@epilot/entity-client 4.9.3 → 4.10.1

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
@@ -229,6 +229,38 @@ declare namespace Components {
229
229
  * Setting to `true` prevents the attribute from being modified / deleted
230
230
  */
231
231
  protected?: boolean;
232
+ /**
233
+ * A set of configurations meant to document and assist the user in filling the attribute.
234
+ */
235
+ info_helpers?: {
236
+ /**
237
+ * The text to be displayed in the attribute hint helper.
238
+ * When specified it overrides the `hint_text_key` configuration.
239
+ *
240
+ */
241
+ hint_text?: string;
242
+ /**
243
+ * The key of the hint text to be displayed in the attribute hint helper.
244
+ * The key should be a valid i18n key.
245
+ *
246
+ */
247
+ hint_text_key?: string;
248
+ /**
249
+ * The name of the custom component to be used as the hint helper.
250
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
251
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
252
+ *
253
+ */
254
+ hint_custom_component?: string;
255
+ /**
256
+ * The placement of the hint tooltip.
257
+ * The value should be a valid `@mui/core` tooltip placement.
258
+ *
259
+ * example:
260
+ * top
261
+ */
262
+ hint_tooltip_placement?: string;
263
+ };
232
264
  type?: "relation_address";
233
265
  has_primary?: boolean;
234
266
  }
@@ -319,6 +351,38 @@ declare namespace Components {
319
351
  * Setting to `true` prevents the attribute from being modified / deleted
320
352
  */
321
353
  protected?: boolean;
354
+ /**
355
+ * A set of configurations meant to document and assist the user in filling the attribute.
356
+ */
357
+ info_helpers?: {
358
+ /**
359
+ * The text to be displayed in the attribute hint helper.
360
+ * When specified it overrides the `hint_text_key` configuration.
361
+ *
362
+ */
363
+ hint_text?: string;
364
+ /**
365
+ * The key of the hint text to be displayed in the attribute hint helper.
366
+ * The key should be a valid i18n key.
367
+ *
368
+ */
369
+ hint_text_key?: string;
370
+ /**
371
+ * The name of the custom component to be used as the hint helper.
372
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
373
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
374
+ *
375
+ */
376
+ hint_custom_component?: string;
377
+ /**
378
+ * The placement of the hint tooltip.
379
+ * The value should be a valid `@mui/core` tooltip placement.
380
+ *
381
+ * example:
382
+ * top
383
+ */
384
+ hint_tooltip_placement?: string;
385
+ };
322
386
  type?: "automation";
323
387
  }
324
388
  export interface BaseAttribute {
@@ -404,19 +468,69 @@ declare namespace Components {
404
468
  * Setting to `true` prevents the attribute from being modified / deleted
405
469
  */
406
470
  protected?: boolean;
471
+ /**
472
+ * A set of configurations meant to document and assist the user in filling the attribute.
473
+ */
474
+ info_helpers?: {
475
+ /**
476
+ * The text to be displayed in the attribute hint helper.
477
+ * When specified it overrides the `hint_text_key` configuration.
478
+ *
479
+ */
480
+ hint_text?: string;
481
+ /**
482
+ * The key of the hint text to be displayed in the attribute hint helper.
483
+ * The key should be a valid i18n key.
484
+ *
485
+ */
486
+ hint_text_key?: string;
487
+ /**
488
+ * The name of the custom component to be used as the hint helper.
489
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
490
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
491
+ *
492
+ */
493
+ hint_custom_component?: string;
494
+ /**
495
+ * The placement of the hint tooltip.
496
+ * The value should be a valid `@mui/core` tooltip placement.
497
+ *
498
+ * example:
499
+ * top
500
+ */
501
+ hint_tooltip_placement?: string;
502
+ };
407
503
  }
408
504
  /**
409
505
  * example:
410
506
  * {
411
507
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
412
508
  * "_org": "123",
509
+ * "_owners": [
510
+ * {
511
+ * "org_id": "123",
512
+ * "user_id": "123"
513
+ * }
514
+ * ],
413
515
  * "_schema": "contact",
414
516
  * "_tags": [
415
517
  * "example",
416
518
  * "mock"
417
519
  * ],
418
520
  * "_created_at": "2021-02-09T12:41:43.662Z",
419
- * "_updated_at": "2021-02-09T12:41:43.662Z"
521
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
522
+ * "_acl": {
523
+ * "view": [
524
+ * "org:456",
525
+ * "org:789"
526
+ * ],
527
+ * "edit": [
528
+ * "org:456"
529
+ * ],
530
+ * "delete": [
531
+ * "org:456"
532
+ * ]
533
+ * }
420
534
  * }
421
535
  */
422
536
  export interface BaseEntity {
@@ -426,6 +540,13 @@ declare namespace Components {
426
540
  * Organization Id the entity belongs to
427
541
  */
428
542
  _org: string;
543
+ _owners?: /**
544
+ * The user / organization owning this entity.
545
+ *
546
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
547
+ *
548
+ */
549
+ EntityOwner[];
429
550
  _schema: /**
430
551
  * URL-friendly identifier for the entity schema
431
552
  * example:
@@ -439,6 +560,7 @@ declare namespace Components {
439
560
  _tags?: string[] | null;
440
561
  _created_at: string | null; // date-time
441
562
  _updated_at: string | null; // date-time
563
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
442
564
  }
443
565
  /**
444
566
  * Reference to blueprint
@@ -530,6 +652,38 @@ declare namespace Components {
530
652
  * Setting to `true` prevents the attribute from being modified / deleted
531
653
  */
532
654
  protected?: boolean;
655
+ /**
656
+ * A set of configurations meant to document and assist the user in filling the attribute.
657
+ */
658
+ info_helpers?: {
659
+ /**
660
+ * The text to be displayed in the attribute hint helper.
661
+ * When specified it overrides the `hint_text_key` configuration.
662
+ *
663
+ */
664
+ hint_text?: string;
665
+ /**
666
+ * The key of the hint text to be displayed in the attribute hint helper.
667
+ * The key should be a valid i18n key.
668
+ *
669
+ */
670
+ hint_text_key?: string;
671
+ /**
672
+ * The name of the custom component to be used as the hint helper.
673
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
674
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
675
+ *
676
+ */
677
+ hint_custom_component?: string;
678
+ /**
679
+ * The placement of the hint tooltip.
680
+ * The value should be a valid `@mui/core` tooltip placement.
681
+ *
682
+ * example:
683
+ * top
684
+ */
685
+ hint_tooltip_placement?: string;
686
+ };
533
687
  type?: "boolean";
534
688
  }
535
689
  export type ClassificationId = string; // uuid
@@ -624,6 +778,38 @@ declare namespace Components {
624
778
  * Setting to `true` prevents the attribute from being modified / deleted
625
779
  */
626
780
  protected?: boolean;
781
+ /**
782
+ * A set of configurations meant to document and assist the user in filling the attribute.
783
+ */
784
+ info_helpers?: {
785
+ /**
786
+ * The text to be displayed in the attribute hint helper.
787
+ * When specified it overrides the `hint_text_key` configuration.
788
+ *
789
+ */
790
+ hint_text?: string;
791
+ /**
792
+ * The key of the hint text to be displayed in the attribute hint helper.
793
+ * The key should be a valid i18n key.
794
+ *
795
+ */
796
+ hint_text_key?: string;
797
+ /**
798
+ * The name of the custom component to be used as the hint helper.
799
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
800
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
801
+ *
802
+ */
803
+ hint_custom_component?: string;
804
+ /**
805
+ * The placement of the hint tooltip.
806
+ * The value should be a valid `@mui/core` tooltip placement.
807
+ *
808
+ * example:
809
+ * top
810
+ */
811
+ hint_tooltip_placement?: string;
812
+ };
627
813
  type?: "computed";
628
814
  }
629
815
  /**
@@ -712,6 +898,38 @@ declare namespace Components {
712
898
  * Setting to `true` prevents the attribute from being modified / deleted
713
899
  */
714
900
  protected?: boolean;
901
+ /**
902
+ * A set of configurations meant to document and assist the user in filling the attribute.
903
+ */
904
+ info_helpers?: {
905
+ /**
906
+ * The text to be displayed in the attribute hint helper.
907
+ * When specified it overrides the `hint_text_key` configuration.
908
+ *
909
+ */
910
+ hint_text?: string;
911
+ /**
912
+ * The key of the hint text to be displayed in the attribute hint helper.
913
+ * The key should be a valid i18n key.
914
+ *
915
+ */
916
+ hint_text_key?: string;
917
+ /**
918
+ * The name of the custom component to be used as the hint helper.
919
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
920
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
921
+ *
922
+ */
923
+ hint_custom_component?: string;
924
+ /**
925
+ * The placement of the hint tooltip.
926
+ * The value should be a valid `@mui/core` tooltip placement.
927
+ *
928
+ * example:
929
+ * top
930
+ */
931
+ hint_tooltip_placement?: string;
932
+ };
715
933
  type: "consent";
716
934
  topic: string;
717
935
  identifiers?: string[];
@@ -802,6 +1020,38 @@ declare namespace Components {
802
1020
  * Setting to `true` prevents the attribute from being modified / deleted
803
1021
  */
804
1022
  protected?: boolean;
1023
+ /**
1024
+ * A set of configurations meant to document and assist the user in filling the attribute.
1025
+ */
1026
+ info_helpers?: {
1027
+ /**
1028
+ * The text to be displayed in the attribute hint helper.
1029
+ * When specified it overrides the `hint_text_key` configuration.
1030
+ *
1031
+ */
1032
+ hint_text?: string;
1033
+ /**
1034
+ * The key of the hint text to be displayed in the attribute hint helper.
1035
+ * The key should be a valid i18n key.
1036
+ *
1037
+ */
1038
+ hint_text_key?: string;
1039
+ /**
1040
+ * The name of the custom component to be used as the hint helper.
1041
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
1042
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
1043
+ *
1044
+ */
1045
+ hint_custom_component?: string;
1046
+ /**
1047
+ * The placement of the hint tooltip.
1048
+ * The value should be a valid `@mui/core` tooltip placement.
1049
+ *
1050
+ * example:
1051
+ * top
1052
+ */
1053
+ hint_tooltip_placement?: string;
1054
+ };
805
1055
  type?: "country";
806
1056
  }
807
1057
  /**
@@ -890,6 +1140,38 @@ declare namespace Components {
890
1140
  * Setting to `true` prevents the attribute from being modified / deleted
891
1141
  */
892
1142
  protected?: boolean;
1143
+ /**
1144
+ * A set of configurations meant to document and assist the user in filling the attribute.
1145
+ */
1146
+ info_helpers?: {
1147
+ /**
1148
+ * The text to be displayed in the attribute hint helper.
1149
+ * When specified it overrides the `hint_text_key` configuration.
1150
+ *
1151
+ */
1152
+ hint_text?: string;
1153
+ /**
1154
+ * The key of the hint text to be displayed in the attribute hint helper.
1155
+ * The key should be a valid i18n key.
1156
+ *
1157
+ */
1158
+ hint_text_key?: string;
1159
+ /**
1160
+ * The name of the custom component to be used as the hint helper.
1161
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
1162
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
1163
+ *
1164
+ */
1165
+ hint_custom_component?: string;
1166
+ /**
1167
+ * The placement of the hint tooltip.
1168
+ * The value should be a valid `@mui/core` tooltip placement.
1169
+ *
1170
+ * example:
1171
+ * top
1172
+ */
1173
+ hint_tooltip_placement?: string;
1174
+ };
893
1175
  type: "currency";
894
1176
  currency_selector_only?: boolean;
895
1177
  /**
@@ -988,6 +1270,38 @@ declare namespace Components {
988
1270
  * Setting to `true` prevents the attribute from being modified / deleted
989
1271
  */
990
1272
  protected?: boolean;
1273
+ /**
1274
+ * A set of configurations meant to document and assist the user in filling the attribute.
1275
+ */
1276
+ info_helpers?: {
1277
+ /**
1278
+ * The text to be displayed in the attribute hint helper.
1279
+ * When specified it overrides the `hint_text_key` configuration.
1280
+ *
1281
+ */
1282
+ hint_text?: string;
1283
+ /**
1284
+ * The key of the hint text to be displayed in the attribute hint helper.
1285
+ * The key should be a valid i18n key.
1286
+ *
1287
+ */
1288
+ hint_text_key?: string;
1289
+ /**
1290
+ * The name of the custom component to be used as the hint helper.
1291
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
1292
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
1293
+ *
1294
+ */
1295
+ hint_custom_component?: string;
1296
+ /**
1297
+ * The placement of the hint tooltip.
1298
+ * The value should be a valid `@mui/core` tooltip placement.
1299
+ *
1300
+ * example:
1301
+ * top
1302
+ */
1303
+ hint_tooltip_placement?: string;
1304
+ };
991
1305
  type?: "date" | "datetime";
992
1306
  }
993
1307
  /**
@@ -995,13 +1309,31 @@ declare namespace Components {
995
1309
  * {
996
1310
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
997
1311
  * "_org": "123",
1312
+ * "_owners": [
1313
+ * {
1314
+ * "org_id": "123",
1315
+ * "user_id": "123"
1316
+ * }
1317
+ * ],
998
1318
  * "_schema": "contact",
999
1319
  * "_tags": [
1000
1320
  * "example",
1001
1321
  * "mock"
1002
1322
  * ],
1003
1323
  * "_created_at": "2021-02-09T12:41:43.662Z",
1004
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1324
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
1325
+ * "_acl": {
1326
+ * "view": [
1327
+ * "org:456",
1328
+ * "org:789"
1329
+ * ],
1330
+ * "edit": [
1331
+ * "org:456"
1332
+ * ],
1333
+ * "delete": [
1334
+ * "org:456"
1335
+ * ]
1336
+ * }
1005
1337
  * }
1006
1338
  */
1007
1339
  export interface Entity {
@@ -1011,6 +1343,13 @@ declare namespace Components {
1011
1343
  * Organization Id the entity belongs to
1012
1344
  */
1013
1345
  _org?: string;
1346
+ _owners?: /**
1347
+ * The user / organization owning this entity.
1348
+ *
1349
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
1350
+ *
1351
+ */
1352
+ EntityOwner[];
1014
1353
  _schema?: /**
1015
1354
  * URL-friendly identifier for the entity schema
1016
1355
  * example:
@@ -1024,6 +1363,16 @@ declare namespace Components {
1024
1363
  _tags?: string[] | null;
1025
1364
  _created_at?: string | null; // date-time
1026
1365
  _updated_at?: string | null; // date-time
1366
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
1367
+ }
1368
+ /**
1369
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
1370
+ */
1371
+ export interface EntityAcl {
1372
+ [name: string]: any;
1373
+ view?: string[];
1374
+ edit?: string[];
1375
+ delete?: string[];
1027
1376
  }
1028
1377
  /**
1029
1378
  * Capabilities the Entity has. Turn features on/off for entities.
@@ -1236,6 +1585,16 @@ declare namespace Components {
1236
1585
  * {
1237
1586
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1238
1587
  * "_org": "123",
1588
+ * "_owners": [
1589
+ * {
1590
+ * "org_id": "123",
1591
+ * "user_id": "123"
1592
+ * },
1593
+ * {
1594
+ * "org_id": "123",
1595
+ * "user_id": "123"
1596
+ * }
1597
+ * ],
1239
1598
  * "_schema": "contact",
1240
1599
  * "_tags": [
1241
1600
  * "example",
@@ -1244,7 +1603,23 @@ declare namespace Components {
1244
1603
  * "mock"
1245
1604
  * ],
1246
1605
  * "_created_at": "2021-02-09T12:41:43.662Z",
1247
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1606
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
1607
+ * "_acl": {
1608
+ * "view": [
1609
+ * "org:456",
1610
+ * "org:789",
1611
+ * "org:456",
1612
+ * "org:789"
1613
+ * ],
1614
+ * "edit": [
1615
+ * "org:456",
1616
+ * "org:456"
1617
+ * ],
1618
+ * "delete": [
1619
+ * "org:456",
1620
+ * "org:456"
1621
+ * ]
1622
+ * }
1248
1623
  * }
1249
1624
  */
1250
1625
  export interface EntityItem {
@@ -1254,6 +1629,13 @@ declare namespace Components {
1254
1629
  * Organization Id the entity belongs to
1255
1630
  */
1256
1631
  _org: string;
1632
+ _owners?: /**
1633
+ * The user / organization owning this entity.
1634
+ *
1635
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
1636
+ *
1637
+ */
1638
+ EntityOwner[];
1257
1639
  _schema: /**
1258
1640
  * URL-friendly identifier for the entity schema
1259
1641
  * example:
@@ -1267,6 +1649,7 @@ declare namespace Components {
1267
1649
  _tags?: string[] | null;
1268
1650
  _created_at: string | null; // date-time
1269
1651
  _updated_at: string | null; // date-time
1652
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
1270
1653
  }
1271
1654
  export interface EntityOperation {
1272
1655
  entity: EntityId /* uuid */;
@@ -1303,6 +1686,12 @@ declare namespace Components {
1303
1686
  * {
1304
1687
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305
1688
  * "_org": "123",
1689
+ * "_owners": [
1690
+ * {
1691
+ * "org_id": "123",
1692
+ * "user_id": "123"
1693
+ * }
1694
+ * ],
1306
1695
  * "_schema": "contact",
1307
1696
  * "_tags": [
1308
1697
  * "example",
@@ -1310,6 +1699,18 @@ declare namespace Components {
1310
1699
  * ],
1311
1700
  * "_created_at": "2021-02-09T12:41:43.662Z",
1312
1701
  * "_updated_at": "2021-02-09T12:41:43.662Z",
1702
+ * "_acl": {
1703
+ * "view": [
1704
+ * "org:456",
1705
+ * "org:789"
1706
+ * ],
1707
+ * "edit": [
1708
+ * "org:456"
1709
+ * ],
1710
+ * "delete": [
1711
+ * "org:456"
1712
+ * ]
1713
+ * },
1313
1714
  * "status": "Inactive"
1314
1715
  * }
1315
1716
  */
@@ -1320,6 +1721,13 @@ declare namespace Components {
1320
1721
  * Organization Id the entity belongs to
1321
1722
  */
1322
1723
  _org?: string;
1724
+ _owners?: /**
1725
+ * The user / organization owning this entity.
1726
+ *
1727
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
1728
+ *
1729
+ */
1730
+ EntityOwner[];
1323
1731
  _schema?: /**
1324
1732
  * URL-friendly identifier for the entity schema
1325
1733
  * example:
@@ -1333,6 +1741,7 @@ declare namespace Components {
1333
1741
  _tags?: string[] | null;
1334
1742
  _created_at?: string | null; // date-time
1335
1743
  _updated_at?: string | null; // date-time
1744
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
1336
1745
  };
1337
1746
  diff?: {
1338
1747
  added?: /**
@@ -1340,13 +1749,31 @@ declare namespace Components {
1340
1749
  * {
1341
1750
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1342
1751
  * "_org": "123",
1752
+ * "_owners": [
1753
+ * {
1754
+ * "org_id": "123",
1755
+ * "user_id": "123"
1756
+ * }
1757
+ * ],
1343
1758
  * "_schema": "contact",
1344
1759
  * "_tags": [
1345
1760
  * "example",
1346
1761
  * "mock"
1347
1762
  * ],
1348
1763
  * "_created_at": "2021-02-09T12:41:43.662Z",
1349
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1764
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
1765
+ * "_acl": {
1766
+ * "view": [
1767
+ * "org:456",
1768
+ * "org:789"
1769
+ * ],
1770
+ * "edit": [
1771
+ * "org:456"
1772
+ * ],
1773
+ * "delete": [
1774
+ * "org:456"
1775
+ * ]
1776
+ * }
1350
1777
  * }
1351
1778
  */
1352
1779
  Entity;
@@ -1355,13 +1782,31 @@ declare namespace Components {
1355
1782
  * {
1356
1783
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1357
1784
  * "_org": "123",
1785
+ * "_owners": [
1786
+ * {
1787
+ * "org_id": "123",
1788
+ * "user_id": "123"
1789
+ * }
1790
+ * ],
1358
1791
  * "_schema": "contact",
1359
1792
  * "_tags": [
1360
1793
  * "example",
1361
1794
  * "mock"
1362
1795
  * ],
1363
1796
  * "_created_at": "2021-02-09T12:41:43.662Z",
1364
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1797
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
1798
+ * "_acl": {
1799
+ * "view": [
1800
+ * "org:456",
1801
+ * "org:789"
1802
+ * ],
1803
+ * "edit": [
1804
+ * "org:456"
1805
+ * ],
1806
+ * "delete": [
1807
+ * "org:456"
1808
+ * ]
1809
+ * }
1365
1810
  * }
1366
1811
  */
1367
1812
  Entity;
@@ -1370,18 +1815,54 @@ declare namespace Components {
1370
1815
  * {
1371
1816
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1372
1817
  * "_org": "123",
1818
+ * "_owners": [
1819
+ * {
1820
+ * "org_id": "123",
1821
+ * "user_id": "123"
1822
+ * }
1823
+ * ],
1373
1824
  * "_schema": "contact",
1374
1825
  * "_tags": [
1375
1826
  * "example",
1376
1827
  * "mock"
1377
1828
  * ],
1378
1829
  * "_created_at": "2021-02-09T12:41:43.662Z",
1379
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1830
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
1831
+ * "_acl": {
1832
+ * "view": [
1833
+ * "org:456",
1834
+ * "org:789"
1835
+ * ],
1836
+ * "edit": [
1837
+ * "org:456"
1838
+ * ],
1839
+ * "delete": [
1840
+ * "org:456"
1841
+ * ]
1842
+ * }
1380
1843
  * }
1381
1844
  */
1382
1845
  Entity;
1383
1846
  };
1384
1847
  }
1848
+ /**
1849
+ * The user / organization owning this entity.
1850
+ *
1851
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
1852
+ *
1853
+ */
1854
+ export interface EntityOwner {
1855
+ /**
1856
+ * example:
1857
+ * 123
1858
+ */
1859
+ org_id: string;
1860
+ /**
1861
+ * example:
1862
+ * 123
1863
+ */
1864
+ user_id?: string;
1865
+ }
1385
1866
  /**
1386
1867
  * The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
1387
1868
  */
@@ -1935,6 +2416,16 @@ declare namespace Components {
1935
2416
  * {
1936
2417
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1937
2418
  * "_org": "123",
2419
+ * "_owners": [
2420
+ * {
2421
+ * "org_id": "123",
2422
+ * "user_id": "123"
2423
+ * },
2424
+ * {
2425
+ * "org_id": "123",
2426
+ * "user_id": "123"
2427
+ * }
2428
+ * ],
1938
2429
  * "_schema": "contact",
1939
2430
  * "_tags": [
1940
2431
  * "example",
@@ -1943,7 +2434,23 @@ declare namespace Components {
1943
2434
  * "mock"
1944
2435
  * ],
1945
2436
  * "_created_at": "2021-02-09T12:41:43.662Z",
1946
- * "_updated_at": "2021-02-09T12:41:43.662Z"
2437
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
2438
+ * "_acl": {
2439
+ * "view": [
2440
+ * "org:456",
2441
+ * "org:789",
2442
+ * "org:456",
2443
+ * "org:789"
2444
+ * ],
2445
+ * "edit": [
2446
+ * "org:456",
2447
+ * "org:456"
2448
+ * ],
2449
+ * "delete": [
2450
+ * "org:456",
2451
+ * "org:456"
2452
+ * ]
2453
+ * }
1947
2454
  * }
1948
2455
  */
1949
2456
  EntityItem[];
@@ -2069,6 +2576,38 @@ declare namespace Components {
2069
2576
  * Setting to `true` prevents the attribute from being modified / deleted
2070
2577
  */
2071
2578
  protected?: boolean;
2579
+ /**
2580
+ * A set of configurations meant to document and assist the user in filling the attribute.
2581
+ */
2582
+ info_helpers?: {
2583
+ /**
2584
+ * The text to be displayed in the attribute hint helper.
2585
+ * When specified it overrides the `hint_text_key` configuration.
2586
+ *
2587
+ */
2588
+ hint_text?: string;
2589
+ /**
2590
+ * The key of the hint text to be displayed in the attribute hint helper.
2591
+ * The key should be a valid i18n key.
2592
+ *
2593
+ */
2594
+ hint_text_key?: string;
2595
+ /**
2596
+ * The name of the custom component to be used as the hint helper.
2597
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
2598
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
2599
+ *
2600
+ */
2601
+ hint_custom_component?: string;
2602
+ /**
2603
+ * The placement of the hint tooltip.
2604
+ * The value should be a valid `@mui/core` tooltip placement.
2605
+ *
2606
+ * example:
2607
+ * top
2608
+ */
2609
+ hint_tooltip_placement?: string;
2610
+ };
2072
2611
  type: "image" | "file";
2073
2612
  multiple?: boolean;
2074
2613
  /**
@@ -2092,13 +2631,31 @@ declare namespace Components {
2092
2631
  * {
2093
2632
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2094
2633
  * "_org": "123",
2634
+ * "_owners": [
2635
+ * {
2636
+ * "org_id": "123",
2637
+ * "user_id": "123"
2638
+ * }
2639
+ * ],
2095
2640
  * "_schema": "contact",
2096
2641
  * "_tags": [
2097
2642
  * "example",
2098
2643
  * "mock"
2099
2644
  * ],
2100
2645
  * "_created_at": "2021-02-09T12:41:43.662Z",
2101
- * "_updated_at": "2021-02-09T12:41:43.662Z"
2646
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
2647
+ * "_acl": {
2648
+ * "view": [
2649
+ * "org:456",
2650
+ * "org:789"
2651
+ * ],
2652
+ * "edit": [
2653
+ * "org:456"
2654
+ * ],
2655
+ * "delete": [
2656
+ * "org:456"
2657
+ * ]
2658
+ * }
2102
2659
  * }
2103
2660
  */
2104
2661
  RelationEntity)[];
@@ -2114,6 +2671,11 @@ declare namespace Components {
2114
2671
  * Entity with relation data resolved into the attribute values
2115
2672
  * example:
2116
2673
  * {
2674
+ * "_relations": [
2675
+ * {
2676
+ * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2677
+ * }
2678
+ * ],
2117
2679
  * "status": "active",
2118
2680
  * "customer_number": "abc123",
2119
2681
  * "email": [
@@ -2168,6 +2730,9 @@ declare namespace Components {
2168
2730
  */
2169
2731
  export interface HydratedEntity {
2170
2732
  [name: string]: any;
2733
+ _relations: {
2734
+ entity_id: EntityId /* uuid */;
2735
+ }[];
2171
2736
  }
2172
2737
  /**
2173
2738
  * Entity with relation data resolved into the attribute values
@@ -2175,6 +2740,12 @@ declare namespace Components {
2175
2740
  * {
2176
2741
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2177
2742
  * "_org": "123",
2743
+ * "_owners": [
2744
+ * {
2745
+ * "org_id": "123",
2746
+ * "user_id": "123"
2747
+ * }
2748
+ * ],
2178
2749
  * "_schema": "contact",
2179
2750
  * "_tags": [
2180
2751
  * "example",
@@ -2182,6 +2753,23 @@ declare namespace Components {
2182
2753
  * ],
2183
2754
  * "_created_at": "2021-02-09T12:41:43.662Z",
2184
2755
  * "_updated_at": "2021-02-09T12:41:43.662Z",
2756
+ * "_acl": {
2757
+ * "view": [
2758
+ * "org:456",
2759
+ * "org:789"
2760
+ * ],
2761
+ * "edit": [
2762
+ * "org:456"
2763
+ * ],
2764
+ * "delete": [
2765
+ * "org:456"
2766
+ * ]
2767
+ * },
2768
+ * "_relations": [
2769
+ * {
2770
+ * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2771
+ * }
2772
+ * ],
2185
2773
  * "status": "active",
2186
2774
  * "customer_number": "abc123",
2187
2775
  * "email": [
@@ -2241,6 +2829,13 @@ declare namespace Components {
2241
2829
  * Organization Id the entity belongs to
2242
2830
  */
2243
2831
  _org: string;
2832
+ _owners?: /**
2833
+ * The user / organization owning this entity.
2834
+ *
2835
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
2836
+ *
2837
+ */
2838
+ EntityOwner[];
2244
2839
  _schema: /**
2245
2840
  * URL-friendly identifier for the entity schema
2246
2841
  * example:
@@ -2254,6 +2849,10 @@ declare namespace Components {
2254
2849
  _tags?: string[] | null;
2255
2850
  _created_at: string | null; // date-time
2256
2851
  _updated_at: string | null; // date-time
2852
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
2853
+ _relations: {
2854
+ entity_id: EntityId /* uuid */;
2855
+ }[];
2257
2856
  }
2258
2857
  /**
2259
2858
  * No UI representation
@@ -2341,6 +2940,38 @@ declare namespace Components {
2341
2940
  * Setting to `true` prevents the attribute from being modified / deleted
2342
2941
  */
2343
2942
  protected?: boolean;
2943
+ /**
2944
+ * A set of configurations meant to document and assist the user in filling the attribute.
2945
+ */
2946
+ info_helpers?: {
2947
+ /**
2948
+ * The text to be displayed in the attribute hint helper.
2949
+ * When specified it overrides the `hint_text_key` configuration.
2950
+ *
2951
+ */
2952
+ hint_text?: string;
2953
+ /**
2954
+ * The key of the hint text to be displayed in the attribute hint helper.
2955
+ * The key should be a valid i18n key.
2956
+ *
2957
+ */
2958
+ hint_text_key?: string;
2959
+ /**
2960
+ * The name of the custom component to be used as the hint helper.
2961
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
2962
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
2963
+ *
2964
+ */
2965
+ hint_custom_component?: string;
2966
+ /**
2967
+ * The placement of the hint tooltip.
2968
+ * The value should be a valid `@mui/core` tooltip placement.
2969
+ *
2970
+ * example:
2971
+ * top
2972
+ */
2973
+ hint_tooltip_placement?: string;
2974
+ };
2344
2975
  type?: "internal";
2345
2976
  }
2346
2977
  /**
@@ -2429,6 +3060,38 @@ declare namespace Components {
2429
3060
  * Setting to `true` prevents the attribute from being modified / deleted
2430
3061
  */
2431
3062
  protected?: boolean;
3063
+ /**
3064
+ * A set of configurations meant to document and assist the user in filling the attribute.
3065
+ */
3066
+ info_helpers?: {
3067
+ /**
3068
+ * The text to be displayed in the attribute hint helper.
3069
+ * When specified it overrides the `hint_text_key` configuration.
3070
+ *
3071
+ */
3072
+ hint_text?: string;
3073
+ /**
3074
+ * The key of the hint text to be displayed in the attribute hint helper.
3075
+ * The key should be a valid i18n key.
3076
+ *
3077
+ */
3078
+ hint_text_key?: string;
3079
+ /**
3080
+ * The name of the custom component to be used as the hint helper.
3081
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3082
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3083
+ *
3084
+ */
3085
+ hint_custom_component?: string;
3086
+ /**
3087
+ * The placement of the hint tooltip.
3088
+ * The value should be a valid `@mui/core` tooltip placement.
3089
+ *
3090
+ * example:
3091
+ * top
3092
+ */
3093
+ hint_tooltip_placement?: string;
3094
+ };
2432
3095
  type?: "internal_user";
2433
3096
  }
2434
3097
  /**
@@ -2517,6 +3180,38 @@ declare namespace Components {
2517
3180
  * Setting to `true` prevents the attribute from being modified / deleted
2518
3181
  */
2519
3182
  protected?: boolean;
3183
+ /**
3184
+ * A set of configurations meant to document and assist the user in filling the attribute.
3185
+ */
3186
+ info_helpers?: {
3187
+ /**
3188
+ * The text to be displayed in the attribute hint helper.
3189
+ * When specified it overrides the `hint_text_key` configuration.
3190
+ *
3191
+ */
3192
+ hint_text?: string;
3193
+ /**
3194
+ * The key of the hint text to be displayed in the attribute hint helper.
3195
+ * The key should be a valid i18n key.
3196
+ *
3197
+ */
3198
+ hint_text_key?: string;
3199
+ /**
3200
+ * The name of the custom component to be used as the hint helper.
3201
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3202
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3203
+ *
3204
+ */
3205
+ hint_custom_component?: string;
3206
+ /**
3207
+ * The placement of the hint tooltip.
3208
+ * The value should be a valid `@mui/core` tooltip placement.
3209
+ *
3210
+ * example:
3211
+ * top
3212
+ */
3213
+ hint_tooltip_placement?: string;
3214
+ };
2520
3215
  type?: "invitation_email";
2521
3216
  }
2522
3217
  /**
@@ -2613,6 +3308,38 @@ declare namespace Components {
2613
3308
  * Setting to `true` prevents the attribute from being modified / deleted
2614
3309
  */
2615
3310
  protected?: boolean;
3311
+ /**
3312
+ * A set of configurations meant to document and assist the user in filling the attribute.
3313
+ */
3314
+ info_helpers?: {
3315
+ /**
3316
+ * The text to be displayed in the attribute hint helper.
3317
+ * When specified it overrides the `hint_text_key` configuration.
3318
+ *
3319
+ */
3320
+ hint_text?: string;
3321
+ /**
3322
+ * The key of the hint text to be displayed in the attribute hint helper.
3323
+ * The key should be a valid i18n key.
3324
+ *
3325
+ */
3326
+ hint_text_key?: string;
3327
+ /**
3328
+ * The name of the custom component to be used as the hint helper.
3329
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3330
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3331
+ *
3332
+ */
3333
+ hint_custom_component?: string;
3334
+ /**
3335
+ * The placement of the hint tooltip.
3336
+ * The value should be a valid `@mui/core` tooltip placement.
3337
+ *
3338
+ * example:
3339
+ * top
3340
+ */
3341
+ hint_tooltip_placement?: string;
3342
+ };
2616
3343
  type?: "link";
2617
3344
  }
2618
3345
  /**
@@ -2701,6 +3428,38 @@ declare namespace Components {
2701
3428
  * Setting to `true` prevents the attribute from being modified / deleted
2702
3429
  */
2703
3430
  protected?: boolean;
3431
+ /**
3432
+ * A set of configurations meant to document and assist the user in filling the attribute.
3433
+ */
3434
+ info_helpers?: {
3435
+ /**
3436
+ * The text to be displayed in the attribute hint helper.
3437
+ * When specified it overrides the `hint_text_key` configuration.
3438
+ *
3439
+ */
3440
+ hint_text?: string;
3441
+ /**
3442
+ * The key of the hint text to be displayed in the attribute hint helper.
3443
+ * The key should be a valid i18n key.
3444
+ *
3445
+ */
3446
+ hint_text_key?: string;
3447
+ /**
3448
+ * The name of the custom component to be used as the hint helper.
3449
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3450
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3451
+ *
3452
+ */
3453
+ hint_custom_component?: string;
3454
+ /**
3455
+ * The placement of the hint tooltip.
3456
+ * The value should be a valid `@mui/core` tooltip placement.
3457
+ *
3458
+ * example:
3459
+ * top
3460
+ */
3461
+ hint_tooltip_placement?: string;
3462
+ };
2704
3463
  type?: "multiselect" | "checkbox";
2705
3464
  /**
2706
3465
  * controls if the matching of values against the options is case sensitive or not
@@ -2805,6 +3564,38 @@ declare namespace Components {
2805
3564
  * Setting to `true` prevents the attribute from being modified / deleted
2806
3565
  */
2807
3566
  protected?: boolean;
3567
+ /**
3568
+ * A set of configurations meant to document and assist the user in filling the attribute.
3569
+ */
3570
+ info_helpers?: {
3571
+ /**
3572
+ * The text to be displayed in the attribute hint helper.
3573
+ * When specified it overrides the `hint_text_key` configuration.
3574
+ *
3575
+ */
3576
+ hint_text?: string;
3577
+ /**
3578
+ * The key of the hint text to be displayed in the attribute hint helper.
3579
+ * The key should be a valid i18n key.
3580
+ *
3581
+ */
3582
+ hint_text_key?: string;
3583
+ /**
3584
+ * The name of the custom component to be used as the hint helper.
3585
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3586
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3587
+ *
3588
+ */
3589
+ hint_custom_component?: string;
3590
+ /**
3591
+ * The placement of the hint tooltip.
3592
+ * The value should be a valid `@mui/core` tooltip placement.
3593
+ *
3594
+ * example:
3595
+ * top
3596
+ */
3597
+ hint_tooltip_placement?: string;
3598
+ };
2808
3599
  type?: "number";
2809
3600
  format?: string;
2810
3601
  }
@@ -2894,6 +3685,38 @@ declare namespace Components {
2894
3685
  * Setting to `true` prevents the attribute from being modified / deleted
2895
3686
  */
2896
3687
  protected?: boolean;
3688
+ /**
3689
+ * A set of configurations meant to document and assist the user in filling the attribute.
3690
+ */
3691
+ info_helpers?: {
3692
+ /**
3693
+ * The text to be displayed in the attribute hint helper.
3694
+ * When specified it overrides the `hint_text_key` configuration.
3695
+ *
3696
+ */
3697
+ hint_text?: string;
3698
+ /**
3699
+ * The key of the hint text to be displayed in the attribute hint helper.
3700
+ * The key should be a valid i18n key.
3701
+ *
3702
+ */
3703
+ hint_text_key?: string;
3704
+ /**
3705
+ * The name of the custom component to be used as the hint helper.
3706
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3707
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3708
+ *
3709
+ */
3710
+ hint_custom_component?: string;
3711
+ /**
3712
+ * The placement of the hint tooltip.
3713
+ * The value should be a valid `@mui/core` tooltip placement.
3714
+ *
3715
+ * example:
3716
+ * top
3717
+ */
3718
+ hint_tooltip_placement?: string;
3719
+ };
2897
3720
  type?: "ordered_list";
2898
3721
  }
2899
3722
  /**
@@ -2982,6 +3805,38 @@ declare namespace Components {
2982
3805
  * Setting to `true` prevents the attribute from being modified / deleted
2983
3806
  */
2984
3807
  protected?: boolean;
3808
+ /**
3809
+ * A set of configurations meant to document and assist the user in filling the attribute.
3810
+ */
3811
+ info_helpers?: {
3812
+ /**
3813
+ * The text to be displayed in the attribute hint helper.
3814
+ * When specified it overrides the `hint_text_key` configuration.
3815
+ *
3816
+ */
3817
+ hint_text?: string;
3818
+ /**
3819
+ * The key of the hint text to be displayed in the attribute hint helper.
3820
+ * The key should be a valid i18n key.
3821
+ *
3822
+ */
3823
+ hint_text_key?: string;
3824
+ /**
3825
+ * The name of the custom component to be used as the hint helper.
3826
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3827
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3828
+ *
3829
+ */
3830
+ hint_custom_component?: string;
3831
+ /**
3832
+ * The placement of the hint tooltip.
3833
+ * The value should be a valid `@mui/core` tooltip placement.
3834
+ *
3835
+ * example:
3836
+ * top
3837
+ */
3838
+ hint_tooltip_placement?: string;
3839
+ };
2985
3840
  type?: "partner_status";
2986
3841
  }
2987
3842
  /**
@@ -3070,6 +3925,38 @@ declare namespace Components {
3070
3925
  * Setting to `true` prevents the attribute from being modified / deleted
3071
3926
  */
3072
3927
  protected?: boolean;
3928
+ /**
3929
+ * A set of configurations meant to document and assist the user in filling the attribute.
3930
+ */
3931
+ info_helpers?: {
3932
+ /**
3933
+ * The text to be displayed in the attribute hint helper.
3934
+ * When specified it overrides the `hint_text_key` configuration.
3935
+ *
3936
+ */
3937
+ hint_text?: string;
3938
+ /**
3939
+ * The key of the hint text to be displayed in the attribute hint helper.
3940
+ * The key should be a valid i18n key.
3941
+ *
3942
+ */
3943
+ hint_text_key?: string;
3944
+ /**
3945
+ * The name of the custom component to be used as the hint helper.
3946
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3947
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3948
+ *
3949
+ */
3950
+ hint_custom_component?: string;
3951
+ /**
3952
+ * The placement of the hint tooltip.
3953
+ * The value should be a valid `@mui/core` tooltip placement.
3954
+ *
3955
+ * example:
3956
+ * top
3957
+ */
3958
+ hint_tooltip_placement?: string;
3959
+ };
3073
3960
  type?: "relation_payment_method";
3074
3961
  has_primary?: boolean;
3075
3962
  }
@@ -3163,6 +4050,38 @@ declare namespace Components {
3163
4050
  * Setting to `true` prevents the attribute from being modified / deleted
3164
4051
  */
3165
4052
  protected?: boolean;
4053
+ /**
4054
+ * A set of configurations meant to document and assist the user in filling the attribute.
4055
+ */
4056
+ info_helpers?: {
4057
+ /**
4058
+ * The text to be displayed in the attribute hint helper.
4059
+ * When specified it overrides the `hint_text_key` configuration.
4060
+ *
4061
+ */
4062
+ hint_text?: string;
4063
+ /**
4064
+ * The key of the hint text to be displayed in the attribute hint helper.
4065
+ * The key should be a valid i18n key.
4066
+ *
4067
+ */
4068
+ hint_text_key?: string;
4069
+ /**
4070
+ * The name of the custom component to be used as the hint helper.
4071
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4072
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4073
+ *
4074
+ */
4075
+ hint_custom_component?: string;
4076
+ /**
4077
+ * The placement of the hint tooltip.
4078
+ * The value should be a valid `@mui/core` tooltip placement.
4079
+ *
4080
+ * example:
4081
+ * top
4082
+ */
4083
+ hint_tooltip_placement?: string;
4084
+ };
3166
4085
  id?: ClassificationId /* uuid */;
3167
4086
  parents?: ClassificationId /* uuid */[];
3168
4087
  created_at?: string; // date-time
@@ -3270,6 +4189,38 @@ declare namespace Components {
3270
4189
  * Setting to `true` prevents the attribute from being modified / deleted
3271
4190
  */
3272
4191
  protected?: boolean;
4192
+ /**
4193
+ * A set of configurations meant to document and assist the user in filling the attribute.
4194
+ */
4195
+ info_helpers?: {
4196
+ /**
4197
+ * The text to be displayed in the attribute hint helper.
4198
+ * When specified it overrides the `hint_text_key` configuration.
4199
+ *
4200
+ */
4201
+ hint_text?: string;
4202
+ /**
4203
+ * The key of the hint text to be displayed in the attribute hint helper.
4204
+ * The key should be a valid i18n key.
4205
+ *
4206
+ */
4207
+ hint_text_key?: string;
4208
+ /**
4209
+ * The name of the custom component to be used as the hint helper.
4210
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4211
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4212
+ *
4213
+ */
4214
+ hint_custom_component?: string;
4215
+ /**
4216
+ * The placement of the hint tooltip.
4217
+ * The value should be a valid `@mui/core` tooltip placement.
4218
+ *
4219
+ * example:
4220
+ * top
4221
+ */
4222
+ hint_tooltip_placement?: string;
4223
+ };
3273
4224
  type?: "relation";
3274
4225
  relation_type?: "has_many" | "has_one";
3275
4226
  /**
@@ -3349,6 +4300,16 @@ declare namespace Components {
3349
4300
  * {
3350
4301
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3351
4302
  * "_org": "123",
4303
+ * "_owners": [
4304
+ * {
4305
+ * "org_id": "123",
4306
+ * "user_id": "123"
4307
+ * },
4308
+ * {
4309
+ * "org_id": "123",
4310
+ * "user_id": "123"
4311
+ * }
4312
+ * ],
3352
4313
  * "_schema": "contact",
3353
4314
  * "_tags": [
3354
4315
  * "example",
@@ -3357,7 +4318,23 @@ declare namespace Components {
3357
4318
  * "mock"
3358
4319
  * ],
3359
4320
  * "_created_at": "2021-02-09T12:41:43.662Z",
3360
- * "_updated_at": "2021-02-09T12:41:43.662Z"
4321
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
4322
+ * "_acl": {
4323
+ * "view": [
4324
+ * "org:456",
4325
+ * "org:789",
4326
+ * "org:456",
4327
+ * "org:789"
4328
+ * ],
4329
+ * "edit": [
4330
+ * "org:456",
4331
+ * "org:456"
4332
+ * ],
4333
+ * "delete": [
4334
+ * "org:456",
4335
+ * "org:456"
4336
+ * ]
4337
+ * }
3361
4338
  * }
3362
4339
  */
3363
4340
  new_entity_item?: {
@@ -3367,6 +4344,13 @@ declare namespace Components {
3367
4344
  * Organization Id the entity belongs to
3368
4345
  */
3369
4346
  _org: string;
4347
+ _owners?: /**
4348
+ * The user / organization owning this entity.
4349
+ *
4350
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
4351
+ *
4352
+ */
4353
+ EntityOwner[];
3370
4354
  _schema: /**
3371
4355
  * URL-friendly identifier for the entity schema
3372
4356
  * example:
@@ -3380,6 +4364,7 @@ declare namespace Components {
3380
4364
  _tags?: string[] | null;
3381
4365
  _created_at: string | null; // date-time
3382
4366
  _updated_at: string | null; // date-time
4367
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
3383
4368
  };
3384
4369
  }[];
3385
4370
  drawer_size?: "small" | "medium" | "large";
@@ -3409,13 +4394,31 @@ declare namespace Components {
3409
4394
  * {
3410
4395
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411
4396
  * "_org": "123",
4397
+ * "_owners": [
4398
+ * {
4399
+ * "org_id": "123",
4400
+ * "user_id": "123"
4401
+ * }
4402
+ * ],
3412
4403
  * "_schema": "contact",
3413
4404
  * "_tags": [
3414
4405
  * "example",
3415
4406
  * "mock"
3416
4407
  * ],
3417
4408
  * "_created_at": "2021-02-09T12:41:43.662Z",
3418
- * "_updated_at": "2021-02-09T12:41:43.662Z"
4409
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
4410
+ * "_acl": {
4411
+ * "view": [
4412
+ * "org:456",
4413
+ * "org:789"
4414
+ * ],
4415
+ * "edit": [
4416
+ * "org:456"
4417
+ * ],
4418
+ * "delete": [
4419
+ * "org:456"
4420
+ * ]
4421
+ * }
3419
4422
  * }
3420
4423
  */
3421
4424
  export interface RelationEntity {
@@ -3425,6 +4428,13 @@ declare namespace Components {
3425
4428
  * Organization Id the entity belongs to
3426
4429
  */
3427
4430
  _org: string;
4431
+ _owners?: /**
4432
+ * The user / organization owning this entity.
4433
+ *
4434
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
4435
+ *
4436
+ */
4437
+ EntityOwner[];
3428
4438
  _schema: /**
3429
4439
  * URL-friendly identifier for the entity schema
3430
4440
  * example:
@@ -3438,6 +4448,7 @@ declare namespace Components {
3438
4448
  _tags?: string[] | null;
3439
4449
  _created_at: string | null; // date-time
3440
4450
  _updated_at: string | null; // date-time
4451
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
3441
4452
  $relation?: RelationItem;
3442
4453
  }
3443
4454
  export interface RelationItem {
@@ -3535,6 +4546,38 @@ declare namespace Components {
3535
4546
  * Setting to `true` prevents the attribute from being modified / deleted
3536
4547
  */
3537
4548
  protected?: boolean;
4549
+ /**
4550
+ * A set of configurations meant to document and assist the user in filling the attribute.
4551
+ */
4552
+ info_helpers?: {
4553
+ /**
4554
+ * The text to be displayed in the attribute hint helper.
4555
+ * When specified it overrides the `hint_text_key` configuration.
4556
+ *
4557
+ */
4558
+ hint_text?: string;
4559
+ /**
4560
+ * The key of the hint text to be displayed in the attribute hint helper.
4561
+ * The key should be a valid i18n key.
4562
+ *
4563
+ */
4564
+ hint_text_key?: string;
4565
+ /**
4566
+ * The name of the custom component to be used as the hint helper.
4567
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4568
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4569
+ *
4570
+ */
4571
+ hint_custom_component?: string;
4572
+ /**
4573
+ * The placement of the hint tooltip.
4574
+ * The value should be a valid `@mui/core` tooltip placement.
4575
+ *
4576
+ * example:
4577
+ * top
4578
+ */
4579
+ hint_tooltip_placement?: string;
4580
+ };
3538
4581
  repeatable?: boolean;
3539
4582
  has_primary?: boolean;
3540
4583
  /**
@@ -3788,6 +4831,38 @@ declare namespace Components {
3788
4831
  * Setting to `true` prevents the attribute from being modified / deleted
3789
4832
  */
3790
4833
  protected?: boolean;
4834
+ /**
4835
+ * A set of configurations meant to document and assist the user in filling the attribute.
4836
+ */
4837
+ info_helpers?: {
4838
+ /**
4839
+ * The text to be displayed in the attribute hint helper.
4840
+ * When specified it overrides the `hint_text_key` configuration.
4841
+ *
4842
+ */
4843
+ hint_text?: string;
4844
+ /**
4845
+ * The key of the hint text to be displayed in the attribute hint helper.
4846
+ * The key should be a valid i18n key.
4847
+ *
4848
+ */
4849
+ hint_text_key?: string;
4850
+ /**
4851
+ * The name of the custom component to be used as the hint helper.
4852
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4853
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4854
+ *
4855
+ */
4856
+ hint_custom_component?: string;
4857
+ /**
4858
+ * The placement of the hint tooltip.
4859
+ * The value should be a valid `@mui/core` tooltip placement.
4860
+ *
4861
+ * example:
4862
+ * top
4863
+ */
4864
+ hint_tooltip_placement?: string;
4865
+ };
3791
4866
  type?: "select" | "radio";
3792
4867
  options?: ({
3793
4868
  value: string;
@@ -3884,6 +4959,38 @@ declare namespace Components {
3884
4959
  * Setting to `true` prevents the attribute from being modified / deleted
3885
4960
  */
3886
4961
  protected?: boolean;
4962
+ /**
4963
+ * A set of configurations meant to document and assist the user in filling the attribute.
4964
+ */
4965
+ info_helpers?: {
4966
+ /**
4967
+ * The text to be displayed in the attribute hint helper.
4968
+ * When specified it overrides the `hint_text_key` configuration.
4969
+ *
4970
+ */
4971
+ hint_text?: string;
4972
+ /**
4973
+ * The key of the hint text to be displayed in the attribute hint helper.
4974
+ * The key should be a valid i18n key.
4975
+ *
4976
+ */
4977
+ hint_text_key?: string;
4978
+ /**
4979
+ * The name of the custom component to be used as the hint helper.
4980
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4981
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4982
+ *
4983
+ */
4984
+ hint_custom_component?: string;
4985
+ /**
4986
+ * The placement of the hint tooltip.
4987
+ * The value should be a valid `@mui/core` tooltip placement.
4988
+ *
4989
+ * example:
4990
+ * top
4991
+ */
4992
+ hint_tooltip_placement?: string;
4993
+ };
3887
4994
  type?: "sequence";
3888
4995
  /**
3889
4996
  * Prefix added before the sequence number
@@ -3979,6 +5086,38 @@ declare namespace Components {
3979
5086
  * Setting to `true` prevents the attribute from being modified / deleted
3980
5087
  */
3981
5088
  protected?: boolean;
5089
+ /**
5090
+ * A set of configurations meant to document and assist the user in filling the attribute.
5091
+ */
5092
+ info_helpers?: {
5093
+ /**
5094
+ * The text to be displayed in the attribute hint helper.
5095
+ * When specified it overrides the `hint_text_key` configuration.
5096
+ *
5097
+ */
5098
+ hint_text?: string;
5099
+ /**
5100
+ * The key of the hint text to be displayed in the attribute hint helper.
5101
+ * The key should be a valid i18n key.
5102
+ *
5103
+ */
5104
+ hint_text_key?: string;
5105
+ /**
5106
+ * The name of the custom component to be used as the hint helper.
5107
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5108
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5109
+ *
5110
+ */
5111
+ hint_custom_component?: string;
5112
+ /**
5113
+ * The placement of the hint tooltip.
5114
+ * The value should be a valid `@mui/core` tooltip placement.
5115
+ *
5116
+ * example:
5117
+ * top
5118
+ */
5119
+ hint_tooltip_placement?: string;
5120
+ };
3982
5121
  type?: "status";
3983
5122
  options?: ((string | null) | {
3984
5123
  value: string;
@@ -4131,6 +5270,38 @@ declare namespace Components {
4131
5270
  * Setting to `true` prevents the attribute from being modified / deleted
4132
5271
  */
4133
5272
  protected?: boolean;
5273
+ /**
5274
+ * A set of configurations meant to document and assist the user in filling the attribute.
5275
+ */
5276
+ info_helpers?: {
5277
+ /**
5278
+ * The text to be displayed in the attribute hint helper.
5279
+ * When specified it overrides the `hint_text_key` configuration.
5280
+ *
5281
+ */
5282
+ hint_text?: string;
5283
+ /**
5284
+ * The key of the hint text to be displayed in the attribute hint helper.
5285
+ * The key should be a valid i18n key.
5286
+ *
5287
+ */
5288
+ hint_text_key?: string;
5289
+ /**
5290
+ * The name of the custom component to be used as the hint helper.
5291
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5292
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5293
+ *
5294
+ */
5295
+ hint_custom_component?: string;
5296
+ /**
5297
+ * The placement of the hint tooltip.
5298
+ * The value should be a valid `@mui/core` tooltip placement.
5299
+ *
5300
+ * example:
5301
+ * top
5302
+ */
5303
+ hint_tooltip_placement?: string;
5304
+ };
4134
5305
  type?: "tags";
4135
5306
  options?: string[];
4136
5307
  suggestions?: string[];
@@ -4260,6 +5431,38 @@ declare namespace Components {
4260
5431
  * Setting to `true` prevents the attribute from being modified / deleted
4261
5432
  */
4262
5433
  protected?: boolean;
5434
+ /**
5435
+ * A set of configurations meant to document and assist the user in filling the attribute.
5436
+ */
5437
+ info_helpers?: {
5438
+ /**
5439
+ * The text to be displayed in the attribute hint helper.
5440
+ * When specified it overrides the `hint_text_key` configuration.
5441
+ *
5442
+ */
5443
+ hint_text?: string;
5444
+ /**
5445
+ * The key of the hint text to be displayed in the attribute hint helper.
5446
+ * The key should be a valid i18n key.
5447
+ *
5448
+ */
5449
+ hint_text_key?: string;
5450
+ /**
5451
+ * The name of the custom component to be used as the hint helper.
5452
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5453
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5454
+ *
5455
+ */
5456
+ hint_custom_component?: string;
5457
+ /**
5458
+ * The placement of the hint tooltip.
5459
+ * The value should be a valid `@mui/core` tooltip placement.
5460
+ *
5461
+ * example:
5462
+ * top
5463
+ */
5464
+ hint_tooltip_placement?: string;
5465
+ };
4263
5466
  type?: "string";
4264
5467
  multiline?: boolean;
4265
5468
  }
@@ -4349,6 +5552,38 @@ declare namespace Components {
4349
5552
  * Setting to `true` prevents the attribute from being modified / deleted
4350
5553
  */
4351
5554
  protected?: boolean;
5555
+ /**
5556
+ * A set of configurations meant to document and assist the user in filling the attribute.
5557
+ */
5558
+ info_helpers?: {
5559
+ /**
5560
+ * The text to be displayed in the attribute hint helper.
5561
+ * When specified it overrides the `hint_text_key` configuration.
5562
+ *
5563
+ */
5564
+ hint_text?: string;
5565
+ /**
5566
+ * The key of the hint text to be displayed in the attribute hint helper.
5567
+ * The key should be a valid i18n key.
5568
+ *
5569
+ */
5570
+ hint_text_key?: string;
5571
+ /**
5572
+ * The name of the custom component to be used as the hint helper.
5573
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5574
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5575
+ *
5576
+ */
5577
+ hint_custom_component?: string;
5578
+ /**
5579
+ * The placement of the hint tooltip.
5580
+ * The value should be a valid `@mui/core` tooltip placement.
5581
+ *
5582
+ * example:
5583
+ * top
5584
+ */
5585
+ hint_tooltip_placement?: string;
5586
+ };
4352
5587
  type?: "relation_user";
4353
5588
  multiple?: boolean;
4354
5589
  }
@@ -4483,13 +5718,31 @@ declare namespace Paths {
4483
5718
  * {
4484
5719
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4485
5720
  * "_org": "123",
5721
+ * "_owners": [
5722
+ * {
5723
+ * "org_id": "123",
5724
+ * "user_id": "123"
5725
+ * }
5726
+ * ],
4486
5727
  * "_schema": "contact",
4487
5728
  * "_tags": [
4488
5729
  * "example",
4489
5730
  * "mock"
4490
5731
  * ],
4491
5732
  * "_created_at": "2021-02-09T12:41:43.662Z",
4492
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5733
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
5734
+ * "_acl": {
5735
+ * "view": [
5736
+ * "org:456",
5737
+ * "org:789"
5738
+ * ],
5739
+ * "edit": [
5740
+ * "org:456"
5741
+ * ],
5742
+ * "delete": [
5743
+ * "org:456"
5744
+ * ]
5745
+ * }
4493
5746
  * }
4494
5747
  */
4495
5748
  Components.Schemas.Entity;
@@ -4499,6 +5752,16 @@ declare namespace Paths {
4499
5752
  * {
4500
5753
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4501
5754
  * "_org": "123",
5755
+ * "_owners": [
5756
+ * {
5757
+ * "org_id": "123",
5758
+ * "user_id": "123"
5759
+ * },
5760
+ * {
5761
+ * "org_id": "123",
5762
+ * "user_id": "123"
5763
+ * }
5764
+ * ],
4502
5765
  * "_schema": "contact",
4503
5766
  * "_tags": [
4504
5767
  * "example",
@@ -4507,7 +5770,23 @@ declare namespace Paths {
4507
5770
  * "mock"
4508
5771
  * ],
4509
5772
  * "_created_at": "2021-02-09T12:41:43.662Z",
4510
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5773
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
5774
+ * "_acl": {
5775
+ * "view": [
5776
+ * "org:456",
5777
+ * "org:789",
5778
+ * "org:456",
5779
+ * "org:789"
5780
+ * ],
5781
+ * "edit": [
5782
+ * "org:456",
5783
+ * "org:456"
5784
+ * ],
5785
+ * "delete": [
5786
+ * "org:456",
5787
+ * "org:456"
5788
+ * ]
5789
+ * }
4511
5790
  * }
4512
5791
  */
4513
5792
  Components.Schemas.EntityItem;
@@ -4667,6 +5946,16 @@ declare namespace Paths {
4667
5946
  * {
4668
5947
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4669
5948
  * "_org": "123",
5949
+ * "_owners": [
5950
+ * {
5951
+ * "org_id": "123",
5952
+ * "user_id": "123"
5953
+ * },
5954
+ * {
5955
+ * "org_id": "123",
5956
+ * "user_id": "123"
5957
+ * }
5958
+ * ],
4670
5959
  * "_schema": "contact",
4671
5960
  * "_tags": [
4672
5961
  * "example",
@@ -4675,7 +5964,23 @@ declare namespace Paths {
4675
5964
  * "mock"
4676
5965
  * ],
4677
5966
  * "_created_at": "2021-02-09T12:41:43.662Z",
4678
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5967
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
5968
+ * "_acl": {
5969
+ * "view": [
5970
+ * "org:456",
5971
+ * "org:789",
5972
+ * "org:456",
5973
+ * "org:789"
5974
+ * ],
5975
+ * "edit": [
5976
+ * "org:456",
5977
+ * "org:456"
5978
+ * ],
5979
+ * "delete": [
5980
+ * "org:456",
5981
+ * "org:456"
5982
+ * ]
5983
+ * }
4679
5984
  * }
4680
5985
  */
4681
5986
  Components.Schemas.EntityItem;
@@ -4684,6 +5989,16 @@ declare namespace Paths {
4684
5989
  * {
4685
5990
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4686
5991
  * "_org": "123",
5992
+ * "_owners": [
5993
+ * {
5994
+ * "org_id": "123",
5995
+ * "user_id": "123"
5996
+ * },
5997
+ * {
5998
+ * "org_id": "123",
5999
+ * "user_id": "123"
6000
+ * }
6001
+ * ],
4687
6002
  * "_schema": "contact",
4688
6003
  * "_tags": [
4689
6004
  * "example",
@@ -4692,7 +6007,23 @@ declare namespace Paths {
4692
6007
  * "mock"
4693
6008
  * ],
4694
6009
  * "_created_at": "2021-02-09T12:41:43.662Z",
4695
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6010
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6011
+ * "_acl": {
6012
+ * "view": [
6013
+ * "org:456",
6014
+ * "org:789",
6015
+ * "org:456",
6016
+ * "org:789"
6017
+ * ],
6018
+ * "edit": [
6019
+ * "org:456",
6020
+ * "org:456"
6021
+ * ],
6022
+ * "delete": [
6023
+ * "org:456",
6024
+ * "org:456"
6025
+ * ]
6026
+ * }
4696
6027
  * }
4697
6028
  */
4698
6029
  Components.Schemas.EntityItem[];
@@ -4994,13 +6325,31 @@ declare namespace Paths {
4994
6325
  * {
4995
6326
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4996
6327
  * "_org": "123",
6328
+ * "_owners": [
6329
+ * {
6330
+ * "org_id": "123",
6331
+ * "user_id": "123"
6332
+ * }
6333
+ * ],
4997
6334
  * "_schema": "contact",
4998
6335
  * "_tags": [
4999
6336
  * "example",
5000
6337
  * "mock"
5001
6338
  * ],
5002
6339
  * "_created_at": "2021-02-09T12:41:43.662Z",
5003
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6340
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6341
+ * "_acl": {
6342
+ * "view": [
6343
+ * "org:456",
6344
+ * "org:789"
6345
+ * ],
6346
+ * "edit": [
6347
+ * "org:456"
6348
+ * ],
6349
+ * "delete": [
6350
+ * "org:456"
6351
+ * ]
6352
+ * }
5004
6353
  * }
5005
6354
  */
5006
6355
  Components.Schemas.Entity;
@@ -5010,6 +6359,16 @@ declare namespace Paths {
5010
6359
  * {
5011
6360
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5012
6361
  * "_org": "123",
6362
+ * "_owners": [
6363
+ * {
6364
+ * "org_id": "123",
6365
+ * "user_id": "123"
6366
+ * },
6367
+ * {
6368
+ * "org_id": "123",
6369
+ * "user_id": "123"
6370
+ * }
6371
+ * ],
5013
6372
  * "_schema": "contact",
5014
6373
  * "_tags": [
5015
6374
  * "example",
@@ -5018,7 +6377,23 @@ declare namespace Paths {
5018
6377
  * "mock"
5019
6378
  * ],
5020
6379
  * "_created_at": "2021-02-09T12:41:43.662Z",
5021
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6380
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6381
+ * "_acl": {
6382
+ * "view": [
6383
+ * "org:456",
6384
+ * "org:789",
6385
+ * "org:456",
6386
+ * "org:789"
6387
+ * ],
6388
+ * "edit": [
6389
+ * "org:456",
6390
+ * "org:456"
6391
+ * ],
6392
+ * "delete": [
6393
+ * "org:456",
6394
+ * "org:456"
6395
+ * ]
6396
+ * }
5022
6397
  * }
5023
6398
  */
5024
6399
  Components.Schemas.EntityItem;
@@ -5136,13 +6511,31 @@ declare namespace Paths {
5136
6511
  * {
5137
6512
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5138
6513
  * "_org": "123",
6514
+ * "_owners": [
6515
+ * {
6516
+ * "org_id": "123",
6517
+ * "user_id": "123"
6518
+ * }
6519
+ * ],
5139
6520
  * "_schema": "contact",
5140
6521
  * "_tags": [
5141
6522
  * "example",
5142
6523
  * "mock"
5143
6524
  * ],
5144
6525
  * "_created_at": "2021-02-09T12:41:43.662Z",
5145
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6526
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6527
+ * "_acl": {
6528
+ * "view": [
6529
+ * "org:456",
6530
+ * "org:789"
6531
+ * ],
6532
+ * "edit": [
6533
+ * "org:456"
6534
+ * ],
6535
+ * "delete": [
6536
+ * "org:456"
6537
+ * ]
6538
+ * }
5146
6539
  * }
5147
6540
  */
5148
6541
  Components.Schemas.Entity;
@@ -5152,6 +6545,16 @@ declare namespace Paths {
5152
6545
  * {
5153
6546
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5154
6547
  * "_org": "123",
6548
+ * "_owners": [
6549
+ * {
6550
+ * "org_id": "123",
6551
+ * "user_id": "123"
6552
+ * },
6553
+ * {
6554
+ * "org_id": "123",
6555
+ * "user_id": "123"
6556
+ * }
6557
+ * ],
5155
6558
  * "_schema": "contact",
5156
6559
  * "_tags": [
5157
6560
  * "example",
@@ -5160,7 +6563,23 @@ declare namespace Paths {
5160
6563
  * "mock"
5161
6564
  * ],
5162
6565
  * "_created_at": "2021-02-09T12:41:43.662Z",
5163
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6566
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6567
+ * "_acl": {
6568
+ * "view": [
6569
+ * "org:456",
6570
+ * "org:789",
6571
+ * "org:456",
6572
+ * "org:789"
6573
+ * ],
6574
+ * "edit": [
6575
+ * "org:456",
6576
+ * "org:456"
6577
+ * ],
6578
+ * "delete": [
6579
+ * "org:456",
6580
+ * "org:456"
6581
+ * ]
6582
+ * }
5164
6583
  * }
5165
6584
  */
5166
6585
  Components.Schemas.EntityItem;
@@ -5245,13 +6664,31 @@ declare namespace Paths {
5245
6664
  * {
5246
6665
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5247
6666
  * "_org": "123",
6667
+ * "_owners": [
6668
+ * {
6669
+ * "org_id": "123",
6670
+ * "user_id": "123"
6671
+ * }
6672
+ * ],
5248
6673
  * "_schema": "contact",
5249
6674
  * "_tags": [
5250
6675
  * "example",
5251
6676
  * "mock"
5252
6677
  * ],
5253
6678
  * "_created_at": "2021-02-09T12:41:43.662Z",
5254
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6679
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6680
+ * "_acl": {
6681
+ * "view": [
6682
+ * "org:456",
6683
+ * "org:789"
6684
+ * ],
6685
+ * "edit": [
6686
+ * "org:456"
6687
+ * ],
6688
+ * "delete": [
6689
+ * "org:456"
6690
+ * ]
6691
+ * }
5255
6692
  * }
5256
6693
  */
5257
6694
  Components.Schemas.Entity;
@@ -5262,6 +6699,16 @@ declare namespace Paths {
5262
6699
  * {
5263
6700
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5264
6701
  * "_org": "123",
6702
+ * "_owners": [
6703
+ * {
6704
+ * "org_id": "123",
6705
+ * "user_id": "123"
6706
+ * },
6707
+ * {
6708
+ * "org_id": "123",
6709
+ * "user_id": "123"
6710
+ * }
6711
+ * ],
5265
6712
  * "_schema": "contact",
5266
6713
  * "_tags": [
5267
6714
  * "example",
@@ -5270,7 +6717,23 @@ declare namespace Paths {
5270
6717
  * "mock"
5271
6718
  * ],
5272
6719
  * "_created_at": "2021-02-09T12:41:43.662Z",
5273
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6720
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6721
+ * "_acl": {
6722
+ * "view": [
6723
+ * "org:456",
6724
+ * "org:789",
6725
+ * "org:456",
6726
+ * "org:789"
6727
+ * ],
6728
+ * "edit": [
6729
+ * "org:456",
6730
+ * "org:456"
6731
+ * ],
6732
+ * "delete": [
6733
+ * "org:456",
6734
+ * "org:456"
6735
+ * ]
6736
+ * }
5274
6737
  * }
5275
6738
  */
5276
6739
  Components.Schemas.EntityItem;
@@ -5279,6 +6742,16 @@ declare namespace Paths {
5279
6742
  * {
5280
6743
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5281
6744
  * "_org": "123",
6745
+ * "_owners": [
6746
+ * {
6747
+ * "org_id": "123",
6748
+ * "user_id": "123"
6749
+ * },
6750
+ * {
6751
+ * "org_id": "123",
6752
+ * "user_id": "123"
6753
+ * }
6754
+ * ],
5282
6755
  * "_schema": "contact",
5283
6756
  * "_tags": [
5284
6757
  * "example",
@@ -5287,7 +6760,23 @@ declare namespace Paths {
5287
6760
  * "mock"
5288
6761
  * ],
5289
6762
  * "_created_at": "2021-02-09T12:41:43.662Z",
5290
- * "_updated_at": "2021-02-09T12:41:43.662Z"
6763
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
6764
+ * "_acl": {
6765
+ * "view": [
6766
+ * "org:456",
6767
+ * "org:789",
6768
+ * "org:456",
6769
+ * "org:789"
6770
+ * ],
6771
+ * "edit": [
6772
+ * "org:456",
6773
+ * "org:456"
6774
+ * ],
6775
+ * "delete": [
6776
+ * "org:456",
6777
+ * "org:456"
6778
+ * ]
6779
+ * }
5291
6780
  * }
5292
6781
  */
5293
6782
  Components.Schemas.EntityItem;