@ndla/types-backend 1.0.104 → 1.0.106

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