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