@epilot/entity-client 1.30.3 → 2.0.2
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 +273 -205
- package/dist/openapi.json +170 -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 | /* Payment input */ PaymentAttribute;
|
|
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?: /**
|
|
@@ -737,7 +766,7 @@ declare namespace Components {
|
|
|
737
766
|
* }
|
|
738
767
|
*/
|
|
739
768
|
export interface EntityParcelView {
|
|
740
|
-
|
|
769
|
+
view_type?: "parcel";
|
|
741
770
|
/**
|
|
742
771
|
* example:
|
|
743
772
|
* @epilot360/pricing-hub-app
|
|
@@ -754,13 +783,17 @@ declare namespace Components {
|
|
|
754
783
|
* contact
|
|
755
784
|
*/
|
|
756
785
|
EntitySlug;
|
|
757
|
-
blueprint?: BlueprintEntityId /* uuid */;
|
|
786
|
+
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
758
787
|
/**
|
|
759
788
|
* This schema should only be active when the feature flag is enabled
|
|
760
789
|
* example:
|
|
761
790
|
* FF_MY_FEATURE_FLAG
|
|
762
791
|
*/
|
|
763
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[];
|
|
764
797
|
/**
|
|
765
798
|
* User-friendly identifier for the entity schema
|
|
766
799
|
* example:
|
|
@@ -783,10 +816,13 @@ declare namespace Components {
|
|
|
783
816
|
* {{first_name}} {{last_name}}
|
|
784
817
|
*/
|
|
785
818
|
title_template?: string;
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
819
|
+
ui_config?: {
|
|
820
|
+
table_view?: EntityViewConfig;
|
|
821
|
+
create_view?: EntityViewConfig;
|
|
822
|
+
edit_view?: EntityViewConfig;
|
|
823
|
+
list_item?: {
|
|
824
|
+
summary_attributes?: string[];
|
|
825
|
+
};
|
|
790
826
|
};
|
|
791
827
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
792
828
|
/**
|
|
@@ -804,10 +840,14 @@ declare namespace Components {
|
|
|
804
840
|
group_settings?: {
|
|
805
841
|
[name: string]: {
|
|
806
842
|
expanded?: boolean;
|
|
843
|
+
/**
|
|
844
|
+
* Render order of the group
|
|
845
|
+
*/
|
|
846
|
+
order?: number;
|
|
807
847
|
};
|
|
808
848
|
};
|
|
809
849
|
/**
|
|
810
|
-
*
|
|
850
|
+
* Custom grid definitions for the layout
|
|
811
851
|
*/
|
|
812
852
|
layout_settings?: {
|
|
813
853
|
[name: string]: {
|
|
@@ -875,13 +915,17 @@ declare namespace Components {
|
|
|
875
915
|
* contact
|
|
876
916
|
*/
|
|
877
917
|
EntitySlug;
|
|
878
|
-
blueprint?: BlueprintEntityId /* uuid */;
|
|
918
|
+
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
879
919
|
/**
|
|
880
920
|
* This schema should only be active when the feature flag is enabled
|
|
881
921
|
* example:
|
|
882
922
|
* FF_MY_FEATURE_FLAG
|
|
883
923
|
*/
|
|
884
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[];
|
|
885
929
|
/**
|
|
886
930
|
* User-friendly identifier for the entity schema
|
|
887
931
|
* example:
|
|
@@ -904,10 +948,13 @@ declare namespace Components {
|
|
|
904
948
|
* {{first_name}} {{last_name}}
|
|
905
949
|
*/
|
|
906
950
|
title_template?: string;
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
951
|
+
ui_config?: {
|
|
952
|
+
table_view?: EntityViewConfig;
|
|
953
|
+
create_view?: EntityViewConfig;
|
|
954
|
+
edit_view?: EntityViewConfig;
|
|
955
|
+
list_item?: {
|
|
956
|
+
summary_attributes?: string[];
|
|
957
|
+
};
|
|
911
958
|
};
|
|
912
959
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
913
960
|
/**
|
|
@@ -925,10 +972,14 @@ declare namespace Components {
|
|
|
925
972
|
group_settings?: {
|
|
926
973
|
[name: string]: {
|
|
927
974
|
expanded?: boolean;
|
|
975
|
+
/**
|
|
976
|
+
* Render order of the group
|
|
977
|
+
*/
|
|
978
|
+
order?: number;
|
|
928
979
|
};
|
|
929
980
|
};
|
|
930
981
|
/**
|
|
931
|
-
*
|
|
982
|
+
* Custom grid definitions for the layout
|
|
932
983
|
*/
|
|
933
984
|
layout_settings?: {
|
|
934
985
|
[name: string]: {
|
|
@@ -1062,7 +1113,7 @@ declare namespace Components {
|
|
|
1062
1113
|
*/
|
|
1063
1114
|
EntityParcelView | EntityViewDisabled;
|
|
1064
1115
|
export interface EntityViewDisabled {
|
|
1065
|
-
|
|
1116
|
+
view_type?: "disabled";
|
|
1066
1117
|
}
|
|
1067
1118
|
/**
|
|
1068
1119
|
* File or Image Attachment
|
|
@@ -1071,14 +1122,20 @@ declare namespace Components {
|
|
|
1071
1122
|
name: string;
|
|
1072
1123
|
label: string;
|
|
1073
1124
|
placeholder?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Do not render attribute in entity views
|
|
1127
|
+
*/
|
|
1074
1128
|
hidden?: boolean;
|
|
1129
|
+
/**
|
|
1130
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1131
|
+
*/
|
|
1132
|
+
show_in_table?: boolean;
|
|
1075
1133
|
required?: boolean;
|
|
1076
1134
|
readonly?: boolean;
|
|
1077
|
-
show_in_table?: boolean;
|
|
1078
1135
|
deprecated?: boolean;
|
|
1079
1136
|
default_value?: string | {
|
|
1080
1137
|
[name: string]: any;
|
|
1081
|
-
} | number | number | boolean;
|
|
1138
|
+
} | number | number | boolean | any[];
|
|
1082
1139
|
group?: string;
|
|
1083
1140
|
layout?: string;
|
|
1084
1141
|
/**
|
|
@@ -1276,14 +1333,20 @@ declare namespace Components {
|
|
|
1276
1333
|
name: string;
|
|
1277
1334
|
label: string;
|
|
1278
1335
|
placeholder?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Do not render attribute in entity views
|
|
1338
|
+
*/
|
|
1279
1339
|
hidden?: boolean;
|
|
1340
|
+
/**
|
|
1341
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1342
|
+
*/
|
|
1343
|
+
show_in_table?: boolean;
|
|
1280
1344
|
required?: boolean;
|
|
1281
1345
|
readonly?: boolean;
|
|
1282
|
-
show_in_table?: boolean;
|
|
1283
1346
|
deprecated?: boolean;
|
|
1284
1347
|
default_value?: string | {
|
|
1285
1348
|
[name: string]: any;
|
|
1286
|
-
} | number | number | boolean;
|
|
1349
|
+
} | number | number | boolean | any[];
|
|
1287
1350
|
group?: string;
|
|
1288
1351
|
layout?: string;
|
|
1289
1352
|
/**
|
|
@@ -1330,14 +1393,20 @@ declare namespace Components {
|
|
|
1330
1393
|
name: string;
|
|
1331
1394
|
label: string;
|
|
1332
1395
|
placeholder?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* Do not render attribute in entity views
|
|
1398
|
+
*/
|
|
1333
1399
|
hidden?: boolean;
|
|
1400
|
+
/**
|
|
1401
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1402
|
+
*/
|
|
1403
|
+
show_in_table?: boolean;
|
|
1334
1404
|
required?: boolean;
|
|
1335
1405
|
readonly?: boolean;
|
|
1336
|
-
show_in_table?: boolean;
|
|
1337
1406
|
deprecated?: boolean;
|
|
1338
1407
|
default_value?: string | {
|
|
1339
1408
|
[name: string]: any;
|
|
1340
|
-
} | number | number | boolean;
|
|
1409
|
+
} | number | number | boolean | any[];
|
|
1341
1410
|
group?: string;
|
|
1342
1411
|
layout?: string;
|
|
1343
1412
|
/**
|
|
@@ -1384,14 +1453,20 @@ declare namespace Components {
|
|
|
1384
1453
|
name: string;
|
|
1385
1454
|
label: string;
|
|
1386
1455
|
placeholder?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Do not render attribute in entity views
|
|
1458
|
+
*/
|
|
1387
1459
|
hidden?: boolean;
|
|
1460
|
+
/**
|
|
1461
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1462
|
+
*/
|
|
1463
|
+
show_in_table?: boolean;
|
|
1388
1464
|
required?: boolean;
|
|
1389
1465
|
readonly?: boolean;
|
|
1390
|
-
show_in_table?: boolean;
|
|
1391
1466
|
deprecated?: boolean;
|
|
1392
1467
|
default_value?: string | {
|
|
1393
1468
|
[name: string]: any;
|
|
1394
|
-
} | number | number | boolean;
|
|
1469
|
+
} | number | number | boolean | any[];
|
|
1395
1470
|
group?: string;
|
|
1396
1471
|
layout?: string;
|
|
1397
1472
|
/**
|
|
@@ -1439,14 +1514,20 @@ declare namespace Components {
|
|
|
1439
1514
|
name: string;
|
|
1440
1515
|
label: string;
|
|
1441
1516
|
placeholder?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Do not render attribute in entity views
|
|
1519
|
+
*/
|
|
1442
1520
|
hidden?: boolean;
|
|
1521
|
+
/**
|
|
1522
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1523
|
+
*/
|
|
1524
|
+
show_in_table?: boolean;
|
|
1443
1525
|
required?: boolean;
|
|
1444
1526
|
readonly?: boolean;
|
|
1445
|
-
show_in_table?: boolean;
|
|
1446
1527
|
deprecated?: boolean;
|
|
1447
1528
|
default_value?: string | {
|
|
1448
1529
|
[name: string]: any;
|
|
1449
|
-
} | number | number | boolean;
|
|
1530
|
+
} | number | number | boolean | any[];
|
|
1450
1531
|
group?: string;
|
|
1451
1532
|
layout?: string;
|
|
1452
1533
|
/**
|
|
@@ -1486,6 +1567,66 @@ declare namespace Components {
|
|
|
1486
1567
|
feature_flag?: string;
|
|
1487
1568
|
type?: "ordered_list";
|
|
1488
1569
|
}
|
|
1570
|
+
/**
|
|
1571
|
+
* Payment input
|
|
1572
|
+
*/
|
|
1573
|
+
export interface PaymentAttribute {
|
|
1574
|
+
name: string;
|
|
1575
|
+
label: string;
|
|
1576
|
+
placeholder?: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* Do not render attribute in entity views
|
|
1579
|
+
*/
|
|
1580
|
+
hidden?: boolean;
|
|
1581
|
+
/**
|
|
1582
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1583
|
+
*/
|
|
1584
|
+
show_in_table?: boolean;
|
|
1585
|
+
required?: boolean;
|
|
1586
|
+
readonly?: boolean;
|
|
1587
|
+
deprecated?: boolean;
|
|
1588
|
+
default_value?: string | {
|
|
1589
|
+
[name: string]: any;
|
|
1590
|
+
} | number | number | boolean | any[];
|
|
1591
|
+
group?: string;
|
|
1592
|
+
layout?: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* When set to true, will hide the label of the field.
|
|
1595
|
+
*/
|
|
1596
|
+
hide_label?: boolean;
|
|
1597
|
+
/**
|
|
1598
|
+
* Code name of the icon to used to represent this attribute.
|
|
1599
|
+
* The value must be a valid @epilot/base-elements Icon name
|
|
1600
|
+
*
|
|
1601
|
+
*/
|
|
1602
|
+
icon?: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* Defines the conditional rendering expression for showing this field.
|
|
1605
|
+
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
1606
|
+
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
1607
|
+
*
|
|
1608
|
+
*/
|
|
1609
|
+
render_condition?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* A set of constraints applicable to the attribute.
|
|
1612
|
+
* These constraints should and will be enforced by the attribute renderer.
|
|
1613
|
+
*
|
|
1614
|
+
* example:
|
|
1615
|
+
* {
|
|
1616
|
+
* "disablePast": true
|
|
1617
|
+
* }
|
|
1618
|
+
*/
|
|
1619
|
+
constraints?: {
|
|
1620
|
+
[key: string]: any;
|
|
1621
|
+
};
|
|
1622
|
+
/**
|
|
1623
|
+
* This attribute should only be active when the feature flag is enabled
|
|
1624
|
+
* example:
|
|
1625
|
+
* FF_MY_FEATURE_FLAG
|
|
1626
|
+
*/
|
|
1627
|
+
feature_flag?: string;
|
|
1628
|
+
type?: "payment";
|
|
1629
|
+
}
|
|
1489
1630
|
/**
|
|
1490
1631
|
* example:
|
|
1491
1632
|
* {
|
|
@@ -1494,7 +1635,7 @@ declare namespace Components {
|
|
|
1494
1635
|
* }
|
|
1495
1636
|
*/
|
|
1496
1637
|
export interface RedirectEntityView {
|
|
1497
|
-
|
|
1638
|
+
view_type?: "redirect";
|
|
1498
1639
|
/**
|
|
1499
1640
|
* example:
|
|
1500
1641
|
* /app/pricing-hub/product/:entityId
|
|
@@ -1508,14 +1649,20 @@ declare namespace Components {
|
|
|
1508
1649
|
name: string;
|
|
1509
1650
|
label: string;
|
|
1510
1651
|
placeholder?: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* Do not render attribute in entity views
|
|
1654
|
+
*/
|
|
1511
1655
|
hidden?: boolean;
|
|
1656
|
+
/**
|
|
1657
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1658
|
+
*/
|
|
1659
|
+
show_in_table?: boolean;
|
|
1512
1660
|
required?: boolean;
|
|
1513
1661
|
readonly?: boolean;
|
|
1514
|
-
show_in_table?: boolean;
|
|
1515
1662
|
deprecated?: boolean;
|
|
1516
1663
|
default_value?: string | {
|
|
1517
1664
|
[name: string]: any;
|
|
1518
|
-
} | number | number | boolean;
|
|
1665
|
+
} | number | number | boolean | any[];
|
|
1519
1666
|
group?: string;
|
|
1520
1667
|
layout?: string;
|
|
1521
1668
|
/**
|
|
@@ -1574,14 +1721,20 @@ declare namespace Components {
|
|
|
1574
1721
|
name: string;
|
|
1575
1722
|
label: string;
|
|
1576
1723
|
placeholder?: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* Do not render attribute in entity views
|
|
1726
|
+
*/
|
|
1577
1727
|
hidden?: boolean;
|
|
1728
|
+
/**
|
|
1729
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1730
|
+
*/
|
|
1731
|
+
show_in_table?: boolean;
|
|
1578
1732
|
required?: boolean;
|
|
1579
1733
|
readonly?: boolean;
|
|
1580
|
-
show_in_table?: boolean;
|
|
1581
1734
|
deprecated?: boolean;
|
|
1582
1735
|
default_value?: string | {
|
|
1583
1736
|
[name: string]: any;
|
|
1584
|
-
} | number | number | boolean;
|
|
1737
|
+
} | number | number | boolean | any[];
|
|
1585
1738
|
group?: string;
|
|
1586
1739
|
layout?: string;
|
|
1587
1740
|
/**
|
|
@@ -1634,14 +1787,20 @@ declare namespace Components {
|
|
|
1634
1787
|
name: string;
|
|
1635
1788
|
label: string;
|
|
1636
1789
|
placeholder?: string;
|
|
1790
|
+
/**
|
|
1791
|
+
* Do not render attribute in entity views
|
|
1792
|
+
*/
|
|
1637
1793
|
hidden?: boolean;
|
|
1794
|
+
/**
|
|
1795
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1796
|
+
*/
|
|
1797
|
+
show_in_table?: boolean;
|
|
1638
1798
|
required?: boolean;
|
|
1639
1799
|
readonly?: boolean;
|
|
1640
|
-
show_in_table?: boolean;
|
|
1641
1800
|
deprecated?: boolean;
|
|
1642
1801
|
default_value?: string | {
|
|
1643
1802
|
[name: string]: any;
|
|
1644
|
-
} | number | number | boolean;
|
|
1803
|
+
} | number | number | boolean | any[];
|
|
1645
1804
|
group?: string;
|
|
1646
1805
|
layout?: string;
|
|
1647
1806
|
/**
|
|
@@ -1705,14 +1864,20 @@ declare namespace Components {
|
|
|
1705
1864
|
name: string;
|
|
1706
1865
|
label: string;
|
|
1707
1866
|
placeholder?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* Do not render attribute in entity views
|
|
1869
|
+
*/
|
|
1708
1870
|
hidden?: boolean;
|
|
1871
|
+
/**
|
|
1872
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1873
|
+
*/
|
|
1874
|
+
show_in_table?: boolean;
|
|
1709
1875
|
required?: boolean;
|
|
1710
1876
|
readonly?: boolean;
|
|
1711
|
-
show_in_table?: boolean;
|
|
1712
1877
|
deprecated?: boolean;
|
|
1713
1878
|
default_value?: string | {
|
|
1714
1879
|
[name: string]: any;
|
|
1715
|
-
} | number | number | boolean;
|
|
1880
|
+
} | number | number | boolean | any[];
|
|
1716
1881
|
group?: string;
|
|
1717
1882
|
layout?: string;
|
|
1718
1883
|
/**
|
|
@@ -1755,75 +1920,26 @@ declare namespace Components {
|
|
|
1755
1920
|
suggestions?: string[];
|
|
1756
1921
|
}
|
|
1757
1922
|
/**
|
|
1758
|
-
*
|
|
1923
|
+
* Textarea or text input
|
|
1759
1924
|
*/
|
|
1760
|
-
export interface
|
|
1925
|
+
export interface TextAttribute {
|
|
1761
1926
|
name: string;
|
|
1762
1927
|
label: string;
|
|
1763
1928
|
placeholder?: string;
|
|
1764
|
-
hidden?: boolean;
|
|
1765
|
-
required?: boolean;
|
|
1766
|
-
readonly?: boolean;
|
|
1767
|
-
show_in_table?: boolean;
|
|
1768
|
-
deprecated?: boolean;
|
|
1769
|
-
default_value?: string | {
|
|
1770
|
-
[name: string]: any;
|
|
1771
|
-
} | number | number | boolean;
|
|
1772
|
-
group?: string;
|
|
1773
|
-
layout?: string;
|
|
1774
|
-
/**
|
|
1775
|
-
* When set to true, will hide the label of the field.
|
|
1776
|
-
*/
|
|
1777
|
-
hide_label?: boolean;
|
|
1778
|
-
/**
|
|
1779
|
-
* Code name of the icon to used to represent this attribute.
|
|
1780
|
-
* The value must be a valid @epilot/base-elements Icon name
|
|
1781
|
-
*
|
|
1782
|
-
*/
|
|
1783
|
-
icon?: string;
|
|
1784
|
-
/**
|
|
1785
|
-
* Defines the conditional rendering expression for showing this field.
|
|
1786
|
-
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
1787
|
-
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
1788
|
-
*
|
|
1789
|
-
*/
|
|
1790
|
-
render_condition?: string;
|
|
1791
1929
|
/**
|
|
1792
|
-
*
|
|
1793
|
-
* These constraints should and will be enforced by the attribute renderer.
|
|
1794
|
-
*
|
|
1795
|
-
* example:
|
|
1796
|
-
* {
|
|
1797
|
-
* "disablePast": true
|
|
1798
|
-
* }
|
|
1930
|
+
* Do not render attribute in entity views
|
|
1799
1931
|
*/
|
|
1800
|
-
|
|
1801
|
-
[key: string]: any;
|
|
1802
|
-
};
|
|
1932
|
+
hidden?: boolean;
|
|
1803
1933
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* example:
|
|
1806
|
-
* FF_MY_FEATURE_FLAG
|
|
1934
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1807
1935
|
*/
|
|
1808
|
-
|
|
1809
|
-
type?: "relation_tax";
|
|
1810
|
-
multiple?: boolean;
|
|
1811
|
-
}
|
|
1812
|
-
/**
|
|
1813
|
-
* Textarea or text input
|
|
1814
|
-
*/
|
|
1815
|
-
export interface TextAttribute {
|
|
1816
|
-
name: string;
|
|
1817
|
-
label: string;
|
|
1818
|
-
placeholder?: string;
|
|
1819
|
-
hidden?: boolean;
|
|
1936
|
+
show_in_table?: boolean;
|
|
1820
1937
|
required?: boolean;
|
|
1821
1938
|
readonly?: boolean;
|
|
1822
|
-
show_in_table?: boolean;
|
|
1823
1939
|
deprecated?: boolean;
|
|
1824
1940
|
default_value?: string | {
|
|
1825
1941
|
[name: string]: any;
|
|
1826
|
-
} | number | number | boolean;
|
|
1942
|
+
} | number | number | boolean | any[];
|
|
1827
1943
|
group?: string;
|
|
1828
1944
|
layout?: string;
|
|
1829
1945
|
/**
|
|
@@ -1871,14 +1987,20 @@ declare namespace Components {
|
|
|
1871
1987
|
name: string;
|
|
1872
1988
|
label: string;
|
|
1873
1989
|
placeholder?: string;
|
|
1990
|
+
/**
|
|
1991
|
+
* Do not render attribute in entity views
|
|
1992
|
+
*/
|
|
1874
1993
|
hidden?: boolean;
|
|
1994
|
+
/**
|
|
1995
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
1996
|
+
*/
|
|
1997
|
+
show_in_table?: boolean;
|
|
1875
1998
|
required?: boolean;
|
|
1876
1999
|
readonly?: boolean;
|
|
1877
|
-
show_in_table?: boolean;
|
|
1878
2000
|
deprecated?: boolean;
|
|
1879
2001
|
default_value?: string | {
|
|
1880
2002
|
[name: string]: any;
|
|
1881
|
-
} | number | number | boolean;
|
|
2003
|
+
} | number | number | boolean | any[];
|
|
1882
2004
|
group?: string;
|
|
1883
2005
|
layout?: string;
|
|
1884
2006
|
/**
|
|
@@ -2100,17 +2222,6 @@ declare namespace Paths {
|
|
|
2100
2222
|
export type $200 = Components.Schemas.ActivityItem;
|
|
2101
2223
|
}
|
|
2102
2224
|
}
|
|
2103
|
-
namespace GetBlueprint {
|
|
2104
|
-
namespace Parameters {
|
|
2105
|
-
export type Id = Components.Schemas.BlueprintId /* uuid */;
|
|
2106
|
-
}
|
|
2107
|
-
export interface PathParameters {
|
|
2108
|
-
id: Parameters.Id;
|
|
2109
|
-
}
|
|
2110
|
-
namespace Responses {
|
|
2111
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
2112
|
-
}
|
|
2113
|
-
}
|
|
2114
2225
|
namespace GetEntity {
|
|
2115
2226
|
namespace Parameters {
|
|
2116
2227
|
export type Hydrate = boolean;
|
|
@@ -2249,13 +2360,6 @@ declare namespace Paths {
|
|
|
2249
2360
|
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
2250
2361
|
}
|
|
2251
2362
|
}
|
|
2252
|
-
namespace SearchAvailableBlueprints {
|
|
2253
|
-
namespace Responses {
|
|
2254
|
-
export interface $200 {
|
|
2255
|
-
results?: Components.Schemas.Blueprint[];
|
|
2256
|
-
}
|
|
2257
|
-
}
|
|
2258
|
-
}
|
|
2259
2363
|
namespace SearchEntities {
|
|
2260
2364
|
export type RequestBody = Components.Schemas.EntitySearchParams;
|
|
2261
2365
|
namespace Responses {
|
|
@@ -2458,17 +2562,6 @@ export interface OperationMethods {
|
|
|
2458
2562
|
data?: Paths.SearchEntities.RequestBody,
|
|
2459
2563
|
config?: AxiosRequestConfig
|
|
2460
2564
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
2461
|
-
/**
|
|
2462
|
-
* autocomplete - autocomplete
|
|
2463
|
-
*
|
|
2464
|
-
* Autocomplete entity attributes
|
|
2465
|
-
*
|
|
2466
|
-
*/
|
|
2467
|
-
'autocomplete'(
|
|
2468
|
-
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2469
|
-
data?: any,
|
|
2470
|
-
config?: AxiosRequestConfig
|
|
2471
|
-
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2472
2565
|
/**
|
|
2473
2566
|
* createEntity - createEntity
|
|
2474
2567
|
*
|
|
@@ -2626,6 +2719,17 @@ export interface OperationMethods {
|
|
|
2626
2719
|
data?: any,
|
|
2627
2720
|
config?: AxiosRequestConfig
|
|
2628
2721
|
): OperationResponse<Paths.DeleteEntity.Responses.$200>
|
|
2722
|
+
/**
|
|
2723
|
+
* autocomplete - autocomplete
|
|
2724
|
+
*
|
|
2725
|
+
* Autocomplete entity attributes
|
|
2726
|
+
*
|
|
2727
|
+
*/
|
|
2728
|
+
'autocomplete'(
|
|
2729
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2730
|
+
data?: any,
|
|
2731
|
+
config?: AxiosRequestConfig
|
|
2732
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2629
2733
|
/**
|
|
2630
2734
|
* createActivity - createActivity
|
|
2631
2735
|
*
|
|
@@ -2671,26 +2775,10 @@ export interface OperationMethods {
|
|
|
2671
2775
|
data?: any,
|
|
2672
2776
|
config?: AxiosRequestConfig
|
|
2673
2777
|
): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
|
|
2674
|
-
/**
|
|
2675
|
-
* searchAvailableBlueprints - searchAvailableBlueprints
|
|
2676
|
-
*/
|
|
2677
|
-
'searchAvailableBlueprints'(
|
|
2678
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2679
|
-
data?: any,
|
|
2680
|
-
config?: AxiosRequestConfig
|
|
2681
|
-
): OperationResponse<Paths.SearchAvailableBlueprints.Responses.$200>
|
|
2682
|
-
/**
|
|
2683
|
-
* getBlueprint - getBlueprint
|
|
2684
|
-
*/
|
|
2685
|
-
'getBlueprint'(
|
|
2686
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
2687
|
-
data?: any,
|
|
2688
|
-
config?: AxiosRequestConfig
|
|
2689
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
2690
2778
|
}
|
|
2691
2779
|
|
|
2692
2780
|
export interface PathsDictionary {
|
|
2693
|
-
['/schemas']: {
|
|
2781
|
+
['/v1/entity/schemas']: {
|
|
2694
2782
|
/**
|
|
2695
2783
|
* listSchemas - listSchemas
|
|
2696
2784
|
*/
|
|
@@ -2700,7 +2788,7 @@ export interface PathsDictionary {
|
|
|
2700
2788
|
config?: AxiosRequestConfig
|
|
2701
2789
|
): OperationResponse<Paths.ListSchemas.Responses.$200>
|
|
2702
2790
|
}
|
|
2703
|
-
['/schemas/{slug}']: {
|
|
2791
|
+
['/v1/entity/schemas/{slug}']: {
|
|
2704
2792
|
/**
|
|
2705
2793
|
* getSchema - getSchema
|
|
2706
2794
|
*/
|
|
@@ -2726,7 +2814,7 @@ export interface PathsDictionary {
|
|
|
2726
2814
|
config?: AxiosRequestConfig
|
|
2727
2815
|
): OperationResponse<Paths.DeleteSchema.Responses.$204>
|
|
2728
2816
|
}
|
|
2729
|
-
['/entity:search']: {
|
|
2817
|
+
['/v1/entity:search']: {
|
|
2730
2818
|
/**
|
|
2731
2819
|
* searchEntities - searchEntities
|
|
2732
2820
|
*
|
|
@@ -2781,20 +2869,7 @@ export interface PathsDictionary {
|
|
|
2781
2869
|
config?: AxiosRequestConfig
|
|
2782
2870
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
2783
2871
|
}
|
|
2784
|
-
['/entity
|
|
2785
|
-
/**
|
|
2786
|
-
* autocomplete - autocomplete
|
|
2787
|
-
*
|
|
2788
|
-
* Autocomplete entity attributes
|
|
2789
|
-
*
|
|
2790
|
-
*/
|
|
2791
|
-
'get'(
|
|
2792
|
-
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2793
|
-
data?: any,
|
|
2794
|
-
config?: AxiosRequestConfig
|
|
2795
|
-
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2796
|
-
}
|
|
2797
|
-
['/entity/{slug}']: {
|
|
2872
|
+
['/v1/entity/{slug}']: {
|
|
2798
2873
|
/**
|
|
2799
2874
|
* createEntity - createEntity
|
|
2800
2875
|
*
|
|
@@ -2831,7 +2906,7 @@ export interface PathsDictionary {
|
|
|
2831
2906
|
config?: AxiosRequestConfig
|
|
2832
2907
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
2833
2908
|
}
|
|
2834
|
-
['/entity/{slug}:upsert']: {
|
|
2909
|
+
['/v1/entity/{slug}:upsert']: {
|
|
2835
2910
|
/**
|
|
2836
2911
|
* upsertEntity - upsertEntity
|
|
2837
2912
|
*
|
|
@@ -2852,7 +2927,7 @@ export interface PathsDictionary {
|
|
|
2852
2927
|
config?: AxiosRequestConfig
|
|
2853
2928
|
): OperationResponse<Paths.UpsertEntity.Responses.$200 | Paths.UpsertEntity.Responses.$201>
|
|
2854
2929
|
}
|
|
2855
|
-
['/entity/{slug}/{id}']: {
|
|
2930
|
+
['/v1/entity/{slug}/{id}']: {
|
|
2856
2931
|
/**
|
|
2857
2932
|
* getEntity - getEntity
|
|
2858
2933
|
*
|
|
@@ -2957,7 +3032,20 @@ export interface PathsDictionary {
|
|
|
2957
3032
|
config?: AxiosRequestConfig
|
|
2958
3033
|
): OperationResponse<Paths.DeleteEntity.Responses.$200>
|
|
2959
3034
|
}
|
|
2960
|
-
['/
|
|
3035
|
+
['/v1/entity:autocomplete']: {
|
|
3036
|
+
/**
|
|
3037
|
+
* autocomplete - autocomplete
|
|
3038
|
+
*
|
|
3039
|
+
* Autocomplete entity attributes
|
|
3040
|
+
*
|
|
3041
|
+
*/
|
|
3042
|
+
'get'(
|
|
3043
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
3044
|
+
data?: any,
|
|
3045
|
+
config?: AxiosRequestConfig
|
|
3046
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
3047
|
+
}
|
|
3048
|
+
['/v1/entity/activity']: {
|
|
2961
3049
|
/**
|
|
2962
3050
|
* createActivity - createActivity
|
|
2963
3051
|
*
|
|
@@ -2973,7 +3061,7 @@ export interface PathsDictionary {
|
|
|
2973
3061
|
config?: AxiosRequestConfig
|
|
2974
3062
|
): OperationResponse<Paths.CreateActivity.Responses.$200>
|
|
2975
3063
|
}
|
|
2976
|
-
['/activity/{id}']: {
|
|
3064
|
+
['/v1/entity/activity/{id}']: {
|
|
2977
3065
|
/**
|
|
2978
3066
|
* getActivity - getActivity
|
|
2979
3067
|
*
|
|
@@ -2985,7 +3073,7 @@ export interface PathsDictionary {
|
|
|
2985
3073
|
config?: AxiosRequestConfig
|
|
2986
3074
|
): OperationResponse<Paths.GetActivity.Responses.$200>
|
|
2987
3075
|
}
|
|
2988
|
-
['/activity/{id}:attach']: {
|
|
3076
|
+
['/v1/entity/activity/{id}:attach']: {
|
|
2989
3077
|
/**
|
|
2990
3078
|
* attachActivity - attachActivity
|
|
2991
3079
|
*
|
|
@@ -2997,7 +3085,7 @@ export interface PathsDictionary {
|
|
|
2997
3085
|
config?: AxiosRequestConfig
|
|
2998
3086
|
): OperationResponse<Paths.AttachActivity.Responses.$200>
|
|
2999
3087
|
}
|
|
3000
|
-
['/entity/{slug}/{id}/activity']: {
|
|
3088
|
+
['/v1/entity/{slug}/{id}/activity']: {
|
|
3001
3089
|
/**
|
|
3002
3090
|
* getEntityActivityFeed - getEntityActivityFeed
|
|
3003
3091
|
*
|
|
@@ -3010,26 +3098,6 @@ export interface PathsDictionary {
|
|
|
3010
3098
|
config?: AxiosRequestConfig
|
|
3011
3099
|
): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
|
|
3012
3100
|
}
|
|
3013
|
-
['/blueprints']: {
|
|
3014
|
-
/**
|
|
3015
|
-
* searchAvailableBlueprints - searchAvailableBlueprints
|
|
3016
|
-
*/
|
|
3017
|
-
'get'(
|
|
3018
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3019
|
-
data?: any,
|
|
3020
|
-
config?: AxiosRequestConfig
|
|
3021
|
-
): OperationResponse<Paths.SearchAvailableBlueprints.Responses.$200>
|
|
3022
|
-
}
|
|
3023
|
-
['/blueprints/{id}']: {
|
|
3024
|
-
/**
|
|
3025
|
-
* getBlueprint - getBlueprint
|
|
3026
|
-
*/
|
|
3027
|
-
'get'(
|
|
3028
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
3029
|
-
data?: any,
|
|
3030
|
-
config?: AxiosRequestConfig
|
|
3031
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
3032
|
-
}
|
|
3033
3101
|
}
|
|
3034
3102
|
|
|
3035
3103
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|