@storyblok/schema 0.1.0-alpha.0

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