@storyblok/management-api-client 0.1.1 → 0.1.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 (41) hide show
  1. package/dist/generated/assets/types.gen.d.mts +14 -2
  2. package/dist/generated/assets/types.gen.d.ts +14 -2
  3. package/dist/generated/assets/types.gen.js.map +1 -1
  4. package/dist/generated/assets/types.gen.mjs.map +1 -1
  5. package/dist/generated/component_folders/types.gen.d.mts +8 -28
  6. package/dist/generated/component_folders/types.gen.d.ts +8 -28
  7. package/dist/generated/component_folders/types.gen.js.map +1 -1
  8. package/dist/generated/component_folders/types.gen.mjs.map +1 -1
  9. package/dist/generated/components/types.gen.d.mts +19 -7
  10. package/dist/generated/components/types.gen.d.ts +19 -7
  11. package/dist/generated/components/types.gen.js.map +1 -1
  12. package/dist/generated/components/types.gen.mjs.map +1 -1
  13. package/dist/generated/datasource_entries/types.gen.d.mts +26 -42
  14. package/dist/generated/datasource_entries/types.gen.d.ts +26 -42
  15. package/dist/generated/datasource_entries/types.gen.js.map +1 -1
  16. package/dist/generated/datasource_entries/types.gen.mjs.map +1 -1
  17. package/dist/generated/datasources/types.gen.d.mts +13 -59
  18. package/dist/generated/datasources/types.gen.d.ts +13 -59
  19. package/dist/generated/datasources/types.gen.js.map +1 -1
  20. package/dist/generated/datasources/types.gen.mjs.map +1 -1
  21. package/dist/generated/internal_tags/types.gen.d.mts +14 -2
  22. package/dist/generated/internal_tags/types.gen.d.ts +14 -2
  23. package/dist/generated/internal_tags/types.gen.js.map +1 -1
  24. package/dist/generated/internal_tags/types.gen.mjs.map +1 -1
  25. package/dist/generated/presets/types.gen.d.mts +10 -80
  26. package/dist/generated/presets/types.gen.d.ts +10 -80
  27. package/dist/generated/presets/types.gen.js.map +1 -1
  28. package/dist/generated/presets/types.gen.mjs.map +1 -1
  29. package/dist/generated/spaces/types.gen.d.mts +71 -0
  30. package/dist/generated/spaces/types.gen.d.ts +71 -0
  31. package/dist/generated/spaces/types.gen.js.map +1 -1
  32. package/dist/generated/spaces/types.gen.mjs.map +1 -1
  33. package/dist/generated/stories/types.gen.d.mts +30 -17
  34. package/dist/generated/stories/types.gen.d.ts +30 -17
  35. package/dist/generated/stories/types.gen.js.map +1 -1
  36. package/dist/generated/stories/types.gen.mjs.map +1 -1
  37. package/dist/generated/users/types.gen.d.mts +10 -113
  38. package/dist/generated/users/types.gen.d.ts +10 -113
  39. package/dist/generated/users/types.gen.js.map +1 -1
  40. package/dist/generated/users/types.gen.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -1 +1 @@
1
- {"version":3,"file":"types.gen.mjs","names":[],"sources":["../../../src/generated/presets/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * A Preset Object for creating new presets\n */\nexport type PresetCreate = {\n /**\n * Given name of your preset\n */\n name: string;\n /**\n * Fields of the component filled with content\n */\n preset?: {\n [key: string]: unknown;\n };\n /**\n * The ID of the component the preset is for\n */\n component_id: number;\n /**\n * Screenshot or other preview image for your editor\n */\n image?: string;\n /**\n * Color of the preset icon\n */\n color?: string;\n /**\n * Icon of the preset\n */\n icon?: string;\n /**\n * A description of the preset for the editors\n */\n description?: string;\n};\n\n/**\n * A Preset Object for updating existing presets\n */\nexport type PresetUpdate = {\n /**\n * Given name of your preset\n */\n name?: string;\n /**\n * Fields of the component filled with content\n */\n preset?: {\n [key: string]: unknown;\n };\n /**\n * The ID of the component the preset is for\n */\n component_id?: number;\n /**\n * Screenshot or other preview image for your editors\n */\n image?: string;\n /**\n * Color of the preset icon\n */\n color?: string;\n /**\n * Icon of the preset\n */\n icon?: string;\n /**\n * A description of the preset for the editors\n */\n description?: string;\n};\n\n/**\n * A Preset Object representing a content preset\n */\nexport type Preset = {\n /**\n * Numeric ID of your preset\n */\n readonly id: number;\n /**\n * Given name of your preset\n */\n name?: string;\n /**\n * Fields of the component filled with content\n */\n preset?: {\n [key: string]: unknown;\n };\n /**\n * The ID of the component the preset is for\n */\n component_id?: number;\n /**\n * Numeric ID of a space\n */\n space_id?: number;\n /**\n * Creation date\n */\n created_at?: string;\n /**\n * Latest update date\n */\n updated_at?: string;\n /**\n * Screenshot or other preview image for your editor\n */\n image?: string;\n /**\n * Color of the preset icon\n */\n color?: string;\n /**\n * Icon of the preset\n */\n icon?: string;\n /**\n * A description of the preset for the editors\n */\n description?: string;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\n/**\n * The ID of your preset (can be integer or string)\n */\nexport type PresetId = number | string;\n\nexport type ListData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: {\n /**\n * Filter presets by component ID\n */\n component_id?: number;\n };\n url: '/v1/spaces/{space_id}/presets';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type ListError = ListErrors[keyof ListErrors];\n\nexport type ListResponses = {\n /**\n * Successfully retrieved presets\n */\n 200: {\n presets?: Array<Preset>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n preset?: PresetCreate;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type CreateError = CreateErrors[keyof CreateErrors];\n\nexport type CreateResponses = {\n /**\n * Successfully created preset\n */\n 201: {\n preset?: Preset;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type DeleteError = DeleteErrors[keyof DeleteErrors];\n\nexport type DeleteResponses = {\n /**\n * Successfully deleted preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type GetError = GetErrors[keyof GetErrors];\n\nexport type GetResponses = {\n /**\n * Successfully retrieved preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n preset?: PresetUpdate;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type UpdateError = UpdateErrors[keyof UpdateErrors];\n\nexport type UpdateResponses = {\n /**\n * Successfully updated preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
1
+ {"version":3,"file":"types.gen.mjs","names":[],"sources":["../../../src/generated/presets/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * A Preset Object representing a content preset\n */\nexport type Preset = {\n /**\n * Numeric ID of your preset\n */\n readonly id: number;\n /**\n * Given name of your preset\n */\n name: string;\n /**\n * Fields of the component filled with content\n */\n preset: {\n [key: string]: unknown;\n };\n /**\n * The ID of the component the preset is for\n */\n component_id: number;\n /**\n * Numeric ID of a space\n */\n readonly space_id?: number;\n /**\n * Creation date\n */\n readonly created_at?: string;\n /**\n * Latest update date\n */\n readonly updated_at?: string;\n /**\n * Screenshot or other preview image for your editor\n */\n image?: string;\n /**\n * Color of the preset icon\n */\n color?: string;\n /**\n * Icon of the preset\n */\n icon?: string;\n /**\n * A description of the preset for the editors\n */\n description?: string;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\n/**\n * The ID of your preset (can be integer or string)\n */\nexport type PresetId = number | string;\n\nexport type ListData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: {\n /**\n * Filter presets by component ID\n */\n component_id?: number;\n };\n url: '/v1/spaces/{space_id}/presets';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type ListError = ListErrors[keyof ListErrors];\n\nexport type ListResponses = {\n /**\n * Successfully retrieved presets\n */\n 200: {\n presets?: Array<Preset>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n preset?: Preset;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type CreateError = CreateErrors[keyof CreateErrors];\n\nexport type CreateResponses = {\n /**\n * Successfully created preset\n */\n 201: {\n preset?: Preset;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type DeleteError = DeleteErrors[keyof DeleteErrors];\n\nexport type DeleteResponses = {\n /**\n * Successfully deleted preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type GetError = GetErrors[keyof GetErrors];\n\nexport type GetResponses = {\n /**\n * Successfully retrieved preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n preset?: Preset;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n /**\n * The ID of your preset (can be integer or string)\n */\n preset_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}/presets/{preset_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: {\n error?: string;\n };\n /**\n * Unauthorized\n */\n 401: {\n error?: string;\n };\n /**\n * Resource not found\n */\n 404: {\n error?: string;\n };\n};\n\nexport type UpdateError = UpdateErrors[keyof UpdateErrors];\n\nexport type UpdateResponses = {\n /**\n * Successfully updated preset\n */\n 200: {\n preset?: Preset;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
@@ -142,6 +142,52 @@ type Space = {
142
142
  owner?: {
143
143
  [key: string]: unknown;
144
144
  };
145
+ /**
146
+ * Organization object for the space
147
+ */
148
+ org?: {
149
+ /**
150
+ * Name of the organization
151
+ */
152
+ name?: string;
153
+ /**
154
+ * Whether AI text generator is disabled in the organization
155
+ */
156
+ ai_text_generator_disabled_in_org?: boolean;
157
+ /**
158
+ * Custom upload limit in MB for the organization
159
+ */
160
+ custom_upload_limit_in_mb?: number;
161
+ };
162
+ /**
163
+ * Whether the space is in an organization
164
+ */
165
+ in_org?: boolean;
166
+ /**
167
+ * Whether the space is assigned to a partner
168
+ */
169
+ assign_partner?: boolean;
170
+ /**
171
+ * Array of language objects available in the space
172
+ */
173
+ languages?: Array<{
174
+ /**
175
+ * Language code (e.g., 'en', 'de', 'fr')
176
+ */
177
+ code?: string;
178
+ /**
179
+ * Display name of the language
180
+ */
181
+ name?: string;
182
+ /**
183
+ * AI translation code for the language, can be null
184
+ */
185
+ ai_translation_code?: string;
186
+ }>;
187
+ /**
188
+ * Default language code for the space
189
+ */
190
+ default_lang_name?: string;
145
191
  };
146
192
  /**
147
193
  * The Collaborator Object
@@ -262,6 +308,31 @@ type SpaceCreateRequest = {
262
308
  * Reference to a blueprint
263
309
  */
264
310
  blueprint_reference?: string;
311
+ /**
312
+ * Organization object for the space
313
+ */
314
+ org?: {
315
+ /**
316
+ * Name of the organization
317
+ */
318
+ name?: string;
319
+ /**
320
+ * Whether AI text generator is disabled in the organization
321
+ */
322
+ ai_text_generator_disabled_in_org?: boolean;
323
+ /**
324
+ * Custom upload limit in MB for the organization
325
+ */
326
+ custom_upload_limit_in_mb?: number;
327
+ };
328
+ /**
329
+ * Whether the space is in an organization
330
+ */
331
+ in_org?: boolean;
332
+ /**
333
+ * Whether the space is assigned to a partner
334
+ */
335
+ assign_partner?: boolean;
265
336
  };
266
337
  /**
267
338
  * Request body for updating a space
@@ -142,6 +142,52 @@ type Space = {
142
142
  owner?: {
143
143
  [key: string]: unknown;
144
144
  };
145
+ /**
146
+ * Organization object for the space
147
+ */
148
+ org?: {
149
+ /**
150
+ * Name of the organization
151
+ */
152
+ name?: string;
153
+ /**
154
+ * Whether AI text generator is disabled in the organization
155
+ */
156
+ ai_text_generator_disabled_in_org?: boolean;
157
+ /**
158
+ * Custom upload limit in MB for the organization
159
+ */
160
+ custom_upload_limit_in_mb?: number;
161
+ };
162
+ /**
163
+ * Whether the space is in an organization
164
+ */
165
+ in_org?: boolean;
166
+ /**
167
+ * Whether the space is assigned to a partner
168
+ */
169
+ assign_partner?: boolean;
170
+ /**
171
+ * Array of language objects available in the space
172
+ */
173
+ languages?: Array<{
174
+ /**
175
+ * Language code (e.g., 'en', 'de', 'fr')
176
+ */
177
+ code?: string;
178
+ /**
179
+ * Display name of the language
180
+ */
181
+ name?: string;
182
+ /**
183
+ * AI translation code for the language, can be null
184
+ */
185
+ ai_translation_code?: string;
186
+ }>;
187
+ /**
188
+ * Default language code for the space
189
+ */
190
+ default_lang_name?: string;
145
191
  };
146
192
  /**
147
193
  * The Collaborator Object
@@ -262,6 +308,31 @@ type SpaceCreateRequest = {
262
308
  * Reference to a blueprint
263
309
  */
264
310
  blueprint_reference?: string;
311
+ /**
312
+ * Organization object for the space
313
+ */
314
+ org?: {
315
+ /**
316
+ * Name of the organization
317
+ */
318
+ name?: string;
319
+ /**
320
+ * Whether AI text generator is disabled in the organization
321
+ */
322
+ ai_text_generator_disabled_in_org?: boolean;
323
+ /**
324
+ * Custom upload limit in MB for the organization
325
+ */
326
+ custom_upload_limit_in_mb?: number;
327
+ };
328
+ /**
329
+ * Whether the space is in an organization
330
+ */
331
+ in_org?: boolean;
332
+ /**
333
+ * Whether the space is assigned to a partner
334
+ */
335
+ assign_partner?: boolean;
265
336
  };
266
337
  /**
267
338
  * Request body for updating a space
@@ -1 +1 @@
1
- {"version":3,"file":"types.gen.js","names":[],"sources":["../../../src/generated/spaces/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * The Space Object\n */\nexport type Space = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Space Plan\n */\n plan?: string;\n /**\n * Plan Level of Space\n */\n plan_level?: number;\n /**\n * Limits of the space\n */\n limits?: {\n [key: string]: unknown;\n };\n /**\n * Creation date\n */\n created_at?: string;\n /**\n * ID of the space\n */\n readonly id: number;\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Number of Stories in the Space\n */\n stories_count?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Number of Assets in the Space\n */\n assets_count?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Request Count of the day\n */\n request_count_today?: number;\n /**\n * Number of Exceeded Requests\n */\n exceeded_requests?: number;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Is the space in trial mode\n */\n trial?: boolean;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Does the space have a slack webhook\n */\n has_slack_webhook?: boolean;\n /**\n * If the space has pending tasks like backup, deployment etc\n */\n has_pending_tasks?: boolean;\n /**\n * Legacy (no longer in use). Used to enable or disable AI translations.\n */\n ai_translation_disabled?: boolean;\n /**\n * The oldest available preview token of the space\n */\n first_token?: string;\n /**\n * Options for backup and language configurations\n */\n options?: {\n [key: string]: unknown;\n };\n /**\n * Array of Collaborators of the Space\n */\n collaborator?: Array<Collaborator>;\n /**\n * The user Object of the Owner\n */\n owner?: {\n [key: string]: unknown;\n };\n};\n\n/**\n * The Collaborator Object\n */\nexport type Collaborator = {\n /**\n * The user object inside a collaborator object\n */\n user?: {\n /**\n * The user ID\n */\n id?: number;\n /**\n * First name of collaborator\n */\n firstname?: string;\n /**\n * Last name of collaborator\n */\n lastname?: string;\n /**\n * Email of collaborator\n */\n alt_email?: string;\n /**\n * Avatar of collaborator usually an image\n */\n avatar?: string;\n /**\n * User ID of collaborator\n */\n userid?: string;\n /**\n * Friendly name of collaborator\n */\n friendly_name?: string;\n };\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric ID of the user\n */\n user_id?: number;\n /**\n * Allow specific actions for collaborator in interface and add the permission as array of strings\n */\n permissions?: Array<'read_stories' | 'save_stories' | 'publish_stories' | 'unpublish_stories' | 'publish_folders' | 'unpublish_folders' | 'deploy_stories' | 'delete_stories' | 'edit_image' | 'view_composer' | 'change_alternate_group' | 'move_story' | 'edit_story_slug' | 'view_content' | 'view_folders' | 'view_draft_json' | 'view_published_json' | 'manage_tags' | 'edit_datasources' | 'edit_datasource_keys' | 'access_commerce' | 'manage_block_library' | 'hide_asset_folders'>;\n /**\n * Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.\n */\n allowed_paths?: Array<number>;\n /**\n * Hide specific fields for this user with an array of strings with the schema\n */\n field_permissions?: Array<string>;\n /**\n * Numeric id of collaborator\n */\n id?: number;\n /**\n * Numeric ID of the space role\n */\n space_role_id?: number;\n /**\n * Array of space role ids\n */\n space_role_ids?: Array<number>;\n /**\n * Numeric id of the collaborator space\n */\n space_id?: number;\n};\n\n/**\n * Request body for creating a space\n */\nexport type SpaceCreateRequest = {\n /**\n * Name of the Space\n */\n name: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Whether this is a demo space\n */\n is_demo?: boolean;\n /**\n * Reference to a blueprint\n */\n blueprint_reference?: string;\n};\n\n/**\n * Request body for updating a space\n */\nexport type SpaceUpdateRequest = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Array of language objects\n */\n languages?: Array<{\n /**\n * Language code\n */\n code?: string;\n /**\n * Language name\n */\n name?: string;\n /**\n * AI translation code for the language\n */\n ai_translation_code?: string;\n }>;\n /**\n * Crawl configuration\n */\n crawl_config?: {\n /**\n * Base URL for crawling\n */\n base_url?: string;\n /**\n * Whether crawling is enabled\n */\n enabled?: boolean;\n };\n /**\n * Required asset fields\n */\n required_assest_fields?: Array<string>;\n /**\n * Custom metadata schema for assets\n */\n asset_custom_meta_data_schema?: Array<{\n /**\n * Field key\n */\n key?: string;\n /**\n * Display name for the field\n */\n display_name?: string;\n /**\n * Regex pattern for validation\n */\n regex?: string;\n /**\n * Error message for regex validation\n */\n regex_message?: string;\n /**\n * Whether the field is required\n */\n required?: boolean;\n /**\n * Whether the field is translatable\n */\n translatable?: boolean;\n /**\n * Allowed file types\n */\n filetypes?: Array<string>;\n }>;\n /**\n * Translatable asset fields\n */\n translatable_asset_fields?: Array<string>;\n /**\n * Dimensions app folder IDs\n */\n dimensions_app_folder_ids?: Array<number>;\n /**\n * Disclaimer ID for the space\n */\n disclaimer_id?: number;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\nexport type ListData = {\n body?: never;\n path?: never;\n query?: {\n /**\n * Search term to filter spaces by name\n */\n search?: string;\n };\n url: '/v1/spaces';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n};\n\nexport type ListResponses = {\n /**\n * List of spaces\n */\n 200: {\n spaces?: Array<Space>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n space: SpaceCreateRequest;\n /**\n * The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.\n */\n dup_id?: number;\n /**\n * Whether to create the space within the user's organization\n */\n in_org?: boolean;\n /**\n * Type of space for enterprise plans\n */\n space_type?: string;\n /**\n * Whether to assign a partner to the space\n */\n assign_partner?: boolean;\n };\n path?: never;\n query?: never;\n url: '/v1/spaces';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type CreateResponses = {\n /**\n * Space created\n */\n 201: {\n space?: Space;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type DeleteResponses = {\n /**\n * Space deleted\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n};\n\nexport type GetResponses = {\n /**\n * Space details\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n space: SpaceUpdateRequest;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type UpdateResponses = {\n /**\n * Space updated\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
1
+ {"version":3,"file":"types.gen.js","names":[],"sources":["../../../src/generated/spaces/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * The Space Object\n */\nexport type Space = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Space Plan\n */\n plan?: string;\n /**\n * Plan Level of Space\n */\n plan_level?: number;\n /**\n * Limits of the space\n */\n limits?: {\n [key: string]: unknown;\n };\n /**\n * Creation date\n */\n created_at?: string;\n /**\n * ID of the space\n */\n readonly id: number;\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Number of Stories in the Space\n */\n stories_count?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Number of Assets in the Space\n */\n assets_count?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Request Count of the day\n */\n request_count_today?: number;\n /**\n * Number of Exceeded Requests\n */\n exceeded_requests?: number;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Is the space in trial mode\n */\n trial?: boolean;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Does the space have a slack webhook\n */\n has_slack_webhook?: boolean;\n /**\n * If the space has pending tasks like backup, deployment etc\n */\n has_pending_tasks?: boolean;\n /**\n * Legacy (no longer in use). Used to enable or disable AI translations.\n */\n ai_translation_disabled?: boolean;\n /**\n * The oldest available preview token of the space\n */\n first_token?: string;\n /**\n * Options for backup and language configurations\n */\n options?: {\n [key: string]: unknown;\n };\n /**\n * Array of Collaborators of the Space\n */\n collaborator?: Array<Collaborator>;\n /**\n * The user Object of the Owner\n */\n owner?: {\n [key: string]: unknown;\n };\n /**\n * Organization object for the space\n */\n org?: {\n /**\n * Name of the organization\n */\n name?: string;\n /**\n * Whether AI text generator is disabled in the organization\n */\n ai_text_generator_disabled_in_org?: boolean;\n /**\n * Custom upload limit in MB for the organization\n */\n custom_upload_limit_in_mb?: number;\n };\n /**\n * Whether the space is in an organization\n */\n in_org?: boolean;\n /**\n * Whether the space is assigned to a partner\n */\n assign_partner?: boolean;\n /**\n * Array of language objects available in the space\n */\n languages?: Array<{\n /**\n * Language code (e.g., 'en', 'de', 'fr')\n */\n code?: string;\n /**\n * Display name of the language\n */\n name?: string;\n /**\n * AI translation code for the language, can be null\n */\n ai_translation_code?: string;\n }>;\n /**\n * Default language code for the space\n */\n default_lang_name?: string;\n};\n\n/**\n * The Collaborator Object\n */\nexport type Collaborator = {\n /**\n * The user object inside a collaborator object\n */\n user?: {\n /**\n * The user ID\n */\n id?: number;\n /**\n * First name of collaborator\n */\n firstname?: string;\n /**\n * Last name of collaborator\n */\n lastname?: string;\n /**\n * Email of collaborator\n */\n alt_email?: string;\n /**\n * Avatar of collaborator usually an image\n */\n avatar?: string;\n /**\n * User ID of collaborator\n */\n userid?: string;\n /**\n * Friendly name of collaborator\n */\n friendly_name?: string;\n };\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric ID of the user\n */\n user_id?: number;\n /**\n * Allow specific actions for collaborator in interface and add the permission as array of strings\n */\n permissions?: Array<'read_stories' | 'save_stories' | 'publish_stories' | 'unpublish_stories' | 'publish_folders' | 'unpublish_folders' | 'deploy_stories' | 'delete_stories' | 'edit_image' | 'view_composer' | 'change_alternate_group' | 'move_story' | 'edit_story_slug' | 'view_content' | 'view_folders' | 'view_draft_json' | 'view_published_json' | 'manage_tags' | 'edit_datasources' | 'edit_datasource_keys' | 'access_commerce' | 'manage_block_library' | 'hide_asset_folders'>;\n /**\n * Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.\n */\n allowed_paths?: Array<number>;\n /**\n * Hide specific fields for this user with an array of strings with the schema\n */\n field_permissions?: Array<string>;\n /**\n * Numeric id of collaborator\n */\n id?: number;\n /**\n * Numeric ID of the space role\n */\n space_role_id?: number;\n /**\n * Array of space role ids\n */\n space_role_ids?: Array<number>;\n /**\n * Numeric id of the collaborator space\n */\n space_id?: number;\n};\n\n/**\n * Request body for creating a space\n */\nexport type SpaceCreateRequest = {\n /**\n * Name of the Space\n */\n name: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Whether this is a demo space\n */\n is_demo?: boolean;\n /**\n * Reference to a blueprint\n */\n blueprint_reference?: string;\n /**\n * Organization object for the space\n */\n org?: {\n /**\n * Name of the organization\n */\n name?: string;\n /**\n * Whether AI text generator is disabled in the organization\n */\n ai_text_generator_disabled_in_org?: boolean;\n /**\n * Custom upload limit in MB for the organization\n */\n custom_upload_limit_in_mb?: number;\n };\n /**\n * Whether the space is in an organization\n */\n in_org?: boolean;\n /**\n * Whether the space is assigned to a partner\n */\n assign_partner?: boolean;\n};\n\n/**\n * Request body for updating a space\n */\nexport type SpaceUpdateRequest = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Array of language objects\n */\n languages?: Array<{\n /**\n * Language code\n */\n code?: string;\n /**\n * Language name\n */\n name?: string;\n /**\n * AI translation code for the language\n */\n ai_translation_code?: string;\n }>;\n /**\n * Crawl configuration\n */\n crawl_config?: {\n /**\n * Base URL for crawling\n */\n base_url?: string;\n /**\n * Whether crawling is enabled\n */\n enabled?: boolean;\n };\n /**\n * Required asset fields\n */\n required_assest_fields?: Array<string>;\n /**\n * Custom metadata schema for assets\n */\n asset_custom_meta_data_schema?: Array<{\n /**\n * Field key\n */\n key?: string;\n /**\n * Display name for the field\n */\n display_name?: string;\n /**\n * Regex pattern for validation\n */\n regex?: string;\n /**\n * Error message for regex validation\n */\n regex_message?: string;\n /**\n * Whether the field is required\n */\n required?: boolean;\n /**\n * Whether the field is translatable\n */\n translatable?: boolean;\n /**\n * Allowed file types\n */\n filetypes?: Array<string>;\n }>;\n /**\n * Translatable asset fields\n */\n translatable_asset_fields?: Array<string>;\n /**\n * Dimensions app folder IDs\n */\n dimensions_app_folder_ids?: Array<number>;\n /**\n * Disclaimer ID for the space\n */\n disclaimer_id?: number;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\nexport type ListData = {\n body?: never;\n path?: never;\n query?: {\n /**\n * Search term to filter spaces by name\n */\n search?: string;\n };\n url: '/v1/spaces';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n};\n\nexport type ListResponses = {\n /**\n * List of spaces\n */\n 200: {\n spaces?: Array<Space>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n space: SpaceCreateRequest;\n /**\n * The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.\n */\n dup_id?: number;\n /**\n * Whether to create the space within the user's organization\n */\n in_org?: boolean;\n /**\n * Type of space for enterprise plans\n */\n space_type?: string;\n /**\n * Whether to assign a partner to the space\n */\n assign_partner?: boolean;\n };\n path?: never;\n query?: never;\n url: '/v1/spaces';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type CreateResponses = {\n /**\n * Space created\n */\n 201: {\n space?: Space;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type DeleteResponses = {\n /**\n * Space deleted\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n};\n\nexport type GetResponses = {\n /**\n * Space details\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n space: SpaceUpdateRequest;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type UpdateResponses = {\n /**\n * Space updated\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
@@ -1 +1 @@
1
- {"version":3,"file":"types.gen.mjs","names":[],"sources":["../../../src/generated/spaces/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * The Space Object\n */\nexport type Space = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Space Plan\n */\n plan?: string;\n /**\n * Plan Level of Space\n */\n plan_level?: number;\n /**\n * Limits of the space\n */\n limits?: {\n [key: string]: unknown;\n };\n /**\n * Creation date\n */\n created_at?: string;\n /**\n * ID of the space\n */\n readonly id: number;\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Number of Stories in the Space\n */\n stories_count?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Number of Assets in the Space\n */\n assets_count?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Request Count of the day\n */\n request_count_today?: number;\n /**\n * Number of Exceeded Requests\n */\n exceeded_requests?: number;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Is the space in trial mode\n */\n trial?: boolean;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Does the space have a slack webhook\n */\n has_slack_webhook?: boolean;\n /**\n * If the space has pending tasks like backup, deployment etc\n */\n has_pending_tasks?: boolean;\n /**\n * Legacy (no longer in use). Used to enable or disable AI translations.\n */\n ai_translation_disabled?: boolean;\n /**\n * The oldest available preview token of the space\n */\n first_token?: string;\n /**\n * Options for backup and language configurations\n */\n options?: {\n [key: string]: unknown;\n };\n /**\n * Array of Collaborators of the Space\n */\n collaborator?: Array<Collaborator>;\n /**\n * The user Object of the Owner\n */\n owner?: {\n [key: string]: unknown;\n };\n};\n\n/**\n * The Collaborator Object\n */\nexport type Collaborator = {\n /**\n * The user object inside a collaborator object\n */\n user?: {\n /**\n * The user ID\n */\n id?: number;\n /**\n * First name of collaborator\n */\n firstname?: string;\n /**\n * Last name of collaborator\n */\n lastname?: string;\n /**\n * Email of collaborator\n */\n alt_email?: string;\n /**\n * Avatar of collaborator usually an image\n */\n avatar?: string;\n /**\n * User ID of collaborator\n */\n userid?: string;\n /**\n * Friendly name of collaborator\n */\n friendly_name?: string;\n };\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric ID of the user\n */\n user_id?: number;\n /**\n * Allow specific actions for collaborator in interface and add the permission as array of strings\n */\n permissions?: Array<'read_stories' | 'save_stories' | 'publish_stories' | 'unpublish_stories' | 'publish_folders' | 'unpublish_folders' | 'deploy_stories' | 'delete_stories' | 'edit_image' | 'view_composer' | 'change_alternate_group' | 'move_story' | 'edit_story_slug' | 'view_content' | 'view_folders' | 'view_draft_json' | 'view_published_json' | 'manage_tags' | 'edit_datasources' | 'edit_datasource_keys' | 'access_commerce' | 'manage_block_library' | 'hide_asset_folders'>;\n /**\n * Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.\n */\n allowed_paths?: Array<number>;\n /**\n * Hide specific fields for this user with an array of strings with the schema\n */\n field_permissions?: Array<string>;\n /**\n * Numeric id of collaborator\n */\n id?: number;\n /**\n * Numeric ID of the space role\n */\n space_role_id?: number;\n /**\n * Array of space role ids\n */\n space_role_ids?: Array<number>;\n /**\n * Numeric id of the collaborator space\n */\n space_id?: number;\n};\n\n/**\n * Request body for creating a space\n */\nexport type SpaceCreateRequest = {\n /**\n * Name of the Space\n */\n name: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Whether this is a demo space\n */\n is_demo?: boolean;\n /**\n * Reference to a blueprint\n */\n blueprint_reference?: string;\n};\n\n/**\n * Request body for updating a space\n */\nexport type SpaceUpdateRequest = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Array of language objects\n */\n languages?: Array<{\n /**\n * Language code\n */\n code?: string;\n /**\n * Language name\n */\n name?: string;\n /**\n * AI translation code for the language\n */\n ai_translation_code?: string;\n }>;\n /**\n * Crawl configuration\n */\n crawl_config?: {\n /**\n * Base URL for crawling\n */\n base_url?: string;\n /**\n * Whether crawling is enabled\n */\n enabled?: boolean;\n };\n /**\n * Required asset fields\n */\n required_assest_fields?: Array<string>;\n /**\n * Custom metadata schema for assets\n */\n asset_custom_meta_data_schema?: Array<{\n /**\n * Field key\n */\n key?: string;\n /**\n * Display name for the field\n */\n display_name?: string;\n /**\n * Regex pattern for validation\n */\n regex?: string;\n /**\n * Error message for regex validation\n */\n regex_message?: string;\n /**\n * Whether the field is required\n */\n required?: boolean;\n /**\n * Whether the field is translatable\n */\n translatable?: boolean;\n /**\n * Allowed file types\n */\n filetypes?: Array<string>;\n }>;\n /**\n * Translatable asset fields\n */\n translatable_asset_fields?: Array<string>;\n /**\n * Dimensions app folder IDs\n */\n dimensions_app_folder_ids?: Array<number>;\n /**\n * Disclaimer ID for the space\n */\n disclaimer_id?: number;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\nexport type ListData = {\n body?: never;\n path?: never;\n query?: {\n /**\n * Search term to filter spaces by name\n */\n search?: string;\n };\n url: '/v1/spaces';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n};\n\nexport type ListResponses = {\n /**\n * List of spaces\n */\n 200: {\n spaces?: Array<Space>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n space: SpaceCreateRequest;\n /**\n * The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.\n */\n dup_id?: number;\n /**\n * Whether to create the space within the user's organization\n */\n in_org?: boolean;\n /**\n * Type of space for enterprise plans\n */\n space_type?: string;\n /**\n * Whether to assign a partner to the space\n */\n assign_partner?: boolean;\n };\n path?: never;\n query?: never;\n url: '/v1/spaces';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type CreateResponses = {\n /**\n * Space created\n */\n 201: {\n space?: Space;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type DeleteResponses = {\n /**\n * Space deleted\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n};\n\nexport type GetResponses = {\n /**\n * Space details\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n space: SpaceUpdateRequest;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type UpdateResponses = {\n /**\n * Space updated\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
1
+ {"version":3,"file":"types.gen.mjs","names":[],"sources":["../../../src/generated/spaces/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\n/**\n * The Space Object\n */\nexport type Space = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Space Plan\n */\n plan?: string;\n /**\n * Plan Level of Space\n */\n plan_level?: number;\n /**\n * Limits of the space\n */\n limits?: {\n [key: string]: unknown;\n };\n /**\n * Creation date\n */\n created_at?: string;\n /**\n * ID of the space\n */\n readonly id: number;\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Number of Stories in the Space\n */\n stories_count?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Number of Assets in the Space\n */\n assets_count?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Request Count of the day\n */\n request_count_today?: number;\n /**\n * Number of Exceeded Requests\n */\n exceeded_requests?: number;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Is the space in trial mode\n */\n trial?: boolean;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Does the space have a slack webhook\n */\n has_slack_webhook?: boolean;\n /**\n * If the space has pending tasks like backup, deployment etc\n */\n has_pending_tasks?: boolean;\n /**\n * Legacy (no longer in use). Used to enable or disable AI translations.\n */\n ai_translation_disabled?: boolean;\n /**\n * The oldest available preview token of the space\n */\n first_token?: string;\n /**\n * Options for backup and language configurations\n */\n options?: {\n [key: string]: unknown;\n };\n /**\n * Array of Collaborators of the Space\n */\n collaborator?: Array<Collaborator>;\n /**\n * The user Object of the Owner\n */\n owner?: {\n [key: string]: unknown;\n };\n /**\n * Organization object for the space\n */\n org?: {\n /**\n * Name of the organization\n */\n name?: string;\n /**\n * Whether AI text generator is disabled in the organization\n */\n ai_text_generator_disabled_in_org?: boolean;\n /**\n * Custom upload limit in MB for the organization\n */\n custom_upload_limit_in_mb?: number;\n };\n /**\n * Whether the space is in an organization\n */\n in_org?: boolean;\n /**\n * Whether the space is assigned to a partner\n */\n assign_partner?: boolean;\n /**\n * Array of language objects available in the space\n */\n languages?: Array<{\n /**\n * Language code (e.g., 'en', 'de', 'fr')\n */\n code?: string;\n /**\n * Display name of the language\n */\n name?: string;\n /**\n * AI translation code for the language, can be null\n */\n ai_translation_code?: string;\n }>;\n /**\n * Default language code for the space\n */\n default_lang_name?: string;\n};\n\n/**\n * The Collaborator Object\n */\nexport type Collaborator = {\n /**\n * The user object inside a collaborator object\n */\n user?: {\n /**\n * The user ID\n */\n id?: number;\n /**\n * First name of collaborator\n */\n firstname?: string;\n /**\n * Last name of collaborator\n */\n lastname?: string;\n /**\n * Email of collaborator\n */\n alt_email?: string;\n /**\n * Avatar of collaborator usually an image\n */\n avatar?: string;\n /**\n * User ID of collaborator\n */\n userid?: string;\n /**\n * Friendly name of collaborator\n */\n friendly_name?: string;\n };\n /**\n * Role of the collaborator, could be admin, editor or custom roles\n */\n role?: string;\n /**\n * Numeric ID of the user\n */\n user_id?: number;\n /**\n * Allow specific actions for collaborator in interface and add the permission as array of strings\n */\n permissions?: Array<'read_stories' | 'save_stories' | 'publish_stories' | 'unpublish_stories' | 'publish_folders' | 'unpublish_folders' | 'deploy_stories' | 'delete_stories' | 'edit_image' | 'view_composer' | 'change_alternate_group' | 'move_story' | 'edit_story_slug' | 'view_content' | 'view_folders' | 'view_draft_json' | 'view_published_json' | 'manage_tags' | 'edit_datasources' | 'edit_datasource_keys' | 'access_commerce' | 'manage_block_library' | 'hide_asset_folders'>;\n /**\n * Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.\n */\n allowed_paths?: Array<number>;\n /**\n * Hide specific fields for this user with an array of strings with the schema\n */\n field_permissions?: Array<string>;\n /**\n * Numeric id of collaborator\n */\n id?: number;\n /**\n * Numeric ID of the space role\n */\n space_role_id?: number;\n /**\n * Array of space role ids\n */\n space_role_ids?: Array<number>;\n /**\n * Numeric id of the collaborator space\n */\n space_id?: number;\n};\n\n/**\n * Request body for creating a space\n */\nexport type SpaceCreateRequest = {\n /**\n * Name of the Space\n */\n name: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Whether this is a demo space\n */\n is_demo?: boolean;\n /**\n * Reference to a blueprint\n */\n blueprint_reference?: string;\n /**\n * Organization object for the space\n */\n org?: {\n /**\n * Name of the organization\n */\n name?: string;\n /**\n * Whether AI text generator is disabled in the organization\n */\n ai_text_generator_disabled_in_org?: boolean;\n /**\n * Custom upload limit in MB for the organization\n */\n custom_upload_limit_in_mb?: number;\n };\n /**\n * Whether the space is in an organization\n */\n in_org?: boolean;\n /**\n * Whether the space is assigned to a partner\n */\n assign_partner?: boolean;\n};\n\n/**\n * Request body for updating a space\n */\nexport type SpaceUpdateRequest = {\n /**\n * Name of the Space\n */\n name?: string;\n /**\n * Domain for your default preview url\n */\n domain?: string;\n /**\n * Unique Domain for the Storyblok Rendering Service\n */\n uniq_domain?: string;\n /**\n * Numeric user id of the owner for that space\n */\n owner_id?: number;\n /**\n * Published Webhook URL\n */\n story_published_hook?: string;\n /**\n * Array of name, location (url) objects\n */\n environments?: Array<{\n /**\n * Environment name\n */\n name?: string;\n /**\n * Environment URL\n */\n location?: string;\n }>;\n /**\n * Space id of a possible parent space\n */\n parent_id?: number;\n /**\n * Searchblok id, if available\n */\n searchblok_id?: number;\n /**\n * Is the space globally duplicatable by all users\n */\n duplicatable?: boolean;\n /**\n * Billing information used to generate your invoices for this space\n */\n billing_address?: {\n [key: string]: unknown;\n };\n /**\n * Routes for the Storyblok Rendering Service\n */\n routes?: Array<string>;\n /**\n * Component name which will be used as default content type for this folders entries\n */\n default_root?: string;\n /**\n * Array of language objects\n */\n languages?: Array<{\n /**\n * Language code\n */\n code?: string;\n /**\n * Language name\n */\n name?: string;\n /**\n * AI translation code for the language\n */\n ai_translation_code?: string;\n }>;\n /**\n * Crawl configuration\n */\n crawl_config?: {\n /**\n * Base URL for crawling\n */\n base_url?: string;\n /**\n * Whether crawling is enabled\n */\n enabled?: boolean;\n };\n /**\n * Required asset fields\n */\n required_assest_fields?: Array<string>;\n /**\n * Custom metadata schema for assets\n */\n asset_custom_meta_data_schema?: Array<{\n /**\n * Field key\n */\n key?: string;\n /**\n * Display name for the field\n */\n display_name?: string;\n /**\n * Regex pattern for validation\n */\n regex?: string;\n /**\n * Error message for regex validation\n */\n regex_message?: string;\n /**\n * Whether the field is required\n */\n required?: boolean;\n /**\n * Whether the field is translatable\n */\n translatable?: boolean;\n /**\n * Allowed file types\n */\n filetypes?: Array<string>;\n }>;\n /**\n * Translatable asset fields\n */\n translatable_asset_fields?: Array<string>;\n /**\n * Dimensions app folder IDs\n */\n dimensions_app_folder_ids?: Array<number>;\n /**\n * Disclaimer ID for the space\n */\n disclaimer_id?: number;\n};\n\n/**\n * The ID of the Storyblok space (can be integer or string)\n */\nexport type SpaceId = number | string;\n\nexport type ListData = {\n body?: never;\n path?: never;\n query?: {\n /**\n * Search term to filter spaces by name\n */\n search?: string;\n };\n url: '/v1/spaces';\n};\n\nexport type ListErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n};\n\nexport type ListResponses = {\n /**\n * List of spaces\n */\n 200: {\n spaces?: Array<Space>;\n };\n};\n\nexport type ListResponse = ListResponses[keyof ListResponses];\n\nexport type CreateData = {\n body: {\n space: SpaceCreateRequest;\n /**\n * The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.\n */\n dup_id?: number;\n /**\n * Whether to create the space within the user's organization\n */\n in_org?: boolean;\n /**\n * Type of space for enterprise plans\n */\n space_type?: string;\n /**\n * Whether to assign a partner to the space\n */\n assign_partner?: boolean;\n };\n path?: never;\n query?: never;\n url: '/v1/spaces';\n};\n\nexport type CreateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type CreateResponses = {\n /**\n * Space created\n */\n 201: {\n space?: Space;\n };\n};\n\nexport type CreateResponse = CreateResponses[keyof CreateResponses];\n\nexport type DeleteData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type DeleteErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type DeleteResponses = {\n /**\n * Space deleted\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type DeleteResponse = DeleteResponses[keyof DeleteResponses];\n\nexport type GetData = {\n body?: never;\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type GetErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n};\n\nexport type GetResponses = {\n /**\n * Space details\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type GetResponse = GetResponses[keyof GetResponses];\n\nexport type UpdateData = {\n body: {\n space: SpaceUpdateRequest;\n };\n path: {\n /**\n * The ID of the Storyblok space (can be integer or string)\n */\n space_id: number | string;\n };\n query?: never;\n url: '/v1/spaces/{space_id}';\n};\n\nexport type UpdateErrors = {\n /**\n * Bad request\n */\n 400: unknown;\n /**\n * Unauthorized\n */\n 401: unknown;\n /**\n * Forbidden - insufficient permissions\n */\n 403: unknown;\n /**\n * Space not found\n */\n 404: unknown;\n /**\n * Unprocessable entity - validation errors\n */\n 422: unknown;\n};\n\nexport type UpdateResponses = {\n /**\n * Space updated\n */\n 200: {\n space?: Space;\n };\n};\n\nexport type UpdateResponse = UpdateResponses[keyof UpdateResponses];\n\nexport type ClientOptions = {\n baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});\n};"],"mappings":""}
@@ -1,5 +1,5 @@
1
1
  declare namespace types_gen_d_exports {
2
- export { ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses };
2
+ export { Blok, ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, ComponentContent, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses };
3
3
  }
4
4
  type Story = Story2;
5
5
  type StoryCreateRequest = StoryCreateRequest2;
@@ -52,6 +52,25 @@ type StoryVersionComparison = {
52
52
  };
53
53
  };
54
54
  type UnpublishedStory = Story2;
55
+ type ComponentContent = Blok;
56
+ /**
57
+ * Generic component content structure that can be extended for specific component types. Supports deeply nested components in arrays and objects. Additional fields can be strings, numbers, booleans, objects, or arrays.
58
+ */
59
+ type Blok = {
60
+ /**
61
+ * Unique identifier for the content
62
+ */
63
+ _uid: string;
64
+ /**
65
+ * The story type's technical name (e.g., 'page', 'teaser', 'grid', 'feature', etc.)
66
+ */
67
+ component: string;
68
+ /**
69
+ * Storyblok editor markup for inline editing
70
+ */
71
+ _editable?: string;
72
+ [key: string]: (string | number | boolean | Array<Blok>) | string | undefined;
73
+ };
55
74
  /**
56
75
  * A Storyblok story object representing a content entry
57
76
  */
@@ -134,19 +153,9 @@ type Story2 = {
134
153
  */
135
154
  is_folder?: boolean;
136
155
  /**
137
- * An object containing the field data associated with the specific story type's specific content structure. Also includes a component property with the story type's technical name.
156
+ * An object containing the field data associated with the specific story type's specific content structure. Can contain deeply nested components in arrays and objects. Also includes a component property with the story type's technical name.
138
157
  */
139
- content?: {
140
- /**
141
- * Unique identifier for the content
142
- */
143
- _uid?: string;
144
- /**
145
- * The story type's technical name
146
- */
147
- component?: string;
148
- [key: string]: unknown | string | undefined;
149
- };
158
+ content?: Blok;
150
159
  /**
151
160
  * true if a story is currently published, even if it has unpublished changes
152
161
  */
@@ -403,7 +412,7 @@ type StoryUpdateRequest2 = {
403
412
  /**
404
413
  * If this is 1, the request can overwrite a locked story. Note that a user currently editing the story (which is why it was locked) will encounter a content conflict model. Importantly, note that force_update does not work when editing is locked for the workflow stage that the story currently is in
405
414
  */
406
- force_update?: 0 | 1;
415
+ force_update?: '0' | '1';
407
416
  /**
408
417
  * Numeric ID of release (optional)
409
418
  */
@@ -452,6 +461,10 @@ type StoryVersion2 = {
452
461
  * The ID of the Storyblok space (can be integer or string)
453
462
  */
454
463
  type SpaceId = number | string;
464
+ /**
465
+ * Page number for pagination. Default is 1.
466
+ */
467
+ type Page = number;
455
468
  /**
456
469
  * The ID of the story (can be integer or string)
457
470
  */
@@ -466,11 +479,11 @@ type ListData = {
466
479
  };
467
480
  query?: {
468
481
  /**
469
- * Current page of stories
482
+ * Page number for pagination. Default is 1.
470
483
  */
471
484
  page?: number;
472
485
  /**
473
- * The number of stories to return
486
+ * Number of stories per page. Default is 25, maximum is 100.
474
487
  */
475
488
  per_page?: number;
476
489
  /**
@@ -1400,5 +1413,5 @@ type ClientOptions = {
1400
1413
  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});
1401
1414
  };
1402
1415
  //#endregion
1403
- export { ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses, types_gen_d_exports };
1416
+ export { Blok, ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, ComponentContent, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses, types_gen_d_exports };
1404
1417
  //# sourceMappingURL=types.gen.d.mts.map
@@ -1,5 +1,5 @@
1
1
  declare namespace types_gen_d_exports {
2
- export { ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses };
2
+ export { Blok, ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, ComponentContent, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses };
3
3
  }
4
4
  type Story = Story2;
5
5
  type StoryCreateRequest = StoryCreateRequest2;
@@ -52,6 +52,25 @@ type StoryVersionComparison = {
52
52
  };
53
53
  };
54
54
  type UnpublishedStory = Story2;
55
+ type ComponentContent = Blok;
56
+ /**
57
+ * Generic component content structure that can be extended for specific component types. Supports deeply nested components in arrays and objects. Additional fields can be strings, numbers, booleans, objects, or arrays.
58
+ */
59
+ type Blok = {
60
+ /**
61
+ * Unique identifier for the content
62
+ */
63
+ _uid: string;
64
+ /**
65
+ * The story type's technical name (e.g., 'page', 'teaser', 'grid', 'feature', etc.)
66
+ */
67
+ component: string;
68
+ /**
69
+ * Storyblok editor markup for inline editing
70
+ */
71
+ _editable?: string;
72
+ [key: string]: (string | number | boolean | Array<Blok>) | string | undefined;
73
+ };
55
74
  /**
56
75
  * A Storyblok story object representing a content entry
57
76
  */
@@ -134,19 +153,9 @@ type Story2 = {
134
153
  */
135
154
  is_folder?: boolean;
136
155
  /**
137
- * An object containing the field data associated with the specific story type's specific content structure. Also includes a component property with the story type's technical name.
156
+ * An object containing the field data associated with the specific story type's specific content structure. Can contain deeply nested components in arrays and objects. Also includes a component property with the story type's technical name.
138
157
  */
139
- content?: {
140
- /**
141
- * Unique identifier for the content
142
- */
143
- _uid?: string;
144
- /**
145
- * The story type's technical name
146
- */
147
- component?: string;
148
- [key: string]: unknown | string | undefined;
149
- };
158
+ content?: Blok;
150
159
  /**
151
160
  * true if a story is currently published, even if it has unpublished changes
152
161
  */
@@ -403,7 +412,7 @@ type StoryUpdateRequest2 = {
403
412
  /**
404
413
  * If this is 1, the request can overwrite a locked story. Note that a user currently editing the story (which is why it was locked) will encounter a content conflict model. Importantly, note that force_update does not work when editing is locked for the workflow stage that the story currently is in
405
414
  */
406
- force_update?: 0 | 1;
415
+ force_update?: '0' | '1';
407
416
  /**
408
417
  * Numeric ID of release (optional)
409
418
  */
@@ -452,6 +461,10 @@ type StoryVersion2 = {
452
461
  * The ID of the Storyblok space (can be integer or string)
453
462
  */
454
463
  type SpaceId = number | string;
464
+ /**
465
+ * Page number for pagination. Default is 1.
466
+ */
467
+ type Page = number;
455
468
  /**
456
469
  * The ID of the story (can be integer or string)
457
470
  */
@@ -466,11 +479,11 @@ type ListData = {
466
479
  };
467
480
  query?: {
468
481
  /**
469
- * Current page of stories
482
+ * Page number for pagination. Default is 1.
470
483
  */
471
484
  page?: number;
472
485
  /**
473
- * The number of stories to return
486
+ * Number of stories per page. Default is 25, maximum is 100.
474
487
  */
475
488
  per_page?: number;
476
489
  /**
@@ -1400,5 +1413,5 @@ type ClientOptions = {
1400
1413
  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});
1401
1414
  };
1402
1415
  //#endregion
1403
- export { ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses, types_gen_d_exports };
1416
+ export { Blok, ClientOptions, CompareVersionsData, CompareVersionsErrors, CompareVersionsResponse, CompareVersionsResponses, ComponentContent, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, DuplicateData, DuplicateErrors, DuplicateResponse, DuplicateResponses, ExportData, ExportErrors, ExportResponse, ExportResponses, GetData, GetErrors, GetResponse, GetResponses, GetUnpublishedDependenciesData, GetUnpublishedDependenciesErrors, GetUnpublishedDependenciesResponse, GetUnpublishedDependenciesResponses, ImportData, ImportErrors, ImportResponse, ImportResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PublishData, PublishErrors, PublishResponse, PublishResponses, RestoreVersionsData, RestoreVersionsErrors, RestoreVersionsResponse, RestoreVersionsResponses, SpaceId, Story, Story2, StoryCreateRequest, StoryCreateRequest2, StoryDuplicateRequest, StoryId, StoryUpdateRequest, StoryUpdateRequest2, StoryVersion, StoryVersion2, StoryVersionComparison, TranslateData, TranslateErrors, TranslateResponse, TranslateResponses, UnpublishData, UnpublishErrors, UnpublishResponse, UnpublishResponses, UnpublishedStory, UpdateStoryData, UpdateStoryErrors, UpdateStoryResponse, UpdateStoryResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses, types_gen_d_exports };
1404
1417
  //# sourceMappingURL=types.gen.d.ts.map