@epilot/entity-client 1.30.2 → 2.0.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.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +221 -205
- package/dist/openapi.json +152 -237
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -146,19 +146,25 @@ declare namespace Components {
|
|
|
146
146
|
download_url: string;
|
|
147
147
|
alt_text?: string;
|
|
148
148
|
}
|
|
149
|
-
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /*
|
|
149
|
+
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute;
|
|
150
150
|
export interface BaseAttribute {
|
|
151
151
|
name: string;
|
|
152
152
|
label: string;
|
|
153
153
|
placeholder?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Do not render attribute in entity views
|
|
156
|
+
*/
|
|
154
157
|
hidden?: boolean;
|
|
158
|
+
/**
|
|
159
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
160
|
+
*/
|
|
161
|
+
show_in_table?: boolean;
|
|
155
162
|
required?: boolean;
|
|
156
163
|
readonly?: boolean;
|
|
157
|
-
show_in_table?: boolean;
|
|
158
164
|
deprecated?: boolean;
|
|
159
165
|
default_value?: string | {
|
|
160
166
|
[name: string]: any;
|
|
161
|
-
} | number | number | boolean;
|
|
167
|
+
} | number | number | boolean | any[];
|
|
162
168
|
group?: string;
|
|
163
169
|
layout?: string;
|
|
164
170
|
/**
|
|
@@ -231,17 +237,10 @@ declare namespace Components {
|
|
|
231
237
|
_created_at: string; // date-time
|
|
232
238
|
_updated_at: string; // date-time
|
|
233
239
|
}
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
* example:
|
|
238
|
-
* Power & Gas Utilities
|
|
239
|
-
*/
|
|
240
|
-
name?: string;
|
|
241
|
-
schemas?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ EntitySchema[];
|
|
242
|
-
}
|
|
240
|
+
/**
|
|
241
|
+
* Reference to blueprint
|
|
242
|
+
*/
|
|
243
243
|
export type BlueprintEntityId = string; // uuid
|
|
244
|
-
export type BlueprintId = string; // uuid
|
|
245
244
|
/**
|
|
246
245
|
* Yes / No Toggle
|
|
247
246
|
*/
|
|
@@ -249,14 +248,20 @@ declare namespace Components {
|
|
|
249
248
|
name: string;
|
|
250
249
|
label: string;
|
|
251
250
|
placeholder?: string;
|
|
251
|
+
/**
|
|
252
|
+
* Do not render attribute in entity views
|
|
253
|
+
*/
|
|
252
254
|
hidden?: boolean;
|
|
255
|
+
/**
|
|
256
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
257
|
+
*/
|
|
258
|
+
show_in_table?: boolean;
|
|
253
259
|
required?: boolean;
|
|
254
260
|
readonly?: boolean;
|
|
255
|
-
show_in_table?: boolean;
|
|
256
261
|
deprecated?: boolean;
|
|
257
262
|
default_value?: string | {
|
|
258
263
|
[name: string]: any;
|
|
259
|
-
} | number | number | boolean;
|
|
264
|
+
} | number | number | boolean | any[];
|
|
260
265
|
group?: string;
|
|
261
266
|
layout?: string;
|
|
262
267
|
/**
|
|
@@ -303,14 +308,20 @@ declare namespace Components {
|
|
|
303
308
|
name: string;
|
|
304
309
|
label: string;
|
|
305
310
|
placeholder?: string;
|
|
311
|
+
/**
|
|
312
|
+
* Do not render attribute in entity views
|
|
313
|
+
*/
|
|
306
314
|
hidden?: boolean;
|
|
315
|
+
/**
|
|
316
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
317
|
+
*/
|
|
318
|
+
show_in_table?: boolean;
|
|
307
319
|
required?: boolean;
|
|
308
320
|
readonly?: boolean;
|
|
309
|
-
show_in_table?: boolean;
|
|
310
321
|
deprecated?: boolean;
|
|
311
322
|
default_value?: string | {
|
|
312
323
|
[name: string]: any;
|
|
313
|
-
} | number | number | boolean;
|
|
324
|
+
} | number | number | boolean | any[];
|
|
314
325
|
group?: string;
|
|
315
326
|
layout?: string;
|
|
316
327
|
/**
|
|
@@ -359,14 +370,20 @@ declare namespace Components {
|
|
|
359
370
|
name: string;
|
|
360
371
|
label: string;
|
|
361
372
|
placeholder?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Do not render attribute in entity views
|
|
375
|
+
*/
|
|
362
376
|
hidden?: boolean;
|
|
377
|
+
/**
|
|
378
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
379
|
+
*/
|
|
380
|
+
show_in_table?: boolean;
|
|
363
381
|
required?: boolean;
|
|
364
382
|
readonly?: boolean;
|
|
365
|
-
show_in_table?: boolean;
|
|
366
383
|
deprecated?: boolean;
|
|
367
384
|
default_value?: string | {
|
|
368
385
|
[name: string]: any;
|
|
369
|
-
} | number | number | boolean;
|
|
386
|
+
} | number | number | boolean | any[];
|
|
370
387
|
group?: string;
|
|
371
388
|
layout?: string;
|
|
372
389
|
/**
|
|
@@ -413,14 +430,20 @@ declare namespace Components {
|
|
|
413
430
|
name: string;
|
|
414
431
|
label: string;
|
|
415
432
|
placeholder?: string;
|
|
433
|
+
/**
|
|
434
|
+
* Do not render attribute in entity views
|
|
435
|
+
*/
|
|
416
436
|
hidden?: boolean;
|
|
437
|
+
/**
|
|
438
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
439
|
+
*/
|
|
440
|
+
show_in_table?: boolean;
|
|
417
441
|
required?: boolean;
|
|
418
442
|
readonly?: boolean;
|
|
419
|
-
show_in_table?: boolean;
|
|
420
443
|
deprecated?: boolean;
|
|
421
444
|
default_value?: string | {
|
|
422
445
|
[name: string]: any;
|
|
423
|
-
} | number | number | boolean;
|
|
446
|
+
} | number | number | boolean | any[];
|
|
424
447
|
group?: string;
|
|
425
448
|
layout?: string;
|
|
426
449
|
/**
|
|
@@ -476,14 +499,20 @@ declare namespace Components {
|
|
|
476
499
|
name: string;
|
|
477
500
|
label: string;
|
|
478
501
|
placeholder?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Do not render attribute in entity views
|
|
504
|
+
*/
|
|
479
505
|
hidden?: boolean;
|
|
506
|
+
/**
|
|
507
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
508
|
+
*/
|
|
509
|
+
show_in_table?: boolean;
|
|
480
510
|
required?: boolean;
|
|
481
511
|
readonly?: boolean;
|
|
482
|
-
show_in_table?: boolean;
|
|
483
512
|
deprecated?: boolean;
|
|
484
513
|
default_value?: string | {
|
|
485
514
|
[name: string]: any;
|
|
486
|
-
} | number | number | boolean;
|
|
515
|
+
} | number | number | boolean | any[];
|
|
487
516
|
group?: string;
|
|
488
517
|
layout?: string;
|
|
489
518
|
/**
|
|
@@ -611,13 +640,13 @@ declare namespace Components {
|
|
|
611
640
|
legacy?: boolean;
|
|
612
641
|
}
|
|
613
642
|
export interface EntityDefaultCreate {
|
|
614
|
-
|
|
643
|
+
view_type?: "default";
|
|
615
644
|
}
|
|
616
645
|
export interface EntityDefaultEdit {
|
|
617
|
-
|
|
646
|
+
view_type?: "default";
|
|
618
647
|
}
|
|
619
648
|
export interface EntityDefaultOverview {
|
|
620
|
-
|
|
649
|
+
view_type?: "default";
|
|
621
650
|
dropdown_items?: ({
|
|
622
651
|
type?: "entity";
|
|
623
652
|
entity?: /**
|
|
@@ -632,6 +661,10 @@ declare namespace Components {
|
|
|
632
661
|
* FF_MY_FEATURE_FLAG
|
|
633
662
|
*/
|
|
634
663
|
feature_flag?: string;
|
|
664
|
+
/**
|
|
665
|
+
* Only show item for legacy tenants (ivy)
|
|
666
|
+
*/
|
|
667
|
+
legacy?: boolean;
|
|
635
668
|
} | {
|
|
636
669
|
type?: "link";
|
|
637
670
|
/**
|
|
@@ -646,6 +679,10 @@ declare namespace Components {
|
|
|
646
679
|
* FF_MY_FEATURE_FLAG
|
|
647
680
|
*/
|
|
648
681
|
feature_flag?: string;
|
|
682
|
+
/**
|
|
683
|
+
* Only show item for legacy tenants (ivy)
|
|
684
|
+
*/
|
|
685
|
+
legacy?: boolean;
|
|
649
686
|
})[];
|
|
650
687
|
row_actions?: string[];
|
|
651
688
|
classic_view?: string; // uri
|
|
@@ -729,7 +766,7 @@ declare namespace Components {
|
|
|
729
766
|
* }
|
|
730
767
|
*/
|
|
731
768
|
export interface EntityParcelView {
|
|
732
|
-
|
|
769
|
+
view_type?: "parcel";
|
|
733
770
|
/**
|
|
734
771
|
* example:
|
|
735
772
|
* @epilot360/pricing-hub-app
|
|
@@ -746,13 +783,17 @@ declare namespace Components {
|
|
|
746
783
|
* contact
|
|
747
784
|
*/
|
|
748
785
|
EntitySlug;
|
|
749
|
-
blueprint?: BlueprintEntityId /* uuid */;
|
|
786
|
+
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
750
787
|
/**
|
|
751
788
|
* This schema should only be active when the feature flag is enabled
|
|
752
789
|
* example:
|
|
753
790
|
* FF_MY_FEATURE_FLAG
|
|
754
791
|
*/
|
|
755
792
|
feature_flag?: string;
|
|
793
|
+
/**
|
|
794
|
+
* This schema should only be active when one of the organization settings is enabled
|
|
795
|
+
*/
|
|
796
|
+
enable_setting?: string[];
|
|
756
797
|
/**
|
|
757
798
|
* User-friendly identifier for the entity schema
|
|
758
799
|
* example:
|
|
@@ -775,10 +816,13 @@ declare namespace Components {
|
|
|
775
816
|
* {{first_name}} {{last_name}}
|
|
776
817
|
*/
|
|
777
818
|
title_template?: string;
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
819
|
+
ui_config?: {
|
|
820
|
+
table_view?: EntityViewConfig;
|
|
821
|
+
create_view?: EntityViewConfig;
|
|
822
|
+
edit_view?: EntityViewConfig;
|
|
823
|
+
list_item?: {
|
|
824
|
+
summary_attributes?: string[];
|
|
825
|
+
};
|
|
782
826
|
};
|
|
783
827
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
784
828
|
/**
|
|
@@ -796,10 +840,14 @@ declare namespace Components {
|
|
|
796
840
|
group_settings?: {
|
|
797
841
|
[name: string]: {
|
|
798
842
|
expanded?: boolean;
|
|
843
|
+
/**
|
|
844
|
+
* Render order of the group
|
|
845
|
+
*/
|
|
846
|
+
order?: number;
|
|
799
847
|
};
|
|
800
848
|
};
|
|
801
849
|
/**
|
|
802
|
-
*
|
|
850
|
+
* Custom grid definitions for the layout
|
|
803
851
|
*/
|
|
804
852
|
layout_settings?: {
|
|
805
853
|
[name: string]: {
|
|
@@ -867,13 +915,17 @@ declare namespace Components {
|
|
|
867
915
|
* contact
|
|
868
916
|
*/
|
|
869
917
|
EntitySlug;
|
|
870
|
-
blueprint?: BlueprintEntityId /* uuid */;
|
|
918
|
+
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
871
919
|
/**
|
|
872
920
|
* This schema should only be active when the feature flag is enabled
|
|
873
921
|
* example:
|
|
874
922
|
* FF_MY_FEATURE_FLAG
|
|
875
923
|
*/
|
|
876
924
|
feature_flag?: string;
|
|
925
|
+
/**
|
|
926
|
+
* This schema should only be active when one of the organization settings is enabled
|
|
927
|
+
*/
|
|
928
|
+
enable_setting?: string[];
|
|
877
929
|
/**
|
|
878
930
|
* User-friendly identifier for the entity schema
|
|
879
931
|
* example:
|
|
@@ -896,10 +948,13 @@ declare namespace Components {
|
|
|
896
948
|
* {{first_name}} {{last_name}}
|
|
897
949
|
*/
|
|
898
950
|
title_template?: string;
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
951
|
+
ui_config?: {
|
|
952
|
+
table_view?: EntityViewConfig;
|
|
953
|
+
create_view?: EntityViewConfig;
|
|
954
|
+
edit_view?: EntityViewConfig;
|
|
955
|
+
list_item?: {
|
|
956
|
+
summary_attributes?: string[];
|
|
957
|
+
};
|
|
903
958
|
};
|
|
904
959
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
905
960
|
/**
|
|
@@ -917,10 +972,14 @@ declare namespace Components {
|
|
|
917
972
|
group_settings?: {
|
|
918
973
|
[name: string]: {
|
|
919
974
|
expanded?: boolean;
|
|
975
|
+
/**
|
|
976
|
+
* Render order of the group
|
|
977
|
+
*/
|
|
978
|
+
order?: number;
|
|
920
979
|
};
|
|
921
980
|
};
|
|
922
981
|
/**
|
|
923
|
-
*
|
|
982
|
+
* Custom grid definitions for the layout
|
|
924
983
|
*/
|
|
925
984
|
layout_settings?: {
|
|
926
985
|
[name: string]: {
|
|
@@ -1054,7 +1113,7 @@ declare namespace Components {
|
|
|
1054
1113
|
*/
|
|
1055
1114
|
EntityParcelView | EntityViewDisabled;
|
|
1056
1115
|
export interface EntityViewDisabled {
|
|
1057
|
-
|
|
1116
|
+
view_type?: "disabled";
|
|
1058
1117
|
}
|
|
1059
1118
|
/**
|
|
1060
1119
|
* File or Image Attachment
|
|
@@ -1063,14 +1122,20 @@ declare namespace Components {
|
|
|
1063
1122
|
name: string;
|
|
1064
1123
|
label: string;
|
|
1065
1124
|
placeholder?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Do not render attribute in entity views
|
|
1127
|
+
*/
|
|
1066
1128
|
hidden?: boolean;
|
|
1129
|
+
/**
|
|
1130
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1131
|
+
*/
|
|
1132
|
+
show_in_table?: boolean;
|
|
1067
1133
|
required?: boolean;
|
|
1068
1134
|
readonly?: boolean;
|
|
1069
|
-
show_in_table?: boolean;
|
|
1070
1135
|
deprecated?: boolean;
|
|
1071
1136
|
default_value?: string | {
|
|
1072
1137
|
[name: string]: any;
|
|
1073
|
-
} | number | number | boolean;
|
|
1138
|
+
} | number | number | boolean | any[];
|
|
1074
1139
|
group?: string;
|
|
1075
1140
|
layout?: string;
|
|
1076
1141
|
/**
|
|
@@ -1268,14 +1333,20 @@ declare namespace Components {
|
|
|
1268
1333
|
name: string;
|
|
1269
1334
|
label: string;
|
|
1270
1335
|
placeholder?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Do not render attribute in entity views
|
|
1338
|
+
*/
|
|
1271
1339
|
hidden?: boolean;
|
|
1340
|
+
/**
|
|
1341
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1342
|
+
*/
|
|
1343
|
+
show_in_table?: boolean;
|
|
1272
1344
|
required?: boolean;
|
|
1273
1345
|
readonly?: boolean;
|
|
1274
|
-
show_in_table?: boolean;
|
|
1275
1346
|
deprecated?: boolean;
|
|
1276
1347
|
default_value?: string | {
|
|
1277
1348
|
[name: string]: any;
|
|
1278
|
-
} | number | number | boolean;
|
|
1349
|
+
} | number | number | boolean | any[];
|
|
1279
1350
|
group?: string;
|
|
1280
1351
|
layout?: string;
|
|
1281
1352
|
/**
|
|
@@ -1322,14 +1393,20 @@ declare namespace Components {
|
|
|
1322
1393
|
name: string;
|
|
1323
1394
|
label: string;
|
|
1324
1395
|
placeholder?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* Do not render attribute in entity views
|
|
1398
|
+
*/
|
|
1325
1399
|
hidden?: boolean;
|
|
1400
|
+
/**
|
|
1401
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1402
|
+
*/
|
|
1403
|
+
show_in_table?: boolean;
|
|
1326
1404
|
required?: boolean;
|
|
1327
1405
|
readonly?: boolean;
|
|
1328
|
-
show_in_table?: boolean;
|
|
1329
1406
|
deprecated?: boolean;
|
|
1330
1407
|
default_value?: string | {
|
|
1331
1408
|
[name: string]: any;
|
|
1332
|
-
} | number | number | boolean;
|
|
1409
|
+
} | number | number | boolean | any[];
|
|
1333
1410
|
group?: string;
|
|
1334
1411
|
layout?: string;
|
|
1335
1412
|
/**
|
|
@@ -1376,14 +1453,20 @@ declare namespace Components {
|
|
|
1376
1453
|
name: string;
|
|
1377
1454
|
label: string;
|
|
1378
1455
|
placeholder?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Do not render attribute in entity views
|
|
1458
|
+
*/
|
|
1379
1459
|
hidden?: boolean;
|
|
1460
|
+
/**
|
|
1461
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1462
|
+
*/
|
|
1463
|
+
show_in_table?: boolean;
|
|
1380
1464
|
required?: boolean;
|
|
1381
1465
|
readonly?: boolean;
|
|
1382
|
-
show_in_table?: boolean;
|
|
1383
1466
|
deprecated?: boolean;
|
|
1384
1467
|
default_value?: string | {
|
|
1385
1468
|
[name: string]: any;
|
|
1386
|
-
} | number | number | boolean;
|
|
1469
|
+
} | number | number | boolean | any[];
|
|
1387
1470
|
group?: string;
|
|
1388
1471
|
layout?: string;
|
|
1389
1472
|
/**
|
|
@@ -1431,14 +1514,20 @@ declare namespace Components {
|
|
|
1431
1514
|
name: string;
|
|
1432
1515
|
label: string;
|
|
1433
1516
|
placeholder?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Do not render attribute in entity views
|
|
1519
|
+
*/
|
|
1434
1520
|
hidden?: boolean;
|
|
1521
|
+
/**
|
|
1522
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1523
|
+
*/
|
|
1524
|
+
show_in_table?: boolean;
|
|
1435
1525
|
required?: boolean;
|
|
1436
1526
|
readonly?: boolean;
|
|
1437
|
-
show_in_table?: boolean;
|
|
1438
1527
|
deprecated?: boolean;
|
|
1439
1528
|
default_value?: string | {
|
|
1440
1529
|
[name: string]: any;
|
|
1441
|
-
} | number | number | boolean;
|
|
1530
|
+
} | number | number | boolean | any[];
|
|
1442
1531
|
group?: string;
|
|
1443
1532
|
layout?: string;
|
|
1444
1533
|
/**
|
|
@@ -1486,7 +1575,7 @@ declare namespace Components {
|
|
|
1486
1575
|
* }
|
|
1487
1576
|
*/
|
|
1488
1577
|
export interface RedirectEntityView {
|
|
1489
|
-
|
|
1578
|
+
view_type?: "redirect";
|
|
1490
1579
|
/**
|
|
1491
1580
|
* example:
|
|
1492
1581
|
* /app/pricing-hub/product/:entityId
|
|
@@ -1500,14 +1589,20 @@ declare namespace Components {
|
|
|
1500
1589
|
name: string;
|
|
1501
1590
|
label: string;
|
|
1502
1591
|
placeholder?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* Do not render attribute in entity views
|
|
1594
|
+
*/
|
|
1503
1595
|
hidden?: boolean;
|
|
1596
|
+
/**
|
|
1597
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1598
|
+
*/
|
|
1599
|
+
show_in_table?: boolean;
|
|
1504
1600
|
required?: boolean;
|
|
1505
1601
|
readonly?: boolean;
|
|
1506
|
-
show_in_table?: boolean;
|
|
1507
1602
|
deprecated?: boolean;
|
|
1508
1603
|
default_value?: string | {
|
|
1509
1604
|
[name: string]: any;
|
|
1510
|
-
} | number | number | boolean;
|
|
1605
|
+
} | number | number | boolean | any[];
|
|
1511
1606
|
group?: string;
|
|
1512
1607
|
layout?: string;
|
|
1513
1608
|
/**
|
|
@@ -1566,14 +1661,20 @@ declare namespace Components {
|
|
|
1566
1661
|
name: string;
|
|
1567
1662
|
label: string;
|
|
1568
1663
|
placeholder?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Do not render attribute in entity views
|
|
1666
|
+
*/
|
|
1569
1667
|
hidden?: boolean;
|
|
1668
|
+
/**
|
|
1669
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1670
|
+
*/
|
|
1671
|
+
show_in_table?: boolean;
|
|
1570
1672
|
required?: boolean;
|
|
1571
1673
|
readonly?: boolean;
|
|
1572
|
-
show_in_table?: boolean;
|
|
1573
1674
|
deprecated?: boolean;
|
|
1574
1675
|
default_value?: string | {
|
|
1575
1676
|
[name: string]: any;
|
|
1576
|
-
} | number | number | boolean;
|
|
1677
|
+
} | number | number | boolean | any[];
|
|
1577
1678
|
group?: string;
|
|
1578
1679
|
layout?: string;
|
|
1579
1680
|
/**
|
|
@@ -1626,14 +1727,20 @@ declare namespace Components {
|
|
|
1626
1727
|
name: string;
|
|
1627
1728
|
label: string;
|
|
1628
1729
|
placeholder?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* Do not render attribute in entity views
|
|
1732
|
+
*/
|
|
1629
1733
|
hidden?: boolean;
|
|
1734
|
+
/**
|
|
1735
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1736
|
+
*/
|
|
1737
|
+
show_in_table?: boolean;
|
|
1630
1738
|
required?: boolean;
|
|
1631
1739
|
readonly?: boolean;
|
|
1632
|
-
show_in_table?: boolean;
|
|
1633
1740
|
deprecated?: boolean;
|
|
1634
1741
|
default_value?: string | {
|
|
1635
1742
|
[name: string]: any;
|
|
1636
|
-
} | number | number | boolean;
|
|
1743
|
+
} | number | number | boolean | any[];
|
|
1637
1744
|
group?: string;
|
|
1638
1745
|
layout?: string;
|
|
1639
1746
|
/**
|
|
@@ -1697,14 +1804,20 @@ declare namespace Components {
|
|
|
1697
1804
|
name: string;
|
|
1698
1805
|
label: string;
|
|
1699
1806
|
placeholder?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* Do not render attribute in entity views
|
|
1809
|
+
*/
|
|
1700
1810
|
hidden?: boolean;
|
|
1811
|
+
/**
|
|
1812
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1813
|
+
*/
|
|
1814
|
+
show_in_table?: boolean;
|
|
1701
1815
|
required?: boolean;
|
|
1702
1816
|
readonly?: boolean;
|
|
1703
|
-
show_in_table?: boolean;
|
|
1704
1817
|
deprecated?: boolean;
|
|
1705
1818
|
default_value?: string | {
|
|
1706
1819
|
[name: string]: any;
|
|
1707
|
-
} | number | number | boolean;
|
|
1820
|
+
} | number | number | boolean | any[];
|
|
1708
1821
|
group?: string;
|
|
1709
1822
|
layout?: string;
|
|
1710
1823
|
/**
|
|
@@ -1747,75 +1860,26 @@ declare namespace Components {
|
|
|
1747
1860
|
suggestions?: string[];
|
|
1748
1861
|
}
|
|
1749
1862
|
/**
|
|
1750
|
-
*
|
|
1863
|
+
* Textarea or text input
|
|
1751
1864
|
*/
|
|
1752
|
-
export interface
|
|
1865
|
+
export interface TextAttribute {
|
|
1753
1866
|
name: string;
|
|
1754
1867
|
label: string;
|
|
1755
1868
|
placeholder?: string;
|
|
1756
|
-
hidden?: boolean;
|
|
1757
|
-
required?: boolean;
|
|
1758
|
-
readonly?: boolean;
|
|
1759
|
-
show_in_table?: boolean;
|
|
1760
|
-
deprecated?: boolean;
|
|
1761
|
-
default_value?: string | {
|
|
1762
|
-
[name: string]: any;
|
|
1763
|
-
} | number | number | boolean;
|
|
1764
|
-
group?: string;
|
|
1765
|
-
layout?: string;
|
|
1766
|
-
/**
|
|
1767
|
-
* When set to true, will hide the label of the field.
|
|
1768
|
-
*/
|
|
1769
|
-
hide_label?: boolean;
|
|
1770
1869
|
/**
|
|
1771
|
-
*
|
|
1772
|
-
* The value must be a valid @epilot/base-elements Icon name
|
|
1773
|
-
*
|
|
1774
|
-
*/
|
|
1775
|
-
icon?: string;
|
|
1776
|
-
/**
|
|
1777
|
-
* Defines the conditional rendering expression for showing this field.
|
|
1778
|
-
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
1779
|
-
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
1780
|
-
*
|
|
1781
|
-
*/
|
|
1782
|
-
render_condition?: string;
|
|
1783
|
-
/**
|
|
1784
|
-
* A set of constraints applicable to the attribute.
|
|
1785
|
-
* These constraints should and will be enforced by the attribute renderer.
|
|
1786
|
-
*
|
|
1787
|
-
* example:
|
|
1788
|
-
* {
|
|
1789
|
-
* "disablePast": true
|
|
1790
|
-
* }
|
|
1870
|
+
* Do not render attribute in entity views
|
|
1791
1871
|
*/
|
|
1792
|
-
|
|
1793
|
-
[key: string]: any;
|
|
1794
|
-
};
|
|
1872
|
+
hidden?: boolean;
|
|
1795
1873
|
/**
|
|
1796
|
-
*
|
|
1797
|
-
* example:
|
|
1798
|
-
* FF_MY_FEATURE_FLAG
|
|
1874
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1799
1875
|
*/
|
|
1800
|
-
|
|
1801
|
-
type?: "relation_tax";
|
|
1802
|
-
multiple?: boolean;
|
|
1803
|
-
}
|
|
1804
|
-
/**
|
|
1805
|
-
* Textarea or text input
|
|
1806
|
-
*/
|
|
1807
|
-
export interface TextAttribute {
|
|
1808
|
-
name: string;
|
|
1809
|
-
label: string;
|
|
1810
|
-
placeholder?: string;
|
|
1811
|
-
hidden?: boolean;
|
|
1876
|
+
show_in_table?: boolean;
|
|
1812
1877
|
required?: boolean;
|
|
1813
1878
|
readonly?: boolean;
|
|
1814
|
-
show_in_table?: boolean;
|
|
1815
1879
|
deprecated?: boolean;
|
|
1816
1880
|
default_value?: string | {
|
|
1817
1881
|
[name: string]: any;
|
|
1818
|
-
} | number | number | boolean;
|
|
1882
|
+
} | number | number | boolean | any[];
|
|
1819
1883
|
group?: string;
|
|
1820
1884
|
layout?: string;
|
|
1821
1885
|
/**
|
|
@@ -1863,14 +1927,20 @@ declare namespace Components {
|
|
|
1863
1927
|
name: string;
|
|
1864
1928
|
label: string;
|
|
1865
1929
|
placeholder?: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* Do not render attribute in entity views
|
|
1932
|
+
*/
|
|
1866
1933
|
hidden?: boolean;
|
|
1934
|
+
/**
|
|
1935
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1936
|
+
*/
|
|
1937
|
+
show_in_table?: boolean;
|
|
1867
1938
|
required?: boolean;
|
|
1868
1939
|
readonly?: boolean;
|
|
1869
|
-
show_in_table?: boolean;
|
|
1870
1940
|
deprecated?: boolean;
|
|
1871
1941
|
default_value?: string | {
|
|
1872
1942
|
[name: string]: any;
|
|
1873
|
-
} | number | number | boolean;
|
|
1943
|
+
} | number | number | boolean | any[];
|
|
1874
1944
|
group?: string;
|
|
1875
1945
|
layout?: string;
|
|
1876
1946
|
/**
|
|
@@ -2092,17 +2162,6 @@ declare namespace Paths {
|
|
|
2092
2162
|
export type $200 = Components.Schemas.ActivityItem;
|
|
2093
2163
|
}
|
|
2094
2164
|
}
|
|
2095
|
-
namespace GetBlueprint {
|
|
2096
|
-
namespace Parameters {
|
|
2097
|
-
export type Id = Components.Schemas.BlueprintId /* uuid */;
|
|
2098
|
-
}
|
|
2099
|
-
export interface PathParameters {
|
|
2100
|
-
id: Parameters.Id;
|
|
2101
|
-
}
|
|
2102
|
-
namespace Responses {
|
|
2103
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
2104
|
-
}
|
|
2105
|
-
}
|
|
2106
2165
|
namespace GetEntity {
|
|
2107
2166
|
namespace Parameters {
|
|
2108
2167
|
export type Hydrate = boolean;
|
|
@@ -2241,13 +2300,6 @@ declare namespace Paths {
|
|
|
2241
2300
|
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
2242
2301
|
}
|
|
2243
2302
|
}
|
|
2244
|
-
namespace SearchAvailableBlueprints {
|
|
2245
|
-
namespace Responses {
|
|
2246
|
-
export interface $200 {
|
|
2247
|
-
results?: Components.Schemas.Blueprint[];
|
|
2248
|
-
}
|
|
2249
|
-
}
|
|
2250
|
-
}
|
|
2251
2303
|
namespace SearchEntities {
|
|
2252
2304
|
export type RequestBody = Components.Schemas.EntitySearchParams;
|
|
2253
2305
|
namespace Responses {
|
|
@@ -2450,17 +2502,6 @@ export interface OperationMethods {
|
|
|
2450
2502
|
data?: Paths.SearchEntities.RequestBody,
|
|
2451
2503
|
config?: AxiosRequestConfig
|
|
2452
2504
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
2453
|
-
/**
|
|
2454
|
-
* autocomplete - autocomplete
|
|
2455
|
-
*
|
|
2456
|
-
* Autocomplete entity attributes
|
|
2457
|
-
*
|
|
2458
|
-
*/
|
|
2459
|
-
'autocomplete'(
|
|
2460
|
-
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2461
|
-
data?: any,
|
|
2462
|
-
config?: AxiosRequestConfig
|
|
2463
|
-
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2464
2505
|
/**
|
|
2465
2506
|
* createEntity - createEntity
|
|
2466
2507
|
*
|
|
@@ -2618,6 +2659,17 @@ export interface OperationMethods {
|
|
|
2618
2659
|
data?: any,
|
|
2619
2660
|
config?: AxiosRequestConfig
|
|
2620
2661
|
): OperationResponse<Paths.DeleteEntity.Responses.$200>
|
|
2662
|
+
/**
|
|
2663
|
+
* autocomplete - autocomplete
|
|
2664
|
+
*
|
|
2665
|
+
* Autocomplete entity attributes
|
|
2666
|
+
*
|
|
2667
|
+
*/
|
|
2668
|
+
'autocomplete'(
|
|
2669
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2670
|
+
data?: any,
|
|
2671
|
+
config?: AxiosRequestConfig
|
|
2672
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2621
2673
|
/**
|
|
2622
2674
|
* createActivity - createActivity
|
|
2623
2675
|
*
|
|
@@ -2663,26 +2715,10 @@ export interface OperationMethods {
|
|
|
2663
2715
|
data?: any,
|
|
2664
2716
|
config?: AxiosRequestConfig
|
|
2665
2717
|
): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
|
|
2666
|
-
/**
|
|
2667
|
-
* searchAvailableBlueprints - searchAvailableBlueprints
|
|
2668
|
-
*/
|
|
2669
|
-
'searchAvailableBlueprints'(
|
|
2670
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2671
|
-
data?: any,
|
|
2672
|
-
config?: AxiosRequestConfig
|
|
2673
|
-
): OperationResponse<Paths.SearchAvailableBlueprints.Responses.$200>
|
|
2674
|
-
/**
|
|
2675
|
-
* getBlueprint - getBlueprint
|
|
2676
|
-
*/
|
|
2677
|
-
'getBlueprint'(
|
|
2678
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
2679
|
-
data?: any,
|
|
2680
|
-
config?: AxiosRequestConfig
|
|
2681
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
2682
2718
|
}
|
|
2683
2719
|
|
|
2684
2720
|
export interface PathsDictionary {
|
|
2685
|
-
['/schemas']: {
|
|
2721
|
+
['/v1/entity/schemas']: {
|
|
2686
2722
|
/**
|
|
2687
2723
|
* listSchemas - listSchemas
|
|
2688
2724
|
*/
|
|
@@ -2692,7 +2728,7 @@ export interface PathsDictionary {
|
|
|
2692
2728
|
config?: AxiosRequestConfig
|
|
2693
2729
|
): OperationResponse<Paths.ListSchemas.Responses.$200>
|
|
2694
2730
|
}
|
|
2695
|
-
['/schemas/{slug}']: {
|
|
2731
|
+
['/v1/entity/schemas/{slug}']: {
|
|
2696
2732
|
/**
|
|
2697
2733
|
* getSchema - getSchema
|
|
2698
2734
|
*/
|
|
@@ -2718,7 +2754,7 @@ export interface PathsDictionary {
|
|
|
2718
2754
|
config?: AxiosRequestConfig
|
|
2719
2755
|
): OperationResponse<Paths.DeleteSchema.Responses.$204>
|
|
2720
2756
|
}
|
|
2721
|
-
['/entity:search']: {
|
|
2757
|
+
['/v1/entity:search']: {
|
|
2722
2758
|
/**
|
|
2723
2759
|
* searchEntities - searchEntities
|
|
2724
2760
|
*
|
|
@@ -2773,20 +2809,7 @@ export interface PathsDictionary {
|
|
|
2773
2809
|
config?: AxiosRequestConfig
|
|
2774
2810
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
2775
2811
|
}
|
|
2776
|
-
['/entity
|
|
2777
|
-
/**
|
|
2778
|
-
* autocomplete - autocomplete
|
|
2779
|
-
*
|
|
2780
|
-
* Autocomplete entity attributes
|
|
2781
|
-
*
|
|
2782
|
-
*/
|
|
2783
|
-
'get'(
|
|
2784
|
-
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2785
|
-
data?: any,
|
|
2786
|
-
config?: AxiosRequestConfig
|
|
2787
|
-
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2788
|
-
}
|
|
2789
|
-
['/entity/{slug}']: {
|
|
2812
|
+
['/v1/entity/{slug}']: {
|
|
2790
2813
|
/**
|
|
2791
2814
|
* createEntity - createEntity
|
|
2792
2815
|
*
|
|
@@ -2823,7 +2846,7 @@ export interface PathsDictionary {
|
|
|
2823
2846
|
config?: AxiosRequestConfig
|
|
2824
2847
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
2825
2848
|
}
|
|
2826
|
-
['/entity/{slug}:upsert']: {
|
|
2849
|
+
['/v1/entity/{slug}:upsert']: {
|
|
2827
2850
|
/**
|
|
2828
2851
|
* upsertEntity - upsertEntity
|
|
2829
2852
|
*
|
|
@@ -2844,7 +2867,7 @@ export interface PathsDictionary {
|
|
|
2844
2867
|
config?: AxiosRequestConfig
|
|
2845
2868
|
): OperationResponse<Paths.UpsertEntity.Responses.$200 | Paths.UpsertEntity.Responses.$201>
|
|
2846
2869
|
}
|
|
2847
|
-
['/entity/{slug}/{id}']: {
|
|
2870
|
+
['/v1/entity/{slug}/{id}']: {
|
|
2848
2871
|
/**
|
|
2849
2872
|
* getEntity - getEntity
|
|
2850
2873
|
*
|
|
@@ -2949,7 +2972,20 @@ export interface PathsDictionary {
|
|
|
2949
2972
|
config?: AxiosRequestConfig
|
|
2950
2973
|
): OperationResponse<Paths.DeleteEntity.Responses.$200>
|
|
2951
2974
|
}
|
|
2952
|
-
['/
|
|
2975
|
+
['/v1/entity:autocomplete']: {
|
|
2976
|
+
/**
|
|
2977
|
+
* autocomplete - autocomplete
|
|
2978
|
+
*
|
|
2979
|
+
* Autocomplete entity attributes
|
|
2980
|
+
*
|
|
2981
|
+
*/
|
|
2982
|
+
'get'(
|
|
2983
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2984
|
+
data?: any,
|
|
2985
|
+
config?: AxiosRequestConfig
|
|
2986
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2987
|
+
}
|
|
2988
|
+
['/v1/entity/activity']: {
|
|
2953
2989
|
/**
|
|
2954
2990
|
* createActivity - createActivity
|
|
2955
2991
|
*
|
|
@@ -2965,7 +3001,7 @@ export interface PathsDictionary {
|
|
|
2965
3001
|
config?: AxiosRequestConfig
|
|
2966
3002
|
): OperationResponse<Paths.CreateActivity.Responses.$200>
|
|
2967
3003
|
}
|
|
2968
|
-
['/activity/{id}']: {
|
|
3004
|
+
['/v1/entity/activity/{id}']: {
|
|
2969
3005
|
/**
|
|
2970
3006
|
* getActivity - getActivity
|
|
2971
3007
|
*
|
|
@@ -2977,7 +3013,7 @@ export interface PathsDictionary {
|
|
|
2977
3013
|
config?: AxiosRequestConfig
|
|
2978
3014
|
): OperationResponse<Paths.GetActivity.Responses.$200>
|
|
2979
3015
|
}
|
|
2980
|
-
['/activity/{id}:attach']: {
|
|
3016
|
+
['/v1/entity/activity/{id}:attach']: {
|
|
2981
3017
|
/**
|
|
2982
3018
|
* attachActivity - attachActivity
|
|
2983
3019
|
*
|
|
@@ -2989,7 +3025,7 @@ export interface PathsDictionary {
|
|
|
2989
3025
|
config?: AxiosRequestConfig
|
|
2990
3026
|
): OperationResponse<Paths.AttachActivity.Responses.$200>
|
|
2991
3027
|
}
|
|
2992
|
-
['/entity/{slug}/{id}/activity']: {
|
|
3028
|
+
['/v1/entity/{slug}/{id}/activity']: {
|
|
2993
3029
|
/**
|
|
2994
3030
|
* getEntityActivityFeed - getEntityActivityFeed
|
|
2995
3031
|
*
|
|
@@ -3002,26 +3038,6 @@ export interface PathsDictionary {
|
|
|
3002
3038
|
config?: AxiosRequestConfig
|
|
3003
3039
|
): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
|
|
3004
3040
|
}
|
|
3005
|
-
['/blueprints']: {
|
|
3006
|
-
/**
|
|
3007
|
-
* searchAvailableBlueprints - searchAvailableBlueprints
|
|
3008
|
-
*/
|
|
3009
|
-
'get'(
|
|
3010
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3011
|
-
data?: any,
|
|
3012
|
-
config?: AxiosRequestConfig
|
|
3013
|
-
): OperationResponse<Paths.SearchAvailableBlueprints.Responses.$200>
|
|
3014
|
-
}
|
|
3015
|
-
['/blueprints/{id}']: {
|
|
3016
|
-
/**
|
|
3017
|
-
* getBlueprint - getBlueprint
|
|
3018
|
-
*/
|
|
3019
|
-
'get'(
|
|
3020
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
3021
|
-
data?: any,
|
|
3022
|
-
config?: AxiosRequestConfig
|
|
3023
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
3024
|
-
}
|
|
3025
3041
|
}
|
|
3026
3042
|
|
|
3027
3043
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|