@storyblok/management-api-client 1.0.0-alpha.1 → 1.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +217 -203
  5. package/dist/client.d.mts +217 -203
  6. package/dist/client.mjs +9 -9
  7. package/dist/client.mjs.map +1 -1
  8. package/dist/generated/mapi/_internal.gen.d.cts +371 -0
  9. package/dist/generated/mapi/_internal.gen.d.mts +371 -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 +1598 -0
  65. package/dist/generated/mapi/types-aliased.gen.d.mts +1598 -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 +49 -0
  73. package/dist/generated/types/block.d.mts +49 -0
  74. package/dist/generated/types/field.d.cts +87 -0
  75. package/dist/generated/types/field.d.mts +87 -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 +8 -4
  79. package/dist/index.d.mts +8 -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 +31 -41
  160. package/playground/integration-tests/test/types/components.test-d.ts +74 -0
  161. package/playground/integration-tests/test/types/resources.test-d.ts +212 -0
  162. package/playground/integration-tests/test/types/stories.test-d.ts +273 -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 +4 -4
  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
@@ -0,0 +1,1598 @@
1
+ //#region src/generated/mapi/types-aliased.gen.d.ts
2
+ type Component = {
3
+ /**
4
+ * Unique identifier for the component
5
+ */
6
+ readonly id: number;
7
+ /**
8
+ * Technical name of the component.
9
+ */
10
+ name: string;
11
+ /**
12
+ * Human-readable display name
13
+ */
14
+ display_name?: string | null;
15
+ /**
16
+ * Component description
17
+ */
18
+ description?: string | null;
19
+ /**
20
+ * Creation timestamp (format is ISO 8601 standard in UTC).
21
+ */
22
+ readonly created_at: string;
23
+ /**
24
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
25
+ */
26
+ updated_at: string;
27
+ /**
28
+ * Component field schema definition
29
+ */
30
+ schema: {
31
+ [key: string]: {
32
+ type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
33
+ /**
34
+ * Field ID
35
+ */
36
+ id?: string;
37
+ [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | undefined;
38
+ };
39
+ };
40
+ /**
41
+ * Component image URL
42
+ */
43
+ image?: string | null;
44
+ /**
45
+ * Field used for preview.
46
+ */
47
+ preview_field?: string | null;
48
+ /**
49
+ * Whether this component can be used as a root component.
50
+ */
51
+ is_root: boolean;
52
+ /**
53
+ * Preview template HTML.
54
+ */
55
+ preview_tmpl?: string | null;
56
+ /**
57
+ * Whether this component can be nested inside other components.
58
+ */
59
+ is_nestable: boolean;
60
+ /**
61
+ * All presets associated with this component.
62
+ */
63
+ all_presets?: Array<{
64
+ /**
65
+ * Preset ID
66
+ */
67
+ id?: number;
68
+ /**
69
+ * Preset name
70
+ */
71
+ name?: string;
72
+ /**
73
+ * Preset schema
74
+ */
75
+ preset?: {
76
+ [key: string]: unknown;
77
+ };
78
+ /**
79
+ * ID of the component this preset belongs to
80
+ */
81
+ component_id?: number;
82
+ /**
83
+ * Image URL for the preset preview
84
+ */
85
+ image?: string | null;
86
+ /**
87
+ * Icon name for the preset
88
+ */
89
+ icon?: string | null;
90
+ /**
91
+ * Color for the preset display
92
+ */
93
+ color?: string | null;
94
+ /**
95
+ * Description of the preset
96
+ */
97
+ description?: string | null;
98
+ }>;
99
+ /**
100
+ * Default preset ID.
101
+ */
102
+ preset_id?: number | null;
103
+ /**
104
+ * Display name if available, otherwise technical name.
105
+ */
106
+ real_name?: string;
107
+ /**
108
+ * UUID of the component group this component belongs to.
109
+ */
110
+ component_group_uuid?: string | null;
111
+ /**
112
+ * Component color for UI display
113
+ */
114
+ color?: string | null;
115
+ /**
116
+ * Component icon name
117
+ */
118
+ icon?: string | null;
119
+ internal_tags_list?: Array<{
120
+ /**
121
+ * ID
122
+ */
123
+ id?: number;
124
+ /**
125
+ * Name
126
+ */
127
+ name?: string;
128
+ }>;
129
+ /**
130
+ * List of internal tag IDs
131
+ */
132
+ internal_tag_ids?: Array<string>;
133
+ /**
134
+ * Content Type Asset preview.
135
+ */
136
+ content_type_asset_preview?: string | null;
137
+ /**
138
+ * Component metadata.
139
+ */
140
+ metadata?: {
141
+ [key: string]: unknown;
142
+ } | null;
143
+ };
144
+ type ComponentCreate = {
145
+ /**
146
+ * Name of the component
147
+ */
148
+ name: string;
149
+ /**
150
+ * Human-readable display name
151
+ */
152
+ display_name?: string;
153
+ /**
154
+ * Component description
155
+ */
156
+ description?: string;
157
+ /**
158
+ * Preview template HTML
159
+ */
160
+ preview_tmpl?: string;
161
+ /**
162
+ * Component image URL
163
+ */
164
+ image?: string;
165
+ /**
166
+ * Field used for preview
167
+ */
168
+ preview_field?: string;
169
+ /**
170
+ * Whether this component can be used as a root component
171
+ */
172
+ is_root?: boolean;
173
+ /**
174
+ * Whether this component can be nested inside other components
175
+ */
176
+ is_nestable?: boolean;
177
+ /**
178
+ * Default preset ID
179
+ */
180
+ preset_id?: number;
181
+ /**
182
+ * UUID
183
+ */
184
+ component_group_uuid?: string;
185
+ /**
186
+ * Component color for UI display
187
+ */
188
+ color?: string;
189
+ /**
190
+ * Component icon name
191
+ */
192
+ icon?: string;
193
+ /**
194
+ * Asset preview URL for content type
195
+ */
196
+ content_type_asset_preview?: string;
197
+ /**
198
+ * List of internal tag IDs
199
+ */
200
+ internal_tag_ids?: Array<number>;
201
+ /**
202
+ * Component field schema definition
203
+ */
204
+ schema?: {
205
+ [key: string]: {
206
+ type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
207
+ /**
208
+ * Human-readable field name
209
+ */
210
+ display_name?: string;
211
+ /**
212
+ * Whether this field is required
213
+ */
214
+ required?: boolean;
215
+ /**
216
+ * Whether this field is translatable
217
+ */
218
+ translatable?: boolean;
219
+ [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
220
+ };
221
+ };
222
+ /**
223
+ * Component metadata
224
+ */
225
+ metadata?: {
226
+ [key: string]: unknown;
227
+ };
228
+ };
229
+ type ComponentUpdate = {
230
+ /**
231
+ * Name of the component
232
+ */
233
+ name?: string;
234
+ /**
235
+ * Human-readable display name
236
+ */
237
+ display_name?: string;
238
+ /**
239
+ * Component description
240
+ */
241
+ description?: string;
242
+ /**
243
+ * Preview template HTML
244
+ */
245
+ preview_tmpl?: string;
246
+ /**
247
+ * Component image URL
248
+ */
249
+ image?: string;
250
+ /**
251
+ * Field used for preview
252
+ */
253
+ preview_field?: string;
254
+ /**
255
+ * Whether this component can be used as a root component
256
+ */
257
+ is_root?: boolean;
258
+ /**
259
+ * Whether this component can be nested inside other components
260
+ */
261
+ is_nestable?: boolean;
262
+ /**
263
+ * Default preset ID
264
+ */
265
+ preset_id?: number;
266
+ /**
267
+ * UUID
268
+ */
269
+ component_group_uuid?: string;
270
+ /**
271
+ * Component color for UI display
272
+ */
273
+ color?: string;
274
+ /**
275
+ * Component icon name
276
+ */
277
+ icon?: string;
278
+ /**
279
+ * Asset preview URL for content type
280
+ */
281
+ content_type_asset_preview?: string;
282
+ /**
283
+ * List of internal tag IDs
284
+ */
285
+ internal_tag_ids?: Array<number>;
286
+ /**
287
+ * Component field schema definition
288
+ */
289
+ schema?: {
290
+ [key: string]: {
291
+ type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
292
+ /**
293
+ * Human-readable field name
294
+ */
295
+ display_name?: string;
296
+ /**
297
+ * Whether this field is required
298
+ */
299
+ required?: boolean;
300
+ /**
301
+ * Whether this field is translatable
302
+ */
303
+ translatable?: boolean;
304
+ [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
305
+ };
306
+ };
307
+ /**
308
+ * Component metadata
309
+ */
310
+ metadata?: {
311
+ [key: string]: unknown;
312
+ };
313
+ };
314
+ type Asset = {
315
+ /**
316
+ * Id of the asset.
317
+ */
318
+ id: number;
319
+ /**
320
+ * Full path of the asset, including the file name.
321
+ */
322
+ filename: string;
323
+ /**
324
+ * ID of the space this asset belongs to
325
+ */
326
+ space_id: number;
327
+ /**
328
+ * Creation timestamp (format is ISO 8601 standard in UTC).
329
+ */
330
+ created_at: string;
331
+ /**
332
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
333
+ */
334
+ updated_at: string;
335
+ /**
336
+ * File object with upload details
337
+ */
338
+ file?: {
339
+ [key: string]: unknown;
340
+ } | null;
341
+ /**
342
+ * Id of the folder containing this asset.
343
+ */
344
+ asset_folder_id?: number | null;
345
+ deleted_at?: string | null;
346
+ /**
347
+ * file name
348
+ */
349
+ short_filename?: string;
350
+ /**
351
+ * The content length in bytes.
352
+ */
353
+ content_length?: number | null;
354
+ /**
355
+ * The content type.
356
+ */
357
+ content_type?: string | null;
358
+ /**
359
+ * deleted?.
360
+ */
361
+ permanently_deleted?: boolean | null;
362
+ /**
363
+ * Alt text for the asset (default language).
364
+ */
365
+ alt?: string | null;
366
+ /**
367
+ * Copyright text.
368
+ */
369
+ copyright?: string | null;
370
+ /**
371
+ * User's job title or role.
372
+ */
373
+ title?: string | null;
374
+ /**
375
+ * Focus point.
376
+ */
377
+ focus?: string | null;
378
+ /**
379
+ * Ext id
380
+ */
381
+ ext_id?: string | null;
382
+ expire_at?: string | null;
383
+ /**
384
+ * source
385
+ */
386
+ source?: string | null;
387
+ /**
388
+ * List of internal tag IDs
389
+ */
390
+ internal_tag_ids?: Array<number>;
391
+ /**
392
+ * If locked
393
+ */
394
+ locked?: boolean;
395
+ /**
396
+ * Defines if the asset should be inaccessible to the public.
397
+ */
398
+ is_private: boolean;
399
+ publish_at?: string | null;
400
+ /**
401
+ * Additional metadata
402
+ */
403
+ meta_data?: {
404
+ [key: string]: unknown;
405
+ } | null;
406
+ /**
407
+ * List of internal tags
408
+ */
409
+ internal_tags_list?: Array<{
410
+ id: number;
411
+ name: string;
412
+ }>;
413
+ };
414
+ type AssetCreate = {
415
+ fields: {
416
+ /**
417
+ * acl
418
+ */
419
+ acl: string;
420
+ /**
421
+ * Cache Control
422
+ */
423
+ 'Cache-Control': string;
424
+ /**
425
+ * Content Type
426
+ */
427
+ 'Content-Type': string;
428
+ /**
429
+ * key
430
+ */
431
+ key: string;
432
+ /**
433
+ * Expiration date (optional)
434
+ */
435
+ Expires?: string;
436
+ /**
437
+ * policy
438
+ */
439
+ policy: string;
440
+ /**
441
+ * credential
442
+ */
443
+ 'x-amz-credential': string;
444
+ /**
445
+ * algorithm
446
+ */
447
+ 'x-amz-algorithm': string;
448
+ /**
449
+ * date
450
+ */
451
+ 'x-amz-date': string;
452
+ /**
453
+ * signature
454
+ */
455
+ 'x-amz-signature': string;
456
+ };
457
+ post_url: string;
458
+ pretty_url: string;
459
+ public_url: string;
460
+ id: number;
461
+ locked: boolean;
462
+ /**
463
+ * Custom metadata for the asset
464
+ */
465
+ meta_data: {
466
+ [key: string]: unknown;
467
+ };
468
+ };
469
+ type AssetUpdate = {
470
+ /**
471
+ * Publish date
472
+ */
473
+ publish_at?: string;
474
+ /**
475
+ * Expire date
476
+ */
477
+ expire_at?: string;
478
+ /**
479
+ * Whether the asset is private
480
+ */
481
+ is_private?: boolean | null;
482
+ /**
483
+ * Asset folder ID
484
+ */
485
+ asset_folder_id?: number | null;
486
+ /**
487
+ * Alt
488
+ */
489
+ alt?: string | null;
490
+ /**
491
+ * Title
492
+ */
493
+ title?: string | null;
494
+ /**
495
+ * Copyright
496
+ */
497
+ copyright?: string | null;
498
+ /**
499
+ * Focus
500
+ */
501
+ focus?: string | null;
502
+ /**
503
+ * External ID
504
+ */
505
+ ext_id?: string | null;
506
+ /**
507
+ * Source
508
+ */
509
+ source?: string | null;
510
+ /**
511
+ * Internal tag IDs
512
+ */
513
+ internal_tag_ids?: Array<number>;
514
+ /**
515
+ * Metadata
516
+ */
517
+ meta_data?: {
518
+ [key: string]: unknown;
519
+ };
520
+ };
521
+ /**
522
+ * Folder for organizing assets within a space
523
+ */
524
+ type AssetFolder = {
525
+ id: number;
526
+ name: string;
527
+ /**
528
+ * ID of parent space if this is a child space.
529
+ */
530
+ parent_id: number | null;
531
+ /**
532
+ * Unique UUID identifier for the discussion.
533
+ */
534
+ uuid: string;
535
+ parent_uuid: string | null;
536
+ };
537
+ type AssetFolderCreate = {
538
+ name: string;
539
+ parent_id?: number | null;
540
+ };
541
+ type AssetFolderUpdate = {
542
+ name?: string;
543
+ parent_id?: number | null;
544
+ };
545
+ /**
546
+ * Logical grouping of components for organizational purposes
547
+ */
548
+ type ComponentFolder = {
549
+ /**
550
+ * Unique ID.
551
+ */
552
+ id: number;
553
+ /**
554
+ * The name of the component group.
555
+ */
556
+ name: string;
557
+ /**
558
+ * Unique UUID identifier for the discussion.
559
+ */
560
+ uuid: string;
561
+ /**
562
+ * ID of parent space if this is a child space.
563
+ */
564
+ parent_id: number | null;
565
+ /**
566
+ * The UUID of the parent component group
567
+ */
568
+ parent_uuid: string | null;
569
+ };
570
+ type ComponentFolderCreate = {
571
+ /**
572
+ * Name of the component group
573
+ */
574
+ name: string;
575
+ /**
576
+ * Parent component group ID
577
+ */
578
+ parent_id?: number | null;
579
+ };
580
+ type ComponentFolderUpdate = ComponentFolderCreate;
581
+ /**
582
+ * A named collection of key-value entries used for structured content options
583
+ */
584
+ type MapiDatasource = {
585
+ /**
586
+ * ID.
587
+ */
588
+ id: number;
589
+ /**
590
+ * Name.
591
+ */
592
+ name: string;
593
+ /**
594
+ * URL-friendly identifier for the app category.
595
+ */
596
+ slug: string;
597
+ /**
598
+ * Dimensions of the datasource.
599
+ */
600
+ dimensions: Array<Dimension>;
601
+ /**
602
+ * Creation timestamp (format is ISO 8601 standard in UTC).
603
+ */
604
+ created_at?: string;
605
+ /**
606
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
607
+ */
608
+ updated_at?: string;
609
+ };
610
+ type DatasourceCreate = {
611
+ /**
612
+ * The name of the datasource
613
+ */
614
+ name: string;
615
+ /**
616
+ * The unique slug of the datasource
617
+ */
618
+ slug: string;
619
+ /**
620
+ * Array of dimensions to create for this datasource
621
+ */
622
+ dimensions_attributes?: Array<{
623
+ /**
624
+ * ID of existing dimension (for updates)
625
+ */
626
+ id?: number;
627
+ /**
628
+ * Name of the dimension
629
+ */
630
+ name?: string;
631
+ /**
632
+ * Value for the dimension entry
633
+ */
634
+ entry_value?: string;
635
+ /**
636
+ * Set to true to delete this dimension
637
+ */
638
+ _destroy?: boolean;
639
+ }>;
640
+ };
641
+ type DatasourceUpdate = {
642
+ /**
643
+ * The name of the datasource
644
+ */
645
+ name?: string;
646
+ /**
647
+ * The unique slug of the datasource
648
+ */
649
+ slug?: string;
650
+ /**
651
+ * Array of dimensions to update or create for this datasource
652
+ */
653
+ dimensions_attributes?: Array<{
654
+ /**
655
+ * ID of existing dimension (for updates)
656
+ */
657
+ id?: number;
658
+ /**
659
+ * Name of the dimension
660
+ */
661
+ name?: string;
662
+ /**
663
+ * Value for the dimension entry
664
+ */
665
+ entry_value?: string;
666
+ /**
667
+ * Set to true to delete this dimension
668
+ */
669
+ _destroy?: boolean;
670
+ }>;
671
+ };
672
+ /**
673
+ * A single key-value entry within a datasource
674
+ */
675
+ type MapiDatasourceEntry = {
676
+ /**
677
+ * ID.
678
+ */
679
+ id: number;
680
+ /**
681
+ * Name.
682
+ */
683
+ name: string;
684
+ /**
685
+ * Given value in default dimension
686
+ */
687
+ value: string;
688
+ /**
689
+ * Given value in the requested dimension.
690
+ */
691
+ dimension_value: string | null;
692
+ };
693
+ type InternalTag = {
694
+ /**
695
+ * Unique ID
696
+ */
697
+ id: number;
698
+ /**
699
+ * The name of the internal tag
700
+ */
701
+ name: string;
702
+ /**
703
+ * The type of object this tag is associated with
704
+ */
705
+ object_type: 'asset' | 'component' | 'idea';
706
+ /**
707
+ * Count of assets associated with this tag (only present when with_assets_count parameter is used)
708
+ */
709
+ assets_count?: number | null;
710
+ };
711
+ type InternalTagCreate = {
712
+ /**
713
+ * The name of the internal tag
714
+ */
715
+ name: string;
716
+ /**
717
+ * The type of object this tag is associated with
718
+ */
719
+ object_type?: 'asset' | 'component' | 'idea';
720
+ };
721
+ type InternalTagUpdate = InternalTagCreate;
722
+ type Preset = {
723
+ /**
724
+ * Unique identifier of the preset
725
+ */
726
+ id: number;
727
+ /**
728
+ * Name of the preset
729
+ */
730
+ name: string;
731
+ /**
732
+ * The preset content configuration as JSON object
733
+ */
734
+ preset: {
735
+ [key: string]: unknown;
736
+ } | null;
737
+ /**
738
+ * ID of the component this preset belongs to
739
+ */
740
+ component_id: number;
741
+ /**
742
+ * ID of the space this preset belongs to
743
+ */
744
+ space_id: number;
745
+ /**
746
+ * URL of the preset preview image
747
+ */
748
+ image?: string | null;
749
+ /**
750
+ * Color associated with the preset
751
+ */
752
+ color?: string | null;
753
+ /**
754
+ * Icon identifier for the preset
755
+ */
756
+ icon?: string | null;
757
+ /**
758
+ * Description of the preset
759
+ */
760
+ description?: string | null;
761
+ /**
762
+ * Creation timestamp (format is ISO 8601 standard in UTC).
763
+ */
764
+ created_at: string;
765
+ /**
766
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
767
+ */
768
+ updated_at: string;
769
+ };
770
+ type PresetCreate = {
771
+ /**
772
+ * Name of the preset
773
+ */
774
+ name: string;
775
+ /**
776
+ * The preset content configuration as JSON object
777
+ */
778
+ preset?: {
779
+ [key: string]: unknown;
780
+ };
781
+ /**
782
+ * ID of the component this preset belongs to
783
+ */
784
+ component_id: number;
785
+ /**
786
+ * URL of the preset preview image
787
+ */
788
+ image?: string;
789
+ /**
790
+ * Icon identifier for the preset
791
+ */
792
+ icon?: string;
793
+ /**
794
+ * Color associated with the preset
795
+ */
796
+ color?: string;
797
+ /**
798
+ * Description of the preset
799
+ */
800
+ description?: string;
801
+ };
802
+ type PresetUpdate = {
803
+ /**
804
+ * Name of the preset
805
+ */
806
+ name?: string;
807
+ /**
808
+ * The preset content configuration as JSON object
809
+ */
810
+ preset?: {
811
+ [key: string]: unknown;
812
+ };
813
+ /**
814
+ * ID of the component this preset belongs to
815
+ */
816
+ component_id?: number;
817
+ /**
818
+ * URL of the preset preview image
819
+ */
820
+ image?: string;
821
+ /**
822
+ * Icon identifier for the preset
823
+ */
824
+ icon?: string;
825
+ /**
826
+ * Color associated with the preset
827
+ */
828
+ color?: string;
829
+ /**
830
+ * Description of the preset
831
+ */
832
+ description?: string;
833
+ };
834
+ type Space = {
835
+ /**
836
+ * The unique identifier of the space
837
+ */
838
+ readonly id: number;
839
+ /**
840
+ * The name of the space.
841
+ */
842
+ name: string;
843
+ /**
844
+ * External unique identifier
845
+ */
846
+ euid?: string | null;
847
+ /**
848
+ * The region where the space is hosted
849
+ */
850
+ region: string;
851
+ /**
852
+ * The ID of the space owner
853
+ */
854
+ owner_id: number;
855
+ /**
856
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
857
+ */
858
+ updated_at: string;
859
+ /**
860
+ * Creation timestamp (format is ISO 8601 standard in UTC).
861
+ */
862
+ readonly created_at: string;
863
+ /**
864
+ * The subscription plan name
865
+ */
866
+ plan: string;
867
+ /**
868
+ * The plan level identifier
869
+ */
870
+ plan_level: number;
871
+ /**
872
+ * Number of pending traffic boosts
873
+ */
874
+ pending_traffic_boosts?: number | null;
875
+ /**
876
+ * Number of pending limit boosts
877
+ */
878
+ pending_limit_boosts?: number | null;
879
+ /**
880
+ * Whether the space is on a trial plan
881
+ */
882
+ trial: boolean;
883
+ /**
884
+ * Whether two-factor authentication is required
885
+ */
886
+ requires_2fa: boolean;
887
+ /**
888
+ * The organization ID if space belongs to an organization
889
+ */
890
+ org_id?: number | null;
891
+ /**
892
+ * The partner ID if space is associated with a partner
893
+ */
894
+ partner_id?: number | null;
895
+ /**
896
+ * The subscription status
897
+ */
898
+ subscription_status?: string | null;
899
+ /**
900
+ * Stripe trial status
901
+ */
902
+ stripe_trial_status?: string | null;
903
+ /**
904
+ * Stripe trial end date
905
+ */
906
+ stripe_trial_end?: string | null;
907
+ /**
908
+ * The type of space (e.g., personal, team)
909
+ */
910
+ space_type?: string | null;
911
+ /**
912
+ * The timestamp when the space was canceled
913
+ */
914
+ canceled_at?: string | null;
915
+ /**
916
+ * Whether the organization requires 2FA.
917
+ */
918
+ org_requires_2fa: boolean;
919
+ /**
920
+ * The timestamp when the space became unpaid
921
+ */
922
+ unpaid_at?: string | null;
923
+ /**
924
+ * The timestamp when the space was blocked
925
+ */
926
+ blocked_at?: string | null;
927
+ /**
928
+ * Whether the space is in development mode
929
+ */
930
+ development_mode: boolean;
931
+ /**
932
+ * Flags indicating which feature limits have been exceeded
933
+ */
934
+ feature_limit_exceeded_flags: {
935
+ [key: string]: boolean | null;
936
+ };
937
+ /**
938
+ * The status of the organization.
939
+ */
940
+ org_status?: string | null;
941
+ /**
942
+ * Available roles in the space
943
+ */
944
+ space_roles?: Array<SpaceRole>;
945
+ /**
946
+ * Whether the space is on a Joyride trial
947
+ */
948
+ joyride_trial?: boolean;
949
+ /**
950
+ * When the Joyride trial expires
951
+ */
952
+ joyride_trial_expires_at?: string | null;
953
+ /**
954
+ * When the Joyride trial started
955
+ */
956
+ joyride_trial_started_at?: string | null;
957
+ /**
958
+ * Whether the Joyride trial traffic limit has been exceeded.
959
+ */
960
+ joyride_traffic_limit_exceeded?: boolean;
961
+ [key: string]: unknown | number | string | string | null | number | null | number | null | boolean | number | null | number | null | string | null | string | null | string | null | string | null | string | null | string | null | string | null | {
962
+ [key: string]: boolean | null;
963
+ } | string | null | Array<SpaceRole> | string | null | string | null | undefined;
964
+ };
965
+ type SpaceCreate = {
966
+ /**
967
+ * The name of the space
968
+ */
969
+ name: string;
970
+ /**
971
+ * The domain associated with the space
972
+ */
973
+ domain?: string | null;
974
+ /**
975
+ * ID of parent space if creating a child space
976
+ */
977
+ parent_id?: number | null;
978
+ /**
979
+ * Webhook URL for story published events
980
+ */
981
+ story_published_hook?: string | null;
982
+ /**
983
+ * Searchblok integration ID
984
+ */
985
+ searchblok_id?: string | null;
986
+ /**
987
+ * Whether this is a demo space
988
+ */
989
+ is_demo?: boolean;
990
+ /**
991
+ * Blueprint reference for space initialization
992
+ */
993
+ blueprint_reference?: string | null;
994
+ /**
995
+ * Whether to disable the onboarding tour
996
+ */
997
+ onboarding_tour_disabled?: boolean;
998
+ /**
999
+ * Initial environments configuration
1000
+ */
1001
+ environments?: Array<{
1002
+ name: string;
1003
+ location: string;
1004
+ }>;
1005
+ };
1006
+ type SpaceUpdate = {
1007
+ /**
1008
+ * The name of the space
1009
+ */
1010
+ name?: string;
1011
+ /**
1012
+ * The domain associated with the space
1013
+ */
1014
+ domain?: string;
1015
+ /**
1016
+ * Webhook URL for story published events
1017
+ */
1018
+ story_published_hook?: string | null;
1019
+ /**
1020
+ * Unique domain for the space
1021
+ */
1022
+ uniq_domain?: string | null;
1023
+ /**
1024
+ * ID of the new owner (only changeable by current owner)
1025
+ */
1026
+ owner_id?: number;
1027
+ /**
1028
+ * Whether this is a demo space
1029
+ */
1030
+ is_demo?: boolean;
1031
+ /**
1032
+ * Searchblok integration ID
1033
+ */
1034
+ searchblok_id?: string | null;
1035
+ /**
1036
+ * ID of parent space
1037
+ */
1038
+ parent_id?: number | null;
1039
+ /**
1040
+ * Cache version
1041
+ */
1042
+ version?: number;
1043
+ /**
1044
+ * Whether the space can be duplicated
1045
+ */
1046
+ duplicatable?: boolean;
1047
+ /**
1048
+ * Default root component type
1049
+ */
1050
+ default_root?: string;
1051
+ /**
1052
+ * AWS role for asset management
1053
+ */
1054
+ asset_aws_role?: string | null;
1055
+ /**
1056
+ * Personal S3 bucket for assets
1057
+ */
1058
+ personal_s3_asset_bucket?: string | null;
1059
+ /**
1060
+ * AWS region for assets
1061
+ */
1062
+ asset_region?: string | null;
1063
+ /**
1064
+ * Token for webhook authentication
1065
+ */
1066
+ webhook_token?: string | null;
1067
+ /**
1068
+ * Whether to use translated stories feature
1069
+ */
1070
+ use_translated_stories?: boolean;
1071
+ /**
1072
+ * Backup schedule time
1073
+ */
1074
+ backup_time?: string | null;
1075
+ /**
1076
+ * Current onboarding step
1077
+ */
1078
+ onboarding_step?: string | null;
1079
+ /**
1080
+ * Webhook URL for release merged events
1081
+ */
1082
+ release_merged_hook?: string | null;
1083
+ /**
1084
+ * Webhook URL for branch deployed events
1085
+ */
1086
+ branch_deployed_hook?: string | null;
1087
+ /**
1088
+ * Webhook URL for datasource entry saved events
1089
+ */
1090
+ datasource_entry_saved_hook?: string | null;
1091
+ /**
1092
+ * Webhook URL for story saved events
1093
+ */
1094
+ story_saved_hook?: string | null;
1095
+ /**
1096
+ * Webhook URL for stage changed events
1097
+ */
1098
+ stage_changed_hook?: string | null;
1099
+ /**
1100
+ * S3 bucket name
1101
+ */
1102
+ s3_bucket?: string | null;
1103
+ /**
1104
+ * AWS ARN for external integrations
1105
+ */
1106
+ aws_arn?: string | null;
1107
+ /**
1108
+ * Cloudinary cloud name
1109
+ */
1110
+ cloudinary_cloud_name?: string | null;
1111
+ /**
1112
+ * Cloudinary API key
1113
+ */
1114
+ cloudinary_api_key?: string | null;
1115
+ /**
1116
+ * Backup frequency setting
1117
+ */
1118
+ backup_frequency?: string | null;
1119
+ /**
1120
+ * Day of week for weekly backups (0-6)
1121
+ */
1122
+ backup_week_day?: number | null;
1123
+ /**
1124
+ * Default language name
1125
+ */
1126
+ default_lang_name?: string | null;
1127
+ /**
1128
+ * Default AI translation language code (AiServices::TextService::LANGUAGES); defaults to en
1129
+ */
1130
+ default_ai_lang_code?: string | null;
1131
+ /**
1132
+ * Whether to use hosted backups
1133
+ */
1134
+ hosted_backup?: boolean;
1135
+ /**
1136
+ * Whether space is in maintenance mode
1137
+ */
1138
+ maintenance?: boolean;
1139
+ /**
1140
+ * Tablet screen size in pixels
1141
+ */
1142
+ tablet_size?: number | null;
1143
+ /**
1144
+ * Mobile screen size in pixels
1145
+ */
1146
+ mobile_size?: number | null;
1147
+ /**
1148
+ * Whether visual mode is disabled
1149
+ */
1150
+ visual_mode_disable?: boolean;
1151
+ /**
1152
+ * Whether AI text generation is disabled
1153
+ */
1154
+ ai_text_generator_disabled?: boolean;
1155
+ /**
1156
+ * Whether to track usage statistics
1157
+ */
1158
+ track_statistics?: boolean;
1159
+ /**
1160
+ * Custom upload limit in megabytes
1161
+ */
1162
+ custom_upload_limit_in_mb?: number | null;
1163
+ /**
1164
+ * Whether strong authentication is required
1165
+ */
1166
+ strong_auth?: boolean;
1167
+ /**
1168
+ * Auto-delete old versions after specified days
1169
+ */
1170
+ auto_delete_old_versions_after_days?: number | null;
1171
+ /**
1172
+ * Whether to encode preview URLs
1173
+ */
1174
+ encode_preview_urls?: boolean;
1175
+ /**
1176
+ * Whether to enable extended character set in story slugs
1177
+ */
1178
+ enable_extended_char_set_in_stories_slug?: boolean;
1179
+ /**
1180
+ * Whether to show alternative versions of stories
1181
+ */
1182
+ show_stories_alternative_versions?: boolean;
1183
+ /**
1184
+ * Blueprint reference
1185
+ */
1186
+ blueprint_reference?: string | null;
1187
+ /**
1188
+ * Whether to inherit organization AI configuration
1189
+ */
1190
+ inherit_org_ai_configuration?: boolean;
1191
+ /**
1192
+ * Whether to disable the onboarding tour
1193
+ */
1194
+ onboarding_tour_disabled?: boolean;
1195
+ /**
1196
+ * Language configuration
1197
+ */
1198
+ languages?: Array<{
1199
+ code: string;
1200
+ name: string;
1201
+ ai_translation_code?: string | null;
1202
+ }>;
1203
+ /**
1204
+ * Custom routes configuration
1205
+ */
1206
+ routes?: Array<{
1207
+ pattern: string;
1208
+ template: string;
1209
+ }>;
1210
+ /**
1211
+ * Environment configuration
1212
+ */
1213
+ environments?: Array<{
1214
+ name: string;
1215
+ location: string;
1216
+ }>;
1217
+ /**
1218
+ * Web crawling configuration
1219
+ */
1220
+ crawl_config?: {
1221
+ base_url?: string;
1222
+ enabled?: boolean;
1223
+ };
1224
+ /**
1225
+ * Billing address information
1226
+ */
1227
+ billing_address?: {
1228
+ tax_number?: string;
1229
+ order_number?: string;
1230
+ company?: string;
1231
+ email?: string;
1232
+ name?: string;
1233
+ address_city?: string;
1234
+ address_country?: string;
1235
+ address_iso_country?: string;
1236
+ address_line1?: string;
1237
+ address_zip?: string;
1238
+ };
1239
+ /**
1240
+ * Required asset fields configuration
1241
+ */
1242
+ required_assest_fields?: Array<string>;
1243
+ /**
1244
+ * Custom metadata schema for assets
1245
+ */
1246
+ asset_custom_meta_data_schema?: Array<{
1247
+ key?: string;
1248
+ display_name?: string;
1249
+ regex?: string | null;
1250
+ regex_message?: string | null;
1251
+ required?: boolean;
1252
+ translatable?: boolean;
1253
+ filetypes?: Array<string>;
1254
+ }>;
1255
+ /**
1256
+ * Translatable asset fields configuration
1257
+ */
1258
+ translatable_asset_fields?: Array<string>;
1259
+ /**
1260
+ * Dimension app folder configurations with full metadata. Each item represents a dimension with its associated root folder.
1261
+ */
1262
+ dimensions_app_folders?: Array<{
1263
+ /**
1264
+ * The ID of the linked folder
1265
+ */
1266
+ folder_id: number;
1267
+ /**
1268
+ * The AI translation code for this folder
1269
+ */
1270
+ ai_translation_code: string | null;
1271
+ }>;
1272
+ /**
1273
+ * Whether to enable AI translation for the dimensions app
1274
+ */
1275
+ enable_dimensions_app_ai_translation?: boolean;
1276
+ };
1277
+ type User = {
1278
+ userid: string;
1279
+ email: string;
1280
+ organization?: string | null;
1281
+ /**
1282
+ * Username
1283
+ */
1284
+ username?: string | null;
1285
+ use_username: boolean;
1286
+ alt_email?: string | null;
1287
+ firstname?: string | null;
1288
+ lastname?: string | null;
1289
+ phone?: string | null;
1290
+ readonly id: number;
1291
+ login_strategy: 'otp_email' | 'otp_sms' | 'password' | 'twilio_totp';
1292
+ /**
1293
+ * Creation timestamp (format is ISO 8601 standard in UTC).
1294
+ */
1295
+ readonly created_at: string;
1296
+ /**
1297
+ * User's role in the organization. Null if user has no org.
1298
+ */
1299
+ org_role?: 'admin' | 'owner' | 'member' | null;
1300
+ has_org: boolean;
1301
+ has_partner: boolean;
1302
+ /**
1303
+ * Delegated from partner association. Null if user has no partner.
1304
+ */
1305
+ partner_status?: string | null;
1306
+ /**
1307
+ * Organization details. Returns empty object {} when user has no organization.
1308
+ */
1309
+ org: {
1310
+ id?: number;
1311
+ /**
1312
+ * Organization settings stored as JSONB. Contains keys like track_statistics, strong_auth, sso_servers_webhook, etc.
1313
+ */
1314
+ settings?: {
1315
+ [key: string]: unknown;
1316
+ };
1317
+ name?: string;
1318
+ status?: 'active' | 'disabled' | 'deactivated';
1319
+ };
1320
+ timezone?: string | null;
1321
+ avatar?: string | null;
1322
+ /**
1323
+ * Display name derived from firstname/lastname or email
1324
+ */
1325
+ friendly_name: string;
1326
+ notified: Array<string>;
1327
+ /**
1328
+ * The language code for this translation.
1329
+ */
1330
+ lang?: string | null;
1331
+ partner_role?: string | null;
1332
+ favourite_spaces: Array<number>;
1333
+ /**
1334
+ * Array of idea UUIDs marked as favourite.
1335
+ */
1336
+ favourite_ideas: Array<string>;
1337
+ /**
1338
+ * User's system role
1339
+ */
1340
+ role?: 'admin' | 'normal' | 'banned' | 'sso' | 'superuser' | 'devops' | 'marketer' | null;
1341
+ /**
1342
+ * Always returns true.
1343
+ */
1344
+ beta_user: boolean;
1345
+ /**
1346
+ * Defaults to true if not set
1347
+ */
1348
+ track_statistics: boolean;
1349
+ /**
1350
+ * User UI theme preferences. Defaults to {"theme": "default"} if not set.
1351
+ */
1352
+ ui_theme: {
1353
+ [key: string]: unknown;
1354
+ };
1355
+ is_editor?: boolean | null;
1356
+ /**
1357
+ * Whether the user authenticates via SSO.
1358
+ */
1359
+ sso?: boolean | null;
1360
+ job_role?: string | null;
1361
+ job_title?: string | null;
1362
+ /**
1363
+ * Whether user has verified TOTP 2FA.
1364
+ */
1365
+ totp_factor_verified: boolean;
1366
+ /**
1367
+ * Available 2FA methods for this user. Always includes otp_email; otp_sms if phone set; twilio_totp if TOTP configured.
1368
+ */
1369
+ configured_2fa_options: Array<'otp_email' | 'otp_sms' | 'twilio_totp'>;
1370
+ disclaimer_ids: Array<number>;
1371
+ company_name?: string | null;
1372
+ live_chat_enabled: boolean;
1373
+ /**
1374
+ * True if user confirmed email or uses SSO
1375
+ */
1376
+ confirmed: boolean;
1377
+ };
1378
+ type UserUpdate = {
1379
+ email?: string;
1380
+ password?: string;
1381
+ password_confirmation?: string;
1382
+ current_password?: string;
1383
+ firstname?: string;
1384
+ lastname?: string;
1385
+ username?: string;
1386
+ lang?: string;
1387
+ timezone?: string;
1388
+ use_username?: boolean;
1389
+ alt_email?: string;
1390
+ login_strategy?: 'password' | 'otp_email' | 'otp_sms';
1391
+ phone?: string;
1392
+ is_editor?: boolean;
1393
+ job_role?: string;
1394
+ job_title?: string;
1395
+ company_name?: string;
1396
+ company_size?: string;
1397
+ usage_type?: string;
1398
+ framework_used?: string;
1399
+ beta_user?: boolean;
1400
+ track_statistics?: boolean;
1401
+ ui_theme?: {
1402
+ [key: string]: unknown;
1403
+ };
1404
+ favourite_spaces?: Array<number>;
1405
+ favourite_ideas?: Array<number>;
1406
+ notified?: Array<string>;
1407
+ disclaimer_ids?: Array<number>;
1408
+ };
1409
+ type StoryTranslatedSlug = {
1410
+ /**
1411
+ * id
1412
+ */
1413
+ id: number;
1414
+ /**
1415
+ * The name for this translated slug
1416
+ */
1417
+ name: string | null;
1418
+ /**
1419
+ * URL-friendly identifier for the app category.
1420
+ */
1421
+ slug: string;
1422
+ /**
1423
+ * The language code for this translation.
1424
+ */
1425
+ lang: string;
1426
+ published: boolean | null;
1427
+ };
1428
+ type StoryLocalizedPath = {
1429
+ /**
1430
+ * The localized path
1431
+ */
1432
+ path: string;
1433
+ /**
1434
+ * The translated name
1435
+ */
1436
+ name: string | null;
1437
+ /**
1438
+ * The language code for this translation.
1439
+ */
1440
+ lang: string;
1441
+ /**
1442
+ * Published status or date
1443
+ */
1444
+ published: boolean | string | null;
1445
+ /**
1446
+ * The translated slug (only present when folders are used).
1447
+ */
1448
+ translated_slug?: string;
1449
+ };
1450
+ /**
1451
+ * A dimension for datasource entries, enabling localized or context-specific values
1452
+ */
1453
+ type Dimension = {
1454
+ /**
1455
+ * ID
1456
+ */
1457
+ id: number;
1458
+ /**
1459
+ * Name
1460
+ */
1461
+ name: string;
1462
+ /**
1463
+ * The value provided for the datasource dimension.
1464
+ */
1465
+ entry_value: string;
1466
+ /**
1467
+ * The numeric ID of the datasource that the dimension belongs to.
1468
+ */
1469
+ datasource_id?: number;
1470
+ /**
1471
+ * Creation timestamp (format is ISO 8601 standard in UTC).
1472
+ */
1473
+ created_at?: string;
1474
+ /**
1475
+ * Latest update timestamp (format is ISO 8601 standard in UTC).
1476
+ */
1477
+ updated_at?: string;
1478
+ };
1479
+ /**
1480
+ * Custom role definition controlling permissions within a space
1481
+ */
1482
+ type SpaceRole = {
1483
+ /**
1484
+ * The unique identifier of the space role.
1485
+ */
1486
+ id: number;
1487
+ /**
1488
+ * The role name
1489
+ */
1490
+ role: string;
1491
+ /**
1492
+ * Optional subtitle for the role.
1493
+ */
1494
+ subtitle?: string | null;
1495
+ /**
1496
+ * External ID for integrations
1497
+ */
1498
+ ext_id?: string | null;
1499
+ /**
1500
+ * List of permissions
1501
+ */
1502
+ permissions: Array<string>;
1503
+ /**
1504
+ * Allowed content paths.
1505
+ */
1506
+ allowed_paths: Array<string>;
1507
+ /**
1508
+ * Resolved allowed paths with slugs.
1509
+ */
1510
+ resolved_allowed_paths: Array<string>;
1511
+ /**
1512
+ * Blocked content paths.
1513
+ */
1514
+ blocked_paths: Array<string>;
1515
+ /**
1516
+ * Resolved blocked paths with slugs.
1517
+ */
1518
+ resolved_blocked_paths: Array<string> | null;
1519
+ /**
1520
+ * Field-level permissions
1521
+ */
1522
+ field_permissions: Array<string>;
1523
+ /**
1524
+ * Allowed field permissions.
1525
+ */
1526
+ allowed_field_permissions: Array<string>;
1527
+ /**
1528
+ * Read-only field permissions.
1529
+ */
1530
+ readonly_field_permissions: Array<string>;
1531
+ /**
1532
+ * Allowed datasource IDs.
1533
+ */
1534
+ datasource_ids: Array<number>;
1535
+ /**
1536
+ * Blocked datasource IDs.
1537
+ */
1538
+ blocked_datasource_ids: Array<number>;
1539
+ /**
1540
+ * Blocked component IDs for usage.
1541
+ */
1542
+ component_ids: Array<number>;
1543
+ /**
1544
+ * Allowed component IDs for usage.
1545
+ */
1546
+ allowed_component_ids: Array<number>;
1547
+ /**
1548
+ * Managed component IDs.
1549
+ */
1550
+ managed_component_ids: Array<number>;
1551
+ /**
1552
+ * Blocked manage component IDs.
1553
+ */
1554
+ blocked_manage_component_ids: Array<number>;
1555
+ /**
1556
+ * Managed component group UUIDs.
1557
+ */
1558
+ managed_component_group_uuids: Array<string>;
1559
+ /**
1560
+ * Blocked manage component group UUIDs.
1561
+ */
1562
+ blocked_manage_component_group_uuids: Array<string>;
1563
+ /**
1564
+ * Allowed component group UUIDs for usage.
1565
+ */
1566
+ component_group_uuids: Array<string>;
1567
+ /**
1568
+ * Blocked component group UUIDs for usage.
1569
+ */
1570
+ blocked_component_group_uuids: Array<string>;
1571
+ /**
1572
+ * Allowed branch IDs.
1573
+ */
1574
+ branch_ids: Array<number>;
1575
+ /**
1576
+ * Blocked branch IDs.
1577
+ */
1578
+ blocked_branch_ids: Array<number>;
1579
+ /**
1580
+ * Allowed language codes.
1581
+ */
1582
+ allowed_languages: Array<string>;
1583
+ /**
1584
+ * Blocked language codes.
1585
+ */
1586
+ blocked_languages: Array<string>;
1587
+ /**
1588
+ * Allowed asset folder IDs.
1589
+ */
1590
+ asset_folder_ids: Array<number>;
1591
+ /**
1592
+ * Blocked asset folder IDs.
1593
+ */
1594
+ blocked_asset_folder_ids: Array<number>;
1595
+ };
1596
+ //#endregion
1597
+ export { Asset, AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, Component, ComponentCreate, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, ComponentUpdate, DatasourceCreate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, MapiDatasource, MapiDatasourceEntry, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, StoryLocalizedPath, StoryTranslatedSlug, User, UserUpdate };
1598
+ //# sourceMappingURL=types-aliased.gen.d.cts.map