@geolens/sdk 1.29.2 → 1.30.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/sdk.gen.d.ts +347 -321
- package/dist/client/sdk.gen.d.ts.map +1 -1
- package/dist/client/sdk.gen.js +346 -320
- package/dist/client/sdk.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +906 -21
- package/dist/client/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -534,6 +534,31 @@ export type AdminUserCreate = {
|
|
|
534
534
|
*/
|
|
535
535
|
role?: string;
|
|
536
536
|
};
|
|
537
|
+
/**
|
|
538
|
+
* AggregateRow
|
|
539
|
+
*/
|
|
540
|
+
export type AggregateRow = {
|
|
541
|
+
/**
|
|
542
|
+
* Gid
|
|
543
|
+
*
|
|
544
|
+
* The feature's id; text at or beyond 2^53, as for a value.
|
|
545
|
+
*/
|
|
546
|
+
gid: number | string;
|
|
547
|
+
/**
|
|
548
|
+
* Values
|
|
549
|
+
*
|
|
550
|
+
* By column. The column's value. A number JSON cannot carry exactly, such as an integer beyond 2^53 or NaN, comes back as text.
|
|
551
|
+
*/
|
|
552
|
+
values: {
|
|
553
|
+
[key: string]: string | number | number | boolean | null;
|
|
554
|
+
};
|
|
555
|
+
/**
|
|
556
|
+
* Bbox
|
|
557
|
+
*
|
|
558
|
+
* Present only when the dataset has geometry: the feature's `[west, south, east, north]` in WGS 84, or null without a shape.
|
|
559
|
+
*/
|
|
560
|
+
bbox?: Array<number> | null;
|
|
561
|
+
};
|
|
537
562
|
/**
|
|
538
563
|
* AlterColumnTypeRequest
|
|
539
564
|
*/
|
|
@@ -1008,6 +1033,41 @@ export type ArcgisLossReport = {
|
|
|
1008
1033
|
[key: string]: number;
|
|
1009
1034
|
};
|
|
1010
1035
|
};
|
|
1036
|
+
/**
|
|
1037
|
+
* ArcgisTranslatedView
|
|
1038
|
+
*/
|
|
1039
|
+
export type ArcgisTranslatedView = {
|
|
1040
|
+
/**
|
|
1041
|
+
* Basemap Style
|
|
1042
|
+
*
|
|
1043
|
+
* The GeoLens basemap id.
|
|
1044
|
+
*/
|
|
1045
|
+
basemap_style: string | null;
|
|
1046
|
+
/**
|
|
1047
|
+
* Center Lng
|
|
1048
|
+
*
|
|
1049
|
+
* Initial center longitude.
|
|
1050
|
+
*/
|
|
1051
|
+
center_lng: number | null;
|
|
1052
|
+
/**
|
|
1053
|
+
* Center Lat
|
|
1054
|
+
*
|
|
1055
|
+
* Initial center latitude.
|
|
1056
|
+
*/
|
|
1057
|
+
center_lat: number | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* Zoom
|
|
1060
|
+
*
|
|
1061
|
+
* Initial zoom level.
|
|
1062
|
+
*/
|
|
1063
|
+
zoom: number | null;
|
|
1064
|
+
/**
|
|
1065
|
+
* Bearing
|
|
1066
|
+
*
|
|
1067
|
+
* Initial rotation in degrees.
|
|
1068
|
+
*/
|
|
1069
|
+
bearing: number | null;
|
|
1070
|
+
};
|
|
1011
1071
|
/**
|
|
1012
1072
|
* ArcgisUnmatchedLayer
|
|
1013
1073
|
*/
|
|
@@ -1109,6 +1169,22 @@ export type ArcgisWebmapImportResponse = {
|
|
|
1109
1169
|
* Unmatched Layers
|
|
1110
1170
|
*/
|
|
1111
1171
|
unmatched_layers: Array<ArcgisUnmatchedLayer>;
|
|
1172
|
+
/**
|
|
1173
|
+
* Layer Sources
|
|
1174
|
+
*
|
|
1175
|
+
* The operational layer id each entry of `layers` was translated from, in the same order.
|
|
1176
|
+
*/
|
|
1177
|
+
layer_sources?: Array<string>;
|
|
1178
|
+
/**
|
|
1179
|
+
* The initial view and basemap the map gets.
|
|
1180
|
+
*/
|
|
1181
|
+
view?: ArcgisTranslatedView | null;
|
|
1182
|
+
/**
|
|
1183
|
+
* Notes
|
|
1184
|
+
*
|
|
1185
|
+
* The loss report as the import writes it to the map's notes.
|
|
1186
|
+
*/
|
|
1187
|
+
notes?: string | null;
|
|
1112
1188
|
};
|
|
1113
1189
|
/**
|
|
1114
1190
|
* AttributeMetadataListResponse
|
|
@@ -1474,12 +1550,18 @@ export type BackfillTenantRun = {
|
|
|
1474
1550
|
* BarChartConfig
|
|
1475
1551
|
*/
|
|
1476
1552
|
export type BarChartConfig = {
|
|
1553
|
+
/**
|
|
1554
|
+
* Mode
|
|
1555
|
+
*
|
|
1556
|
+
* `category`: one bar per value of `column`. `by_feature`: one bar per feature, labelled by `label_column`, sized by `value_column`. `by_fields`: one bar per name in `fields`, each showing `stat` of that field. `date`: `column` grouped by `date_bucket`.
|
|
1557
|
+
*/
|
|
1558
|
+
mode?: 'category' | 'by_feature' | 'by_fields' | 'date';
|
|
1477
1559
|
/**
|
|
1478
1560
|
* Column
|
|
1479
1561
|
*
|
|
1480
|
-
* The column whose values become bars.
|
|
1562
|
+
* The column whose values become bars (`category` and `date`).
|
|
1481
1563
|
*/
|
|
1482
|
-
column
|
|
1564
|
+
column?: string | null;
|
|
1483
1565
|
/**
|
|
1484
1566
|
* Stat
|
|
1485
1567
|
*/
|
|
@@ -1492,6 +1574,42 @@ export type BarChartConfig = {
|
|
|
1492
1574
|
* Limit
|
|
1493
1575
|
*/
|
|
1494
1576
|
limit?: number;
|
|
1577
|
+
/**
|
|
1578
|
+
* Label Column
|
|
1579
|
+
*
|
|
1580
|
+
* `by_feature`: the field that labels each bar.
|
|
1581
|
+
*/
|
|
1582
|
+
label_column?: string | null;
|
|
1583
|
+
/**
|
|
1584
|
+
* Value Column
|
|
1585
|
+
*
|
|
1586
|
+
* `by_feature`: the numeric field that sizes each bar.
|
|
1587
|
+
*/
|
|
1588
|
+
value_column?: string | null;
|
|
1589
|
+
/**
|
|
1590
|
+
* Sort
|
|
1591
|
+
*
|
|
1592
|
+
* `by_feature`: bar order by value.
|
|
1593
|
+
*/
|
|
1594
|
+
sort?: 'asc' | 'desc';
|
|
1595
|
+
/**
|
|
1596
|
+
* Fields
|
|
1597
|
+
*
|
|
1598
|
+
* `by_fields`: the numeric fields to chart, one bar each.
|
|
1599
|
+
*/
|
|
1600
|
+
fields?: Array<string>;
|
|
1601
|
+
/**
|
|
1602
|
+
* Date Bucket
|
|
1603
|
+
*
|
|
1604
|
+
* `date`: the span each bar covers.
|
|
1605
|
+
*/
|
|
1606
|
+
date_bucket?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1607
|
+
/**
|
|
1608
|
+
* Use Layer Colors
|
|
1609
|
+
*
|
|
1610
|
+
* `category`: colour bars as the layer does when `column` is its style column.
|
|
1611
|
+
*/
|
|
1612
|
+
use_layer_colors?: boolean;
|
|
1495
1613
|
};
|
|
1496
1614
|
/**
|
|
1497
1615
|
* BarChartWidget
|
|
@@ -1526,7 +1644,7 @@ export type BarChartWidget = {
|
|
|
1526
1644
|
/**
|
|
1527
1645
|
* V
|
|
1528
1646
|
*/
|
|
1529
|
-
v: 1;
|
|
1647
|
+
v: 1 | 2;
|
|
1530
1648
|
config: BarChartConfig;
|
|
1531
1649
|
};
|
|
1532
1650
|
/**
|
|
@@ -2164,6 +2282,30 @@ export type CapabilitiesUpload = {
|
|
|
2164
2282
|
*/
|
|
2165
2283
|
presigned: boolean;
|
|
2166
2284
|
};
|
|
2285
|
+
/**
|
|
2286
|
+
* CarouselWidget
|
|
2287
|
+
*/
|
|
2288
|
+
export type CarouselWidget = {
|
|
2289
|
+
/**
|
|
2290
|
+
* Id
|
|
2291
|
+
*
|
|
2292
|
+
* Made by the client and stable across saves.
|
|
2293
|
+
*/
|
|
2294
|
+
id: string;
|
|
2295
|
+
/**
|
|
2296
|
+
* Title
|
|
2297
|
+
*/
|
|
2298
|
+
title?: string | null;
|
|
2299
|
+
/**
|
|
2300
|
+
* Type
|
|
2301
|
+
*/
|
|
2302
|
+
type: 'carousel';
|
|
2303
|
+
/**
|
|
2304
|
+
* V
|
|
2305
|
+
*/
|
|
2306
|
+
v: 1;
|
|
2307
|
+
config: GalleryConfig;
|
|
2308
|
+
};
|
|
2167
2309
|
/**
|
|
2168
2310
|
* CatalogStatsResponse
|
|
2169
2311
|
*/
|
|
@@ -3580,12 +3722,24 @@ export type DashboardConfig = {
|
|
|
3580
3722
|
* Where the panel sits beside the map: `right` or `bottom`. On narrow screens it is always below the map.
|
|
3581
3723
|
*/
|
|
3582
3724
|
panel?: 'right' | 'bottom';
|
|
3725
|
+
/**
|
|
3726
|
+
* Map Hidden
|
|
3727
|
+
*
|
|
3728
|
+
* Show the widgets across the full page and don't mount the map. Widgets scoped to the map view fall back to the whole layer.
|
|
3729
|
+
*/
|
|
3730
|
+
map_hidden?: boolean;
|
|
3731
|
+
/**
|
|
3732
|
+
* Theme
|
|
3733
|
+
*
|
|
3734
|
+
* The page's colours: `light`, `dark`, or `follow` the reader's setting.
|
|
3735
|
+
*/
|
|
3736
|
+
theme?: 'follow' | 'light' | 'dark';
|
|
3583
3737
|
/**
|
|
3584
3738
|
* Widgets
|
|
3585
3739
|
*
|
|
3586
3740
|
* The widgets on layers this response shows, in panel order.
|
|
3587
3741
|
*/
|
|
3588
|
-
widgets: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | HistogramWidget | CategorySelectorWidget>;
|
|
3742
|
+
widgets: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | PieChartWidget | FeatureListWidget | TableWidget | HistogramWidget | CategorySelectorWidget>;
|
|
3589
3743
|
};
|
|
3590
3744
|
/**
|
|
3591
3745
|
* DashboardConfigInput
|
|
@@ -3601,12 +3755,30 @@ export type DashboardConfigInput = {
|
|
|
3601
3755
|
* Where the panel sits beside the map: `right` or `bottom`. On narrow screens it is always below the map. Leave it out to keep the stored panel.
|
|
3602
3756
|
*/
|
|
3603
3757
|
panel?: 'right' | 'bottom' | null;
|
|
3758
|
+
/**
|
|
3759
|
+
* Map Hidden
|
|
3760
|
+
*
|
|
3761
|
+
* Show the widgets across the full page and don't mount the map. Widgets scoped to the map view fall back to the whole layer. Leave it out to keep the stored value.
|
|
3762
|
+
*/
|
|
3763
|
+
map_hidden?: boolean | null;
|
|
3764
|
+
/**
|
|
3765
|
+
* Theme
|
|
3766
|
+
*
|
|
3767
|
+
* The page's colours: `light`, `dark`, or `follow` the reader's setting. Leave it out to keep the stored theme.
|
|
3768
|
+
*/
|
|
3769
|
+
theme?: 'follow' | 'light' | 'dark' | null;
|
|
3770
|
+
/**
|
|
3771
|
+
* Readable
|
|
3772
|
+
*
|
|
3773
|
+
* The widget `type:v` pairs this client can parse, such as `bar_chart:1`. Stored widgets outside the list are kept in place. Leave it out for the widgets of earlier releases.
|
|
3774
|
+
*/
|
|
3775
|
+
readable?: Array<string> | null;
|
|
3604
3776
|
/**
|
|
3605
3777
|
* Widgets
|
|
3606
3778
|
*
|
|
3607
3779
|
* Widgets in panel order. Each, except a text widget, names a layer of this map that you can read. Stored widgets you can't see are kept in place.
|
|
3608
3780
|
*/
|
|
3609
|
-
widgets?: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | HistogramWidget | CategorySelectorWidget>;
|
|
3781
|
+
widgets?: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | PieChartWidget | FeatureListWidget | TableWidget | HistogramWidget | CategorySelectorWidget>;
|
|
3610
3782
|
};
|
|
3611
3783
|
/**
|
|
3612
3784
|
* DatasetApiKeyCreateRequest
|
|
@@ -5199,6 +5371,10 @@ export type DuplicateMapResponse = {
|
|
|
5199
5371
|
* The sharing groups the map is shared with, by name. Set on the detail endpoint for the owner and admins only; null elsewhere.
|
|
5200
5372
|
*/
|
|
5201
5373
|
groups?: Array<GroupRef> | null;
|
|
5374
|
+
/**
|
|
5375
|
+
* The theme a branding extension sets for the map's viewer and dashboard; null without one. The Builder ignores it.
|
|
5376
|
+
*/
|
|
5377
|
+
reader_theme?: ReaderTheme | null;
|
|
5202
5378
|
/**
|
|
5203
5379
|
* Excluded Layer Count
|
|
5204
5380
|
*
|
|
@@ -5380,6 +5556,30 @@ export type EmbedTokenUpdate = {
|
|
|
5380
5556
|
*/
|
|
5381
5557
|
allowed_origins?: Array<string> | null;
|
|
5382
5558
|
};
|
|
5559
|
+
/**
|
|
5560
|
+
* EmbedWidget
|
|
5561
|
+
*/
|
|
5562
|
+
export type EmbedWidget = {
|
|
5563
|
+
/**
|
|
5564
|
+
* Id
|
|
5565
|
+
*
|
|
5566
|
+
* Made by the client and stable across saves.
|
|
5567
|
+
*/
|
|
5568
|
+
id: string;
|
|
5569
|
+
/**
|
|
5570
|
+
* Title
|
|
5571
|
+
*/
|
|
5572
|
+
title?: string | null;
|
|
5573
|
+
/**
|
|
5574
|
+
* Type
|
|
5575
|
+
*/
|
|
5576
|
+
type: 'embed';
|
|
5577
|
+
/**
|
|
5578
|
+
* V
|
|
5579
|
+
*/
|
|
5580
|
+
v: 1;
|
|
5581
|
+
config: FrameConfig;
|
|
5582
|
+
};
|
|
5383
5583
|
/**
|
|
5384
5584
|
* EmbeddingStatsResponse
|
|
5385
5585
|
*/
|
|
@@ -5694,6 +5894,67 @@ export type FeatureFlagsResponse = {
|
|
|
5694
5894
|
*/
|
|
5695
5895
|
restrict_public_visibility?: boolean;
|
|
5696
5896
|
};
|
|
5897
|
+
/**
|
|
5898
|
+
* FeatureListConfig
|
|
5899
|
+
*/
|
|
5900
|
+
export type FeatureListConfig = {
|
|
5901
|
+
/**
|
|
5902
|
+
* Title Column
|
|
5903
|
+
*/
|
|
5904
|
+
title_column: string;
|
|
5905
|
+
/**
|
|
5906
|
+
* Subtitle Column
|
|
5907
|
+
*/
|
|
5908
|
+
subtitle_column?: string | null;
|
|
5909
|
+
/**
|
|
5910
|
+
* Sort Column
|
|
5911
|
+
*/
|
|
5912
|
+
sort_column?: string | null;
|
|
5913
|
+
/**
|
|
5914
|
+
* Sort
|
|
5915
|
+
*/
|
|
5916
|
+
sort?: 'asc' | 'desc';
|
|
5917
|
+
/**
|
|
5918
|
+
* Page Size
|
|
5919
|
+
*/
|
|
5920
|
+
page_size?: number;
|
|
5921
|
+
};
|
|
5922
|
+
/**
|
|
5923
|
+
* FeatureListWidget
|
|
5924
|
+
*/
|
|
5925
|
+
export type FeatureListWidget = {
|
|
5926
|
+
/**
|
|
5927
|
+
* Id
|
|
5928
|
+
*
|
|
5929
|
+
* Made by the client and stable across saves.
|
|
5930
|
+
*/
|
|
5931
|
+
id: string;
|
|
5932
|
+
/**
|
|
5933
|
+
* Title
|
|
5934
|
+
*/
|
|
5935
|
+
title?: string | null;
|
|
5936
|
+
/**
|
|
5937
|
+
* Layer Id
|
|
5938
|
+
*
|
|
5939
|
+
* A layer of the host's map.
|
|
5940
|
+
*/
|
|
5941
|
+
layer_id: string;
|
|
5942
|
+
/**
|
|
5943
|
+
* Scope
|
|
5944
|
+
*
|
|
5945
|
+
* Summarize the whole layer, or only what the map view shows.
|
|
5946
|
+
*/
|
|
5947
|
+
scope?: 'layer' | 'view';
|
|
5948
|
+
/**
|
|
5949
|
+
* Type
|
|
5950
|
+
*/
|
|
5951
|
+
type: 'feature_list';
|
|
5952
|
+
/**
|
|
5953
|
+
* V
|
|
5954
|
+
*/
|
|
5955
|
+
v: 1;
|
|
5956
|
+
config: FeatureListConfig;
|
|
5957
|
+
};
|
|
5697
5958
|
/**
|
|
5698
5959
|
* FeatureReplace
|
|
5699
5960
|
*
|
|
@@ -5728,6 +5989,85 @@ export type FeatureUpdate = {
|
|
|
5728
5989
|
[key: string]: unknown;
|
|
5729
5990
|
} | null;
|
|
5730
5991
|
};
|
|
5992
|
+
/**
|
|
5993
|
+
* FrameConfig
|
|
5994
|
+
*/
|
|
5995
|
+
export type FrameConfig = {
|
|
5996
|
+
/**
|
|
5997
|
+
* Url
|
|
5998
|
+
*
|
|
5999
|
+
* An https address on a host an admin approved for stories. Stored as given and never fetched by the server.
|
|
6000
|
+
*/
|
|
6001
|
+
url: string;
|
|
6002
|
+
/**
|
|
6003
|
+
* Title
|
|
6004
|
+
*
|
|
6005
|
+
* Names the frame for screen readers.
|
|
6006
|
+
*/
|
|
6007
|
+
title: string;
|
|
6008
|
+
};
|
|
6009
|
+
/**
|
|
6010
|
+
* GalleryConfig
|
|
6011
|
+
*/
|
|
6012
|
+
export type GalleryConfig = {
|
|
6013
|
+
/**
|
|
6014
|
+
* Images
|
|
6015
|
+
*
|
|
6016
|
+
* Images uploaded to the host story, in reading order.
|
|
6017
|
+
*/
|
|
6018
|
+
images: Array<GalleryImage>;
|
|
6019
|
+
};
|
|
6020
|
+
/**
|
|
6021
|
+
* GalleryImage
|
|
6022
|
+
*/
|
|
6023
|
+
export type GalleryImage = {
|
|
6024
|
+
/**
|
|
6025
|
+
* Alt
|
|
6026
|
+
*
|
|
6027
|
+
* Text that stands in for the image; required unless it is decorative.
|
|
6028
|
+
*/
|
|
6029
|
+
alt?: string | null;
|
|
6030
|
+
/**
|
|
6031
|
+
* Decorative
|
|
6032
|
+
*
|
|
6033
|
+
* True when the image adds nothing a reader needs: readers get an empty alt, and `alt` may be left out.
|
|
6034
|
+
*/
|
|
6035
|
+
decorative?: boolean | null;
|
|
6036
|
+
/**
|
|
6037
|
+
* Caption
|
|
6038
|
+
*/
|
|
6039
|
+
caption?: string | null;
|
|
6040
|
+
/**
|
|
6041
|
+
* Asset Id
|
|
6042
|
+
*
|
|
6043
|
+
* An image uploaded to the host story.
|
|
6044
|
+
*/
|
|
6045
|
+
asset_id: string;
|
|
6046
|
+
};
|
|
6047
|
+
/**
|
|
6048
|
+
* GalleryWidget
|
|
6049
|
+
*/
|
|
6050
|
+
export type GalleryWidget = {
|
|
6051
|
+
/**
|
|
6052
|
+
* Id
|
|
6053
|
+
*
|
|
6054
|
+
* Made by the client and stable across saves.
|
|
6055
|
+
*/
|
|
6056
|
+
id: string;
|
|
6057
|
+
/**
|
|
6058
|
+
* Title
|
|
6059
|
+
*/
|
|
6060
|
+
title?: string | null;
|
|
6061
|
+
/**
|
|
6062
|
+
* Type
|
|
6063
|
+
*/
|
|
6064
|
+
type: 'gallery';
|
|
6065
|
+
/**
|
|
6066
|
+
* V
|
|
6067
|
+
*/
|
|
6068
|
+
v: 1;
|
|
6069
|
+
config: GalleryConfig;
|
|
6070
|
+
};
|
|
5731
6071
|
/**
|
|
5732
6072
|
* GeoJSONFeature
|
|
5733
6073
|
*
|
|
@@ -5837,14 +6177,40 @@ export type GroupByRequest = {
|
|
|
5837
6177
|
group_column: string;
|
|
5838
6178
|
/**
|
|
5839
6179
|
* Stat
|
|
6180
|
+
*
|
|
6181
|
+
* One statistic; or give `stats`.
|
|
5840
6182
|
*/
|
|
5841
|
-
stat
|
|
6183
|
+
stat?: 'count' | 'sum' | 'avg' | 'min' | 'max' | null;
|
|
5842
6184
|
/**
|
|
5843
6185
|
* Column
|
|
5844
6186
|
*
|
|
5845
6187
|
* The numeric column `stat` reads; omit for `count`.
|
|
5846
6188
|
*/
|
|
5847
6189
|
column?: string | null;
|
|
6190
|
+
/**
|
|
6191
|
+
* Stats
|
|
6192
|
+
*
|
|
6193
|
+
* Statistics returned as each group's `values`, in this order.
|
|
6194
|
+
*/
|
|
6195
|
+
stats?: Array<GroupStat> | null;
|
|
6196
|
+
/**
|
|
6197
|
+
* Date Bucket
|
|
6198
|
+
*
|
|
6199
|
+
* Group a date or timestamp column by the UTC day, Monday-first week, month or year it falls in.
|
|
6200
|
+
*/
|
|
6201
|
+
date_bucket?: 'day' | 'week' | 'month' | 'year' | null;
|
|
6202
|
+
/**
|
|
6203
|
+
* Sort By
|
|
6204
|
+
*
|
|
6205
|
+
* Order and keep groups by a statistic's index in `stats` (0 with `stat`) or by `group`. Defaults to the first statistic, or to the group with `date_bucket`.
|
|
6206
|
+
*/
|
|
6207
|
+
sort_by?: 'group' | number | null;
|
|
6208
|
+
/**
|
|
6209
|
+
* Sort
|
|
6210
|
+
*
|
|
6211
|
+
* Defaults to `desc`, or `asc` with `date_bucket`.
|
|
6212
|
+
*/
|
|
6213
|
+
sort?: 'asc' | 'desc' | null;
|
|
5848
6214
|
/**
|
|
5849
6215
|
* Limit
|
|
5850
6216
|
*/
|
|
@@ -5877,9 +6243,15 @@ export type GroupByResult = {
|
|
|
5877
6243
|
/**
|
|
5878
6244
|
* Groups
|
|
5879
6245
|
*
|
|
5880
|
-
*
|
|
6246
|
+
* In the requested order; by default the largest value first.
|
|
5881
6247
|
*/
|
|
5882
6248
|
groups: Array<GroupValue>;
|
|
6249
|
+
/**
|
|
6250
|
+
* Truncated
|
|
6251
|
+
*
|
|
6252
|
+
* Whether more groups matched than `limit` lists.
|
|
6253
|
+
*/
|
|
6254
|
+
truncated?: boolean;
|
|
5883
6255
|
};
|
|
5884
6256
|
/**
|
|
5885
6257
|
* GroupListResponse
|
|
@@ -5995,6 +6367,21 @@ export type GroupResponse = {
|
|
|
5995
6367
|
*/
|
|
5996
6368
|
updated_at: string;
|
|
5997
6369
|
};
|
|
6370
|
+
/**
|
|
6371
|
+
* GroupStat
|
|
6372
|
+
*/
|
|
6373
|
+
export type GroupStat = {
|
|
6374
|
+
/**
|
|
6375
|
+
* Stat
|
|
6376
|
+
*/
|
|
6377
|
+
stat: 'count' | 'sum' | 'avg' | 'min' | 'max';
|
|
6378
|
+
/**
|
|
6379
|
+
* Column
|
|
6380
|
+
*
|
|
6381
|
+
* The numeric column `stat` reads. Optional for `count`, which then counts rows, and otherwise counts the column's non-null values.
|
|
6382
|
+
*/
|
|
6383
|
+
column?: string | null;
|
|
6384
|
+
};
|
|
5998
6385
|
/**
|
|
5999
6386
|
* GroupValue
|
|
6000
6387
|
*/
|
|
@@ -6008,9 +6395,15 @@ export type GroupValue = {
|
|
|
6008
6395
|
/**
|
|
6009
6396
|
* Value
|
|
6010
6397
|
*
|
|
6011
|
-
* Exact for count, sum, min and max, as for a key; avg is a float.
|
|
6398
|
+
* Exact for count, sum, min and max, as for a key; avg is a float. With `stats`, the first statistic's value.
|
|
6012
6399
|
*/
|
|
6013
6400
|
value: number | number | string | null;
|
|
6401
|
+
/**
|
|
6402
|
+
* Values
|
|
6403
|
+
*
|
|
6404
|
+
* Present with `stats`: each one's value in order. Exact for count, sum, min and max, as for a key; avg is a float.
|
|
6405
|
+
*/
|
|
6406
|
+
values?: Array<number | number | string | null> | null;
|
|
6014
6407
|
};
|
|
6015
6408
|
/**
|
|
6016
6409
|
* GroupWrite
|
|
@@ -6297,6 +6690,30 @@ export type IndicatorConfig = {
|
|
|
6297
6690
|
* Column
|
|
6298
6691
|
*/
|
|
6299
6692
|
column?: string | null;
|
|
6693
|
+
/**
|
|
6694
|
+
* Reference
|
|
6695
|
+
*
|
|
6696
|
+
* A fixed number to compare the value with. The indicator shows the difference from it.
|
|
6697
|
+
*/
|
|
6698
|
+
reference?: number | null;
|
|
6699
|
+
/**
|
|
6700
|
+
* Reference Label
|
|
6701
|
+
*
|
|
6702
|
+
* A short name for the reference, such as `Target`. Needs `reference`.
|
|
6703
|
+
*/
|
|
6704
|
+
reference_label?: string | null;
|
|
6705
|
+
/**
|
|
6706
|
+
* Higher Is Better
|
|
6707
|
+
*
|
|
6708
|
+
* Whether a value above the reference is the good outcome. Absent means true.
|
|
6709
|
+
*/
|
|
6710
|
+
higher_is_better?: boolean | null;
|
|
6711
|
+
/**
|
|
6712
|
+
* Comparison
|
|
6713
|
+
*
|
|
6714
|
+
* Show the difference as a `value`, a `percent` change, or `both`. Absent means `both`.
|
|
6715
|
+
*/
|
|
6716
|
+
comparison?: 'value' | 'percent' | 'both' | null;
|
|
6300
6717
|
};
|
|
6301
6718
|
/**
|
|
6302
6719
|
* IndicatorWidget
|
|
@@ -6330,8 +6747,10 @@ export type IndicatorWidget = {
|
|
|
6330
6747
|
type: 'indicator';
|
|
6331
6748
|
/**
|
|
6332
6749
|
* V
|
|
6750
|
+
*
|
|
6751
|
+
* `2` when the config sets any reference option, else `1`. A `1` that sets one is refused.
|
|
6333
6752
|
*/
|
|
6334
|
-
v: 1;
|
|
6753
|
+
v: 1 | 2;
|
|
6335
6754
|
config: IndicatorConfig;
|
|
6336
6755
|
};
|
|
6337
6756
|
/**
|
|
@@ -7238,6 +7657,12 @@ export type MapGroupsResponse = {
|
|
|
7238
7657
|
* Layers that some of the map's new groups still can't read; the same shape a 409 lists under `detail.layers`.
|
|
7239
7658
|
*/
|
|
7240
7659
|
hidden_layers?: Array<MapLayerAccessGap>;
|
|
7660
|
+
/**
|
|
7661
|
+
* Updated At
|
|
7662
|
+
*
|
|
7663
|
+
* The map's `updated_at` after the change, which any change to its groups moves.
|
|
7664
|
+
*/
|
|
7665
|
+
updated_at?: string | null;
|
|
7241
7666
|
};
|
|
7242
7667
|
/**
|
|
7243
7668
|
* MapGroupsUpdate
|
|
@@ -7255,6 +7680,12 @@ export type MapGroupsUpdate = {
|
|
|
7255
7680
|
* Required when the map would become restricted with layers some of its new groups can't read; without it the request answers 409 and lists them. `share_datasets` also shares each such dataset the caller may share with the groups that lack it; `map_only` leaves those layers hidden from them.
|
|
7256
7681
|
*/
|
|
7257
7682
|
confirm?: 'share_datasets' | 'map_only' | null;
|
|
7683
|
+
/**
|
|
7684
|
+
* Expected Updated At
|
|
7685
|
+
*
|
|
7686
|
+
* The map's `updated_at` the caller read. When set and the map has changed since, its groups included, nothing is written and the answer is 409 with `detail.code` `stale_write`. Omit it to write unconditionally.
|
|
7687
|
+
*/
|
|
7688
|
+
expected_updated_at?: string | null;
|
|
7258
7689
|
};
|
|
7259
7690
|
/**
|
|
7260
7691
|
* MapHistoryEventResponse
|
|
@@ -7891,6 +8322,10 @@ export type MapResponse = {
|
|
|
7891
8322
|
* The sharing groups the map is shared with, by name. Set on the detail endpoint for the owner and admins only; null elsewhere.
|
|
7892
8323
|
*/
|
|
7893
8324
|
groups?: Array<GroupRef> | null;
|
|
8325
|
+
/**
|
|
8326
|
+
* The theme a branding extension sets for the map's viewer and dashboard; null without one. The Builder ignores it.
|
|
8327
|
+
*/
|
|
8328
|
+
reader_theme?: ReaderTheme | null;
|
|
7894
8329
|
};
|
|
7895
8330
|
/**
|
|
7896
8331
|
* MapSpriteEntry
|
|
@@ -7947,10 +8382,6 @@ export type MapStoryReference = {
|
|
|
7947
8382
|
* forward-compatibility with future MapLibre fields (e.g. ``projection``,
|
|
7948
8383
|
* ``light``, ``transition``) so adding a new key on the client side
|
|
7949
8384
|
* doesn't require a server release.
|
|
7950
|
-
*
|
|
7951
|
-
* Replacing the previous bare-``dict`` body parameter removes
|
|
7952
|
-
* ``additionalProperties: true`` from the OpenAPI schema and lets
|
|
7953
|
-
* openapi-python-client generate a navigable named model class.
|
|
7954
8385
|
*/
|
|
7955
8386
|
export type MapStyleImportRequest = {
|
|
7956
8387
|
/**
|
|
@@ -8234,6 +8665,12 @@ export type MapUpdate = {
|
|
|
8234
8665
|
* Custom map-level legend title. Null or empty leaves the legend without a heading override. At most 120 characters.
|
|
8235
8666
|
*/
|
|
8236
8667
|
legend_title?: string | null;
|
|
8668
|
+
/**
|
|
8669
|
+
* Expected Updated At
|
|
8670
|
+
*
|
|
8671
|
+
* The map's `updated_at` the caller read. When set and the map has changed since, nothing is written and the answer is 409 with `detail.code` `stale_write`. Omit it to write unconditionally.
|
|
8672
|
+
*/
|
|
8673
|
+
expected_updated_at?: string | null;
|
|
8237
8674
|
};
|
|
8238
8675
|
/**
|
|
8239
8676
|
* MapVisibility
|
|
@@ -9390,6 +9827,73 @@ export type PermissionsResponse = {
|
|
|
9390
9827
|
[key: string]: boolean;
|
|
9391
9828
|
};
|
|
9392
9829
|
};
|
|
9830
|
+
/**
|
|
9831
|
+
* PieChartConfig
|
|
9832
|
+
*/
|
|
9833
|
+
export type PieChartConfig = {
|
|
9834
|
+
/**
|
|
9835
|
+
* Column
|
|
9836
|
+
*
|
|
9837
|
+
* The column whose values become slices.
|
|
9838
|
+
*/
|
|
9839
|
+
column: string;
|
|
9840
|
+
/**
|
|
9841
|
+
* Stat
|
|
9842
|
+
*/
|
|
9843
|
+
stat?: 'count' | 'sum' | 'mean' | 'min' | 'max';
|
|
9844
|
+
/**
|
|
9845
|
+
* Stat Column
|
|
9846
|
+
*/
|
|
9847
|
+
stat_column?: string | null;
|
|
9848
|
+
/**
|
|
9849
|
+
* Limit
|
|
9850
|
+
*
|
|
9851
|
+
* Slices beyond this many are merged into Other.
|
|
9852
|
+
*/
|
|
9853
|
+
limit?: number;
|
|
9854
|
+
/**
|
|
9855
|
+
* Use Layer Colors
|
|
9856
|
+
*
|
|
9857
|
+
* Colour slices as the layer does when `column` is its style column.
|
|
9858
|
+
*/
|
|
9859
|
+
use_layer_colors?: boolean;
|
|
9860
|
+
};
|
|
9861
|
+
/**
|
|
9862
|
+
* PieChartWidget
|
|
9863
|
+
*/
|
|
9864
|
+
export type PieChartWidget = {
|
|
9865
|
+
/**
|
|
9866
|
+
* Id
|
|
9867
|
+
*
|
|
9868
|
+
* Made by the client and stable across saves.
|
|
9869
|
+
*/
|
|
9870
|
+
id: string;
|
|
9871
|
+
/**
|
|
9872
|
+
* Title
|
|
9873
|
+
*/
|
|
9874
|
+
title?: string | null;
|
|
9875
|
+
/**
|
|
9876
|
+
* Layer Id
|
|
9877
|
+
*
|
|
9878
|
+
* A layer of the host's map.
|
|
9879
|
+
*/
|
|
9880
|
+
layer_id: string;
|
|
9881
|
+
/**
|
|
9882
|
+
* Scope
|
|
9883
|
+
*
|
|
9884
|
+
* Summarize the whole layer, or only what the map view shows.
|
|
9885
|
+
*/
|
|
9886
|
+
scope?: 'layer' | 'view';
|
|
9887
|
+
/**
|
|
9888
|
+
* Type
|
|
9889
|
+
*/
|
|
9890
|
+
type: 'pie_chart';
|
|
9891
|
+
/**
|
|
9892
|
+
* V
|
|
9893
|
+
*/
|
|
9894
|
+
v: 1;
|
|
9895
|
+
config: PieChartConfig;
|
|
9896
|
+
};
|
|
9393
9897
|
/**
|
|
9394
9898
|
* PointCloudMetadata
|
|
9395
9899
|
*
|
|
@@ -10159,7 +10663,36 @@ export type RasterTileToken = {
|
|
|
10159
10663
|
/**
|
|
10160
10664
|
* Format
|
|
10161
10665
|
*/
|
|
10162
|
-
format: string;
|
|
10666
|
+
format: string;
|
|
10667
|
+
};
|
|
10668
|
+
/**
|
|
10669
|
+
* ReaderTheme
|
|
10670
|
+
*
|
|
10671
|
+
* An accent colour, a logo and a font family for reader-facing pages.
|
|
10672
|
+
*
|
|
10673
|
+
* The frontend applies these as theme tokens only. A font is named, never
|
|
10674
|
+
* fetched: the operator ships the font file, since the CSP allows no remote
|
|
10675
|
+
* fonts.
|
|
10676
|
+
*/
|
|
10677
|
+
export type ReaderTheme = {
|
|
10678
|
+
/**
|
|
10679
|
+
* Accent
|
|
10680
|
+
*
|
|
10681
|
+
* The accent colour as `#rrggbb`.
|
|
10682
|
+
*/
|
|
10683
|
+
accent?: string | null;
|
|
10684
|
+
/**
|
|
10685
|
+
* Logo Url
|
|
10686
|
+
*
|
|
10687
|
+
* An https URL of the logo shown in the page header.
|
|
10688
|
+
*/
|
|
10689
|
+
logo_url?: string | null;
|
|
10690
|
+
/**
|
|
10691
|
+
* Font Family
|
|
10692
|
+
*
|
|
10693
|
+
* A CSS font family list the page's text uses first.
|
|
10694
|
+
*/
|
|
10695
|
+
font_family?: string | null;
|
|
10163
10696
|
};
|
|
10164
10697
|
/**
|
|
10165
10698
|
* RefreshRequest
|
|
@@ -10624,6 +11157,97 @@ export type ReuploadServicePreviewRequest = {
|
|
|
10624
11157
|
*/
|
|
10625
11158
|
auth?: ServiceAuthRequest | null;
|
|
10626
11159
|
};
|
|
11160
|
+
/**
|
|
11161
|
+
* RowsRequest
|
|
11162
|
+
*/
|
|
11163
|
+
export type RowsRequest = {
|
|
11164
|
+
/**
|
|
11165
|
+
* Filter
|
|
11166
|
+
*
|
|
11167
|
+
* CQL2-JSON filter, as the OGC API Features `filter` accepts.
|
|
11168
|
+
*/
|
|
11169
|
+
filter?: {
|
|
11170
|
+
[key: string]: unknown;
|
|
11171
|
+
} | null;
|
|
11172
|
+
/**
|
|
11173
|
+
* Bbox
|
|
11174
|
+
*
|
|
11175
|
+
* Map view `[west, south, east, north]` in WGS 84; west greater than east crosses the antimeridian. Omit for the whole layer.
|
|
11176
|
+
*/
|
|
11177
|
+
bbox?: [
|
|
11178
|
+
number,
|
|
11179
|
+
number,
|
|
11180
|
+
number,
|
|
11181
|
+
number
|
|
11182
|
+
] | null;
|
|
11183
|
+
/**
|
|
11184
|
+
* Op
|
|
11185
|
+
*/
|
|
11186
|
+
op: 'rows';
|
|
11187
|
+
/**
|
|
11188
|
+
* Columns
|
|
11189
|
+
*/
|
|
11190
|
+
columns: Array<string>;
|
|
11191
|
+
/**
|
|
11192
|
+
* Sort Column
|
|
11193
|
+
*
|
|
11194
|
+
* Order rows by this column with nulls last, then by gid; omit to order by gid.
|
|
11195
|
+
*/
|
|
11196
|
+
sort_column?: string | null;
|
|
11197
|
+
/**
|
|
11198
|
+
* Sort
|
|
11199
|
+
*/
|
|
11200
|
+
sort?: 'asc' | 'desc';
|
|
11201
|
+
/**
|
|
11202
|
+
* Limit
|
|
11203
|
+
*/
|
|
11204
|
+
limit?: number;
|
|
11205
|
+
/**
|
|
11206
|
+
* Cursor
|
|
11207
|
+
*
|
|
11208
|
+
* The previous page's `next_cursor`, under the same sort.
|
|
11209
|
+
*/
|
|
11210
|
+
cursor?: string | null;
|
|
11211
|
+
};
|
|
11212
|
+
/**
|
|
11213
|
+
* RowsResponse
|
|
11214
|
+
*/
|
|
11215
|
+
export type RowsResponse = {
|
|
11216
|
+
/**
|
|
11217
|
+
* Approximate
|
|
11218
|
+
*
|
|
11219
|
+
* Always false: a view too wide to count exactly is refused.
|
|
11220
|
+
*/
|
|
11221
|
+
approximate?: false;
|
|
11222
|
+
/**
|
|
11223
|
+
* Cached
|
|
11224
|
+
*/
|
|
11225
|
+
cached: boolean;
|
|
11226
|
+
/**
|
|
11227
|
+
* Op
|
|
11228
|
+
*/
|
|
11229
|
+
op: 'rows';
|
|
11230
|
+
result: RowsResult;
|
|
11231
|
+
};
|
|
11232
|
+
/**
|
|
11233
|
+
* RowsResult
|
|
11234
|
+
*/
|
|
11235
|
+
export type RowsResult = {
|
|
11236
|
+
/**
|
|
11237
|
+
* Rows
|
|
11238
|
+
*/
|
|
11239
|
+
rows: Array<AggregateRow>;
|
|
11240
|
+
/**
|
|
11241
|
+
* Next Cursor
|
|
11242
|
+
*
|
|
11243
|
+
* Pass as `cursor` for the next page.
|
|
11244
|
+
*/
|
|
11245
|
+
next_cursor: string | null;
|
|
11246
|
+
/**
|
|
11247
|
+
* Has More
|
|
11248
|
+
*/
|
|
11249
|
+
has_more: boolean;
|
|
11250
|
+
};
|
|
10627
11251
|
/**
|
|
10628
11252
|
* SSEActionsEvent
|
|
10629
11253
|
*
|
|
@@ -11498,6 +12122,10 @@ export type SharedMapResponse = {
|
|
|
11498
12122
|
* Layers
|
|
11499
12123
|
*/
|
|
11500
12124
|
layers: Array<SharedLayerResponse>;
|
|
12125
|
+
/**
|
|
12126
|
+
* The theme a branding extension sets for the viewer and its dashboard; null without one.
|
|
12127
|
+
*/
|
|
12128
|
+
reader_theme?: ReaderTheme | null;
|
|
11501
12129
|
};
|
|
11502
12130
|
/**
|
|
11503
12131
|
* SourceHealthResponse
|
|
@@ -12830,7 +13458,7 @@ export type StoryChapter = {
|
|
|
12830
13458
|
/**
|
|
12831
13459
|
* Blocks
|
|
12832
13460
|
*/
|
|
12833
|
-
blocks?: Array<MarkdownWidget | ImageWidget | ButtonWidget | SeparatorWidget>;
|
|
13461
|
+
blocks?: Array<MarkdownWidget | ImageWidget | GalleryWidget | CarouselWidget | ButtonWidget | SeparatorWidget | EmbedWidget | VideoWidget>;
|
|
12834
13462
|
};
|
|
12835
13463
|
/**
|
|
12836
13464
|
* StoryChapterInput
|
|
@@ -12856,7 +13484,7 @@ export type StoryChapterInput = {
|
|
|
12856
13484
|
/**
|
|
12857
13485
|
* Blocks
|
|
12858
13486
|
*/
|
|
12859
|
-
blocks?: Array<MarkdownWidget | ImageWidget | ButtonWidget | SeparatorWidget>;
|
|
13487
|
+
blocks?: Array<MarkdownWidget | ImageWidget | GalleryWidget | CarouselWidget | ButtonWidget | SeparatorWidget | EmbedWidget | VideoWidget>;
|
|
12860
13488
|
};
|
|
12861
13489
|
/**
|
|
12862
13490
|
* StoryCreate
|
|
@@ -12883,6 +13511,7 @@ export type StoryDocument = {
|
|
|
12883
13511
|
* Chapters
|
|
12884
13512
|
*/
|
|
12885
13513
|
chapters: Array<StoryChapter>;
|
|
13514
|
+
settings?: StorySettings | null;
|
|
12886
13515
|
};
|
|
12887
13516
|
/**
|
|
12888
13517
|
* StoryDocumentInput
|
|
@@ -12896,6 +13525,10 @@ export type StoryDocumentInput = {
|
|
|
12896
13525
|
* Chapters
|
|
12897
13526
|
*/
|
|
12898
13527
|
chapters?: Array<StoryChapterInput>;
|
|
13528
|
+
/**
|
|
13529
|
+
* Reader settings; absent means every default.
|
|
13530
|
+
*/
|
|
13531
|
+
settings?: StorySettings | null;
|
|
12899
13532
|
};
|
|
12900
13533
|
/**
|
|
12901
13534
|
* StoryDraftResponse
|
|
@@ -12966,6 +13599,25 @@ export type StoryDraftUpdate = {
|
|
|
12966
13599
|
revision: number;
|
|
12967
13600
|
document: StoryDocumentInput;
|
|
12968
13601
|
};
|
|
13602
|
+
/**
|
|
13603
|
+
* StoryFrameHost
|
|
13604
|
+
*
|
|
13605
|
+
* One approved host.
|
|
13606
|
+
*/
|
|
13607
|
+
export type StoryFrameHost = {
|
|
13608
|
+
/**
|
|
13609
|
+
* Host
|
|
13610
|
+
*
|
|
13611
|
+
* An exact host name, such as media.example.org.
|
|
13612
|
+
*/
|
|
13613
|
+
host: string;
|
|
13614
|
+
/**
|
|
13615
|
+
* Allow Same Origin
|
|
13616
|
+
*
|
|
13617
|
+
* Let this host's frames keep their origin, which some video players need. The frame keeps it wherever the page sends it, so any other approved host it opens gets the same.
|
|
13618
|
+
*/
|
|
13619
|
+
allow_same_origin?: boolean;
|
|
13620
|
+
};
|
|
12969
13621
|
/**
|
|
12970
13622
|
* StoryGroupsResponse
|
|
12971
13623
|
*/
|
|
@@ -13083,6 +13735,10 @@ export type StoryResponse = {
|
|
|
13083
13735
|
* The published document; null until the story is published.
|
|
13084
13736
|
*/
|
|
13085
13737
|
document: StoryDocument | null;
|
|
13738
|
+
/**
|
|
13739
|
+
* The theme a branding extension sets for the story's reader; null without one.
|
|
13740
|
+
*/
|
|
13741
|
+
reader_theme?: ReaderTheme | null;
|
|
13086
13742
|
};
|
|
13087
13743
|
/**
|
|
13088
13744
|
* StoryRevision
|
|
@@ -13112,6 +13768,47 @@ export type StoryScene = {
|
|
|
13112
13768
|
layer_visibility?: {
|
|
13113
13769
|
[key: string]: boolean;
|
|
13114
13770
|
};
|
|
13771
|
+
/**
|
|
13772
|
+
* Transition
|
|
13773
|
+
*
|
|
13774
|
+
* How the map moves into this scene; absent uses the story setting.
|
|
13775
|
+
*/
|
|
13776
|
+
transition?: 'fly' | 'glide' | 'cut' | null;
|
|
13777
|
+
};
|
|
13778
|
+
/**
|
|
13779
|
+
* StorySettings
|
|
13780
|
+
*/
|
|
13781
|
+
export type StorySettings = {
|
|
13782
|
+
/**
|
|
13783
|
+
* Navigation
|
|
13784
|
+
*
|
|
13785
|
+
* Show the chapter navigation bar.
|
|
13786
|
+
*/
|
|
13787
|
+
navigation?: boolean;
|
|
13788
|
+
/**
|
|
13789
|
+
* Layout
|
|
13790
|
+
*
|
|
13791
|
+
* Chapter panel beside the map or floating over it.
|
|
13792
|
+
*/
|
|
13793
|
+
layout?: 'side' | 'floating';
|
|
13794
|
+
/**
|
|
13795
|
+
* Panel Position
|
|
13796
|
+
*
|
|
13797
|
+
* Where a floating panel sits.
|
|
13798
|
+
*/
|
|
13799
|
+
panel_position?: 'left' | 'right' | 'center';
|
|
13800
|
+
/**
|
|
13801
|
+
* Theme
|
|
13802
|
+
*
|
|
13803
|
+
* Reader page theme; follow uses the reader's.
|
|
13804
|
+
*/
|
|
13805
|
+
theme?: 'follow' | 'light' | 'dark';
|
|
13806
|
+
/**
|
|
13807
|
+
* Transition
|
|
13808
|
+
*
|
|
13809
|
+
* How the map moves into a chapter whose scene sets no transition.
|
|
13810
|
+
*/
|
|
13811
|
+
transition?: 'fly' | 'glide' | 'cut';
|
|
13115
13812
|
};
|
|
13116
13813
|
/**
|
|
13117
13814
|
* StorySummary
|
|
@@ -13158,6 +13855,12 @@ export type StorySummary = {
|
|
|
13158
13855
|
* Can Edit
|
|
13159
13856
|
*/
|
|
13160
13857
|
can_edit: boolean;
|
|
13858
|
+
/**
|
|
13859
|
+
* Chapter Count
|
|
13860
|
+
*
|
|
13861
|
+
* Chapters in the published document; 0 until published.
|
|
13862
|
+
*/
|
|
13863
|
+
chapter_count: number;
|
|
13161
13864
|
};
|
|
13162
13865
|
/**
|
|
13163
13866
|
* StoryUpdate
|
|
@@ -13263,6 +13966,33 @@ export type SummaryDraftResponse = {
|
|
|
13263
13966
|
*/
|
|
13264
13967
|
draft: string;
|
|
13265
13968
|
};
|
|
13969
|
+
/**
|
|
13970
|
+
* TableConfig
|
|
13971
|
+
*/
|
|
13972
|
+
export type TableConfig = {
|
|
13973
|
+
/**
|
|
13974
|
+
* Group Column
|
|
13975
|
+
*/
|
|
13976
|
+
group_column: string;
|
|
13977
|
+
/**
|
|
13978
|
+
* Stats
|
|
13979
|
+
*/
|
|
13980
|
+
stats: Array<TableStat>;
|
|
13981
|
+
/**
|
|
13982
|
+
* Sort By
|
|
13983
|
+
*
|
|
13984
|
+
* The index in `stats` of the statistic to sort by; leave it out to sort by the group value.
|
|
13985
|
+
*/
|
|
13986
|
+
sort_by?: number | null;
|
|
13987
|
+
/**
|
|
13988
|
+
* Sort
|
|
13989
|
+
*/
|
|
13990
|
+
sort?: 'asc' | 'desc';
|
|
13991
|
+
/**
|
|
13992
|
+
* Limit
|
|
13993
|
+
*/
|
|
13994
|
+
limit?: number;
|
|
13995
|
+
};
|
|
13266
13996
|
/**
|
|
13267
13997
|
* TableRegisterResponse
|
|
13268
13998
|
*/
|
|
@@ -13286,6 +14016,55 @@ export type TableRegisterResponse = {
|
|
|
13286
14016
|
*/
|
|
13287
14017
|
table_name: string;
|
|
13288
14018
|
};
|
|
14019
|
+
/**
|
|
14020
|
+
* TableStat
|
|
14021
|
+
*/
|
|
14022
|
+
export type TableStat = {
|
|
14023
|
+
/**
|
|
14024
|
+
* Stat
|
|
14025
|
+
*/
|
|
14026
|
+
stat: 'count' | 'sum' | 'mean' | 'min' | 'max';
|
|
14027
|
+
/**
|
|
14028
|
+
* Column
|
|
14029
|
+
*/
|
|
14030
|
+
column?: string | null;
|
|
14031
|
+
};
|
|
14032
|
+
/**
|
|
14033
|
+
* TableWidget
|
|
14034
|
+
*/
|
|
14035
|
+
export type TableWidget = {
|
|
14036
|
+
/**
|
|
14037
|
+
* Id
|
|
14038
|
+
*
|
|
14039
|
+
* Made by the client and stable across saves.
|
|
14040
|
+
*/
|
|
14041
|
+
id: string;
|
|
14042
|
+
/**
|
|
14043
|
+
* Title
|
|
14044
|
+
*/
|
|
14045
|
+
title?: string | null;
|
|
14046
|
+
/**
|
|
14047
|
+
* Layer Id
|
|
14048
|
+
*
|
|
14049
|
+
* A layer of the host's map.
|
|
14050
|
+
*/
|
|
14051
|
+
layer_id: string;
|
|
14052
|
+
/**
|
|
14053
|
+
* Scope
|
|
14054
|
+
*
|
|
14055
|
+
* Summarize the whole layer, or only what the map view shows.
|
|
14056
|
+
*/
|
|
14057
|
+
scope?: 'layer' | 'view';
|
|
14058
|
+
/**
|
|
14059
|
+
* Type
|
|
14060
|
+
*/
|
|
14061
|
+
type: 'table';
|
|
14062
|
+
/**
|
|
14063
|
+
* V
|
|
14064
|
+
*/
|
|
14065
|
+
v: 1;
|
|
14066
|
+
config: TableConfig;
|
|
14067
|
+
};
|
|
13289
14068
|
/**
|
|
13290
14069
|
* TerrainConfig
|
|
13291
14070
|
*/
|
|
@@ -14011,6 +14790,30 @@ export type VerifyEmailRequest = {
|
|
|
14011
14790
|
*/
|
|
14012
14791
|
token: string;
|
|
14013
14792
|
};
|
|
14793
|
+
/**
|
|
14794
|
+
* VideoWidget
|
|
14795
|
+
*/
|
|
14796
|
+
export type VideoWidget = {
|
|
14797
|
+
/**
|
|
14798
|
+
* Id
|
|
14799
|
+
*
|
|
14800
|
+
* Made by the client and stable across saves.
|
|
14801
|
+
*/
|
|
14802
|
+
id: string;
|
|
14803
|
+
/**
|
|
14804
|
+
* Title
|
|
14805
|
+
*/
|
|
14806
|
+
title?: string | null;
|
|
14807
|
+
/**
|
|
14808
|
+
* Type
|
|
14809
|
+
*/
|
|
14810
|
+
type: 'video';
|
|
14811
|
+
/**
|
|
14812
|
+
* V
|
|
14813
|
+
*/
|
|
14814
|
+
v: 1;
|
|
14815
|
+
config: FrameConfig;
|
|
14816
|
+
};
|
|
14014
14817
|
/**
|
|
14015
14818
|
* VisibilityCheckResponse
|
|
14016
14819
|
*/
|
|
@@ -20288,7 +21091,9 @@ export type AggregateEndpointDatasetsDatasetIdAggregatePostData = {
|
|
|
20288
21091
|
op: 'histogram';
|
|
20289
21092
|
} & HistogramRequest) | ({
|
|
20290
21093
|
op: 'group_by';
|
|
20291
|
-
} & GroupByRequest)
|
|
21094
|
+
} & GroupByRequest) | ({
|
|
21095
|
+
op: 'rows';
|
|
21096
|
+
} & RowsRequest);
|
|
20292
21097
|
headers?: {
|
|
20293
21098
|
/**
|
|
20294
21099
|
* X-Embed-Token
|
|
@@ -20357,7 +21162,9 @@ export type AggregateEndpointDatasetsDatasetIdAggregatePostResponses = {
|
|
|
20357
21162
|
op: 'histogram';
|
|
20358
21163
|
} & HistogramResponse) | ({
|
|
20359
21164
|
op: 'group_by';
|
|
20360
|
-
} & GroupByResponse)
|
|
21165
|
+
} & GroupByResponse) | ({
|
|
21166
|
+
op: 'rows';
|
|
21167
|
+
} & RowsResponse);
|
|
20361
21168
|
};
|
|
20362
21169
|
export type AggregateEndpointDatasetsDatasetIdAggregatePostResponse = AggregateEndpointDatasetsDatasetIdAggregatePostResponses[keyof AggregateEndpointDatasetsDatasetIdAggregatePostResponses];
|
|
20363
21170
|
export type AnalysisMaterializeEndpointDatasetsDatasetIdAnalysisMaterializePostData = {
|
|
@@ -23949,7 +24756,7 @@ export type GetDatasetRowsEndpointDatasetsDatasetIdRowsGetData = {
|
|
|
23949
24756
|
/**
|
|
23950
24757
|
* X-Embed-Token
|
|
23951
24758
|
*
|
|
23952
|
-
* Optional embed token.
|
|
24759
|
+
* Optional embed token. This route answers it for datasets in the token's scope while the token's map has `show_attribute_table` on. A caller who can read the dataset is served by their own permissions whatever the token covers.
|
|
23953
24760
|
*/
|
|
23954
24761
|
'X-Embed-Token'?: string | null;
|
|
23955
24762
|
};
|
|
@@ -31540,13 +32347,13 @@ export type SearchGetStacSearchGetData = {
|
|
|
31540
32347
|
/**
|
|
31541
32348
|
* Collections
|
|
31542
32349
|
*
|
|
31543
|
-
* Comma-separated collection IDs
|
|
32350
|
+
* Comma-separated collection IDs, at most 1000; more answer 400.
|
|
31544
32351
|
*/
|
|
31545
32352
|
collections?: string | null;
|
|
31546
32353
|
/**
|
|
31547
32354
|
* Ids
|
|
31548
32355
|
*
|
|
31549
|
-
* Comma-separated item IDs
|
|
32356
|
+
* Comma-separated item IDs, at most 1000; more answer 400.
|
|
31550
32357
|
*/
|
|
31551
32358
|
ids?: string | null;
|
|
31552
32359
|
/**
|
|
@@ -31660,6 +32467,18 @@ export type ListStoriesEndpointStoriesGetData = {
|
|
|
31660
32467
|
* Owned Only
|
|
31661
32468
|
*/
|
|
31662
32469
|
owned_only?: boolean;
|
|
32470
|
+
/**
|
|
32471
|
+
* Search
|
|
32472
|
+
*
|
|
32473
|
+
* Case-insensitive match on title and summary.
|
|
32474
|
+
*/
|
|
32475
|
+
search?: string | null;
|
|
32476
|
+
/**
|
|
32477
|
+
* Published Only
|
|
32478
|
+
*
|
|
32479
|
+
* Leave out stories that were never published.
|
|
32480
|
+
*/
|
|
32481
|
+
published_only?: boolean;
|
|
31663
32482
|
};
|
|
31664
32483
|
url: '/stories/';
|
|
31665
32484
|
};
|
|
@@ -31761,6 +32580,60 @@ export type CreateStoryEndpointStoriesPostResponses = {
|
|
|
31761
32580
|
201: StoryDraftResponse;
|
|
31762
32581
|
};
|
|
31763
32582
|
export type CreateStoryEndpointStoriesPostResponse = CreateStoryEndpointStoriesPostResponses[keyof CreateStoryEndpointStoriesPostResponses];
|
|
32583
|
+
export type StoryFrameHostsEndpointStoriesFrameHostsGetData = {
|
|
32584
|
+
body?: never;
|
|
32585
|
+
path?: never;
|
|
32586
|
+
query?: never;
|
|
32587
|
+
url: '/stories/frame-hosts/';
|
|
32588
|
+
};
|
|
32589
|
+
export type StoryFrameHostsEndpointStoriesFrameHostsGetErrors = {
|
|
32590
|
+
/**
|
|
32591
|
+
* Bad request — invalid payload
|
|
32592
|
+
*/
|
|
32593
|
+
400: ProblemDetail;
|
|
32594
|
+
/**
|
|
32595
|
+
* Unauthorized — missing or invalid credentials
|
|
32596
|
+
*/
|
|
32597
|
+
401: ProblemDetail;
|
|
32598
|
+
/**
|
|
32599
|
+
* Forbidden — caller lacks write access
|
|
32600
|
+
*/
|
|
32601
|
+
403: ProblemDetail;
|
|
32602
|
+
/**
|
|
32603
|
+
* Not found
|
|
32604
|
+
*/
|
|
32605
|
+
404: ProblemDetail;
|
|
32606
|
+
/**
|
|
32607
|
+
* Conflict — resource state prevents the operation
|
|
32608
|
+
*/
|
|
32609
|
+
409: ProblemDetail;
|
|
32610
|
+
/**
|
|
32611
|
+
* Validation error
|
|
32612
|
+
*/
|
|
32613
|
+
422: ProblemDetail;
|
|
32614
|
+
/**
|
|
32615
|
+
* Too many requests — retry after the advertised interval
|
|
32616
|
+
*/
|
|
32617
|
+
429: ProblemDetail;
|
|
32618
|
+
/**
|
|
32619
|
+
* Internal server error
|
|
32620
|
+
*/
|
|
32621
|
+
500: ProblemDetail;
|
|
32622
|
+
/**
|
|
32623
|
+
* Service unavailable — the database could not serve the request
|
|
32624
|
+
*/
|
|
32625
|
+
503: ProblemDetail;
|
|
32626
|
+
};
|
|
32627
|
+
export type StoryFrameHostsEndpointStoriesFrameHostsGetError = StoryFrameHostsEndpointStoriesFrameHostsGetErrors[keyof StoryFrameHostsEndpointStoriesFrameHostsGetErrors];
|
|
32628
|
+
export type StoryFrameHostsEndpointStoriesFrameHostsGetResponses = {
|
|
32629
|
+
/**
|
|
32630
|
+
* Response Story Frame Hosts Endpoint Stories Frame Hosts Get
|
|
32631
|
+
*
|
|
32632
|
+
* Successful Response
|
|
32633
|
+
*/
|
|
32634
|
+
200: Array<StoryFrameHost>;
|
|
32635
|
+
};
|
|
32636
|
+
export type StoryFrameHostsEndpointStoriesFrameHostsGetResponse = StoryFrameHostsEndpointStoriesFrameHostsGetResponses[keyof StoryFrameHostsEndpointStoriesFrameHostsGetResponses];
|
|
31764
32637
|
export type DeleteStoryEndpointStoriesStoryIdDeleteData = {
|
|
31765
32638
|
body?: never;
|
|
31766
32639
|
path: {
|
|
@@ -32454,6 +33327,12 @@ export type ClusterTileEndpointTilesClustersTablePathZxyPbfGetData = {
|
|
|
32454
33327
|
* Cols
|
|
32455
33328
|
*/
|
|
32456
33329
|
cols?: string | null;
|
|
33330
|
+
/**
|
|
33331
|
+
* Cols Only
|
|
33332
|
+
*
|
|
33333
|
+
* Carry only the columns named by `cols`, at every zoom.
|
|
33334
|
+
*/
|
|
33335
|
+
cols_only?: boolean;
|
|
32457
33336
|
/**
|
|
32458
33337
|
* Cluster Radius
|
|
32459
33338
|
*/
|
|
@@ -32737,6 +33616,12 @@ export type TileEndpointTilesTablePathZxyPbfGetData = {
|
|
|
32737
33616
|
* Cols
|
|
32738
33617
|
*/
|
|
32739
33618
|
cols?: string | null;
|
|
33619
|
+
/**
|
|
33620
|
+
* Cols Only
|
|
33621
|
+
*
|
|
33622
|
+
* Carry only the columns named by `cols`, at every zoom.
|
|
33623
|
+
*/
|
|
33624
|
+
cols_only?: boolean;
|
|
32740
33625
|
};
|
|
32741
33626
|
url: '/tiles/{table_path}/{z}/{x}/{y}.pbf';
|
|
32742
33627
|
};
|