@storyblok/management-api-client 1.0.0-alpha.1 → 1.0.0-alpha.3
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/README.md +3 -1
- package/dist/client.cjs +9 -9
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +217 -203
- package/dist/client.d.mts +217 -203
- package/dist/client.mjs +9 -9
- package/dist/client.mjs.map +1 -1
- package/dist/generated/mapi/_internal.gen.d.cts +371 -0
- package/dist/generated/mapi/_internal.gen.d.mts +371 -0
- package/dist/generated/{shared → mapi}/client/client.gen.cjs +1 -1
- package/dist/generated/mapi/client/client.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/client.gen.mjs +1 -1
- package/dist/generated/mapi/client/client.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/types.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/client/types.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.cjs +1 -1
- package/dist/generated/mapi/client/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/utils.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.mjs +1 -1
- package/dist/generated/mapi/client/utils.gen.mjs.map +1 -0
- package/dist/generated/mapi/client.gen.cjs +10 -0
- package/dist/generated/mapi/client.gen.cjs.map +1 -0
- package/dist/generated/mapi/client.gen.mjs +10 -0
- package/dist/generated/mapi/client.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/auth.gen.cjs +1 -1
- package/dist/generated/mapi/core/auth.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/auth.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/auth.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/auth.gen.mjs +1 -1
- package/dist/generated/mapi/core/auth.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.cjs +1 -1
- package/dist/generated/mapi/core/bodySerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.mjs +1 -1
- package/dist/generated/mapi/core/bodySerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/params.gen.cjs +1 -1
- package/dist/generated/mapi/core/params.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/params.gen.mjs +1 -1
- package/dist/generated/mapi/core/params.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.cjs +1 -1
- package/dist/generated/mapi/core/pathSerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.mjs +1 -1
- package/dist/generated/mapi/core/pathSerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.cjs +1 -1
- package/dist/generated/mapi/core/serverSentEvents.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.mjs +1 -1
- package/dist/generated/mapi/core/serverSentEvents.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/types.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/types.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/utils.gen.cjs +1 -1
- package/dist/generated/mapi/core/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/utils.gen.mjs +1 -1
- package/dist/generated/mapi/core/utils.gen.mjs.map +1 -0
- package/dist/generated/mapi/sdk.gen.cjs +1477 -0
- package/dist/generated/mapi/sdk.gen.cjs.map +1 -0
- package/dist/generated/mapi/sdk.gen.mjs +1399 -0
- package/dist/generated/mapi/sdk.gen.mjs.map +1 -0
- package/dist/generated/mapi/types-aliased.gen.d.cts +1598 -0
- package/dist/generated/mapi/types-aliased.gen.d.mts +1598 -0
- package/dist/generated/mapi/types.gen.d.cts +5075 -0
- package/dist/generated/mapi/types.gen.d.mts +5075 -0
- package/dist/generated/{components/types.gen.d.cts → overlay/_internal.gen.d.cts} +281 -457
- package/dist/generated/{components/types.gen.d.mts → overlay/_internal.gen.d.mts} +281 -457
- package/dist/generated/types/_utils.d.cts +7 -0
- package/dist/generated/types/_utils.d.mts +7 -0
- package/dist/generated/types/block.d.cts +49 -0
- package/dist/generated/types/block.d.mts +49 -0
- package/dist/generated/types/field.d.cts +87 -0
- package/dist/generated/types/field.d.mts +87 -0
- package/dist/generated/types/mapi-story.d.cts +29 -0
- package/dist/generated/types/mapi-story.d.mts +29 -0
- package/dist/index.d.cts +8 -4
- package/dist/index.d.mts +8 -4
- package/dist/resources/asset-folders.cjs +9 -9
- package/dist/resources/asset-folders.cjs.map +1 -1
- package/dist/resources/asset-folders.mjs +9 -9
- package/dist/resources/asset-folders.mjs.map +1 -1
- package/dist/resources/assets.cjs +64 -46
- package/dist/resources/assets.cjs.map +1 -1
- package/dist/resources/assets.d.cts +23 -28
- package/dist/resources/assets.d.mts +23 -28
- package/dist/resources/assets.mjs +64 -46
- package/dist/resources/assets.mjs.map +1 -1
- package/dist/resources/component-folders.cjs +9 -9
- package/dist/resources/component-folders.cjs.map +1 -1
- package/dist/resources/component-folders.mjs +9 -9
- package/dist/resources/component-folders.mjs.map +1 -1
- package/dist/resources/components.cjs +28 -20
- package/dist/resources/components.cjs.map +1 -1
- package/dist/resources/components.d.cts +76 -0
- package/dist/resources/components.d.mts +76 -0
- package/dist/resources/components.mjs +28 -20
- package/dist/resources/components.mjs.map +1 -1
- package/dist/resources/datasource-entries.cjs +28 -34
- package/dist/resources/datasource-entries.cjs.map +1 -1
- package/dist/resources/datasource-entries.mjs +29 -35
- package/dist/resources/datasource-entries.mjs.map +1 -1
- package/dist/resources/datasources.cjs +27 -9
- package/dist/resources/datasources.cjs.map +1 -1
- package/dist/resources/datasources.mjs +27 -9
- package/dist/resources/datasources.mjs.map +1 -1
- package/dist/resources/experiments.cjs +299 -0
- package/dist/resources/experiments.cjs.map +1 -0
- package/dist/resources/experiments.mjs +299 -0
- package/dist/resources/experiments.mjs.map +1 -0
- package/dist/resources/internal-tags.cjs +7 -7
- package/dist/resources/internal-tags.cjs.map +1 -1
- package/dist/resources/internal-tags.mjs +7 -7
- package/dist/resources/internal-tags.mjs.map +1 -1
- package/dist/resources/presets.cjs +9 -9
- package/dist/resources/presets.cjs.map +1 -1
- package/dist/resources/presets.mjs +9 -9
- package/dist/resources/presets.mjs.map +1 -1
- package/dist/resources/shared.cjs +15 -0
- package/dist/resources/shared.cjs.map +1 -1
- package/dist/resources/shared.mjs +15 -1
- package/dist/resources/shared.mjs.map +1 -1
- package/dist/resources/spaces.cjs +8 -7
- package/dist/resources/spaces.cjs.map +1 -1
- package/dist/resources/spaces.d.cts +8 -0
- package/dist/resources/spaces.d.mts +7 -0
- package/dist/resources/spaces.mjs +8 -7
- package/dist/resources/spaces.mjs.map +1 -1
- package/dist/resources/stories.cjs +20 -16
- package/dist/resources/stories.cjs.map +1 -1
- package/dist/resources/stories.d.cts +30 -42
- package/dist/resources/stories.d.mts +30 -42
- package/dist/resources/stories.mjs +20 -16
- package/dist/resources/stories.mjs.map +1 -1
- package/dist/resources/users.cjs +3 -3
- package/dist/resources/users.cjs.map +1 -1
- package/dist/resources/users.mjs +3 -3
- package/dist/resources/users.mjs.map +1 -1
- package/dist/utils/query-serializer.cjs +54 -0
- package/dist/utils/query-serializer.cjs.map +1 -0
- package/dist/utils/query-serializer.mjs +54 -0
- package/dist/utils/query-serializer.mjs.map +1 -0
- package/dist/utils/rate-limit.cjs +15 -74
- package/dist/utils/rate-limit.cjs.map +1 -1
- package/dist/utils/rate-limit.d.cts +5 -6
- package/dist/utils/rate-limit.d.mts +5 -6
- package/dist/utils/rate-limit.mjs +15 -74
- package/dist/utils/rate-limit.mjs.map +1 -1
- package/package.json +13 -13
- package/playground/integration-tests/README.md +24 -0
- package/playground/integration-tests/eslint.config.js +5 -0
- package/playground/integration-tests/node_modules/.bin/eslint +16 -0
- package/playground/integration-tests/node_modules/.bin/tsc +16 -0
- package/playground/integration-tests/node_modules/.bin/tsserver +16 -0
- package/playground/integration-tests/node_modules/.bin/vitest +16 -0
- package/playground/integration-tests/package.json +24 -0
- package/{test → playground/integration-tests/test}/setup.e2e.ts +2 -2
- package/{test → playground/integration-tests/test}/specs/mapi-round-trip.spec.e2e.ts +31 -41
- package/playground/integration-tests/test/types/components.test-d.ts +74 -0
- package/playground/integration-tests/test/types/resources.test-d.ts +212 -0
- package/playground/integration-tests/test/types/stories.test-d.ts +273 -0
- package/{vitest.config.e2e.ts → playground/integration-tests/vitest.config.e2e.ts} +1 -2
- package/playground/integration-tests/vitest.config.ts +13 -0
- package/test/GUIDE.md +4 -4
- package/vitest.config.ts +2 -0
- package/dist/generated/asset_folders/client.gen.cjs +0 -10
- package/dist/generated/asset_folders/client.gen.cjs.map +0 -1
- package/dist/generated/asset_folders/client.gen.mjs +0 -10
- package/dist/generated/asset_folders/client.gen.mjs.map +0 -1
- package/dist/generated/asset_folders/sdk.gen.cjs +0 -99
- package/dist/generated/asset_folders/sdk.gen.cjs.map +0 -1
- package/dist/generated/asset_folders/sdk.gen.mjs +0 -95
- package/dist/generated/asset_folders/sdk.gen.mjs.map +0 -1
- package/dist/generated/asset_folders/types.gen.d.cts +0 -130
- package/dist/generated/asset_folders/types.gen.d.mts +0 -130
- package/dist/generated/assets/client.gen.cjs +0 -10
- package/dist/generated/assets/client.gen.cjs.map +0 -1
- package/dist/generated/assets/client.gen.mjs +0 -10
- package/dist/generated/assets/client.gen.mjs.map +0 -1
- package/dist/generated/assets/sdk.gen.cjs +0 -179
- package/dist/generated/assets/sdk.gen.cjs.map +0 -1
- package/dist/generated/assets/sdk.gen.mjs +0 -171
- package/dist/generated/assets/sdk.gen.mjs.map +0 -1
- package/dist/generated/assets/types.gen.d.cts +0 -343
- package/dist/generated/assets/types.gen.d.mts +0 -343
- package/dist/generated/component_folders/client.gen.cjs +0 -10
- package/dist/generated/component_folders/client.gen.cjs.map +0 -1
- package/dist/generated/component_folders/client.gen.mjs +0 -10
- package/dist/generated/component_folders/client.gen.mjs.map +0 -1
- package/dist/generated/component_folders/sdk.gen.cjs +0 -99
- package/dist/generated/component_folders/sdk.gen.cjs.map +0 -1
- package/dist/generated/component_folders/sdk.gen.mjs +0 -95
- package/dist/generated/component_folders/sdk.gen.mjs.map +0 -1
- package/dist/generated/component_folders/types.gen.d.cts +0 -102
- package/dist/generated/component_folders/types.gen.d.mts +0 -102
- package/dist/generated/components/client.gen.cjs +0 -10
- package/dist/generated/components/client.gen.cjs.map +0 -1
- package/dist/generated/components/client.gen.mjs +0 -10
- package/dist/generated/components/client.gen.mjs.map +0 -1
- package/dist/generated/components/sdk.gen.cjs +0 -171
- package/dist/generated/components/sdk.gen.cjs.map +0 -1
- package/dist/generated/components/sdk.gen.mjs +0 -163
- package/dist/generated/components/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/client.gen.cjs +0 -10
- package/dist/generated/datasource_entries/client.gen.cjs.map +0 -1
- package/dist/generated/datasource_entries/client.gen.mjs +0 -10
- package/dist/generated/datasource_entries/client.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/sdk.gen.cjs +0 -89
- package/dist/generated/datasource_entries/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasource_entries/sdk.gen.mjs +0 -85
- package/dist/generated/datasource_entries/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/types.gen.d.cts +0 -130
- package/dist/generated/datasource_entries/types.gen.d.mts +0 -130
- package/dist/generated/datasources/client.gen.cjs +0 -10
- package/dist/generated/datasources/client.gen.cjs.map +0 -1
- package/dist/generated/datasources/client.gen.mjs +0 -10
- package/dist/generated/datasources/client.gen.mjs.map +0 -1
- package/dist/generated/datasources/sdk.gen.cjs +0 -89
- package/dist/generated/datasources/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasources/sdk.gen.mjs +0 -85
- package/dist/generated/datasources/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasources/types.gen.d.cts +0 -165
- package/dist/generated/datasources/types.gen.d.mts +0 -165
- package/dist/generated/internal_tags/client.gen.cjs +0 -10
- package/dist/generated/internal_tags/client.gen.cjs.map +0 -1
- package/dist/generated/internal_tags/client.gen.mjs +0 -10
- package/dist/generated/internal_tags/client.gen.mjs.map +0 -1
- package/dist/generated/internal_tags/sdk.gen.cjs +0 -74
- package/dist/generated/internal_tags/sdk.gen.cjs.map +0 -1
- package/dist/generated/internal_tags/sdk.gen.mjs +0 -71
- package/dist/generated/internal_tags/sdk.gen.mjs.map +0 -1
- package/dist/generated/internal_tags/types.gen.d.cts +0 -102
- package/dist/generated/internal_tags/types.gen.d.mts +0 -102
- package/dist/generated/presets/client.gen.cjs +0 -10
- package/dist/generated/presets/client.gen.cjs.map +0 -1
- package/dist/generated/presets/client.gen.mjs +0 -10
- package/dist/generated/presets/client.gen.mjs.map +0 -1
- package/dist/generated/presets/sdk.gen.cjs +0 -99
- package/dist/generated/presets/sdk.gen.cjs.map +0 -1
- package/dist/generated/presets/sdk.gen.mjs +0 -95
- package/dist/generated/presets/sdk.gen.mjs.map +0 -1
- package/dist/generated/presets/types.gen.d.cts +0 -171
- package/dist/generated/presets/types.gen.d.mts +0 -171
- package/dist/generated/shared/client/client.gen.cjs.map +0 -1
- package/dist/generated/shared/client/client.gen.mjs.map +0 -1
- package/dist/generated/shared/client/utils.gen.cjs.map +0 -1
- package/dist/generated/shared/client/utils.gen.mjs.map +0 -1
- package/dist/generated/shared/core/auth.gen.cjs.map +0 -1
- package/dist/generated/shared/core/auth.gen.mjs.map +0 -1
- package/dist/generated/shared/core/bodySerializer.gen.cjs.map +0 -1
- package/dist/generated/shared/core/bodySerializer.gen.mjs.map +0 -1
- package/dist/generated/shared/core/params.gen.cjs.map +0 -1
- package/dist/generated/shared/core/params.gen.mjs.map +0 -1
- package/dist/generated/shared/core/pathSerializer.gen.cjs.map +0 -1
- package/dist/generated/shared/core/pathSerializer.gen.mjs.map +0 -1
- package/dist/generated/shared/core/serverSentEvents.gen.cjs.map +0 -1
- package/dist/generated/shared/core/serverSentEvents.gen.mjs.map +0 -1
- package/dist/generated/shared/core/utils.gen.cjs.map +0 -1
- package/dist/generated/shared/core/utils.gen.mjs.map +0 -1
- package/dist/generated/spaces/client.gen.cjs +0 -10
- package/dist/generated/spaces/client.gen.cjs.map +0 -1
- package/dist/generated/spaces/client.gen.mjs +0 -10
- package/dist/generated/spaces/client.gen.mjs.map +0 -1
- package/dist/generated/spaces/sdk.gen.cjs +0 -99
- package/dist/generated/spaces/sdk.gen.cjs.map +0 -1
- package/dist/generated/spaces/sdk.gen.mjs +0 -95
- package/dist/generated/spaces/sdk.gen.mjs.map +0 -1
- package/dist/generated/spaces/types.gen.d.cts +0 -504
- package/dist/generated/spaces/types.gen.d.mts +0 -504
- package/dist/generated/stories/client.gen.cjs +0 -10
- package/dist/generated/stories/client.gen.cjs.map +0 -1
- package/dist/generated/stories/client.gen.mjs +0 -10
- package/dist/generated/stories/client.gen.mjs.map +0 -1
- package/dist/generated/stories/sdk.gen.cjs +0 -138
- package/dist/generated/stories/sdk.gen.cjs.map +0 -1
- package/dist/generated/stories/sdk.gen.mjs +0 -131
- package/dist/generated/stories/sdk.gen.mjs.map +0 -1
- package/dist/generated/stories/types.gen.d.cts +0 -1314
- package/dist/generated/stories/types.gen.d.mts +0 -1314
- package/dist/generated/users/client.gen.cjs +0 -10
- package/dist/generated/users/client.gen.cjs.map +0 -1
- package/dist/generated/users/client.gen.mjs +0 -10
- package/dist/generated/users/client.gen.mjs.map +0 -1
- package/dist/generated/users/sdk.gen.cjs +0 -44
- package/dist/generated/users/sdk.gen.cjs.map +0 -1
- package/dist/generated/users/sdk.gen.mjs +0 -43
- package/dist/generated/users/sdk.gen.mjs.map +0 -1
- package/dist/generated/users/types.gen.d.cts +0 -249
- package/dist/generated/users/types.gen.d.mts +0 -249
- /package/dist/generated/{shared → mapi}/client/client.gen.d.mts +0 -0
- /package/dist/generated/{shared → mapi}/client/index.cjs +0 -0
- /package/dist/generated/{shared → mapi}/client/index.d.mts +0 -0
- /package/dist/generated/{shared → mapi}/client/index.mjs +0 -0
package/dist/client.d.cts
CHANGED
|
@@ -1,22 +1,14 @@
|
|
|
1
|
-
import { AssetFolder,
|
|
1
|
+
import { ActivateExperimentData, ActivateExperimentResponses, Asset, AssetFolder, AssetUpdateRequest, BulkDestroyAssetsData, BulkRestoreAssetsData, BulkUpdateAssetsData, CompleteExperimentResponses, CompleteExperimentWithWinnerResponses, ComponentGroup, CreateAsset, CreateAssetData, CreateAssetFolderData, CreateComponentGroupData, CreateDatasourceData, CreateDatasourceEntryData, CreateExperimentData, CreateExperimentResponses, CreateExperimentStoryData, CreateExperimentStoryResponses, CreateInternalTagData, CreatePresetData, CreateSpaceData, CreateStoryMappingData, CreateStoryMappingResponses, Datasource, DatasourceEntriesIndexResponse, DatasourceEntryShowResponse, DeleteAssetFolderData, DeleteExperimentResponses, DeleteExperimentStoryResponses, DeleteStoryMappingResponses, FinishUploadAsset, GetExperimentResponses, GetExperimentResultsResponses, InternalTag, ListAssetFoldersData, ListAssetsData, ListComponentGroupsData, ListDatasourceEntriesData, ListDatasourcesData, ListExperimentsData, ListExperimentsResponses, ListInternalTagsData, ListPresetsData, ListSpacesData, PartialUpdateDatasourceData, PartialUpdateDatasourceEntryData, PauseExperimentResponses, Preset, PushExperimentResultsData, PushExperimentResultsResponses, ReplaceDatasourceData, ReplaceDatasourceEntryData, SelectExperimentWinnerResponses, ShowAsset, Space, SpaceDetail, UpdateAssetData, UpdateAssetFolderData, UpdateComponentGroupData, UpdateCurrentUserData, UpdateExperimentData, UpdateExperimentResponses, UpdateInternalTagData, UpdatePresetData, UpdateSpaceData, User } from "./generated/mapi/types.gen.cjs";
|
|
2
|
+
import { Middleware } from "./generated/mapi/client/utils.gen.cjs";
|
|
3
|
+
import { Client, ResolvedRequestOptions, RetryOptions } from "./generated/mapi/client/types.gen.cjs";
|
|
2
4
|
import { SpaceIdPathOverride } from "./resources/shared.cjs";
|
|
3
|
-
import { Asset
|
|
4
|
-
import { AssetCreate, AssetUploadRequest } from "./resources/assets.cjs";
|
|
5
|
-
import {
|
|
6
|
-
import { Component, ComponentCreate, ComponentUpdate, ListData as ListData$3, RestoreVersionData, VersionData, VersionsData } from "./generated/components/types.gen.cjs";
|
|
7
|
-
import { CreateData as CreateData$2, DatasourceEntry, ListData as ListData$4, UpdateData as UpdateData$3 } from "./generated/datasource_entries/types.gen.cjs";
|
|
8
|
-
import { CreateData as CreateData$3, Datasource, ListData as ListData$5, UpdateData as UpdateData$4 } from "./generated/datasources/types.gen.cjs";
|
|
9
|
-
import { CreateData as CreateData$4, InternalTag, ListData as ListData$6, UpdateData as UpdateData$5 } from "./generated/internal_tags/types.gen.cjs";
|
|
10
|
-
import { CreateData as CreateData$5, ListData as ListData$7, Preset, UpdateData as UpdateData$6 } from "./generated/presets/types.gen.cjs";
|
|
11
|
-
import { CreateData as CreateData$6, ListData as ListData$8, Space, UpdateData as UpdateData$7 } from "./generated/spaces/types.gen.cjs";
|
|
12
|
-
import { UpdateMeData, User } from "./generated/users/types.gen.cjs";
|
|
13
|
-
import { Middleware } from "./generated/shared/client/utils.gen.cjs";
|
|
14
|
-
import { Client, ResolvedRequestOptions, RetryOptions } from "./generated/shared/client/types.gen.cjs";
|
|
5
|
+
import { Asset as Asset$1 } from "./generated/mapi/types-aliased.gen.cjs";
|
|
6
|
+
import { AssetCreate, AssetUploadRequest, ListAssetsResult } from "./resources/assets.cjs";
|
|
7
|
+
import { Block } from "./generated/types/block.cjs";
|
|
15
8
|
import { ClientError } from "./error.cjs";
|
|
16
9
|
import { RateLimitConfig } from "./utils/rate-limit.cjs";
|
|
10
|
+
import { createComponentsResource } from "./resources/components.cjs";
|
|
17
11
|
import { createStoriesResource } from "./resources/stories.cjs";
|
|
18
|
-
import * as _storyblok_schema0 from "@storyblok/schema";
|
|
19
|
-
import { Block } from "@storyblok/schema";
|
|
20
12
|
import { Region } from "@storyblok/region-helper";
|
|
21
13
|
|
|
22
14
|
//#region src/client.d.ts
|
|
@@ -129,36 +121,36 @@ type ManagementApiClientConfig<ThrowOnError extends boolean = false> = TokenConf
|
|
|
129
121
|
declare function buildResources<DefaultThrowOnError extends boolean = false>(deps: MapiResourceDeps<DefaultThrowOnError>, client: Client): {
|
|
130
122
|
assetFolders: {
|
|
131
123
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
132
|
-
query?:
|
|
124
|
+
query?: ListAssetFoldersData["query"];
|
|
133
125
|
signal?: AbortSignal;
|
|
134
126
|
throwOnError?: ThrowOnError | undefined;
|
|
135
127
|
fetchOptions?: FetchOptions;
|
|
136
128
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
137
|
-
asset_folders
|
|
129
|
+
asset_folders: Array<AssetFolder>;
|
|
138
130
|
}, ThrowOnError>>;
|
|
139
|
-
get<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number
|
|
131
|
+
get<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
|
|
140
132
|
signal?: AbortSignal;
|
|
141
133
|
throwOnError?: ThrowOnError | undefined;
|
|
142
134
|
fetchOptions?: FetchOptions;
|
|
143
135
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
144
|
-
asset_folder
|
|
136
|
+
asset_folder: AssetFolder;
|
|
145
137
|
}, ThrowOnError>>;
|
|
146
138
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
147
|
-
body:
|
|
139
|
+
body: CreateAssetFolderData["body"];
|
|
148
140
|
signal?: AbortSignal;
|
|
149
141
|
throwOnError?: ThrowOnError | undefined;
|
|
150
142
|
fetchOptions?: FetchOptions;
|
|
151
143
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
152
|
-
asset_folder
|
|
144
|
+
asset_folder: AssetFolder;
|
|
153
145
|
}, ThrowOnError>>;
|
|
154
|
-
update<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number
|
|
155
|
-
body:
|
|
146
|
+
update<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options: {
|
|
147
|
+
body: UpdateAssetFolderData["body"];
|
|
156
148
|
signal?: AbortSignal;
|
|
157
149
|
throwOnError?: ThrowOnError | undefined;
|
|
158
150
|
fetchOptions?: FetchOptions;
|
|
159
151
|
} & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
|
|
160
|
-
delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number
|
|
161
|
-
query?:
|
|
152
|
+
delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
|
|
153
|
+
query?: DeleteAssetFolderData["query"];
|
|
162
154
|
signal?: AbortSignal;
|
|
163
155
|
throwOnError?: ThrowOnError | undefined;
|
|
164
156
|
fetchOptions?: FetchOptions;
|
|
@@ -166,38 +158,36 @@ declare function buildResources<DefaultThrowOnError extends boolean = false>(dep
|
|
|
166
158
|
};
|
|
167
159
|
assets: {
|
|
168
160
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
169
|
-
query?:
|
|
161
|
+
query?: ListAssetsData["query"];
|
|
170
162
|
signal?: AbortSignal;
|
|
171
163
|
throwOnError?: ThrowOnError | undefined;
|
|
172
164
|
fetchOptions?: FetchOptions;
|
|
173
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
174
|
-
assets?: Array<Asset>;
|
|
175
|
-
}, ThrowOnError>>;
|
|
165
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<ListAssetsResult, ThrowOnError>>;
|
|
176
166
|
signResponseObject<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
177
|
-
|
|
167
|
+
query: CreateAssetData["query"];
|
|
178
168
|
signal?: AbortSignal;
|
|
179
169
|
throwOnError?: ThrowOnError | undefined;
|
|
180
170
|
fetchOptions?: FetchOptions;
|
|
181
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
171
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CreateAsset, ThrowOnError>>;
|
|
182
172
|
upload(options: {
|
|
183
173
|
body: AssetUploadRequest;
|
|
184
174
|
file: Blob | ArrayBuffer;
|
|
185
175
|
signal?: AbortSignal;
|
|
186
176
|
fetchOptions?: FetchOptions;
|
|
187
|
-
} & SpaceIdPathOverride): Promise<Asset>;
|
|
177
|
+
} & SpaceIdPathOverride): Promise<Asset$1>;
|
|
188
178
|
create(options: {
|
|
189
179
|
body: AssetCreate;
|
|
190
180
|
file: Blob | ArrayBuffer;
|
|
191
181
|
signal?: AbortSignal;
|
|
192
182
|
fetchOptions?: FetchOptions;
|
|
193
|
-
} & SpaceIdPathOverride): Promise<Asset>;
|
|
194
|
-
get<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number
|
|
183
|
+
} & SpaceIdPathOverride): Promise<Asset$1>;
|
|
184
|
+
get<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
|
|
195
185
|
signal?: AbortSignal;
|
|
196
186
|
throwOnError?: ThrowOnError | undefined;
|
|
197
187
|
fetchOptions?: FetchOptions;
|
|
198
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
199
|
-
update(assetId: number
|
|
200
|
-
body:
|
|
188
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<ShowAsset, ThrowOnError>>;
|
|
189
|
+
update(assetId: number, options: ({
|
|
190
|
+
body: UpdateAssetData["body"];
|
|
201
191
|
file?: undefined;
|
|
202
192
|
} | {
|
|
203
193
|
body: AssetUpdateRequest & {
|
|
@@ -208,200 +198,113 @@ declare function buildResources<DefaultThrowOnError extends boolean = false>(dep
|
|
|
208
198
|
signal?: AbortSignal;
|
|
209
199
|
fetchOptions?: FetchOptions;
|
|
210
200
|
} & SpaceIdPathOverride): Promise<void>;
|
|
211
|
-
delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number
|
|
201
|
+
delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
|
|
212
202
|
signal?: AbortSignal;
|
|
213
203
|
throwOnError?: ThrowOnError | undefined;
|
|
214
204
|
fetchOptions?: FetchOptions;
|
|
215
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
216
|
-
|
|
217
|
-
}, ThrowOnError>>;
|
|
218
|
-
finalize<ThrowOnError extends boolean = DefaultThrowOnError>(signedResponseObjectId: string, options?: {
|
|
205
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<Asset, ThrowOnError>>;
|
|
206
|
+
finalize<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
|
|
219
207
|
signal?: AbortSignal;
|
|
220
208
|
throwOnError?: ThrowOnError | undefined;
|
|
221
209
|
fetchOptions?: FetchOptions;
|
|
222
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
223
|
-
message?: string;
|
|
224
|
-
}, ThrowOnError>>;
|
|
210
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<FinishUploadAsset, ThrowOnError>>;
|
|
225
211
|
deleteMany<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
226
|
-
body:
|
|
212
|
+
body: BulkDestroyAssetsData["body"];
|
|
227
213
|
signal?: AbortSignal;
|
|
228
214
|
throwOnError?: ThrowOnError | undefined;
|
|
229
215
|
fetchOptions?: FetchOptions;
|
|
230
216
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
231
|
-
message
|
|
217
|
+
message: string;
|
|
232
218
|
}, ThrowOnError>>;
|
|
233
219
|
bulkMove<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
234
|
-
body:
|
|
220
|
+
body: BulkUpdateAssetsData["body"];
|
|
235
221
|
signal?: AbortSignal;
|
|
236
222
|
throwOnError?: ThrowOnError | undefined;
|
|
237
223
|
fetchOptions?: FetchOptions;
|
|
238
224
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
239
|
-
message
|
|
225
|
+
message: string;
|
|
240
226
|
}, ThrowOnError>>;
|
|
241
227
|
bulkRestore<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
242
|
-
body:
|
|
243
|
-
signal?: AbortSignal;
|
|
244
|
-
throwOnError?: ThrowOnError | undefined;
|
|
245
|
-
fetchOptions?: FetchOptions;
|
|
246
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
247
|
-
message?: string;
|
|
248
|
-
}, ThrowOnError>>;
|
|
249
|
-
};
|
|
250
|
-
componentFolders: {
|
|
251
|
-
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
252
|
-
query?: ListData$2["query"];
|
|
228
|
+
body: BulkRestoreAssetsData["body"];
|
|
253
229
|
signal?: AbortSignal;
|
|
254
230
|
throwOnError?: ThrowOnError | undefined;
|
|
255
231
|
fetchOptions?: FetchOptions;
|
|
256
232
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
257
|
-
|
|
233
|
+
message: string;
|
|
258
234
|
}, ThrowOnError>>;
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
264
|
-
component_group?: ComponentFolder;
|
|
265
|
-
}, ThrowOnError>>;
|
|
266
|
-
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
267
|
-
body: CreateData$1["body"];
|
|
268
|
-
signal?: AbortSignal;
|
|
269
|
-
throwOnError?: ThrowOnError | undefined;
|
|
270
|
-
fetchOptions?: FetchOptions;
|
|
271
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
272
|
-
component_group?: ComponentFolder;
|
|
273
|
-
}, ThrowOnError>>;
|
|
274
|
-
update<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number | string, options: {
|
|
275
|
-
body: UpdateData$2["body"];
|
|
276
|
-
signal?: AbortSignal;
|
|
277
|
-
throwOnError?: ThrowOnError | undefined;
|
|
278
|
-
fetchOptions?: FetchOptions;
|
|
279
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
280
|
-
component_group?: ComponentFolder;
|
|
281
|
-
}, ThrowOnError>>;
|
|
282
|
-
delete<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number | string, options?: {
|
|
235
|
+
convertToShared<ThrowOnError extends boolean = false>(assetId: number | string, options: {
|
|
236
|
+
query: {
|
|
237
|
+
target_asset_folder_id: number;
|
|
238
|
+
};
|
|
283
239
|
signal?: AbortSignal;
|
|
284
240
|
throwOnError?: ThrowOnError | undefined;
|
|
285
241
|
fetchOptions?: FetchOptions;
|
|
286
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
242
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<Asset$1, ThrowOnError>>;
|
|
287
243
|
};
|
|
288
|
-
|
|
244
|
+
componentFolders: {
|
|
289
245
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
290
|
-
query?:
|
|
246
|
+
query?: ListComponentGroupsData["query"];
|
|
291
247
|
signal?: AbortSignal;
|
|
292
248
|
throwOnError?: ThrowOnError | undefined;
|
|
293
249
|
fetchOptions?: FetchOptions;
|
|
294
250
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
295
|
-
|
|
251
|
+
component_groups: Array<ComponentGroup>;
|
|
296
252
|
}, ThrowOnError>>;
|
|
297
|
-
get<ThrowOnError extends boolean = DefaultThrowOnError>(
|
|
253
|
+
get<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
|
|
298
254
|
signal?: AbortSignal;
|
|
299
255
|
throwOnError?: ThrowOnError | undefined;
|
|
300
256
|
fetchOptions?: FetchOptions;
|
|
301
257
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
302
|
-
|
|
258
|
+
component_group: ComponentGroup;
|
|
303
259
|
}, ThrowOnError>>;
|
|
304
260
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
305
|
-
body:
|
|
306
|
-
component?: ComponentCreate;
|
|
307
|
-
}, "component"> & {
|
|
308
|
-
component?: _storyblok_schema0.ComponentCreate;
|
|
309
|
-
};
|
|
261
|
+
body: CreateComponentGroupData["body"];
|
|
310
262
|
signal?: AbortSignal;
|
|
311
263
|
throwOnError?: ThrowOnError | undefined;
|
|
312
264
|
fetchOptions?: FetchOptions;
|
|
313
265
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
314
|
-
|
|
266
|
+
component_group: ComponentGroup;
|
|
315
267
|
}, ThrowOnError>>;
|
|
316
|
-
update<ThrowOnError extends boolean = DefaultThrowOnError>(
|
|
317
|
-
body:
|
|
318
|
-
component?: ComponentUpdate;
|
|
319
|
-
update_content?: boolean;
|
|
320
|
-
}, "component"> & {
|
|
321
|
-
component?: _storyblok_schema0.ComponentUpdate;
|
|
322
|
-
};
|
|
268
|
+
update<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options: {
|
|
269
|
+
body: UpdateComponentGroupData["body"];
|
|
323
270
|
signal?: AbortSignal;
|
|
324
271
|
throwOnError?: ThrowOnError | undefined;
|
|
325
272
|
fetchOptions?: FetchOptions;
|
|
326
273
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
327
|
-
|
|
274
|
+
component_group: ComponentGroup;
|
|
328
275
|
}, ThrowOnError>>;
|
|
329
|
-
delete<ThrowOnError extends boolean = DefaultThrowOnError>(
|
|
276
|
+
delete<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
|
|
330
277
|
signal?: AbortSignal;
|
|
331
278
|
throwOnError?: ThrowOnError | undefined;
|
|
332
279
|
fetchOptions?: FetchOptions;
|
|
333
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
334
|
-
component?: Component;
|
|
335
|
-
}, ThrowOnError>>;
|
|
336
|
-
restore<ThrowOnError extends boolean = DefaultThrowOnError>(componentId: number | string, options?: {
|
|
337
|
-
signal?: AbortSignal;
|
|
338
|
-
throwOnError?: ThrowOnError | undefined;
|
|
339
|
-
fetchOptions?: FetchOptions;
|
|
340
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
341
|
-
component?: Component;
|
|
342
|
-
}, ThrowOnError>>;
|
|
343
|
-
versions<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
344
|
-
query?: VersionsData["query"];
|
|
345
|
-
signal?: AbortSignal;
|
|
346
|
-
throwOnError?: ThrowOnError | undefined;
|
|
347
|
-
fetchOptions?: FetchOptions;
|
|
348
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
349
|
-
versions?: Array<{
|
|
350
|
-
id?: number;
|
|
351
|
-
event?: string;
|
|
352
|
-
created_at?: string;
|
|
353
|
-
author_id?: number;
|
|
354
|
-
item_id?: number;
|
|
355
|
-
author?: string;
|
|
356
|
-
is_draft?: boolean;
|
|
357
|
-
}>;
|
|
358
|
-
}, ThrowOnError>>;
|
|
359
|
-
version<ThrowOnError extends boolean = DefaultThrowOnError>(componentId: number | string, versionId: VersionData["path"]["version_id"], options?: {
|
|
360
|
-
signal?: AbortSignal;
|
|
361
|
-
throwOnError?: ThrowOnError | undefined;
|
|
362
|
-
fetchOptions?: FetchOptions;
|
|
363
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
364
|
-
component_version?: {
|
|
365
|
-
schema?: {
|
|
366
|
-
[key: string]: unknown;
|
|
367
|
-
};
|
|
368
|
-
};
|
|
369
|
-
}, ThrowOnError>>;
|
|
370
|
-
restoreVersion<ThrowOnError extends boolean = DefaultThrowOnError>(versionId: RestoreVersionData["path"]["version_id"], options: {
|
|
371
|
-
body: RestoreVersionData["body"];
|
|
372
|
-
signal?: AbortSignal;
|
|
373
|
-
throwOnError?: ThrowOnError | undefined;
|
|
374
|
-
fetchOptions?: FetchOptions;
|
|
375
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
376
|
-
component?: Component;
|
|
377
|
-
}, ThrowOnError>>;
|
|
280
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
|
|
378
281
|
};
|
|
379
282
|
datasourceEntries: {
|
|
380
283
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
381
|
-
query?:
|
|
284
|
+
query?: ListDatasourceEntriesData["query"];
|
|
382
285
|
signal?: AbortSignal;
|
|
383
286
|
throwOnError?: ThrowOnError | undefined;
|
|
384
287
|
fetchOptions?: FetchOptions;
|
|
385
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
386
|
-
datasource_entries?: Array<DatasourceEntry>;
|
|
387
|
-
}, ThrowOnError>>;
|
|
288
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntriesIndexResponse, ThrowOnError>>;
|
|
388
289
|
get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options?: {
|
|
389
290
|
signal?: AbortSignal;
|
|
390
291
|
throwOnError?: ThrowOnError | undefined;
|
|
391
292
|
fetchOptions?: FetchOptions;
|
|
392
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
393
|
-
datasource_entry?: DatasourceEntry;
|
|
394
|
-
}, ThrowOnError>>;
|
|
293
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
|
|
395
294
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
396
|
-
body:
|
|
295
|
+
body: CreateDatasourceEntryData["body"];
|
|
397
296
|
signal?: AbortSignal;
|
|
398
297
|
throwOnError?: ThrowOnError | undefined;
|
|
399
298
|
fetchOptions?: FetchOptions;
|
|
400
|
-
} & SpaceIdPathOverride): Promise<ApiResponse<
|
|
401
|
-
datasource_entry?: DatasourceEntry;
|
|
402
|
-
}, ThrowOnError>>;
|
|
299
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
|
|
403
300
|
update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options: {
|
|
404
|
-
body:
|
|
301
|
+
body: PartialUpdateDatasourceEntryData["body"];
|
|
302
|
+
signal?: AbortSignal;
|
|
303
|
+
throwOnError?: ThrowOnError | undefined;
|
|
304
|
+
fetchOptions?: FetchOptions;
|
|
305
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
|
|
306
|
+
replace<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options: {
|
|
307
|
+
body: ReplaceDatasourceEntryData["body"];
|
|
405
308
|
signal?: AbortSignal;
|
|
406
309
|
throwOnError?: ThrowOnError | undefined;
|
|
407
310
|
fetchOptions?: FetchOptions;
|
|
@@ -414,70 +317,178 @@ declare function buildResources<DefaultThrowOnError extends boolean = false>(dep
|
|
|
414
317
|
};
|
|
415
318
|
datasources: {
|
|
416
319
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
417
|
-
query?:
|
|
320
|
+
query?: ListDatasourcesData["query"];
|
|
418
321
|
signal?: AbortSignal;
|
|
419
322
|
throwOnError?: ThrowOnError | undefined;
|
|
420
323
|
fetchOptions?: FetchOptions;
|
|
421
324
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
422
|
-
datasources
|
|
325
|
+
datasources: Array<Datasource>;
|
|
423
326
|
}, ThrowOnError>>;
|
|
424
|
-
get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number, options?: {
|
|
327
|
+
get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options?: {
|
|
425
328
|
signal?: AbortSignal;
|
|
426
329
|
throwOnError?: ThrowOnError | undefined;
|
|
427
330
|
fetchOptions?: FetchOptions;
|
|
428
331
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
429
|
-
datasource
|
|
332
|
+
datasource: Datasource;
|
|
430
333
|
}, ThrowOnError>>;
|
|
431
334
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
432
|
-
body:
|
|
335
|
+
body: CreateDatasourceData["body"];
|
|
433
336
|
signal?: AbortSignal;
|
|
434
337
|
throwOnError?: ThrowOnError | undefined;
|
|
435
338
|
fetchOptions?: FetchOptions;
|
|
436
339
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
437
|
-
datasource
|
|
340
|
+
datasource: Datasource;
|
|
438
341
|
}, ThrowOnError>>;
|
|
439
|
-
update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number, options: {
|
|
440
|
-
body:
|
|
342
|
+
update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options: {
|
|
343
|
+
body: PartialUpdateDatasourceData["body"];
|
|
441
344
|
signal?: AbortSignal;
|
|
442
345
|
throwOnError?: ThrowOnError | undefined;
|
|
443
346
|
fetchOptions?: FetchOptions;
|
|
444
347
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
445
|
-
datasource
|
|
348
|
+
datasource: Datasource;
|
|
446
349
|
}, ThrowOnError>>;
|
|
447
|
-
|
|
350
|
+
replace<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options: {
|
|
351
|
+
body: ReplaceDatasourceData["body"];
|
|
352
|
+
signal?: AbortSignal;
|
|
353
|
+
throwOnError?: ThrowOnError | undefined;
|
|
354
|
+
fetchOptions?: FetchOptions;
|
|
355
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
356
|
+
datasource: Datasource;
|
|
357
|
+
}, ThrowOnError>>;
|
|
358
|
+
delete<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options?: {
|
|
448
359
|
signal?: AbortSignal;
|
|
449
360
|
throwOnError?: ThrowOnError | undefined;
|
|
450
361
|
fetchOptions?: FetchOptions;
|
|
451
362
|
} & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
|
|
452
363
|
};
|
|
364
|
+
experiments: {
|
|
365
|
+
list<ThrowOnError extends boolean = false>(options?: {
|
|
366
|
+
query?: ListExperimentsData["query"];
|
|
367
|
+
signal?: AbortSignal;
|
|
368
|
+
throwOnError?: ThrowOnError;
|
|
369
|
+
fetchOptions?: FetchOptions;
|
|
370
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<ListExperimentsResponses[200], ThrowOnError>>;
|
|
371
|
+
get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
372
|
+
signal?: AbortSignal;
|
|
373
|
+
throwOnError?: ThrowOnError;
|
|
374
|
+
fetchOptions?: FetchOptions;
|
|
375
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<GetExperimentResponses[200], ThrowOnError>>;
|
|
376
|
+
create<ThrowOnError extends boolean = false>(options: {
|
|
377
|
+
body: CreateExperimentData["body"];
|
|
378
|
+
signal?: AbortSignal;
|
|
379
|
+
throwOnError?: ThrowOnError;
|
|
380
|
+
fetchOptions?: FetchOptions;
|
|
381
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentResponses[201], ThrowOnError>>;
|
|
382
|
+
update<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
|
|
383
|
+
body: UpdateExperimentData["body"];
|
|
384
|
+
signal?: AbortSignal;
|
|
385
|
+
throwOnError?: ThrowOnError;
|
|
386
|
+
fetchOptions?: FetchOptions;
|
|
387
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<UpdateExperimentResponses[200], ThrowOnError>>;
|
|
388
|
+
delete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
389
|
+
signal?: AbortSignal;
|
|
390
|
+
throwOnError?: ThrowOnError;
|
|
391
|
+
fetchOptions?: FetchOptions;
|
|
392
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentResponses[204], ThrowOnError>>;
|
|
393
|
+
activate<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
394
|
+
query?: ActivateExperimentData["query"];
|
|
395
|
+
signal?: AbortSignal;
|
|
396
|
+
throwOnError?: ThrowOnError;
|
|
397
|
+
fetchOptions?: FetchOptions;
|
|
398
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<ActivateExperimentResponses[200], ThrowOnError>>;
|
|
399
|
+
pause<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
400
|
+
signal?: AbortSignal;
|
|
401
|
+
throwOnError?: ThrowOnError;
|
|
402
|
+
fetchOptions?: FetchOptions;
|
|
403
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<PauseExperimentResponses[200], ThrowOnError>>;
|
|
404
|
+
complete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
405
|
+
signal?: AbortSignal;
|
|
406
|
+
throwOnError?: ThrowOnError;
|
|
407
|
+
fetchOptions?: FetchOptions;
|
|
408
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CompleteExperimentResponses[200], ThrowOnError>>;
|
|
409
|
+
completeWithWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
|
|
410
|
+
signal?: AbortSignal;
|
|
411
|
+
throwOnError?: ThrowOnError;
|
|
412
|
+
fetchOptions?: FetchOptions;
|
|
413
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CompleteExperimentWithWinnerResponses[200], ThrowOnError>>;
|
|
414
|
+
selectWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
|
|
415
|
+
signal?
|
|
416
|
+
/**
|
|
417
|
+
* Escape hatch: send a PUT request to any MAPI endpoint not yet wrapped
|
|
418
|
+
* in a dedicated resource method.
|
|
419
|
+
*/
|
|
420
|
+
: AbortSignal;
|
|
421
|
+
throwOnError?: ThrowOnError;
|
|
422
|
+
fetchOptions?: FetchOptions;
|
|
423
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<SelectExperimentWinnerResponses[200], ThrowOnError>>;
|
|
424
|
+
stories: {
|
|
425
|
+
create<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
|
|
426
|
+
body: CreateExperimentStoryData["body"];
|
|
427
|
+
signal?: AbortSignal;
|
|
428
|
+
throwOnError?: ThrowOnError;
|
|
429
|
+
fetchOptions?: FetchOptions;
|
|
430
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentStoryResponses[201], ThrowOnError>>;
|
|
431
|
+
delete<ThrowOnError extends boolean = false>(experimentId: number | string, storyId: number | string, options?: {
|
|
432
|
+
signal?: AbortSignal;
|
|
433
|
+
throwOnError?: ThrowOnError;
|
|
434
|
+
fetchOptions?: FetchOptions;
|
|
435
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentStoryResponses[204], ThrowOnError>>;
|
|
436
|
+
};
|
|
437
|
+
storyMappings: {
|
|
438
|
+
create<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, options: {
|
|
439
|
+
body: CreateStoryMappingData["body"];
|
|
440
|
+
signal?: AbortSignal;
|
|
441
|
+
throwOnError?: ThrowOnError;
|
|
442
|
+
fetchOptions?: FetchOptions;
|
|
443
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<CreateStoryMappingResponses[201], ThrowOnError>>;
|
|
444
|
+
delete<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, originalStoryId: number | string, options?: {
|
|
445
|
+
signal?: AbortSignal;
|
|
446
|
+
throwOnError?: ThrowOnError;
|
|
447
|
+
fetchOptions?: FetchOptions;
|
|
448
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<DeleteStoryMappingResponses[204], ThrowOnError>>;
|
|
449
|
+
};
|
|
450
|
+
results: {
|
|
451
|
+
get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
|
|
452
|
+
signal?: AbortSignal;
|
|
453
|
+
throwOnError?: ThrowOnError;
|
|
454
|
+
fetchOptions?: FetchOptions;
|
|
455
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<GetExperimentResultsResponses[200], ThrowOnError>>;
|
|
456
|
+
push<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
|
|
457
|
+
body: PushExperimentResultsData["body"];
|
|
458
|
+
signal?: AbortSignal;
|
|
459
|
+
throwOnError?: ThrowOnError;
|
|
460
|
+
fetchOptions?: FetchOptions;
|
|
461
|
+
} & SpaceIdPathOverride): Promise<ApiResponse<PushExperimentResultsResponses[200], ThrowOnError>>;
|
|
462
|
+
};
|
|
463
|
+
};
|
|
453
464
|
delete: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
|
|
454
465
|
get: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
|
|
455
466
|
patch: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
|
|
456
467
|
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
457
468
|
internalTags: {
|
|
458
469
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
459
|
-
query?:
|
|
470
|
+
query?: ListInternalTagsData["query"];
|
|
460
471
|
signal?: AbortSignal;
|
|
461
472
|
throwOnError?: ThrowOnError | undefined;
|
|
462
473
|
fetchOptions?: FetchOptions;
|
|
463
474
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
464
|
-
internal_tags
|
|
475
|
+
internal_tags: Array<InternalTag>;
|
|
465
476
|
}, ThrowOnError>>;
|
|
466
477
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
467
|
-
body:
|
|
478
|
+
body: CreateInternalTagData["body"];
|
|
468
479
|
signal?: AbortSignal;
|
|
469
480
|
throwOnError?: ThrowOnError | undefined;
|
|
470
481
|
fetchOptions?: FetchOptions;
|
|
471
482
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
472
|
-
internal_tag
|
|
483
|
+
internal_tag: InternalTag;
|
|
473
484
|
}, ThrowOnError>>;
|
|
474
485
|
update<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options: {
|
|
475
|
-
body:
|
|
486
|
+
body: UpdateInternalTagData["body"];
|
|
476
487
|
signal?: AbortSignal;
|
|
477
488
|
throwOnError?: ThrowOnError | undefined;
|
|
478
489
|
fetchOptions?: FetchOptions;
|
|
479
490
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
480
|
-
internal_tag
|
|
491
|
+
internal_tag: InternalTag;
|
|
481
492
|
}, ThrowOnError>>;
|
|
482
493
|
delete<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options?: {
|
|
483
494
|
signal?: AbortSignal;
|
|
@@ -488,83 +499,84 @@ declare function buildResources<DefaultThrowOnError extends boolean = false>(dep
|
|
|
488
499
|
post: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
|
|
489
500
|
presets: {
|
|
490
501
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
491
|
-
query?:
|
|
502
|
+
query?: ListPresetsData["query"];
|
|
492
503
|
signal?: AbortSignal;
|
|
493
504
|
throwOnError?: ThrowOnError | undefined;
|
|
494
505
|
fetchOptions?: FetchOptions;
|
|
495
506
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
496
507
|
presets: Array<Preset>;
|
|
497
508
|
}, ThrowOnError>>;
|
|
498
|
-
get<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number
|
|
509
|
+
get<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
|
|
499
510
|
signal?: AbortSignal;
|
|
500
511
|
throwOnError?: ThrowOnError | undefined;
|
|
501
512
|
fetchOptions?: FetchOptions;
|
|
502
513
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
503
|
-
preset
|
|
514
|
+
preset: Preset;
|
|
504
515
|
}, ThrowOnError>>;
|
|
505
516
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
506
|
-
body:
|
|
517
|
+
body: CreatePresetData["body"];
|
|
507
518
|
signal?: AbortSignal;
|
|
508
519
|
throwOnError?: ThrowOnError | undefined;
|
|
509
520
|
fetchOptions?: FetchOptions;
|
|
510
521
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
511
|
-
preset
|
|
522
|
+
preset: Preset;
|
|
512
523
|
}, ThrowOnError>>;
|
|
513
|
-
update<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number
|
|
514
|
-
body:
|
|
524
|
+
update<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options: {
|
|
525
|
+
body: UpdatePresetData["body"];
|
|
515
526
|
signal?: AbortSignal;
|
|
516
527
|
throwOnError?: ThrowOnError | undefined;
|
|
517
528
|
fetchOptions?: FetchOptions;
|
|
518
529
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
519
|
-
preset
|
|
530
|
+
preset: Preset;
|
|
520
531
|
}, ThrowOnError>>;
|
|
521
|
-
delete<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number
|
|
532
|
+
delete<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
|
|
522
533
|
signal?: AbortSignal;
|
|
523
534
|
throwOnError?: ThrowOnError | undefined;
|
|
524
535
|
fetchOptions?: FetchOptions;
|
|
525
536
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
526
|
-
preset
|
|
537
|
+
preset: Preset;
|
|
527
538
|
}, ThrowOnError>>;
|
|
528
539
|
};
|
|
529
540
|
put: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
|
|
530
541
|
spaces: {
|
|
531
542
|
list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
532
|
-
query?:
|
|
543
|
+
query?: ListSpacesData["query"];
|
|
533
544
|
signal?: AbortSignal;
|
|
534
545
|
throwOnError?: ThrowOnError | undefined;
|
|
535
546
|
fetchOptions?: FetchOptions;
|
|
536
547
|
}): Promise<ApiResponse<{
|
|
537
|
-
spaces
|
|
548
|
+
spaces: Array<Space>;
|
|
538
549
|
}, ThrowOnError>>;
|
|
539
550
|
create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
540
|
-
body:
|
|
551
|
+
body: CreateSpaceData["body"];
|
|
552
|
+
query?: CreateSpaceData["query"];
|
|
541
553
|
signal?: AbortSignal;
|
|
542
554
|
throwOnError?: ThrowOnError | undefined;
|
|
543
555
|
fetchOptions?: FetchOptions;
|
|
544
556
|
}): Promise<ApiResponse<{
|
|
545
|
-
space
|
|
557
|
+
space: SpaceDetail;
|
|
546
558
|
}, ThrowOnError>>;
|
|
547
559
|
get<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
548
560
|
signal?: AbortSignal;
|
|
549
561
|
throwOnError?: ThrowOnError | undefined;
|
|
550
562
|
fetchOptions?: FetchOptions;
|
|
551
563
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
552
|
-
space
|
|
564
|
+
space: SpaceDetail;
|
|
553
565
|
}, ThrowOnError>>;
|
|
554
566
|
update<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
555
|
-
body:
|
|
567
|
+
body: UpdateSpaceData["body"];
|
|
556
568
|
signal?: AbortSignal;
|
|
557
569
|
throwOnError?: ThrowOnError | undefined;
|
|
558
570
|
fetchOptions?: FetchOptions;
|
|
559
571
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
560
|
-
space
|
|
572
|
+
space: SpaceDetail;
|
|
561
573
|
}, ThrowOnError>>;
|
|
562
574
|
delete<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
|
|
563
575
|
signal?: AbortSignal;
|
|
564
576
|
throwOnError?: ThrowOnError | undefined;
|
|
565
577
|
fetchOptions?: FetchOptions;
|
|
566
578
|
} & SpaceIdPathOverride): Promise<ApiResponse<{
|
|
567
|
-
space
|
|
579
|
+
space: Space;
|
|
568
580
|
}, ThrowOnError>>;
|
|
569
581
|
};
|
|
570
582
|
users: {
|
|
@@ -573,15 +585,15 @@ declare function buildResources<DefaultThrowOnError extends boolean = false>(dep
|
|
|
573
585
|
throwOnError?: ThrowOnError | undefined;
|
|
574
586
|
fetchOptions?: FetchOptions;
|
|
575
587
|
}): Promise<ApiResponse<{
|
|
576
|
-
user
|
|
588
|
+
user: User;
|
|
577
589
|
}, ThrowOnError>>;
|
|
578
590
|
updateMe<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
|
|
579
|
-
body:
|
|
591
|
+
body: UpdateCurrentUserData["body"];
|
|
580
592
|
signal?: AbortSignal;
|
|
581
593
|
throwOnError?: ThrowOnError | undefined;
|
|
582
594
|
fetchOptions?: FetchOptions;
|
|
583
595
|
}): Promise<ApiResponse<{
|
|
584
|
-
user
|
|
596
|
+
user: User;
|
|
585
597
|
}, ThrowOnError>>;
|
|
586
598
|
};
|
|
587
599
|
};
|
|
@@ -596,11 +608,13 @@ type ResolveComponents<T extends StoryblokTypesConfig> = T extends {
|
|
|
596
608
|
blocks: infer B extends Block;
|
|
597
609
|
} ? B : never;
|
|
598
610
|
/**
|
|
599
|
-
* The return type of `createManagementApiClient`, parameterised by `
|
|
611
|
+
* The return type of `createManagementApiClient`, parameterised by `TBlocks` so that
|
|
600
612
|
* `.stories` methods can narrow story content types without touching the runtime object.
|
|
613
|
+
* Component *definitions* (`.components`) are wire-shaped and not narrowed by `TBlocks`.
|
|
601
614
|
*/
|
|
602
|
-
type ManagementApiClient<
|
|
603
|
-
|
|
615
|
+
type ManagementApiClient<TBlocks extends Block = Block, DefaultThrowOnError extends boolean = false> = ReturnType<typeof buildResources<DefaultThrowOnError>> & {
|
|
616
|
+
components: ReturnType<typeof createComponentsResource<DefaultThrowOnError>>;
|
|
617
|
+
stories: ReturnType<typeof createStoriesResource<TBlocks, DefaultThrowOnError>>;
|
|
604
618
|
/**
|
|
605
619
|
* Returns the same client instance cast to a version that narrows story content
|
|
606
620
|
* to the provided component types. No runtime cost — type parameter is erased.
|