@geolens/sdk 1.27.1 → 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.
@@ -278,8 +278,9 @@ export const createGroupAdminGroupsPost = (options) => (options.client ?? client
278
278
  *
279
279
  * Delete a sharing group and all its memberships (admin only).
280
280
  *
281
- * Its members lose the group's datasets and maps at once, signed tile URLs
282
- * included. A restricted map shared only with this group becomes private.
281
+ * Its members lose the group's datasets, maps and stories at once, signed
282
+ * tile URLs included. A restricted map or story shared only with this group
283
+ * becomes private.
283
284
  */
284
285
  export const deleteGroupAdminGroupsGroupIdDelete = (options) => (options.client ?? client).delete({
285
286
  security: [
@@ -2068,7 +2069,10 @@ export const updateDatasetMetadataDatasetsDatasetIdPatch = (options) => (options
2068
2069
  * Compute one exact aggregate over a dataset's rows, for a widget.
2069
2070
  *
2070
2071
  * Anonymous callers can read public, published datasets; ``X-Embed-Token``
2071
- * authorizes datasets in the token's scope. Other datasets return 404.
2072
+ * authorizes datasets in the token's scope. Other datasets return 404. A
2073
+ * request only the embed token authorizes may read only the columns in the
2074
+ * dataset's tile column allowlist, when it has one; any other column is
2075
+ * refused as an unknown one.
2072
2076
  *
2073
2077
  * With ``bbox``, a view the planner expects to hold more than 500,000 rows
2074
2078
  * is refused with 422 and the code ``too_wide`` rather than approximated. A
@@ -2507,7 +2511,9 @@ export const exportDatasetEndpointDatasetsDatasetIdExportGet = (options) => (opt
2507
2511
  * Return up to 5,000 features as RFC 7946 GeoJSON with Z coordinates.
2508
2512
  *
2509
2513
  * ``X-Embed-Token`` authorizes private datasets in the token's scope through
2510
- * the same capability check used for tile requests.
2514
+ * the same capability check used for tile requests. A request only the embed
2515
+ * token authorizes gets only the properties in the dataset's tile column
2516
+ * allowlist, when it has one.
2511
2517
  *
2512
2518
  * Anonymous callers can read public, published datasets. Private or
2513
2519
  * restricted datasets return 404 unless user or embed credentials authorize
@@ -3325,6 +3331,15 @@ export const reuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPost = (options
3325
3331
  * Uses cursor-based pagination: pass ``after`` (the ``next_cursor`` gid) to
3326
3332
  * fetch the next page, with or without ``sort``.
3327
3333
  * Supports column filtering via query params: ``filter[column_name]=value``.
3334
+ * An optional CQL2-JSON ``filter`` expression ANDs with them.
3335
+ *
3336
+ * Anonymous callers can read public, published datasets. ``X-Embed-Token``
3337
+ * authorizes datasets in the token's scope while the token's map has
3338
+ * ``show_attribute_table`` on. Other datasets return 404. A request only the
3339
+ * embed token authorizes reads only the columns in the dataset's tile column
3340
+ * allowlist, when it has one: any other column is treated as one the table
3341
+ * lacks, in the returned columns, ``sort``, ``filter`` and
3342
+ * ``filter[column]``.
3328
3343
  */
3329
3344
  export const getDatasetRowsEndpointDatasetsDatasetIdRowsGet = (options) => (options.client ?? client).get({
3330
3345
  security: [
@@ -4970,6 +4985,29 @@ export const shareMapEndpointMapsMapIdSharePost = (options) => (options.client ?
4970
4985
  ...options.headers
4971
4986
  }
4972
4987
  });
4988
+ /**
4989
+ * List Map Stories Endpoint
4990
+ *
4991
+ * List the stories whose scenes use this map (owner or admin).
4992
+ *
4993
+ * Stories you can't read are only counted, in `hidden_count`. Deleting the
4994
+ * map keeps each story's chapters and their text; a chapter whose scene
4995
+ * used the map loses that scene. 404 when you can't read the map, 403 when
4996
+ * you can but don't own it.
4997
+ */
4998
+ export const listMapStoriesEndpointMapsMapIdStoriesGet = (options) => (options.client ?? client).get({
4999
+ security: [
5000
+ { scheme: 'bearer', type: 'http' },
5001
+ { name: 'X-Api-Key', type: 'apiKey' },
5002
+ {
5003
+ in: 'query',
5004
+ name: 'api_key',
5005
+ type: 'apiKey'
5006
+ }
5007
+ ],
5008
+ url: '/maps/{map_id}/stories/',
5009
+ ...options
5010
+ });
4973
5011
  /**
4974
5012
  * Export Map Style Endpoint
4975
5013
  *
@@ -6186,6 +6224,328 @@ export const searchPostStacSearchPost = (options) => (options.client ?? client).
6186
6224
  ...options.headers
6187
6225
  }
6188
6226
  });
6227
+ /**
6228
+ * List Stories Endpoint
6229
+ *
6230
+ * List the stories the caller may read, most recently updated first.
6231
+ *
6232
+ * Anyone sees published public stories, signed-in users also published
6233
+ * internal ones, owners their own (published or not), and admins all.
6234
+ */
6235
+ export const listStoriesEndpointStoriesGet = (options) => (options?.client ?? client).get({
6236
+ security: [
6237
+ { scheme: 'bearer', type: 'http' },
6238
+ { name: 'X-Api-Key', type: 'apiKey' },
6239
+ {
6240
+ in: 'query',
6241
+ name: 'api_key',
6242
+ type: 'apiKey'
6243
+ }
6244
+ ],
6245
+ url: '/stories/',
6246
+ ...options
6247
+ });
6248
+ /**
6249
+ * Create Story Endpoint
6250
+ *
6251
+ * Create a private, unpublished story with an empty draft.
6252
+ */
6253
+ export const createStoryEndpointStoriesPost = (options) => (options.client ?? client).post({
6254
+ security: [
6255
+ { scheme: 'bearer', type: 'http' },
6256
+ { name: 'X-Api-Key', type: 'apiKey' },
6257
+ {
6258
+ in: 'query',
6259
+ name: 'api_key',
6260
+ type: 'apiKey'
6261
+ }
6262
+ ],
6263
+ url: '/stories/',
6264
+ ...options,
6265
+ headers: {
6266
+ 'Content-Type': 'application/json',
6267
+ ...options.headers
6268
+ }
6269
+ });
6270
+ /**
6271
+ * Delete Story Endpoint
6272
+ *
6273
+ * Delete a story and its images (owner or admin). The maps it uses are
6274
+ * untouched.
6275
+ */
6276
+ export const deleteStoryEndpointStoriesStoryIdDelete = (options) => (options.client ?? client).delete({
6277
+ security: [
6278
+ { scheme: 'bearer', type: 'http' },
6279
+ { name: 'X-Api-Key', type: 'apiKey' },
6280
+ {
6281
+ in: 'query',
6282
+ name: 'api_key',
6283
+ type: 'apiKey'
6284
+ }
6285
+ ],
6286
+ url: '/stories/{story_id}',
6287
+ ...options
6288
+ });
6289
+ /**
6290
+ * Get Story Endpoint
6291
+ *
6292
+ * Read a story's published document.
6293
+ *
6294
+ * Scenes on maps the caller can't read come back without their scene. An
6295
+ * unpublished story is readable only by its owner and admins, with a null
6296
+ * document. 404 when the caller can't read the story.
6297
+ */
6298
+ export const getStoryEndpointStoriesStoryIdGet = (options) => (options.client ?? client).get({
6299
+ security: [
6300
+ { scheme: 'bearer', type: 'http' },
6301
+ { name: 'X-Api-Key', type: 'apiKey' },
6302
+ {
6303
+ in: 'query',
6304
+ name: 'api_key',
6305
+ type: 'apiKey'
6306
+ }
6307
+ ],
6308
+ url: '/stories/{story_id}',
6309
+ ...options
6310
+ });
6311
+ /**
6312
+ * Update Story Endpoint
6313
+ *
6314
+ * Change a story's title, summary, visibility or cover (owner or admin).
6315
+ *
6316
+ * These apply at once, without Publish. A visibility wider than a map the
6317
+ * published story uses answers 409 `maps_narrower_than_story`; a narrower
6318
+ * one is always allowed. A story shared with groups stays restricted when
6319
+ * made private.
6320
+ */
6321
+ export const updateStoryEndpointStoriesStoryIdPatch = (options) => (options.client ?? client).patch({
6322
+ security: [
6323
+ { scheme: 'bearer', type: 'http' },
6324
+ { name: 'X-Api-Key', type: 'apiKey' },
6325
+ {
6326
+ in: 'query',
6327
+ name: 'api_key',
6328
+ type: 'apiKey'
6329
+ }
6330
+ ],
6331
+ url: '/stories/{story_id}',
6332
+ ...options,
6333
+ headers: {
6334
+ 'Content-Type': 'application/json',
6335
+ ...options.headers
6336
+ }
6337
+ });
6338
+ /**
6339
+ * Upload Story Asset Endpoint
6340
+ *
6341
+ * Upload an image, the multipart part `file`, for the story's blocks or
6342
+ * cover (owner or admin).
6343
+ *
6344
+ * PNG, JPEG and WebP, told apart by their bytes. It's stored as sRGB WebP
6345
+ * without its metadata. 400 `story_image_unreadable`, 413
6346
+ * `story_image_too_large`, 415 `story_image_unsupported`, 409
6347
+ * `story_asset_limit` or `story_asset_owner_limit`, 503 `story_image_busy`.
6348
+ * Readers get it once a published block or the cover uses it.
6349
+ */
6350
+ export const uploadStoryAssetEndpointStoriesStoryIdAssetsPost = (options) => (options.client ?? client).post({
6351
+ ...formDataBodySerializer,
6352
+ security: [
6353
+ { scheme: 'bearer', type: 'http' },
6354
+ { name: 'X-Api-Key', type: 'apiKey' },
6355
+ {
6356
+ in: 'query',
6357
+ name: 'api_key',
6358
+ type: 'apiKey'
6359
+ }
6360
+ ],
6361
+ url: '/stories/{story_id}/assets',
6362
+ ...options,
6363
+ headers: {
6364
+ 'Content-Type': null,
6365
+ ...options.headers
6366
+ }
6367
+ });
6368
+ /**
6369
+ * Get Story Asset Endpoint
6370
+ *
6371
+ * Serve one of the story's images, as WebP unless `variant` says otherwise.
6372
+ *
6373
+ * Its owner and admins get any of them. Anyone else who can read the story
6374
+ * gets the cover and the images its published document uses. 404 otherwise.
6375
+ */
6376
+ export const getStoryAssetEndpointStoriesStoryIdAssetsAssetIdGet = (options) => (options.client ?? client).get({
6377
+ security: [
6378
+ { scheme: 'bearer', type: 'http' },
6379
+ { name: 'X-Api-Key', type: 'apiKey' },
6380
+ {
6381
+ in: 'query',
6382
+ name: 'api_key',
6383
+ type: 'apiKey'
6384
+ }
6385
+ ],
6386
+ url: '/stories/{story_id}/assets/{asset_id}',
6387
+ ...options
6388
+ });
6389
+ /**
6390
+ * Discard Story Draft Endpoint
6391
+ *
6392
+ * Revert the draft to the published document, or to an empty one for a
6393
+ * story never published (owner or admin).
6394
+ *
6395
+ * `revision` must match the stored draft's, or 409 `stale_revision`, so a
6396
+ * stale tab or a retry can't erase a draft saved since.
6397
+ */
6398
+ export const discardStoryDraftEndpointStoriesStoryIdDiscardPost = (options) => (options.client ?? client).post({
6399
+ security: [
6400
+ { scheme: 'bearer', type: 'http' },
6401
+ { name: 'X-Api-Key', type: 'apiKey' },
6402
+ {
6403
+ in: 'query',
6404
+ name: 'api_key',
6405
+ type: 'apiKey'
6406
+ }
6407
+ ],
6408
+ url: '/stories/{story_id}/discard',
6409
+ ...options,
6410
+ headers: {
6411
+ 'Content-Type': 'application/json',
6412
+ ...options.headers
6413
+ }
6414
+ });
6415
+ /**
6416
+ * Get Story Draft Endpoint
6417
+ *
6418
+ * Read the draft with its revision (owner or admin).
6419
+ *
6420
+ * Scenes on maps you can't read come back without their scene, marked
6421
+ * `scene_hidden`. 404 when you can't read the story, 403 when you can but
6422
+ * don't own it.
6423
+ */
6424
+ export const getStoryDraftEndpointStoriesStoryIdDraftGet = (options) => (options.client ?? client).get({
6425
+ security: [
6426
+ { scheme: 'bearer', type: 'http' },
6427
+ { name: 'X-Api-Key', type: 'apiKey' },
6428
+ {
6429
+ in: 'query',
6430
+ name: 'api_key',
6431
+ type: 'apiKey'
6432
+ }
6433
+ ],
6434
+ url: '/stories/{story_id}/draft',
6435
+ ...options
6436
+ });
6437
+ /**
6438
+ * Save Story Draft Endpoint
6439
+ *
6440
+ * Replace the whole draft (owner or admin). Readers keep the published
6441
+ * document until Publish.
6442
+ *
6443
+ * `revision` must match the stored draft's, or 409 `stale_revision`. 422
6444
+ * for an unknown or invalid block, for a scene on a map you can't read
6445
+ * (`detail.code` `story_maps_not_found`), or for an image block naming an
6446
+ * image this story doesn't have (`story_assets_not_found`). Blocks you
6447
+ * can't see and scenes sent back with `scene_hidden` are kept as stored.
6448
+ */
6449
+ export const saveStoryDraftEndpointStoriesStoryIdDraftPut = (options) => (options.client ?? client).put({
6450
+ security: [
6451
+ { scheme: 'bearer', type: 'http' },
6452
+ { name: 'X-Api-Key', type: 'apiKey' },
6453
+ {
6454
+ in: 'query',
6455
+ name: 'api_key',
6456
+ type: 'apiKey'
6457
+ }
6458
+ ],
6459
+ url: '/stories/{story_id}/draft',
6460
+ ...options,
6461
+ headers: {
6462
+ 'Content-Type': 'application/json',
6463
+ ...options.headers
6464
+ }
6465
+ });
6466
+ /**
6467
+ * Duplicate Story Endpoint
6468
+ *
6469
+ * Copy a story you can read into a new private draft you own.
6470
+ *
6471
+ * Its owner or an admin copies the draft; anyone else the published
6472
+ * document. Scenes on maps you can't read are left out of the copy. The
6473
+ * copy gets its own copies of the images it uses and of the cover.
6474
+ */
6475
+ export const duplicateStoryEndpointStoriesStoryIdDuplicatePost = (options) => (options.client ?? client).post({
6476
+ security: [
6477
+ { scheme: 'bearer', type: 'http' },
6478
+ { name: 'X-Api-Key', type: 'apiKey' },
6479
+ {
6480
+ in: 'query',
6481
+ name: 'api_key',
6482
+ type: 'apiKey'
6483
+ }
6484
+ ],
6485
+ url: '/stories/{story_id}/duplicate',
6486
+ ...options
6487
+ });
6488
+ /**
6489
+ * Set Story Groups Endpoint
6490
+ *
6491
+ * Share a story with exactly these sharing groups (owner or admin).
6492
+ *
6493
+ * An owner may add only groups they belong to (403); an admin may add any.
6494
+ * A private story shared with a group becomes restricted, and once
6495
+ * published its members can read it; a restricted one left with no group
6496
+ * becomes private. Internal and public stories keep their audience. 404 for
6497
+ * an unknown group.
6498
+ *
6499
+ * 409 `maps_narrower_than_story` when the published story uses maps some
6500
+ * member of a new group can't read: `detail.maps` names the ones you can
6501
+ * read, each with `can_share`, and `detail.unreadable_maps` counts the
6502
+ * rest; see `confirm`.
6503
+ */
6504
+ export const setStoryGroupsEndpointStoriesStoryIdGroupsPut = (options) => (options.client ?? client).put({
6505
+ security: [
6506
+ { scheme: 'bearer', type: 'http' },
6507
+ { name: 'X-Api-Key', type: 'apiKey' },
6508
+ {
6509
+ in: 'query',
6510
+ name: 'api_key',
6511
+ type: 'apiKey'
6512
+ }
6513
+ ],
6514
+ url: '/stories/{story_id}/groups/',
6515
+ ...options,
6516
+ headers: {
6517
+ 'Content-Type': 'application/json',
6518
+ ...options.headers
6519
+ }
6520
+ });
6521
+ /**
6522
+ * Publish Story Endpoint
6523
+ *
6524
+ * Publish the draft (owner or admin): readers get it from now on.
6525
+ *
6526
+ * `revision` must match the stored draft's, or 409 `stale_revision`. 409
6527
+ * `maps_narrower_than_story` when a map a scene uses can't be read by
6528
+ * everyone the story's visibility reaches: `detail.maps` names the ones you
6529
+ * can read and `detail.unreadable_maps` counts the rest. For a restricted
6530
+ * story, a map only some of its groups lack is `can_share`; see `confirm`.
6531
+ */
6532
+ export const publishStoryEndpointStoriesStoryIdPublishPost = (options) => (options.client ?? client).post({
6533
+ security: [
6534
+ { scheme: 'bearer', type: 'http' },
6535
+ { name: 'X-Api-Key', type: 'apiKey' },
6536
+ {
6537
+ in: 'query',
6538
+ name: 'api_key',
6539
+ type: 'apiKey'
6540
+ }
6541
+ ],
6542
+ url: '/stories/{story_id}/publish',
6543
+ ...options,
6544
+ headers: {
6545
+ 'Content-Type': 'application/json',
6546
+ ...options.headers
6547
+ }
6548
+ });
6189
6549
  /**
6190
6550
  * Cluster Tile Endpoint
6191
6551
  *
@@ -6226,10 +6586,10 @@ export const searchPostStacSearchPost = (options) => (options.client ?? client).
6226
6586
  * ``If-None-Match`` matches answers 304. Where a deployment runs cold storage,
6227
6587
  * a dataset still being restored answers 202 with a job id to poll. Requests
6228
6588
  * answer 429 with ``Retry-After`` when the per-process capacity for uncached
6229
- * renders stays full for a short wait, tile-pool acquisition times out, a
6230
- * tile query exceeds the pool's per-command timeout, or the configured
6231
- * per-tenant concurrency limit is exceeded. Any other failure serving the
6232
- * tile answers 503.
6589
+ * renders stays full for a short wait, tile-pool acquisition times out, or the
6590
+ * configured per-tenant concurrency limit is exceeded. A tile query that
6591
+ * exceeds the pool's per-command timeout answers 503 without ``Retry-After``
6592
+ * and is not cached, as does any other failure serving the tile.
6233
6593
  */
6234
6594
  export const clusterTileEndpointTilesClustersTablePathZXYPbfGet = (options) => (options.client ?? client).get({
6235
6595
  security: [
@@ -6278,9 +6638,10 @@ export const clusterTileEndpointTilesClustersTablePathZXYPbfGet = (options) => (
6278
6638
  * unsupported format, 401 when a request that no capability authorized
6279
6639
  * carried a credential which did not resolve, 403 when the embed token is
6280
6640
  * invalid or expired or a multi-tenant request arrives with no tenant
6281
- * context, 422 for an out-of-range stretch parameter, and 503 when the
6282
- * renderer cannot be reached. A different failure from the renderer is
6283
- * passed through with its own status.
6641
+ * context, 422 for an out-of-range stretch parameter, 429 with
6642
+ * ``Retry-After`` when the per-process capacity for uncached raster renders
6643
+ * stays full for a short wait, and 503 when the renderer cannot be reached. A
6644
+ * different failure from the renderer is passed through with its own status.
6284
6645
  *
6285
6646
  * 404 covers more than a missing dataset. A dataset that is unknown, is not a
6286
6647
  * raster or has no image answers 404. Where no capability authorized the
@@ -6411,10 +6772,10 @@ export const getTileTokensBatchTilesTokensPost = (options) => (options.client ??
6411
6772
  * ``If-None-Match`` matches answers 304. Where a deployment runs cold storage,
6412
6773
  * a dataset still being restored answers 202 with a job id to poll. Requests
6413
6774
  * answer 429 with ``Retry-After`` when the per-process capacity for uncached
6414
- * renders stays full for a short wait, tile-pool acquisition times out, a
6415
- * tile query exceeds the pool's per-command timeout, or the configured
6416
- * per-tenant concurrency limit is exceeded. Any other failure serving the
6417
- * tile answers 503.
6775
+ * renders stays full for a short wait, tile-pool acquisition times out, or the
6776
+ * configured per-tenant concurrency limit is exceeded. A tile query that
6777
+ * exceeds the pool's per-command timeout answers 503 without ``Retry-After``
6778
+ * and is not cached, as does any other failure serving the tile.
6418
6779
  */
6419
6780
  export const tileEndpointTilesTablePathZXYPbfGet = (options) => (options.client ?? client).get({
6420
6781
  security: [