@storyblok/management-api-client 0.3.0 → 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (300) hide show
  1. package/README.md +3 -1
  2. package/dist/client.cjs +190 -0
  3. package/dist/client.cjs.map +1 -0
  4. package/dist/client.d.cts +632 -0
  5. package/dist/client.d.mts +632 -0
  6. package/dist/client.mjs +189 -0
  7. package/dist/client.mjs.map +1 -0
  8. package/dist/error.cjs.map +1 -1
  9. package/dist/error.d.cts +12 -2
  10. package/dist/error.d.mts +12 -2
  11. package/dist/error.mjs.map +1 -1
  12. package/dist/generated/mapi/_internal.gen.d.cts +541 -0
  13. package/dist/generated/mapi/_internal.gen.d.mts +541 -0
  14. package/dist/generated/{shared → mapi}/client/client.gen.cjs +1 -1
  15. package/dist/generated/mapi/client/client.gen.cjs.map +1 -0
  16. package/dist/generated/{shared → mapi}/client/client.gen.mjs +1 -1
  17. package/dist/generated/mapi/client/client.gen.mjs.map +1 -0
  18. package/dist/generated/{shared → mapi}/client/types.gen.d.cts +1 -1
  19. package/dist/generated/{shared → mapi}/client/types.gen.d.mts +1 -1
  20. package/dist/generated/{shared → mapi}/client/utils.gen.cjs +1 -1
  21. package/dist/generated/mapi/client/utils.gen.cjs.map +1 -0
  22. package/dist/generated/{shared → mapi}/client/utils.gen.d.cts +1 -1
  23. package/dist/generated/{shared → mapi}/client/utils.gen.d.mts +1 -1
  24. package/dist/generated/{shared → mapi}/client/utils.gen.mjs +1 -1
  25. package/dist/generated/mapi/client/utils.gen.mjs.map +1 -0
  26. package/dist/generated/mapi/client.gen.cjs +10 -0
  27. package/dist/generated/mapi/client.gen.cjs.map +1 -0
  28. package/dist/generated/mapi/client.gen.mjs +10 -0
  29. package/dist/generated/mapi/client.gen.mjs.map +1 -0
  30. package/dist/generated/{shared → mapi}/core/auth.gen.cjs +1 -1
  31. package/dist/generated/mapi/core/auth.gen.cjs.map +1 -0
  32. package/dist/generated/{shared → mapi}/core/auth.gen.d.cts +1 -1
  33. package/dist/generated/{shared → mapi}/core/auth.gen.d.mts +1 -1
  34. package/dist/generated/{shared → mapi}/core/auth.gen.mjs +1 -1
  35. package/dist/generated/mapi/core/auth.gen.mjs.map +1 -0
  36. package/dist/generated/{shared → mapi}/core/bodySerializer.gen.cjs +1 -1
  37. package/dist/generated/mapi/core/bodySerializer.gen.cjs.map +1 -0
  38. package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.cts +1 -1
  39. package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.mts +1 -1
  40. package/dist/generated/{shared → mapi}/core/bodySerializer.gen.mjs +1 -1
  41. package/dist/generated/mapi/core/bodySerializer.gen.mjs.map +1 -0
  42. package/dist/generated/{shared → mapi}/core/params.gen.cjs +1 -1
  43. package/dist/generated/mapi/core/params.gen.cjs.map +1 -0
  44. package/dist/generated/{shared → mapi}/core/params.gen.mjs +1 -1
  45. package/dist/generated/mapi/core/params.gen.mjs.map +1 -0
  46. package/dist/generated/{shared → mapi}/core/pathSerializer.gen.cjs +1 -1
  47. package/dist/generated/mapi/core/pathSerializer.gen.cjs.map +1 -0
  48. package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.cts +1 -1
  49. package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.mts +1 -1
  50. package/dist/generated/{shared → mapi}/core/pathSerializer.gen.mjs +1 -1
  51. package/dist/generated/mapi/core/pathSerializer.gen.mjs.map +1 -0
  52. package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.cjs +1 -1
  53. package/dist/generated/mapi/core/serverSentEvents.gen.cjs.map +1 -0
  54. package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.cts +1 -1
  55. package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.mts +1 -1
  56. package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.mjs +1 -1
  57. package/dist/generated/mapi/core/serverSentEvents.gen.mjs.map +1 -0
  58. package/dist/generated/{shared → mapi}/core/types.gen.d.cts +1 -1
  59. package/dist/generated/{shared → mapi}/core/types.gen.d.mts +1 -1
  60. package/dist/generated/{shared → mapi}/core/utils.gen.cjs +1 -1
  61. package/dist/generated/mapi/core/utils.gen.cjs.map +1 -0
  62. package/dist/generated/{shared → mapi}/core/utils.gen.mjs +1 -1
  63. package/dist/generated/mapi/core/utils.gen.mjs.map +1 -0
  64. package/dist/generated/mapi/sdk.gen.cjs +1477 -0
  65. package/dist/generated/mapi/sdk.gen.cjs.map +1 -0
  66. package/dist/generated/mapi/sdk.gen.mjs +1399 -0
  67. package/dist/generated/mapi/sdk.gen.mjs.map +1 -0
  68. package/dist/generated/mapi/types-aliased.gen.d.cts +1428 -0
  69. package/dist/generated/mapi/types-aliased.gen.d.mts +1428 -0
  70. package/dist/generated/mapi/types.gen.d.cts +5075 -0
  71. package/dist/generated/mapi/types.gen.d.mts +5075 -0
  72. package/dist/generated/overlay/_internal.gen.d.cts +850 -0
  73. package/dist/generated/overlay/_internal.gen.d.mts +850 -0
  74. package/dist/generated/types/_utils.d.cts +7 -0
  75. package/dist/generated/types/_utils.d.mts +7 -0
  76. package/dist/generated/types/block.d.cts +30 -0
  77. package/dist/generated/types/block.d.mts +30 -0
  78. package/dist/generated/types/field.d.cts +75 -0
  79. package/dist/generated/types/field.d.mts +75 -0
  80. package/dist/generated/types/mapi-story.d.cts +29 -0
  81. package/dist/generated/types/mapi-story.d.mts +29 -0
  82. package/dist/index.cjs +3 -173
  83. package/dist/index.d.cts +13 -433
  84. package/dist/index.d.mts +13 -433
  85. package/dist/index.mjs +2 -171
  86. package/dist/resources/asset-folders.cjs +9 -9
  87. package/dist/resources/asset-folders.cjs.map +1 -1
  88. package/dist/resources/asset-folders.mjs +9 -9
  89. package/dist/resources/asset-folders.mjs.map +1 -1
  90. package/dist/resources/assets.cjs +57 -48
  91. package/dist/resources/assets.cjs.map +1 -1
  92. package/dist/resources/assets.d.cts +23 -27
  93. package/dist/resources/assets.d.mts +23 -27
  94. package/dist/resources/assets.mjs +57 -48
  95. package/dist/resources/assets.mjs.map +1 -1
  96. package/dist/resources/component-folders.cjs +9 -9
  97. package/dist/resources/component-folders.cjs.map +1 -1
  98. package/dist/resources/component-folders.mjs +9 -9
  99. package/dist/resources/component-folders.mjs.map +1 -1
  100. package/dist/resources/components.cjs +28 -20
  101. package/dist/resources/components.cjs.map +1 -1
  102. package/dist/resources/components.d.cts +76 -0
  103. package/dist/resources/components.d.mts +76 -0
  104. package/dist/resources/components.mjs +28 -20
  105. package/dist/resources/components.mjs.map +1 -1
  106. package/dist/resources/datasource-entries.cjs +28 -34
  107. package/dist/resources/datasource-entries.cjs.map +1 -1
  108. package/dist/resources/datasource-entries.mjs +29 -35
  109. package/dist/resources/datasource-entries.mjs.map +1 -1
  110. package/dist/resources/datasources.cjs +27 -9
  111. package/dist/resources/datasources.cjs.map +1 -1
  112. package/dist/resources/datasources.mjs +27 -9
  113. package/dist/resources/datasources.mjs.map +1 -1
  114. package/dist/resources/experiments.cjs +299 -0
  115. package/dist/resources/experiments.cjs.map +1 -0
  116. package/dist/resources/experiments.mjs +299 -0
  117. package/dist/resources/experiments.mjs.map +1 -0
  118. package/dist/resources/internal-tags.cjs +7 -7
  119. package/dist/resources/internal-tags.cjs.map +1 -1
  120. package/dist/resources/internal-tags.mjs +7 -7
  121. package/dist/resources/internal-tags.mjs.map +1 -1
  122. package/dist/resources/presets.cjs +9 -9
  123. package/dist/resources/presets.cjs.map +1 -1
  124. package/dist/resources/presets.mjs +9 -9
  125. package/dist/resources/presets.mjs.map +1 -1
  126. package/dist/resources/shared.cjs +15 -0
  127. package/dist/resources/shared.cjs.map +1 -1
  128. package/dist/resources/shared.mjs +15 -1
  129. package/dist/resources/shared.mjs.map +1 -1
  130. package/dist/resources/spaces.cjs +8 -7
  131. package/dist/resources/spaces.cjs.map +1 -1
  132. package/dist/resources/spaces.d.cts +8 -0
  133. package/dist/resources/spaces.d.mts +7 -0
  134. package/dist/resources/spaces.mjs +8 -7
  135. package/dist/resources/spaces.mjs.map +1 -1
  136. package/dist/resources/stories.cjs +20 -16
  137. package/dist/resources/stories.cjs.map +1 -1
  138. package/dist/resources/stories.d.cts +93 -0
  139. package/dist/resources/stories.d.mts +93 -0
  140. package/dist/resources/stories.mjs +20 -16
  141. package/dist/resources/stories.mjs.map +1 -1
  142. package/dist/resources/users.cjs +3 -3
  143. package/dist/resources/users.cjs.map +1 -1
  144. package/dist/resources/users.mjs +3 -3
  145. package/dist/resources/users.mjs.map +1 -1
  146. package/dist/utils/query-serializer.cjs +54 -0
  147. package/dist/utils/query-serializer.cjs.map +1 -0
  148. package/dist/utils/query-serializer.mjs +54 -0
  149. package/dist/utils/query-serializer.mjs.map +1 -0
  150. package/package.json +16 -14
  151. package/playground/integration-tests/README.md +24 -0
  152. package/playground/integration-tests/eslint.config.js +5 -0
  153. package/playground/integration-tests/node_modules/.bin/eslint +16 -0
  154. package/playground/integration-tests/node_modules/.bin/tsc +16 -0
  155. package/playground/integration-tests/node_modules/.bin/tsserver +16 -0
  156. package/playground/integration-tests/node_modules/.bin/vitest +16 -0
  157. package/playground/integration-tests/package.json +24 -0
  158. package/playground/integration-tests/test/setup.e2e.ts +11 -0
  159. package/playground/integration-tests/test/specs/mapi-round-trip.spec.e2e.ts +520 -0
  160. package/playground/integration-tests/test/types/components.test-d.ts +113 -0
  161. package/playground/integration-tests/test/types/resources.test-d.ts +364 -0
  162. package/playground/integration-tests/test/types/stories.test-d.ts +306 -0
  163. package/playground/integration-tests/vitest.config.e2e.ts +25 -0
  164. package/playground/integration-tests/vitest.config.ts +13 -0
  165. package/test/GUIDE.md +59 -0
  166. package/vitest.config.ts +5 -0
  167. package/dist/generated/asset_folders/client.gen.cjs +0 -10
  168. package/dist/generated/asset_folders/client.gen.cjs.map +0 -1
  169. package/dist/generated/asset_folders/client.gen.mjs +0 -10
  170. package/dist/generated/asset_folders/client.gen.mjs.map +0 -1
  171. package/dist/generated/asset_folders/sdk.gen.cjs +0 -99
  172. package/dist/generated/asset_folders/sdk.gen.cjs.map +0 -1
  173. package/dist/generated/asset_folders/sdk.gen.mjs +0 -95
  174. package/dist/generated/asset_folders/sdk.gen.mjs.map +0 -1
  175. package/dist/generated/asset_folders/types.gen.d.cts +0 -156
  176. package/dist/generated/asset_folders/types.gen.d.mts +0 -156
  177. package/dist/generated/assets/client.gen.cjs +0 -10
  178. package/dist/generated/assets/client.gen.cjs.map +0 -1
  179. package/dist/generated/assets/client.gen.mjs +0 -10
  180. package/dist/generated/assets/client.gen.mjs.map +0 -1
  181. package/dist/generated/assets/sdk.gen.cjs +0 -179
  182. package/dist/generated/assets/sdk.gen.cjs.map +0 -1
  183. package/dist/generated/assets/sdk.gen.mjs +0 -171
  184. package/dist/generated/assets/sdk.gen.mjs.map +0 -1
  185. package/dist/generated/assets/types.gen.d.cts +0 -415
  186. package/dist/generated/assets/types.gen.d.mts +0 -415
  187. package/dist/generated/component_folders/client.gen.cjs +0 -10
  188. package/dist/generated/component_folders/client.gen.cjs.map +0 -1
  189. package/dist/generated/component_folders/client.gen.mjs +0 -10
  190. package/dist/generated/component_folders/client.gen.mjs.map +0 -1
  191. package/dist/generated/component_folders/sdk.gen.cjs +0 -99
  192. package/dist/generated/component_folders/sdk.gen.cjs.map +0 -1
  193. package/dist/generated/component_folders/sdk.gen.mjs +0 -95
  194. package/dist/generated/component_folders/sdk.gen.mjs.map +0 -1
  195. package/dist/generated/component_folders/types.gen.d.cts +0 -118
  196. package/dist/generated/component_folders/types.gen.d.mts +0 -118
  197. package/dist/generated/components/client.gen.cjs +0 -10
  198. package/dist/generated/components/client.gen.cjs.map +0 -1
  199. package/dist/generated/components/client.gen.mjs +0 -10
  200. package/dist/generated/components/client.gen.mjs.map +0 -1
  201. package/dist/generated/components/sdk.gen.cjs +0 -171
  202. package/dist/generated/components/sdk.gen.cjs.map +0 -1
  203. package/dist/generated/components/sdk.gen.mjs +0 -163
  204. package/dist/generated/components/sdk.gen.mjs.map +0 -1
  205. package/dist/generated/components/types.gen.d.cts +0 -855
  206. package/dist/generated/components/types.gen.d.mts +0 -855
  207. package/dist/generated/datasource_entries/client.gen.cjs +0 -10
  208. package/dist/generated/datasource_entries/client.gen.cjs.map +0 -1
  209. package/dist/generated/datasource_entries/client.gen.mjs +0 -10
  210. package/dist/generated/datasource_entries/client.gen.mjs.map +0 -1
  211. package/dist/generated/datasource_entries/sdk.gen.cjs +0 -89
  212. package/dist/generated/datasource_entries/sdk.gen.cjs.map +0 -1
  213. package/dist/generated/datasource_entries/sdk.gen.mjs +0 -85
  214. package/dist/generated/datasource_entries/sdk.gen.mjs.map +0 -1
  215. package/dist/generated/datasource_entries/types.gen.d.cts +0 -156
  216. package/dist/generated/datasource_entries/types.gen.d.mts +0 -156
  217. package/dist/generated/datasources/client.gen.cjs +0 -10
  218. package/dist/generated/datasources/client.gen.cjs.map +0 -1
  219. package/dist/generated/datasources/client.gen.mjs +0 -10
  220. package/dist/generated/datasources/client.gen.mjs.map +0 -1
  221. package/dist/generated/datasources/sdk.gen.cjs +0 -89
  222. package/dist/generated/datasources/sdk.gen.cjs.map +0 -1
  223. package/dist/generated/datasources/sdk.gen.mjs +0 -85
  224. package/dist/generated/datasources/sdk.gen.mjs.map +0 -1
  225. package/dist/generated/datasources/types.gen.d.cts +0 -186
  226. package/dist/generated/datasources/types.gen.d.mts +0 -186
  227. package/dist/generated/internal_tags/client.gen.cjs +0 -10
  228. package/dist/generated/internal_tags/client.gen.cjs.map +0 -1
  229. package/dist/generated/internal_tags/client.gen.mjs +0 -10
  230. package/dist/generated/internal_tags/client.gen.mjs.map +0 -1
  231. package/dist/generated/internal_tags/sdk.gen.cjs +0 -74
  232. package/dist/generated/internal_tags/sdk.gen.cjs.map +0 -1
  233. package/dist/generated/internal_tags/sdk.gen.mjs +0 -71
  234. package/dist/generated/internal_tags/sdk.gen.mjs.map +0 -1
  235. package/dist/generated/internal_tags/types.gen.d.cts +0 -106
  236. package/dist/generated/internal_tags/types.gen.d.mts +0 -106
  237. package/dist/generated/presets/client.gen.cjs +0 -10
  238. package/dist/generated/presets/client.gen.cjs.map +0 -1
  239. package/dist/generated/presets/client.gen.mjs +0 -10
  240. package/dist/generated/presets/client.gen.mjs.map +0 -1
  241. package/dist/generated/presets/sdk.gen.cjs +0 -99
  242. package/dist/generated/presets/sdk.gen.cjs.map +0 -1
  243. package/dist/generated/presets/sdk.gen.mjs +0 -95
  244. package/dist/generated/presets/sdk.gen.mjs.map +0 -1
  245. package/dist/generated/presets/types.gen.d.cts +0 -176
  246. package/dist/generated/presets/types.gen.d.mts +0 -176
  247. package/dist/generated/shared/client/client.gen.cjs.map +0 -1
  248. package/dist/generated/shared/client/client.gen.mjs.map +0 -1
  249. package/dist/generated/shared/client/utils.gen.cjs.map +0 -1
  250. package/dist/generated/shared/client/utils.gen.mjs.map +0 -1
  251. package/dist/generated/shared/core/auth.gen.cjs.map +0 -1
  252. package/dist/generated/shared/core/auth.gen.mjs.map +0 -1
  253. package/dist/generated/shared/core/bodySerializer.gen.cjs.map +0 -1
  254. package/dist/generated/shared/core/bodySerializer.gen.mjs.map +0 -1
  255. package/dist/generated/shared/core/params.gen.cjs.map +0 -1
  256. package/dist/generated/shared/core/params.gen.mjs.map +0 -1
  257. package/dist/generated/shared/core/pathSerializer.gen.cjs.map +0 -1
  258. package/dist/generated/shared/core/pathSerializer.gen.mjs.map +0 -1
  259. package/dist/generated/shared/core/serverSentEvents.gen.cjs.map +0 -1
  260. package/dist/generated/shared/core/serverSentEvents.gen.mjs.map +0 -1
  261. package/dist/generated/shared/core/utils.gen.cjs.map +0 -1
  262. package/dist/generated/shared/core/utils.gen.mjs.map +0 -1
  263. package/dist/generated/spaces/client.gen.cjs +0 -10
  264. package/dist/generated/spaces/client.gen.cjs.map +0 -1
  265. package/dist/generated/spaces/client.gen.mjs +0 -10
  266. package/dist/generated/spaces/client.gen.mjs.map +0 -1
  267. package/dist/generated/spaces/sdk.gen.cjs +0 -99
  268. package/dist/generated/spaces/sdk.gen.cjs.map +0 -1
  269. package/dist/generated/spaces/sdk.gen.mjs +0 -95
  270. package/dist/generated/spaces/sdk.gen.mjs.map +0 -1
  271. package/dist/generated/spaces/types.gen.d.cts +0 -544
  272. package/dist/generated/spaces/types.gen.d.mts +0 -544
  273. package/dist/generated/stories/client.gen.cjs +0 -10
  274. package/dist/generated/stories/client.gen.cjs.map +0 -1
  275. package/dist/generated/stories/client.gen.mjs +0 -10
  276. package/dist/generated/stories/client.gen.mjs.map +0 -1
  277. package/dist/generated/stories/sdk.gen.cjs +0 -138
  278. package/dist/generated/stories/sdk.gen.cjs.map +0 -1
  279. package/dist/generated/stories/sdk.gen.mjs +0 -131
  280. package/dist/generated/stories/sdk.gen.mjs.map +0 -1
  281. package/dist/generated/stories/types.gen.d.cts +0 -1306
  282. package/dist/generated/stories/types.gen.d.mts +0 -1306
  283. package/dist/generated/users/client.gen.cjs +0 -10
  284. package/dist/generated/users/client.gen.cjs.map +0 -1
  285. package/dist/generated/users/client.gen.mjs +0 -10
  286. package/dist/generated/users/client.gen.mjs.map +0 -1
  287. package/dist/generated/users/sdk.gen.cjs +0 -44
  288. package/dist/generated/users/sdk.gen.cjs.map +0 -1
  289. package/dist/generated/users/sdk.gen.mjs +0 -43
  290. package/dist/generated/users/sdk.gen.mjs.map +0 -1
  291. package/dist/generated/users/types.gen.d.cts +0 -348
  292. package/dist/generated/users/types.gen.d.mts +0 -348
  293. package/dist/index.cjs.map +0 -1
  294. package/dist/index.mjs.map +0 -1
  295. package/dist/types.d.cts +0 -130
  296. package/dist/types.d.mts +0 -130
  297. /package/dist/generated/{shared → mapi}/client/client.gen.d.mts +0 -0
  298. /package/dist/generated/{shared → mapi}/client/index.cjs +0 -0
  299. /package/dist/generated/{shared → mapi}/client/index.d.mts +0 -0
  300. /package/dist/generated/{shared → mapi}/client/index.mjs +0 -0
@@ -0,0 +1,632 @@
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";
4
+ import { SpaceIdPathOverride } from "./resources/shared.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";
8
+ import { ClientError } from "./error.cjs";
9
+ import { RateLimitConfig } from "./utils/rate-limit.cjs";
10
+ import { createComponentsResource } from "./resources/components.cjs";
11
+ import { createStoriesResource } from "./resources/stories.cjs";
12
+ import { Region } from "@storyblok/region-helper";
13
+
14
+ //#region src/client.d.ts
15
+ type ApiResponse<T, ThrowOnError extends boolean = false> = ThrowOnError extends true ? {
16
+ data: T;
17
+ error?: never;
18
+ response: Response;
19
+ request: Request;
20
+ } : {
21
+ data: T;
22
+ error: undefined;
23
+ response: Response;
24
+ request: Request;
25
+ } | {
26
+ data: undefined;
27
+ error: ClientError;
28
+ response: Response;
29
+ request: Request;
30
+ };
31
+ interface RequestConfigOverrides {
32
+ throwOnError?: boolean;
33
+ }
34
+ /**
35
+ * Arbitrary options forwarded to the underlying `fetch()` call.
36
+ *
37
+ * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and
38
+ * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)
39
+ * are both supported.
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * client.stories.get(123, {
44
+ * fetchOptions: {
45
+ * cache: 'no-store',
46
+ * next: { revalidate: 60 },
47
+ * },
48
+ * })
49
+ * ```
50
+ */
51
+ type FetchOptions = Record<string, unknown>;
52
+ interface HttpRequestOptions {
53
+ query?: Record<string, unknown>;
54
+ body?: unknown;
55
+ headers?: Record<string, string>;
56
+ signal?: AbortSignal;
57
+ throwOnError?: RequestConfigOverrides['throwOnError'];
58
+ fetchOptions?: FetchOptions;
59
+ }
60
+ /**
61
+ * Dependencies injected into every resource factory.
62
+ */
63
+ interface MapiResourceDeps<DefaultThrowOnError extends boolean = false> {
64
+ client: Client;
65
+ spaceId?: number;
66
+ wrapRequest: <TData, ThrowOnError extends boolean = DefaultThrowOnError>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;
67
+ }
68
+ type TokenConfig = {
69
+ /** Personal access token for authentication. */personalAccessToken: string;
70
+ oauthToken?: never;
71
+ } | {
72
+ personalAccessToken?: never; /** OAuth bearer token for authentication. */
73
+ oauthToken: string;
74
+ } | {
75
+ personalAccessToken?: undefined;
76
+ oauthToken?: undefined;
77
+ };
78
+ type ManagementApiClientConfig<ThrowOnError extends boolean = false> = TokenConfig & {
79
+ /**
80
+ * The Storyblok space ID. Used as the default for space-scoped endpoints.
81
+ * You can also override it per request via `path.space_id`.
82
+ */
83
+ spaceId?: number;
84
+ /**
85
+ * Storyblok region. Determines the base URL.
86
+ * @default 'eu'
87
+ */
88
+ region?: Region;
89
+ /**
90
+ * Override the base URL entirely (e.g. for testing).
91
+ */
92
+ baseUrl?: string;
93
+ /**
94
+ * Additional request headers.
95
+ */
96
+ headers?: Record<string, string>;
97
+ /**
98
+ * Throw on HTTP errors instead of returning them.
99
+ * @default false
100
+ */
101
+ throwOnError?: ThrowOnError;
102
+ /**
103
+ * Retry configuration for failed requests.
104
+ */
105
+ retry?: RetryOptions;
106
+ /**
107
+ * Request timeout in milliseconds.
108
+ * @default 30_000
109
+ */
110
+ timeout?: number;
111
+ /**
112
+ * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.
113
+ *
114
+ * - `undefined` (default): single bucket at maxConcurrency: 6.
115
+ * - `number`: fixed max concurrent requests per second.
116
+ * - `{ maxConcurrency?: number; adaptToServerHeaders?: boolean }`: full config.
117
+ * - `false`: disable rate limiting entirely.
118
+ */
119
+ rateLimit?: RateLimitConfig | number | false;
120
+ };
121
+ declare function buildResources<DefaultThrowOnError extends boolean = false>(deps: MapiResourceDeps<DefaultThrowOnError>, client: Client): {
122
+ assetFolders: {
123
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
124
+ query?: ListAssetFoldersData["query"];
125
+ signal?: AbortSignal;
126
+ throwOnError?: ThrowOnError | undefined;
127
+ fetchOptions?: FetchOptions;
128
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
129
+ asset_folders: Array<AssetFolder>;
130
+ }, ThrowOnError>>;
131
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
132
+ signal?: AbortSignal;
133
+ throwOnError?: ThrowOnError | undefined;
134
+ fetchOptions?: FetchOptions;
135
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
136
+ asset_folder: AssetFolder;
137
+ }, ThrowOnError>>;
138
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
139
+ body: CreateAssetFolderData["body"];
140
+ signal?: AbortSignal;
141
+ throwOnError?: ThrowOnError | undefined;
142
+ fetchOptions?: FetchOptions;
143
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
144
+ asset_folder: AssetFolder;
145
+ }, ThrowOnError>>;
146
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options: {
147
+ body: UpdateAssetFolderData["body"];
148
+ signal?: AbortSignal;
149
+ throwOnError?: ThrowOnError | undefined;
150
+ fetchOptions?: FetchOptions;
151
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
152
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
153
+ query?: DeleteAssetFolderData["query"];
154
+ signal?: AbortSignal;
155
+ throwOnError?: ThrowOnError | undefined;
156
+ fetchOptions?: FetchOptions;
157
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
158
+ };
159
+ assets: {
160
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
161
+ query?: ListAssetsData["query"];
162
+ signal?: AbortSignal;
163
+ throwOnError?: ThrowOnError | undefined;
164
+ fetchOptions?: FetchOptions;
165
+ } & SpaceIdPathOverride): Promise<ApiResponse<ListAssetsResult, ThrowOnError>>;
166
+ signResponseObject<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
167
+ query: CreateAssetData["query"];
168
+ signal?: AbortSignal;
169
+ throwOnError?: ThrowOnError | undefined;
170
+ fetchOptions?: FetchOptions;
171
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateAsset, ThrowOnError>>;
172
+ upload(options: {
173
+ body: AssetUploadRequest;
174
+ file: Blob | ArrayBuffer;
175
+ signal?: AbortSignal;
176
+ fetchOptions?: FetchOptions;
177
+ } & SpaceIdPathOverride): Promise<Asset$1>;
178
+ create(options: {
179
+ body: AssetCreate;
180
+ file: Blob | ArrayBuffer;
181
+ signal?: AbortSignal;
182
+ fetchOptions?: FetchOptions;
183
+ } & SpaceIdPathOverride): Promise<Asset$1>;
184
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
185
+ signal?: AbortSignal;
186
+ throwOnError?: ThrowOnError | undefined;
187
+ fetchOptions?: FetchOptions;
188
+ } & SpaceIdPathOverride): Promise<ApiResponse<ShowAsset, ThrowOnError>>;
189
+ update(assetId: number, options: ({
190
+ body: UpdateAssetData["body"];
191
+ file?: undefined;
192
+ } | {
193
+ body: AssetUpdateRequest & {
194
+ short_filename: string;
195
+ };
196
+ file: Blob | ArrayBuffer;
197
+ }) & {
198
+ signal?: AbortSignal;
199
+ fetchOptions?: FetchOptions;
200
+ } & SpaceIdPathOverride): Promise<void>;
201
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
202
+ signal?: AbortSignal;
203
+ throwOnError?: ThrowOnError | undefined;
204
+ fetchOptions?: FetchOptions;
205
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset, ThrowOnError>>;
206
+ finalize<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
207
+ signal?: AbortSignal;
208
+ throwOnError?: ThrowOnError | undefined;
209
+ fetchOptions?: FetchOptions;
210
+ } & SpaceIdPathOverride): Promise<ApiResponse<FinishUploadAsset, ThrowOnError>>;
211
+ deleteMany<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
212
+ body: BulkDestroyAssetsData["body"];
213
+ signal?: AbortSignal;
214
+ throwOnError?: ThrowOnError | undefined;
215
+ fetchOptions?: FetchOptions;
216
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
217
+ message: string;
218
+ }, ThrowOnError>>;
219
+ bulkMove<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
220
+ body: BulkUpdateAssetsData["body"];
221
+ signal?: AbortSignal;
222
+ throwOnError?: ThrowOnError | undefined;
223
+ fetchOptions?: FetchOptions;
224
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
225
+ message: string;
226
+ }, ThrowOnError>>;
227
+ bulkRestore<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
228
+ body: BulkRestoreAssetsData["body"];
229
+ signal?: AbortSignal;
230
+ throwOnError?: ThrowOnError | undefined;
231
+ fetchOptions?: FetchOptions;
232
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
233
+ message: string;
234
+ }, ThrowOnError>>;
235
+ convertToShared<ThrowOnError extends boolean = false>(assetId: number | string, options: {
236
+ query: {
237
+ target_asset_folder_id: number;
238
+ };
239
+ signal?: AbortSignal;
240
+ throwOnError?: ThrowOnError | undefined;
241
+ fetchOptions?: FetchOptions;
242
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset$1, ThrowOnError>>;
243
+ };
244
+ componentFolders: {
245
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
246
+ query?: ListComponentGroupsData["query"];
247
+ signal?: AbortSignal;
248
+ throwOnError?: ThrowOnError | undefined;
249
+ fetchOptions?: FetchOptions;
250
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
251
+ component_groups: Array<ComponentGroup>;
252
+ }, ThrowOnError>>;
253
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
254
+ signal?: AbortSignal;
255
+ throwOnError?: ThrowOnError | undefined;
256
+ fetchOptions?: FetchOptions;
257
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
258
+ component_group: ComponentGroup;
259
+ }, ThrowOnError>>;
260
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
261
+ body: CreateComponentGroupData["body"];
262
+ signal?: AbortSignal;
263
+ throwOnError?: ThrowOnError | undefined;
264
+ fetchOptions?: FetchOptions;
265
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
266
+ component_group: ComponentGroup;
267
+ }, ThrowOnError>>;
268
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options: {
269
+ body: UpdateComponentGroupData["body"];
270
+ signal?: AbortSignal;
271
+ throwOnError?: ThrowOnError | undefined;
272
+ fetchOptions?: FetchOptions;
273
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
274
+ component_group: ComponentGroup;
275
+ }, ThrowOnError>>;
276
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
277
+ signal?: AbortSignal;
278
+ throwOnError?: ThrowOnError | undefined;
279
+ fetchOptions?: FetchOptions;
280
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
281
+ };
282
+ datasourceEntries: {
283
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
284
+ query?: ListDatasourceEntriesData["query"];
285
+ signal?: AbortSignal;
286
+ throwOnError?: ThrowOnError | undefined;
287
+ fetchOptions?: FetchOptions;
288
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntriesIndexResponse, ThrowOnError>>;
289
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options?: {
290
+ signal?: AbortSignal;
291
+ throwOnError?: ThrowOnError | undefined;
292
+ fetchOptions?: FetchOptions;
293
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
294
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
295
+ body: CreateDatasourceEntryData["body"];
296
+ signal?: AbortSignal;
297
+ throwOnError?: ThrowOnError | undefined;
298
+ fetchOptions?: FetchOptions;
299
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
300
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options: {
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"];
308
+ signal?: AbortSignal;
309
+ throwOnError?: ThrowOnError | undefined;
310
+ fetchOptions?: FetchOptions;
311
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
312
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options?: {
313
+ signal?: AbortSignal;
314
+ throwOnError?: ThrowOnError | undefined;
315
+ fetchOptions?: FetchOptions;
316
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
317
+ };
318
+ datasources: {
319
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
320
+ query?: ListDatasourcesData["query"];
321
+ signal?: AbortSignal;
322
+ throwOnError?: ThrowOnError | undefined;
323
+ fetchOptions?: FetchOptions;
324
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
325
+ datasources: Array<Datasource>;
326
+ }, ThrowOnError>>;
327
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options?: {
328
+ signal?: AbortSignal;
329
+ throwOnError?: ThrowOnError | undefined;
330
+ fetchOptions?: FetchOptions;
331
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
332
+ datasource: Datasource;
333
+ }, ThrowOnError>>;
334
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
335
+ body: CreateDatasourceData["body"];
336
+ signal?: AbortSignal;
337
+ throwOnError?: ThrowOnError | undefined;
338
+ fetchOptions?: FetchOptions;
339
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
340
+ datasource: Datasource;
341
+ }, ThrowOnError>>;
342
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options: {
343
+ body: PartialUpdateDatasourceData["body"];
344
+ signal?: AbortSignal;
345
+ throwOnError?: ThrowOnError | undefined;
346
+ fetchOptions?: FetchOptions;
347
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
348
+ datasource: Datasource;
349
+ }, ThrowOnError>>;
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?: {
359
+ signal?: AbortSignal;
360
+ throwOnError?: ThrowOnError | undefined;
361
+ fetchOptions?: FetchOptions;
362
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
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?: AbortSignal;
416
+ throwOnError?: ThrowOnError;
417
+ fetchOptions?: FetchOptions;
418
+ } & SpaceIdPathOverride): Promise<ApiResponse<SelectExperimentWinnerResponses[200], ThrowOnError>>;
419
+ stories: {
420
+ create<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
421
+ body: CreateExperimentStoryData["body"];
422
+ signal?: AbortSignal;
423
+ throwOnError?: ThrowOnError;
424
+ fetchOptions?: FetchOptions;
425
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentStoryResponses[201], ThrowOnError>>;
426
+ delete<ThrowOnError extends boolean = false>(experimentId: number | string, storyId: number | string, options?: {
427
+ signal?: AbortSignal;
428
+ throwOnError?: ThrowOnError;
429
+ fetchOptions?: FetchOptions;
430
+ } & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentStoryResponses[204], ThrowOnError>>;
431
+ };
432
+ storyMappings: {
433
+ create<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, options: {
434
+ body: CreateStoryMappingData["body"];
435
+ signal?: AbortSignal;
436
+ throwOnError?: ThrowOnError;
437
+ fetchOptions?: FetchOptions;
438
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateStoryMappingResponses[201], ThrowOnError>>;
439
+ delete<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, originalStoryId: number | string, options?: {
440
+ signal?: AbortSignal;
441
+ throwOnError?: ThrowOnError;
442
+ fetchOptions?: FetchOptions;
443
+ } & SpaceIdPathOverride): Promise<ApiResponse<DeleteStoryMappingResponses[204], ThrowOnError>>;
444
+ };
445
+ results: {
446
+ get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
447
+ signal?: AbortSignal;
448
+ throwOnError?: ThrowOnError;
449
+ fetchOptions?: FetchOptions;
450
+ } & SpaceIdPathOverride): Promise<ApiResponse<GetExperimentResultsResponses[200], ThrowOnError>>;
451
+ push<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
452
+ body: PushExperimentResultsData["body"];
453
+ signal?: AbortSignal;
454
+ throwOnError?: ThrowOnError;
455
+ fetchOptions?: FetchOptions;
456
+ } & SpaceIdPathOverride): Promise<ApiResponse<PushExperimentResultsResponses[200], ThrowOnError>>;
457
+ };
458
+ };
459
+ delete: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
460
+ get: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
461
+ patch: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
462
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
463
+ internalTags: {
464
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
465
+ query?: ListInternalTagsData["query"];
466
+ signal?: AbortSignal;
467
+ throwOnError?: ThrowOnError | undefined;
468
+ fetchOptions?: FetchOptions;
469
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
470
+ internal_tags: Array<InternalTag>;
471
+ }, ThrowOnError>>;
472
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
473
+ body: CreateInternalTagData["body"];
474
+ signal?: AbortSignal;
475
+ throwOnError?: ThrowOnError | undefined;
476
+ fetchOptions?: FetchOptions;
477
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
478
+ internal_tag: InternalTag;
479
+ }, ThrowOnError>>;
480
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options: {
481
+ body: UpdateInternalTagData["body"];
482
+ signal?: AbortSignal;
483
+ throwOnError?: ThrowOnError | undefined;
484
+ fetchOptions?: FetchOptions;
485
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
486
+ internal_tag: InternalTag;
487
+ }, ThrowOnError>>;
488
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options?: {
489
+ signal?: AbortSignal;
490
+ throwOnError?: ThrowOnError | undefined;
491
+ fetchOptions?: FetchOptions;
492
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
493
+ };
494
+ post: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
495
+ presets: {
496
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
497
+ query?: ListPresetsData["query"];
498
+ signal?: AbortSignal;
499
+ throwOnError?: ThrowOnError | undefined;
500
+ fetchOptions?: FetchOptions;
501
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
502
+ presets: Array<Preset>;
503
+ }, ThrowOnError>>;
504
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
505
+ signal?: AbortSignal;
506
+ throwOnError?: ThrowOnError | undefined;
507
+ fetchOptions?: FetchOptions;
508
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
509
+ preset: Preset;
510
+ }, ThrowOnError>>;
511
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
512
+ body: CreatePresetData["body"];
513
+ signal?: AbortSignal;
514
+ throwOnError?: ThrowOnError | undefined;
515
+ fetchOptions?: FetchOptions;
516
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
517
+ preset: Preset;
518
+ }, ThrowOnError>>;
519
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options: {
520
+ body: UpdatePresetData["body"];
521
+ signal?: AbortSignal;
522
+ throwOnError?: ThrowOnError | undefined;
523
+ fetchOptions?: FetchOptions;
524
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
525
+ preset: Preset;
526
+ }, ThrowOnError>>;
527
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
528
+ signal?: AbortSignal;
529
+ throwOnError?: ThrowOnError | undefined;
530
+ fetchOptions?: FetchOptions;
531
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
532
+ preset: Preset;
533
+ }, ThrowOnError>>;
534
+ };
535
+ put: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
536
+ spaces: {
537
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
538
+ query?: ListSpacesData["query"];
539
+ signal?: AbortSignal;
540
+ throwOnError?: ThrowOnError | undefined;
541
+ fetchOptions?: FetchOptions;
542
+ }): Promise<ApiResponse<{
543
+ spaces: Array<Space>;
544
+ }, ThrowOnError>>;
545
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
546
+ body: CreateSpaceData["body"];
547
+ query?: CreateSpaceData["query"];
548
+ signal?: AbortSignal;
549
+ throwOnError?: ThrowOnError | undefined;
550
+ fetchOptions?: FetchOptions;
551
+ }): Promise<ApiResponse<{
552
+ space: SpaceDetail;
553
+ }, ThrowOnError>>;
554
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
555
+ signal?: AbortSignal;
556
+ throwOnError?: ThrowOnError | undefined;
557
+ fetchOptions?: FetchOptions;
558
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
559
+ space: SpaceDetail;
560
+ }, ThrowOnError>>;
561
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
562
+ body: UpdateSpaceData["body"];
563
+ signal?: AbortSignal;
564
+ throwOnError?: ThrowOnError | undefined;
565
+ fetchOptions?: FetchOptions;
566
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
567
+ space: SpaceDetail;
568
+ }, ThrowOnError>>;
569
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
570
+ signal?: AbortSignal;
571
+ throwOnError?: ThrowOnError | undefined;
572
+ fetchOptions?: FetchOptions;
573
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
574
+ space: Space;
575
+ }, ThrowOnError>>;
576
+ };
577
+ users: {
578
+ me<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
579
+ signal?: AbortSignal;
580
+ throwOnError?: ThrowOnError | undefined;
581
+ fetchOptions?: FetchOptions;
582
+ }): Promise<ApiResponse<{
583
+ user: User;
584
+ }, ThrowOnError>>;
585
+ updateMe<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
586
+ body: UpdateCurrentUserData["body"];
587
+ signal?: AbortSignal;
588
+ throwOnError?: ThrowOnError | undefined;
589
+ fetchOptions?: FetchOptions;
590
+ }): Promise<ApiResponse<{
591
+ user: User;
592
+ }, ThrowOnError>>;
593
+ };
594
+ };
595
+ type StoryblokTypesConfig = {
596
+ components: Block;
597
+ } | {
598
+ blocks: Block;
599
+ };
600
+ type ResolveComponents<T extends StoryblokTypesConfig> = T extends {
601
+ components: infer C extends Block;
602
+ } ? C : T extends {
603
+ blocks: infer B extends Block;
604
+ } ? B : never;
605
+ /**
606
+ * The return type of `createManagementApiClient`, parameterised by `TComponents` so that
607
+ * `.stories` methods can narrow story content types without touching the runtime object.
608
+ */
609
+ type ManagementApiClient<TComponents extends Block = Block, DefaultThrowOnError extends boolean = false> = ReturnType<typeof buildResources<DefaultThrowOnError>> & {
610
+ components: ReturnType<typeof createComponentsResource<TComponents, DefaultThrowOnError>>;
611
+ stories: ReturnType<typeof createStoriesResource<TComponents, DefaultThrowOnError>>;
612
+ /**
613
+ * Returns the same client instance cast to a version that narrows story content
614
+ * to the provided component types. No runtime cost — type parameter is erased.
615
+ *
616
+ * Accepts either `{ components: ... }` or `{ blocks: ... }` — the latter matches the
617
+ * `Schema` type produced by `@storyblok/schema`'s `InferSchema`.
618
+ *
619
+ * @example
620
+ * ```ts
621
+ * import type { Schema } from './schema';
622
+ *
623
+ * const client = createManagementApiClient({ personalAccessToken: '...' })
624
+ * .withTypes<Schema>();
625
+ * ```
626
+ */
627
+ withTypes: <T extends StoryblokTypesConfig>() => ManagementApiClient<ResolveComponents<T>, DefaultThrowOnError>;
628
+ };
629
+ declare const createManagementApiClient: <DefaultThrowOnError extends boolean = false>(config: ManagementApiClientConfig<DefaultThrowOnError>) => ManagementApiClient<Block, DefaultThrowOnError>;
630
+ //#endregion
631
+ export { ApiResponse, FetchOptions, HttpRequestOptions, ManagementApiClient, ManagementApiClientConfig, MapiResourceDeps, RequestConfigOverrides, createManagementApiClient };
632
+ //# sourceMappingURL=client.d.cts.map