@ndla/types-backend 1.0.34 → 1.0.35

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