@geolens/sdk 1.28.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1949,6 +1949,51 @@ export type BulkRevokeResponse = {
1949
1949
  */
1950
1950
  revoked_count: number;
1951
1951
  };
1952
+ /**
1953
+ * ButtonConfig
1954
+ */
1955
+ export type ButtonConfig = {
1956
+ /**
1957
+ * Label
1958
+ */
1959
+ label: string;
1960
+ /**
1961
+ * Url
1962
+ *
1963
+ * An http or https address; any other scheme is refused.
1964
+ */
1965
+ url: string;
1966
+ /**
1967
+ * New Tab
1968
+ *
1969
+ * Open the link in a new tab.
1970
+ */
1971
+ new_tab?: boolean;
1972
+ };
1973
+ /**
1974
+ * ButtonWidget
1975
+ */
1976
+ export type ButtonWidget = {
1977
+ /**
1978
+ * Id
1979
+ *
1980
+ * Made by the client and stable across saves.
1981
+ */
1982
+ id: string;
1983
+ /**
1984
+ * Title
1985
+ */
1986
+ title?: string | null;
1987
+ /**
1988
+ * Type
1989
+ */
1990
+ type: 'button';
1991
+ /**
1992
+ * V
1993
+ */
1994
+ v: 1;
1995
+ config: ButtonConfig;
1996
+ };
1952
1997
  /**
1953
1998
  * CapabilitiesAuth
1954
1999
  */
@@ -2178,6 +2223,55 @@ export type CatalogStatsResponse = {
2178
2223
  */
2179
2224
  total_users?: number;
2180
2225
  };
2226
+ /**
2227
+ * CategorySelectorConfig
2228
+ */
2229
+ export type CategorySelectorConfig = {
2230
+ /**
2231
+ * Column
2232
+ */
2233
+ column: string;
2234
+ /**
2235
+ * Multiple
2236
+ */
2237
+ multiple?: boolean;
2238
+ };
2239
+ /**
2240
+ * CategorySelectorWidget
2241
+ */
2242
+ export type CategorySelectorWidget = {
2243
+ /**
2244
+ * Id
2245
+ *
2246
+ * Made by the client and stable across saves.
2247
+ */
2248
+ id: string;
2249
+ /**
2250
+ * Title
2251
+ */
2252
+ title?: string | null;
2253
+ /**
2254
+ * Layer Id
2255
+ *
2256
+ * A layer of the host's map.
2257
+ */
2258
+ layer_id: string;
2259
+ /**
2260
+ * Scope
2261
+ *
2262
+ * Summarize the whole layer, or only what the map view shows.
2263
+ */
2264
+ scope?: 'layer' | 'view';
2265
+ /**
2266
+ * Type
2267
+ */
2268
+ type: 'category_selector';
2269
+ /**
2270
+ * V
2271
+ */
2272
+ v: 1;
2273
+ config: CategorySelectorConfig;
2274
+ };
2181
2275
  /**
2182
2276
  * ChangePasswordRequest
2183
2277
  */
@@ -3480,12 +3574,18 @@ export type DashboardConfig = {
3480
3574
  * Version
3481
3575
  */
3482
3576
  version: number;
3577
+ /**
3578
+ * Panel
3579
+ *
3580
+ * Where the panel sits beside the map: `right` or `bottom`. On narrow screens it is always below the map.
3581
+ */
3582
+ panel?: 'right' | 'bottom';
3483
3583
  /**
3484
3584
  * Widgets
3485
3585
  *
3486
3586
  * The widgets on layers this response shows, in panel order.
3487
3587
  */
3488
- widgets: Array<IndicatorWidget | BarChartWidget>;
3588
+ widgets: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | HistogramWidget | CategorySelectorWidget>;
3489
3589
  };
3490
3590
  /**
3491
3591
  * DashboardConfigInput
@@ -3495,12 +3595,18 @@ export type DashboardConfigInput = {
3495
3595
  * Version
3496
3596
  */
3497
3597
  version?: 1;
3598
+ /**
3599
+ * Panel
3600
+ *
3601
+ * 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
+ */
3603
+ panel?: 'right' | 'bottom' | null;
3498
3604
  /**
3499
3605
  * Widgets
3500
3606
  *
3501
- * Widgets in panel order. Each names a layer of this map that you can read. Stored widgets you can't see are kept in place.
3607
+ * 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.
3502
3608
  */
3503
- widgets?: Array<IndicatorWidget | BarChartWidget>;
3609
+ widgets?: Array<MarkdownWidget | IndicatorWidget | BarChartWidget | HistogramWidget | CategorySelectorWidget>;
3504
3610
  };
3505
3611
  /**
3506
3612
  * DatasetApiKeyCreateRequest
@@ -3801,7 +3907,7 @@ export type DatasetMeta = {
3801
3907
  /**
3802
3908
  * Tile Columns
3803
3909
  *
3804
- * Ordered vector-tile property allowlist; null restores zoom defaults, [] emits geometry-only tiles, list emits those properties at any zoom.
3910
+ * Ordered vector-tile property allowlist; null restores zoom defaults, [] emits geometry-only tiles, list emits those properties at any zoom. Reads authorized only by an embed token are limited to these columns too.
3805
3911
  */
3806
3912
  tile_columns?: Array<string> | null;
3807
3913
  /**
@@ -4568,6 +4674,12 @@ export type DatasetRowsResponse = {
4568
4674
  * Columns the rows endpoint accepts as `sort`.
4569
4675
  */
4570
4676
  sortable_columns?: Array<string>;
4677
+ /**
4678
+ * Bboxes
4679
+ *
4680
+ * With `with_bbox=true`, one entry per row in `rows` order: the row's [minx, miny, maxx, maxy] in EPSG:4326, or null for a row without geometry. Null otherwise.
4681
+ */
4682
+ bboxes?: Array<Array<number> | null> | null;
4571
4683
  /**
4572
4684
  * Table Id
4573
4685
  *
@@ -5021,6 +5133,12 @@ export type DuplicateMapResponse = {
5021
5133
  * Show Basemap Labels
5022
5134
  */
5023
5135
  show_basemap_labels: boolean;
5136
+ /**
5137
+ * Show Attribute Table
5138
+ *
5139
+ * Whether viewers offer each layer's attribute table. Embed tokens for the map may read a layer's rows only while it is on; the columns they may read come from each dataset's tile column allowlist.
5140
+ */
5141
+ show_attribute_table?: boolean;
5024
5142
  basemap_config?: BasemapConfig | null;
5025
5143
  terrain_config?: TerrainConfig | null;
5026
5144
  dashboard_config?: DashboardConfig | null;
@@ -5945,6 +6063,19 @@ export type HistogramBin = {
5945
6063
  */
5946
6064
  count: number;
5947
6065
  };
6066
+ /**
6067
+ * HistogramConfig
6068
+ */
6069
+ export type HistogramConfig = {
6070
+ /**
6071
+ * Column
6072
+ */
6073
+ column: string;
6074
+ /**
6075
+ * Bins
6076
+ */
6077
+ bins?: number;
6078
+ };
5948
6079
  /**
5949
6080
  * HistogramRequest
5950
6081
  */
@@ -6008,9 +6139,51 @@ export type HistogramResult = {
6008
6139
  /**
6009
6140
  * Bins
6010
6141
  *
6011
- * Equal-width bins over the finite values; empty with none.
6142
+ * Equal-width bins over the finite values, empty with none. Unless whole_numbers is true, a bin holds its lower edge but not its upper one, and the last bin holds both.
6012
6143
  */
6013
6144
  bins: Array<HistogramBin>;
6145
+ /**
6146
+ * Whole Numbers
6147
+ *
6148
+ * Whether each bin holds the whole numbers from its lower edge to one below its upper edge. Only an integer column has whole-number bins, and only while every edge is a safe JavaScript integer; they may then number fewer than requested, and the last may be narrower.
6149
+ */
6150
+ whole_numbers?: boolean;
6151
+ };
6152
+ /**
6153
+ * HistogramWidget
6154
+ */
6155
+ export type HistogramWidget = {
6156
+ /**
6157
+ * Id
6158
+ *
6159
+ * Made by the client and stable across saves.
6160
+ */
6161
+ id: string;
6162
+ /**
6163
+ * Title
6164
+ */
6165
+ title?: string | null;
6166
+ /**
6167
+ * Layer Id
6168
+ *
6169
+ * A layer of the host's map.
6170
+ */
6171
+ layer_id: string;
6172
+ /**
6173
+ * Scope
6174
+ *
6175
+ * Summarize the whole layer, or only what the map view shows.
6176
+ */
6177
+ scope?: 'layer' | 'view';
6178
+ /**
6179
+ * Type
6180
+ */
6181
+ type: 'histogram';
6182
+ /**
6183
+ * V
6184
+ */
6185
+ v: 1;
6186
+ config: HistogramConfig;
6014
6187
  };
6015
6188
  /**
6016
6189
  * ImageConfig
@@ -6019,9 +6192,15 @@ export type ImageConfig = {
6019
6192
  /**
6020
6193
  * Alt
6021
6194
  *
6022
- * Empty for decorative.
6195
+ * Text that stands in for the image; required unless it is decorative.
6023
6196
  */
6024
- alt?: string;
6197
+ alt?: string | null;
6198
+ /**
6199
+ * Decorative
6200
+ *
6201
+ * True when the image adds nothing a reader needs: readers get an empty alt, and `alt` may be left out.
6202
+ */
6203
+ decorative?: boolean | null;
6025
6204
  /**
6026
6205
  * Caption
6027
6206
  */
@@ -6898,7 +7077,7 @@ export type ManifestSource = {
6898
7077
  /**
6899
7078
  * Type
6900
7079
  *
6901
- * Source modality. Vector sources require zip, gpkg, geojson, json, csv, xlsx, xls, fgb, kml, or kmz; raster_cog sources require tif or tiff.
7080
+ * Source modality. Vector sources require zip, gpkg, geojson, json, csv, xlsx, xls, fgb, kml, kmz, or parquet; raster_cog sources require tif or tiff.
6902
7081
  */
6903
7082
  type: 'vector' | 'raster_cog';
6904
7083
  /**
@@ -7300,7 +7479,7 @@ export type MapLayerInput = {
7300
7479
  /**
7301
7480
  * Layout
7302
7481
  *
7303
- * MapLibre layout properties override
7482
+ * MapLibre layout properties override. `_minzoom` and `_maxzoom` set the zoom range where the layer is visible; the exported style writes them as `minzoom` and `maxzoom`.
7304
7483
  */
7305
7484
  layout?: {
7306
7485
  [key: string]: unknown;
@@ -7332,7 +7511,7 @@ export type MapLayerInput = {
7332
7511
  /**
7333
7512
  * Style Config
7334
7513
  *
7335
- * Data-driven and builder UI style configuration. Accepted top-level keys: breaks, builder, categories, classCount, colorLabel, colors, column, heatmapPaint, legendLabel, method, mode, ramp, render_mode, reversed, savedCirclePaint, sizeLabel, sizeRange, sizes, symbol, target; other top-level keys are dropped when the map is exported as a MapLibre style. Builder-only state lives under builder, whose interpreted keys are arrow_color, arrow_size, arrow_spacing, cluster_color, cluster_color_ramp, cluster_max_zoom, cluster_radius, cluster_show_counts, cluster_text_color, cluster_text_size, colormap, extrusion_min_zoom, extrusion_opacity, fill_color_saved, fill_disabled, fill_opacity_saved, folder_group_expanded, folder_group_id, folder_group_name, heatmap_ramp, heatmap_reversed, heatmap_weight_column, height_column, height_scale, hypso_enabled, hypso_ramp, hypso_reversed, lineGradient, outline_color, outline_width, outline_width_saved, pmax, pmin, sigma, stretch, stroke_disabled, symbol. Other builder keys are stored and exported unchanged but have no effect. See https://docs.getgeolens.com/guides/api/publishing-from-desktop-gis/
7514
+ * Data-driven and builder UI style configuration. Accepted top-level keys: breaks, builder, categories, classCount, colorLabel, colors, column, heatmapPaint, legendLabel, method, mode, ramp, render_mode, reversed, savedCirclePaint, sizeLabel, sizeRange, sizes, symbol, target; other top-level keys are dropped when the map is exported as a MapLibre style. Builder-only state lives under builder, whose interpreted keys are arrow_color, arrow_size, arrow_spacing, cluster_color, cluster_color_ramp, cluster_max_zoom, cluster_radius, cluster_show_counts, cluster_text_color, cluster_text_size, colormap, extrusion_min_zoom, extrusion_opacity, fill_color_saved, fill_disabled, fill_opacity_saved, folder_group_expanded, folder_group_id, folder_group_name, heatmap_ramp, heatmap_reversed, heatmap_weight_column, height_column, height_scale, hypso_enabled, hypso_ramp, hypso_reversed, lineGradient, outline_color, outline_width, outline_width_saved, pmax, pmin, sigma, stretch, stroke_disabled, symbol. Other builder keys are stored and exported unchanged but have no effect. legendLabel replaces the layer's name in the legend and layer list; colorLabel and sizeLabel replace the column name in the title of the color and size legend sections. See https://docs.getgeolens.com/guides/api/publishing-from-desktop-gis/
7336
7515
  */
7337
7516
  style_config?: {
7338
7517
  [key: string]: unknown;
@@ -7381,7 +7560,7 @@ export type MapLayerPatch = {
7381
7560
  /**
7382
7561
  * Layout
7383
7562
  *
7384
- * MapLibre layout properties override
7563
+ * MapLibre layout properties override. `_minzoom` and `_maxzoom` set the zoom range where the layer is visible.
7385
7564
  */
7386
7565
  layout?: {
7387
7566
  [key: string]: unknown;
@@ -7450,6 +7629,8 @@ export type MapLayerResponse = {
7450
7629
  dataset_extent_bbox: Array<number> | null;
7451
7630
  /**
7452
7631
  * Dataset Column Info
7632
+ *
7633
+ * The dataset's columns, each with its name and type. In a map response each also carries its current attribute title, semantic role and value labels when set.
7453
7634
  */
7454
7635
  dataset_column_info?: Array<{
7455
7636
  [key: string]: unknown;
@@ -7644,6 +7825,12 @@ export type MapResponse = {
7644
7825
  * Show Basemap Labels
7645
7826
  */
7646
7827
  show_basemap_labels: boolean;
7828
+ /**
7829
+ * Show Attribute Table
7830
+ *
7831
+ * Whether viewers offer each layer's attribute table. Embed tokens for the map may read a layer's rows only while it is on; the columns they may read come from each dataset's tile column allowlist.
7832
+ */
7833
+ show_attribute_table?: boolean;
7647
7834
  basemap_config?: BasemapConfig | null;
7648
7835
  terrain_config?: TerrainConfig | null;
7649
7836
  dashboard_config?: DashboardConfig | null;
@@ -7720,6 +7907,36 @@ export type MapSpriteEntry = {
7720
7907
  */
7721
7908
  url: string;
7722
7909
  };
7910
+ /**
7911
+ * MapStoriesResponse
7912
+ */
7913
+ export type MapStoriesResponse = {
7914
+ /**
7915
+ * Stories
7916
+ *
7917
+ * Stories using the map that you can read, by title.
7918
+ */
7919
+ stories: Array<MapStoryReference>;
7920
+ /**
7921
+ * Hidden Count
7922
+ *
7923
+ * Stories using the map that you can't read; not named.
7924
+ */
7925
+ hidden_count: number;
7926
+ };
7927
+ /**
7928
+ * MapStoryReference
7929
+ */
7930
+ export type MapStoryReference = {
7931
+ /**
7932
+ * Id
7933
+ */
7934
+ id: string;
7935
+ /**
7936
+ * Title
7937
+ */
7938
+ title: string;
7939
+ };
7723
7940
  /**
7724
7941
  * MapStyleImportRequest
7725
7942
  *
@@ -7898,6 +8115,12 @@ export type MapSummaryResponse = {
7898
8115
  * Layer Count
7899
8116
  */
7900
8117
  layer_count: number;
8118
+ /**
8119
+ * Has Dashboard
8120
+ *
8121
+ * True when the map shows you at least one dashboard widget.
8122
+ */
8123
+ has_dashboard?: boolean;
7901
8124
  /**
7902
8125
  * Created By Username
7903
8126
  */
@@ -7971,6 +8194,12 @@ export type MapUpdate = {
7971
8194
  * Show Basemap Labels
7972
8195
  */
7973
8196
  show_basemap_labels?: boolean | null;
8197
+ /**
8198
+ * Show Attribute Table
8199
+ *
8200
+ * Whether viewers offer each layer's attribute table. Embed tokens for the map may read a layer's rows only while it is on; the columns they may read come from each dataset's tile column allowlist.
8201
+ */
8202
+ show_attribute_table?: boolean | null;
7974
8203
  /**
7975
8204
  * Curated map-level basemap appearance preferences
7976
8205
  */
@@ -10684,6 +10913,41 @@ export type SchemaDiff = {
10684
10913
  */
10685
10914
  row_count_delta: number | null;
10686
10915
  };
10916
+ /**
10917
+ * SeparatorConfig
10918
+ */
10919
+ export type SeparatorConfig = {
10920
+ /**
10921
+ * Style
10922
+ *
10923
+ * A thin line, or a larger empty gap.
10924
+ */
10925
+ style?: 'line' | 'gap';
10926
+ };
10927
+ /**
10928
+ * SeparatorWidget
10929
+ */
10930
+ export type SeparatorWidget = {
10931
+ /**
10932
+ * Id
10933
+ *
10934
+ * Made by the client and stable across saves.
10935
+ */
10936
+ id: string;
10937
+ /**
10938
+ * Title
10939
+ */
10940
+ title?: string | null;
10941
+ /**
10942
+ * Type
10943
+ */
10944
+ type: 'separator';
10945
+ /**
10946
+ * V
10947
+ */
10948
+ v: 1;
10949
+ config: SeparatorConfig;
10950
+ };
10687
10951
  /**
10688
10952
  * ServiceAuthRequest
10689
10953
  *
@@ -11160,6 +11424,12 @@ export type SharedLayerResponse = {
11160
11424
  * Dataset Extent Bbox
11161
11425
  */
11162
11426
  dataset_extent_bbox?: Array<number> | null;
11427
+ /**
11428
+ * Dataset Tile Columns
11429
+ *
11430
+ * Dataset tile attribute allowlist, as on MapLayerResponse: null allows all queryable columns, [] exposes none.
11431
+ */
11432
+ dataset_tile_columns?: Array<string> | null;
11163
11433
  };
11164
11434
  /**
11165
11435
  * SharedMapResponse
@@ -11207,6 +11477,12 @@ export type SharedMapResponse = {
11207
11477
  * Show Basemap Labels
11208
11478
  */
11209
11479
  show_basemap_labels?: boolean;
11480
+ /**
11481
+ * Show Attribute Table
11482
+ *
11483
+ * Whether the viewer offers each layer's attribute table. The columns an embed may read come from each dataset's tile column allowlist.
11484
+ */
11485
+ show_attribute_table?: boolean;
11210
11486
  basemap_config?: BasemapConfig | null;
11211
11487
  terrain_config?: TerrainConfig | null;
11212
11488
  dashboard_config?: DashboardConfig | null;
@@ -12473,10 +12749,39 @@ export type StatusUpdateResponse = {
12473
12749
  /**
12474
12750
  * StoredStoryVisibility
12475
12751
  *
12476
- * A story's visibility as stored. ``restricted`` is reserved for story
12477
- * group sharing, which no route sets yet.
12752
+ * A story's visibility as stored. A private story shared with groups is
12753
+ * ``restricted``: its groups' members read it too.
12478
12754
  */
12479
12755
  export type StoredStoryVisibility = 'private' | 'internal' | 'public' | 'restricted';
12756
+ /**
12757
+ * StoryAssetResponse
12758
+ */
12759
+ export type StoryAssetResponse = {
12760
+ /**
12761
+ * Id
12762
+ *
12763
+ * Served at `/stories/{story_id}/assets/{id}` as WebP.
12764
+ */
12765
+ id: string;
12766
+ /**
12767
+ * Width
12768
+ */
12769
+ width: number;
12770
+ /**
12771
+ * Height
12772
+ */
12773
+ height: number;
12774
+ /**
12775
+ * Byte Size
12776
+ *
12777
+ * Size of the stored image in all its sizes.
12778
+ */
12779
+ byte_size: number;
12780
+ /**
12781
+ * Created At
12782
+ */
12783
+ created_at: string;
12784
+ };
12480
12785
  /**
12481
12786
  * StoryCamera
12482
12787
  */
@@ -12525,7 +12830,7 @@ export type StoryChapter = {
12525
12830
  /**
12526
12831
  * Blocks
12527
12832
  */
12528
- blocks?: Array<MarkdownWidget | ImageWidget>;
12833
+ blocks?: Array<MarkdownWidget | ImageWidget | ButtonWidget | SeparatorWidget>;
12529
12834
  };
12530
12835
  /**
12531
12836
  * StoryChapterInput
@@ -12551,7 +12856,7 @@ export type StoryChapterInput = {
12551
12856
  /**
12552
12857
  * Blocks
12553
12858
  */
12554
- blocks?: Array<MarkdownWidget | ImageWidget>;
12859
+ blocks?: Array<MarkdownWidget | ImageWidget | ButtonWidget | SeparatorWidget>;
12555
12860
  };
12556
12861
  /**
12557
12862
  * StoryCreate
@@ -12619,6 +12924,12 @@ export type StoryDraftResponse = {
12619
12924
  * When the story was last published; null if never.
12620
12925
  */
12621
12926
  published_at: string | null;
12927
+ /**
12928
+ * Cover Asset Id
12929
+ *
12930
+ * The cover image, served at `/stories/{id}/assets/{cover_asset_id}`; null without one.
12931
+ */
12932
+ cover_asset_id: string | null;
12622
12933
  /**
12623
12934
  * Created At
12624
12935
  */
@@ -12636,6 +12947,12 @@ export type StoryDraftResponse = {
12636
12947
  */
12637
12948
  revision: number;
12638
12949
  document: StoryDocument;
12950
+ /**
12951
+ * Groups
12952
+ *
12953
+ * The sharing groups the story is shared with, by name.
12954
+ */
12955
+ groups?: Array<GroupRef>;
12639
12956
  };
12640
12957
  /**
12641
12958
  * StoryDraftUpdate
@@ -12649,6 +12966,44 @@ export type StoryDraftUpdate = {
12649
12966
  revision: number;
12650
12967
  document: StoryDocumentInput;
12651
12968
  };
12969
+ /**
12970
+ * StoryGroupsResponse
12971
+ */
12972
+ export type StoryGroupsResponse = {
12973
+ /**
12974
+ * The story's visibility after the change: a private story shared with a group becomes restricted, and a restricted one left with no group becomes private.
12975
+ */
12976
+ visibility: StoredStoryVisibility;
12977
+ /**
12978
+ * Groups
12979
+ *
12980
+ * The sharing groups the story is shared with, by name.
12981
+ */
12982
+ groups: Array<GroupRef>;
12983
+ /**
12984
+ * Shared Map Ids
12985
+ *
12986
+ * Maps this request shared with the story's new groups.
12987
+ */
12988
+ shared_map_ids?: Array<string>;
12989
+ };
12990
+ /**
12991
+ * StoryGroupsUpdate
12992
+ */
12993
+ export type StoryGroupsUpdate = {
12994
+ /**
12995
+ * Group Ids
12996
+ *
12997
+ * Every group the story is shared with afterwards; an empty list unshares it. An owner may add only groups they belong to, and an admin any group.
12998
+ */
12999
+ group_ids: Array<string>;
13000
+ /**
13001
+ * Confirm
13002
+ *
13003
+ * Required to go ahead when maps the story uses block some of its groups; without it the request answers 409 and lists them. `share_maps` first shares each map marked `can_share` with the groups that lack it, which makes a private one restricted. The request is still refused while any other map blocks it.
13004
+ */
13005
+ confirm?: 'share_maps' | null;
13006
+ };
12652
13007
  /**
12653
13008
  * StoryListResponse
12654
13009
  */
@@ -12656,11 +13011,28 @@ export type StoryListResponse = {
12656
13011
  /**
12657
13012
  * Stories
12658
13013
  */
12659
- stories: Array<StorySummary>;
13014
+ stories: Array<StorySummary>;
13015
+ /**
13016
+ * Total
13017
+ */
13018
+ total: number;
13019
+ };
13020
+ /**
13021
+ * StoryPublish
13022
+ */
13023
+ export type StoryPublish = {
13024
+ /**
13025
+ * Revision
13026
+ *
13027
+ * The draft revision this publish or discard acts on.
13028
+ */
13029
+ revision: number;
12660
13030
  /**
12661
- * Total
13031
+ * Confirm
13032
+ *
13033
+ * Required to go ahead when maps the story uses block some of its groups; without it the request answers 409 and lists them. `share_maps` first shares each map marked `can_share` with the groups that lack it, which makes a private one restricted. The request is still refused while any other map blocks it.
12662
13034
  */
12663
- total: number;
13035
+ confirm?: 'share_maps' | null;
12664
13036
  };
12665
13037
  /**
12666
13038
  * StoryResponse
@@ -12689,6 +13061,12 @@ export type StoryResponse = {
12689
13061
  * When the story was last published; null if never.
12690
13062
  */
12691
13063
  published_at: string | null;
13064
+ /**
13065
+ * Cover Asset Id
13066
+ *
13067
+ * The cover image, served at `/stories/{id}/assets/{cover_asset_id}`; null without one.
13068
+ */
13069
+ cover_asset_id: string | null;
12692
13070
  /**
12693
13071
  * Created At
12694
13072
  */
@@ -12762,6 +13140,12 @@ export type StorySummary = {
12762
13140
  * When the story was last published; null if never.
12763
13141
  */
12764
13142
  published_at: string | null;
13143
+ /**
13144
+ * Cover Asset Id
13145
+ *
13146
+ * The cover image, served at `/stories/{id}/assets/{cover_asset_id}`; null without one.
13147
+ */
13148
+ cover_asset_id: string | null;
12765
13149
  /**
12766
13150
  * Created At
12767
13151
  */
@@ -12791,6 +13175,12 @@ export type StoryUpdate = {
12791
13175
  * Refused with 409 when a map the published story uses is narrower than the new visibility.
12792
13176
  */
12793
13177
  visibility?: StoryVisibility | null;
13178
+ /**
13179
+ * Cover Asset Id
13180
+ *
13181
+ * An image uploaded to this story to use as its cover, or null for none. 422 `story_assets_not_found` for an image this story doesn't have.
13182
+ */
13183
+ cover_asset_id?: string | null;
12794
13184
  };
12795
13185
  /**
12796
13186
  * StoryVisibility
@@ -23555,6 +23945,14 @@ export type ReuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPostResponses =
23555
23945
  export type ReuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPostResponse = ReuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPostResponses[keyof ReuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPostResponses];
23556
23946
  export type GetDatasetRowsEndpointDatasetsDatasetIdRowsGetData = {
23557
23947
  body?: never;
23948
+ headers?: {
23949
+ /**
23950
+ * X-Embed-Token
23951
+ *
23952
+ * Optional embed token. Datasets in the token's scope are authorized when the token's map has `show_attribute_table` on.
23953
+ */
23954
+ 'X-Embed-Token'?: string | null;
23955
+ };
23558
23956
  path: {
23559
23957
  /**
23560
23958
  * Dataset Id
@@ -23588,6 +23986,18 @@ export type GetDatasetRowsEndpointDatasetsDatasetIdRowsGetData = {
23588
23986
  * Optional CQL2-JSON filter expression (as the OGC items route's ``filter-lang=cql2-json``). ANDs with the ``filter[column]`` ILIKE filters; malformed expressions and unknown columns return 400.
23589
23987
  */
23590
23988
  filter?: string | null;
23989
+ /**
23990
+ * Gid
23991
+ *
23992
+ * Return at most the row with this gid, ANDed with `filter` and the `filter[column]` filters. The total counts it like a filter.
23993
+ */
23994
+ gid?: number | null;
23995
+ /**
23996
+ * With Bbox
23997
+ *
23998
+ * Also return `bboxes`, each row's bounding box in EPSG:4326.
23999
+ */
24000
+ with_bbox?: boolean;
23591
24001
  };
23592
24002
  url: '/datasets/{dataset_id}/rows/';
23593
24003
  };
@@ -23597,7 +24007,7 @@ export type GetDatasetRowsEndpointDatasetsDatasetIdRowsGetErrors = {
23597
24007
  */
23598
24008
  400: ProblemDetail;
23599
24009
  /**
23600
- * Unauthorized — missing or invalid credentials
24010
+ * Unauthenticated — a credential was supplied and could not be resolved (expired, revoked, or malformed). Sending no credential at all is not an error on these operations; they answer anonymously with the public subset. Neither is sending an unresolvable credential alongside a valid X-Embed-Token that authorizes the request on its own. That request is served and the unrelated credential is ignored.
23601
24011
  */
23602
24012
  401: ProblemDetail;
23603
24013
  /**
@@ -27693,6 +28103,63 @@ export type ShareMapEndpointMapsMapIdSharePostResponses = {
27693
28103
  200: ShareTokenResponse;
27694
28104
  };
27695
28105
  export type ShareMapEndpointMapsMapIdSharePostResponse = ShareMapEndpointMapsMapIdSharePostResponses[keyof ShareMapEndpointMapsMapIdSharePostResponses];
28106
+ export type ListMapStoriesEndpointMapsMapIdStoriesGetData = {
28107
+ body?: never;
28108
+ path: {
28109
+ /**
28110
+ * Map Id
28111
+ */
28112
+ map_id: string;
28113
+ };
28114
+ query?: never;
28115
+ url: '/maps/{map_id}/stories/';
28116
+ };
28117
+ export type ListMapStoriesEndpointMapsMapIdStoriesGetErrors = {
28118
+ /**
28119
+ * Bad request — invalid payload
28120
+ */
28121
+ 400: ProblemDetail;
28122
+ /**
28123
+ * Unauthorized — missing or invalid credentials
28124
+ */
28125
+ 401: ProblemDetail;
28126
+ /**
28127
+ * Forbidden — caller lacks write access
28128
+ */
28129
+ 403: ProblemDetail;
28130
+ /**
28131
+ * Not found
28132
+ */
28133
+ 404: ProblemDetail;
28134
+ /**
28135
+ * Conflict — resource state prevents the operation
28136
+ */
28137
+ 409: ProblemDetail;
28138
+ /**
28139
+ * Validation error
28140
+ */
28141
+ 422: ProblemDetail;
28142
+ /**
28143
+ * Too many requests — retry after the advertised interval
28144
+ */
28145
+ 429: ProblemDetail;
28146
+ /**
28147
+ * Internal server error
28148
+ */
28149
+ 500: ProblemDetail;
28150
+ /**
28151
+ * Service unavailable — the database could not serve the request
28152
+ */
28153
+ 503: ProblemDetail;
28154
+ };
28155
+ export type ListMapStoriesEndpointMapsMapIdStoriesGetError = ListMapStoriesEndpointMapsMapIdStoriesGetErrors[keyof ListMapStoriesEndpointMapsMapIdStoriesGetErrors];
28156
+ export type ListMapStoriesEndpointMapsMapIdStoriesGetResponses = {
28157
+ /**
28158
+ * Successful Response
28159
+ */
28160
+ 200: MapStoriesResponse;
28161
+ };
28162
+ export type ListMapStoriesEndpointMapsMapIdStoriesGetResponse = ListMapStoriesEndpointMapsMapIdStoriesGetResponses[keyof ListMapStoriesEndpointMapsMapIdStoriesGetResponses];
27696
28163
  export type ExportMapStyleEndpointMapsMapIdStyleJsonGetData = {
27697
28164
  body?: never;
27698
28165
  path: {
@@ -31465,6 +31932,145 @@ export type UpdateStoryEndpointStoriesStoryIdPatchResponses = {
31465
31932
  200: StoryResponse;
31466
31933
  };
31467
31934
  export type UpdateStoryEndpointStoriesStoryIdPatchResponse = UpdateStoryEndpointStoriesStoryIdPatchResponses[keyof UpdateStoryEndpointStoriesStoryIdPatchResponses];
31935
+ export type UploadStoryAssetEndpointStoriesStoryIdAssetsPostData = {
31936
+ body: {
31937
+ file: Blob | File;
31938
+ };
31939
+ path: {
31940
+ /**
31941
+ * Story Id
31942
+ */
31943
+ story_id: string;
31944
+ };
31945
+ query?: never;
31946
+ url: '/stories/{story_id}/assets';
31947
+ };
31948
+ export type UploadStoryAssetEndpointStoriesStoryIdAssetsPostErrors = {
31949
+ /**
31950
+ * Bad request — invalid payload
31951
+ */
31952
+ 400: ProblemDetail;
31953
+ /**
31954
+ * Unauthorized — missing or invalid credentials
31955
+ */
31956
+ 401: ProblemDetail;
31957
+ /**
31958
+ * Forbidden — caller lacks write access
31959
+ */
31960
+ 403: ProblemDetail;
31961
+ /**
31962
+ * Not found
31963
+ */
31964
+ 404: ProblemDetail;
31965
+ /**
31966
+ * The story already holds its most images or bytes (`detail.code` `story_asset_limit`), its owner's stories hold the most image bytes the admin allows (`story_asset_owner_limit`), or another change holds its lock.
31967
+ */
31968
+ 409: ProblemDetail;
31969
+ /**
31970
+ * Payload too large
31971
+ */
31972
+ 413: ProblemDetail;
31973
+ /**
31974
+ * Not a PNG, JPEG or WebP image
31975
+ */
31976
+ 415: ProblemDetail;
31977
+ /**
31978
+ * Validation error
31979
+ */
31980
+ 422: ProblemDetail;
31981
+ /**
31982
+ * Too many requests — retry after the advertised interval
31983
+ */
31984
+ 429: ProblemDetail;
31985
+ /**
31986
+ * Internal server error
31987
+ */
31988
+ 500: ProblemDetail;
31989
+ /**
31990
+ * Bad gateway — an upstream provider failed
31991
+ */
31992
+ 502: ProblemDetail;
31993
+ /**
31994
+ * Other images are being processed (`detail.code` `story_image_busy`); retry after `Retry-After` seconds.
31995
+ */
31996
+ 503: ProblemDetail;
31997
+ };
31998
+ export type UploadStoryAssetEndpointStoriesStoryIdAssetsPostError = UploadStoryAssetEndpointStoriesStoryIdAssetsPostErrors[keyof UploadStoryAssetEndpointStoriesStoryIdAssetsPostErrors];
31999
+ export type UploadStoryAssetEndpointStoriesStoryIdAssetsPostResponses = {
32000
+ /**
32001
+ * Successful Response
32002
+ */
32003
+ 201: StoryAssetResponse;
32004
+ };
32005
+ export type UploadStoryAssetEndpointStoriesStoryIdAssetsPostResponse = UploadStoryAssetEndpointStoriesStoryIdAssetsPostResponses[keyof UploadStoryAssetEndpointStoriesStoryIdAssetsPostResponses];
32006
+ export type GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetData = {
32007
+ body?: never;
32008
+ path: {
32009
+ /**
32010
+ * Story Id
32011
+ */
32012
+ story_id: string;
32013
+ /**
32014
+ * Asset Id
32015
+ */
32016
+ asset_id: string;
32017
+ };
32018
+ query?: {
32019
+ /**
32020
+ * Variant
32021
+ *
32022
+ * `card`: at most 640 pixels wide, as WebP. `social`: 1200 by 630, cropped to fill, as JPEG. An image uploaded before these sizes existed answers with the original.
32023
+ */
32024
+ variant?: 'card' | 'social' | null;
32025
+ };
32026
+ url: '/stories/{story_id}/assets/{asset_id}';
32027
+ };
32028
+ export type GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetErrors = {
32029
+ /**
32030
+ * Bad request — invalid payload
32031
+ */
32032
+ 400: ProblemDetail;
32033
+ /**
32034
+ * Unauthorized — missing or invalid credentials
32035
+ */
32036
+ 401: ProblemDetail;
32037
+ /**
32038
+ * Forbidden — caller lacks write access
32039
+ */
32040
+ 403: ProblemDetail;
32041
+ /**
32042
+ * Not found
32043
+ */
32044
+ 404: ProblemDetail;
32045
+ /**
32046
+ * Conflict — resource state prevents the operation
32047
+ */
32048
+ 409: ProblemDetail;
32049
+ /**
32050
+ * Validation error
32051
+ */
32052
+ 422: ProblemDetail;
32053
+ /**
32054
+ * Too many requests — retry after the advertised interval
32055
+ */
32056
+ 429: ProblemDetail;
32057
+ /**
32058
+ * Internal server error
32059
+ */
32060
+ 500: ProblemDetail;
32061
+ /**
32062
+ * Service unavailable — the database could not serve the request
32063
+ */
32064
+ 503: ProblemDetail;
32065
+ };
32066
+ export type GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetError = GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetErrors[keyof GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetErrors];
32067
+ export type GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetResponses = {
32068
+ /**
32069
+ * The image
32070
+ */
32071
+ 200: Blob | File;
32072
+ };
32073
+ export type GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetResponse = GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetResponses[keyof GetStoryAssetEndpointStoriesStoryIdAssetsAssetIdGetResponses];
31468
32074
  export type DiscardStoryDraftEndpointStoriesStoryIdDiscardPostData = {
31469
32075
  body: StoryRevision;
31470
32076
  path: {
@@ -31665,7 +32271,7 @@ export type DuplicateStoryEndpointStoriesStoryIdDuplicatePostErrors = {
31665
32271
  */
31666
32272
  404: ProblemDetail;
31667
32273
  /**
31668
- * Conflict — resource state prevents the operation
32274
+ * The copied images would take your stories past the most image bytes the admin allows (`detail.code` `story_asset_owner_limit`).
31669
32275
  */
31670
32276
  409: ProblemDetail;
31671
32277
  /**
@@ -31680,6 +32286,10 @@ export type DuplicateStoryEndpointStoriesStoryIdDuplicatePostErrors = {
31680
32286
  * Internal server error
31681
32287
  */
31682
32288
  500: ProblemDetail;
32289
+ /**
32290
+ * Bad gateway — an upstream provider failed
32291
+ */
32292
+ 502: ProblemDetail;
31683
32293
  /**
31684
32294
  * Service unavailable — the database could not serve the request
31685
32295
  */
@@ -31693,8 +32303,65 @@ export type DuplicateStoryEndpointStoriesStoryIdDuplicatePostResponses = {
31693
32303
  201: StoryDraftResponse;
31694
32304
  };
31695
32305
  export type DuplicateStoryEndpointStoriesStoryIdDuplicatePostResponse = DuplicateStoryEndpointStoriesStoryIdDuplicatePostResponses[keyof DuplicateStoryEndpointStoriesStoryIdDuplicatePostResponses];
32306
+ export type SetStoryGroupsEndpointStoriesStoryIdGroupsPutData = {
32307
+ body: StoryGroupsUpdate;
32308
+ path: {
32309
+ /**
32310
+ * Story Id
32311
+ */
32312
+ story_id: string;
32313
+ };
32314
+ query?: never;
32315
+ url: '/stories/{story_id}/groups/';
32316
+ };
32317
+ export type SetStoryGroupsEndpointStoriesStoryIdGroupsPutErrors = {
32318
+ /**
32319
+ * Bad request — invalid payload
32320
+ */
32321
+ 400: ProblemDetail;
32322
+ /**
32323
+ * Unauthorized — missing or invalid credentials
32324
+ */
32325
+ 401: ProblemDetail;
32326
+ /**
32327
+ * Forbidden — caller lacks access to this resource
32328
+ */
32329
+ 403: ProblemDetail;
32330
+ /**
32331
+ * Not found
32332
+ */
32333
+ 404: ProblemDetail;
32334
+ /**
32335
+ * Maps the published story uses that some new groups can't read (`detail.code` `maps_narrower_than_story`, the maps under `detail.maps`), or another change holding the story's lock (no `detail.code`).
32336
+ */
32337
+ 409: ProblemDetail;
32338
+ /**
32339
+ * Validation error
32340
+ */
32341
+ 422: ProblemDetail;
32342
+ /**
32343
+ * Too many requests — retry after the advertised interval
32344
+ */
32345
+ 429: ProblemDetail;
32346
+ /**
32347
+ * Internal server error
32348
+ */
32349
+ 500: ProblemDetail;
32350
+ /**
32351
+ * Service unavailable — the database could not serve the request
32352
+ */
32353
+ 503: ProblemDetail;
32354
+ };
32355
+ export type SetStoryGroupsEndpointStoriesStoryIdGroupsPutError = SetStoryGroupsEndpointStoriesStoryIdGroupsPutErrors[keyof SetStoryGroupsEndpointStoriesStoryIdGroupsPutErrors];
32356
+ export type SetStoryGroupsEndpointStoriesStoryIdGroupsPutResponses = {
32357
+ /**
32358
+ * Successful Response
32359
+ */
32360
+ 200: StoryGroupsResponse;
32361
+ };
32362
+ export type SetStoryGroupsEndpointStoriesStoryIdGroupsPutResponse = SetStoryGroupsEndpointStoriesStoryIdGroupsPutResponses[keyof SetStoryGroupsEndpointStoriesStoryIdGroupsPutResponses];
31696
32363
  export type PublishStoryEndpointStoriesStoryIdPublishPostData = {
31697
- body: StoryRevision;
32364
+ body: StoryPublish;
31698
32365
  path: {
31699
32366
  /**
31700
32367
  * Story Id
@@ -31919,6 +32586,10 @@ export type RasterTileProxyTilesRasterProxyDatasetIdZxyFmtGetErrors = {
31919
32586
  * Validation error
31920
32587
  */
31921
32588
  422: ProblemDetail;
32589
+ /**
32590
+ * Too many requests — retry after the advertised interval
32591
+ */
32592
+ 429: ProblemDetail;
31922
32593
  /**
31923
32594
  * Internal server error
31924
32595
  */