@storyblok/management-api-client 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/client.d.mts +1 -1
- package/dist/client/client.d.ts +1 -1
- package/dist/client/client.js +2 -2
- package/dist/client/client.js.map +1 -1
- package/dist/client/client.mjs +2 -2
- package/dist/client/client.mjs.map +1 -1
- package/dist/client/types.d.mts +7 -0
- package/dist/client/types.d.ts +7 -0
- package/dist/generated/assets/types.gen.d.mts +14 -2
- package/dist/generated/assets/types.gen.d.ts +14 -2
- package/dist/generated/assets/types.gen.js.map +1 -1
- package/dist/generated/assets/types.gen.mjs.map +1 -1
- package/dist/generated/component_folders/types.gen.d.mts +8 -28
- package/dist/generated/component_folders/types.gen.d.ts +8 -28
- package/dist/generated/component_folders/types.gen.js.map +1 -1
- package/dist/generated/component_folders/types.gen.mjs.map +1 -1
- package/dist/generated/components/types.gen.d.mts +19 -7
- package/dist/generated/components/types.gen.d.ts +19 -7
- package/dist/generated/components/types.gen.js.map +1 -1
- package/dist/generated/components/types.gen.mjs.map +1 -1
- package/dist/generated/datasource_entries/types.gen.d.mts +26 -42
- package/dist/generated/datasource_entries/types.gen.d.ts +26 -42
- package/dist/generated/datasource_entries/types.gen.js.map +1 -1
- package/dist/generated/datasource_entries/types.gen.mjs.map +1 -1
- package/dist/generated/datasources/types.gen.d.mts +13 -59
- package/dist/generated/datasources/types.gen.d.ts +13 -59
- package/dist/generated/datasources/types.gen.js.map +1 -1
- package/dist/generated/datasources/types.gen.mjs.map +1 -1
- package/dist/generated/internal_tags/types.gen.d.mts +14 -2
- package/dist/generated/internal_tags/types.gen.d.ts +14 -2
- package/dist/generated/internal_tags/types.gen.js.map +1 -1
- package/dist/generated/internal_tags/types.gen.mjs.map +1 -1
- package/dist/generated/presets/types.gen.d.mts +10 -80
- package/dist/generated/presets/types.gen.d.ts +10 -80
- package/dist/generated/presets/types.gen.js.map +1 -1
- package/dist/generated/presets/types.gen.mjs.map +1 -1
- package/dist/generated/spaces/types.gen.d.mts +71 -0
- package/dist/generated/spaces/types.gen.d.ts +71 -0
- package/dist/generated/spaces/types.gen.js.map +1 -1
- package/dist/generated/spaces/types.gen.mjs.map +1 -1
- package/dist/generated/stories/types.gen.d.mts +30 -17
- package/dist/generated/stories/types.gen.d.ts +30 -17
- package/dist/generated/stories/types.gen.js.map +1 -1
- package/dist/generated/stories/types.gen.mjs.map +1 -1
- package/dist/generated/users/types.gen.d.mts +10 -113
- package/dist/generated/users/types.gen.d.ts +10 -113
- package/dist/generated/users/types.gen.js.map +1 -1
- package/dist/generated/users/types.gen.mjs.map +1 -1
- package/dist/index.js +19 -17
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19 -16
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,76 +1,6 @@
|
|
|
1
1
|
declare namespace types_gen_d_exports {
|
|
2
|
-
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset,
|
|
2
|
+
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses };
|
|
3
3
|
}
|
|
4
|
-
/**
|
|
5
|
-
* A Preset Object for creating new presets
|
|
6
|
-
*/
|
|
7
|
-
type PresetCreate = {
|
|
8
|
-
/**
|
|
9
|
-
* Given name of your preset
|
|
10
|
-
*/
|
|
11
|
-
name: string;
|
|
12
|
-
/**
|
|
13
|
-
* Fields of the component filled with content
|
|
14
|
-
*/
|
|
15
|
-
preset?: {
|
|
16
|
-
[key: string]: unknown;
|
|
17
|
-
};
|
|
18
|
-
/**
|
|
19
|
-
* The ID of the component the preset is for
|
|
20
|
-
*/
|
|
21
|
-
component_id: number;
|
|
22
|
-
/**
|
|
23
|
-
* Screenshot or other preview image for your editor
|
|
24
|
-
*/
|
|
25
|
-
image?: string;
|
|
26
|
-
/**
|
|
27
|
-
* Color of the preset icon
|
|
28
|
-
*/
|
|
29
|
-
color?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Icon of the preset
|
|
32
|
-
*/
|
|
33
|
-
icon?: string;
|
|
34
|
-
/**
|
|
35
|
-
* A description of the preset for the editors
|
|
36
|
-
*/
|
|
37
|
-
description?: string;
|
|
38
|
-
};
|
|
39
|
-
/**
|
|
40
|
-
* A Preset Object for updating existing presets
|
|
41
|
-
*/
|
|
42
|
-
type PresetUpdate = {
|
|
43
|
-
/**
|
|
44
|
-
* Given name of your preset
|
|
45
|
-
*/
|
|
46
|
-
name?: string;
|
|
47
|
-
/**
|
|
48
|
-
* Fields of the component filled with content
|
|
49
|
-
*/
|
|
50
|
-
preset?: {
|
|
51
|
-
[key: string]: unknown;
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* The ID of the component the preset is for
|
|
55
|
-
*/
|
|
56
|
-
component_id?: number;
|
|
57
|
-
/**
|
|
58
|
-
* Screenshot or other preview image for your editors
|
|
59
|
-
*/
|
|
60
|
-
image?: string;
|
|
61
|
-
/**
|
|
62
|
-
* Color of the preset icon
|
|
63
|
-
*/
|
|
64
|
-
color?: string;
|
|
65
|
-
/**
|
|
66
|
-
* Icon of the preset
|
|
67
|
-
*/
|
|
68
|
-
icon?: string;
|
|
69
|
-
/**
|
|
70
|
-
* A description of the preset for the editors
|
|
71
|
-
*/
|
|
72
|
-
description?: string;
|
|
73
|
-
};
|
|
74
4
|
/**
|
|
75
5
|
* A Preset Object representing a content preset
|
|
76
6
|
*/
|
|
@@ -82,29 +12,29 @@ type Preset = {
|
|
|
82
12
|
/**
|
|
83
13
|
* Given name of your preset
|
|
84
14
|
*/
|
|
85
|
-
name
|
|
15
|
+
name: string;
|
|
86
16
|
/**
|
|
87
17
|
* Fields of the component filled with content
|
|
88
18
|
*/
|
|
89
|
-
preset
|
|
19
|
+
preset: {
|
|
90
20
|
[key: string]: unknown;
|
|
91
21
|
};
|
|
92
22
|
/**
|
|
93
23
|
* The ID of the component the preset is for
|
|
94
24
|
*/
|
|
95
|
-
component_id
|
|
25
|
+
component_id: number;
|
|
96
26
|
/**
|
|
97
27
|
* Numeric ID of a space
|
|
98
28
|
*/
|
|
99
|
-
space_id?: number;
|
|
29
|
+
readonly space_id?: number;
|
|
100
30
|
/**
|
|
101
31
|
* Creation date
|
|
102
32
|
*/
|
|
103
|
-
created_at?: string;
|
|
33
|
+
readonly created_at?: string;
|
|
104
34
|
/**
|
|
105
35
|
* Latest update date
|
|
106
36
|
*/
|
|
107
|
-
updated_at?: string;
|
|
37
|
+
readonly updated_at?: string;
|
|
108
38
|
/**
|
|
109
39
|
* Screenshot or other preview image for your editor
|
|
110
40
|
*/
|
|
@@ -178,7 +108,7 @@ type ListResponses = {
|
|
|
178
108
|
type ListResponse = ListResponses[keyof ListResponses];
|
|
179
109
|
type CreateData = {
|
|
180
110
|
body: {
|
|
181
|
-
preset?:
|
|
111
|
+
preset?: Preset;
|
|
182
112
|
};
|
|
183
113
|
path: {
|
|
184
114
|
/**
|
|
@@ -311,7 +241,7 @@ type GetResponses = {
|
|
|
311
241
|
type GetResponse = GetResponses[keyof GetResponses];
|
|
312
242
|
type UpdateData = {
|
|
313
243
|
body: {
|
|
314
|
-
preset?:
|
|
244
|
+
preset?: Preset;
|
|
315
245
|
};
|
|
316
246
|
path: {
|
|
317
247
|
/**
|
|
@@ -360,5 +290,5 @@ type ClientOptions = {
|
|
|
360
290
|
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 & {});
|
|
361
291
|
};
|
|
362
292
|
//#endregion
|
|
363
|
-
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset,
|
|
293
|
+
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses, types_gen_d_exports };
|
|
364
294
|
//# sourceMappingURL=types.gen.d.mts.map
|
|
@@ -1,76 +1,6 @@
|
|
|
1
1
|
declare namespace types_gen_d_exports {
|
|
2
|
-
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset,
|
|
2
|
+
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses };
|
|
3
3
|
}
|
|
4
|
-
/**
|
|
5
|
-
* A Preset Object for creating new presets
|
|
6
|
-
*/
|
|
7
|
-
type PresetCreate = {
|
|
8
|
-
/**
|
|
9
|
-
* Given name of your preset
|
|
10
|
-
*/
|
|
11
|
-
name: string;
|
|
12
|
-
/**
|
|
13
|
-
* Fields of the component filled with content
|
|
14
|
-
*/
|
|
15
|
-
preset?: {
|
|
16
|
-
[key: string]: unknown;
|
|
17
|
-
};
|
|
18
|
-
/**
|
|
19
|
-
* The ID of the component the preset is for
|
|
20
|
-
*/
|
|
21
|
-
component_id: number;
|
|
22
|
-
/**
|
|
23
|
-
* Screenshot or other preview image for your editor
|
|
24
|
-
*/
|
|
25
|
-
image?: string;
|
|
26
|
-
/**
|
|
27
|
-
* Color of the preset icon
|
|
28
|
-
*/
|
|
29
|
-
color?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Icon of the preset
|
|
32
|
-
*/
|
|
33
|
-
icon?: string;
|
|
34
|
-
/**
|
|
35
|
-
* A description of the preset for the editors
|
|
36
|
-
*/
|
|
37
|
-
description?: string;
|
|
38
|
-
};
|
|
39
|
-
/**
|
|
40
|
-
* A Preset Object for updating existing presets
|
|
41
|
-
*/
|
|
42
|
-
type PresetUpdate = {
|
|
43
|
-
/**
|
|
44
|
-
* Given name of your preset
|
|
45
|
-
*/
|
|
46
|
-
name?: string;
|
|
47
|
-
/**
|
|
48
|
-
* Fields of the component filled with content
|
|
49
|
-
*/
|
|
50
|
-
preset?: {
|
|
51
|
-
[key: string]: unknown;
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* The ID of the component the preset is for
|
|
55
|
-
*/
|
|
56
|
-
component_id?: number;
|
|
57
|
-
/**
|
|
58
|
-
* Screenshot or other preview image for your editors
|
|
59
|
-
*/
|
|
60
|
-
image?: string;
|
|
61
|
-
/**
|
|
62
|
-
* Color of the preset icon
|
|
63
|
-
*/
|
|
64
|
-
color?: string;
|
|
65
|
-
/**
|
|
66
|
-
* Icon of the preset
|
|
67
|
-
*/
|
|
68
|
-
icon?: string;
|
|
69
|
-
/**
|
|
70
|
-
* A description of the preset for the editors
|
|
71
|
-
*/
|
|
72
|
-
description?: string;
|
|
73
|
-
};
|
|
74
4
|
/**
|
|
75
5
|
* A Preset Object representing a content preset
|
|
76
6
|
*/
|
|
@@ -82,29 +12,29 @@ type Preset = {
|
|
|
82
12
|
/**
|
|
83
13
|
* Given name of your preset
|
|
84
14
|
*/
|
|
85
|
-
name
|
|
15
|
+
name: string;
|
|
86
16
|
/**
|
|
87
17
|
* Fields of the component filled with content
|
|
88
18
|
*/
|
|
89
|
-
preset
|
|
19
|
+
preset: {
|
|
90
20
|
[key: string]: unknown;
|
|
91
21
|
};
|
|
92
22
|
/**
|
|
93
23
|
* The ID of the component the preset is for
|
|
94
24
|
*/
|
|
95
|
-
component_id
|
|
25
|
+
component_id: number;
|
|
96
26
|
/**
|
|
97
27
|
* Numeric ID of a space
|
|
98
28
|
*/
|
|
99
|
-
space_id?: number;
|
|
29
|
+
readonly space_id?: number;
|
|
100
30
|
/**
|
|
101
31
|
* Creation date
|
|
102
32
|
*/
|
|
103
|
-
created_at?: string;
|
|
33
|
+
readonly created_at?: string;
|
|
104
34
|
/**
|
|
105
35
|
* Latest update date
|
|
106
36
|
*/
|
|
107
|
-
updated_at?: string;
|
|
37
|
+
readonly updated_at?: string;
|
|
108
38
|
/**
|
|
109
39
|
* Screenshot or other preview image for your editor
|
|
110
40
|
*/
|
|
@@ -178,7 +108,7 @@ type ListResponses = {
|
|
|
178
108
|
type ListResponse = ListResponses[keyof ListResponses];
|
|
179
109
|
type CreateData = {
|
|
180
110
|
body: {
|
|
181
|
-
preset?:
|
|
111
|
+
preset?: Preset;
|
|
182
112
|
};
|
|
183
113
|
path: {
|
|
184
114
|
/**
|
|
@@ -311,7 +241,7 @@ type GetResponses = {
|
|
|
311
241
|
type GetResponse = GetResponses[keyof GetResponses];
|
|
312
242
|
type UpdateData = {
|
|
313
243
|
body: {
|
|
314
|
-
preset?:
|
|
244
|
+
preset?: Preset;
|
|
315
245
|
};
|
|
316
246
|
path: {
|
|
317
247
|
/**
|
|
@@ -360,5 +290,5 @@ type ClientOptions = {
|
|
|
360
290
|
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 & {});
|
|
361
291
|
};
|
|
362
292
|
//#endregion
|
|
363
|
-
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset,
|
|
293
|
+
export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses, types_gen_d_exports };
|
|
364
294
|
//# sourceMappingURL=types.gen.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.gen.js","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
|
|
1
|
+
{"version":3,"file":"types.gen.js","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":""}
|
|
@@ -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
|
|
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":""}
|