@storyblok/management-api-client 0.5.1 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (328) hide show
  1. package/README.md +3 -1
  2. package/dist/client.cjs +196 -0
  3. package/dist/client.cjs.map +1 -0
  4. package/dist/client.d.cts +761 -0
  5. package/dist/client.d.mts +761 -0
  6. package/dist/client.mjs +195 -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 +371 -0
  13. package/dist/generated/mapi/_internal.gen.d.mts +371 -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 +1598 -0
  69. package/dist/generated/mapi/types-aliased.gen.d.mts +1598 -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 +55 -0
  77. package/dist/generated/types/block.d.mts +55 -0
  78. package/dist/generated/types/field.d.cts +122 -0
  79. package/dist/generated/types/field.d.mts +122 -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 -181
  83. package/dist/index.d.cts +12 -650
  84. package/dist/index.d.mts +12 -649
  85. package/dist/index.mjs +2 -179
  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 -50
  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 -50
  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 +31 -31
  115. package/dist/resources/experiments.cjs.map +1 -1
  116. package/dist/resources/experiments.mjs +31 -31
  117. package/dist/resources/experiments.mjs.map +1 -1
  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-asset-folders.cjs.map +1 -1
  127. package/dist/resources/shared-asset-folders.d.cts +1 -1
  128. package/dist/resources/shared-asset-folders.d.mts +1 -1
  129. package/dist/resources/shared-asset-folders.mjs.map +1 -1
  130. package/dist/resources/shared-assets.cjs.map +1 -1
  131. package/dist/resources/shared-assets.d.cts +2 -2
  132. package/dist/resources/shared-assets.d.mts +2 -2
  133. package/dist/resources/shared-assets.mjs.map +1 -1
  134. package/dist/resources/shared-internal-tags.cjs.map +1 -1
  135. package/dist/resources/shared-internal-tags.mjs.map +1 -1
  136. package/dist/resources/shared.cjs +15 -0
  137. package/dist/resources/shared.cjs.map +1 -1
  138. package/dist/resources/shared.mjs +15 -1
  139. package/dist/resources/shared.mjs.map +1 -1
  140. package/dist/resources/spaces.cjs +8 -7
  141. package/dist/resources/spaces.cjs.map +1 -1
  142. package/dist/resources/spaces.d.cts +8 -0
  143. package/dist/resources/spaces.d.mts +7 -0
  144. package/dist/resources/spaces.mjs +8 -7
  145. package/dist/resources/spaces.mjs.map +1 -1
  146. package/dist/resources/stories.cjs +20 -16
  147. package/dist/resources/stories.cjs.map +1 -1
  148. package/dist/resources/stories.d.cts +93 -0
  149. package/dist/resources/stories.d.mts +93 -0
  150. package/dist/resources/stories.mjs +20 -16
  151. package/dist/resources/stories.mjs.map +1 -1
  152. package/dist/resources/users.cjs +3 -3
  153. package/dist/resources/users.cjs.map +1 -1
  154. package/dist/resources/users.mjs +3 -3
  155. package/dist/resources/users.mjs.map +1 -1
  156. package/dist/utils/query-serializer.cjs +54 -0
  157. package/dist/utils/query-serializer.cjs.map +1 -0
  158. package/dist/utils/query-serializer.mjs +54 -0
  159. package/dist/utils/query-serializer.mjs.map +1 -0
  160. package/dist/utils/rate-limit.cjs +3 -7
  161. package/dist/utils/rate-limit.cjs.map +1 -1
  162. package/dist/utils/rate-limit.mjs +3 -6
  163. package/dist/utils/rate-limit.mjs.map +1 -1
  164. package/dist/utils/throttle.cjs +57 -0
  165. package/dist/utils/throttle.cjs.map +1 -0
  166. package/dist/utils/throttle.mjs +56 -0
  167. package/dist/utils/throttle.mjs.map +1 -0
  168. package/package.json +17 -16
  169. package/playground/integration-tests/README.md +24 -0
  170. package/playground/integration-tests/eslint.config.js +5 -0
  171. package/playground/integration-tests/node_modules/.bin/eslint +16 -0
  172. package/playground/integration-tests/node_modules/.bin/tsc +16 -0
  173. package/playground/integration-tests/node_modules/.bin/tsserver +16 -0
  174. package/playground/integration-tests/node_modules/.bin/vitest +16 -0
  175. package/playground/integration-tests/package.json +24 -0
  176. package/playground/integration-tests/test/setup.e2e.ts +11 -0
  177. package/playground/integration-tests/test/specs/mapi-round-trip.spec.e2e.ts +510 -0
  178. package/playground/integration-tests/test/types/components.test-d.ts +74 -0
  179. package/playground/integration-tests/test/types/resources.test-d.ts +212 -0
  180. package/playground/integration-tests/test/types/stories.test-d.ts +310 -0
  181. package/playground/integration-tests/vitest.config.e2e.ts +25 -0
  182. package/playground/integration-tests/vitest.config.ts +13 -0
  183. package/test/GUIDE.md +59 -0
  184. package/vitest.config.ts +5 -0
  185. package/dist/generated/asset_folders/client.gen.cjs +0 -10
  186. package/dist/generated/asset_folders/client.gen.cjs.map +0 -1
  187. package/dist/generated/asset_folders/client.gen.mjs +0 -10
  188. package/dist/generated/asset_folders/client.gen.mjs.map +0 -1
  189. package/dist/generated/asset_folders/sdk.gen.cjs +0 -99
  190. package/dist/generated/asset_folders/sdk.gen.cjs.map +0 -1
  191. package/dist/generated/asset_folders/sdk.gen.mjs +0 -95
  192. package/dist/generated/asset_folders/sdk.gen.mjs.map +0 -1
  193. package/dist/generated/asset_folders/types.gen.d.cts +0 -156
  194. package/dist/generated/asset_folders/types.gen.d.mts +0 -156
  195. package/dist/generated/assets/client.gen.cjs +0 -10
  196. package/dist/generated/assets/client.gen.cjs.map +0 -1
  197. package/dist/generated/assets/client.gen.mjs +0 -10
  198. package/dist/generated/assets/client.gen.mjs.map +0 -1
  199. package/dist/generated/assets/sdk.gen.cjs +0 -179
  200. package/dist/generated/assets/sdk.gen.cjs.map +0 -1
  201. package/dist/generated/assets/sdk.gen.mjs +0 -171
  202. package/dist/generated/assets/sdk.gen.mjs.map +0 -1
  203. package/dist/generated/assets/types.gen.d.cts +0 -415
  204. package/dist/generated/assets/types.gen.d.mts +0 -415
  205. package/dist/generated/component_folders/client.gen.cjs +0 -10
  206. package/dist/generated/component_folders/client.gen.cjs.map +0 -1
  207. package/dist/generated/component_folders/client.gen.mjs +0 -10
  208. package/dist/generated/component_folders/client.gen.mjs.map +0 -1
  209. package/dist/generated/component_folders/sdk.gen.cjs +0 -99
  210. package/dist/generated/component_folders/sdk.gen.cjs.map +0 -1
  211. package/dist/generated/component_folders/sdk.gen.mjs +0 -95
  212. package/dist/generated/component_folders/sdk.gen.mjs.map +0 -1
  213. package/dist/generated/component_folders/types.gen.d.cts +0 -118
  214. package/dist/generated/component_folders/types.gen.d.mts +0 -118
  215. package/dist/generated/components/client.gen.cjs +0 -10
  216. package/dist/generated/components/client.gen.cjs.map +0 -1
  217. package/dist/generated/components/client.gen.mjs +0 -10
  218. package/dist/generated/components/client.gen.mjs.map +0 -1
  219. package/dist/generated/components/sdk.gen.cjs +0 -171
  220. package/dist/generated/components/sdk.gen.cjs.map +0 -1
  221. package/dist/generated/components/sdk.gen.mjs +0 -163
  222. package/dist/generated/components/sdk.gen.mjs.map +0 -1
  223. package/dist/generated/components/types.gen.d.cts +0 -855
  224. package/dist/generated/components/types.gen.d.mts +0 -855
  225. package/dist/generated/datasource_entries/client.gen.cjs +0 -10
  226. package/dist/generated/datasource_entries/client.gen.cjs.map +0 -1
  227. package/dist/generated/datasource_entries/client.gen.mjs +0 -10
  228. package/dist/generated/datasource_entries/client.gen.mjs.map +0 -1
  229. package/dist/generated/datasource_entries/sdk.gen.cjs +0 -89
  230. package/dist/generated/datasource_entries/sdk.gen.cjs.map +0 -1
  231. package/dist/generated/datasource_entries/sdk.gen.mjs +0 -85
  232. package/dist/generated/datasource_entries/sdk.gen.mjs.map +0 -1
  233. package/dist/generated/datasource_entries/types.gen.d.cts +0 -156
  234. package/dist/generated/datasource_entries/types.gen.d.mts +0 -156
  235. package/dist/generated/datasources/client.gen.cjs +0 -10
  236. package/dist/generated/datasources/client.gen.cjs.map +0 -1
  237. package/dist/generated/datasources/client.gen.mjs +0 -10
  238. package/dist/generated/datasources/client.gen.mjs.map +0 -1
  239. package/dist/generated/datasources/sdk.gen.cjs +0 -89
  240. package/dist/generated/datasources/sdk.gen.cjs.map +0 -1
  241. package/dist/generated/datasources/sdk.gen.mjs +0 -85
  242. package/dist/generated/datasources/sdk.gen.mjs.map +0 -1
  243. package/dist/generated/datasources/types.gen.d.cts +0 -186
  244. package/dist/generated/datasources/types.gen.d.mts +0 -186
  245. package/dist/generated/experiments/client.gen.cjs +0 -10
  246. package/dist/generated/experiments/client.gen.cjs.map +0 -1
  247. package/dist/generated/experiments/client.gen.mjs +0 -10
  248. package/dist/generated/experiments/client.gen.mjs.map +0 -1
  249. package/dist/generated/experiments/sdk.gen.cjs +0 -298
  250. package/dist/generated/experiments/sdk.gen.cjs.map +0 -1
  251. package/dist/generated/experiments/sdk.gen.mjs +0 -283
  252. package/dist/generated/experiments/sdk.gen.mjs.map +0 -1
  253. package/dist/generated/experiments/types.gen.d.cts +0 -522
  254. package/dist/generated/experiments/types.gen.d.mts +0 -522
  255. package/dist/generated/internal_tags/client.gen.cjs +0 -10
  256. package/dist/generated/internal_tags/client.gen.cjs.map +0 -1
  257. package/dist/generated/internal_tags/client.gen.mjs +0 -10
  258. package/dist/generated/internal_tags/client.gen.mjs.map +0 -1
  259. package/dist/generated/internal_tags/sdk.gen.cjs +0 -74
  260. package/dist/generated/internal_tags/sdk.gen.cjs.map +0 -1
  261. package/dist/generated/internal_tags/sdk.gen.mjs +0 -71
  262. package/dist/generated/internal_tags/sdk.gen.mjs.map +0 -1
  263. package/dist/generated/internal_tags/types.gen.d.cts +0 -106
  264. package/dist/generated/internal_tags/types.gen.d.mts +0 -106
  265. package/dist/generated/presets/client.gen.cjs +0 -10
  266. package/dist/generated/presets/client.gen.cjs.map +0 -1
  267. package/dist/generated/presets/client.gen.mjs +0 -10
  268. package/dist/generated/presets/client.gen.mjs.map +0 -1
  269. package/dist/generated/presets/sdk.gen.cjs +0 -99
  270. package/dist/generated/presets/sdk.gen.cjs.map +0 -1
  271. package/dist/generated/presets/sdk.gen.mjs +0 -95
  272. package/dist/generated/presets/sdk.gen.mjs.map +0 -1
  273. package/dist/generated/presets/types.gen.d.cts +0 -176
  274. package/dist/generated/presets/types.gen.d.mts +0 -176
  275. package/dist/generated/shared/client/client.gen.cjs.map +0 -1
  276. package/dist/generated/shared/client/client.gen.mjs.map +0 -1
  277. package/dist/generated/shared/client/utils.gen.cjs.map +0 -1
  278. package/dist/generated/shared/client/utils.gen.mjs.map +0 -1
  279. package/dist/generated/shared/core/auth.gen.cjs.map +0 -1
  280. package/dist/generated/shared/core/auth.gen.mjs.map +0 -1
  281. package/dist/generated/shared/core/bodySerializer.gen.cjs.map +0 -1
  282. package/dist/generated/shared/core/bodySerializer.gen.mjs.map +0 -1
  283. package/dist/generated/shared/core/params.gen.cjs.map +0 -1
  284. package/dist/generated/shared/core/params.gen.mjs.map +0 -1
  285. package/dist/generated/shared/core/pathSerializer.gen.cjs.map +0 -1
  286. package/dist/generated/shared/core/pathSerializer.gen.mjs.map +0 -1
  287. package/dist/generated/shared/core/serverSentEvents.gen.cjs.map +0 -1
  288. package/dist/generated/shared/core/serverSentEvents.gen.mjs.map +0 -1
  289. package/dist/generated/shared/core/utils.gen.cjs.map +0 -1
  290. package/dist/generated/shared/core/utils.gen.mjs.map +0 -1
  291. package/dist/generated/spaces/client.gen.cjs +0 -10
  292. package/dist/generated/spaces/client.gen.cjs.map +0 -1
  293. package/dist/generated/spaces/client.gen.mjs +0 -10
  294. package/dist/generated/spaces/client.gen.mjs.map +0 -1
  295. package/dist/generated/spaces/sdk.gen.cjs +0 -99
  296. package/dist/generated/spaces/sdk.gen.cjs.map +0 -1
  297. package/dist/generated/spaces/sdk.gen.mjs +0 -95
  298. package/dist/generated/spaces/sdk.gen.mjs.map +0 -1
  299. package/dist/generated/spaces/types.gen.d.cts +0 -544
  300. package/dist/generated/spaces/types.gen.d.mts +0 -544
  301. package/dist/generated/stories/client.gen.cjs +0 -10
  302. package/dist/generated/stories/client.gen.cjs.map +0 -1
  303. package/dist/generated/stories/client.gen.mjs +0 -10
  304. package/dist/generated/stories/client.gen.mjs.map +0 -1
  305. package/dist/generated/stories/sdk.gen.cjs +0 -138
  306. package/dist/generated/stories/sdk.gen.cjs.map +0 -1
  307. package/dist/generated/stories/sdk.gen.mjs +0 -131
  308. package/dist/generated/stories/sdk.gen.mjs.map +0 -1
  309. package/dist/generated/stories/types.gen.d.cts +0 -1306
  310. package/dist/generated/stories/types.gen.d.mts +0 -1306
  311. package/dist/generated/users/client.gen.cjs +0 -10
  312. package/dist/generated/users/client.gen.cjs.map +0 -1
  313. package/dist/generated/users/client.gen.mjs +0 -10
  314. package/dist/generated/users/client.gen.mjs.map +0 -1
  315. package/dist/generated/users/sdk.gen.cjs +0 -44
  316. package/dist/generated/users/sdk.gen.cjs.map +0 -1
  317. package/dist/generated/users/sdk.gen.mjs +0 -43
  318. package/dist/generated/users/sdk.gen.mjs.map +0 -1
  319. package/dist/generated/users/types.gen.d.cts +0 -348
  320. package/dist/generated/users/types.gen.d.mts +0 -348
  321. package/dist/index.cjs.map +0 -1
  322. package/dist/index.mjs.map +0 -1
  323. package/dist/types.d.cts +0 -130
  324. package/dist/types.d.mts +0 -130
  325. /package/dist/generated/{shared → mapi}/client/client.gen.d.mts +0 -0
  326. /package/dist/generated/{shared → mapi}/client/index.cjs +0 -0
  327. /package/dist/generated/{shared → mapi}/client/index.d.mts +0 -0
  328. /package/dist/generated/{shared → mapi}/client/index.mjs +0 -0
@@ -0,0 +1,761 @@
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.mjs";
2
+ import { Middleware } from "./generated/mapi/client/utils.gen.mjs";
3
+ import { Client, ResolvedRequestOptions, RetryOptions } from "./generated/mapi/client/types.gen.mjs";
4
+ import { SpaceIdPathOverride } from "./resources/shared.mjs";
5
+ import { Asset as Asset$1, AssetUpdate } from "./generated/mapi/types-aliased.gen.mjs";
6
+ import { AssetCreate, AssetUploadRequest, ListAssetsResult } from "./resources/assets.mjs";
7
+ import { Block } from "./generated/types/block.mjs";
8
+ import { ClientError } from "./error.mjs";
9
+ import { RateLimitConfig } from "./utils/rate-limit.mjs";
10
+ import { createComponentsResource } from "./resources/components.mjs";
11
+ import { createStoriesResource } from "./resources/stories.mjs";
12
+ import { SharedAssetFolderCreate, SharedAssetFolderGetResponse, SharedAssetFolderListResponse, SharedAssetFolderUpdate } from "./resources/shared-asset-folders.mjs";
13
+ import { SharedAssetCreate, SharedAssetListQuery, SharedAssetListResponse, SharedAssetUploadRequest } from "./resources/shared-assets.mjs";
14
+ import { SharedInternalTagCreate, SharedInternalTagListQuery, SharedInternalTagListResponse, SharedInternalTagMutateResponse } from "./resources/shared-internal-tags.mjs";
15
+ import { Region } from "@storyblok/region-helper";
16
+
17
+ //#region src/client.d.ts
18
+ type ApiResponse<T, ThrowOnError extends boolean = false> = ThrowOnError extends true ? {
19
+ data: T;
20
+ error?: never;
21
+ response: Response;
22
+ request: Request;
23
+ } : {
24
+ data: T;
25
+ error: undefined;
26
+ response: Response;
27
+ request: Request;
28
+ } | {
29
+ data: undefined;
30
+ error: ClientError;
31
+ response: Response;
32
+ request: Request;
33
+ };
34
+ interface RequestConfigOverrides {
35
+ throwOnError?: boolean;
36
+ }
37
+ /**
38
+ * Arbitrary options forwarded to the underlying `fetch()` call.
39
+ *
40
+ * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and
41
+ * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)
42
+ * are both supported.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * client.stories.get(123, {
47
+ * fetchOptions: {
48
+ * cache: 'no-store',
49
+ * next: { revalidate: 60 },
50
+ * },
51
+ * })
52
+ * ```
53
+ */
54
+ type FetchOptions = Record<string, unknown>;
55
+ interface HttpRequestOptions {
56
+ query?: Record<string, unknown>;
57
+ body?: unknown;
58
+ headers?: Record<string, string>;
59
+ signal?: AbortSignal;
60
+ throwOnError?: RequestConfigOverrides['throwOnError'];
61
+ fetchOptions?: FetchOptions;
62
+ }
63
+ /**
64
+ * Dependencies injected into every resource factory.
65
+ */
66
+ interface MapiResourceDeps<DefaultThrowOnError extends boolean = false> {
67
+ client: Client;
68
+ spaceId?: number;
69
+ wrapRequest: <TData, ThrowOnError extends boolean = DefaultThrowOnError>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;
70
+ }
71
+ type TokenConfig = {
72
+ /** Personal access token for authentication. */personalAccessToken: string;
73
+ oauthToken?: never;
74
+ } | {
75
+ personalAccessToken?: never; /** OAuth bearer token for authentication. */
76
+ oauthToken: string;
77
+ } | {
78
+ personalAccessToken?: undefined;
79
+ oauthToken?: undefined;
80
+ };
81
+ type ManagementApiClientConfig<ThrowOnError extends boolean = false> = TokenConfig & {
82
+ /**
83
+ * The Storyblok space ID. Used as the default for space-scoped endpoints.
84
+ * You can also override it per request via `path.space_id`.
85
+ */
86
+ spaceId?: number;
87
+ /**
88
+ * Storyblok region. Determines the base URL.
89
+ * @default 'eu'
90
+ */
91
+ region?: Region;
92
+ /**
93
+ * Override the base URL entirely (e.g. for testing).
94
+ */
95
+ baseUrl?: string;
96
+ /**
97
+ * Additional request headers.
98
+ */
99
+ headers?: Record<string, string>;
100
+ /**
101
+ * Throw on HTTP errors instead of returning them.
102
+ * @default false
103
+ */
104
+ throwOnError?: ThrowOnError;
105
+ /**
106
+ * Retry configuration for failed requests.
107
+ */
108
+ retry?: RetryOptions;
109
+ /**
110
+ * Request timeout in milliseconds.
111
+ * @default 30_000
112
+ */
113
+ timeout?: number;
114
+ /**
115
+ * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.
116
+ *
117
+ * - `undefined` (default): single bucket at 6 requests per second.
118
+ * - `number`: fixed requests per second.
119
+ * - `{ requestsPerSecond?: number }`: full config.
120
+ * - `false`: disable rate limiting entirely.
121
+ */
122
+ rateLimit?: RateLimitConfig | number | false;
123
+ };
124
+ declare function buildResources<DefaultThrowOnError extends boolean = false>(deps: MapiResourceDeps<DefaultThrowOnError>, client: Client): {
125
+ assetFolders: {
126
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
127
+ query?: ListAssetFoldersData["query"];
128
+ signal?: AbortSignal;
129
+ throwOnError?: ThrowOnError | undefined;
130
+ fetchOptions?: FetchOptions;
131
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
132
+ asset_folders: Array<AssetFolder>;
133
+ }, ThrowOnError>>;
134
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
135
+ signal?: AbortSignal;
136
+ throwOnError?: ThrowOnError | undefined;
137
+ fetchOptions?: FetchOptions;
138
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
139
+ asset_folder: AssetFolder;
140
+ }, ThrowOnError>>;
141
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
142
+ body: CreateAssetFolderData["body"];
143
+ signal?: AbortSignal;
144
+ throwOnError?: ThrowOnError | undefined;
145
+ fetchOptions?: FetchOptions;
146
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
147
+ asset_folder: AssetFolder;
148
+ }, ThrowOnError>>;
149
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options: {
150
+ body: UpdateAssetFolderData["body"];
151
+ signal?: AbortSignal;
152
+ throwOnError?: ThrowOnError | undefined;
153
+ fetchOptions?: FetchOptions;
154
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
155
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetFolderId: number, options?: {
156
+ query?: DeleteAssetFolderData["query"];
157
+ signal?: AbortSignal;
158
+ throwOnError?: ThrowOnError | undefined;
159
+ fetchOptions?: FetchOptions;
160
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
161
+ };
162
+ assets: {
163
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
164
+ query?: ListAssetsData["query"];
165
+ signal?: AbortSignal;
166
+ throwOnError?: ThrowOnError | undefined;
167
+ fetchOptions?: FetchOptions;
168
+ } & SpaceIdPathOverride): Promise<ApiResponse<ListAssetsResult, ThrowOnError>>;
169
+ signResponseObject<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
170
+ query: CreateAssetData["query"];
171
+ signal?: AbortSignal;
172
+ throwOnError?: ThrowOnError | undefined;
173
+ fetchOptions?: FetchOptions;
174
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateAsset, ThrowOnError>>;
175
+ upload(options: {
176
+ body: AssetUploadRequest;
177
+ file: Blob | ArrayBuffer;
178
+ signal?: AbortSignal;
179
+ fetchOptions?: FetchOptions;
180
+ } & SpaceIdPathOverride): Promise<Asset$1>;
181
+ create(options: {
182
+ body: AssetCreate;
183
+ file: Blob | ArrayBuffer;
184
+ signal?: AbortSignal;
185
+ fetchOptions?: FetchOptions;
186
+ } & SpaceIdPathOverride): Promise<Asset$1>;
187
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
188
+ signal?: AbortSignal;
189
+ throwOnError?: ThrowOnError | undefined;
190
+ fetchOptions?: FetchOptions;
191
+ } & SpaceIdPathOverride): Promise<ApiResponse<ShowAsset, ThrowOnError>>;
192
+ update(assetId: number, options: ({
193
+ body: UpdateAssetData["body"];
194
+ file?: undefined;
195
+ } | {
196
+ body: AssetUpdateRequest & {
197
+ short_filename: string;
198
+ };
199
+ file: Blob | ArrayBuffer;
200
+ }) & {
201
+ signal?: AbortSignal;
202
+ fetchOptions?: FetchOptions;
203
+ } & SpaceIdPathOverride): Promise<void>;
204
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
205
+ signal?: AbortSignal;
206
+ throwOnError?: ThrowOnError | undefined;
207
+ fetchOptions?: FetchOptions;
208
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset, ThrowOnError>>;
209
+ finalize<ThrowOnError extends boolean = DefaultThrowOnError>(assetId: number, options?: {
210
+ signal?: AbortSignal;
211
+ throwOnError?: ThrowOnError | undefined;
212
+ fetchOptions?: FetchOptions;
213
+ } & SpaceIdPathOverride): Promise<ApiResponse<FinishUploadAsset, ThrowOnError>>;
214
+ deleteMany<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
215
+ body: BulkDestroyAssetsData["body"];
216
+ signal?: AbortSignal;
217
+ throwOnError?: ThrowOnError | undefined;
218
+ fetchOptions?: FetchOptions;
219
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
220
+ message: string;
221
+ }, ThrowOnError>>;
222
+ bulkMove<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
223
+ body: BulkUpdateAssetsData["body"];
224
+ signal?: AbortSignal;
225
+ throwOnError?: ThrowOnError | undefined;
226
+ fetchOptions?: FetchOptions;
227
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
228
+ message: string;
229
+ }, ThrowOnError>>;
230
+ bulkRestore<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
231
+ body: BulkRestoreAssetsData["body"];
232
+ signal?: AbortSignal;
233
+ throwOnError?: ThrowOnError | undefined;
234
+ fetchOptions?: FetchOptions;
235
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
236
+ message: string;
237
+ }, ThrowOnError>>;
238
+ convertToShared<ThrowOnError extends boolean = false>(assetId: number | string, options: {
239
+ query: {
240
+ target_asset_folder_id: number;
241
+ };
242
+ signal?: AbortSignal;
243
+ throwOnError?: ThrowOnError | undefined;
244
+ fetchOptions?: FetchOptions;
245
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset$1, ThrowOnError>>;
246
+ };
247
+ componentFolders: {
248
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
249
+ query?: ListComponentGroupsData["query"];
250
+ signal?: AbortSignal;
251
+ throwOnError?: ThrowOnError | undefined;
252
+ fetchOptions?: FetchOptions;
253
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
254
+ component_groups: Array<ComponentGroup>;
255
+ }, ThrowOnError>>;
256
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
257
+ signal?: AbortSignal;
258
+ throwOnError?: ThrowOnError | undefined;
259
+ fetchOptions?: FetchOptions;
260
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
261
+ component_group: ComponentGroup;
262
+ }, ThrowOnError>>;
263
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
264
+ body: CreateComponentGroupData["body"];
265
+ signal?: AbortSignal;
266
+ throwOnError?: ThrowOnError | undefined;
267
+ fetchOptions?: FetchOptions;
268
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
269
+ component_group: ComponentGroup;
270
+ }, ThrowOnError>>;
271
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options: {
272
+ body: UpdateComponentGroupData["body"];
273
+ signal?: AbortSignal;
274
+ throwOnError?: ThrowOnError | undefined;
275
+ fetchOptions?: FetchOptions;
276
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
277
+ component_group: ComponentGroup;
278
+ }, ThrowOnError>>;
279
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(componentGroupId: number, options?: {
280
+ signal?: AbortSignal;
281
+ throwOnError?: ThrowOnError | undefined;
282
+ fetchOptions?: FetchOptions;
283
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
284
+ };
285
+ datasourceEntries: {
286
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
287
+ query?: ListDatasourceEntriesData["query"];
288
+ signal?: AbortSignal;
289
+ throwOnError?: ThrowOnError | undefined;
290
+ fetchOptions?: FetchOptions;
291
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntriesIndexResponse, ThrowOnError>>;
292
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options?: {
293
+ signal?: AbortSignal;
294
+ throwOnError?: ThrowOnError | undefined;
295
+ fetchOptions?: FetchOptions;
296
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
297
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
298
+ body: CreateDatasourceEntryData["body"];
299
+ signal?: AbortSignal;
300
+ throwOnError?: ThrowOnError | undefined;
301
+ fetchOptions?: FetchOptions;
302
+ } & SpaceIdPathOverride): Promise<ApiResponse<DatasourceEntryShowResponse, ThrowOnError>>;
303
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options: {
304
+ body: PartialUpdateDatasourceEntryData["body"];
305
+ query?: {
306
+ dimension_id?: number;
307
+ } | undefined;
308
+ signal?: AbortSignal;
309
+ throwOnError?: ThrowOnError | undefined;
310
+ fetchOptions?: FetchOptions;
311
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
312
+ replace<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options: {
313
+ body: ReplaceDatasourceEntryData["body"];
314
+ signal?: AbortSignal;
315
+ throwOnError?: ThrowOnError | undefined;
316
+ fetchOptions?: FetchOptions;
317
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
318
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceEntryId: number, options?: {
319
+ signal?: AbortSignal;
320
+ throwOnError?: ThrowOnError | undefined;
321
+ fetchOptions?: FetchOptions;
322
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
323
+ };
324
+ datasources: {
325
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
326
+ query?: ListDatasourcesData["query"];
327
+ signal?: AbortSignal;
328
+ throwOnError?: ThrowOnError | undefined;
329
+ fetchOptions?: FetchOptions;
330
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
331
+ datasources: Array<Datasource>;
332
+ }, ThrowOnError>>;
333
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options?: {
334
+ signal?: AbortSignal;
335
+ throwOnError?: ThrowOnError | undefined;
336
+ fetchOptions?: FetchOptions;
337
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
338
+ datasource: Datasource;
339
+ }, ThrowOnError>>;
340
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
341
+ body: CreateDatasourceData["body"];
342
+ signal?: AbortSignal;
343
+ throwOnError?: ThrowOnError | undefined;
344
+ fetchOptions?: FetchOptions;
345
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
346
+ datasource: Datasource;
347
+ }, ThrowOnError>>;
348
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options: {
349
+ body: PartialUpdateDatasourceData["body"];
350
+ signal?: AbortSignal;
351
+ throwOnError?: ThrowOnError | undefined;
352
+ fetchOptions?: FetchOptions;
353
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
354
+ datasource: Datasource;
355
+ }, ThrowOnError>>;
356
+ replace<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options: {
357
+ body: ReplaceDatasourceData["body"];
358
+ signal?: AbortSignal;
359
+ throwOnError?: ThrowOnError | undefined;
360
+ fetchOptions?: FetchOptions;
361
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
362
+ datasource: Datasource;
363
+ }, ThrowOnError>>;
364
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(datasourceId: number | string, options?: {
365
+ signal?: AbortSignal;
366
+ throwOnError?: ThrowOnError | undefined;
367
+ fetchOptions?: FetchOptions;
368
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
369
+ };
370
+ experiments: {
371
+ list<ThrowOnError extends boolean = false>(options?: {
372
+ query?: ListExperimentsData["query"];
373
+ signal?: AbortSignal;
374
+ throwOnError?: ThrowOnError;
375
+ fetchOptions?: FetchOptions;
376
+ } & SpaceIdPathOverride): Promise<ApiResponse<ListExperimentsResponses[200], ThrowOnError>>;
377
+ get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
378
+ signal?: AbortSignal;
379
+ throwOnError?: ThrowOnError;
380
+ fetchOptions?: FetchOptions;
381
+ } & SpaceIdPathOverride): Promise<ApiResponse<GetExperimentResponses[200], ThrowOnError>>;
382
+ create<ThrowOnError extends boolean = false>(options: {
383
+ body: CreateExperimentData["body"];
384
+ signal?: AbortSignal;
385
+ throwOnError?: ThrowOnError;
386
+ fetchOptions?: FetchOptions;
387
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentResponses[201], ThrowOnError>>;
388
+ update<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
389
+ body: UpdateExperimentData["body"];
390
+ signal?: AbortSignal;
391
+ throwOnError?: ThrowOnError;
392
+ fetchOptions?: FetchOptions;
393
+ } & SpaceIdPathOverride): Promise<ApiResponse<UpdateExperimentResponses[200], ThrowOnError>>;
394
+ delete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
395
+ signal?: AbortSignal;
396
+ throwOnError?: ThrowOnError;
397
+ fetchOptions?: FetchOptions;
398
+ } & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentResponses[204], ThrowOnError>>;
399
+ activate<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
400
+ query?: ActivateExperimentData["query"];
401
+ signal?: AbortSignal;
402
+ throwOnError?: ThrowOnError;
403
+ fetchOptions?: FetchOptions;
404
+ } & SpaceIdPathOverride): Promise<ApiResponse<ActivateExperimentResponses[200], ThrowOnError>>;
405
+ pause<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
406
+ signal?: AbortSignal;
407
+ throwOnError?: ThrowOnError;
408
+ fetchOptions?: FetchOptions;
409
+ } & SpaceIdPathOverride): Promise<ApiResponse<PauseExperimentResponses[200], ThrowOnError>>;
410
+ complete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
411
+ signal?: AbortSignal;
412
+ throwOnError?: ThrowOnError;
413
+ fetchOptions?: FetchOptions;
414
+ } & SpaceIdPathOverride): Promise<ApiResponse<CompleteExperimentResponses[200], ThrowOnError>>;
415
+ completeWithWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
416
+ signal?: AbortSignal;
417
+ throwOnError?: ThrowOnError;
418
+ fetchOptions?: FetchOptions;
419
+ } & SpaceIdPathOverride): Promise<ApiResponse<CompleteExperimentWithWinnerResponses[200], ThrowOnError>>;
420
+ selectWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
421
+ signal?: AbortSignal;
422
+ throwOnError?: ThrowOnError;
423
+ fetchOptions?: FetchOptions;
424
+ } & SpaceIdPathOverride): Promise<ApiResponse<SelectExperimentWinnerResponses[200], ThrowOnError>>;
425
+ stories: {
426
+ create<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
427
+ body: CreateExperimentStoryData["body"];
428
+ signal?: AbortSignal;
429
+ throwOnError?: ThrowOnError;
430
+ fetchOptions?: FetchOptions;
431
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentStoryResponses[201], ThrowOnError>>;
432
+ delete<ThrowOnError extends boolean = false>(experimentId: number | string, storyId: number | string, options?: {
433
+ signal?: AbortSignal;
434
+ throwOnError?: ThrowOnError;
435
+ fetchOptions?: FetchOptions;
436
+ } & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentStoryResponses[204], ThrowOnError>>;
437
+ };
438
+ storyMappings: {
439
+ create<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, options: {
440
+ body: CreateStoryMappingData["body"];
441
+ signal?: AbortSignal;
442
+ throwOnError?: ThrowOnError;
443
+ fetchOptions?: FetchOptions;
444
+ } & SpaceIdPathOverride): Promise<ApiResponse<CreateStoryMappingResponses[201], ThrowOnError>>;
445
+ delete<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, originalStoryId: number | string, options?: {
446
+ signal?: AbortSignal;
447
+ throwOnError?: ThrowOnError;
448
+ fetchOptions?: FetchOptions;
449
+ } & SpaceIdPathOverride): Promise<ApiResponse<DeleteStoryMappingResponses[204], ThrowOnError>>;
450
+ };
451
+ results: {
452
+ get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
453
+ signal?: AbortSignal;
454
+ throwOnError?: ThrowOnError;
455
+ fetchOptions?: FetchOptions;
456
+ } & SpaceIdPathOverride): Promise<ApiResponse<GetExperimentResultsResponses[200], ThrowOnError>>;
457
+ push<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
458
+ body: PushExperimentResultsData["body"];
459
+ signal?: AbortSignal;
460
+ throwOnError?: ThrowOnError;
461
+ fetchOptions?: FetchOptions;
462
+ } & SpaceIdPathOverride): Promise<ApiResponse<PushExperimentResultsResponses[200], ThrowOnError>>;
463
+ };
464
+ };
465
+ delete: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
466
+ get: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
467
+ patch: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
468
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
469
+ internalTags: {
470
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
471
+ query?: ListInternalTagsData["query"];
472
+ signal?: AbortSignal;
473
+ throwOnError?: ThrowOnError | undefined;
474
+ fetchOptions?: FetchOptions;
475
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
476
+ internal_tags: Array<InternalTag>;
477
+ }, ThrowOnError>>;
478
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
479
+ body: CreateInternalTagData["body"];
480
+ signal?: AbortSignal;
481
+ throwOnError?: ThrowOnError | undefined;
482
+ fetchOptions?: FetchOptions;
483
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
484
+ internal_tag: InternalTag;
485
+ }, ThrowOnError>>;
486
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options: {
487
+ body: UpdateInternalTagData["body"];
488
+ signal?: AbortSignal;
489
+ throwOnError?: ThrowOnError | undefined;
490
+ fetchOptions?: FetchOptions;
491
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
492
+ internal_tag: InternalTag;
493
+ }, ThrowOnError>>;
494
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(internalTagId: number, options?: {
495
+ signal?: AbortSignal;
496
+ throwOnError?: ThrowOnError | undefined;
497
+ fetchOptions?: FetchOptions;
498
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
499
+ };
500
+ post: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
501
+ presets: {
502
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
503
+ query?: ListPresetsData["query"];
504
+ signal?: AbortSignal;
505
+ throwOnError?: ThrowOnError | undefined;
506
+ fetchOptions?: FetchOptions;
507
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
508
+ presets: Array<Preset>;
509
+ }, ThrowOnError>>;
510
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
511
+ signal?: AbortSignal;
512
+ throwOnError?: ThrowOnError | undefined;
513
+ fetchOptions?: FetchOptions;
514
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
515
+ preset: Preset;
516
+ }, ThrowOnError>>;
517
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
518
+ body: CreatePresetData["body"];
519
+ signal?: AbortSignal;
520
+ throwOnError?: ThrowOnError | undefined;
521
+ fetchOptions?: FetchOptions;
522
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
523
+ preset: Preset;
524
+ }, ThrowOnError>>;
525
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options: {
526
+ body: UpdatePresetData["body"];
527
+ signal?: AbortSignal;
528
+ throwOnError?: ThrowOnError | undefined;
529
+ fetchOptions?: FetchOptions;
530
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
531
+ preset: Preset;
532
+ }, ThrowOnError>>;
533
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(presetId: number, options?: {
534
+ signal?: AbortSignal;
535
+ throwOnError?: ThrowOnError | undefined;
536
+ fetchOptions?: FetchOptions;
537
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
538
+ preset: Preset;
539
+ }, ThrowOnError>>;
540
+ };
541
+ put: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData, DefaultThrowOnError>>;
542
+ sharedAssetFolders: {
543
+ list<ThrowOnError extends boolean = false>(options?: {
544
+ query?: {
545
+ search?: string;
546
+ with_parent?: string;
547
+ by_ids?: string;
548
+ } | undefined;
549
+ signal?: AbortSignal;
550
+ throwOnError?: ThrowOnError | undefined;
551
+ fetchOptions?: FetchOptions;
552
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedAssetFolderListResponse, ThrowOnError>>;
553
+ get<ThrowOnError extends boolean = false>(folderId: number | string, options?: {
554
+ signal?: AbortSignal;
555
+ throwOnError?: ThrowOnError | undefined;
556
+ fetchOptions?: FetchOptions;
557
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedAssetFolderGetResponse, ThrowOnError>>;
558
+ create<ThrowOnError extends boolean = false>(options: {
559
+ body: {
560
+ shared_asset_folder: SharedAssetFolderCreate;
561
+ };
562
+ signal?: AbortSignal;
563
+ throwOnError?: ThrowOnError | undefined;
564
+ fetchOptions?: FetchOptions;
565
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedAssetFolderGetResponse, ThrowOnError>>;
566
+ update<ThrowOnError extends boolean = false>(folderId: number | string, options: {
567
+ body: {
568
+ shared_asset_folder: SharedAssetFolderUpdate;
569
+ };
570
+ signal?: AbortSignal;
571
+ throwOnError?: ThrowOnError | undefined;
572
+ fetchOptions?: FetchOptions;
573
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
574
+ delete<ThrowOnError extends boolean = false>(folderId: number | string, options?: {
575
+ query?: {
576
+ recursive?: boolean;
577
+ } | undefined;
578
+ signal?: AbortSignal;
579
+ throwOnError?: ThrowOnError | undefined;
580
+ fetchOptions?: FetchOptions;
581
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
582
+ };
583
+ sharedAssets: {
584
+ list<ThrowOnError extends boolean = false>(options?: {
585
+ query?: SharedAssetListQuery;
586
+ signal?: AbortSignal;
587
+ throwOnError?: ThrowOnError | undefined;
588
+ fetchOptions?: FetchOptions;
589
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedAssetListResponse, ThrowOnError>>;
590
+ get<ThrowOnError extends boolean = false>(assetId: number | string, options?: {
591
+ signal?: AbortSignal;
592
+ throwOnError?: ThrowOnError | undefined;
593
+ fetchOptions?: FetchOptions;
594
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset$1, ThrowOnError>>;
595
+ upload(options: {
596
+ body: SharedAssetUploadRequest;
597
+ file: Blob | ArrayBuffer;
598
+ signal?: AbortSignal;
599
+ fetchOptions?: FetchOptions;
600
+ } & SpaceIdPathOverride): Promise<Asset$1>;
601
+ create(options: {
602
+ body: SharedAssetCreate;
603
+ file: Blob | ArrayBuffer;
604
+ signal?: AbortSignal;
605
+ fetchOptions?: FetchOptions;
606
+ } & SpaceIdPathOverride): Promise<Asset$1>;
607
+ update(assetId: number | string, options: ({
608
+ body: {
609
+ asset: AssetUpdate;
610
+ };
611
+ file?: undefined;
612
+ } | {
613
+ body: {
614
+ asset: AssetUpdate;
615
+ short_filename: string;
616
+ };
617
+ file: Blob | ArrayBuffer;
618
+ }) & {
619
+ signal?: AbortSignal;
620
+ fetchOptions?: FetchOptions;
621
+ } & SpaceIdPathOverride): Promise<void>;
622
+ delete<ThrowOnError extends boolean = false>(assetId: number | string, options?: {
623
+ signal?: AbortSignal;
624
+ throwOnError?: ThrowOnError | undefined;
625
+ fetchOptions?: FetchOptions;
626
+ } & SpaceIdPathOverride): Promise<ApiResponse<Asset$1, ThrowOnError>>;
627
+ };
628
+ sharedInternalTags: {
629
+ list<ThrowOnError extends boolean = false>(options: {
630
+ query: SharedInternalTagListQuery;
631
+ signal?: AbortSignal;
632
+ throwOnError?: ThrowOnError | undefined;
633
+ fetchOptions?: FetchOptions;
634
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedInternalTagListResponse, ThrowOnError>>;
635
+ create<ThrowOnError extends boolean = false>(options: {
636
+ body: {
637
+ shared_internal_tag: SharedInternalTagCreate;
638
+ };
639
+ signal?: AbortSignal;
640
+ throwOnError?: ThrowOnError | undefined;
641
+ fetchOptions?: FetchOptions;
642
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedInternalTagMutateResponse, ThrowOnError>>;
643
+ update<ThrowOnError extends boolean = false>(tagId: number, options: {
644
+ body: {
645
+ shared_internal_tag: SharedInternalTagCreate;
646
+ };
647
+ signal?: AbortSignal;
648
+ throwOnError?: ThrowOnError | undefined;
649
+ fetchOptions?: FetchOptions;
650
+ } & SpaceIdPathOverride): Promise<ApiResponse<SharedInternalTagMutateResponse, ThrowOnError>>;
651
+ delete<ThrowOnError extends boolean = false>(tagId: number, options: {
652
+ query: {
653
+ asset_folder_id: number;
654
+ };
655
+ signal?: AbortSignal;
656
+ throwOnError?: ThrowOnError | undefined;
657
+ fetchOptions?: FetchOptions;
658
+ } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
659
+ };
660
+ spaces: {
661
+ list<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
662
+ query?: ListSpacesData["query"];
663
+ signal?: AbortSignal;
664
+ throwOnError?: ThrowOnError | undefined;
665
+ fetchOptions?: FetchOptions;
666
+ }): Promise<ApiResponse<{
667
+ spaces: Array<Space>;
668
+ }, ThrowOnError>>;
669
+ create<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
670
+ body: CreateSpaceData["body"];
671
+ query?: CreateSpaceData["query"];
672
+ signal?: AbortSignal;
673
+ throwOnError?: ThrowOnError | undefined;
674
+ fetchOptions?: FetchOptions;
675
+ }): Promise<ApiResponse<{
676
+ space: SpaceDetail;
677
+ }, ThrowOnError>>;
678
+ get<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
679
+ signal?: AbortSignal;
680
+ throwOnError?: ThrowOnError | undefined;
681
+ fetchOptions?: FetchOptions;
682
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
683
+ space: SpaceDetail;
684
+ }, ThrowOnError>>;
685
+ update<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
686
+ body: UpdateSpaceData["body"];
687
+ signal?: AbortSignal;
688
+ throwOnError?: ThrowOnError | undefined;
689
+ fetchOptions?: FetchOptions;
690
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
691
+ space: SpaceDetail;
692
+ }, ThrowOnError>>;
693
+ delete<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
694
+ signal?: AbortSignal;
695
+ throwOnError?: ThrowOnError | undefined;
696
+ fetchOptions?: FetchOptions;
697
+ } & SpaceIdPathOverride): Promise<ApiResponse<{
698
+ space: Space;
699
+ }, ThrowOnError>>;
700
+ };
701
+ users: {
702
+ me<ThrowOnError extends boolean = DefaultThrowOnError>(options?: {
703
+ signal?: AbortSignal;
704
+ throwOnError?: ThrowOnError | undefined;
705
+ fetchOptions?: FetchOptions;
706
+ }): Promise<ApiResponse<{
707
+ user: User;
708
+ }, ThrowOnError>>;
709
+ updateMe<ThrowOnError extends boolean = DefaultThrowOnError>(options: {
710
+ body: UpdateCurrentUserData["body"];
711
+ signal?: AbortSignal;
712
+ throwOnError?: ThrowOnError | undefined;
713
+ fetchOptions?: FetchOptions;
714
+ }): Promise<ApiResponse<{
715
+ user: User;
716
+ }, ThrowOnError>>;
717
+ };
718
+ };
719
+ type StoryblokTypesConfig = {
720
+ components: Block;
721
+ } | {
722
+ blocks: Block;
723
+ };
724
+ type ResolveComponents<T extends StoryblokTypesConfig> = T extends {
725
+ components: infer C extends Block;
726
+ } ? C : T extends {
727
+ blocks: infer B extends Block;
728
+ } ? B : never;
729
+ /** Extracts the `fieldType → value` plugin map from a Schema, defaulting to an empty map. */
730
+ type ResolveFieldPlugins<T> = T extends {
731
+ fieldPlugins: infer P;
732
+ } ? P : Record<never, never>;
733
+ /**
734
+ * The return type of `createManagementApiClient`, parameterised by `TBlocks` so that
735
+ * `.stories` methods can narrow story content types without touching the runtime object.
736
+ * Component *definitions* (`.components`) are wire-shaped and not narrowed by `TBlocks`.
737
+ */
738
+ type ManagementApiClient<TBlocks extends Block = Block, TFieldPlugins = Record<never, never>, DefaultThrowOnError extends boolean = false> = ReturnType<typeof buildResources<DefaultThrowOnError>> & {
739
+ components: ReturnType<typeof createComponentsResource<DefaultThrowOnError>>;
740
+ stories: ReturnType<typeof createStoriesResource<TBlocks, TFieldPlugins, DefaultThrowOnError>>;
741
+ /**
742
+ * Returns the same client instance cast to a version that narrows story content
743
+ * to the provided component types. No runtime cost — type parameter is erased.
744
+ *
745
+ * Accepts either `{ components: ... }` or `{ blocks: ... }` — the latter matches the
746
+ * `Schema` type produced by `@storyblok/schema`'s `InferSchema`.
747
+ *
748
+ * @example
749
+ * ```ts
750
+ * import type { Schema } from './schema';
751
+ *
752
+ * const client = createManagementApiClient({ personalAccessToken: '...' })
753
+ * .withTypes<Schema>();
754
+ * ```
755
+ */
756
+ withTypes: <T extends StoryblokTypesConfig>() => ManagementApiClient<ResolveComponents<T>, ResolveFieldPlugins<T>, DefaultThrowOnError>;
757
+ };
758
+ declare const createManagementApiClient: <DefaultThrowOnError extends boolean = false>(config: ManagementApiClientConfig<DefaultThrowOnError>) => ManagementApiClient<Block, Record<never, never>, DefaultThrowOnError>;
759
+ //#endregion
760
+ export { ApiResponse, FetchOptions, HttpRequestOptions, ManagementApiClient, ManagementApiClientConfig, MapiResourceDeps, RequestConfigOverrides, createManagementApiClient };
761
+ //# sourceMappingURL=client.d.mts.map