@storyblok/management-api-client 0.3.0 → 1.0.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/client.cjs +190 -0
- package/dist/client.cjs.map +1 -0
- package/dist/client.d.cts +632 -0
- package/dist/client.d.mts +632 -0
- package/dist/client.mjs +189 -0
- package/dist/client.mjs.map +1 -0
- package/dist/error.cjs.map +1 -1
- package/dist/error.d.cts +12 -2
- package/dist/error.d.mts +12 -2
- package/dist/error.mjs.map +1 -1
- package/dist/generated/mapi/_internal.gen.d.cts +541 -0
- package/dist/generated/mapi/_internal.gen.d.mts +541 -0
- package/dist/generated/{shared → mapi}/client/client.gen.cjs +1 -1
- package/dist/generated/mapi/client/client.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/client.gen.mjs +1 -1
- package/dist/generated/mapi/client/client.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/types.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/client/types.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.cjs +1 -1
- package/dist/generated/mapi/client/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/client/utils.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/client/utils.gen.mjs +1 -1
- package/dist/generated/mapi/client/utils.gen.mjs.map +1 -0
- package/dist/generated/mapi/client.gen.cjs +10 -0
- package/dist/generated/mapi/client.gen.cjs.map +1 -0
- package/dist/generated/mapi/client.gen.mjs +10 -0
- package/dist/generated/mapi/client.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/auth.gen.cjs +1 -1
- package/dist/generated/mapi/core/auth.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/auth.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/auth.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/auth.gen.mjs +1 -1
- package/dist/generated/mapi/core/auth.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.cjs +1 -1
- package/dist/generated/mapi/core/bodySerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/bodySerializer.gen.mjs +1 -1
- package/dist/generated/mapi/core/bodySerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/params.gen.cjs +1 -1
- package/dist/generated/mapi/core/params.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/params.gen.mjs +1 -1
- package/dist/generated/mapi/core/params.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.cjs +1 -1
- package/dist/generated/mapi/core/pathSerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/pathSerializer.gen.mjs +1 -1
- package/dist/generated/mapi/core/pathSerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.cjs +1 -1
- package/dist/generated/mapi/core/serverSentEvents.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/serverSentEvents.gen.mjs +1 -1
- package/dist/generated/mapi/core/serverSentEvents.gen.mjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/types.gen.d.cts +1 -1
- package/dist/generated/{shared → mapi}/core/types.gen.d.mts +1 -1
- package/dist/generated/{shared → mapi}/core/utils.gen.cjs +1 -1
- package/dist/generated/mapi/core/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → mapi}/core/utils.gen.mjs +1 -1
- package/dist/generated/mapi/core/utils.gen.mjs.map +1 -0
- package/dist/generated/mapi/sdk.gen.cjs +1477 -0
- package/dist/generated/mapi/sdk.gen.cjs.map +1 -0
- package/dist/generated/mapi/sdk.gen.mjs +1399 -0
- package/dist/generated/mapi/sdk.gen.mjs.map +1 -0
- package/dist/generated/mapi/types-aliased.gen.d.cts +1428 -0
- package/dist/generated/mapi/types-aliased.gen.d.mts +1428 -0
- package/dist/generated/mapi/types.gen.d.cts +5075 -0
- package/dist/generated/mapi/types.gen.d.mts +5075 -0
- package/dist/generated/overlay/_internal.gen.d.cts +850 -0
- package/dist/generated/overlay/_internal.gen.d.mts +850 -0
- package/dist/generated/types/_utils.d.cts +7 -0
- package/dist/generated/types/_utils.d.mts +7 -0
- package/dist/generated/types/block.d.cts +30 -0
- package/dist/generated/types/block.d.mts +30 -0
- package/dist/generated/types/field.d.cts +75 -0
- package/dist/generated/types/field.d.mts +75 -0
- package/dist/generated/types/mapi-story.d.cts +29 -0
- package/dist/generated/types/mapi-story.d.mts +29 -0
- package/dist/index.cjs +3 -173
- package/dist/index.d.cts +13 -433
- package/dist/index.d.mts +13 -433
- package/dist/index.mjs +2 -171
- package/dist/resources/asset-folders.cjs +9 -9
- package/dist/resources/asset-folders.cjs.map +1 -1
- package/dist/resources/asset-folders.mjs +9 -9
- package/dist/resources/asset-folders.mjs.map +1 -1
- package/dist/resources/assets.cjs +57 -48
- package/dist/resources/assets.cjs.map +1 -1
- package/dist/resources/assets.d.cts +23 -27
- package/dist/resources/assets.d.mts +23 -27
- package/dist/resources/assets.mjs +57 -48
- package/dist/resources/assets.mjs.map +1 -1
- package/dist/resources/component-folders.cjs +9 -9
- package/dist/resources/component-folders.cjs.map +1 -1
- package/dist/resources/component-folders.mjs +9 -9
- package/dist/resources/component-folders.mjs.map +1 -1
- package/dist/resources/components.cjs +28 -20
- package/dist/resources/components.cjs.map +1 -1
- package/dist/resources/components.d.cts +76 -0
- package/dist/resources/components.d.mts +76 -0
- package/dist/resources/components.mjs +28 -20
- package/dist/resources/components.mjs.map +1 -1
- package/dist/resources/datasource-entries.cjs +28 -34
- package/dist/resources/datasource-entries.cjs.map +1 -1
- package/dist/resources/datasource-entries.mjs +29 -35
- package/dist/resources/datasource-entries.mjs.map +1 -1
- package/dist/resources/datasources.cjs +27 -9
- package/dist/resources/datasources.cjs.map +1 -1
- package/dist/resources/datasources.mjs +27 -9
- package/dist/resources/datasources.mjs.map +1 -1
- package/dist/resources/experiments.cjs +299 -0
- package/dist/resources/experiments.cjs.map +1 -0
- package/dist/resources/experiments.mjs +299 -0
- package/dist/resources/experiments.mjs.map +1 -0
- package/dist/resources/internal-tags.cjs +7 -7
- package/dist/resources/internal-tags.cjs.map +1 -1
- package/dist/resources/internal-tags.mjs +7 -7
- package/dist/resources/internal-tags.mjs.map +1 -1
- package/dist/resources/presets.cjs +9 -9
- package/dist/resources/presets.cjs.map +1 -1
- package/dist/resources/presets.mjs +9 -9
- package/dist/resources/presets.mjs.map +1 -1
- package/dist/resources/shared.cjs +15 -0
- package/dist/resources/shared.cjs.map +1 -1
- package/dist/resources/shared.mjs +15 -1
- package/dist/resources/shared.mjs.map +1 -1
- package/dist/resources/spaces.cjs +8 -7
- package/dist/resources/spaces.cjs.map +1 -1
- package/dist/resources/spaces.d.cts +8 -0
- package/dist/resources/spaces.d.mts +7 -0
- package/dist/resources/spaces.mjs +8 -7
- package/dist/resources/spaces.mjs.map +1 -1
- package/dist/resources/stories.cjs +20 -16
- package/dist/resources/stories.cjs.map +1 -1
- package/dist/resources/stories.d.cts +93 -0
- package/dist/resources/stories.d.mts +93 -0
- package/dist/resources/stories.mjs +20 -16
- package/dist/resources/stories.mjs.map +1 -1
- package/dist/resources/users.cjs +3 -3
- package/dist/resources/users.cjs.map +1 -1
- package/dist/resources/users.mjs +3 -3
- package/dist/resources/users.mjs.map +1 -1
- package/dist/utils/query-serializer.cjs +54 -0
- package/dist/utils/query-serializer.cjs.map +1 -0
- package/dist/utils/query-serializer.mjs +54 -0
- package/dist/utils/query-serializer.mjs.map +1 -0
- package/package.json +16 -14
- package/playground/integration-tests/README.md +24 -0
- package/playground/integration-tests/eslint.config.js +5 -0
- package/playground/integration-tests/node_modules/.bin/eslint +16 -0
- package/playground/integration-tests/node_modules/.bin/tsc +16 -0
- package/playground/integration-tests/node_modules/.bin/tsserver +16 -0
- package/playground/integration-tests/node_modules/.bin/vitest +16 -0
- package/playground/integration-tests/package.json +24 -0
- package/playground/integration-tests/test/setup.e2e.ts +11 -0
- package/playground/integration-tests/test/specs/mapi-round-trip.spec.e2e.ts +520 -0
- package/playground/integration-tests/test/types/components.test-d.ts +113 -0
- package/playground/integration-tests/test/types/resources.test-d.ts +364 -0
- package/playground/integration-tests/test/types/stories.test-d.ts +306 -0
- package/playground/integration-tests/vitest.config.e2e.ts +25 -0
- package/playground/integration-tests/vitest.config.ts +13 -0
- package/test/GUIDE.md +59 -0
- package/vitest.config.ts +5 -0
- package/dist/generated/asset_folders/client.gen.cjs +0 -10
- package/dist/generated/asset_folders/client.gen.cjs.map +0 -1
- package/dist/generated/asset_folders/client.gen.mjs +0 -10
- package/dist/generated/asset_folders/client.gen.mjs.map +0 -1
- package/dist/generated/asset_folders/sdk.gen.cjs +0 -99
- package/dist/generated/asset_folders/sdk.gen.cjs.map +0 -1
- package/dist/generated/asset_folders/sdk.gen.mjs +0 -95
- package/dist/generated/asset_folders/sdk.gen.mjs.map +0 -1
- package/dist/generated/asset_folders/types.gen.d.cts +0 -156
- package/dist/generated/asset_folders/types.gen.d.mts +0 -156
- package/dist/generated/assets/client.gen.cjs +0 -10
- package/dist/generated/assets/client.gen.cjs.map +0 -1
- package/dist/generated/assets/client.gen.mjs +0 -10
- package/dist/generated/assets/client.gen.mjs.map +0 -1
- package/dist/generated/assets/sdk.gen.cjs +0 -179
- package/dist/generated/assets/sdk.gen.cjs.map +0 -1
- package/dist/generated/assets/sdk.gen.mjs +0 -171
- package/dist/generated/assets/sdk.gen.mjs.map +0 -1
- package/dist/generated/assets/types.gen.d.cts +0 -415
- package/dist/generated/assets/types.gen.d.mts +0 -415
- package/dist/generated/component_folders/client.gen.cjs +0 -10
- package/dist/generated/component_folders/client.gen.cjs.map +0 -1
- package/dist/generated/component_folders/client.gen.mjs +0 -10
- package/dist/generated/component_folders/client.gen.mjs.map +0 -1
- package/dist/generated/component_folders/sdk.gen.cjs +0 -99
- package/dist/generated/component_folders/sdk.gen.cjs.map +0 -1
- package/dist/generated/component_folders/sdk.gen.mjs +0 -95
- package/dist/generated/component_folders/sdk.gen.mjs.map +0 -1
- package/dist/generated/component_folders/types.gen.d.cts +0 -118
- package/dist/generated/component_folders/types.gen.d.mts +0 -118
- package/dist/generated/components/client.gen.cjs +0 -10
- package/dist/generated/components/client.gen.cjs.map +0 -1
- package/dist/generated/components/client.gen.mjs +0 -10
- package/dist/generated/components/client.gen.mjs.map +0 -1
- package/dist/generated/components/sdk.gen.cjs +0 -171
- package/dist/generated/components/sdk.gen.cjs.map +0 -1
- package/dist/generated/components/sdk.gen.mjs +0 -163
- package/dist/generated/components/sdk.gen.mjs.map +0 -1
- package/dist/generated/components/types.gen.d.cts +0 -855
- package/dist/generated/components/types.gen.d.mts +0 -855
- package/dist/generated/datasource_entries/client.gen.cjs +0 -10
- package/dist/generated/datasource_entries/client.gen.cjs.map +0 -1
- package/dist/generated/datasource_entries/client.gen.mjs +0 -10
- package/dist/generated/datasource_entries/client.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/sdk.gen.cjs +0 -89
- package/dist/generated/datasource_entries/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasource_entries/sdk.gen.mjs +0 -85
- package/dist/generated/datasource_entries/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/types.gen.d.cts +0 -156
- package/dist/generated/datasource_entries/types.gen.d.mts +0 -156
- package/dist/generated/datasources/client.gen.cjs +0 -10
- package/dist/generated/datasources/client.gen.cjs.map +0 -1
- package/dist/generated/datasources/client.gen.mjs +0 -10
- package/dist/generated/datasources/client.gen.mjs.map +0 -1
- package/dist/generated/datasources/sdk.gen.cjs +0 -89
- package/dist/generated/datasources/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasources/sdk.gen.mjs +0 -85
- package/dist/generated/datasources/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasources/types.gen.d.cts +0 -186
- package/dist/generated/datasources/types.gen.d.mts +0 -186
- package/dist/generated/internal_tags/client.gen.cjs +0 -10
- package/dist/generated/internal_tags/client.gen.cjs.map +0 -1
- package/dist/generated/internal_tags/client.gen.mjs +0 -10
- package/dist/generated/internal_tags/client.gen.mjs.map +0 -1
- package/dist/generated/internal_tags/sdk.gen.cjs +0 -74
- package/dist/generated/internal_tags/sdk.gen.cjs.map +0 -1
- package/dist/generated/internal_tags/sdk.gen.mjs +0 -71
- package/dist/generated/internal_tags/sdk.gen.mjs.map +0 -1
- package/dist/generated/internal_tags/types.gen.d.cts +0 -106
- package/dist/generated/internal_tags/types.gen.d.mts +0 -106
- package/dist/generated/presets/client.gen.cjs +0 -10
- package/dist/generated/presets/client.gen.cjs.map +0 -1
- package/dist/generated/presets/client.gen.mjs +0 -10
- package/dist/generated/presets/client.gen.mjs.map +0 -1
- package/dist/generated/presets/sdk.gen.cjs +0 -99
- package/dist/generated/presets/sdk.gen.cjs.map +0 -1
- package/dist/generated/presets/sdk.gen.mjs +0 -95
- package/dist/generated/presets/sdk.gen.mjs.map +0 -1
- package/dist/generated/presets/types.gen.d.cts +0 -176
- package/dist/generated/presets/types.gen.d.mts +0 -176
- package/dist/generated/shared/client/client.gen.cjs.map +0 -1
- package/dist/generated/shared/client/client.gen.mjs.map +0 -1
- package/dist/generated/shared/client/utils.gen.cjs.map +0 -1
- package/dist/generated/shared/client/utils.gen.mjs.map +0 -1
- package/dist/generated/shared/core/auth.gen.cjs.map +0 -1
- package/dist/generated/shared/core/auth.gen.mjs.map +0 -1
- package/dist/generated/shared/core/bodySerializer.gen.cjs.map +0 -1
- package/dist/generated/shared/core/bodySerializer.gen.mjs.map +0 -1
- package/dist/generated/shared/core/params.gen.cjs.map +0 -1
- package/dist/generated/shared/core/params.gen.mjs.map +0 -1
- package/dist/generated/shared/core/pathSerializer.gen.cjs.map +0 -1
- package/dist/generated/shared/core/pathSerializer.gen.mjs.map +0 -1
- package/dist/generated/shared/core/serverSentEvents.gen.cjs.map +0 -1
- package/dist/generated/shared/core/serverSentEvents.gen.mjs.map +0 -1
- package/dist/generated/shared/core/utils.gen.cjs.map +0 -1
- package/dist/generated/shared/core/utils.gen.mjs.map +0 -1
- package/dist/generated/spaces/client.gen.cjs +0 -10
- package/dist/generated/spaces/client.gen.cjs.map +0 -1
- package/dist/generated/spaces/client.gen.mjs +0 -10
- package/dist/generated/spaces/client.gen.mjs.map +0 -1
- package/dist/generated/spaces/sdk.gen.cjs +0 -99
- package/dist/generated/spaces/sdk.gen.cjs.map +0 -1
- package/dist/generated/spaces/sdk.gen.mjs +0 -95
- package/dist/generated/spaces/sdk.gen.mjs.map +0 -1
- package/dist/generated/spaces/types.gen.d.cts +0 -544
- package/dist/generated/spaces/types.gen.d.mts +0 -544
- package/dist/generated/stories/client.gen.cjs +0 -10
- package/dist/generated/stories/client.gen.cjs.map +0 -1
- package/dist/generated/stories/client.gen.mjs +0 -10
- package/dist/generated/stories/client.gen.mjs.map +0 -1
- package/dist/generated/stories/sdk.gen.cjs +0 -138
- package/dist/generated/stories/sdk.gen.cjs.map +0 -1
- package/dist/generated/stories/sdk.gen.mjs +0 -131
- package/dist/generated/stories/sdk.gen.mjs.map +0 -1
- package/dist/generated/stories/types.gen.d.cts +0 -1306
- package/dist/generated/stories/types.gen.d.mts +0 -1306
- package/dist/generated/users/client.gen.cjs +0 -10
- package/dist/generated/users/client.gen.cjs.map +0 -1
- package/dist/generated/users/client.gen.mjs +0 -10
- package/dist/generated/users/client.gen.mjs.map +0 -1
- package/dist/generated/users/sdk.gen.cjs +0 -44
- package/dist/generated/users/sdk.gen.cjs.map +0 -1
- package/dist/generated/users/sdk.gen.mjs +0 -43
- package/dist/generated/users/sdk.gen.mjs.map +0 -1
- package/dist/generated/users/types.gen.d.cts +0 -348
- package/dist/generated/users/types.gen.d.mts +0 -348
- package/dist/index.cjs.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/types.d.cts +0 -130
- package/dist/types.d.mts +0 -130
- /package/dist/generated/{shared → mapi}/client/client.gen.d.mts +0 -0
- /package/dist/generated/{shared → mapi}/client/index.cjs +0 -0
- /package/dist/generated/{shared → mapi}/client/index.d.mts +0 -0
- /package/dist/generated/{shared → mapi}/client/index.mjs +0 -0
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.gen.cjs","names":["client"],"sources":["../../../src/generated/spaces/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Client, Options as Options2, TDataShape } from '../shared/client';\nimport { client } from './client.gen';\nimport type { CreateData, CreateErrors, CreateResponses, DeleteData, DeleteErrors, DeleteResponses, GetData, GetErrors, GetResponses, ListData, ListErrors, ListResponses, UpdateData, UpdateErrors, UpdateResponses } from './types.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {\n /**\n * You can provide a client instance returned by `createClient()` instead of\n * individual options. This might be also useful if you want to implement a\n * custom client.\n */\n client?: Client;\n /**\n * You can pass arbitrary values through the `meta` object. This can be\n * used to access values that aren't defined as part of the SDK function.\n */\n meta?: Record<string, unknown>;\n};\n\n/**\n * Retrieve Multiple Spaces\n *\n * Returns an array of space objects.\n */\nexport const list = <ThrowOnError extends boolean = false>(options?: Options<ListData, ThrowOnError>) => (options?.client ?? client).get<ListResponses, ListErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces',\n ...options\n});\n\n/**\n * Create a Space\n *\n * This endpoint creates a new space. To duplicate an existing space, include the dup_id parameter in the request body.\n */\nexport const create = <ThrowOnError extends boolean = false>(options: Options<CreateData, ThrowOnError>) => (options.client ?? client).post<CreateResponses, CreateErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces',\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options.headers\n }\n});\n\n/**\n * Delete a Space\n *\n * Delete a space by its numeric id.\n */\nexport const delete_ = <ThrowOnError extends boolean = false>(options: Options<DeleteData, ThrowOnError>) => (options.client ?? client).delete<DeleteResponses, DeleteErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options\n});\n\n/**\n * Retrieve a Single Space\n *\n * Returns a single space object by providing a specific numeric id.\n */\nexport const get = <ThrowOnError extends boolean = false>(options: Options<GetData, ThrowOnError>) => (options.client ?? client).get<GetResponses, GetErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options\n});\n\n/**\n * Update a Space\n *\n * Update a space using the numeric ID. You can only able to update the properties mentioned here.\n */\nexport const update = <ThrowOnError extends boolean = false>(options: Options<UpdateData, ThrowOnError>) => (options.client ?? client).put<UpdateResponses, UpdateErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options.headers\n }\n});\n"],"mappings":";;;;;;;;AAyBA,MAAa,QAA8C,aAA+C,SAAS,UAAUA,2BAAQ,IAA6C;CAC9K,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAUA,2BAAQ,KAAkD;CACrL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC;;;;;;AAOF,MAAa,WAAiD,aAAgD,QAAQ,UAAUA,2BAAQ,OAAoD;CACxL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,OAA6C,aAA6C,QAAQ,UAAUA,2BAAQ,IAA2C;CACxK,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAUA,2BAAQ,IAAiD;CACpL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC"}
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
import { client } from "./client.gen.mjs";
|
|
2
|
-
|
|
3
|
-
//#region src/generated/spaces/sdk.gen.ts
|
|
4
|
-
/**
|
|
5
|
-
* Retrieve Multiple Spaces
|
|
6
|
-
*
|
|
7
|
-
* Returns an array of space objects.
|
|
8
|
-
*/
|
|
9
|
-
const list = (options) => (options?.client ?? client).get({
|
|
10
|
-
security: [{
|
|
11
|
-
name: "Authorization",
|
|
12
|
-
type: "apiKey"
|
|
13
|
-
}, {
|
|
14
|
-
scheme: "bearer",
|
|
15
|
-
type: "http"
|
|
16
|
-
}],
|
|
17
|
-
url: "/v1/spaces",
|
|
18
|
-
...options
|
|
19
|
-
});
|
|
20
|
-
/**
|
|
21
|
-
* Create a Space
|
|
22
|
-
*
|
|
23
|
-
* This endpoint creates a new space. To duplicate an existing space, include the dup_id parameter in the request body.
|
|
24
|
-
*/
|
|
25
|
-
const create = (options) => (options.client ?? client).post({
|
|
26
|
-
security: [{
|
|
27
|
-
name: "Authorization",
|
|
28
|
-
type: "apiKey"
|
|
29
|
-
}, {
|
|
30
|
-
scheme: "bearer",
|
|
31
|
-
type: "http"
|
|
32
|
-
}],
|
|
33
|
-
url: "/v1/spaces",
|
|
34
|
-
...options,
|
|
35
|
-
headers: {
|
|
36
|
-
"Content-Type": "application/json",
|
|
37
|
-
...options.headers
|
|
38
|
-
}
|
|
39
|
-
});
|
|
40
|
-
/**
|
|
41
|
-
* Delete a Space
|
|
42
|
-
*
|
|
43
|
-
* Delete a space by its numeric id.
|
|
44
|
-
*/
|
|
45
|
-
const delete_ = (options) => (options.client ?? client).delete({
|
|
46
|
-
security: [{
|
|
47
|
-
name: "Authorization",
|
|
48
|
-
type: "apiKey"
|
|
49
|
-
}, {
|
|
50
|
-
scheme: "bearer",
|
|
51
|
-
type: "http"
|
|
52
|
-
}],
|
|
53
|
-
url: "/v1/spaces/{space_id}",
|
|
54
|
-
...options
|
|
55
|
-
});
|
|
56
|
-
/**
|
|
57
|
-
* Retrieve a Single Space
|
|
58
|
-
*
|
|
59
|
-
* Returns a single space object by providing a specific numeric id.
|
|
60
|
-
*/
|
|
61
|
-
const get = (options) => (options.client ?? client).get({
|
|
62
|
-
security: [{
|
|
63
|
-
name: "Authorization",
|
|
64
|
-
type: "apiKey"
|
|
65
|
-
}, {
|
|
66
|
-
scheme: "bearer",
|
|
67
|
-
type: "http"
|
|
68
|
-
}],
|
|
69
|
-
url: "/v1/spaces/{space_id}",
|
|
70
|
-
...options
|
|
71
|
-
});
|
|
72
|
-
/**
|
|
73
|
-
* Update a Space
|
|
74
|
-
*
|
|
75
|
-
* Update a space using the numeric ID. You can only able to update the properties mentioned here.
|
|
76
|
-
*/
|
|
77
|
-
const update = (options) => (options.client ?? client).put({
|
|
78
|
-
security: [{
|
|
79
|
-
name: "Authorization",
|
|
80
|
-
type: "apiKey"
|
|
81
|
-
}, {
|
|
82
|
-
scheme: "bearer",
|
|
83
|
-
type: "http"
|
|
84
|
-
}],
|
|
85
|
-
url: "/v1/spaces/{space_id}",
|
|
86
|
-
...options,
|
|
87
|
-
headers: {
|
|
88
|
-
"Content-Type": "application/json",
|
|
89
|
-
...options.headers
|
|
90
|
-
}
|
|
91
|
-
});
|
|
92
|
-
|
|
93
|
-
//#endregion
|
|
94
|
-
export { create, delete_, get, list, update };
|
|
95
|
-
//# sourceMappingURL=sdk.gen.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.gen.mjs","names":[],"sources":["../../../src/generated/spaces/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Client, Options as Options2, TDataShape } from '../shared/client';\nimport { client } from './client.gen';\nimport type { CreateData, CreateErrors, CreateResponses, DeleteData, DeleteErrors, DeleteResponses, GetData, GetErrors, GetResponses, ListData, ListErrors, ListResponses, UpdateData, UpdateErrors, UpdateResponses } from './types.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {\n /**\n * You can provide a client instance returned by `createClient()` instead of\n * individual options. This might be also useful if you want to implement a\n * custom client.\n */\n client?: Client;\n /**\n * You can pass arbitrary values through the `meta` object. This can be\n * used to access values that aren't defined as part of the SDK function.\n */\n meta?: Record<string, unknown>;\n};\n\n/**\n * Retrieve Multiple Spaces\n *\n * Returns an array of space objects.\n */\nexport const list = <ThrowOnError extends boolean = false>(options?: Options<ListData, ThrowOnError>) => (options?.client ?? client).get<ListResponses, ListErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces',\n ...options\n});\n\n/**\n * Create a Space\n *\n * This endpoint creates a new space. To duplicate an existing space, include the dup_id parameter in the request body.\n */\nexport const create = <ThrowOnError extends boolean = false>(options: Options<CreateData, ThrowOnError>) => (options.client ?? client).post<CreateResponses, CreateErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces',\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options.headers\n }\n});\n\n/**\n * Delete a Space\n *\n * Delete a space by its numeric id.\n */\nexport const delete_ = <ThrowOnError extends boolean = false>(options: Options<DeleteData, ThrowOnError>) => (options.client ?? client).delete<DeleteResponses, DeleteErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options\n});\n\n/**\n * Retrieve a Single Space\n *\n * Returns a single space object by providing a specific numeric id.\n */\nexport const get = <ThrowOnError extends boolean = false>(options: Options<GetData, ThrowOnError>) => (options.client ?? client).get<GetResponses, GetErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options\n});\n\n/**\n * Update a Space\n *\n * Update a space using the numeric ID. You can only able to update the properties mentioned here.\n */\nexport const update = <ThrowOnError extends boolean = false>(options: Options<UpdateData, ThrowOnError>) => (options.client ?? client).put<UpdateResponses, UpdateErrors, ThrowOnError>({\n security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n url: '/v1/spaces/{space_id}',\n ...options,\n headers: {\n 'Content-Type': 'application/json',\n ...options.headers\n }\n});\n"],"mappings":";;;;;;;;AAyBA,MAAa,QAA8C,aAA+C,SAAS,UAAU,QAAQ,IAA6C;CAC9K,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAU,QAAQ,KAAkD;CACrL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC;;;;;;AAOF,MAAa,WAAiD,aAAgD,QAAQ,UAAU,QAAQ,OAAoD;CACxL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,OAA6C,aAA6C,QAAQ,UAAU,QAAQ,IAA2C;CACxK,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAU,QAAQ,IAAiD;CACpL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC"}
|
|
@@ -1,544 +0,0 @@
|
|
|
1
|
-
//#region src/generated/spaces/types.gen.d.ts
|
|
2
|
-
/**
|
|
3
|
-
* The Space Object
|
|
4
|
-
*/
|
|
5
|
-
type Space = {
|
|
6
|
-
/**
|
|
7
|
-
* Name of the Space
|
|
8
|
-
*/
|
|
9
|
-
name?: string;
|
|
10
|
-
/**
|
|
11
|
-
* Domain for your default preview url
|
|
12
|
-
*/
|
|
13
|
-
domain?: string;
|
|
14
|
-
/**
|
|
15
|
-
* Unique Domain for the Storyblok Rendering Service
|
|
16
|
-
*/
|
|
17
|
-
uniq_domain?: string;
|
|
18
|
-
/**
|
|
19
|
-
* Space Plan
|
|
20
|
-
*/
|
|
21
|
-
plan?: string;
|
|
22
|
-
/**
|
|
23
|
-
* Plan Level of Space
|
|
24
|
-
*/
|
|
25
|
-
plan_level?: number;
|
|
26
|
-
/**
|
|
27
|
-
* Creation date
|
|
28
|
-
*/
|
|
29
|
-
created_at?: string;
|
|
30
|
-
/**
|
|
31
|
-
* ID of the space
|
|
32
|
-
*/
|
|
33
|
-
readonly id: number;
|
|
34
|
-
/**
|
|
35
|
-
* Role of the collaborator, could be admin, editor or custom roles
|
|
36
|
-
*/
|
|
37
|
-
role?: string;
|
|
38
|
-
/**
|
|
39
|
-
* Numeric user id of the owner for that space
|
|
40
|
-
*/
|
|
41
|
-
owner_id?: number;
|
|
42
|
-
/**
|
|
43
|
-
* Published Webhook URL
|
|
44
|
-
*/
|
|
45
|
-
story_published_hook?: string;
|
|
46
|
-
/**
|
|
47
|
-
* Array of name, location (url) objects
|
|
48
|
-
*/
|
|
49
|
-
environments?: Array<{
|
|
50
|
-
/**
|
|
51
|
-
* Environment name
|
|
52
|
-
*/
|
|
53
|
-
name?: string;
|
|
54
|
-
/**
|
|
55
|
-
* Environment URL
|
|
56
|
-
*/
|
|
57
|
-
location?: string;
|
|
58
|
-
}>;
|
|
59
|
-
/**
|
|
60
|
-
* Number of Stories in the Space
|
|
61
|
-
*/
|
|
62
|
-
stories_count?: number;
|
|
63
|
-
/**
|
|
64
|
-
* Space id of a possible parent space
|
|
65
|
-
*/
|
|
66
|
-
parent_id?: number;
|
|
67
|
-
/**
|
|
68
|
-
* Number of Assets in the Space
|
|
69
|
-
*/
|
|
70
|
-
assets_count?: number;
|
|
71
|
-
/**
|
|
72
|
-
* Searchblok id, if available
|
|
73
|
-
*/
|
|
74
|
-
searchblok_id?: number;
|
|
75
|
-
/**
|
|
76
|
-
* Is the space globally duplicatable by all users
|
|
77
|
-
*/
|
|
78
|
-
duplicatable?: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* Request Count of the day
|
|
81
|
-
*/
|
|
82
|
-
request_count_today?: number;
|
|
83
|
-
/**
|
|
84
|
-
* Number of Exceeded Requests
|
|
85
|
-
*/
|
|
86
|
-
exceeded_requests?: number;
|
|
87
|
-
/**
|
|
88
|
-
* Routes for the Storyblok Rendering Service
|
|
89
|
-
*/
|
|
90
|
-
routes?: Array<string>;
|
|
91
|
-
/**
|
|
92
|
-
* Is the space in trial mode
|
|
93
|
-
*/
|
|
94
|
-
trial?: boolean;
|
|
95
|
-
/**
|
|
96
|
-
* Component name which will be used as default content type for this folders entries
|
|
97
|
-
*/
|
|
98
|
-
default_root?: string;
|
|
99
|
-
/**
|
|
100
|
-
* Does the space have a slack webhook
|
|
101
|
-
*/
|
|
102
|
-
has_slack_webhook?: boolean;
|
|
103
|
-
/**
|
|
104
|
-
* If the space has pending tasks like backup, deployment etc
|
|
105
|
-
*/
|
|
106
|
-
has_pending_tasks?: boolean;
|
|
107
|
-
/**
|
|
108
|
-
* Legacy (no longer in use). Used to enable or disable AI translations.
|
|
109
|
-
*/
|
|
110
|
-
ai_translation_disabled?: boolean;
|
|
111
|
-
/**
|
|
112
|
-
* The oldest available preview token of the space
|
|
113
|
-
*/
|
|
114
|
-
first_token?: string;
|
|
115
|
-
/**
|
|
116
|
-
* Array of Collaborators of the Space
|
|
117
|
-
*/
|
|
118
|
-
collaborator?: Array<Collaborator>;
|
|
119
|
-
/**
|
|
120
|
-
* Organization object for the space
|
|
121
|
-
*/
|
|
122
|
-
org?: {
|
|
123
|
-
/**
|
|
124
|
-
* Name of the organization
|
|
125
|
-
*/
|
|
126
|
-
name?: string;
|
|
127
|
-
/**
|
|
128
|
-
* Whether AI text generator is disabled in the organization
|
|
129
|
-
*/
|
|
130
|
-
ai_text_generator_disabled_in_org?: boolean;
|
|
131
|
-
/**
|
|
132
|
-
* Custom upload limit in MB for the organization
|
|
133
|
-
*/
|
|
134
|
-
custom_upload_limit_in_mb?: number | null;
|
|
135
|
-
};
|
|
136
|
-
/**
|
|
137
|
-
* Whether the space is in an organization
|
|
138
|
-
*/
|
|
139
|
-
in_org?: boolean;
|
|
140
|
-
/**
|
|
141
|
-
* Whether the space is assigned to a partner
|
|
142
|
-
*/
|
|
143
|
-
assign_partner?: boolean;
|
|
144
|
-
/**
|
|
145
|
-
* Array of language objects available in the space
|
|
146
|
-
*/
|
|
147
|
-
languages?: Array<{
|
|
148
|
-
/**
|
|
149
|
-
* Language code (e.g., 'en', 'de', 'fr')
|
|
150
|
-
*/
|
|
151
|
-
code?: string;
|
|
152
|
-
/**
|
|
153
|
-
* Display name of the language
|
|
154
|
-
*/
|
|
155
|
-
name?: string;
|
|
156
|
-
/**
|
|
157
|
-
* AI translation code for the language, can be null
|
|
158
|
-
*/
|
|
159
|
-
ai_translation_code?: string | null;
|
|
160
|
-
}>;
|
|
161
|
-
/**
|
|
162
|
-
* Default language code for the space
|
|
163
|
-
*/
|
|
164
|
-
default_lang_name?: string;
|
|
165
|
-
};
|
|
166
|
-
/**
|
|
167
|
-
* The Collaborator Object
|
|
168
|
-
*/
|
|
169
|
-
type Collaborator = {
|
|
170
|
-
/**
|
|
171
|
-
* The user object inside a collaborator object
|
|
172
|
-
*/
|
|
173
|
-
user?: {
|
|
174
|
-
/**
|
|
175
|
-
* The user ID
|
|
176
|
-
*/
|
|
177
|
-
id?: number;
|
|
178
|
-
/**
|
|
179
|
-
* First name of collaborator
|
|
180
|
-
*/
|
|
181
|
-
firstname?: string;
|
|
182
|
-
/**
|
|
183
|
-
* Last name of collaborator
|
|
184
|
-
*/
|
|
185
|
-
lastname?: string;
|
|
186
|
-
/**
|
|
187
|
-
* Email of collaborator
|
|
188
|
-
*/
|
|
189
|
-
alt_email?: string;
|
|
190
|
-
/**
|
|
191
|
-
* Avatar of collaborator usually an image
|
|
192
|
-
*/
|
|
193
|
-
avatar?: string;
|
|
194
|
-
/**
|
|
195
|
-
* User ID of collaborator
|
|
196
|
-
*/
|
|
197
|
-
userid?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Friendly name of collaborator
|
|
200
|
-
*/
|
|
201
|
-
friendly_name?: string;
|
|
202
|
-
};
|
|
203
|
-
/**
|
|
204
|
-
* Role of the collaborator, could be admin, editor or custom roles
|
|
205
|
-
*/
|
|
206
|
-
role?: string;
|
|
207
|
-
/**
|
|
208
|
-
* Numeric ID of the user
|
|
209
|
-
*/
|
|
210
|
-
user_id?: number;
|
|
211
|
-
/**
|
|
212
|
-
* Allow specific actions for collaborator in interface and add the permission as array of strings
|
|
213
|
-
*/
|
|
214
|
-
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'>;
|
|
215
|
-
/**
|
|
216
|
-
* 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.
|
|
217
|
-
*/
|
|
218
|
-
allowed_paths?: Array<number>;
|
|
219
|
-
/**
|
|
220
|
-
* Hide specific fields for this user with an array of strings with the schema
|
|
221
|
-
*/
|
|
222
|
-
field_permissions?: Array<string>;
|
|
223
|
-
/**
|
|
224
|
-
* Numeric id of collaborator
|
|
225
|
-
*/
|
|
226
|
-
id?: number;
|
|
227
|
-
/**
|
|
228
|
-
* Numeric ID of the space role
|
|
229
|
-
*/
|
|
230
|
-
space_role_id?: number;
|
|
231
|
-
/**
|
|
232
|
-
* Array of space role ids
|
|
233
|
-
*/
|
|
234
|
-
space_role_ids?: Array<number>;
|
|
235
|
-
/**
|
|
236
|
-
* Numeric id of the collaborator space
|
|
237
|
-
*/
|
|
238
|
-
space_id?: number;
|
|
239
|
-
};
|
|
240
|
-
/**
|
|
241
|
-
* Input for creating a space
|
|
242
|
-
*/
|
|
243
|
-
type SpaceCreate = {
|
|
244
|
-
/**
|
|
245
|
-
* Name of the Space
|
|
246
|
-
*/
|
|
247
|
-
name: string;
|
|
248
|
-
/**
|
|
249
|
-
* Domain for your default preview url
|
|
250
|
-
*/
|
|
251
|
-
domain?: string;
|
|
252
|
-
/**
|
|
253
|
-
* Published Webhook URL
|
|
254
|
-
*/
|
|
255
|
-
story_published_hook?: string;
|
|
256
|
-
/**
|
|
257
|
-
* Array of name, location (url) objects
|
|
258
|
-
*/
|
|
259
|
-
environments?: Array<{
|
|
260
|
-
/**
|
|
261
|
-
* Environment name
|
|
262
|
-
*/
|
|
263
|
-
name?: string;
|
|
264
|
-
/**
|
|
265
|
-
* Environment URL
|
|
266
|
-
*/
|
|
267
|
-
location?: string;
|
|
268
|
-
}>;
|
|
269
|
-
/**
|
|
270
|
-
* Searchblok id, if available
|
|
271
|
-
*/
|
|
272
|
-
searchblok_id?: number;
|
|
273
|
-
/**
|
|
274
|
-
* Space id of a possible parent space
|
|
275
|
-
*/
|
|
276
|
-
parent_id?: number;
|
|
277
|
-
/**
|
|
278
|
-
* Whether this is a demo space
|
|
279
|
-
*/
|
|
280
|
-
is_demo?: boolean;
|
|
281
|
-
/**
|
|
282
|
-
* Reference to a blueprint
|
|
283
|
-
*/
|
|
284
|
-
blueprint_reference?: string;
|
|
285
|
-
/**
|
|
286
|
-
* Organization object for the space
|
|
287
|
-
*/
|
|
288
|
-
org?: {
|
|
289
|
-
/**
|
|
290
|
-
* Name of the organization
|
|
291
|
-
*/
|
|
292
|
-
name?: string;
|
|
293
|
-
/**
|
|
294
|
-
* Whether AI text generator is disabled in the organization
|
|
295
|
-
*/
|
|
296
|
-
ai_text_generator_disabled_in_org?: boolean;
|
|
297
|
-
/**
|
|
298
|
-
* Custom upload limit in MB for the organization
|
|
299
|
-
*/
|
|
300
|
-
custom_upload_limit_in_mb?: number | null;
|
|
301
|
-
};
|
|
302
|
-
/**
|
|
303
|
-
* Whether the space is in an organization
|
|
304
|
-
*/
|
|
305
|
-
in_org?: boolean;
|
|
306
|
-
/**
|
|
307
|
-
* Whether the space is assigned to a partner
|
|
308
|
-
*/
|
|
309
|
-
assign_partner?: boolean;
|
|
310
|
-
};
|
|
311
|
-
/**
|
|
312
|
-
* Input for updating a space
|
|
313
|
-
*/
|
|
314
|
-
type SpaceUpdate = {
|
|
315
|
-
/**
|
|
316
|
-
* Name of the Space
|
|
317
|
-
*/
|
|
318
|
-
name?: string;
|
|
319
|
-
/**
|
|
320
|
-
* Domain for your default preview url
|
|
321
|
-
*/
|
|
322
|
-
domain?: string;
|
|
323
|
-
/**
|
|
324
|
-
* Unique Domain for the Storyblok Rendering Service
|
|
325
|
-
*/
|
|
326
|
-
uniq_domain?: string;
|
|
327
|
-
/**
|
|
328
|
-
* Numeric user id of the owner for that space
|
|
329
|
-
*/
|
|
330
|
-
owner_id?: number;
|
|
331
|
-
/**
|
|
332
|
-
* Published Webhook URL
|
|
333
|
-
*/
|
|
334
|
-
story_published_hook?: string;
|
|
335
|
-
/**
|
|
336
|
-
* Array of name, location (url) objects
|
|
337
|
-
*/
|
|
338
|
-
environments?: Array<{
|
|
339
|
-
/**
|
|
340
|
-
* Environment name
|
|
341
|
-
*/
|
|
342
|
-
name?: string;
|
|
343
|
-
/**
|
|
344
|
-
* Environment URL
|
|
345
|
-
*/
|
|
346
|
-
location?: string;
|
|
347
|
-
}>;
|
|
348
|
-
/**
|
|
349
|
-
* Space id of a possible parent space
|
|
350
|
-
*/
|
|
351
|
-
parent_id?: number;
|
|
352
|
-
/**
|
|
353
|
-
* Searchblok id, if available
|
|
354
|
-
*/
|
|
355
|
-
searchblok_id?: number;
|
|
356
|
-
/**
|
|
357
|
-
* Is the space globally duplicatable by all users
|
|
358
|
-
*/
|
|
359
|
-
duplicatable?: boolean;
|
|
360
|
-
/**
|
|
361
|
-
* Billing information used to generate your invoices for this space
|
|
362
|
-
*/
|
|
363
|
-
billing_address?: {
|
|
364
|
-
[key: string]: unknown;
|
|
365
|
-
};
|
|
366
|
-
/**
|
|
367
|
-
* Routes for the Storyblok Rendering Service
|
|
368
|
-
*/
|
|
369
|
-
routes?: Array<string>;
|
|
370
|
-
/**
|
|
371
|
-
* Component name which will be used as default content type for this folders entries
|
|
372
|
-
*/
|
|
373
|
-
default_root?: string;
|
|
374
|
-
/**
|
|
375
|
-
* Array of language objects
|
|
376
|
-
*/
|
|
377
|
-
languages?: Array<{
|
|
378
|
-
/**
|
|
379
|
-
* Language code
|
|
380
|
-
*/
|
|
381
|
-
code?: string;
|
|
382
|
-
/**
|
|
383
|
-
* Language name
|
|
384
|
-
*/
|
|
385
|
-
name?: string;
|
|
386
|
-
/**
|
|
387
|
-
* AI translation code for the language
|
|
388
|
-
*/
|
|
389
|
-
ai_translation_code?: string;
|
|
390
|
-
}>;
|
|
391
|
-
/**
|
|
392
|
-
* Crawl configuration
|
|
393
|
-
*/
|
|
394
|
-
crawl_config?: {
|
|
395
|
-
/**
|
|
396
|
-
* Base URL for crawling
|
|
397
|
-
*/
|
|
398
|
-
base_url?: string;
|
|
399
|
-
/**
|
|
400
|
-
* Whether crawling is enabled
|
|
401
|
-
*/
|
|
402
|
-
enabled?: boolean;
|
|
403
|
-
};
|
|
404
|
-
/**
|
|
405
|
-
* Required asset fields
|
|
406
|
-
*/
|
|
407
|
-
required_assest_fields?: Array<string>;
|
|
408
|
-
/**
|
|
409
|
-
* Custom metadata schema for assets
|
|
410
|
-
*/
|
|
411
|
-
asset_custom_meta_data_schema?: Array<{
|
|
412
|
-
/**
|
|
413
|
-
* Field key
|
|
414
|
-
*/
|
|
415
|
-
key?: string;
|
|
416
|
-
/**
|
|
417
|
-
* Display name for the field
|
|
418
|
-
*/
|
|
419
|
-
display_name?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Regex pattern for validation
|
|
422
|
-
*/
|
|
423
|
-
regex?: string;
|
|
424
|
-
/**
|
|
425
|
-
* Error message for regex validation
|
|
426
|
-
*/
|
|
427
|
-
regex_message?: string;
|
|
428
|
-
/**
|
|
429
|
-
* Whether the field is required
|
|
430
|
-
*/
|
|
431
|
-
required?: boolean;
|
|
432
|
-
/**
|
|
433
|
-
* Whether the field is translatable
|
|
434
|
-
*/
|
|
435
|
-
translatable?: boolean;
|
|
436
|
-
/**
|
|
437
|
-
* Allowed file types
|
|
438
|
-
*/
|
|
439
|
-
filetypes?: Array<string>;
|
|
440
|
-
}>;
|
|
441
|
-
/**
|
|
442
|
-
* Translatable asset fields
|
|
443
|
-
*/
|
|
444
|
-
translatable_asset_fields?: Array<string>;
|
|
445
|
-
/**
|
|
446
|
-
* Dimensions app folder IDs
|
|
447
|
-
*/
|
|
448
|
-
dimensions_app_folder_ids?: Array<number>;
|
|
449
|
-
/**
|
|
450
|
-
* Disclaimer ID for the space
|
|
451
|
-
*/
|
|
452
|
-
disclaimer_id?: number;
|
|
453
|
-
};
|
|
454
|
-
type ListData = {
|
|
455
|
-
body?: never;
|
|
456
|
-
path?: never;
|
|
457
|
-
query?: {
|
|
458
|
-
/**
|
|
459
|
-
* Search term to filter spaces by name
|
|
460
|
-
*/
|
|
461
|
-
search?: string;
|
|
462
|
-
};
|
|
463
|
-
url: '/v1/spaces';
|
|
464
|
-
};
|
|
465
|
-
type ListResponses = {
|
|
466
|
-
/**
|
|
467
|
-
* List of spaces
|
|
468
|
-
*/
|
|
469
|
-
200: {
|
|
470
|
-
spaces?: Array<Space>;
|
|
471
|
-
};
|
|
472
|
-
};
|
|
473
|
-
type CreateData = {
|
|
474
|
-
body: {
|
|
475
|
-
space: SpaceCreate;
|
|
476
|
-
/**
|
|
477
|
-
* The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.
|
|
478
|
-
*/
|
|
479
|
-
dup_id?: number;
|
|
480
|
-
/**
|
|
481
|
-
* Whether to create the space within the user's organization
|
|
482
|
-
*/
|
|
483
|
-
in_org?: boolean;
|
|
484
|
-
/**
|
|
485
|
-
* Type of space for enterprise plans
|
|
486
|
-
*/
|
|
487
|
-
space_type?: string;
|
|
488
|
-
/**
|
|
489
|
-
* Whether to assign a partner to the space
|
|
490
|
-
*/
|
|
491
|
-
assign_partner?: boolean;
|
|
492
|
-
};
|
|
493
|
-
path?: never;
|
|
494
|
-
query?: never;
|
|
495
|
-
url: '/v1/spaces';
|
|
496
|
-
};
|
|
497
|
-
type CreateResponses = {
|
|
498
|
-
/**
|
|
499
|
-
* Space created
|
|
500
|
-
*/
|
|
501
|
-
201: {
|
|
502
|
-
space?: Space;
|
|
503
|
-
};
|
|
504
|
-
};
|
|
505
|
-
type DeleteResponses = {
|
|
506
|
-
/**
|
|
507
|
-
* Space deleted
|
|
508
|
-
*/
|
|
509
|
-
200: {
|
|
510
|
-
space?: Space;
|
|
511
|
-
};
|
|
512
|
-
};
|
|
513
|
-
type GetResponses = {
|
|
514
|
-
/**
|
|
515
|
-
* Space details
|
|
516
|
-
*/
|
|
517
|
-
200: {
|
|
518
|
-
space?: Space;
|
|
519
|
-
};
|
|
520
|
-
};
|
|
521
|
-
type UpdateData = {
|
|
522
|
-
body: {
|
|
523
|
-
space: SpaceUpdate;
|
|
524
|
-
};
|
|
525
|
-
path: {
|
|
526
|
-
/**
|
|
527
|
-
* The ID of the Storyblok space (can be integer or string)
|
|
528
|
-
*/
|
|
529
|
-
space_id: number | string;
|
|
530
|
-
};
|
|
531
|
-
query?: never;
|
|
532
|
-
url: '/v1/spaces/{space_id}';
|
|
533
|
-
};
|
|
534
|
-
type UpdateResponses = {
|
|
535
|
-
/**
|
|
536
|
-
* Space updated
|
|
537
|
-
*/
|
|
538
|
-
200: {
|
|
539
|
-
space?: Space;
|
|
540
|
-
};
|
|
541
|
-
};
|
|
542
|
-
//#endregion
|
|
543
|
-
export { CreateData, CreateResponses, DeleteResponses, GetResponses, ListData, ListResponses, Space, SpaceCreate, SpaceUpdate, UpdateData, UpdateResponses };
|
|
544
|
-
//# sourceMappingURL=types.gen.d.cts.map
|