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