@ndla/types-backend 1.0.102 → 1.0.104
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/build/article-api.d.ts +1132 -31
- package/build/article-api.js +0 -37
- package/build/article-api.js.map +1 -1
- package/build/audio-api.d.ts +2178 -36
- package/build/audio-api.js +0 -37
- package/build/audio-api.js.map +1 -1
- package/build/concept-api.d.ts +1657 -34
- package/build/concept-api.js +0 -37
- package/build/concept-api.js.map +1 -1
- package/build/draft-api.d.ts +3193 -57
- package/build/draft-api.js +0 -37
- package/build/draft-api.js.map +1 -1
- package/build/frontpage-api.d.ts +998 -27
- package/build/frontpage-api.js +0 -37
- package/build/frontpage-api.js.map +1 -1
- package/build/image-api-openapi.d.ts +37 -1
- package/build/image-api.d.ts +2293 -34
- package/build/image-api.js +0 -37
- package/build/image-api.js.map +1 -1
- package/build/learningpath-api.d.ts +3092 -43
- package/build/learningpath-api.js +0 -37
- package/build/learningpath-api.js.map +1 -1
- package/build/myndla-api.d.ts +3880 -43
- package/build/myndla-api.js +0 -37
- package/build/myndla-api.js.map +1 -1
- package/build/oembed-proxy.d.ts +251 -9
- package/build/oembed-proxy.js +0 -37
- package/build/oembed-proxy.js.map +1 -1
- package/build/scripts/generate-openapi.js +5 -12
- package/build/scripts/generate-openapi.js.map +1 -1
- package/build/search-api.d.ts +1645 -66
- package/build/search-api.js +0 -37
- package/build/search-api.js.map +1 -1
- package/package.json +2 -2
- package/build/article-api-openapi.d.ts +0 -1104
- package/build/article-api-openapi.js +0 -3
- package/build/article-api-openapi.js.map +0 -1
- package/build/audio-api-openapi.d.ts +0 -2145
- package/build/audio-api-openapi.js +0 -3
- package/build/audio-api-openapi.js.map +0 -1
- package/build/concept-api-openapi.d.ts +0 -1626
- package/build/concept-api-openapi.js +0 -3
- package/build/concept-api-openapi.js.map +0 -1
- package/build/draft-api-openapi.d.ts +0 -3139
- package/build/draft-api-openapi.js +0 -3
- package/build/draft-api-openapi.js.map +0 -1
- package/build/frontpage-api-openapi.d.ts +0 -974
- package/build/frontpage-api-openapi.js +0 -3
- package/build/frontpage-api-openapi.js.map +0 -1
- package/build/learningpath-api-openapi.d.ts +0 -3052
- package/build/learningpath-api-openapi.js +0 -3
- package/build/learningpath-api-openapi.js.map +0 -1
- package/build/oembed-proxy-openapi.d.ts +0 -245
- package/build/oembed-proxy-openapi.js +0 -3
- package/build/oembed-proxy-openapi.js.map +0 -1
- package/build/search-api-openapi.d.ts +0 -1582
- package/build/search-api-openapi.js +0 -3
- package/build/search-api-openapi.js.map +0 -1
package/build/audio-api.d.ts
CHANGED
|
@@ -1,36 +1,2178 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
1
|
+
export type paths = {
|
|
2
|
+
"/audio-api/v1/audio": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Find audio files
|
|
11
|
+
* @description Shows all the audio files in the ndla.no database. You can search it too.
|
|
12
|
+
*/
|
|
13
|
+
get: operations["getAudio-apiV1Audio"];
|
|
14
|
+
put?: never;
|
|
15
|
+
/**
|
|
16
|
+
* Upload a new audio file with meta information
|
|
17
|
+
* @description Upload a new audio file with meta data
|
|
18
|
+
*/
|
|
19
|
+
post: operations["postAudio-apiV1Audio"];
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/audio-api/v1/audio/search": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
get?: never;
|
|
34
|
+
put?: never;
|
|
35
|
+
/**
|
|
36
|
+
* Find audio files
|
|
37
|
+
* @description Shows all the audio files in the ndla.no database. You can search it too.
|
|
38
|
+
*/
|
|
39
|
+
post: operations["postAudio-apiV1AudioSearch"];
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/audio-api/v1/audio/ids": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Fetch audio that matches ids parameter.
|
|
55
|
+
* @description Fetch audios that matches ids parameter.
|
|
56
|
+
*/
|
|
57
|
+
get: operations["getAudio-apiV1AudioIds"];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
"/audio-api/v1/audio/tag-search": {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Retrieves a list of all previously used tags in audios
|
|
75
|
+
* @description Retrieves a list of all previously used tags in audios
|
|
76
|
+
*/
|
|
77
|
+
get: operations["getAudio-apiV1AudioTag-search"];
|
|
78
|
+
put?: never;
|
|
79
|
+
post?: never;
|
|
80
|
+
delete?: never;
|
|
81
|
+
options?: never;
|
|
82
|
+
head?: never;
|
|
83
|
+
patch?: never;
|
|
84
|
+
trace?: never;
|
|
85
|
+
};
|
|
86
|
+
"/audio-api/v1/audio/{audio-id}": {
|
|
87
|
+
parameters: {
|
|
88
|
+
query?: never;
|
|
89
|
+
header?: never;
|
|
90
|
+
path?: never;
|
|
91
|
+
cookie?: never;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Fetch information for audio file
|
|
95
|
+
* @description Shows info of the audio with submitted id.
|
|
96
|
+
*/
|
|
97
|
+
get: operations["getAudio-apiV1AudioAudio-id"];
|
|
98
|
+
/**
|
|
99
|
+
* Upload audio for a different language or update metadata for an existing audio-file
|
|
100
|
+
* @description Update the metadata for an existing language, or upload metadata for a new language.
|
|
101
|
+
*/
|
|
102
|
+
put: operations["putAudio-apiV1AudioAudio-id"];
|
|
103
|
+
post?: never;
|
|
104
|
+
/**
|
|
105
|
+
* Deletes audio with the specified id
|
|
106
|
+
* @description Deletes audio with the specified id
|
|
107
|
+
*/
|
|
108
|
+
delete: operations["deleteAudio-apiV1AudioAudio-id"];
|
|
109
|
+
options?: never;
|
|
110
|
+
head?: never;
|
|
111
|
+
patch?: never;
|
|
112
|
+
trace?: never;
|
|
113
|
+
};
|
|
114
|
+
"/audio-api/v1/audio/{audio-id}/language/{language}": {
|
|
115
|
+
parameters: {
|
|
116
|
+
query?: never;
|
|
117
|
+
header?: never;
|
|
118
|
+
path?: never;
|
|
119
|
+
cookie?: never;
|
|
120
|
+
};
|
|
121
|
+
get?: never;
|
|
122
|
+
put?: never;
|
|
123
|
+
post?: never;
|
|
124
|
+
/**
|
|
125
|
+
* Delete language version of audio metadata.
|
|
126
|
+
* @description Delete language version of audio metadata.
|
|
127
|
+
*/
|
|
128
|
+
delete: operations["deleteAudio-apiV1AudioAudio-idLanguageLanguage"];
|
|
129
|
+
options?: never;
|
|
130
|
+
head?: never;
|
|
131
|
+
patch?: never;
|
|
132
|
+
trace?: never;
|
|
133
|
+
};
|
|
134
|
+
"/audio-api/v1/series": {
|
|
135
|
+
parameters: {
|
|
136
|
+
query?: never;
|
|
137
|
+
header?: never;
|
|
138
|
+
path?: never;
|
|
139
|
+
cookie?: never;
|
|
140
|
+
};
|
|
141
|
+
/**
|
|
142
|
+
* Find series
|
|
143
|
+
* @description Shows all the series. Also searchable.
|
|
144
|
+
*/
|
|
145
|
+
get: operations["getAudio-apiV1Series"];
|
|
146
|
+
put?: never;
|
|
147
|
+
/**
|
|
148
|
+
* Create a new series with meta information
|
|
149
|
+
* @description Create a new series with meta information
|
|
150
|
+
*/
|
|
151
|
+
post: operations["postAudio-apiV1Series"];
|
|
152
|
+
delete?: never;
|
|
153
|
+
options?: never;
|
|
154
|
+
head?: never;
|
|
155
|
+
patch?: never;
|
|
156
|
+
trace?: never;
|
|
157
|
+
};
|
|
158
|
+
"/audio-api/v1/series/search": {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: never;
|
|
161
|
+
header?: never;
|
|
162
|
+
path?: never;
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
get?: never;
|
|
166
|
+
put?: never;
|
|
167
|
+
/**
|
|
168
|
+
* Find series
|
|
169
|
+
* @description Shows all the series. Also searchable.
|
|
170
|
+
*/
|
|
171
|
+
post: operations["postAudio-apiV1SeriesSearch"];
|
|
172
|
+
delete?: never;
|
|
173
|
+
options?: never;
|
|
174
|
+
head?: never;
|
|
175
|
+
patch?: never;
|
|
176
|
+
trace?: never;
|
|
177
|
+
};
|
|
178
|
+
"/audio-api/v1/series/{series-id}": {
|
|
179
|
+
parameters: {
|
|
180
|
+
query?: never;
|
|
181
|
+
header?: never;
|
|
182
|
+
path?: never;
|
|
183
|
+
cookie?: never;
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Fetch information for series
|
|
187
|
+
* @description Shows info of the series with submitted id.
|
|
188
|
+
*/
|
|
189
|
+
get: operations["getAudio-apiV1SeriesSeries-id"];
|
|
190
|
+
/**
|
|
191
|
+
* Upload audio for a different language or update metadata for an existing audio-file
|
|
192
|
+
* @description Update the metadata for an existing language, or upload metadata for a new language.
|
|
193
|
+
*/
|
|
194
|
+
put: operations["putAudio-apiV1SeriesSeries-id"];
|
|
195
|
+
post?: never;
|
|
196
|
+
/**
|
|
197
|
+
* Deletes series with the specified id
|
|
198
|
+
* @description Deletes series with the specified id
|
|
199
|
+
*/
|
|
200
|
+
delete: operations["deleteAudio-apiV1SeriesSeries-id"];
|
|
201
|
+
options?: never;
|
|
202
|
+
head?: never;
|
|
203
|
+
patch?: never;
|
|
204
|
+
trace?: never;
|
|
205
|
+
};
|
|
206
|
+
"/audio-api/v1/series/{series-id}/language/{language}": {
|
|
207
|
+
parameters: {
|
|
208
|
+
query?: never;
|
|
209
|
+
header?: never;
|
|
210
|
+
path?: never;
|
|
211
|
+
cookie?: never;
|
|
212
|
+
};
|
|
213
|
+
get?: never;
|
|
214
|
+
put?: never;
|
|
215
|
+
post?: never;
|
|
216
|
+
/**
|
|
217
|
+
* Delete language version of audio metadata.
|
|
218
|
+
* @description Delete language version of audio metadata.
|
|
219
|
+
*/
|
|
220
|
+
delete: operations["deleteAudio-apiV1SeriesSeries-idLanguageLanguage"];
|
|
221
|
+
options?: never;
|
|
222
|
+
head?: never;
|
|
223
|
+
patch?: never;
|
|
224
|
+
trace?: never;
|
|
225
|
+
};
|
|
226
|
+
"/audio-api/v1/transcription/{videoId}/{language}/extract-audio": {
|
|
227
|
+
parameters: {
|
|
228
|
+
query?: never;
|
|
229
|
+
header?: never;
|
|
230
|
+
path?: never;
|
|
231
|
+
cookie?: never;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Get audio extraction status
|
|
235
|
+
* @description Get the status of the audio extraction from a Brightcove video.
|
|
236
|
+
*/
|
|
237
|
+
get: operations["getAudio-apiV1TranscriptionVideoidLanguageExtract-audio"];
|
|
238
|
+
put?: never;
|
|
239
|
+
/**
|
|
240
|
+
* Extract audio from video
|
|
241
|
+
* @description Extracts audio from a Brightcove video and uploads it to S3.
|
|
242
|
+
*/
|
|
243
|
+
post: operations["postAudio-apiV1TranscriptionVideoidLanguageExtract-audio"];
|
|
244
|
+
delete?: never;
|
|
245
|
+
options?: never;
|
|
246
|
+
head?: never;
|
|
247
|
+
patch?: never;
|
|
248
|
+
trace?: never;
|
|
249
|
+
};
|
|
250
|
+
"/audio-api/v1/transcription/video/{videoId}/{language}": {
|
|
251
|
+
parameters: {
|
|
252
|
+
query?: never;
|
|
253
|
+
header?: never;
|
|
254
|
+
path?: never;
|
|
255
|
+
cookie?: never;
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* Get the transcription status of a video
|
|
259
|
+
* @description Get the transcription of a video.
|
|
260
|
+
*/
|
|
261
|
+
get: operations["getAudio-apiV1TranscriptionVideoVideoidLanguage"];
|
|
262
|
+
put?: never;
|
|
263
|
+
/**
|
|
264
|
+
* Transcribe video
|
|
265
|
+
* @description Transcribes a video and uploads the transcription to S3.
|
|
266
|
+
*/
|
|
267
|
+
post: operations["postAudio-apiV1TranscriptionVideoVideoidLanguage"];
|
|
268
|
+
delete?: never;
|
|
269
|
+
options?: never;
|
|
270
|
+
head?: never;
|
|
271
|
+
patch?: never;
|
|
272
|
+
trace?: never;
|
|
273
|
+
};
|
|
274
|
+
"/audio-api/v1/transcription/audio/{audioName}/{audioId}/{language}": {
|
|
275
|
+
parameters: {
|
|
276
|
+
query?: never;
|
|
277
|
+
header?: never;
|
|
278
|
+
path?: never;
|
|
279
|
+
cookie?: never;
|
|
280
|
+
};
|
|
281
|
+
get?: never;
|
|
282
|
+
put?: never;
|
|
283
|
+
/**
|
|
284
|
+
* Transcribe audio
|
|
285
|
+
* @description Transcribes an audiofile and uploads the transcription to S3.
|
|
286
|
+
*/
|
|
287
|
+
post: operations["postAudio-apiV1TranscriptionAudioAudionameAudioidLanguage"];
|
|
288
|
+
delete?: never;
|
|
289
|
+
options?: never;
|
|
290
|
+
head?: never;
|
|
291
|
+
patch?: never;
|
|
292
|
+
trace?: never;
|
|
293
|
+
};
|
|
294
|
+
"/audio-api/v1/transcription/audio/{audioId}/{language}": {
|
|
295
|
+
parameters: {
|
|
296
|
+
query?: never;
|
|
297
|
+
header?: never;
|
|
298
|
+
path?: never;
|
|
299
|
+
cookie?: never;
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* Get the transcription status of an audiofile
|
|
303
|
+
* @description Get the transcription of an audiofile .
|
|
304
|
+
*/
|
|
305
|
+
get: operations["getAudio-apiV1TranscriptionAudioAudioidLanguage"];
|
|
306
|
+
put?: never;
|
|
307
|
+
post?: never;
|
|
308
|
+
delete?: never;
|
|
309
|
+
options?: never;
|
|
310
|
+
head?: never;
|
|
311
|
+
patch?: never;
|
|
312
|
+
trace?: never;
|
|
313
|
+
};
|
|
314
|
+
};
|
|
315
|
+
export type webhooks = Record<string, never>;
|
|
316
|
+
export type components = {
|
|
317
|
+
schemas: {
|
|
318
|
+
/** AllErrors */
|
|
319
|
+
AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
|
|
320
|
+
/**
|
|
321
|
+
* AudioDTO
|
|
322
|
+
* @description The audio file for this language
|
|
323
|
+
*/
|
|
324
|
+
AudioDTO: {
|
|
325
|
+
/** @description The path to where the audio is located */
|
|
326
|
+
url: string;
|
|
327
|
+
/** @description The mime type of the audio file */
|
|
328
|
+
mimeType: string;
|
|
329
|
+
/**
|
|
330
|
+
* Format: int64
|
|
331
|
+
* @description The size of the audio file
|
|
332
|
+
*/
|
|
333
|
+
fileSize: number;
|
|
334
|
+
/** @description The current language for this audio */
|
|
335
|
+
language: string;
|
|
336
|
+
};
|
|
337
|
+
/**
|
|
338
|
+
* AudioMetaInformationDTO
|
|
339
|
+
* @description Meta information about the audio object
|
|
340
|
+
*/
|
|
341
|
+
AudioMetaInformationDTO: {
|
|
342
|
+
/**
|
|
343
|
+
* Format: int64
|
|
344
|
+
* @description The unique id of this audio
|
|
345
|
+
*/
|
|
346
|
+
id: number;
|
|
347
|
+
/**
|
|
348
|
+
* Format: int32
|
|
349
|
+
* @description The revision number of this audio
|
|
350
|
+
*/
|
|
351
|
+
revision: number;
|
|
352
|
+
/** @description The title of the audio file */
|
|
353
|
+
title: components["schemas"]["TitleDTO"];
|
|
354
|
+
audioFile: components["schemas"]["AudioDTO"];
|
|
355
|
+
copyright: components["schemas"]["CopyrightDTO"];
|
|
356
|
+
tags: components["schemas"]["TagDTO"];
|
|
357
|
+
/** @description The languages available for this audio */
|
|
358
|
+
supportedLanguages: string[];
|
|
359
|
+
/** @description Type of audio. 'standard', or 'podcast'. */
|
|
360
|
+
audioType: string;
|
|
361
|
+
podcastMeta?: components["schemas"]["PodcastMetaDTO"];
|
|
362
|
+
/** @description Meta information about series if the audio is a podcast and a part of a series. */
|
|
363
|
+
series?: components["schemas"]["SeriesDTO"];
|
|
364
|
+
/** @description Manuscript for the audio */
|
|
365
|
+
manuscript?: components["schemas"]["ManuscriptDTO"];
|
|
366
|
+
/** @description The time of creation for the audio-file */
|
|
367
|
+
created: string;
|
|
368
|
+
/** @description The time of last update for the audio-file */
|
|
369
|
+
updated: string;
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
372
|
+
* AudioSummaryDTO
|
|
373
|
+
* @description Short summary of information about the audio
|
|
374
|
+
*/
|
|
375
|
+
AudioSummaryDTO: {
|
|
376
|
+
/**
|
|
377
|
+
* Format: int64
|
|
378
|
+
* @description The unique id of the audio
|
|
379
|
+
*/
|
|
380
|
+
id: number;
|
|
381
|
+
/** @description The title of the audio */
|
|
382
|
+
title: components["schemas"]["TitleDTO"];
|
|
383
|
+
/** @description The audioType. Possible values standard and podcast */
|
|
384
|
+
audioType: string;
|
|
385
|
+
/** @description The full url to where the complete information about the audio can be found */
|
|
386
|
+
url: string;
|
|
387
|
+
/** @description Describes the license of the audio */
|
|
388
|
+
license: string;
|
|
389
|
+
/** @description A list of available languages for this audio */
|
|
390
|
+
supportedLanguages: string[];
|
|
391
|
+
/** @description A manuscript for the audio */
|
|
392
|
+
manuscript?: components["schemas"]["ManuscriptDTO"];
|
|
393
|
+
podcastMeta?: components["schemas"]["PodcastMetaDTO"];
|
|
394
|
+
/** @description Series that the audio is part of */
|
|
395
|
+
series?: components["schemas"]["SeriesSummaryDTO"];
|
|
396
|
+
/** @description The time and date of last update */
|
|
397
|
+
lastUpdated: string;
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* AudioSummarySearchResultDTO
|
|
401
|
+
* @description Information about audio summary search-results
|
|
402
|
+
*/
|
|
403
|
+
AudioSummarySearchResultDTO: {
|
|
404
|
+
/**
|
|
405
|
+
* Format: int64
|
|
406
|
+
* @description The total number of articles matching this query
|
|
407
|
+
*/
|
|
408
|
+
totalCount: number;
|
|
409
|
+
/**
|
|
410
|
+
* Format: int32
|
|
411
|
+
* @description For which page results are shown from
|
|
412
|
+
*/
|
|
413
|
+
page?: number;
|
|
414
|
+
/**
|
|
415
|
+
* Format: int32
|
|
416
|
+
* @description The number of results per page
|
|
417
|
+
*/
|
|
418
|
+
pageSize: number;
|
|
419
|
+
/** @description The chosen search language */
|
|
420
|
+
language: string;
|
|
421
|
+
/** @description The search results */
|
|
422
|
+
results: components["schemas"]["AudioSummaryDTO"][];
|
|
423
|
+
};
|
|
424
|
+
/**
|
|
425
|
+
* AuthorDTO
|
|
426
|
+
* @description Information about an author
|
|
427
|
+
*/
|
|
428
|
+
AuthorDTO: {
|
|
429
|
+
type: components["schemas"]["ContributorType"];
|
|
430
|
+
/** @description The name of the of the author */
|
|
431
|
+
name: string;
|
|
432
|
+
};
|
|
433
|
+
/**
|
|
434
|
+
* ContributorType
|
|
435
|
+
* @description The description of the author. Eg. Photographer or Supplier
|
|
436
|
+
* @enum {string}
|
|
437
|
+
*/
|
|
438
|
+
ContributorType: "artist" | "cowriter" | "compiler" | "composer" | "correction" | "director" | "distributor" | "editorial" | "facilitator" | "idea" | "illustrator" | "linguistic" | "originator" | "photographer" | "processor" | "publisher" | "reader" | "rightsholder" | "scriptwriter" | "supplier" | "translator" | "writer";
|
|
439
|
+
/**
|
|
440
|
+
* CopyrightDTO
|
|
441
|
+
* @description Copyright information for the audio files
|
|
442
|
+
*/
|
|
443
|
+
CopyrightDTO: {
|
|
444
|
+
license: components["schemas"]["LicenseDTO"];
|
|
445
|
+
/** @description Reference to where the article is procured */
|
|
446
|
+
origin?: string;
|
|
447
|
+
/** @description List of creators */
|
|
448
|
+
creators: components["schemas"]["AuthorDTO"][];
|
|
449
|
+
/** @description List of processors */
|
|
450
|
+
processors: components["schemas"]["AuthorDTO"][];
|
|
451
|
+
/** @description List of rightsholders */
|
|
452
|
+
rightsholders: components["schemas"]["AuthorDTO"][];
|
|
453
|
+
/** @description Date from which the copyright is valid */
|
|
454
|
+
validFrom?: string;
|
|
455
|
+
/** @description Date to which the copyright is valid */
|
|
456
|
+
validTo?: string;
|
|
457
|
+
/** @description Whether or not the content has been processed */
|
|
458
|
+
processed: boolean;
|
|
459
|
+
};
|
|
460
|
+
/** CoverPhotoDTO */
|
|
461
|
+
CoverPhotoDTO: {
|
|
462
|
+
/** @description Id for the coverPhoto in image-api */
|
|
463
|
+
id: string;
|
|
464
|
+
/** @description Url to the coverPhoto */
|
|
465
|
+
url: string;
|
|
466
|
+
/** @description Alttext for the coverPhoto */
|
|
467
|
+
altText: string;
|
|
468
|
+
};
|
|
469
|
+
/**
|
|
470
|
+
* DescriptionDTO
|
|
471
|
+
* @description The description of the series
|
|
472
|
+
*/
|
|
473
|
+
DescriptionDTO: {
|
|
474
|
+
/** @description The description of the element */
|
|
475
|
+
description: string;
|
|
476
|
+
/** @description ISO 639-1 code that represents the language used in the description */
|
|
477
|
+
language: string;
|
|
478
|
+
};
|
|
479
|
+
/**
|
|
480
|
+
* ErrorBody
|
|
481
|
+
* @description Information about an error
|
|
482
|
+
*/
|
|
483
|
+
ErrorBody: {
|
|
484
|
+
/** @description Code stating the type of error */
|
|
485
|
+
code: string;
|
|
486
|
+
/** @description Description of the error */
|
|
487
|
+
description: string;
|
|
488
|
+
/** @description When the error occurred */
|
|
489
|
+
occurredAt: string;
|
|
490
|
+
/**
|
|
491
|
+
* Format: int32
|
|
492
|
+
* @description Numeric http status code
|
|
493
|
+
*/
|
|
494
|
+
statusCode: number;
|
|
495
|
+
};
|
|
496
|
+
/**
|
|
497
|
+
* LicenseDTO
|
|
498
|
+
* @description Describes the license of the article
|
|
499
|
+
*/
|
|
500
|
+
LicenseDTO: {
|
|
501
|
+
/** @description The name of the license */
|
|
502
|
+
license: string;
|
|
503
|
+
/** @description Description of the license */
|
|
504
|
+
description?: string;
|
|
505
|
+
/** @description Url to where the license can be found */
|
|
506
|
+
url?: string;
|
|
507
|
+
};
|
|
508
|
+
/** ManuscriptDTO */
|
|
509
|
+
ManuscriptDTO: {
|
|
510
|
+
/** @description The manuscript of the audio file */
|
|
511
|
+
manuscript: string;
|
|
512
|
+
/** @description ISO 639-1 code that represents the language used in the manuscript */
|
|
513
|
+
language: string;
|
|
514
|
+
};
|
|
515
|
+
/** MetaDataAndFileForm */
|
|
516
|
+
MetaDataAndFileForm: {
|
|
517
|
+
metadata: components["schemas"]["NewAudioMetaInformationDTO"];
|
|
518
|
+
/** Format: binary */
|
|
519
|
+
file: Blob;
|
|
520
|
+
};
|
|
521
|
+
/** MetaDataAndOptFileForm */
|
|
522
|
+
MetaDataAndOptFileForm: {
|
|
523
|
+
metadata: components["schemas"]["UpdatedAudioMetaInformationDTO"];
|
|
524
|
+
/** Format: binary */
|
|
525
|
+
file?: Blob;
|
|
526
|
+
};
|
|
527
|
+
/**
|
|
528
|
+
* NewAudioMetaInformationDTO
|
|
529
|
+
* @description Meta information about the audio object
|
|
530
|
+
*/
|
|
531
|
+
NewAudioMetaInformationDTO: {
|
|
532
|
+
/** @description The title of the audio file */
|
|
533
|
+
title: string;
|
|
534
|
+
/** @description ISO 639-1 code that represents the language used in this resource */
|
|
535
|
+
language: string;
|
|
536
|
+
copyright: components["schemas"]["CopyrightDTO"];
|
|
537
|
+
/** @description Tags for this audio file */
|
|
538
|
+
tags: string[];
|
|
539
|
+
/** @description Type of audio. 'standard', or 'podcast', defaults to 'standard' */
|
|
540
|
+
audioType?: string;
|
|
541
|
+
podcastMeta?: components["schemas"]["NewPodcastMetaDTO"];
|
|
542
|
+
/**
|
|
543
|
+
* Format: int64
|
|
544
|
+
* @description Id of series if the audio is a podcast and a part of a series.
|
|
545
|
+
*/
|
|
546
|
+
seriesId?: number;
|
|
547
|
+
/** @description Manuscript for the audio */
|
|
548
|
+
manuscript?: string;
|
|
549
|
+
};
|
|
550
|
+
/**
|
|
551
|
+
* NewPodcastMetaDTO
|
|
552
|
+
* @description Meta information about podcast, only applicable if audioType is 'podcast'.
|
|
553
|
+
*/
|
|
554
|
+
NewPodcastMetaDTO: {
|
|
555
|
+
/** @description Introduction for the podcast */
|
|
556
|
+
introduction: string;
|
|
557
|
+
/** @description Cover photo for the podcast */
|
|
558
|
+
coverPhotoId: string;
|
|
559
|
+
/** @description Cover photo alttext for the podcast */
|
|
560
|
+
coverPhotoAltText: string;
|
|
561
|
+
};
|
|
562
|
+
/**
|
|
563
|
+
* NewSeriesDTO
|
|
564
|
+
* @description Meta information about podcast series
|
|
565
|
+
*/
|
|
566
|
+
NewSeriesDTO: {
|
|
567
|
+
/** @description Header for the series */
|
|
568
|
+
title: string;
|
|
569
|
+
/** @description Description for the series */
|
|
570
|
+
description: string;
|
|
571
|
+
/** @description Cover photo for the series */
|
|
572
|
+
coverPhotoId: string;
|
|
573
|
+
/** @description Cover photo alttext for the series */
|
|
574
|
+
coverPhotoAltText: string;
|
|
575
|
+
/** @description Ids for episodes of the series */
|
|
576
|
+
episodes: number[];
|
|
577
|
+
/** @description ISO 639-1 code that represents the language used in this resource */
|
|
578
|
+
language: string;
|
|
579
|
+
/**
|
|
580
|
+
* Format: int32
|
|
581
|
+
* @description Revision number of this series (Only used to do locking when updating)
|
|
582
|
+
*/
|
|
583
|
+
revision?: number;
|
|
584
|
+
/** @description Specifies if this series generates rss-feed */
|
|
585
|
+
hasRSS?: boolean;
|
|
586
|
+
};
|
|
587
|
+
/**
|
|
588
|
+
* NotFoundWithSupportedLanguages
|
|
589
|
+
* @description Information about an error
|
|
590
|
+
*/
|
|
591
|
+
NotFoundWithSupportedLanguages: {
|
|
592
|
+
/** @description Code stating the type of error */
|
|
593
|
+
code: string;
|
|
594
|
+
/** @description Description of the error */
|
|
595
|
+
description: string;
|
|
596
|
+
/** @description When the error occurred */
|
|
597
|
+
occurredAt: string;
|
|
598
|
+
/** @description List of supported languages */
|
|
599
|
+
supportedLanguages?: string[];
|
|
600
|
+
/**
|
|
601
|
+
* Format: int32
|
|
602
|
+
* @description Numeric http status code
|
|
603
|
+
*/
|
|
604
|
+
statusCode: number;
|
|
605
|
+
};
|
|
606
|
+
/**
|
|
607
|
+
* PodcastMetaDTO
|
|
608
|
+
* @description Meta information about podcast, only applicable if audioType is 'podcast'.
|
|
609
|
+
*/
|
|
610
|
+
PodcastMetaDTO: {
|
|
611
|
+
/** @description Introduction for the podcast */
|
|
612
|
+
introduction: string;
|
|
613
|
+
/** @description Cover photo for the podcast */
|
|
614
|
+
coverPhoto: components["schemas"]["CoverPhotoDTO"];
|
|
615
|
+
/** @description ISO 639-1 code that represents the language used in the title */
|
|
616
|
+
language: string;
|
|
617
|
+
};
|
|
618
|
+
/**
|
|
619
|
+
* SearchParamsDTO
|
|
620
|
+
* @description The search parameters
|
|
621
|
+
*/
|
|
622
|
+
SearchParamsDTO: {
|
|
623
|
+
/** @description Return only audio with titles, alt-texts or tags matching the specified query. */
|
|
624
|
+
query?: string;
|
|
625
|
+
/** @description Return only audio with provided license. */
|
|
626
|
+
license?: string;
|
|
627
|
+
/** @description The ISO 639-1 language code describing language used in query-params */
|
|
628
|
+
language?: string;
|
|
629
|
+
/**
|
|
630
|
+
* Format: int32
|
|
631
|
+
* @description The page number of the search hits to display.
|
|
632
|
+
*/
|
|
633
|
+
page?: number;
|
|
634
|
+
/**
|
|
635
|
+
* Format: int32
|
|
636
|
+
* @description The number of search hits to display for each page.
|
|
637
|
+
*/
|
|
638
|
+
pageSize?: number;
|
|
639
|
+
sort?: components["schemas"]["Sort"];
|
|
640
|
+
/** @description A search context retrieved from the response header of a previous search. */
|
|
641
|
+
scrollId?: string;
|
|
642
|
+
/** @description Type of audio to filter by. */
|
|
643
|
+
audioType?: string;
|
|
644
|
+
/**
|
|
645
|
+
* @description Filter result by whether they are a part of a series or not.
|
|
646
|
+
* 'true' will return only audios that are a part of a series.
|
|
647
|
+
* 'false' will return only audios that are NOT a part of a series.
|
|
648
|
+
* Not specifying will return both audios that are a part of a series and not.
|
|
649
|
+
*/
|
|
650
|
+
filterBySeries?: boolean;
|
|
651
|
+
/** @description Return all matched audios whether they exist on selected language or not. */
|
|
652
|
+
fallback?: boolean;
|
|
653
|
+
};
|
|
654
|
+
/** SeriesDTO */
|
|
655
|
+
SeriesDTO: {
|
|
656
|
+
/**
|
|
657
|
+
* Format: int64
|
|
658
|
+
* @description The unique id of this series
|
|
659
|
+
*/
|
|
660
|
+
id: number;
|
|
661
|
+
/**
|
|
662
|
+
* Format: int32
|
|
663
|
+
* @description The revision number of this series
|
|
664
|
+
*/
|
|
665
|
+
revision: number;
|
|
666
|
+
/** @description The title of the series */
|
|
667
|
+
title: components["schemas"]["TitleDTO"];
|
|
668
|
+
description: components["schemas"]["DescriptionDTO"];
|
|
669
|
+
/** @description Cover photo for the series */
|
|
670
|
+
coverPhoto: components["schemas"]["CoverPhotoDTO"];
|
|
671
|
+
/** @description The metainfo of the episodes in the series */
|
|
672
|
+
episodes?: components["schemas"]["AudioMetaInformationDTO"][];
|
|
673
|
+
/** @description A list of available languages for this series */
|
|
674
|
+
supportedLanguages: string[];
|
|
675
|
+
/** @description Specifies if this series generates rss-feed */
|
|
676
|
+
hasRSS: boolean;
|
|
677
|
+
};
|
|
678
|
+
/**
|
|
679
|
+
* SeriesSearchParamsDTO
|
|
680
|
+
* @description The search parameters
|
|
681
|
+
*/
|
|
682
|
+
SeriesSearchParamsDTO: {
|
|
683
|
+
/** @description Return only series with titles, alt-texts or tags matching the specified query. */
|
|
684
|
+
query?: string;
|
|
685
|
+
/** @description The ISO 639-1 language code describing language used in query-params */
|
|
686
|
+
language?: string;
|
|
687
|
+
/**
|
|
688
|
+
* Format: int32
|
|
689
|
+
* @description The page number of the search hits to display.
|
|
690
|
+
*/
|
|
691
|
+
page?: number;
|
|
692
|
+
/**
|
|
693
|
+
* Format: int32
|
|
694
|
+
* @description The number of search hits to display for each page.
|
|
695
|
+
*/
|
|
696
|
+
pageSize?: number;
|
|
697
|
+
sort?: components["schemas"]["Sort"];
|
|
698
|
+
/** @description A search context retrieved from the response header of a previous search. */
|
|
699
|
+
scrollId?: string;
|
|
700
|
+
/** @description Return all matched series whether they exist on selected language or not. */
|
|
701
|
+
fallback?: boolean;
|
|
702
|
+
};
|
|
703
|
+
/** SeriesSummaryDTO */
|
|
704
|
+
SeriesSummaryDTO: {
|
|
705
|
+
/**
|
|
706
|
+
* Format: int64
|
|
707
|
+
* @description The unique id of the series
|
|
708
|
+
*/
|
|
709
|
+
id: number;
|
|
710
|
+
/** @description The title of the series */
|
|
711
|
+
title: components["schemas"]["TitleDTO"];
|
|
712
|
+
description: components["schemas"]["DescriptionDTO"];
|
|
713
|
+
/** @description A list of available languages for this series */
|
|
714
|
+
supportedLanguages: string[];
|
|
715
|
+
/** @description A list of episode summaries */
|
|
716
|
+
episodes?: components["schemas"]["AudioSummaryDTO"][];
|
|
717
|
+
/** @description Cover photo for the series */
|
|
718
|
+
coverPhoto: components["schemas"]["CoverPhotoDTO"];
|
|
719
|
+
};
|
|
720
|
+
/**
|
|
721
|
+
* SeriesSummarySearchResultDTO
|
|
722
|
+
* @description Information about series summary search-results
|
|
723
|
+
*/
|
|
724
|
+
SeriesSummarySearchResultDTO: {
|
|
725
|
+
/**
|
|
726
|
+
* Format: int64
|
|
727
|
+
* @description The total number of articles matching this query
|
|
728
|
+
*/
|
|
729
|
+
totalCount: number;
|
|
730
|
+
/**
|
|
731
|
+
* Format: int32
|
|
732
|
+
* @description For which page results are shown from
|
|
733
|
+
*/
|
|
734
|
+
page?: number;
|
|
735
|
+
/**
|
|
736
|
+
* Format: int32
|
|
737
|
+
* @description The number of results per page
|
|
738
|
+
*/
|
|
739
|
+
pageSize: number;
|
|
740
|
+
/** @description The chosen search language */
|
|
741
|
+
language: string;
|
|
742
|
+
/** @description The search results */
|
|
743
|
+
results: components["schemas"]["SeriesSummaryDTO"][];
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* Sort
|
|
747
|
+
* @description The sorting used on results. Default is by -relevance.
|
|
748
|
+
* @enum {string}
|
|
749
|
+
*/
|
|
750
|
+
Sort: "-relevance" | "relevance" | "-title" | "title" | "-lastUpdated" | "lastUpdated" | "-id" | "id";
|
|
751
|
+
/**
|
|
752
|
+
* TagDTO
|
|
753
|
+
* @description Tags for this audio file
|
|
754
|
+
*/
|
|
755
|
+
TagDTO: {
|
|
756
|
+
/** @description The searchable tag. */
|
|
757
|
+
tags: string[];
|
|
758
|
+
/** @description ISO 639-1 code that represents the language used in tag */
|
|
759
|
+
language: string;
|
|
760
|
+
};
|
|
761
|
+
/**
|
|
762
|
+
* TagsSearchResultDTO
|
|
763
|
+
* @description Information about tags-search-results
|
|
764
|
+
*/
|
|
765
|
+
TagsSearchResultDTO: {
|
|
766
|
+
/**
|
|
767
|
+
* Format: int64
|
|
768
|
+
* @description The total number of tags matching this query
|
|
769
|
+
*/
|
|
770
|
+
totalCount: number;
|
|
771
|
+
/**
|
|
772
|
+
* Format: int32
|
|
773
|
+
* @description For which page results are shown from
|
|
774
|
+
*/
|
|
775
|
+
page: number;
|
|
776
|
+
/**
|
|
777
|
+
* Format: int32
|
|
778
|
+
* @description The number of results per page
|
|
779
|
+
*/
|
|
780
|
+
pageSize: number;
|
|
781
|
+
/** @description The chosen search language */
|
|
782
|
+
language: string;
|
|
783
|
+
/** @description The search results */
|
|
784
|
+
results: string[];
|
|
785
|
+
};
|
|
786
|
+
/** TitleDTO */
|
|
787
|
+
TitleDTO: {
|
|
788
|
+
/** @description The title of the audio file */
|
|
789
|
+
title: string;
|
|
790
|
+
/** @description ISO 639-1 code that represents the language used in the title */
|
|
791
|
+
language: string;
|
|
792
|
+
};
|
|
793
|
+
/**
|
|
794
|
+
* TranscriptionResultDTO
|
|
795
|
+
* @description The result of a transcription job
|
|
796
|
+
*/
|
|
797
|
+
TranscriptionResultDTO: {
|
|
798
|
+
/** @description The status of the transcription job */
|
|
799
|
+
status: string;
|
|
800
|
+
/** @description The transcription of the audio */
|
|
801
|
+
transcription?: string;
|
|
802
|
+
};
|
|
803
|
+
/**
|
|
804
|
+
* UpdatedAudioMetaInformationDTO
|
|
805
|
+
* @description Meta information about the audio object
|
|
806
|
+
*/
|
|
807
|
+
UpdatedAudioMetaInformationDTO: {
|
|
808
|
+
/**
|
|
809
|
+
* Format: int32
|
|
810
|
+
* @description The revision number of this audio
|
|
811
|
+
*/
|
|
812
|
+
revision: number;
|
|
813
|
+
/** @description The title of the audio file */
|
|
814
|
+
title: string;
|
|
815
|
+
/** @description ISO 639-1 code that represents the language used in this resource */
|
|
816
|
+
language: string;
|
|
817
|
+
copyright: components["schemas"]["CopyrightDTO"];
|
|
818
|
+
/** @description Tags for this audio file */
|
|
819
|
+
tags: string[];
|
|
820
|
+
/** @description Type of audio. 'standard', or 'podcast', defaults to 'standard' */
|
|
821
|
+
audioType?: string;
|
|
822
|
+
podcastMeta?: components["schemas"]["NewPodcastMetaDTO"];
|
|
823
|
+
/**
|
|
824
|
+
* Format: int64
|
|
825
|
+
* @description Id of series if the audio is a podcast and a part of a series.
|
|
826
|
+
*/
|
|
827
|
+
seriesId?: number;
|
|
828
|
+
/** @description Manuscript for the audio */
|
|
829
|
+
manuscript?: string;
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* ValidationErrorBody
|
|
833
|
+
* @description Information about an error
|
|
834
|
+
*/
|
|
835
|
+
ValidationErrorBody: {
|
|
836
|
+
/** @description Code stating the type of error */
|
|
837
|
+
code: string;
|
|
838
|
+
/** @description Description of the error */
|
|
839
|
+
description: string;
|
|
840
|
+
/** @description When the error occurred */
|
|
841
|
+
occurredAt: string;
|
|
842
|
+
/** @description List of validation messages */
|
|
843
|
+
messages?: components["schemas"]["ValidationMessage"][];
|
|
844
|
+
/**
|
|
845
|
+
* Format: int32
|
|
846
|
+
* @description Numeric http status code
|
|
847
|
+
*/
|
|
848
|
+
statusCode: number;
|
|
849
|
+
};
|
|
850
|
+
/**
|
|
851
|
+
* ValidationMessage
|
|
852
|
+
* @description A message describing a validation error on a specific field
|
|
853
|
+
*/
|
|
854
|
+
ValidationMessage: {
|
|
855
|
+
/** @description The field the error occured in */
|
|
856
|
+
field: string;
|
|
857
|
+
/** @description The validation message */
|
|
858
|
+
message: string;
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
responses: never;
|
|
862
|
+
parameters: never;
|
|
863
|
+
requestBodies: never;
|
|
864
|
+
headers: never;
|
|
865
|
+
pathItems: never;
|
|
866
|
+
};
|
|
867
|
+
export type AllErrors = components['schemas']['AllErrors'];
|
|
868
|
+
export type AudioDTO = components['schemas']['AudioDTO'];
|
|
869
|
+
export type AudioMetaInformationDTO = components['schemas']['AudioMetaInformationDTO'];
|
|
870
|
+
export type AudioSummaryDTO = components['schemas']['AudioSummaryDTO'];
|
|
871
|
+
export type AudioSummarySearchResultDTO = components['schemas']['AudioSummarySearchResultDTO'];
|
|
872
|
+
export type AuthorDTO = components['schemas']['AuthorDTO'];
|
|
873
|
+
export type ContributorType = components['schemas']['ContributorType'];
|
|
874
|
+
export type CopyrightDTO = components['schemas']['CopyrightDTO'];
|
|
875
|
+
export type CoverPhotoDTO = components['schemas']['CoverPhotoDTO'];
|
|
876
|
+
export type DescriptionDTO = components['schemas']['DescriptionDTO'];
|
|
877
|
+
export type ErrorBody = components['schemas']['ErrorBody'];
|
|
878
|
+
export type LicenseDTO = components['schemas']['LicenseDTO'];
|
|
879
|
+
export type ManuscriptDTO = components['schemas']['ManuscriptDTO'];
|
|
880
|
+
export type MetaDataAndFileForm = components['schemas']['MetaDataAndFileForm'];
|
|
881
|
+
export type MetaDataAndOptFileForm = components['schemas']['MetaDataAndOptFileForm'];
|
|
882
|
+
export type NewAudioMetaInformationDTO = components['schemas']['NewAudioMetaInformationDTO'];
|
|
883
|
+
export type NewPodcastMetaDTO = components['schemas']['NewPodcastMetaDTO'];
|
|
884
|
+
export type NewSeriesDTO = components['schemas']['NewSeriesDTO'];
|
|
885
|
+
export type NotFoundWithSupportedLanguages = components['schemas']['NotFoundWithSupportedLanguages'];
|
|
886
|
+
export type PodcastMetaDTO = components['schemas']['PodcastMetaDTO'];
|
|
887
|
+
export type SearchParamsDTO = components['schemas']['SearchParamsDTO'];
|
|
888
|
+
export type SeriesDTO = components['schemas']['SeriesDTO'];
|
|
889
|
+
export type SeriesSearchParamsDTO = components['schemas']['SeriesSearchParamsDTO'];
|
|
890
|
+
export type SeriesSummaryDTO = components['schemas']['SeriesSummaryDTO'];
|
|
891
|
+
export type SeriesSummarySearchResultDTO = components['schemas']['SeriesSummarySearchResultDTO'];
|
|
892
|
+
export type Sort = components['schemas']['Sort'];
|
|
893
|
+
export type TagDTO = components['schemas']['TagDTO'];
|
|
894
|
+
export type TagsSearchResultDTO = components['schemas']['TagsSearchResultDTO'];
|
|
895
|
+
export type TitleDTO = components['schemas']['TitleDTO'];
|
|
896
|
+
export type TranscriptionResultDTO = components['schemas']['TranscriptionResultDTO'];
|
|
897
|
+
export type UpdatedAudioMetaInformationDTO = components['schemas']['UpdatedAudioMetaInformationDTO'];
|
|
898
|
+
export type ValidationErrorBody = components['schemas']['ValidationErrorBody'];
|
|
899
|
+
export type ValidationMessage = components['schemas']['ValidationMessage'];
|
|
900
|
+
export type $defs = Record<string, never>;
|
|
901
|
+
export interface operations {
|
|
902
|
+
"getAudio-apiV1Audio": {
|
|
903
|
+
parameters: {
|
|
904
|
+
query?: {
|
|
905
|
+
/** @description Return only results with titles or tags matching the specified query. */
|
|
906
|
+
query?: string;
|
|
907
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
908
|
+
language?: string;
|
|
909
|
+
/** @description Return only audio with provided license. */
|
|
910
|
+
license?: string;
|
|
911
|
+
/**
|
|
912
|
+
* @description The sorting used on results.
|
|
913
|
+
* The following are supported: -relevance, relevance, -title, title, -lastUpdated, lastUpdated, -id, id.
|
|
914
|
+
* Default is by -relevance (desc) when query is set, and title (asc) when query is empty.
|
|
915
|
+
*/
|
|
916
|
+
sort?: string;
|
|
917
|
+
/** @description The page number of the search hits to display. */
|
|
918
|
+
page?: number;
|
|
919
|
+
/** @description The number of search hits to display for each page. Defaults to 10 and max is 10000. */
|
|
920
|
+
"page-size"?: number;
|
|
921
|
+
/**
|
|
922
|
+
* @description A unique string obtained from a search you want to keep scrolling in. To obtain one from a search, provide one of the following values: [0,initial,start,first].
|
|
923
|
+
* When scrolling, the parameters from the initial search is used, except in the case of 'language'.
|
|
924
|
+
* This value may change between scrolls. Always use the one in the latest scroll result (The context, if unused, dies after 1m).
|
|
925
|
+
* If you are not paginating past 10000 hits, you can ignore this and use 'page' and 'page-size' instead.
|
|
926
|
+
*/
|
|
927
|
+
"search-context"?: string;
|
|
928
|
+
/**
|
|
929
|
+
* @description Only return types of the specified value.
|
|
930
|
+
* Possible values are 'podcast, standard'
|
|
931
|
+
*/
|
|
932
|
+
"audio-type"?: string;
|
|
933
|
+
/**
|
|
934
|
+
* @description Filter result by whether they are a part of a series or not.
|
|
935
|
+
* 'true' will return only audios that are a part of a series.
|
|
936
|
+
* 'false' will return only audios that are NOT a part of a series.
|
|
937
|
+
* Not specifying will return both audios that are a part of a series and not.
|
|
938
|
+
*/
|
|
939
|
+
"filter-by-series"?: boolean;
|
|
940
|
+
/** @description Fallback to existing language if language is specified. */
|
|
941
|
+
fallback?: boolean;
|
|
942
|
+
};
|
|
943
|
+
header?: never;
|
|
944
|
+
path?: never;
|
|
945
|
+
cookie?: never;
|
|
946
|
+
};
|
|
947
|
+
requestBody?: never;
|
|
948
|
+
responses: {
|
|
949
|
+
200: {
|
|
950
|
+
headers: {
|
|
951
|
+
"search-context"?: string;
|
|
952
|
+
[name: string]: unknown;
|
|
953
|
+
};
|
|
954
|
+
content: {
|
|
955
|
+
"application/json": components["schemas"]["AudioSummarySearchResultDTO"];
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
400: {
|
|
959
|
+
headers: {
|
|
960
|
+
[name: string]: unknown;
|
|
961
|
+
};
|
|
962
|
+
content: {
|
|
963
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
964
|
+
};
|
|
965
|
+
};
|
|
966
|
+
404: {
|
|
967
|
+
headers: {
|
|
968
|
+
[name: string]: unknown;
|
|
969
|
+
};
|
|
970
|
+
content: {
|
|
971
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
972
|
+
};
|
|
973
|
+
};
|
|
974
|
+
500: {
|
|
975
|
+
headers: {
|
|
976
|
+
[name: string]: unknown;
|
|
977
|
+
};
|
|
978
|
+
content: {
|
|
979
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
"postAudio-apiV1Audio": {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: never;
|
|
987
|
+
header?: never;
|
|
988
|
+
path?: never;
|
|
989
|
+
cookie?: never;
|
|
990
|
+
};
|
|
991
|
+
requestBody: {
|
|
992
|
+
content: {
|
|
993
|
+
"multipart/form-data": components["schemas"]["MetaDataAndFileForm"];
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
responses: {
|
|
997
|
+
200: {
|
|
998
|
+
headers: {
|
|
999
|
+
[name: string]: unknown;
|
|
1000
|
+
};
|
|
1001
|
+
content: {
|
|
1002
|
+
"application/json": components["schemas"]["AudioMetaInformationDTO"];
|
|
1003
|
+
};
|
|
1004
|
+
};
|
|
1005
|
+
400: {
|
|
1006
|
+
headers: {
|
|
1007
|
+
[name: string]: unknown;
|
|
1008
|
+
};
|
|
1009
|
+
content: {
|
|
1010
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
401: {
|
|
1014
|
+
headers: {
|
|
1015
|
+
[name: string]: unknown;
|
|
1016
|
+
};
|
|
1017
|
+
content: {
|
|
1018
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1019
|
+
};
|
|
1020
|
+
};
|
|
1021
|
+
403: {
|
|
1022
|
+
headers: {
|
|
1023
|
+
[name: string]: unknown;
|
|
1024
|
+
};
|
|
1025
|
+
content: {
|
|
1026
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
404: {
|
|
1030
|
+
headers: {
|
|
1031
|
+
[name: string]: unknown;
|
|
1032
|
+
};
|
|
1033
|
+
content: {
|
|
1034
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
413: {
|
|
1038
|
+
headers: {
|
|
1039
|
+
[name: string]: unknown;
|
|
1040
|
+
};
|
|
1041
|
+
content: {
|
|
1042
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
500: {
|
|
1046
|
+
headers: {
|
|
1047
|
+
[name: string]: unknown;
|
|
1048
|
+
};
|
|
1049
|
+
content: {
|
|
1050
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
};
|
|
1054
|
+
};
|
|
1055
|
+
"postAudio-apiV1AudioSearch": {
|
|
1056
|
+
parameters: {
|
|
1057
|
+
query?: never;
|
|
1058
|
+
header?: never;
|
|
1059
|
+
path?: never;
|
|
1060
|
+
cookie?: never;
|
|
1061
|
+
};
|
|
1062
|
+
requestBody: {
|
|
1063
|
+
content: {
|
|
1064
|
+
"application/json": components["schemas"]["SearchParamsDTO"];
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
responses: {
|
|
1068
|
+
200: {
|
|
1069
|
+
headers: {
|
|
1070
|
+
"search-context"?: string;
|
|
1071
|
+
[name: string]: unknown;
|
|
1072
|
+
};
|
|
1073
|
+
content: {
|
|
1074
|
+
"application/json": components["schemas"]["AudioSummarySearchResultDTO"];
|
|
1075
|
+
};
|
|
1076
|
+
};
|
|
1077
|
+
400: {
|
|
1078
|
+
headers: {
|
|
1079
|
+
[name: string]: unknown;
|
|
1080
|
+
};
|
|
1081
|
+
content: {
|
|
1082
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
404: {
|
|
1086
|
+
headers: {
|
|
1087
|
+
[name: string]: unknown;
|
|
1088
|
+
};
|
|
1089
|
+
content: {
|
|
1090
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1091
|
+
};
|
|
1092
|
+
};
|
|
1093
|
+
500: {
|
|
1094
|
+
headers: {
|
|
1095
|
+
[name: string]: unknown;
|
|
1096
|
+
};
|
|
1097
|
+
content: {
|
|
1098
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
};
|
|
1103
|
+
"getAudio-apiV1AudioIds": {
|
|
1104
|
+
parameters: {
|
|
1105
|
+
query?: {
|
|
1106
|
+
/** @description Return only audios that have one of the provided ids. To provide multiple ids, separate by comma (,). */
|
|
1107
|
+
ids?: number[];
|
|
1108
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1109
|
+
language?: string;
|
|
1110
|
+
};
|
|
1111
|
+
header?: never;
|
|
1112
|
+
path?: never;
|
|
1113
|
+
cookie?: never;
|
|
1114
|
+
};
|
|
1115
|
+
requestBody?: never;
|
|
1116
|
+
responses: {
|
|
1117
|
+
200: {
|
|
1118
|
+
headers: {
|
|
1119
|
+
[name: string]: unknown;
|
|
1120
|
+
};
|
|
1121
|
+
content: {
|
|
1122
|
+
"application/json": components["schemas"]["AudioMetaInformationDTO"][];
|
|
1123
|
+
};
|
|
1124
|
+
};
|
|
1125
|
+
400: {
|
|
1126
|
+
headers: {
|
|
1127
|
+
[name: string]: unknown;
|
|
1128
|
+
};
|
|
1129
|
+
content: {
|
|
1130
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
404: {
|
|
1134
|
+
headers: {
|
|
1135
|
+
[name: string]: unknown;
|
|
1136
|
+
};
|
|
1137
|
+
content: {
|
|
1138
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
500: {
|
|
1142
|
+
headers: {
|
|
1143
|
+
[name: string]: unknown;
|
|
1144
|
+
};
|
|
1145
|
+
content: {
|
|
1146
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1147
|
+
};
|
|
1148
|
+
};
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
"getAudio-apiV1AudioTag-search": {
|
|
1152
|
+
parameters: {
|
|
1153
|
+
query?: {
|
|
1154
|
+
/** @description Return only results with titles or tags matching the specified query. */
|
|
1155
|
+
query?: string;
|
|
1156
|
+
/** @description The number of search hits to display for each page. Defaults to 10 and max is 10000. */
|
|
1157
|
+
"page-size"?: number;
|
|
1158
|
+
/** @description The page number of the search hits to display. */
|
|
1159
|
+
page?: number;
|
|
1160
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1161
|
+
language?: string;
|
|
1162
|
+
};
|
|
1163
|
+
header?: never;
|
|
1164
|
+
path?: never;
|
|
1165
|
+
cookie?: never;
|
|
1166
|
+
};
|
|
1167
|
+
requestBody?: never;
|
|
1168
|
+
responses: {
|
|
1169
|
+
200: {
|
|
1170
|
+
headers: {
|
|
1171
|
+
[name: string]: unknown;
|
|
1172
|
+
};
|
|
1173
|
+
content: {
|
|
1174
|
+
"application/json": components["schemas"]["TagsSearchResultDTO"];
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
400: {
|
|
1178
|
+
headers: {
|
|
1179
|
+
[name: string]: unknown;
|
|
1180
|
+
};
|
|
1181
|
+
content: {
|
|
1182
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1183
|
+
};
|
|
1184
|
+
};
|
|
1185
|
+
404: {
|
|
1186
|
+
headers: {
|
|
1187
|
+
[name: string]: unknown;
|
|
1188
|
+
};
|
|
1189
|
+
content: {
|
|
1190
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1191
|
+
};
|
|
1192
|
+
};
|
|
1193
|
+
500: {
|
|
1194
|
+
headers: {
|
|
1195
|
+
[name: string]: unknown;
|
|
1196
|
+
};
|
|
1197
|
+
content: {
|
|
1198
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
"getAudio-apiV1AudioAudio-id": {
|
|
1204
|
+
parameters: {
|
|
1205
|
+
query?: {
|
|
1206
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1207
|
+
language?: string;
|
|
1208
|
+
};
|
|
1209
|
+
header?: never;
|
|
1210
|
+
path: {
|
|
1211
|
+
/** @description Id of audio. */
|
|
1212
|
+
"audio-id": number;
|
|
1213
|
+
};
|
|
1214
|
+
cookie?: never;
|
|
1215
|
+
};
|
|
1216
|
+
requestBody?: never;
|
|
1217
|
+
responses: {
|
|
1218
|
+
200: {
|
|
1219
|
+
headers: {
|
|
1220
|
+
[name: string]: unknown;
|
|
1221
|
+
};
|
|
1222
|
+
content: {
|
|
1223
|
+
"application/json": components["schemas"]["AudioMetaInformationDTO"];
|
|
1224
|
+
};
|
|
1225
|
+
};
|
|
1226
|
+
400: {
|
|
1227
|
+
headers: {
|
|
1228
|
+
[name: string]: unknown;
|
|
1229
|
+
};
|
|
1230
|
+
content: {
|
|
1231
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1232
|
+
};
|
|
1233
|
+
};
|
|
1234
|
+
404: {
|
|
1235
|
+
headers: {
|
|
1236
|
+
[name: string]: unknown;
|
|
1237
|
+
};
|
|
1238
|
+
content: {
|
|
1239
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
500: {
|
|
1243
|
+
headers: {
|
|
1244
|
+
[name: string]: unknown;
|
|
1245
|
+
};
|
|
1246
|
+
content: {
|
|
1247
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1248
|
+
};
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
1252
|
+
"putAudio-apiV1AudioAudio-id": {
|
|
1253
|
+
parameters: {
|
|
1254
|
+
query?: never;
|
|
1255
|
+
header?: never;
|
|
1256
|
+
path: {
|
|
1257
|
+
/** @description Id of audio. */
|
|
1258
|
+
"audio-id": number;
|
|
1259
|
+
};
|
|
1260
|
+
cookie?: never;
|
|
1261
|
+
};
|
|
1262
|
+
requestBody: {
|
|
1263
|
+
content: {
|
|
1264
|
+
"multipart/form-data": components["schemas"]["MetaDataAndOptFileForm"];
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
responses: {
|
|
1268
|
+
200: {
|
|
1269
|
+
headers: {
|
|
1270
|
+
[name: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
content: {
|
|
1273
|
+
"application/json": components["schemas"]["AudioMetaInformationDTO"];
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
400: {
|
|
1277
|
+
headers: {
|
|
1278
|
+
[name: string]: unknown;
|
|
1279
|
+
};
|
|
1280
|
+
content: {
|
|
1281
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
401: {
|
|
1285
|
+
headers: {
|
|
1286
|
+
[name: string]: unknown;
|
|
1287
|
+
};
|
|
1288
|
+
content: {
|
|
1289
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1290
|
+
};
|
|
1291
|
+
};
|
|
1292
|
+
403: {
|
|
1293
|
+
headers: {
|
|
1294
|
+
[name: string]: unknown;
|
|
1295
|
+
};
|
|
1296
|
+
content: {
|
|
1297
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1298
|
+
};
|
|
1299
|
+
};
|
|
1300
|
+
404: {
|
|
1301
|
+
headers: {
|
|
1302
|
+
[name: string]: unknown;
|
|
1303
|
+
};
|
|
1304
|
+
content: {
|
|
1305
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
413: {
|
|
1309
|
+
headers: {
|
|
1310
|
+
[name: string]: unknown;
|
|
1311
|
+
};
|
|
1312
|
+
content: {
|
|
1313
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1314
|
+
};
|
|
1315
|
+
};
|
|
1316
|
+
500: {
|
|
1317
|
+
headers: {
|
|
1318
|
+
[name: string]: unknown;
|
|
1319
|
+
};
|
|
1320
|
+
content: {
|
|
1321
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1322
|
+
};
|
|
1323
|
+
};
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
"deleteAudio-apiV1AudioAudio-id": {
|
|
1327
|
+
parameters: {
|
|
1328
|
+
query?: never;
|
|
1329
|
+
header?: never;
|
|
1330
|
+
path: {
|
|
1331
|
+
/** @description Id of audio. */
|
|
1332
|
+
"audio-id": number;
|
|
1333
|
+
};
|
|
1334
|
+
cookie?: never;
|
|
1335
|
+
};
|
|
1336
|
+
requestBody?: never;
|
|
1337
|
+
responses: {
|
|
1338
|
+
204: {
|
|
1339
|
+
headers: {
|
|
1340
|
+
[name: string]: unknown;
|
|
1341
|
+
};
|
|
1342
|
+
content?: never;
|
|
1343
|
+
};
|
|
1344
|
+
400: {
|
|
1345
|
+
headers: {
|
|
1346
|
+
[name: string]: unknown;
|
|
1347
|
+
};
|
|
1348
|
+
content: {
|
|
1349
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1350
|
+
};
|
|
1351
|
+
};
|
|
1352
|
+
401: {
|
|
1353
|
+
headers: {
|
|
1354
|
+
[name: string]: unknown;
|
|
1355
|
+
};
|
|
1356
|
+
content: {
|
|
1357
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
403: {
|
|
1361
|
+
headers: {
|
|
1362
|
+
[name: string]: unknown;
|
|
1363
|
+
};
|
|
1364
|
+
content: {
|
|
1365
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1366
|
+
};
|
|
1367
|
+
};
|
|
1368
|
+
404: {
|
|
1369
|
+
headers: {
|
|
1370
|
+
[name: string]: unknown;
|
|
1371
|
+
};
|
|
1372
|
+
content: {
|
|
1373
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1374
|
+
};
|
|
1375
|
+
};
|
|
1376
|
+
500: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1382
|
+
};
|
|
1383
|
+
};
|
|
1384
|
+
};
|
|
1385
|
+
};
|
|
1386
|
+
"deleteAudio-apiV1AudioAudio-idLanguageLanguage": {
|
|
1387
|
+
parameters: {
|
|
1388
|
+
query?: never;
|
|
1389
|
+
header?: never;
|
|
1390
|
+
path: {
|
|
1391
|
+
/** @description Id of audio. */
|
|
1392
|
+
"audio-id": number;
|
|
1393
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1394
|
+
language: string;
|
|
1395
|
+
};
|
|
1396
|
+
cookie?: never;
|
|
1397
|
+
};
|
|
1398
|
+
requestBody?: never;
|
|
1399
|
+
responses: {
|
|
1400
|
+
200: {
|
|
1401
|
+
headers: {
|
|
1402
|
+
[name: string]: unknown;
|
|
1403
|
+
};
|
|
1404
|
+
content: {
|
|
1405
|
+
"application/json": components["schemas"]["AudioMetaInformationDTO"];
|
|
1406
|
+
};
|
|
1407
|
+
};
|
|
1408
|
+
204: {
|
|
1409
|
+
headers: {
|
|
1410
|
+
[name: string]: unknown;
|
|
1411
|
+
};
|
|
1412
|
+
content?: never;
|
|
1413
|
+
};
|
|
1414
|
+
400: {
|
|
1415
|
+
headers: {
|
|
1416
|
+
[name: string]: unknown;
|
|
1417
|
+
};
|
|
1418
|
+
content: {
|
|
1419
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1420
|
+
};
|
|
1421
|
+
};
|
|
1422
|
+
401: {
|
|
1423
|
+
headers: {
|
|
1424
|
+
[name: string]: unknown;
|
|
1425
|
+
};
|
|
1426
|
+
content: {
|
|
1427
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
403: {
|
|
1431
|
+
headers: {
|
|
1432
|
+
[name: string]: unknown;
|
|
1433
|
+
};
|
|
1434
|
+
content: {
|
|
1435
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1436
|
+
};
|
|
1437
|
+
};
|
|
1438
|
+
404: {
|
|
1439
|
+
headers: {
|
|
1440
|
+
[name: string]: unknown;
|
|
1441
|
+
};
|
|
1442
|
+
content: {
|
|
1443
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1444
|
+
};
|
|
1445
|
+
};
|
|
1446
|
+
500: {
|
|
1447
|
+
headers: {
|
|
1448
|
+
[name: string]: unknown;
|
|
1449
|
+
};
|
|
1450
|
+
content: {
|
|
1451
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1455
|
+
};
|
|
1456
|
+
"getAudio-apiV1Series": {
|
|
1457
|
+
parameters: {
|
|
1458
|
+
query?: {
|
|
1459
|
+
/** @description Return only results with titles or tags matching the specified query. */
|
|
1460
|
+
query?: string;
|
|
1461
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1462
|
+
language?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* @description The sorting used on results.
|
|
1465
|
+
* The following are supported: -relevance, relevance, -title, title, -lastUpdated, lastUpdated, -id, id.
|
|
1466
|
+
* Default is by -relevance (desc) when query is set, and title (asc) when query is empty.
|
|
1467
|
+
*/
|
|
1468
|
+
sort?: string;
|
|
1469
|
+
/** @description The page number of the search hits to display. */
|
|
1470
|
+
page?: number;
|
|
1471
|
+
/** @description The number of search hits to display for each page. Defaults to 10 and max is 10000. */
|
|
1472
|
+
"page-size"?: number;
|
|
1473
|
+
/**
|
|
1474
|
+
* @description A unique string obtained from a search you want to keep scrolling in. To obtain one from a search, provide one of the following values: [0,initial,start,first].
|
|
1475
|
+
* When scrolling, the parameters from the initial search is used, except in the case of 'language'.
|
|
1476
|
+
* This value may change between scrolls. Always use the one in the latest scroll result (The context, if unused, dies after 1m).
|
|
1477
|
+
* If you are not paginating past 10000 hits, you can ignore this and use 'page' and 'page-size' instead.
|
|
1478
|
+
*/
|
|
1479
|
+
"search-context"?: string;
|
|
1480
|
+
/** @description Fallback to existing language if language is specified. */
|
|
1481
|
+
fallback?: boolean;
|
|
1482
|
+
};
|
|
1483
|
+
header?: never;
|
|
1484
|
+
path?: never;
|
|
1485
|
+
cookie?: never;
|
|
1486
|
+
};
|
|
1487
|
+
requestBody?: never;
|
|
1488
|
+
responses: {
|
|
1489
|
+
200: {
|
|
1490
|
+
headers: {
|
|
1491
|
+
"search-context"?: string;
|
|
1492
|
+
[name: string]: unknown;
|
|
1493
|
+
};
|
|
1494
|
+
content: {
|
|
1495
|
+
"application/json": components["schemas"]["SeriesSummarySearchResultDTO"];
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
400: {
|
|
1499
|
+
headers: {
|
|
1500
|
+
[name: string]: unknown;
|
|
1501
|
+
};
|
|
1502
|
+
content: {
|
|
1503
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1504
|
+
};
|
|
1505
|
+
};
|
|
1506
|
+
404: {
|
|
1507
|
+
headers: {
|
|
1508
|
+
[name: string]: unknown;
|
|
1509
|
+
};
|
|
1510
|
+
content: {
|
|
1511
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1512
|
+
};
|
|
1513
|
+
};
|
|
1514
|
+
500: {
|
|
1515
|
+
headers: {
|
|
1516
|
+
[name: string]: unknown;
|
|
1517
|
+
};
|
|
1518
|
+
content: {
|
|
1519
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1520
|
+
};
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
"postAudio-apiV1Series": {
|
|
1525
|
+
parameters: {
|
|
1526
|
+
query?: never;
|
|
1527
|
+
header?: never;
|
|
1528
|
+
path?: never;
|
|
1529
|
+
cookie?: never;
|
|
1530
|
+
};
|
|
1531
|
+
requestBody: {
|
|
1532
|
+
content: {
|
|
1533
|
+
"application/json": components["schemas"]["NewSeriesDTO"];
|
|
1534
|
+
};
|
|
1535
|
+
};
|
|
1536
|
+
responses: {
|
|
1537
|
+
201: {
|
|
1538
|
+
headers: {
|
|
1539
|
+
[name: string]: unknown;
|
|
1540
|
+
};
|
|
1541
|
+
content: {
|
|
1542
|
+
"application/json": components["schemas"]["SeriesDTO"];
|
|
1543
|
+
};
|
|
1544
|
+
};
|
|
1545
|
+
400: {
|
|
1546
|
+
headers: {
|
|
1547
|
+
[name: string]: unknown;
|
|
1548
|
+
};
|
|
1549
|
+
content: {
|
|
1550
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
401: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
403: {
|
|
1562
|
+
headers: {
|
|
1563
|
+
[name: string]: unknown;
|
|
1564
|
+
};
|
|
1565
|
+
content: {
|
|
1566
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1567
|
+
};
|
|
1568
|
+
};
|
|
1569
|
+
404: {
|
|
1570
|
+
headers: {
|
|
1571
|
+
[name: string]: unknown;
|
|
1572
|
+
};
|
|
1573
|
+
content: {
|
|
1574
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1575
|
+
};
|
|
1576
|
+
};
|
|
1577
|
+
500: {
|
|
1578
|
+
headers: {
|
|
1579
|
+
[name: string]: unknown;
|
|
1580
|
+
};
|
|
1581
|
+
content: {
|
|
1582
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
"postAudio-apiV1SeriesSearch": {
|
|
1588
|
+
parameters: {
|
|
1589
|
+
query?: never;
|
|
1590
|
+
header?: never;
|
|
1591
|
+
path?: never;
|
|
1592
|
+
cookie?: never;
|
|
1593
|
+
};
|
|
1594
|
+
requestBody: {
|
|
1595
|
+
content: {
|
|
1596
|
+
"application/json": components["schemas"]["SeriesSearchParamsDTO"];
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
responses: {
|
|
1600
|
+
200: {
|
|
1601
|
+
headers: {
|
|
1602
|
+
"search-context"?: string;
|
|
1603
|
+
[name: string]: unknown;
|
|
1604
|
+
};
|
|
1605
|
+
content: {
|
|
1606
|
+
"application/json": components["schemas"]["SeriesSummarySearchResultDTO"];
|
|
1607
|
+
};
|
|
1608
|
+
};
|
|
1609
|
+
400: {
|
|
1610
|
+
headers: {
|
|
1611
|
+
[name: string]: unknown;
|
|
1612
|
+
};
|
|
1613
|
+
content: {
|
|
1614
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
404: {
|
|
1618
|
+
headers: {
|
|
1619
|
+
[name: string]: unknown;
|
|
1620
|
+
};
|
|
1621
|
+
content: {
|
|
1622
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1623
|
+
};
|
|
1624
|
+
};
|
|
1625
|
+
500: {
|
|
1626
|
+
headers: {
|
|
1627
|
+
[name: string]: unknown;
|
|
1628
|
+
};
|
|
1629
|
+
content: {
|
|
1630
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
"getAudio-apiV1SeriesSeries-id": {
|
|
1636
|
+
parameters: {
|
|
1637
|
+
query?: {
|
|
1638
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1639
|
+
language?: string;
|
|
1640
|
+
};
|
|
1641
|
+
header?: never;
|
|
1642
|
+
path: {
|
|
1643
|
+
/** @description Id of series. */
|
|
1644
|
+
"series-id": number;
|
|
1645
|
+
};
|
|
1646
|
+
cookie?: never;
|
|
1647
|
+
};
|
|
1648
|
+
requestBody?: never;
|
|
1649
|
+
responses: {
|
|
1650
|
+
200: {
|
|
1651
|
+
headers: {
|
|
1652
|
+
[name: string]: unknown;
|
|
1653
|
+
};
|
|
1654
|
+
content: {
|
|
1655
|
+
"application/json": components["schemas"]["SeriesDTO"];
|
|
1656
|
+
};
|
|
1657
|
+
};
|
|
1658
|
+
400: {
|
|
1659
|
+
headers: {
|
|
1660
|
+
[name: string]: unknown;
|
|
1661
|
+
};
|
|
1662
|
+
content: {
|
|
1663
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
404: {
|
|
1667
|
+
headers: {
|
|
1668
|
+
[name: string]: unknown;
|
|
1669
|
+
};
|
|
1670
|
+
content: {
|
|
1671
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1672
|
+
};
|
|
1673
|
+
};
|
|
1674
|
+
500: {
|
|
1675
|
+
headers: {
|
|
1676
|
+
[name: string]: unknown;
|
|
1677
|
+
};
|
|
1678
|
+
content: {
|
|
1679
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1680
|
+
};
|
|
1681
|
+
};
|
|
1682
|
+
};
|
|
1683
|
+
};
|
|
1684
|
+
"putAudio-apiV1SeriesSeries-id": {
|
|
1685
|
+
parameters: {
|
|
1686
|
+
query?: never;
|
|
1687
|
+
header?: never;
|
|
1688
|
+
path: {
|
|
1689
|
+
/** @description Id of series. */
|
|
1690
|
+
"series-id": number;
|
|
1691
|
+
};
|
|
1692
|
+
cookie?: never;
|
|
1693
|
+
};
|
|
1694
|
+
requestBody: {
|
|
1695
|
+
content: {
|
|
1696
|
+
"application/json": components["schemas"]["NewSeriesDTO"];
|
|
1697
|
+
};
|
|
1698
|
+
};
|
|
1699
|
+
responses: {
|
|
1700
|
+
200: {
|
|
1701
|
+
headers: {
|
|
1702
|
+
[name: string]: unknown;
|
|
1703
|
+
};
|
|
1704
|
+
content: {
|
|
1705
|
+
"application/json": components["schemas"]["SeriesDTO"];
|
|
1706
|
+
};
|
|
1707
|
+
};
|
|
1708
|
+
400: {
|
|
1709
|
+
headers: {
|
|
1710
|
+
[name: string]: unknown;
|
|
1711
|
+
};
|
|
1712
|
+
content: {
|
|
1713
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1714
|
+
};
|
|
1715
|
+
};
|
|
1716
|
+
401: {
|
|
1717
|
+
headers: {
|
|
1718
|
+
[name: string]: unknown;
|
|
1719
|
+
};
|
|
1720
|
+
content: {
|
|
1721
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1722
|
+
};
|
|
1723
|
+
};
|
|
1724
|
+
403: {
|
|
1725
|
+
headers: {
|
|
1726
|
+
[name: string]: unknown;
|
|
1727
|
+
};
|
|
1728
|
+
content: {
|
|
1729
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
404: {
|
|
1733
|
+
headers: {
|
|
1734
|
+
[name: string]: unknown;
|
|
1735
|
+
};
|
|
1736
|
+
content: {
|
|
1737
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
500: {
|
|
1741
|
+
headers: {
|
|
1742
|
+
[name: string]: unknown;
|
|
1743
|
+
};
|
|
1744
|
+
content: {
|
|
1745
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1746
|
+
};
|
|
1747
|
+
};
|
|
1748
|
+
};
|
|
1749
|
+
};
|
|
1750
|
+
"deleteAudio-apiV1SeriesSeries-id": {
|
|
1751
|
+
parameters: {
|
|
1752
|
+
query?: never;
|
|
1753
|
+
header?: never;
|
|
1754
|
+
path: {
|
|
1755
|
+
/** @description Id of series. */
|
|
1756
|
+
"series-id": number;
|
|
1757
|
+
};
|
|
1758
|
+
cookie?: never;
|
|
1759
|
+
};
|
|
1760
|
+
requestBody?: never;
|
|
1761
|
+
responses: {
|
|
1762
|
+
204: {
|
|
1763
|
+
headers: {
|
|
1764
|
+
[name: string]: unknown;
|
|
1765
|
+
};
|
|
1766
|
+
content?: never;
|
|
1767
|
+
};
|
|
1768
|
+
400: {
|
|
1769
|
+
headers: {
|
|
1770
|
+
[name: string]: unknown;
|
|
1771
|
+
};
|
|
1772
|
+
content: {
|
|
1773
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1774
|
+
};
|
|
1775
|
+
};
|
|
1776
|
+
403: {
|
|
1777
|
+
headers: {
|
|
1778
|
+
[name: string]: unknown;
|
|
1779
|
+
};
|
|
1780
|
+
content: {
|
|
1781
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
404: {
|
|
1785
|
+
headers: {
|
|
1786
|
+
[name: string]: unknown;
|
|
1787
|
+
};
|
|
1788
|
+
content: {
|
|
1789
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
500: {
|
|
1793
|
+
headers: {
|
|
1794
|
+
[name: string]: unknown;
|
|
1795
|
+
};
|
|
1796
|
+
content: {
|
|
1797
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1798
|
+
};
|
|
1799
|
+
};
|
|
1800
|
+
};
|
|
1801
|
+
};
|
|
1802
|
+
"deleteAudio-apiV1SeriesSeries-idLanguageLanguage": {
|
|
1803
|
+
parameters: {
|
|
1804
|
+
query?: never;
|
|
1805
|
+
header?: never;
|
|
1806
|
+
path: {
|
|
1807
|
+
/** @description Id of series. */
|
|
1808
|
+
"series-id": number;
|
|
1809
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1810
|
+
language: string;
|
|
1811
|
+
};
|
|
1812
|
+
cookie?: never;
|
|
1813
|
+
};
|
|
1814
|
+
requestBody?: never;
|
|
1815
|
+
responses: {
|
|
1816
|
+
200: {
|
|
1817
|
+
headers: {
|
|
1818
|
+
[name: string]: unknown;
|
|
1819
|
+
};
|
|
1820
|
+
content: {
|
|
1821
|
+
"application/json": components["schemas"]["SeriesDTO"];
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
204: {
|
|
1825
|
+
headers: {
|
|
1826
|
+
[name: string]: unknown;
|
|
1827
|
+
};
|
|
1828
|
+
content?: never;
|
|
1829
|
+
};
|
|
1830
|
+
400: {
|
|
1831
|
+
headers: {
|
|
1832
|
+
[name: string]: unknown;
|
|
1833
|
+
};
|
|
1834
|
+
content: {
|
|
1835
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1836
|
+
};
|
|
1837
|
+
};
|
|
1838
|
+
401: {
|
|
1839
|
+
headers: {
|
|
1840
|
+
[name: string]: unknown;
|
|
1841
|
+
};
|
|
1842
|
+
content: {
|
|
1843
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1844
|
+
};
|
|
1845
|
+
};
|
|
1846
|
+
403: {
|
|
1847
|
+
headers: {
|
|
1848
|
+
[name: string]: unknown;
|
|
1849
|
+
};
|
|
1850
|
+
content: {
|
|
1851
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1852
|
+
};
|
|
1853
|
+
};
|
|
1854
|
+
404: {
|
|
1855
|
+
headers: {
|
|
1856
|
+
[name: string]: unknown;
|
|
1857
|
+
};
|
|
1858
|
+
content: {
|
|
1859
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
500: {
|
|
1863
|
+
headers: {
|
|
1864
|
+
[name: string]: unknown;
|
|
1865
|
+
};
|
|
1866
|
+
content: {
|
|
1867
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
};
|
|
1872
|
+
"getAudio-apiV1TranscriptionVideoidLanguageExtract-audio": {
|
|
1873
|
+
parameters: {
|
|
1874
|
+
query?: never;
|
|
1875
|
+
header?: never;
|
|
1876
|
+
path: {
|
|
1877
|
+
/** @description The video id to transcribe */
|
|
1878
|
+
videoId: string;
|
|
1879
|
+
/** @description The language to run the transcription in */
|
|
1880
|
+
language: string;
|
|
1881
|
+
};
|
|
1882
|
+
cookie?: never;
|
|
1883
|
+
};
|
|
1884
|
+
requestBody?: never;
|
|
1885
|
+
responses: {
|
|
1886
|
+
200: {
|
|
1887
|
+
headers: {
|
|
1888
|
+
[name: string]: unknown;
|
|
1889
|
+
};
|
|
1890
|
+
content?: never;
|
|
1891
|
+
};
|
|
1892
|
+
400: {
|
|
1893
|
+
headers: {
|
|
1894
|
+
[name: string]: unknown;
|
|
1895
|
+
};
|
|
1896
|
+
content: {
|
|
1897
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1898
|
+
};
|
|
1899
|
+
};
|
|
1900
|
+
404: {
|
|
1901
|
+
headers: {
|
|
1902
|
+
[name: string]: unknown;
|
|
1903
|
+
};
|
|
1904
|
+
content: {
|
|
1905
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1906
|
+
};
|
|
1907
|
+
};
|
|
1908
|
+
500: {
|
|
1909
|
+
headers: {
|
|
1910
|
+
[name: string]: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
content: {
|
|
1913
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
};
|
|
1918
|
+
"postAudio-apiV1TranscriptionVideoidLanguageExtract-audio": {
|
|
1919
|
+
parameters: {
|
|
1920
|
+
query?: never;
|
|
1921
|
+
header?: never;
|
|
1922
|
+
path: {
|
|
1923
|
+
/** @description The video id to transcribe */
|
|
1924
|
+
videoId: string;
|
|
1925
|
+
/** @description The language to run the transcription in */
|
|
1926
|
+
language: string;
|
|
1927
|
+
};
|
|
1928
|
+
cookie?: never;
|
|
1929
|
+
};
|
|
1930
|
+
requestBody?: never;
|
|
1931
|
+
responses: {
|
|
1932
|
+
200: {
|
|
1933
|
+
headers: {
|
|
1934
|
+
[name: string]: unknown;
|
|
1935
|
+
};
|
|
1936
|
+
content?: never;
|
|
1937
|
+
};
|
|
1938
|
+
400: {
|
|
1939
|
+
headers: {
|
|
1940
|
+
[name: string]: unknown;
|
|
1941
|
+
};
|
|
1942
|
+
content: {
|
|
1943
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1944
|
+
};
|
|
1945
|
+
};
|
|
1946
|
+
404: {
|
|
1947
|
+
headers: {
|
|
1948
|
+
[name: string]: unknown;
|
|
1949
|
+
};
|
|
1950
|
+
content: {
|
|
1951
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
500: {
|
|
1955
|
+
headers: {
|
|
1956
|
+
[name: string]: unknown;
|
|
1957
|
+
};
|
|
1958
|
+
content: {
|
|
1959
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
1960
|
+
};
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
};
|
|
1964
|
+
"getAudio-apiV1TranscriptionVideoVideoidLanguage": {
|
|
1965
|
+
parameters: {
|
|
1966
|
+
query?: never;
|
|
1967
|
+
header?: never;
|
|
1968
|
+
path: {
|
|
1969
|
+
/** @description The video id to transcribe */
|
|
1970
|
+
videoId: string;
|
|
1971
|
+
/** @description The language to run the transcription in */
|
|
1972
|
+
language: string;
|
|
1973
|
+
};
|
|
1974
|
+
cookie?: never;
|
|
1975
|
+
};
|
|
1976
|
+
requestBody?: never;
|
|
1977
|
+
responses: {
|
|
1978
|
+
200: {
|
|
1979
|
+
headers: {
|
|
1980
|
+
[name: string]: unknown;
|
|
1981
|
+
};
|
|
1982
|
+
content: {
|
|
1983
|
+
"application/json": components["schemas"]["TranscriptionResultDTO"];
|
|
1984
|
+
};
|
|
1985
|
+
};
|
|
1986
|
+
400: {
|
|
1987
|
+
headers: {
|
|
1988
|
+
[name: string]: unknown;
|
|
1989
|
+
};
|
|
1990
|
+
content: {
|
|
1991
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1992
|
+
};
|
|
1993
|
+
};
|
|
1994
|
+
404: {
|
|
1995
|
+
headers: {
|
|
1996
|
+
[name: string]: unknown;
|
|
1997
|
+
};
|
|
1998
|
+
content: {
|
|
1999
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2000
|
+
};
|
|
2001
|
+
};
|
|
2002
|
+
405: {
|
|
2003
|
+
headers: {
|
|
2004
|
+
[name: string]: unknown;
|
|
2005
|
+
};
|
|
2006
|
+
content: {
|
|
2007
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2008
|
+
};
|
|
2009
|
+
};
|
|
2010
|
+
500: {
|
|
2011
|
+
headers: {
|
|
2012
|
+
[name: string]: unknown;
|
|
2013
|
+
};
|
|
2014
|
+
content: {
|
|
2015
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
2016
|
+
};
|
|
2017
|
+
};
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
"postAudio-apiV1TranscriptionVideoVideoidLanguage": {
|
|
2021
|
+
parameters: {
|
|
2022
|
+
query?: {
|
|
2023
|
+
/** @description The maximum number of speakers in the video */
|
|
2024
|
+
maxSpeaker?: number;
|
|
2025
|
+
};
|
|
2026
|
+
header?: never;
|
|
2027
|
+
path: {
|
|
2028
|
+
/** @description The video id to transcribe */
|
|
2029
|
+
videoId: string;
|
|
2030
|
+
/** @description The language to run the transcription in */
|
|
2031
|
+
language: string;
|
|
2032
|
+
};
|
|
2033
|
+
cookie?: never;
|
|
2034
|
+
};
|
|
2035
|
+
requestBody?: never;
|
|
2036
|
+
responses: {
|
|
2037
|
+
200: {
|
|
2038
|
+
headers: {
|
|
2039
|
+
[name: string]: unknown;
|
|
2040
|
+
};
|
|
2041
|
+
content?: never;
|
|
2042
|
+
};
|
|
2043
|
+
400: {
|
|
2044
|
+
headers: {
|
|
2045
|
+
[name: string]: unknown;
|
|
2046
|
+
};
|
|
2047
|
+
content: {
|
|
2048
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2049
|
+
};
|
|
2050
|
+
};
|
|
2051
|
+
404: {
|
|
2052
|
+
headers: {
|
|
2053
|
+
[name: string]: unknown;
|
|
2054
|
+
};
|
|
2055
|
+
content: {
|
|
2056
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2057
|
+
};
|
|
2058
|
+
};
|
|
2059
|
+
500: {
|
|
2060
|
+
headers: {
|
|
2061
|
+
[name: string]: unknown;
|
|
2062
|
+
};
|
|
2063
|
+
content: {
|
|
2064
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
2065
|
+
};
|
|
2066
|
+
};
|
|
2067
|
+
};
|
|
2068
|
+
};
|
|
2069
|
+
"postAudio-apiV1TranscriptionAudioAudionameAudioidLanguage": {
|
|
2070
|
+
parameters: {
|
|
2071
|
+
query?: {
|
|
2072
|
+
/** @description The maximum number of speakers in the video */
|
|
2073
|
+
maxSpeaker?: number;
|
|
2074
|
+
/** @description The format of the audio file */
|
|
2075
|
+
format?: string;
|
|
2076
|
+
};
|
|
2077
|
+
header?: never;
|
|
2078
|
+
path: {
|
|
2079
|
+
/** @description The audio name to transcribe */
|
|
2080
|
+
audioName: string;
|
|
2081
|
+
/** @description The audio id to transcribe */
|
|
2082
|
+
audioId: number;
|
|
2083
|
+
/** @description The language to run the transcription in */
|
|
2084
|
+
language: string;
|
|
2085
|
+
};
|
|
2086
|
+
cookie?: never;
|
|
2087
|
+
};
|
|
2088
|
+
requestBody?: never;
|
|
2089
|
+
responses: {
|
|
2090
|
+
200: {
|
|
2091
|
+
headers: {
|
|
2092
|
+
[name: string]: unknown;
|
|
2093
|
+
};
|
|
2094
|
+
content?: never;
|
|
2095
|
+
};
|
|
2096
|
+
400: {
|
|
2097
|
+
headers: {
|
|
2098
|
+
[name: string]: unknown;
|
|
2099
|
+
};
|
|
2100
|
+
content: {
|
|
2101
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2102
|
+
};
|
|
2103
|
+
};
|
|
2104
|
+
404: {
|
|
2105
|
+
headers: {
|
|
2106
|
+
[name: string]: unknown;
|
|
2107
|
+
};
|
|
2108
|
+
content: {
|
|
2109
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
500: {
|
|
2113
|
+
headers: {
|
|
2114
|
+
[name: string]: unknown;
|
|
2115
|
+
};
|
|
2116
|
+
content: {
|
|
2117
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
2118
|
+
};
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
};
|
|
2122
|
+
"getAudio-apiV1TranscriptionAudioAudioidLanguage": {
|
|
2123
|
+
parameters: {
|
|
2124
|
+
query?: never;
|
|
2125
|
+
header?: never;
|
|
2126
|
+
path: {
|
|
2127
|
+
/** @description The audio id to transcribe */
|
|
2128
|
+
audioId: number;
|
|
2129
|
+
/** @description The language to run the transcription in */
|
|
2130
|
+
language: string;
|
|
2131
|
+
};
|
|
2132
|
+
cookie?: never;
|
|
2133
|
+
};
|
|
2134
|
+
requestBody?: never;
|
|
2135
|
+
responses: {
|
|
2136
|
+
200: {
|
|
2137
|
+
headers: {
|
|
2138
|
+
[name: string]: unknown;
|
|
2139
|
+
};
|
|
2140
|
+
content: {
|
|
2141
|
+
"application/json": components["schemas"]["TranscriptionResultDTO"];
|
|
2142
|
+
};
|
|
2143
|
+
};
|
|
2144
|
+
400: {
|
|
2145
|
+
headers: {
|
|
2146
|
+
[name: string]: unknown;
|
|
2147
|
+
};
|
|
2148
|
+
content: {
|
|
2149
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2150
|
+
};
|
|
2151
|
+
};
|
|
2152
|
+
404: {
|
|
2153
|
+
headers: {
|
|
2154
|
+
[name: string]: unknown;
|
|
2155
|
+
};
|
|
2156
|
+
content: {
|
|
2157
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
405: {
|
|
2161
|
+
headers: {
|
|
2162
|
+
[name: string]: unknown;
|
|
2163
|
+
};
|
|
2164
|
+
content: {
|
|
2165
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
2166
|
+
};
|
|
2167
|
+
};
|
|
2168
|
+
500: {
|
|
2169
|
+
headers: {
|
|
2170
|
+
[name: string]: unknown;
|
|
2171
|
+
};
|
|
2172
|
+
content: {
|
|
2173
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
2174
|
+
};
|
|
2175
|
+
};
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
}
|