@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
@@ -1,1306 +0,0 @@
1
- //#region src/generated/stories/types.gen.d.ts
2
- type StoryCreate = StoryCreate2;
3
- type StoryUpdate = StoryUpdate2;
4
- /**
5
- * Minimal story object for alternates
6
- */
7
- type StoryAlternate = {
8
- /**
9
- * The numeric ID
10
- */
11
- id: number;
12
- /**
13
- * The complete name provided for the story
14
- */
15
- name: string;
16
- /**
17
- * The slug specific for the story
18
- */
19
- slug: string;
20
- /**
21
- * true if a story is currently published, even if it has unpublished changes
22
- */
23
- published: boolean;
24
- /**
25
- * The full slug of the story, combining the parent folder(s) and the designated story slug
26
- */
27
- full_slug: string;
28
- /**
29
- * true if the instance constitutes a folder
30
- */
31
- is_folder: boolean;
32
- /**
33
- * ID of the parent folder. 0 for root-level stories.
34
- */
35
- parent_id: number;
36
- };
37
- /**
38
- * Asset field type - single asset (image, video, audio, or document)
39
- */
40
- type AssetField = {
41
- /**
42
- * Identifies this as an asset field
43
- */
44
- fieldtype: 'asset';
45
- /**
46
- * Numeric ID of the asset
47
- */
48
- id: number | null;
49
- /**
50
- * Alternative text for the asset
51
- */
52
- alt: string | null;
53
- /**
54
- * Name of the asset
55
- */
56
- name?: string;
57
- /**
58
- * Focal point coordinates for cropping (format "123x456:789x1011")
59
- */
60
- focus?: string | null;
61
- /**
62
- * Title of the asset
63
- */
64
- title?: string | null;
65
- /**
66
- * Source attribution for the asset
67
- */
68
- source?: string | null;
69
- /**
70
- * URL to the asset file
71
- */
72
- filename: string;
73
- /**
74
- * Copyright information
75
- */
76
- copyright?: string | null;
77
- /**
78
- * Additional metadata for the asset
79
- */
80
- meta_data?: {
81
- [key: string]: unknown;
82
- };
83
- /**
84
- * Whether the asset is hosted externally
85
- */
86
- is_external_url?: boolean;
87
- };
88
- /**
89
- * Content object representing a component instance. Contains a _uid, a component technical name, and dynamic fields whose values depend on the component's schema field types (text, textarea, richtext, markdown, number, datetime, boolean, option, options, asset, multiasset, multilink, bloks, table, section, custom/plugin).
90
- */
91
- type StoryContent = {
92
- /**
93
- * Unique identifier for this component instance
94
- */
95
- _uid: string;
96
- /**
97
- * Technical name of the component (content type or nestable block)
98
- */
99
- component: string;
100
- /**
101
- * Storyblok editor markup string for inline editing (present in draft/preview mode)
102
- */
103
- _editable?: string;
104
- [key: string]: string | number | boolean | Array<string | AssetField | StoryContent> | AssetField | MultilinkField | TableField | RichtextField | PluginField | string | undefined;
105
- };
106
- /**
107
- * Multilink field type - link to internal stories, external URLs, emails, etc.
108
- */
109
- type MultilinkField = {
110
- /**
111
- * Identifies this as a multilink field
112
- */
113
- fieldtype: 'multilink';
114
- /**
115
- * UUID of the linked story (for internal links)
116
- */
117
- id: string;
118
- /**
119
- * URL for external links or email addresses
120
- */
121
- url: string;
122
- /**
123
- * Type of link
124
- */
125
- linktype: 'story' | 'url' | 'email' | 'asset';
126
- /**
127
- * Cached URL path for the linked story
128
- */
129
- cached_url: string;
130
- /**
131
- * Anchor/fragment identifier for the link
132
- */
133
- anchor?: string | null;
134
- /**
135
- * Link target attribute
136
- */
137
- target?: '_self' | '_blank' | null;
138
- };
139
- /**
140
- * Table field type - structured table data
141
- */
142
- type TableField = {
143
- /**
144
- * Table header cells
145
- */
146
- thead: Array<{
147
- _uid: string;
148
- component: '_table_head';
149
- /**
150
- * Header cell content
151
- */
152
- value?: string;
153
- }>;
154
- /**
155
- * Table body rows
156
- */
157
- tbody: Array<{
158
- _uid: string;
159
- component: '_table_row';
160
- /**
161
- * Cells in this row
162
- */
163
- body?: Array<{
164
- _uid: string;
165
- component: '_table_col';
166
- /**
167
- * Cell content
168
- */
169
- value?: string;
170
- }>;
171
- }>;
172
- };
173
- /**
174
- * Richtext field type - structured rich text document (ProseMirror format)
175
- */
176
- type RichtextField = {
177
- /**
178
- * Root node type for richtext documents
179
- */
180
- type: 'doc';
181
- /**
182
- * Array of richtext nodes (paragraphs, headings, lists, bloks, etc.)
183
- */
184
- content?: Array<{
185
- [key: string]: unknown;
186
- }>;
187
- };
188
- /**
189
- * Plugin/Custom field type - field plugin with custom structure
190
- */
191
- type PluginField = {
192
- /**
193
- * Technical name of the field plugin
194
- */
195
- plugin: string;
196
- /**
197
- * Unique identifier for this plugin field instance
198
- */
199
- _uid?: string;
200
- [key: string]: unknown | string | undefined;
201
- };
202
- /**
203
- * Translated slug object (from Translatable Slugs app)
204
- */
205
- type StoryTranslatedSlug = {
206
- /**
207
- * Translated slug path
208
- */
209
- path: string | null;
210
- /**
211
- * Language code of the current language
212
- */
213
- lang: string;
214
- /**
215
- * The complete name provided for the story
216
- */
217
- name?: string | null;
218
- /**
219
- * true if a story is currently published, even if it has unpublished changes
220
- */
221
- published?: boolean | null;
222
- };
223
- /**
224
- * Localized path object (from Translatable Slugs app)
225
- */
226
- type StoryLocalizedPath = {
227
- /**
228
- * Value of the real path defined in the story's entry configuration
229
- */
230
- path: string;
231
- /**
232
- * The complete name provided for the story
233
- */
234
- name?: string | null;
235
- /**
236
- * Language code of the current language
237
- */
238
- lang: string;
239
- /**
240
- * true if a story is currently published, even if it has unpublished changes
241
- */
242
- published?: boolean | null;
243
- };
244
- /**
245
- * Common Storyblok story fields shared by Content Delivery and Management APIs
246
- */
247
- type StoryBase = {
248
- /**
249
- * Numeric id of the story
250
- */
251
- readonly id: number;
252
- /**
253
- * The complete name provided for the story
254
- */
255
- name: string;
256
- /**
257
- * ID of the parent folder. 0 for root-level stories.
258
- */
259
- parent_id: number;
260
- /**
261
- * Group ID (UUID string), shared between stories defined as alternates
262
- */
263
- group_id: string;
264
- /**
265
- * An array containing objects that provide basic data of the stories defined as alternates of the current story
266
- */
267
- alternates: Array<StoryAlternate>;
268
- /**
269
- * Creation date yyyy-MM-dd'T'HH:mm:ssZ
270
- */
271
- created_at: string;
272
- /**
273
- * Date defined in the story's entry configuration YYYY-mm-dd
274
- */
275
- sort_by_date: string | null;
276
- /**
277
- * Array of tag names
278
- */
279
- tag_list: Array<string>;
280
- /**
281
- * Latest update date yyyy-MM-dd'T'HH:mm:ssZ
282
- */
283
- updated_at: string;
284
- /**
285
- * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
286
- */
287
- published_at: string | null;
288
- /**
289
- * Generated UUID string
290
- */
291
- readonly uuid: string;
292
- content: StoryContent;
293
- /**
294
- * The slug specific for the story
295
- */
296
- slug: string;
297
- /**
298
- * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor)
299
- */
300
- path: string | null;
301
- /**
302
- * The full slug of the story, combining the parent folder(s) and the designated story slug
303
- */
304
- full_slug: string;
305
- /**
306
- * true if the story is defined as root for the folder
307
- */
308
- is_startpage: boolean;
309
- /**
310
- * Object to store non-editable data that is exclusively maintained with the Management API
311
- */
312
- meta_data: {
313
- [key: string]: unknown;
314
- } | null;
315
- /**
316
- * First publishing date yyyy-MM-dd'T'HH:mm:ssZ
317
- */
318
- first_published_at: string | null;
319
- /**
320
- * Array of translated slug objects (if the app Translatable Slugs is installed)
321
- */
322
- translated_slugs: Array<StoryTranslatedSlug> | null;
323
- /**
324
- * An array of translated path objects
325
- */
326
- localized_paths?: Array<StoryLocalizedPath>;
327
- /**
328
- * Numeric representation of the story's position in the folder
329
- */
330
- position: number;
331
- };
332
- /**
333
- * Storyblok story object from the Management API.
334
- */
335
- type StoryMapi = StoryBase & {
336
- /**
337
- * Deletion date and time.
338
- */
339
- deleted_at?: string | null;
340
- /**
341
- * Whether the entry is a folder.
342
- */
343
- is_folder?: boolean;
344
- /**
345
- * Whether the story is currently published.
346
- */
347
- published?: boolean;
348
- /**
349
- * Default content type for stories in this folder.
350
- */
351
- default_root?: string | null;
352
- /**
353
- * Whether the Visual Editor is disabled.
354
- */
355
- disable_fe_editor?: boolean;
356
- /**
357
- * Subset of parent folder info (resolved from parent_id).
358
- */
359
- parent?: {
360
- [key: string]: unknown;
361
- };
362
- /**
363
- * Whether the story has unpublished changes.
364
- */
365
- unpublished_changes?: boolean;
366
- /**
367
- * Latest import date.
368
- */
369
- imported_at?: string | null;
370
- preview_token?: {
371
- token?: string;
372
- timestamp?: string;
373
- };
374
- /**
375
- * Legacy UI feature replaced by favourite_for_user_ids.
376
- */
377
- pinned?: boolean;
378
- breadcrumbs?: Array<{
379
- id?: number;
380
- name?: string;
381
- parent_id?: number;
382
- disable_fe_editor?: boolean;
383
- path?: string;
384
- slug?: string;
385
- translated_slugs?: Array<StoryTranslatedSlug>;
386
- }>;
387
- last_author?: {
388
- id?: number;
389
- userid?: string;
390
- friendly_name?: string;
391
- };
392
- /**
393
- * ID of the last user who interacted with the story.
394
- */
395
- last_author_id?: number;
396
- translated_slugs_attributes?: Array<{
397
- id?: number;
398
- lang?: string;
399
- slug?: string;
400
- name?: string;
401
- published?: boolean;
402
- }>;
403
- /**
404
- * ID of the current release.
405
- */
406
- release_id?: number;
407
- /**
408
- * Scheduled publishing date.
409
- */
410
- scheduled_dates?: string;
411
- /**
412
- * User IDs who saved the story as Favorite.
413
- */
414
- favourite_for_user_ids?: Array<number>;
415
- /**
416
- * User IDs assigned to a workflow stage.
417
- */
418
- user_ids?: Array<number>;
419
- /**
420
- * Space role IDs assigned to a workflow stage.
421
- */
422
- space_role_ids?: Array<number>;
423
- /**
424
- * Release IDs associated with the story.
425
- */
426
- release_ids?: Array<number>;
427
- /**
428
- * Version ID of the story's latest content within the release.
429
- */
430
- current_version_id?: number;
431
- /**
432
- * Version ID of the story's content when first added to a release.
433
- */
434
- base_version_id?: number;
435
- /**
436
- * Version ID of the story's current content outside the release.
437
- */
438
- main_version_id?: number;
439
- /**
440
- * Current workflow stage details.
441
- */
442
- stage?: {
443
- workflow_id?: number;
444
- workflow_stage_id?: number;
445
- story_id?: number;
446
- due_date?: string;
447
- created_at?: string;
448
- };
449
- };
450
- /**
451
- * Input for creating a story.
452
- */
453
- type StoryCreate2 = {
454
- /**
455
- * The numeric ID of the story. Can be passed in the body per the MAPI docs.
456
- */
457
- id?: number;
458
- /**
459
- * The complete name provided for the story.
460
- */
461
- name: string;
462
- /**
463
- * The slug specific for the story. Auto-generated as a UUID when omitted.
464
- */
465
- slug?: string;
466
- content?: StoryContent;
467
- /**
468
- * ID of the parent folder.
469
- */
470
- parent_id?: number;
471
- /**
472
- * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
473
- */
474
- path?: string | null;
475
- /**
476
- * true if the story is defined as root for the folder.
477
- */
478
- is_startpage?: boolean;
479
- /**
480
- * Array of tag names.
481
- */
482
- tag_list?: Array<string>;
483
- /**
484
- * Date defined in the story's entry configuration YYYY-mm-dd.
485
- */
486
- sort_by_date?: string | null;
487
- /**
488
- * Numeric representation of the story's position in the folder.
489
- */
490
- position?: number;
491
- /**
492
- * Object to store non-editable data that is exclusively maintained with the Management API.
493
- */
494
- meta_data?: {
495
- [key: string]: unknown;
496
- } | null;
497
- /**
498
- * Whether the entry is a folder.
499
- */
500
- is_folder?: boolean;
501
- /**
502
- * Default content type for stories in this folder.
503
- */
504
- default_root?: string | null;
505
- /**
506
- * Whether the Visual Editor is disabled.
507
- */
508
- disable_fe_editor?: boolean;
509
- /**
510
- * Translated slug entries to create, update, or delete.
511
- */
512
- translated_slugs_attributes?: Array<{
513
- id?: number;
514
- lang?: string;
515
- slug?: string;
516
- name?: string;
517
- published?: boolean;
518
- }>;
519
- };
520
- type StoryCreateRequest2 = {
521
- story: StoryCreate2;
522
- /**
523
- * Should the story be published immediately (set 1 to publish)
524
- */
525
- publish?: number;
526
- /**
527
- * ID of the current release (can be requested with the from_release API parameter)
528
- */
529
- release_id?: number;
530
- };
531
- /**
532
- * Input for updating a story.
533
- */
534
- type StoryUpdate2 = {
535
- /**
536
- * The numeric ID of the story. Can be passed in the update body per the MAPI docs.
537
- */
538
- id?: number;
539
- /**
540
- * The complete name provided for the story.
541
- */
542
- name?: string;
543
- /**
544
- * The slug specific for the story.
545
- */
546
- slug?: string;
547
- content?: StoryContent;
548
- /**
549
- * ID of the parent folder.
550
- */
551
- parent_id?: number;
552
- /**
553
- * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
554
- */
555
- path?: string | null;
556
- /**
557
- * true if the story is defined as root for the folder.
558
- */
559
- is_startpage?: boolean;
560
- /**
561
- * Array of tag names.
562
- */
563
- tag_list?: Array<string>;
564
- /**
565
- * Date defined in the story's entry configuration YYYY-mm-dd.
566
- */
567
- sort_by_date?: string | null;
568
- /**
569
- * Numeric representation of the story's position in the folder.
570
- */
571
- position?: number;
572
- /**
573
- * Object to store non-editable data that is exclusively maintained with the Management API.
574
- */
575
- meta_data?: {
576
- [key: string]: unknown;
577
- } | null;
578
- /**
579
- * Whether the entry is a folder.
580
- */
581
- is_folder?: boolean;
582
- /**
583
- * Default content type for stories in this folder.
584
- */
585
- default_root?: string | null;
586
- /**
587
- * Whether the Visual Editor is disabled.
588
- */
589
- disable_fe_editor?: boolean;
590
- /**
591
- * Translated slug entries to create, update, or delete.
592
- */
593
- translated_slugs_attributes?: Array<{
594
- id?: number;
595
- lang?: string;
596
- slug?: string;
597
- name?: string;
598
- published?: boolean;
599
- }>;
600
- };
601
- type StoryUpdateRequest2 = {
602
- story: StoryUpdate2;
603
- /**
604
- * Group ID (UUID string), shared between stories defined as alternates
605
- */
606
- group_id?: string;
607
- /**
608
- * If this is 1, the request can overwrite a locked story. Note that a user currently editing the story (which is why it was locked) will encounter a content conflict model. Importantly, note that force_update does not work when editing is locked for the workflow stage that the story currently is in
609
- */
610
- force_update?: '0' | '1';
611
- /**
612
- * Numeric ID of release (optional)
613
- */
614
- release_id?: number;
615
- /**
616
- * Should the story be published immediately (set 1 to publish)
617
- */
618
- publish?: number;
619
- /**
620
- * Language code to publish the story individually (must be enabled in the space settings)
621
- */
622
- lang?: string;
623
- };
624
- /**
625
- * Request body for duplicating a story
626
- */
627
- type StoryDuplicateRequestWritable = {
628
- story?: StoryMapiWritable;
629
- /**
630
- * The id of the target folder
631
- */
632
- target_dimension?: number;
633
- /**
634
- * If set to true, the current story's path attribute will used for the duplicated story
635
- */
636
- same_path?: boolean;
637
- };
638
- /**
639
- * Common Storyblok story fields shared by Content Delivery and Management APIs
640
- */
641
- type StoryBaseWritable = {
642
- /**
643
- * The complete name provided for the story
644
- */
645
- name: string;
646
- /**
647
- * ID of the parent folder. 0 for root-level stories.
648
- */
649
- parent_id: number;
650
- /**
651
- * Group ID (UUID string), shared between stories defined as alternates
652
- */
653
- group_id: string;
654
- /**
655
- * An array containing objects that provide basic data of the stories defined as alternates of the current story
656
- */
657
- alternates: Array<StoryAlternate>;
658
- /**
659
- * Creation date yyyy-MM-dd'T'HH:mm:ssZ
660
- */
661
- created_at: string;
662
- /**
663
- * Date defined in the story's entry configuration YYYY-mm-dd
664
- */
665
- sort_by_date: string | null;
666
- /**
667
- * Array of tag names
668
- */
669
- tag_list: Array<string>;
670
- /**
671
- * Latest update date yyyy-MM-dd'T'HH:mm:ssZ
672
- */
673
- updated_at: string;
674
- /**
675
- * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
676
- */
677
- published_at: string | null;
678
- content: StoryContent;
679
- /**
680
- * The slug specific for the story
681
- */
682
- slug: string;
683
- /**
684
- * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor)
685
- */
686
- path: string | null;
687
- /**
688
- * The full slug of the story, combining the parent folder(s) and the designated story slug
689
- */
690
- full_slug: string;
691
- /**
692
- * true if the story is defined as root for the folder
693
- */
694
- is_startpage: boolean;
695
- /**
696
- * Object to store non-editable data that is exclusively maintained with the Management API
697
- */
698
- meta_data: {
699
- [key: string]: unknown;
700
- } | null;
701
- /**
702
- * First publishing date yyyy-MM-dd'T'HH:mm:ssZ
703
- */
704
- first_published_at: string | null;
705
- /**
706
- * Array of translated slug objects (if the app Translatable Slugs is installed)
707
- */
708
- translated_slugs: Array<StoryTranslatedSlug> | null;
709
- /**
710
- * An array of translated path objects
711
- */
712
- localized_paths?: Array<StoryLocalizedPath>;
713
- /**
714
- * Numeric representation of the story's position in the folder
715
- */
716
- position: number;
717
- };
718
- /**
719
- * Storyblok story object from the Management API.
720
- */
721
- type StoryMapiWritable = StoryBaseWritable & {
722
- /**
723
- * Deletion date and time.
724
- */
725
- deleted_at?: string | null;
726
- /**
727
- * Whether the entry is a folder.
728
- */
729
- is_folder?: boolean;
730
- /**
731
- * Whether the story is currently published.
732
- */
733
- published?: boolean;
734
- /**
735
- * Default content type for stories in this folder.
736
- */
737
- default_root?: string | null;
738
- /**
739
- * Whether the Visual Editor is disabled.
740
- */
741
- disable_fe_editor?: boolean;
742
- /**
743
- * Subset of parent folder info (resolved from parent_id).
744
- */
745
- parent?: {
746
- [key: string]: unknown;
747
- };
748
- /**
749
- * Whether the story has unpublished changes.
750
- */
751
- unpublished_changes?: boolean;
752
- /**
753
- * Latest import date.
754
- */
755
- imported_at?: string | null;
756
- preview_token?: {
757
- token?: string;
758
- timestamp?: string;
759
- };
760
- /**
761
- * Legacy UI feature replaced by favourite_for_user_ids.
762
- */
763
- pinned?: boolean;
764
- breadcrumbs?: Array<{
765
- id?: number;
766
- name?: string;
767
- parent_id?: number;
768
- disable_fe_editor?: boolean;
769
- path?: string;
770
- slug?: string;
771
- translated_slugs?: Array<StoryTranslatedSlug>;
772
- }>;
773
- last_author?: {
774
- id?: number;
775
- userid?: string;
776
- friendly_name?: string;
777
- };
778
- /**
779
- * ID of the last user who interacted with the story.
780
- */
781
- last_author_id?: number;
782
- translated_slugs_attributes?: Array<{
783
- id?: number;
784
- lang?: string;
785
- slug?: string;
786
- name?: string;
787
- published?: boolean;
788
- }>;
789
- /**
790
- * ID of the current release.
791
- */
792
- release_id?: number;
793
- /**
794
- * Scheduled publishing date.
795
- */
796
- scheduled_dates?: string;
797
- /**
798
- * User IDs who saved the story as Favorite.
799
- */
800
- favourite_for_user_ids?: Array<number>;
801
- /**
802
- * User IDs assigned to a workflow stage.
803
- */
804
- user_ids?: Array<number>;
805
- /**
806
- * Space role IDs assigned to a workflow stage.
807
- */
808
- space_role_ids?: Array<number>;
809
- /**
810
- * Release IDs associated with the story.
811
- */
812
- release_ids?: Array<number>;
813
- /**
814
- * Version ID of the story's latest content within the release.
815
- */
816
- current_version_id?: number;
817
- /**
818
- * Version ID of the story's content when first added to a release.
819
- */
820
- base_version_id?: number;
821
- /**
822
- * Version ID of the story's current content outside the release.
823
- */
824
- main_version_id?: number;
825
- /**
826
- * Current workflow stage details.
827
- */
828
- stage?: {
829
- workflow_id?: number;
830
- workflow_stage_id?: number;
831
- story_id?: number;
832
- due_date?: string;
833
- created_at?: string;
834
- };
835
- };
836
- type ListData = {
837
- body?: never;
838
- path: {
839
- /**
840
- * The ID of the Storyblok space (can be integer or string)
841
- */
842
- space_id: number | string;
843
- };
844
- query?: {
845
- /**
846
- * Page number for pagination. Default is 1.
847
- */
848
- page?: number;
849
- /**
850
- * Number of items per page. Default is 25.
851
- */
852
- per_page?: number;
853
- /**
854
- * Filters by component in all levels of the content. Allows comma separated value for multiple components
855
- */
856
- contain_component?: string;
857
- /**
858
- * Filter by a term using full text search
859
- */
860
- text_search?: string;
861
- /**
862
- * Sort entries by specific attribute and order with content.YOUR_FIELD:asc and content.YOUR_FIELD:desc. To sort integers append :int. To sort floats append :float. Possible values are all root attributes of the entry (_position_ and _parent_position_ are special invisible attributes) and all fields of your content type inside content with a dot as separator.
863
- */
864
- sort_by?: string;
865
- /**
866
- * Filter by pinned stories if '1'
867
- */
868
- pinned?: boolean;
869
- /**
870
- * Exclude specific stories by providing their IDs as a comma-separated string.
871
- */
872
- excluding_ids?: string;
873
- /**
874
- * Filter by ids (comma separated)
875
- */
876
- by_ids?: string;
877
- /**
878
- * Retrieve specific stories by providing their UUIDs as a comma-separated string.
879
- */
880
- by_uuids?: string;
881
- /**
882
- * Filter by specific tag(s). Multiple tags can be provided as a comma-separated string (treated like an OR operator).
883
- */
884
- with_tag?: string;
885
- /**
886
- * Filter by folders only
887
- */
888
- folder_only?: boolean;
889
- /**
890
- * Filter by stories only
891
- */
892
- story_only?: boolean;
893
- /**
894
- * Filter by parent id
895
- */
896
- with_parent?: number;
897
- /**
898
- * Filter stories starting with a specific slug
899
- */
900
- starts_with?: string;
901
- /**
902
- * Filter by items in the trash folder
903
- */
904
- in_trash?: boolean;
905
- /**
906
- * Filter by search term
907
- */
908
- search?: string;
909
- /**
910
- * Filter by specific attribute(s) of your content type. See Content Delivery API Documentation.
911
- */
912
- filter_query?: string;
913
- /**
914
- * Filter items by the release id
915
- */
916
- in_release?: number;
917
- /**
918
- * true for entries that are currently published; false for those that are currently not published or unpublished
919
- */
920
- is_published?: boolean;
921
- /**
922
- * Retrieve stories by comma-separated full_slug. It is possible to specify wildcards by using *.
923
- */
924
- by_slugs?: string;
925
- /**
926
- * Filters all the stories assigned to the current user whose token is being used
927
- */
928
- mine?: boolean;
929
- /**
930
- * Exclude stories by specifying comma-separated values of full_slug. It is possible to specify wildcards by using *.
931
- */
932
- excluding_slugs?: string;
933
- /**
934
- * Retrieve stories that are in a particular workflow stage by providing a comma-separated list of workflow stage IDs. Workflow stage IDs can be retrieved via the Management API.
935
- */
936
- in_workflow_stages?: string;
937
- /**
938
- * Retrieve specific stories by providing their UUIDs as a comma-separated string. The order of the stories in the response matches the order in which the UUIDs are listed.
939
- */
940
- by_uuids_ordered?: string;
941
- /**
942
- * Filter by exact slug. Make sure to use the full slug.
943
- */
944
- with_slug?: string;
945
- /**
946
- * If added, returns content_summary object with relevant information.
947
- */
948
- with_summary?: number;
949
- /**
950
- * Filter stories that are scheduled after the provided date
951
- */
952
- scheduled_at_gt?: string;
953
- /**
954
- * Filter stories that are scheduled before the provided date
955
- */
956
- scheduled_at_lt?: string;
957
- /**
958
- * Filter by your favourites.
959
- */
960
- favourite?: boolean;
961
- /**
962
- * Filter by references. Can be used for texts (partial search supported) and other references like assets. Example - stories with specific asset. For stories with a specific asset, complete URL of an asset is recommended for specific results. Names are also valid but will include the results found with content search as well.
963
- */
964
- reference_search?: string;
965
- /**
966
- * Filter by branch ID
967
- */
968
- branch_id?: number;
969
- /**
970
- * Release ID for filtering stories
971
- */
972
- release_id?: number;
973
- /**
974
- * Release scope ID for filtering stories
975
- */
976
- release_scope_id?: number;
977
- /**
978
- * Filter stories in specific release
979
- */
980
- in_release_filter?: number;
981
- /**
982
- * Include alternate stories
983
- */
984
- with_alts?: boolean;
985
- /**
986
- * Include translated stories
987
- */
988
- with_translated_stories?: boolean;
989
- };
990
- url: '/v1/spaces/{space_id}/stories';
991
- };
992
- type ListResponses = {
993
- /**
994
- * List of stories
995
- */
996
- 200: {
997
- stories?: Array<StoryMapi>;
998
- };
999
- };
1000
- type CreateData = {
1001
- body: StoryCreateRequest2;
1002
- path: {
1003
- /**
1004
- * The ID of the Storyblok space (can be integer or string)
1005
- */
1006
- space_id: number | string;
1007
- };
1008
- query?: {
1009
- /**
1010
- * Release ID for scheduled content
1011
- */
1012
- release_id?: number;
1013
- /**
1014
- * Language code for translated stories
1015
- */
1016
- lang?: string;
1017
- /**
1018
- * Publish the story after creation
1019
- */
1020
- publish?: boolean;
1021
- /**
1022
- * Preset ID to use for story content
1023
- */
1024
- preset_id?: number;
1025
- /**
1026
- * Use default preset for story content
1027
- */
1028
- use_default_preset?: boolean;
1029
- /**
1030
- * Disable frontend editor for this story
1031
- */
1032
- disable_fe_editor?: boolean;
1033
- };
1034
- url: '/v1/spaces/{space_id}/stories';
1035
- };
1036
- type CreateResponses = {
1037
- /**
1038
- * Story created
1039
- */
1040
- 201: {
1041
- story?: StoryMapi;
1042
- };
1043
- };
1044
- type DeleteResponses = {
1045
- /**
1046
- * Story deleted
1047
- */
1048
- 200: {
1049
- story?: StoryMapi;
1050
- };
1051
- };
1052
- type GetData = {
1053
- body?: never;
1054
- path: {
1055
- /**
1056
- * The ID of the Storyblok space (can be integer or string)
1057
- */
1058
- space_id: number | string;
1059
- /**
1060
- * The ID of the story (can be integer or string)
1061
- */
1062
- story_id: number | string;
1063
- };
1064
- query?: {
1065
- /**
1066
- * Retrieve story by UUID instead of ID
1067
- */
1068
- uuid?: string;
1069
- /**
1070
- * Retrieve specific version of the story
1071
- */
1072
- version?: number;
1073
- };
1074
- url: '/v1/spaces/{space_id}/stories/{story_id}';
1075
- };
1076
- type GetResponses = {
1077
- /**
1078
- * Story details
1079
- */
1080
- 200: {
1081
- story?: StoryMapi;
1082
- };
1083
- };
1084
- type UpdateData = {
1085
- body: StoryUpdateRequest2;
1086
- path: {
1087
- /**
1088
- * The ID of the Storyblok space (can be integer or string)
1089
- */
1090
- space_id: number | string;
1091
- /**
1092
- * The ID of the story (can be integer or string)
1093
- */
1094
- story_id: number | string;
1095
- };
1096
- query?: {
1097
- /**
1098
- * Release ID for scheduled content
1099
- */
1100
- release_id?: number;
1101
- /**
1102
- * Language code for translated stories
1103
- */
1104
- lang?: string;
1105
- /**
1106
- * Force update even if story has been modified
1107
- */
1108
- force_update?: boolean;
1109
- /**
1110
- * Publish the story after update
1111
- */
1112
- publish?: boolean;
1113
- };
1114
- url: '/v1/spaces/{space_id}/stories/{story_id}';
1115
- };
1116
- type UpdateResponses = {
1117
- /**
1118
- * Story updated
1119
- */
1120
- 200: {
1121
- story?: StoryMapi;
1122
- };
1123
- };
1124
- type DuplicateData = {
1125
- body: StoryDuplicateRequestWritable;
1126
- path: {
1127
- /**
1128
- * The ID of the Storyblok space (can be integer or string)
1129
- */
1130
- space_id: number | string;
1131
- /**
1132
- * The ID of the story (can be integer or string)
1133
- */
1134
- story_id: number | string;
1135
- };
1136
- query?: {
1137
- /**
1138
- * Release ID for scheduled content
1139
- */
1140
- release_id?: number;
1141
- /**
1142
- * Automatically create folders during duplication
1143
- */
1144
- auto_create_folders?: boolean;
1145
- /**
1146
- * Target dimension for duplication
1147
- */
1148
- target_dimension?: number;
1149
- };
1150
- url: '/v1/spaces/{space_id}/stories/{story_id}/duplicate';
1151
- };
1152
- type DuplicateResponses = {
1153
- /**
1154
- * Story duplicated
1155
- */
1156
- 200: {
1157
- story?: StoryMapi;
1158
- };
1159
- };
1160
- type PublishData = {
1161
- body?: never;
1162
- path: {
1163
- /**
1164
- * The ID of the Storyblok space (can be integer or string)
1165
- */
1166
- space_id: number | string;
1167
- /**
1168
- * The ID of the story (can be integer or string)
1169
- */
1170
- story_id: number | string;
1171
- };
1172
- query?: {
1173
- /**
1174
- * Accept a list of languages codes separated by a comma
1175
- */
1176
- lang?: string;
1177
- /**
1178
- * Release ID for scheduled publishing
1179
- */
1180
- release_id?: number;
1181
- };
1182
- url: '/v1/spaces/{space_id}/stories/{story_id}/publish';
1183
- };
1184
- type PublishResponses = {
1185
- /**
1186
- * Story published
1187
- */
1188
- 200: {
1189
- story?: StoryMapi;
1190
- };
1191
- };
1192
- type VersionsData = {
1193
- body?: never;
1194
- path: {
1195
- /**
1196
- * The ID of the Storyblok space (can be integer or string)
1197
- */
1198
- space_id: number | string;
1199
- };
1200
- query?: {
1201
- /**
1202
- * ID of the story. When this is passed, the endpoint returns versions of this particular story
1203
- */
1204
- by_story_id?: number;
1205
- /**
1206
- * ID of a Story's version. Use it to retrieve only a specific version of a story
1207
- */
1208
- version_id?: number;
1209
- /**
1210
- * ID of the release. When this is passed, the endpoint returns versions of all stories within the release and stories not associated with a particular release
1211
- */
1212
- by_release_id?: number;
1213
- page?: number;
1214
- /**
1215
- * Number of items per page. Default is 25.
1216
- */
1217
- per_page?: number;
1218
- /**
1219
- * Use it to retrieve all the content of a version
1220
- */
1221
- show_content?: string;
1222
- };
1223
- url: '/v1/spaces/{space_id}/story_versions';
1224
- };
1225
- type VersionsResponses = {
1226
- /**
1227
- * Story versions
1228
- */
1229
- 200: {
1230
- /**
1231
- * An array of objects with each object representing a version and details about the version
1232
- */
1233
- story_versions?: Array<{
1234
- /**
1235
- * Numeric id of the story version
1236
- */
1237
- id?: number;
1238
- /**
1239
- * Creation date
1240
- */
1241
- created_at?: string;
1242
- /**
1243
- * User/numeric id of collaborator
1244
- */
1245
- user_id?: number;
1246
- /**
1247
- * Name of the author
1248
- */
1249
- user?: {
1250
- /**
1251
- * The user ID
1252
- */
1253
- id?: number;
1254
- /**
1255
- * First name of collaborator
1256
- */
1257
- firstname?: string;
1258
- /**
1259
- * Last name of collaborator
1260
- */
1261
- lastname?: string;
1262
- /**
1263
- * Email of collaborator
1264
- */
1265
- alt_email?: string;
1266
- /**
1267
- * Avatar of collaborator usually an image
1268
- */
1269
- avatar?: string;
1270
- /**
1271
- * User ID of collaborator
1272
- */
1273
- userid?: string;
1274
- /**
1275
- * Friendly name of collaborator
1276
- */
1277
- friendly_name?: string;
1278
- };
1279
- /**
1280
- * ID of the story
1281
- */
1282
- story_id?: number;
1283
- /**
1284
- * Publication status of the version
1285
- */
1286
- status?: string;
1287
- /**
1288
- * ID of the release
1289
- */
1290
- release_id?: number;
1291
- /**
1292
- * ID of the parent folder. 0 for root-level stories.
1293
- */
1294
- parent_id?: number;
1295
- /**
1296
- * This object contains the Story's content when the show_content parameter is used
1297
- */
1298
- content?: {
1299
- [key: string]: unknown;
1300
- };
1301
- }>;
1302
- };
1303
- };
1304
- //#endregion
1305
- export { AssetField, CreateData, CreateResponses, DeleteResponses, DuplicateData, DuplicateResponses, GetData, GetResponses, ListData, ListResponses, MultilinkField, PluginField, PublishData, PublishResponses, RichtextField, StoryAlternate, StoryContent, StoryCreate, StoryLocalizedPath, StoryMapi, StoryTranslatedSlug, StoryUpdate, TableField, UpdateData, UpdateResponses, VersionsData, VersionsResponses };
1306
- //# sourceMappingURL=types.gen.d.mts.map