@storyblok/api-client 0.3.1 → 1.0.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/client.cjs +179 -0
- package/dist/client.cjs.map +1 -0
- package/dist/client.d.cts +567 -0
- package/dist/client.d.mts +567 -0
- package/dist/client.mjs +178 -0
- package/dist/client.mjs.map +1 -0
- package/dist/error.cjs.map +1 -1
- package/dist/error.d.cts +13 -2
- package/dist/error.d.mts +13 -2
- package/dist/error.mjs.map +1 -1
- package/dist/generated/capi/_internal.gen.d.cts +120 -0
- package/dist/generated/capi/_internal.gen.d.mts +120 -0
- package/dist/generated/{shared → capi}/client/client.gen.cjs +1 -1
- package/dist/generated/capi/client/client.gen.cjs.map +1 -0
- package/dist/generated/capi/client/client.gen.d.mts +1 -0
- package/dist/generated/{shared → capi}/client/client.gen.mjs +1 -1
- package/dist/generated/capi/client/client.gen.mjs.map +1 -0
- package/dist/generated/capi/client/index.d.mts +3 -0
- package/dist/generated/{shared → capi}/client/types.gen.d.cts +40 -4
- package/dist/generated/{shared → capi}/client/types.gen.d.mts +40 -4
- package/dist/generated/{shared → capi}/client/utils.gen.cjs +1 -1
- package/dist/generated/capi/client/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/client/utils.gen.d.cts +1 -1
- package/dist/generated/{shared → capi}/client/utils.gen.d.mts +1 -1
- package/dist/generated/{shared → capi}/client/utils.gen.mjs +1 -1
- package/dist/generated/capi/client/utils.gen.mjs.map +1 -0
- package/dist/generated/capi/client.gen.cjs +10 -0
- package/dist/generated/capi/client.gen.cjs.map +1 -0
- package/dist/generated/capi/client.gen.mjs +10 -0
- package/dist/generated/capi/client.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/auth.gen.cjs +1 -1
- package/dist/generated/capi/core/auth.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/auth.gen.d.cts +1 -1
- package/dist/generated/{shared → capi}/core/auth.gen.d.mts +1 -1
- package/dist/generated/{shared → capi}/core/auth.gen.mjs +1 -1
- package/dist/generated/capi/core/auth.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/bodySerializer.gen.cjs +1 -1
- package/dist/generated/capi/core/bodySerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/bodySerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → capi}/core/bodySerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → capi}/core/bodySerializer.gen.mjs +1 -1
- package/dist/generated/capi/core/bodySerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/params.gen.cjs +1 -1
- package/dist/generated/capi/core/params.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/params.gen.mjs +1 -1
- package/dist/generated/capi/core/params.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/pathSerializer.gen.cjs +1 -1
- package/dist/generated/capi/core/pathSerializer.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/pathSerializer.gen.d.cts +1 -1
- package/dist/generated/{shared → capi}/core/pathSerializer.gen.d.mts +1 -1
- package/dist/generated/{shared → capi}/core/pathSerializer.gen.mjs +1 -1
- package/dist/generated/capi/core/pathSerializer.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/serverSentEvents.gen.cjs +1 -1
- package/dist/generated/capi/core/serverSentEvents.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/serverSentEvents.gen.d.cts +5 -2
- package/dist/generated/{shared → capi}/core/serverSentEvents.gen.d.mts +5 -2
- package/dist/generated/{shared → capi}/core/serverSentEvents.gen.mjs +1 -1
- package/dist/generated/capi/core/serverSentEvents.gen.mjs.map +1 -0
- package/dist/generated/{shared → capi}/core/types.gen.d.cts +15 -2
- package/dist/generated/{shared → capi}/core/types.gen.d.mts +15 -2
- package/dist/generated/{shared → capi}/core/utils.gen.cjs +1 -1
- package/dist/generated/capi/core/utils.gen.cjs.map +1 -0
- package/dist/generated/{shared → capi}/core/utils.gen.mjs +1 -1
- package/dist/generated/capi/core/utils.gen.mjs.map +1 -0
- package/dist/generated/capi/sdk.gen.cjs +141 -0
- package/dist/generated/capi/sdk.gen.cjs.map +1 -0
- package/dist/generated/capi/sdk.gen.mjs +133 -0
- package/dist/generated/capi/sdk.gen.mjs.map +1 -0
- package/dist/generated/capi/types-aliased.gen.d.cts +181 -0
- package/dist/generated/capi/types-aliased.gen.d.mts +181 -0
- package/dist/generated/capi/types.gen.d.cts +919 -0
- package/dist/generated/capi/types.gen.d.mts +919 -0
- package/dist/generated/mapi/_internal.gen.d.cts +146 -0
- package/dist/generated/mapi/_internal.gen.d.mts +146 -0
- package/dist/generated/mapi/types.gen.d.cts +293 -0
- package/dist/generated/mapi/types.gen.d.mts +293 -0
- package/dist/generated/overlay/_internal.gen.d.cts +831 -0
- package/dist/generated/overlay/_internal.gen.d.mts +831 -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 +29 -0
- package/dist/generated/types/block.d.mts +29 -0
- package/dist/generated/types/field.d.cts +64 -0
- package/dist/generated/types/field.d.mts +64 -0
- package/dist/generated/types/story.d.cts +19 -0
- package/dist/generated/types/story.d.mts +19 -0
- package/dist/index.cjs +2 -154
- package/dist/index.d.cts +8 -184
- package/dist/index.d.mts +8 -184
- package/dist/index.mjs +2 -151
- package/dist/resources/datasource-entries.cjs +2 -2
- package/dist/resources/datasource-entries.cjs.map +1 -1
- package/dist/resources/datasource-entries.mjs +2 -2
- package/dist/resources/datasource-entries.mjs.map +1 -1
- package/dist/resources/datasources.cjs +4 -4
- package/dist/resources/datasources.cjs.map +1 -1
- package/dist/resources/datasources.mjs +4 -4
- package/dist/resources/datasources.mjs.map +1 -1
- package/dist/resources/experiments.cjs +26 -0
- package/dist/resources/experiments.cjs.map +1 -0
- package/dist/resources/experiments.mjs +26 -0
- package/dist/resources/experiments.mjs.map +1 -0
- package/dist/resources/links.cjs +2 -2
- package/dist/resources/links.cjs.map +1 -1
- package/dist/resources/links.mjs +2 -2
- package/dist/resources/links.mjs.map +1 -1
- package/dist/resources/spaces.cjs +4 -4
- package/dist/resources/spaces.cjs.map +1 -1
- package/dist/resources/spaces.mjs +4 -4
- package/dist/resources/spaces.mjs.map +1 -1
- package/dist/resources/stories.cjs +16 -12
- package/dist/resources/stories.cjs.map +1 -1
- package/dist/resources/stories.d.cts +82 -4
- package/dist/resources/stories.d.mts +82 -4
- package/dist/resources/stories.mjs +16 -12
- package/dist/resources/stories.mjs.map +1 -1
- package/dist/resources/tags.cjs +2 -2
- package/dist/resources/tags.cjs.map +1 -1
- package/dist/resources/tags.mjs +2 -2
- package/dist/resources/tags.mjs.map +1 -1
- package/dist/utils/fetch-rel-uuids.cjs +2 -2
- package/dist/utils/fetch-rel-uuids.cjs.map +1 -1
- package/dist/utils/fetch-rel-uuids.mjs +2 -2
- package/dist/utils/fetch-rel-uuids.mjs.map +1 -1
- package/dist/utils/inline-relations.cjs.map +1 -1
- package/dist/utils/inline-relations.mjs.map +1 -1
- package/dist/utils/rate-limit.cjs +9 -5
- package/dist/utils/rate-limit.cjs.map +1 -1
- package/dist/utils/rate-limit.d.cts +4 -18
- package/dist/utils/rate-limit.d.mts +4 -18
- package/dist/utils/rate-limit.mjs +10 -4
- package/dist/utils/rate-limit.mjs.map +1 -1
- package/package.json +16 -12
- 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 -21
- package/dist/generated/datasource_entries/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasource_entries/sdk.gen.mjs +0 -21
- package/dist/generated/datasource_entries/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasource_entries/types.gen.d.cts +0 -67
- package/dist/generated/datasource_entries/types.gen.d.mts +0 -67
- 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 -36
- package/dist/generated/datasources/sdk.gen.cjs.map +0 -1
- package/dist/generated/datasources/sdk.gen.mjs +0 -35
- package/dist/generated/datasources/sdk.gen.mjs.map +0 -1
- package/dist/generated/datasources/types.gen.d.cts +0 -109
- package/dist/generated/datasources/types.gen.d.mts +0 -109
- package/dist/generated/links/client.gen.cjs +0 -10
- package/dist/generated/links/client.gen.cjs.map +0 -1
- package/dist/generated/links/client.gen.mjs +0 -10
- package/dist/generated/links/client.gen.mjs.map +0 -1
- package/dist/generated/links/sdk.gen.cjs +0 -21
- package/dist/generated/links/sdk.gen.cjs.map +0 -1
- package/dist/generated/links/sdk.gen.mjs +0 -21
- package/dist/generated/links/sdk.gen.mjs.map +0 -1
- package/dist/generated/links/types.gen.d.cts +0 -142
- package/dist/generated/links/types.gen.d.mts +0 -142
- 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 -21
- package/dist/generated/spaces/sdk.gen.cjs.map +0 -1
- package/dist/generated/spaces/sdk.gen.mjs +0 -21
- package/dist/generated/spaces/sdk.gen.mjs.map +0 -1
- package/dist/generated/spaces/types.gen.d.cts +0 -34
- package/dist/generated/spaces/types.gen.d.mts +0 -34
- 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 -36
- package/dist/generated/stories/sdk.gen.cjs.map +0 -1
- package/dist/generated/stories/sdk.gen.mjs +0 -35
- package/dist/generated/stories/sdk.gen.mjs.map +0 -1
- package/dist/generated/stories/types.gen.d.cts +0 -544
- package/dist/generated/stories/types.gen.d.mts +0 -544
- package/dist/generated/tags/client.gen.cjs +0 -10
- package/dist/generated/tags/client.gen.cjs.map +0 -1
- package/dist/generated/tags/client.gen.mjs +0 -10
- package/dist/generated/tags/client.gen.mjs.map +0 -1
- package/dist/generated/tags/sdk.gen.cjs +0 -21
- package/dist/generated/tags/sdk.gen.cjs.map +0 -1
- package/dist/generated/tags/sdk.gen.mjs +0 -21
- package/dist/generated/tags/sdk.gen.mjs.map +0 -1
- package/dist/generated/tags/types.gen.d.cts +0 -44
- package/dist/generated/tags/types.gen.d.mts +0 -44
- package/dist/index.cjs.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/types.d.cts +0 -37
- package/dist/types.d.mts +0 -37
- /package/dist/generated/{shared → capi}/client/index.cjs +0 -0
- /package/dist/generated/{shared → capi}/client/index.mjs +0 -0
|
@@ -0,0 +1,919 @@
|
|
|
1
|
+
//#region src/generated/capi/types.gen.d.ts
|
|
2
|
+
type Alternate = {
|
|
3
|
+
/**
|
|
4
|
+
* Translated slug (or parent slug if not installed).
|
|
5
|
+
*/
|
|
6
|
+
path: string;
|
|
7
|
+
/**
|
|
8
|
+
* Translated name of the story or folder.
|
|
9
|
+
*/
|
|
10
|
+
name: string;
|
|
11
|
+
/**
|
|
12
|
+
* Language code of this story variant.
|
|
13
|
+
*/
|
|
14
|
+
lang: string;
|
|
15
|
+
/**
|
|
16
|
+
* True if this variant is published.
|
|
17
|
+
*/
|
|
18
|
+
published: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Translated slug of the story.
|
|
21
|
+
*/
|
|
22
|
+
translated_slug: string;
|
|
23
|
+
};
|
|
24
|
+
type CdnExperiment = {
|
|
25
|
+
/**
|
|
26
|
+
* Numeric ID of the experiment
|
|
27
|
+
*/
|
|
28
|
+
id: number;
|
|
29
|
+
/**
|
|
30
|
+
* Internal name (lowercase, numbers, underscores)
|
|
31
|
+
*/
|
|
32
|
+
name: string;
|
|
33
|
+
/**
|
|
34
|
+
* Human-readable display name
|
|
35
|
+
*/
|
|
36
|
+
display_name: string;
|
|
37
|
+
/**
|
|
38
|
+
* IDs of stories assigned to this experiment
|
|
39
|
+
*/
|
|
40
|
+
story_ids: Array<number>;
|
|
41
|
+
/**
|
|
42
|
+
* Variants belonging to this experiment
|
|
43
|
+
*/
|
|
44
|
+
variants: Array<CdnExperimentVariant>;
|
|
45
|
+
};
|
|
46
|
+
type CdnExperimentVariant = {
|
|
47
|
+
/**
|
|
48
|
+
* Internal name (lowercase, numbers, underscores)
|
|
49
|
+
*/
|
|
50
|
+
name: string;
|
|
51
|
+
/**
|
|
52
|
+
* Human-readable display name
|
|
53
|
+
*/
|
|
54
|
+
display_name: string;
|
|
55
|
+
/**
|
|
56
|
+
* Public identifier for stable bucketing
|
|
57
|
+
*/
|
|
58
|
+
public_id: string;
|
|
59
|
+
/**
|
|
60
|
+
* Traffic weight percentage (0-100)
|
|
61
|
+
*/
|
|
62
|
+
weight: number;
|
|
63
|
+
/**
|
|
64
|
+
* Whether this is the control variant
|
|
65
|
+
*/
|
|
66
|
+
is_control: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Mappings between original stories and their variant copies
|
|
69
|
+
*/
|
|
70
|
+
story_mappings: Array<{
|
|
71
|
+
/**
|
|
72
|
+
* ID of the original story
|
|
73
|
+
*/
|
|
74
|
+
original_story_id: number;
|
|
75
|
+
/**
|
|
76
|
+
* Slug of the original story
|
|
77
|
+
*/
|
|
78
|
+
original_slug: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* ID of the variant story copy
|
|
81
|
+
*/
|
|
82
|
+
variant_story_id: number | null;
|
|
83
|
+
/**
|
|
84
|
+
* Slug of the variant story copy
|
|
85
|
+
*/
|
|
86
|
+
variant_slug: string | null;
|
|
87
|
+
}>;
|
|
88
|
+
};
|
|
89
|
+
type Link = {
|
|
90
|
+
/**
|
|
91
|
+
* ID.
|
|
92
|
+
*/
|
|
93
|
+
id: number;
|
|
94
|
+
uuid: string;
|
|
95
|
+
/**
|
|
96
|
+
* The full slug of the story or folder.
|
|
97
|
+
*/
|
|
98
|
+
slug: string;
|
|
99
|
+
/**
|
|
100
|
+
* Real path defined in the story's entry configuration.
|
|
101
|
+
*/
|
|
102
|
+
path?: string | null;
|
|
103
|
+
/**
|
|
104
|
+
* Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /.
|
|
105
|
+
*/
|
|
106
|
+
real_path?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
* The complete name of the story or folder.
|
|
109
|
+
*/
|
|
110
|
+
name: string;
|
|
111
|
+
/**
|
|
112
|
+
* true if a story is currently published, even if it has unpublished changes.
|
|
113
|
+
*/
|
|
114
|
+
published: boolean;
|
|
115
|
+
/**
|
|
116
|
+
* ID of the parent folder.
|
|
117
|
+
*/
|
|
118
|
+
parent_id: number;
|
|
119
|
+
/**
|
|
120
|
+
* true if the instance constitutes a folder.
|
|
121
|
+
*/
|
|
122
|
+
is_folder: boolean;
|
|
123
|
+
/**
|
|
124
|
+
* true if the story is defined as root for the folder.
|
|
125
|
+
*/
|
|
126
|
+
is_startpage: boolean;
|
|
127
|
+
/**
|
|
128
|
+
* Numeric representation of the story's position in the folder.
|
|
129
|
+
*/
|
|
130
|
+
position: number;
|
|
131
|
+
/**
|
|
132
|
+
* Latest publication timestamp (format is ISO 8601 standard in UTC).
|
|
133
|
+
*/
|
|
134
|
+
published_at?: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* Creation timestamp (format is ISO 8601 standard in UTC).
|
|
137
|
+
*/
|
|
138
|
+
created_at?: string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Latest update timestamp (format is ISO 8601 standard in UTC).
|
|
141
|
+
*/
|
|
142
|
+
updated_at?: string | null;
|
|
143
|
+
/**
|
|
144
|
+
* Alternate language variants.
|
|
145
|
+
*/
|
|
146
|
+
alternates?: Array<Alternate>;
|
|
147
|
+
};
|
|
148
|
+
type LinkWithFullSlug = Link & {
|
|
149
|
+
/**
|
|
150
|
+
* Full slug including path and optional language prefix
|
|
151
|
+
*/
|
|
152
|
+
full_slug: string;
|
|
153
|
+
};
|
|
154
|
+
type Dimension = {
|
|
155
|
+
/**
|
|
156
|
+
* ID.
|
|
157
|
+
*/
|
|
158
|
+
id: number;
|
|
159
|
+
/**
|
|
160
|
+
* Name.
|
|
161
|
+
*/
|
|
162
|
+
name: string;
|
|
163
|
+
/**
|
|
164
|
+
* The value provided for the datasource dimension.
|
|
165
|
+
*/
|
|
166
|
+
entry_value: string;
|
|
167
|
+
/**
|
|
168
|
+
* The numeric ID of the datasource that the dimension belongs to.
|
|
169
|
+
*/
|
|
170
|
+
datasource_id?: number;
|
|
171
|
+
/**
|
|
172
|
+
* Creation timestamp (format is ISO 8601 standard in UTC).
|
|
173
|
+
*/
|
|
174
|
+
created_at?: string;
|
|
175
|
+
/**
|
|
176
|
+
* Latest update timestamp (format is ISO 8601 standard in UTC).
|
|
177
|
+
*/
|
|
178
|
+
updated_at?: string;
|
|
179
|
+
};
|
|
180
|
+
type StoryAlternate = {
|
|
181
|
+
id: number;
|
|
182
|
+
name: string;
|
|
183
|
+
slug: string;
|
|
184
|
+
published: boolean | null;
|
|
185
|
+
full_slug: string;
|
|
186
|
+
is_folder: boolean;
|
|
187
|
+
parent_id: number;
|
|
188
|
+
};
|
|
189
|
+
type Datasource = {
|
|
190
|
+
/**
|
|
191
|
+
* ID.
|
|
192
|
+
*/
|
|
193
|
+
id: number;
|
|
194
|
+
/**
|
|
195
|
+
* Name.
|
|
196
|
+
*/
|
|
197
|
+
name: string;
|
|
198
|
+
/**
|
|
199
|
+
* The unique slug of the datasource.
|
|
200
|
+
*/
|
|
201
|
+
slug: string;
|
|
202
|
+
/**
|
|
203
|
+
* Dimensions of the datasource.
|
|
204
|
+
*/
|
|
205
|
+
dimensions: Array<Dimension>;
|
|
206
|
+
/**
|
|
207
|
+
* Creation timestamp (format is ISO 8601 standard in UTC).
|
|
208
|
+
*/
|
|
209
|
+
created_at?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Latest update timestamp (format is ISO 8601 standard in UTC).
|
|
212
|
+
*/
|
|
213
|
+
updated_at?: string;
|
|
214
|
+
};
|
|
215
|
+
type DatasourceEntry = {
|
|
216
|
+
/**
|
|
217
|
+
* ID.
|
|
218
|
+
*/
|
|
219
|
+
id: number;
|
|
220
|
+
/**
|
|
221
|
+
* Name.
|
|
222
|
+
*/
|
|
223
|
+
name: string;
|
|
224
|
+
/**
|
|
225
|
+
* Given value in default dimension.
|
|
226
|
+
*/
|
|
227
|
+
value: string;
|
|
228
|
+
/**
|
|
229
|
+
* Given value in the requested dimension.
|
|
230
|
+
*/
|
|
231
|
+
dimension_value: string | null;
|
|
232
|
+
};
|
|
233
|
+
type DraftStory = {
|
|
234
|
+
name: string;
|
|
235
|
+
/**
|
|
236
|
+
* Creation timestamp (format is ISO 8601 standard in UTC).
|
|
237
|
+
*/
|
|
238
|
+
created_at: string;
|
|
239
|
+
/**
|
|
240
|
+
* Latest update timestamp (format is ISO 8601 standard in UTC).
|
|
241
|
+
*/
|
|
242
|
+
updated_at?: string | null;
|
|
243
|
+
/**
|
|
244
|
+
* Latest publication timestamp (format is ISO 8601 standard in UTC).
|
|
245
|
+
*/
|
|
246
|
+
published_at: string | null;
|
|
247
|
+
alternates: Array<StoryAlternate>;
|
|
248
|
+
id: number;
|
|
249
|
+
uuid: string;
|
|
250
|
+
/**
|
|
251
|
+
* Dynamic component data rendered by Storyblok, structure varies by component.
|
|
252
|
+
*/
|
|
253
|
+
content: {
|
|
254
|
+
_uid?: string;
|
|
255
|
+
component?: string;
|
|
256
|
+
[key: string]: unknown | string | undefined;
|
|
257
|
+
};
|
|
258
|
+
slug: string;
|
|
259
|
+
full_slug: string;
|
|
260
|
+
default_full_slug: string | null;
|
|
261
|
+
sort_by_date: string | null;
|
|
262
|
+
position: number;
|
|
263
|
+
tag_list: Array<string>;
|
|
264
|
+
is_startpage: boolean;
|
|
265
|
+
parent_id: number;
|
|
266
|
+
/**
|
|
267
|
+
* Custom metadata for the story.
|
|
268
|
+
*/
|
|
269
|
+
meta_data: {
|
|
270
|
+
[key: string]: unknown;
|
|
271
|
+
} | null;
|
|
272
|
+
group_id: string;
|
|
273
|
+
first_published_at: string | null;
|
|
274
|
+
release_id: number | null;
|
|
275
|
+
lang: string;
|
|
276
|
+
path: string | null;
|
|
277
|
+
translated_slugs: Array<{
|
|
278
|
+
path: string;
|
|
279
|
+
name: string | null;
|
|
280
|
+
lang: string;
|
|
281
|
+
published: string | null;
|
|
282
|
+
}> | null;
|
|
283
|
+
};
|
|
284
|
+
type PublicSpace = {
|
|
285
|
+
/**
|
|
286
|
+
* The space ID.
|
|
287
|
+
*/
|
|
288
|
+
id: number;
|
|
289
|
+
/**
|
|
290
|
+
* The space name.
|
|
291
|
+
*/
|
|
292
|
+
name: string;
|
|
293
|
+
/**
|
|
294
|
+
* The domain associated with the space.
|
|
295
|
+
*/
|
|
296
|
+
domain: string;
|
|
297
|
+
/**
|
|
298
|
+
* Cache version.
|
|
299
|
+
*/
|
|
300
|
+
version: number;
|
|
301
|
+
/**
|
|
302
|
+
* List of language codes supported by the public space.
|
|
303
|
+
*/
|
|
304
|
+
language_codes: Array<string>;
|
|
305
|
+
};
|
|
306
|
+
type PublishedStory = {
|
|
307
|
+
name: string;
|
|
308
|
+
/**
|
|
309
|
+
* Creation timestamp (format is ISO 8601 standard in UTC).
|
|
310
|
+
*/
|
|
311
|
+
created_at: string;
|
|
312
|
+
/**
|
|
313
|
+
* Latest update timestamp (format is ISO 8601 standard in UTC).
|
|
314
|
+
*/
|
|
315
|
+
updated_at?: string | null;
|
|
316
|
+
/**
|
|
317
|
+
* Latest publication timestamp (format is ISO 8601 standard in UTC).
|
|
318
|
+
*/
|
|
319
|
+
published_at: string | null;
|
|
320
|
+
id: number;
|
|
321
|
+
uuid: string;
|
|
322
|
+
/**
|
|
323
|
+
* Dynamic component data rendered by Storyblok, structure varies by component.
|
|
324
|
+
*/
|
|
325
|
+
content: {
|
|
326
|
+
_uid?: string;
|
|
327
|
+
component?: string;
|
|
328
|
+
[key: string]: unknown | string | undefined;
|
|
329
|
+
};
|
|
330
|
+
slug: string;
|
|
331
|
+
full_slug: string;
|
|
332
|
+
sort_by_date: string | null;
|
|
333
|
+
position: number;
|
|
334
|
+
tag_list: Array<string>;
|
|
335
|
+
is_startpage: boolean;
|
|
336
|
+
parent_id: number;
|
|
337
|
+
/**
|
|
338
|
+
* Custom metadata for the story.
|
|
339
|
+
*/
|
|
340
|
+
meta_data: {
|
|
341
|
+
[key: string]: unknown;
|
|
342
|
+
} | null;
|
|
343
|
+
group_id: string;
|
|
344
|
+
first_published_at: string | null;
|
|
345
|
+
release_id?: number | null;
|
|
346
|
+
lang: string;
|
|
347
|
+
path: string | null;
|
|
348
|
+
alternates: Array<StoryAlternate>;
|
|
349
|
+
default_full_slug: string | null;
|
|
350
|
+
translated_slugs: Array<{
|
|
351
|
+
path: string;
|
|
352
|
+
name: string | null;
|
|
353
|
+
lang: string;
|
|
354
|
+
published: string | null;
|
|
355
|
+
}> | null;
|
|
356
|
+
};
|
|
357
|
+
type Tag = {
|
|
358
|
+
/**
|
|
359
|
+
* The name of the tag.
|
|
360
|
+
*/
|
|
361
|
+
name: string;
|
|
362
|
+
/**
|
|
363
|
+
* The minimum value of `taggings_count` is 1, not 0.
|
|
364
|
+
* - The number of tags with this name that exist in the space, or
|
|
365
|
+
* - The number of draft or published stories with this tag, or
|
|
366
|
+
* - The number of deleted stories with this tag.
|
|
367
|
+
*/
|
|
368
|
+
taggings_count?: number;
|
|
369
|
+
/**
|
|
370
|
+
* Only visible when passing the `all_tags` parameter. The number of stories currently associated with the tag, corresponding to the <strong>Assigned items</strong> column in the <a href='https://www.storyblok.com/docs/manuals/stories#tags'>Tags tab</a>.
|
|
371
|
+
*/
|
|
372
|
+
tag_on_stories?: number;
|
|
373
|
+
};
|
|
374
|
+
type Story = ({
|
|
375
|
+
version?: 'draft';
|
|
376
|
+
} & DraftStory) | ({
|
|
377
|
+
version?: 'published';
|
|
378
|
+
} & PublishedStory);
|
|
379
|
+
type ListDatasourceEntriesData = {
|
|
380
|
+
body?: never;
|
|
381
|
+
path?: never;
|
|
382
|
+
query?: {
|
|
383
|
+
/**
|
|
384
|
+
* Datasource group id/slug.
|
|
385
|
+
*/
|
|
386
|
+
datasource?: string;
|
|
387
|
+
/**
|
|
388
|
+
* Dimension that you defined for your datasource.
|
|
389
|
+
*/
|
|
390
|
+
dimension?: string;
|
|
391
|
+
/**
|
|
392
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
393
|
+
*/
|
|
394
|
+
cv?: number;
|
|
395
|
+
/**
|
|
396
|
+
* The paginated page number.
|
|
397
|
+
*/
|
|
398
|
+
page?: number;
|
|
399
|
+
/**
|
|
400
|
+
* Number of items per page.
|
|
401
|
+
*/
|
|
402
|
+
per_page?: number;
|
|
403
|
+
};
|
|
404
|
+
url: '/v2/cdn/datasource_entries';
|
|
405
|
+
};
|
|
406
|
+
type ListDatasourcesData = {
|
|
407
|
+
body?: never;
|
|
408
|
+
path?: never;
|
|
409
|
+
query?: {
|
|
410
|
+
/**
|
|
411
|
+
* Filter by publication status:
|
|
412
|
+
* - `draft` – Retrieves draft stories
|
|
413
|
+
* - `published` – Retrieves published stories
|
|
414
|
+
*/
|
|
415
|
+
version?: 'draft' | 'published';
|
|
416
|
+
/**
|
|
417
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
418
|
+
*/
|
|
419
|
+
cv?: number;
|
|
420
|
+
/**
|
|
421
|
+
* Search string.
|
|
422
|
+
*/
|
|
423
|
+
search?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Filter by comma-separated IDs.
|
|
426
|
+
*/
|
|
427
|
+
by_ids?: string;
|
|
428
|
+
/**
|
|
429
|
+
* The paginated page number.
|
|
430
|
+
*/
|
|
431
|
+
page?: number;
|
|
432
|
+
/**
|
|
433
|
+
* Number of items per page.
|
|
434
|
+
*/
|
|
435
|
+
per_page?: number;
|
|
436
|
+
};
|
|
437
|
+
url: '/v2/cdn/datasources';
|
|
438
|
+
};
|
|
439
|
+
type GetDatasourceByIdData = {
|
|
440
|
+
body?: never;
|
|
441
|
+
path: {
|
|
442
|
+
/**
|
|
443
|
+
* Full_slug or numeric ID.
|
|
444
|
+
*/
|
|
445
|
+
id: string;
|
|
446
|
+
};
|
|
447
|
+
query?: {
|
|
448
|
+
/**
|
|
449
|
+
* Filter by publication status:
|
|
450
|
+
* - `draft` – Retrieves draft stories
|
|
451
|
+
* - `published` – Retrieves published stories
|
|
452
|
+
*/
|
|
453
|
+
version?: 'draft' | 'published';
|
|
454
|
+
/**
|
|
455
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
456
|
+
*/
|
|
457
|
+
cv?: number;
|
|
458
|
+
};
|
|
459
|
+
url: '/v2/cdn/datasources/{id}';
|
|
460
|
+
};
|
|
461
|
+
type ListCdnExperimentsV2Data = {
|
|
462
|
+
body?: never;
|
|
463
|
+
path?: never;
|
|
464
|
+
query?: {
|
|
465
|
+
/**
|
|
466
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
467
|
+
*/
|
|
468
|
+
cv?: number;
|
|
469
|
+
};
|
|
470
|
+
url: '/v2/cdn/experiments';
|
|
471
|
+
};
|
|
472
|
+
type ListLinksData = {
|
|
473
|
+
body?: never;
|
|
474
|
+
path?: never;
|
|
475
|
+
query?: {
|
|
476
|
+
/**
|
|
477
|
+
* Filter entries whose full slug starts with the given value. For example, `starts_with=de/beitraege`, `starts_with=en/posts`.
|
|
478
|
+
*/
|
|
479
|
+
starts_with?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Filter by publication status:
|
|
482
|
+
* - `draft` – Retrieves draft stories
|
|
483
|
+
* - `published` – Retrieves published stories
|
|
484
|
+
*/
|
|
485
|
+
version?: 'draft' | 'published';
|
|
486
|
+
/**
|
|
487
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
488
|
+
*/
|
|
489
|
+
cv?: number;
|
|
490
|
+
/**
|
|
491
|
+
* Default: `0`. Set to `1` to include `published_at`, `created_at`, and `updated_at` in the response.
|
|
492
|
+
*/
|
|
493
|
+
include_dates?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Filter links by story or folder UUID.
|
|
496
|
+
*/
|
|
497
|
+
by_uuid?: string;
|
|
498
|
+
/**
|
|
499
|
+
* Filter by folder ID to only return links from a particular folder. To return entries outside folders, set to `0`.
|
|
500
|
+
*/
|
|
501
|
+
with_parent?: string;
|
|
502
|
+
/**
|
|
503
|
+
* To enable pagination, set to `1`.
|
|
504
|
+
*/
|
|
505
|
+
paginated?: string;
|
|
506
|
+
/**
|
|
507
|
+
* The paginated page number.
|
|
508
|
+
*/
|
|
509
|
+
page?: number;
|
|
510
|
+
/**
|
|
511
|
+
* Number of items per page.
|
|
512
|
+
*/
|
|
513
|
+
per_page?: number;
|
|
514
|
+
};
|
|
515
|
+
url: '/v2/cdn/links';
|
|
516
|
+
};
|
|
517
|
+
type GetSpaceData = {
|
|
518
|
+
body?: never;
|
|
519
|
+
path?: never;
|
|
520
|
+
query?: {
|
|
521
|
+
/**
|
|
522
|
+
* Filter by publication status:
|
|
523
|
+
* - `draft` – Retrieves draft stories
|
|
524
|
+
* - `published` – Retrieves published stories
|
|
525
|
+
*/
|
|
526
|
+
version?: 'draft' | 'published';
|
|
527
|
+
};
|
|
528
|
+
url: '/v2/cdn/spaces/me';
|
|
529
|
+
};
|
|
530
|
+
type GetStoryByIdData = {
|
|
531
|
+
body?: never;
|
|
532
|
+
path: {
|
|
533
|
+
/**
|
|
534
|
+
* Full_slug or numeric ID or UUID.
|
|
535
|
+
*/
|
|
536
|
+
id: string;
|
|
537
|
+
};
|
|
538
|
+
query?: {
|
|
539
|
+
/**
|
|
540
|
+
* Added if you want to query by uuid.
|
|
541
|
+
*/
|
|
542
|
+
find_by?: string;
|
|
543
|
+
/**
|
|
544
|
+
* Filter by publication status:
|
|
545
|
+
* - `draft` – Retrieves draft stories
|
|
546
|
+
* - `published` – Retrieves published stories
|
|
547
|
+
*/
|
|
548
|
+
version?: 'draft' | 'published';
|
|
549
|
+
/**
|
|
550
|
+
* Used to resolve internal links of link fields used in a story. Resolved links are included in the links property of the response.
|
|
551
|
+
*/
|
|
552
|
+
resolve_links?: 'story' | 'url' | 'link';
|
|
553
|
+
/**
|
|
554
|
+
* Used to resolve up to two levels of links.
|
|
555
|
+
*/
|
|
556
|
+
resolve_links_level?: 1 | 2;
|
|
557
|
+
/**
|
|
558
|
+
* To resolve relations to other stories established via a multi-option/single-option field.
|
|
559
|
+
*/
|
|
560
|
+
resolve_relations?: string;
|
|
561
|
+
/**
|
|
562
|
+
* To access a story version associated with a specific release by providing the release ID.
|
|
563
|
+
*/
|
|
564
|
+
from_release?: string;
|
|
565
|
+
/**
|
|
566
|
+
* Retrieve stories of a specific content type.
|
|
567
|
+
*/
|
|
568
|
+
content_type?: string;
|
|
569
|
+
/**
|
|
570
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
571
|
+
*/
|
|
572
|
+
cv?: number;
|
|
573
|
+
/**
|
|
574
|
+
* Exclude specific fields from the response (comma-separated list).
|
|
575
|
+
*/
|
|
576
|
+
excluding_fields?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Used to obtain translated versions of one or more stories. Accepts any language code that is configured in the Storyblok space.
|
|
579
|
+
*/
|
|
580
|
+
language?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Used to define a custom fallback language to handle untranslated fields.
|
|
583
|
+
*/
|
|
584
|
+
fallback_lang?: string;
|
|
585
|
+
/**
|
|
586
|
+
* Resolve asset metadata (higher-tier plans only).
|
|
587
|
+
*/
|
|
588
|
+
resolve_assets?: number;
|
|
589
|
+
/**
|
|
590
|
+
* Force second-level relation resolution when first level exceeds limit.
|
|
591
|
+
*/
|
|
592
|
+
resolve_level?: 2;
|
|
593
|
+
/**
|
|
594
|
+
* has a value with string that contains null character
|
|
595
|
+
*/
|
|
596
|
+
param_with_null_char?: string;
|
|
597
|
+
};
|
|
598
|
+
url: '/v2/cdn/stories/{id}';
|
|
599
|
+
};
|
|
600
|
+
type GetStoryByIdResponses = {
|
|
601
|
+
/**
|
|
602
|
+
* Story Found.
|
|
603
|
+
*/
|
|
604
|
+
200: {
|
|
605
|
+
story: Story;
|
|
606
|
+
/**
|
|
607
|
+
* Cache version
|
|
608
|
+
*/
|
|
609
|
+
cv: number;
|
|
610
|
+
/**
|
|
611
|
+
* Rels
|
|
612
|
+
*/
|
|
613
|
+
rels?: Array<Story>;
|
|
614
|
+
links?: Array<LinkWithFullSlug | Link | Story>;
|
|
615
|
+
/**
|
|
616
|
+
* Array of story UUIDs returned instead of `rels` when relation resolution exceeds the space resolve limit
|
|
617
|
+
*/
|
|
618
|
+
rel_uuids?: Array<string>;
|
|
619
|
+
/**
|
|
620
|
+
* Array of story UUIDs returned instead of `links` when link resolution exceeds the space resolve limit
|
|
621
|
+
*/
|
|
622
|
+
link_uuids?: Array<string>;
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
type ListStoriesData = {
|
|
626
|
+
body?: never;
|
|
627
|
+
path?: never;
|
|
628
|
+
query?: {
|
|
629
|
+
/**
|
|
630
|
+
* Filter by publication status:
|
|
631
|
+
* - `draft` – Retrieves draft stories
|
|
632
|
+
* - `published` – Retrieves published stories
|
|
633
|
+
*/
|
|
634
|
+
version?: 'draft' | 'published';
|
|
635
|
+
/**
|
|
636
|
+
* Access a particular cached version of a published story using its Unix timestamp.
|
|
637
|
+
*/
|
|
638
|
+
cv?: number;
|
|
639
|
+
/**
|
|
640
|
+
* Filter entries whose full slug starts with the given value. For example, `starts_with=de/beitraege`, `starts_with=en/posts`.
|
|
641
|
+
*/
|
|
642
|
+
starts_with?: string;
|
|
643
|
+
/**
|
|
644
|
+
* Performs a full-text search by passing a search query. When the `sort_by` parameter is not included with the request,
|
|
645
|
+
* the search results are ordered based on the following:
|
|
646
|
+
* - By relevance of the `full_slug`
|
|
647
|
+
* - By relevance of the `name`
|
|
648
|
+
* - By the `position` in ascending order. The position is the numeric representation of the story's position in its folder.
|
|
649
|
+
*/
|
|
650
|
+
search_term?: string;
|
|
651
|
+
/**
|
|
652
|
+
* Sort stories in ascending or descending order by a specific property. Possible properties are all default story properties and any custom fields defined in the schema of the story type.
|
|
653
|
+
* Default story properties can be used like this:
|
|
654
|
+
* - `sort_by=created_at:desc`
|
|
655
|
+
* - `sort_by=slug:asc`
|
|
656
|
+
*
|
|
657
|
+
* Custom fields can be used like this:
|
|
658
|
+
* - `sort_by=content.meta_description:asc`
|
|
659
|
+
* - `sort_by=content.event_title:desc`
|
|
660
|
+
*
|
|
661
|
+
* By default, all custom fields are sorted as strings. To sort custom fields with numeric values, it needs to be specified whether they should be treated as float or integer. Examples:
|
|
662
|
+
* - `sort_by=content.price:asc:float`
|
|
663
|
+
* - `sort_by=content.event_number:asc:int`
|
|
664
|
+
*
|
|
665
|
+
* Different sorts can be chained using commas like this:
|
|
666
|
+
* - `sort_by=name:desc,slug:asc`
|
|
667
|
+
*
|
|
668
|
+
* There is also a possibility to sort values keeping the null (or empty) ones first or last:
|
|
669
|
+
* - `sort_by=path:desc:nulls_first`
|
|
670
|
+
* - `sort_by=path:desc:nulls_last`
|
|
671
|
+
*
|
|
672
|
+
* `nulls_last` is the default behavior.
|
|
673
|
+
*/
|
|
674
|
+
sort_by?: string;
|
|
675
|
+
/**
|
|
676
|
+
* Number of items per page.
|
|
677
|
+
*/
|
|
678
|
+
per_page?: number;
|
|
679
|
+
/**
|
|
680
|
+
* The paginated page number.
|
|
681
|
+
*/
|
|
682
|
+
page?: number;
|
|
683
|
+
/**
|
|
684
|
+
* Retrieve stories by comma-separated `full_slug`. It is possible to specify wildcards by using *.
|
|
685
|
+
*
|
|
686
|
+
* Examples:
|
|
687
|
+
* - `by_slugs=posts/my-third-post,posts/my-second-post`
|
|
688
|
+
* - `by_slugs=posts*`.
|
|
689
|
+
*/
|
|
690
|
+
by_slugs?: string;
|
|
691
|
+
/**
|
|
692
|
+
* Exclude stories by specifying comma-separated values of full_slug.
|
|
693
|
+
*/
|
|
694
|
+
excluding_slugs?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Retrieve stories published after the specified date (Format: yyyy-MM-dd HH:mm).
|
|
697
|
+
*/
|
|
698
|
+
published_at_gt?: string;
|
|
699
|
+
/**
|
|
700
|
+
* Retrieve stories published at or after the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
701
|
+
*/
|
|
702
|
+
published_at_gte?: string;
|
|
703
|
+
/**
|
|
704
|
+
* Retrieve stories published before the specified date (Format: yyyy-MM-dd HH:mm).
|
|
705
|
+
*/
|
|
706
|
+
published_at_lt?: string;
|
|
707
|
+
/**
|
|
708
|
+
* Retrieve stories published at or before the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
709
|
+
*/
|
|
710
|
+
published_at_lte?: string;
|
|
711
|
+
/**
|
|
712
|
+
* Retrieve stories first published after the specified date (Format: yyyy-MM-dd HH:mm).
|
|
713
|
+
*/
|
|
714
|
+
first_published_at_gt?: string;
|
|
715
|
+
/**
|
|
716
|
+
* Retrieve stories first published at or after the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
717
|
+
*/
|
|
718
|
+
first_published_at_gte?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Retrieve stories first published before the specified date (Format: yyyy-MM-dd HH:mm).
|
|
721
|
+
*/
|
|
722
|
+
first_published_at_lt?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Retrieve stories first published at or before the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
725
|
+
*/
|
|
726
|
+
first_published_at_lte?: string;
|
|
727
|
+
/**
|
|
728
|
+
* Retrieve stories updated after the specified date (Format: yyyy-MM-dd HH:mm).
|
|
729
|
+
*/
|
|
730
|
+
updated_at_gt?: string;
|
|
731
|
+
/**
|
|
732
|
+
* Filter records updated at or after the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
733
|
+
*/
|
|
734
|
+
updated_at_gte?: string;
|
|
735
|
+
/**
|
|
736
|
+
* Retrieve stories updated before the specified date (Format: yyyy-MM-dd HH:mm).
|
|
737
|
+
*/
|
|
738
|
+
updated_at_lt?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Filter records updated at or before the specified date. Supports ISO 8601 (e.g. 2025-07-16T08:00:00Z) and yyyy-MM-dd HH:mm formats.
|
|
741
|
+
*/
|
|
742
|
+
updated_at_lte?: string;
|
|
743
|
+
/**
|
|
744
|
+
* Retrieve stories that are in a particular workflow stage by providing a comma-separated list of workflow stage IDs. Workflow stage IDs can be retrieved via the [Management API](https://www.storyblok.com/docs/api/management/core-resources/workflow-stage/workflow-stage).
|
|
745
|
+
*/
|
|
746
|
+
in_workflow_stages?: string;
|
|
747
|
+
/**
|
|
748
|
+
* Retrieve stories of a specific content type.
|
|
749
|
+
*/
|
|
750
|
+
content_type?: string;
|
|
751
|
+
/**
|
|
752
|
+
* Retrieve stories located in the specified folder level. Only the immediate child stories are included in the response. Stories defined as root for the folder are excluded.
|
|
753
|
+
*/
|
|
754
|
+
level?: number;
|
|
755
|
+
/**
|
|
756
|
+
* To resolve relations to other stories established via a multi-option/single-option field.
|
|
757
|
+
*/
|
|
758
|
+
resolve_relations?: string;
|
|
759
|
+
/**
|
|
760
|
+
* Exclude specific stories by providing their IDs as a comma-separated string.
|
|
761
|
+
*/
|
|
762
|
+
excluding_ids?: string;
|
|
763
|
+
/**
|
|
764
|
+
* Retrieve specific stories by providing their UUIDs as a comma-separated string.
|
|
765
|
+
*/
|
|
766
|
+
by_uuids?: string;
|
|
767
|
+
/**
|
|
768
|
+
* Retrieve specific stories by providing their UUIDs as a comma-separated string. The order of the stories in the response matches the order in which the UUIDs are listed.
|
|
769
|
+
*/
|
|
770
|
+
by_uuids_ordered?: string;
|
|
771
|
+
/**
|
|
772
|
+
* Filter by comma-separated IDs.
|
|
773
|
+
*/
|
|
774
|
+
by_ids?: string;
|
|
775
|
+
/**
|
|
776
|
+
* Filter by specific tag(s). Multiple tags can be provided as a comma-separated string (treated like an OR operator).
|
|
777
|
+
*/
|
|
778
|
+
with_tag?: string;
|
|
779
|
+
/**
|
|
780
|
+
* Filter root‐level stories.
|
|
781
|
+
*/
|
|
782
|
+
is_startpage?: 0 | 1;
|
|
783
|
+
/**
|
|
784
|
+
* Used to resolve internal links of link fields used in a story. Resolved links are included in the links property of the response.
|
|
785
|
+
*/
|
|
786
|
+
resolve_links?: 'story' | 'url' | 'link';
|
|
787
|
+
/**
|
|
788
|
+
* Used to resolve up to two levels of links.
|
|
789
|
+
*/
|
|
790
|
+
resolve_links_level?: 1 | 2;
|
|
791
|
+
/**
|
|
792
|
+
* To access a story version associated with a specific release by providing the release ID.
|
|
793
|
+
*/
|
|
794
|
+
from_release?: string;
|
|
795
|
+
/**
|
|
796
|
+
* Used to define a custom fallback language to handle untranslated fields.
|
|
797
|
+
*/
|
|
798
|
+
fallback_lang?: string;
|
|
799
|
+
/**
|
|
800
|
+
* Used to obtain translated versions of one or more stories. Accepts any language code that is configured in the Storyblok space.
|
|
801
|
+
*/
|
|
802
|
+
language?: string;
|
|
803
|
+
/**
|
|
804
|
+
* Filter by attributes and operations.
|
|
805
|
+
*/
|
|
806
|
+
filter_query?: {
|
|
807
|
+
__or?: Array<{
|
|
808
|
+
[key: string]: {
|
|
809
|
+
[key: string]: string;
|
|
810
|
+
};
|
|
811
|
+
}>;
|
|
812
|
+
[key: string]: {
|
|
813
|
+
in?: string;
|
|
814
|
+
not_in?: string;
|
|
815
|
+
like?: string;
|
|
816
|
+
not_like?: string;
|
|
817
|
+
exists?: string;
|
|
818
|
+
in_array?: Array<string> | string;
|
|
819
|
+
all_in_array?: Array<string> | string;
|
|
820
|
+
gt_date?: string;
|
|
821
|
+
lt_date?: string;
|
|
822
|
+
gt_int?: number;
|
|
823
|
+
lt_int?: number;
|
|
824
|
+
gt_float?: number;
|
|
825
|
+
lt_float?: number;
|
|
826
|
+
is?: 'empty' | 'not_empty' | 'empty_array' | 'not_empty_array' | 'null' | 'not_null' | 'true' | 'false';
|
|
827
|
+
} | Array<{
|
|
828
|
+
[key: string]: {
|
|
829
|
+
[key: string]: string;
|
|
830
|
+
};
|
|
831
|
+
}> | undefined;
|
|
832
|
+
};
|
|
833
|
+
/**
|
|
834
|
+
* Exclude specific fields from the response (comma-separated list).
|
|
835
|
+
*/
|
|
836
|
+
excluding_fields?: string;
|
|
837
|
+
/**
|
|
838
|
+
* Resolve asset metadata (higher-tier plans only).
|
|
839
|
+
*/
|
|
840
|
+
resolve_assets?: 1;
|
|
841
|
+
/**
|
|
842
|
+
* Force second-level relation resolution when first level exceeds limit.
|
|
843
|
+
*/
|
|
844
|
+
resolve_level?: 2;
|
|
845
|
+
/**
|
|
846
|
+
* When set, returns only experiment variant stories
|
|
847
|
+
*/
|
|
848
|
+
only_variants?: 'true';
|
|
849
|
+
/**
|
|
850
|
+
* Non existing sort parameter
|
|
851
|
+
*/
|
|
852
|
+
non_existing_sort_by?: string;
|
|
853
|
+
/**
|
|
854
|
+
* Non existing updated_at_gt parameter
|
|
855
|
+
*/
|
|
856
|
+
non_existing_updated_at_gt?: string;
|
|
857
|
+
/**
|
|
858
|
+
* has a value with string that contains null character
|
|
859
|
+
*/
|
|
860
|
+
param_with_null_char?: string;
|
|
861
|
+
};
|
|
862
|
+
url: '/v2/cdn/stories';
|
|
863
|
+
};
|
|
864
|
+
type ListStoriesResponses = {
|
|
865
|
+
/**
|
|
866
|
+
* Stories listed.
|
|
867
|
+
*/
|
|
868
|
+
200: {
|
|
869
|
+
stories: Array<Story>;
|
|
870
|
+
/**
|
|
871
|
+
* Cache version
|
|
872
|
+
*/
|
|
873
|
+
cv: number;
|
|
874
|
+
/**
|
|
875
|
+
* Related stories (resolved relations)
|
|
876
|
+
*/
|
|
877
|
+
rels?: Array<Story>;
|
|
878
|
+
links?: Array<LinkWithFullSlug | Link | Story>;
|
|
879
|
+
/**
|
|
880
|
+
* Array of story UUIDs returned instead of `rels` when relation resolution exceeds the space resolve limit
|
|
881
|
+
*/
|
|
882
|
+
rel_uuids?: Array<string>;
|
|
883
|
+
/**
|
|
884
|
+
* Array of story UUIDs returned instead of `links` when link resolution exceeds the space resolve limit
|
|
885
|
+
*/
|
|
886
|
+
link_uuids?: Array<string>;
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
type ListTagsData = {
|
|
890
|
+
body?: never;
|
|
891
|
+
path?: never;
|
|
892
|
+
query?: {
|
|
893
|
+
/**
|
|
894
|
+
* Filter entries whose full slug starts with the given value. For example, `starts_with=de/beitraege`, `starts_with=en/posts`.
|
|
895
|
+
*/
|
|
896
|
+
starts_with?: string;
|
|
897
|
+
/**
|
|
898
|
+
* Filter by publication status:
|
|
899
|
+
* - `draft` – Retrieves draft stories
|
|
900
|
+
* - `published` – Retrieves published stories
|
|
901
|
+
*/
|
|
902
|
+
version?: 'draft' | 'published';
|
|
903
|
+
/**
|
|
904
|
+
* Filter by attributes and operations.
|
|
905
|
+
*/
|
|
906
|
+
filter_query?: {
|
|
907
|
+
[key: string]: {
|
|
908
|
+
in?: string;
|
|
909
|
+
not_in?: string;
|
|
910
|
+
like?: string;
|
|
911
|
+
not_like?: string;
|
|
912
|
+
};
|
|
913
|
+
};
|
|
914
|
+
};
|
|
915
|
+
url: '/v2/cdn/tags';
|
|
916
|
+
};
|
|
917
|
+
//#endregion
|
|
918
|
+
export { CdnExperiment, Datasource, DatasourceEntry, GetDatasourceByIdData, GetSpaceData, GetStoryByIdData, GetStoryByIdResponses, Link, LinkWithFullSlug, ListCdnExperimentsV2Data, ListDatasourceEntriesData, ListDatasourcesData, ListLinksData, ListStoriesData, ListStoriesResponses, ListTagsData, PublicSpace, Story, Tag };
|
|
919
|
+
//# sourceMappingURL=types.gen.d.cts.map
|