@epilot/entity-client 7.4.0 → 7.5.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-runtime.json +12 -3
- package/dist/openapi.d.ts +440 -79
- package/dist/openapi.json +167 -23
- package/dist/schema-model.d.ts +23 -4
- package/dist/schema-model.js +48 -5
- package/package.json +2 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -397,8 +397,12 @@ declare namespace Components {
|
|
|
397
397
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
398
398
|
* fixed on the base entity.
|
|
399
399
|
*
|
|
400
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
401
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
402
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
403
|
+
*
|
|
400
404
|
*/
|
|
401
|
-
|
|
405
|
+
overridable_attribute?: boolean;
|
|
402
406
|
default_value?: any;
|
|
403
407
|
/**
|
|
404
408
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -632,8 +636,12 @@ declare namespace Components {
|
|
|
632
636
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
633
637
|
* fixed on the base entity.
|
|
634
638
|
*
|
|
639
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
640
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
641
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
642
|
+
*
|
|
635
643
|
*/
|
|
636
|
-
|
|
644
|
+
overridable_attribute?: boolean;
|
|
637
645
|
default_value?: any;
|
|
638
646
|
/**
|
|
639
647
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -897,8 +905,12 @@ declare namespace Components {
|
|
|
897
905
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
898
906
|
* fixed on the base entity.
|
|
899
907
|
*
|
|
908
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
909
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
910
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
911
|
+
*
|
|
900
912
|
*/
|
|
901
|
-
|
|
913
|
+
overridable_attribute?: boolean;
|
|
902
914
|
default_value?: any;
|
|
903
915
|
/**
|
|
904
916
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1164,8 +1176,12 @@ declare namespace Components {
|
|
|
1164
1176
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1165
1177
|
* fixed on the base entity.
|
|
1166
1178
|
*
|
|
1179
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
1180
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
1181
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
1182
|
+
*
|
|
1167
1183
|
*/
|
|
1168
|
-
|
|
1184
|
+
overridable_attribute?: boolean;
|
|
1169
1185
|
default_value?: any;
|
|
1170
1186
|
/**
|
|
1171
1187
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1496,8 +1512,12 @@ declare namespace Components {
|
|
|
1496
1512
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1497
1513
|
* fixed on the base entity.
|
|
1498
1514
|
*
|
|
1515
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
1516
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
1517
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
1518
|
+
*
|
|
1499
1519
|
*/
|
|
1500
|
-
|
|
1520
|
+
overridable_attribute?: boolean;
|
|
1501
1521
|
default_value?: any;
|
|
1502
1522
|
/**
|
|
1503
1523
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1808,8 +1828,12 @@ declare namespace Components {
|
|
|
1808
1828
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1809
1829
|
* fixed on the base entity.
|
|
1810
1830
|
*
|
|
1831
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
1832
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
1833
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
1834
|
+
*
|
|
1811
1835
|
*/
|
|
1812
|
-
|
|
1836
|
+
overridable_attribute?: boolean;
|
|
1813
1837
|
default_value?: any;
|
|
1814
1838
|
/**
|
|
1815
1839
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2005,13 +2029,13 @@ declare namespace Components {
|
|
|
2005
2029
|
}
|
|
2006
2030
|
/**
|
|
2007
2031
|
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
2008
|
-
* discriminates the variants: only a `select` condition carries `
|
|
2032
|
+
* discriminates the variants: only a `select` condition carries `options`, and only a
|
|
2009
2033
|
* `location` condition carries `format`.
|
|
2010
2034
|
*
|
|
2011
2035
|
*/
|
|
2012
2036
|
export type ConditionDefinition = /**
|
|
2013
2037
|
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
2014
|
-
* discriminates the variants: only a `select` condition carries `
|
|
2038
|
+
* discriminates the variants: only a `select` condition carries `options`, and only a
|
|
2015
2039
|
* `location` condition carries `format`.
|
|
2016
2040
|
*
|
|
2017
2041
|
*/
|
|
@@ -2049,8 +2073,12 @@ declare namespace Components {
|
|
|
2049
2073
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2050
2074
|
* fixed on the base entity.
|
|
2051
2075
|
*
|
|
2076
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
2077
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
2078
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
2079
|
+
*
|
|
2052
2080
|
*/
|
|
2053
|
-
|
|
2081
|
+
overridable_attribute?: boolean;
|
|
2054
2082
|
default_value?: any;
|
|
2055
2083
|
/**
|
|
2056
2084
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2260,8 +2288,12 @@ declare namespace Components {
|
|
|
2260
2288
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2261
2289
|
* fixed on the base entity.
|
|
2262
2290
|
*
|
|
2291
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
2292
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
2293
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
2294
|
+
*
|
|
2263
2295
|
*/
|
|
2264
|
-
|
|
2296
|
+
overridable_attribute?: boolean;
|
|
2265
2297
|
default_value?: any;
|
|
2266
2298
|
/**
|
|
2267
2299
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2469,8 +2501,12 @@ declare namespace Components {
|
|
|
2469
2501
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2470
2502
|
* fixed on the base entity.
|
|
2471
2503
|
*
|
|
2504
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
2505
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
2506
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
2507
|
+
*
|
|
2472
2508
|
*/
|
|
2473
|
-
|
|
2509
|
+
overridable_attribute?: boolean;
|
|
2474
2510
|
default_value?: any;
|
|
2475
2511
|
/**
|
|
2476
2512
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2688,8 +2724,12 @@ declare namespace Components {
|
|
|
2688
2724
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2689
2725
|
* fixed on the base entity.
|
|
2690
2726
|
*
|
|
2727
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
2728
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
2729
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
2730
|
+
*
|
|
2691
2731
|
*/
|
|
2692
|
-
|
|
2732
|
+
overridable_attribute?: boolean;
|
|
2693
2733
|
default_value?: any;
|
|
2694
2734
|
/**
|
|
2695
2735
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2978,8 +3018,12 @@ declare namespace Components {
|
|
|
2978
3018
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2979
3019
|
* fixed on the base entity.
|
|
2980
3020
|
*
|
|
3021
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
3022
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
3023
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
3024
|
+
*
|
|
2981
3025
|
*/
|
|
2982
|
-
|
|
3026
|
+
overridable_attribute?: boolean;
|
|
2983
3027
|
default_value?: any;
|
|
2984
3028
|
/**
|
|
2985
3029
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -3311,14 +3355,23 @@ declare namespace Components {
|
|
|
3311
3355
|
title?: string;
|
|
3312
3356
|
attributes?: Attribute[];
|
|
3313
3357
|
/**
|
|
3314
|
-
* Allow conditional variants
|
|
3315
|
-
*
|
|
3316
|
-
*
|
|
3317
|
-
*
|
|
3318
|
-
|
|
3358
|
+
* Allow conditional variants to override the fields this capability manages. Only
|
|
3359
|
+
* meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
|
|
3360
|
+
* flag covers exactly what that lists, not the capability's name.
|
|
3361
|
+
*
|
|
3362
|
+
*/
|
|
3363
|
+
overridable_attribute?: boolean;
|
|
3364
|
+
/**
|
|
3365
|
+
* Every entity field this capability writes, including one named after the capability
|
|
3366
|
+
* itself. With `overridable_attribute`, this is the definitive list of what a variant
|
|
3367
|
+
* may override through the capability, applied as a single patch.
|
|
3368
|
+
*
|
|
3369
|
+
* Fields, not attributes: a capability may write entity fields that have no attribute
|
|
3370
|
+
* definition, so entries need not resolve to one. Where an entry does resolve to an
|
|
3371
|
+
* attribute, `hidden` and `computed` do not disqualify it.
|
|
3319
3372
|
*
|
|
3320
3373
|
*/
|
|
3321
|
-
|
|
3374
|
+
managed_fields?: string /* ^[a-z0-9_]+$ */[];
|
|
3322
3375
|
_purpose?: /**
|
|
3323
3376
|
* example:
|
|
3324
3377
|
* taxonomy-slug:classification-slug
|
|
@@ -3491,14 +3544,23 @@ declare namespace Components {
|
|
|
3491
3544
|
title?: string;
|
|
3492
3545
|
attributes?: Attribute[];
|
|
3493
3546
|
/**
|
|
3494
|
-
* Allow conditional variants
|
|
3495
|
-
*
|
|
3496
|
-
*
|
|
3497
|
-
*
|
|
3498
|
-
|
|
3547
|
+
* Allow conditional variants to override the fields this capability manages. Only
|
|
3548
|
+
* meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
|
|
3549
|
+
* flag covers exactly what that lists, not the capability's name.
|
|
3550
|
+
*
|
|
3551
|
+
*/
|
|
3552
|
+
overridable_attribute?: boolean;
|
|
3553
|
+
/**
|
|
3554
|
+
* Every entity field this capability writes, including one named after the capability
|
|
3555
|
+
* itself. With `overridable_attribute`, this is the definitive list of what a variant
|
|
3556
|
+
* may override through the capability, applied as a single patch.
|
|
3557
|
+
*
|
|
3558
|
+
* Fields, not attributes: a capability may write entity fields that have no attribute
|
|
3559
|
+
* definition, so entries need not resolve to one. Where an entry does resolve to an
|
|
3560
|
+
* attribute, `hidden` and `computed` do not disqualify it.
|
|
3499
3561
|
*
|
|
3500
3562
|
*/
|
|
3501
|
-
|
|
3563
|
+
managed_fields?: string /* ^[a-z0-9_]+$ */[];
|
|
3502
3564
|
_purpose?: /**
|
|
3503
3565
|
* example:
|
|
3504
3566
|
* taxonomy-slug:classification-slug
|
|
@@ -4660,6 +4722,83 @@ declare namespace Components {
|
|
|
4660
4722
|
widget_widths?: {
|
|
4661
4723
|
[name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
|
|
4662
4724
|
};
|
|
4725
|
+
/**
|
|
4726
|
+
* Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
|
|
4727
|
+
* example:
|
|
4728
|
+
* [
|
|
4729
|
+
* {
|
|
4730
|
+
* "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
|
|
4731
|
+
* "slug": "sales-overview",
|
|
4732
|
+
* "title": "Sales Overview",
|
|
4733
|
+
* "order": 10,
|
|
4734
|
+
* "type": "widgets",
|
|
4735
|
+
* "widgets": [
|
|
4736
|
+
* {
|
|
4737
|
+
* "id": "next_best_action",
|
|
4738
|
+
* "width": "full_width"
|
|
4739
|
+
* },
|
|
4740
|
+
* {
|
|
4741
|
+
* "id": "recent_communications",
|
|
4742
|
+
* "width": "one_third_width"
|
|
4743
|
+
* }
|
|
4744
|
+
* ]
|
|
4745
|
+
* }
|
|
4746
|
+
* ]
|
|
4747
|
+
*/
|
|
4748
|
+
custom_tabs?: {
|
|
4749
|
+
[name: string]: any;
|
|
4750
|
+
/**
|
|
4751
|
+
* Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
|
|
4752
|
+
* example:
|
|
4753
|
+
* 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
|
|
4754
|
+
*/
|
|
4755
|
+
id: string;
|
|
4756
|
+
/**
|
|
4757
|
+
* URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
|
|
4758
|
+
* example:
|
|
4759
|
+
* sales-overview
|
|
4760
|
+
*/
|
|
4761
|
+
slug: string;
|
|
4762
|
+
/**
|
|
4763
|
+
* Tab label, authored by the configuring user.
|
|
4764
|
+
* example:
|
|
4765
|
+
* Sales Overview
|
|
4766
|
+
*/
|
|
4767
|
+
title: string;
|
|
4768
|
+
/**
|
|
4769
|
+
* Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
|
|
4770
|
+
* example:
|
|
4771
|
+
* 10
|
|
4772
|
+
*/
|
|
4773
|
+
order: number;
|
|
4774
|
+
/**
|
|
4775
|
+
* Icon name from the existing entity icon set.
|
|
4776
|
+
* example:
|
|
4777
|
+
* person
|
|
4778
|
+
*/
|
|
4779
|
+
icon?: string;
|
|
4780
|
+
/**
|
|
4781
|
+
* Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
|
|
4782
|
+
* example:
|
|
4783
|
+
* widgets
|
|
4784
|
+
*/
|
|
4785
|
+
type: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
|
|
4788
|
+
*/
|
|
4789
|
+
widgets?: {
|
|
4790
|
+
/**
|
|
4791
|
+
* Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
|
|
4792
|
+
* example:
|
|
4793
|
+
* next_best_action
|
|
4794
|
+
*/
|
|
4795
|
+
id: string;
|
|
4796
|
+
/**
|
|
4797
|
+
* Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
|
|
4798
|
+
*/
|
|
4799
|
+
width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
|
|
4800
|
+
}[];
|
|
4801
|
+
}[];
|
|
4663
4802
|
};
|
|
4664
4803
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
4665
4804
|
/**
|
|
@@ -4775,12 +4914,12 @@ declare namespace Components {
|
|
|
4775
4914
|
* Dimensions that conditional variants of this entity type are keyed by.
|
|
4776
4915
|
*
|
|
4777
4916
|
* Absent or `null` means entities of this type are not conditional. Attributes whose
|
|
4778
|
-
* values a variant may override are marked with `
|
|
4917
|
+
* values a variant may override are marked with `overridable_attribute`.
|
|
4779
4918
|
*
|
|
4780
4919
|
*/
|
|
4781
4920
|
conditions?: /**
|
|
4782
4921
|
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
4783
|
-
* discriminates the variants: only a `select` condition carries `
|
|
4922
|
+
* discriminates the variants: only a `select` condition carries `options`, and only a
|
|
4784
4923
|
* `location` condition carries `format`.
|
|
4785
4924
|
*
|
|
4786
4925
|
*/
|
|
@@ -4929,11 +5068,13 @@ declare namespace Components {
|
|
|
4929
5068
|
type?: string;
|
|
4930
5069
|
};
|
|
4931
5070
|
/**
|
|
4932
|
-
*
|
|
5071
|
+
* No longer returned: schema freezing is retired.
|
|
5072
|
+
*
|
|
4933
5073
|
*/
|
|
4934
5074
|
frozen?: boolean;
|
|
4935
5075
|
/**
|
|
4936
|
-
*
|
|
5076
|
+
* No longer returned: every read returns the latest version.
|
|
5077
|
+
*
|
|
4937
5078
|
*/
|
|
4938
5079
|
latest?: boolean;
|
|
4939
5080
|
/**
|
|
@@ -5113,6 +5254,83 @@ declare namespace Components {
|
|
|
5113
5254
|
widget_widths?: {
|
|
5114
5255
|
[name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
|
|
5115
5256
|
};
|
|
5257
|
+
/**
|
|
5258
|
+
* Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
|
|
5259
|
+
* example:
|
|
5260
|
+
* [
|
|
5261
|
+
* {
|
|
5262
|
+
* "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
|
|
5263
|
+
* "slug": "sales-overview",
|
|
5264
|
+
* "title": "Sales Overview",
|
|
5265
|
+
* "order": 10,
|
|
5266
|
+
* "type": "widgets",
|
|
5267
|
+
* "widgets": [
|
|
5268
|
+
* {
|
|
5269
|
+
* "id": "next_best_action",
|
|
5270
|
+
* "width": "full_width"
|
|
5271
|
+
* },
|
|
5272
|
+
* {
|
|
5273
|
+
* "id": "recent_communications",
|
|
5274
|
+
* "width": "one_third_width"
|
|
5275
|
+
* }
|
|
5276
|
+
* ]
|
|
5277
|
+
* }
|
|
5278
|
+
* ]
|
|
5279
|
+
*/
|
|
5280
|
+
custom_tabs?: {
|
|
5281
|
+
[name: string]: any;
|
|
5282
|
+
/**
|
|
5283
|
+
* Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
|
|
5284
|
+
* example:
|
|
5285
|
+
* 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
|
|
5286
|
+
*/
|
|
5287
|
+
id: string;
|
|
5288
|
+
/**
|
|
5289
|
+
* URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
|
|
5290
|
+
* example:
|
|
5291
|
+
* sales-overview
|
|
5292
|
+
*/
|
|
5293
|
+
slug: string;
|
|
5294
|
+
/**
|
|
5295
|
+
* Tab label, authored by the configuring user.
|
|
5296
|
+
* example:
|
|
5297
|
+
* Sales Overview
|
|
5298
|
+
*/
|
|
5299
|
+
title: string;
|
|
5300
|
+
/**
|
|
5301
|
+
* Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
|
|
5302
|
+
* example:
|
|
5303
|
+
* 10
|
|
5304
|
+
*/
|
|
5305
|
+
order: number;
|
|
5306
|
+
/**
|
|
5307
|
+
* Icon name from the existing entity icon set.
|
|
5308
|
+
* example:
|
|
5309
|
+
* person
|
|
5310
|
+
*/
|
|
5311
|
+
icon?: string;
|
|
5312
|
+
/**
|
|
5313
|
+
* Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
|
|
5314
|
+
* example:
|
|
5315
|
+
* widgets
|
|
5316
|
+
*/
|
|
5317
|
+
type: string;
|
|
5318
|
+
/**
|
|
5319
|
+
* Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
|
|
5320
|
+
*/
|
|
5321
|
+
widgets?: {
|
|
5322
|
+
/**
|
|
5323
|
+
* Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
|
|
5324
|
+
* example:
|
|
5325
|
+
* next_best_action
|
|
5326
|
+
*/
|
|
5327
|
+
id: string;
|
|
5328
|
+
/**
|
|
5329
|
+
* Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
|
|
5330
|
+
*/
|
|
5331
|
+
width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
|
|
5332
|
+
}[];
|
|
5333
|
+
}[];
|
|
5116
5334
|
};
|
|
5117
5335
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
5118
5336
|
/**
|
|
@@ -5228,12 +5446,12 @@ declare namespace Components {
|
|
|
5228
5446
|
* Dimensions that conditional variants of this entity type are keyed by.
|
|
5229
5447
|
*
|
|
5230
5448
|
* Absent or `null` means entities of this type are not conditional. Attributes whose
|
|
5231
|
-
* values a variant may override are marked with `
|
|
5449
|
+
* values a variant may override are marked with `overridable_attribute`.
|
|
5232
5450
|
*
|
|
5233
5451
|
*/
|
|
5234
5452
|
conditions?: /**
|
|
5235
5453
|
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
5236
|
-
* discriminates the variants: only a `select` condition carries `
|
|
5454
|
+
* discriminates the variants: only a `select` condition carries `options`, and only a
|
|
5237
5455
|
* `location` condition carries `format`.
|
|
5238
5456
|
*
|
|
5239
5457
|
*/
|
|
@@ -5787,8 +6005,12 @@ declare namespace Components {
|
|
|
5787
6005
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
5788
6006
|
* fixed on the base entity.
|
|
5789
6007
|
*
|
|
6008
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
6009
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
6010
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
6011
|
+
*
|
|
5790
6012
|
*/
|
|
5791
|
-
|
|
6013
|
+
overridable_attribute?: boolean;
|
|
5792
6014
|
default_value?: any;
|
|
5793
6015
|
/**
|
|
5794
6016
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6709,8 +6931,12 @@ declare namespace Components {
|
|
|
6709
6931
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
6710
6932
|
* fixed on the base entity.
|
|
6711
6933
|
*
|
|
6934
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
6935
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
6936
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
6937
|
+
*
|
|
6712
6938
|
*/
|
|
6713
|
-
|
|
6939
|
+
overridable_attribute?: boolean;
|
|
6714
6940
|
default_value?: any;
|
|
6715
6941
|
/**
|
|
6716
6942
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6918,8 +7144,12 @@ declare namespace Components {
|
|
|
6918
7144
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
6919
7145
|
* fixed on the base entity.
|
|
6920
7146
|
*
|
|
7147
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
7148
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
7149
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
7150
|
+
*
|
|
6921
7151
|
*/
|
|
6922
|
-
|
|
7152
|
+
overridable_attribute?: boolean;
|
|
6923
7153
|
default_value?: any;
|
|
6924
7154
|
/**
|
|
6925
7155
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7127,8 +7357,12 @@ declare namespace Components {
|
|
|
7127
7357
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7128
7358
|
* fixed on the base entity.
|
|
7129
7359
|
*
|
|
7360
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
7361
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
7362
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
7363
|
+
*
|
|
7130
7364
|
*/
|
|
7131
|
-
|
|
7365
|
+
overridable_attribute?: boolean;
|
|
7132
7366
|
default_value?: any;
|
|
7133
7367
|
/**
|
|
7134
7368
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7344,8 +7578,12 @@ declare namespace Components {
|
|
|
7344
7578
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7345
7579
|
* fixed on the base entity.
|
|
7346
7580
|
*
|
|
7581
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
7582
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
7583
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
7584
|
+
*
|
|
7347
7585
|
*/
|
|
7348
|
-
|
|
7586
|
+
overridable_attribute?: boolean;
|
|
7349
7587
|
default_value?: any;
|
|
7350
7588
|
/**
|
|
7351
7589
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7608,8 +7846,12 @@ declare namespace Components {
|
|
|
7608
7846
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7609
7847
|
* fixed on the base entity.
|
|
7610
7848
|
*
|
|
7849
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
7850
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
7851
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
7852
|
+
*
|
|
7611
7853
|
*/
|
|
7612
|
-
|
|
7854
|
+
overridable_attribute?: boolean;
|
|
7613
7855
|
default_value?: any;
|
|
7614
7856
|
/**
|
|
7615
7857
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7904,8 +8146,12 @@ declare namespace Components {
|
|
|
7904
8146
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7905
8147
|
* fixed on the base entity.
|
|
7906
8148
|
*
|
|
8149
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
8150
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
8151
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
8152
|
+
*
|
|
7907
8153
|
*/
|
|
7908
|
-
|
|
8154
|
+
overridable_attribute?: boolean;
|
|
7909
8155
|
default_value?: any;
|
|
7910
8156
|
/**
|
|
7911
8157
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8224,8 +8470,12 @@ declare namespace Components {
|
|
|
8224
8470
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8225
8471
|
* fixed on the base entity.
|
|
8226
8472
|
*
|
|
8473
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
8474
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
8475
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
8476
|
+
*
|
|
8227
8477
|
*/
|
|
8228
|
-
|
|
8478
|
+
overridable_attribute?: boolean;
|
|
8229
8479
|
default_value?: any;
|
|
8230
8480
|
/**
|
|
8231
8481
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8442,8 +8692,12 @@ declare namespace Components {
|
|
|
8442
8692
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8443
8693
|
* fixed on the base entity.
|
|
8444
8694
|
*
|
|
8695
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
8696
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
8697
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
8698
|
+
*
|
|
8445
8699
|
*/
|
|
8446
|
-
|
|
8700
|
+
overridable_attribute?: boolean;
|
|
8447
8701
|
default_value?: any;
|
|
8448
8702
|
/**
|
|
8449
8703
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8651,8 +8905,12 @@ declare namespace Components {
|
|
|
8651
8905
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8652
8906
|
* fixed on the base entity.
|
|
8653
8907
|
*
|
|
8908
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
8909
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
8910
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
8911
|
+
*
|
|
8654
8912
|
*/
|
|
8655
|
-
|
|
8913
|
+
overridable_attribute?: boolean;
|
|
8656
8914
|
default_value?: any;
|
|
8657
8915
|
/**
|
|
8658
8916
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8860,8 +9118,12 @@ declare namespace Components {
|
|
|
8860
9118
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8861
9119
|
* fixed on the base entity.
|
|
8862
9120
|
*
|
|
9121
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
9122
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
9123
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
9124
|
+
*
|
|
8863
9125
|
*/
|
|
8864
|
-
|
|
9126
|
+
overridable_attribute?: boolean;
|
|
8865
9127
|
default_value?: any;
|
|
8866
9128
|
/**
|
|
8867
9129
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9069,8 +9331,12 @@ declare namespace Components {
|
|
|
9069
9331
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9070
9332
|
* fixed on the base entity.
|
|
9071
9333
|
*
|
|
9334
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
9335
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
9336
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
9337
|
+
*
|
|
9072
9338
|
*/
|
|
9073
|
-
|
|
9339
|
+
overridable_attribute?: boolean;
|
|
9074
9340
|
default_value?: any;
|
|
9075
9341
|
/**
|
|
9076
9342
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9278,8 +9544,12 @@ declare namespace Components {
|
|
|
9278
9544
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9279
9545
|
* fixed on the base entity.
|
|
9280
9546
|
*
|
|
9547
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
9548
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
9549
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
9550
|
+
*
|
|
9281
9551
|
*/
|
|
9282
|
-
|
|
9552
|
+
overridable_attribute?: boolean;
|
|
9283
9553
|
default_value?: any;
|
|
9284
9554
|
/**
|
|
9285
9555
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9487,8 +9757,12 @@ declare namespace Components {
|
|
|
9487
9757
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9488
9758
|
* fixed on the base entity.
|
|
9489
9759
|
*
|
|
9760
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
9761
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
9762
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
9763
|
+
*
|
|
9490
9764
|
*/
|
|
9491
|
-
|
|
9765
|
+
overridable_attribute?: boolean;
|
|
9492
9766
|
default_value?: any;
|
|
9493
9767
|
/**
|
|
9494
9768
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9696,8 +9970,12 @@ declare namespace Components {
|
|
|
9696
9970
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9697
9971
|
* fixed on the base entity.
|
|
9698
9972
|
*
|
|
9973
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
9974
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
9975
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
9976
|
+
*
|
|
9699
9977
|
*/
|
|
9700
|
-
|
|
9978
|
+
overridable_attribute?: boolean;
|
|
9701
9979
|
default_value?: any;
|
|
9702
9980
|
/**
|
|
9703
9981
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9905,8 +10183,12 @@ declare namespace Components {
|
|
|
9905
10183
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9906
10184
|
* fixed on the base entity.
|
|
9907
10185
|
*
|
|
10186
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
10187
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
10188
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
10189
|
+
*
|
|
9908
10190
|
*/
|
|
9909
|
-
|
|
10191
|
+
overridable_attribute?: boolean;
|
|
9910
10192
|
default_value?: any;
|
|
9911
10193
|
/**
|
|
9912
10194
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10114,8 +10396,12 @@ declare namespace Components {
|
|
|
10114
10396
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
10115
10397
|
* fixed on the base entity.
|
|
10116
10398
|
*
|
|
10399
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
10400
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
10401
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
10402
|
+
*
|
|
10117
10403
|
*/
|
|
10118
|
-
|
|
10404
|
+
overridable_attribute?: boolean;
|
|
10119
10405
|
default_value?: any;
|
|
10120
10406
|
/**
|
|
10121
10407
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10338,8 +10624,12 @@ declare namespace Components {
|
|
|
10338
10624
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
10339
10625
|
* fixed on the base entity.
|
|
10340
10626
|
*
|
|
10627
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
10628
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
10629
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
10630
|
+
*
|
|
10341
10631
|
*/
|
|
10342
|
-
|
|
10632
|
+
overridable_attribute?: boolean;
|
|
10343
10633
|
default_value?: any;
|
|
10344
10634
|
/**
|
|
10345
10635
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10773,8 +11063,12 @@ declare namespace Components {
|
|
|
10773
11063
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
10774
11064
|
* fixed on the base entity.
|
|
10775
11065
|
*
|
|
11066
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
11067
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
11068
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
11069
|
+
*
|
|
10776
11070
|
*/
|
|
10777
|
-
|
|
11071
|
+
overridable_attribute?: boolean;
|
|
10778
11072
|
default_value?: any;
|
|
10779
11073
|
/**
|
|
10780
11074
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11436,8 +11730,12 @@ declare namespace Components {
|
|
|
11436
11730
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11437
11731
|
* fixed on the base entity.
|
|
11438
11732
|
*
|
|
11733
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
11734
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
11735
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
11736
|
+
*
|
|
11439
11737
|
*/
|
|
11440
|
-
|
|
11738
|
+
overridable_attribute?: boolean;
|
|
11441
11739
|
default_value?: any;
|
|
11442
11740
|
/**
|
|
11443
11741
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11652,14 +11950,23 @@ declare namespace Components {
|
|
|
11652
11950
|
*/
|
|
11653
11951
|
type: "select";
|
|
11654
11952
|
/**
|
|
11655
|
-
* Selectable options
|
|
11953
|
+
* Selectable options, in the same shape a `select` attribute's `options` take: a bare
|
|
11954
|
+
* value or a `{ value, title }` object. May be empty while the condition is being
|
|
11955
|
+
* configured.
|
|
11956
|
+
*
|
|
11656
11957
|
* example:
|
|
11657
11958
|
* [
|
|
11658
11959
|
* "12_months",
|
|
11659
|
-
*
|
|
11960
|
+
* {
|
|
11961
|
+
* "value": "24_months",
|
|
11962
|
+
* "title": "24 months"
|
|
11963
|
+
* }
|
|
11660
11964
|
* ]
|
|
11661
11965
|
*/
|
|
11662
|
-
|
|
11966
|
+
options?: (string | {
|
|
11967
|
+
value: string;
|
|
11968
|
+
title?: string;
|
|
11969
|
+
})[];
|
|
11663
11970
|
}
|
|
11664
11971
|
/**
|
|
11665
11972
|
* Sequence of unique identifiers
|
|
@@ -11694,8 +12001,12 @@ declare namespace Components {
|
|
|
11694
12001
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11695
12002
|
* fixed on the base entity.
|
|
11696
12003
|
*
|
|
12004
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
12005
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
12006
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
12007
|
+
*
|
|
11697
12008
|
*/
|
|
11698
|
-
|
|
12009
|
+
overridable_attribute?: boolean;
|
|
11699
12010
|
default_value?: any;
|
|
11700
12011
|
/**
|
|
11701
12012
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11920,8 +12231,12 @@ declare namespace Components {
|
|
|
11920
12231
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11921
12232
|
* fixed on the base entity.
|
|
11922
12233
|
*
|
|
12234
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
12235
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
12236
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
12237
|
+
*
|
|
11923
12238
|
*/
|
|
11924
|
-
|
|
12239
|
+
overridable_attribute?: boolean;
|
|
11925
12240
|
default_value?: any;
|
|
11926
12241
|
/**
|
|
11927
12242
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -12225,8 +12540,12 @@ declare namespace Components {
|
|
|
12225
12540
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12226
12541
|
* fixed on the base entity.
|
|
12227
12542
|
*
|
|
12543
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
12544
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
12545
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
12546
|
+
*
|
|
12228
12547
|
*/
|
|
12229
|
-
|
|
12548
|
+
overridable_attribute?: boolean;
|
|
12230
12549
|
default_value?: any;
|
|
12231
12550
|
/**
|
|
12232
12551
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -12490,8 +12809,12 @@ declare namespace Components {
|
|
|
12490
12809
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12491
12810
|
* fixed on the base entity.
|
|
12492
12811
|
*
|
|
12812
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
12813
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
12814
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
12815
|
+
*
|
|
12493
12816
|
*/
|
|
12494
|
-
|
|
12817
|
+
overridable_attribute?: boolean;
|
|
12495
12818
|
default_value?: any;
|
|
12496
12819
|
/**
|
|
12497
12820
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -12901,8 +13224,12 @@ declare namespace Components {
|
|
|
12901
13224
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12902
13225
|
* fixed on the base entity.
|
|
12903
13226
|
*
|
|
13227
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
13228
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
13229
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
13230
|
+
*
|
|
12904
13231
|
*/
|
|
12905
|
-
|
|
13232
|
+
overridable_attribute?: boolean;
|
|
12906
13233
|
default_value?: any;
|
|
12907
13234
|
/**
|
|
12908
13235
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -13123,8 +13450,12 @@ declare namespace Components {
|
|
|
13123
13450
|
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
13124
13451
|
* fixed on the base entity.
|
|
13125
13452
|
*
|
|
13453
|
+
* Accepted on scalar attributes and on relations — a variant overrides a relation by
|
|
13454
|
+
* replacing its whole `$relation` list (e.g. a product's prices). Rejected on system
|
|
13455
|
+
* (`_`-prefixed), `readonly`, `hidden`, `computed` and `repeatable` attributes.
|
|
13456
|
+
*
|
|
13126
13457
|
*/
|
|
13127
|
-
|
|
13458
|
+
overridable_attribute?: boolean;
|
|
13128
13459
|
default_value?: any;
|
|
13129
13460
|
/**
|
|
13130
13461
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -13502,6 +13833,7 @@ declare namespace Paths {
|
|
|
13502
13833
|
* _tags
|
|
13503
13834
|
*/
|
|
13504
13835
|
export type Attribute = string;
|
|
13836
|
+
export type From = number;
|
|
13505
13837
|
export type Input = string;
|
|
13506
13838
|
export type Size = number;
|
|
13507
13839
|
export type Slug = /**
|
|
@@ -13521,10 +13853,14 @@ declare namespace Paths {
|
|
|
13521
13853
|
Parameters.Attribute;
|
|
13522
13854
|
slug?: Parameters.Slug;
|
|
13523
13855
|
size?: Parameters.Size;
|
|
13856
|
+
from?: Parameters.From;
|
|
13524
13857
|
}
|
|
13525
13858
|
namespace Responses {
|
|
13526
13859
|
export interface $200 {
|
|
13527
13860
|
/**
|
|
13861
|
+
* Number of distinct values matching the input. Exact (independent of `size`, capped at 1000) for
|
|
13862
|
+
* `_tags`; for other attributes the number of distinct values collected so far, which may grow with `size`.
|
|
13863
|
+
*
|
|
13528
13864
|
* example:
|
|
13529
13865
|
* 1
|
|
13530
13866
|
*/
|
|
@@ -15521,7 +15857,8 @@ declare namespace Paths {
|
|
|
15521
15857
|
*/
|
|
15522
15858
|
drafts_more?: boolean;
|
|
15523
15859
|
/**
|
|
15524
|
-
*
|
|
15860
|
+
* No longer returned: schema freezing is retired.
|
|
15861
|
+
*
|
|
15525
15862
|
*/
|
|
15526
15863
|
frozen_version?: string; // uuid
|
|
15527
15864
|
}
|
|
@@ -15575,7 +15912,7 @@ declare namespace Paths {
|
|
|
15575
15912
|
/**
|
|
15576
15913
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
15577
15914
|
* example:
|
|
15578
|
-
* 2023-01-01T00:00:
|
|
15915
|
+
* 2023-01-01T00:00:00Z
|
|
15579
15916
|
*/
|
|
15580
15917
|
export type CreatedAfter = string; // date-time
|
|
15581
15918
|
/**
|
|
@@ -15601,7 +15938,7 @@ declare namespace Paths {
|
|
|
15601
15938
|
created_after?: /**
|
|
15602
15939
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
15603
15940
|
* example:
|
|
15604
|
-
* 2023-01-01T00:00:
|
|
15941
|
+
* 2023-01-01T00:00:00Z
|
|
15605
15942
|
*/
|
|
15606
15943
|
Parameters.CreatedAfter /* date-time */;
|
|
15607
15944
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -17088,8 +17425,7 @@ export interface OperationMethods {
|
|
|
17088
17425
|
/**
|
|
17089
17426
|
* getSchema - getSchema
|
|
17090
17427
|
*
|
|
17091
|
-
*
|
|
17092
|
-
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
17428
|
+
* Gets the latest version of the Schema.
|
|
17093
17429
|
* Pass ?id= to get a specific version by ID.
|
|
17094
17430
|
*
|
|
17095
17431
|
*/
|
|
@@ -17102,7 +17438,6 @@ export interface OperationMethods {
|
|
|
17102
17438
|
* putSchema - putSchema
|
|
17103
17439
|
*
|
|
17104
17440
|
* Create or update a schema with a new version.
|
|
17105
|
-
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
17106
17441
|
*
|
|
17107
17442
|
*/
|
|
17108
17443
|
'putSchema'(
|
|
@@ -17153,9 +17488,8 @@ export interface OperationMethods {
|
|
|
17153
17488
|
/**
|
|
17154
17489
|
* freezeSchema - freezeSchema
|
|
17155
17490
|
*
|
|
17156
|
-
*
|
|
17157
|
-
*
|
|
17158
|
-
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
17491
|
+
* Deprecated no-op: schema freezing is retired and every read returns the latest version.
|
|
17492
|
+
* Returns the latest version of the schema unchanged. This endpoint will be removed.
|
|
17159
17493
|
*
|
|
17160
17494
|
*/
|
|
17161
17495
|
'freezeSchema'(
|
|
@@ -17166,7 +17500,9 @@ export interface OperationMethods {
|
|
|
17166
17500
|
/**
|
|
17167
17501
|
* unfreezeSchema - unfreezeSchema
|
|
17168
17502
|
*
|
|
17169
|
-
*
|
|
17503
|
+
* Deprecated: schema freezing is retired. Cleans up a leftover frozen pointer by promoting the
|
|
17504
|
+
* latest version to the current version, and succeeds when there is nothing to clean up.
|
|
17505
|
+
* This endpoint will be removed.
|
|
17170
17506
|
*
|
|
17171
17507
|
*/
|
|
17172
17508
|
'unfreezeSchema'(
|
|
@@ -17577,7 +17913,20 @@ export interface OperationMethods {
|
|
|
17577
17913
|
/**
|
|
17578
17914
|
* autocomplete - autocomplete
|
|
17579
17915
|
*
|
|
17580
|
-
* Autocomplete entity attributes
|
|
17916
|
+
* Autocomplete entity attributes.
|
|
17917
|
+
*
|
|
17918
|
+
* Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
|
|
17919
|
+
* A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
|
|
17920
|
+
* configuration.
|
|
17921
|
+
*
|
|
17922
|
+
* To enumerate the label catalogue managed in the Label Builder (including labels that are not
|
|
17923
|
+
* assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
|
|
17924
|
+
* `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
|
|
17925
|
+
* `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
|
|
17926
|
+
*
|
|
17927
|
+
* For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
|
|
17928
|
+
* number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
|
|
17929
|
+
* 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
|
|
17581
17930
|
*
|
|
17582
17931
|
*/
|
|
17583
17932
|
'autocomplete'(
|
|
@@ -18289,8 +18638,7 @@ export interface PathsDictionary {
|
|
|
18289
18638
|
/**
|
|
18290
18639
|
* getSchema - getSchema
|
|
18291
18640
|
*
|
|
18292
|
-
*
|
|
18293
|
-
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
18641
|
+
* Gets the latest version of the Schema.
|
|
18294
18642
|
* Pass ?id= to get a specific version by ID.
|
|
18295
18643
|
*
|
|
18296
18644
|
*/
|
|
@@ -18303,7 +18651,6 @@ export interface PathsDictionary {
|
|
|
18303
18651
|
* putSchema - putSchema
|
|
18304
18652
|
*
|
|
18305
18653
|
* Create or update a schema with a new version.
|
|
18306
|
-
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
18307
18654
|
*
|
|
18308
18655
|
*/
|
|
18309
18656
|
'put'(
|
|
@@ -18362,9 +18709,8 @@ export interface PathsDictionary {
|
|
|
18362
18709
|
/**
|
|
18363
18710
|
* freezeSchema - freezeSchema
|
|
18364
18711
|
*
|
|
18365
|
-
*
|
|
18366
|
-
*
|
|
18367
|
-
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
18712
|
+
* Deprecated no-op: schema freezing is retired and every read returns the latest version.
|
|
18713
|
+
* Returns the latest version of the schema unchanged. This endpoint will be removed.
|
|
18368
18714
|
*
|
|
18369
18715
|
*/
|
|
18370
18716
|
'post'(
|
|
@@ -18377,7 +18723,9 @@ export interface PathsDictionary {
|
|
|
18377
18723
|
/**
|
|
18378
18724
|
* unfreezeSchema - unfreezeSchema
|
|
18379
18725
|
*
|
|
18380
|
-
*
|
|
18726
|
+
* Deprecated: schema freezing is retired. Cleans up a leftover frozen pointer by promoting the
|
|
18727
|
+
* latest version to the current version, and succeeds when there is nothing to clean up.
|
|
18728
|
+
* This endpoint will be removed.
|
|
18381
18729
|
*
|
|
18382
18730
|
*/
|
|
18383
18731
|
'post'(
|
|
@@ -18816,7 +19164,20 @@ export interface PathsDictionary {
|
|
|
18816
19164
|
/**
|
|
18817
19165
|
* autocomplete - autocomplete
|
|
18818
19166
|
*
|
|
18819
|
-
* Autocomplete entity attributes
|
|
19167
|
+
* Autocomplete entity attributes.
|
|
19168
|
+
*
|
|
19169
|
+
* Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
|
|
19170
|
+
* A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
|
|
19171
|
+
* configuration.
|
|
19172
|
+
*
|
|
19173
|
+
* To enumerate the label catalogue managed in the Label Builder (including labels that are not
|
|
19174
|
+
* assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
|
|
19175
|
+
* `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
|
|
19176
|
+
* `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
|
|
19177
|
+
*
|
|
19178
|
+
* For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
|
|
19179
|
+
* number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
|
|
19180
|
+
* 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
|
|
18820
19181
|
*
|
|
18821
19182
|
*/
|
|
18822
19183
|
'get'(
|