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