@payloadcms/figma 0.0.1-alpha.26 → 0.0.1-alpha.28

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 (55) hide show
  1. package/dist/api/control-plane.d.ts +18 -0
  2. package/dist/api/control-plane.d.ts.map +1 -1
  3. package/dist/api/control-plane.js +39 -8
  4. package/dist/api/control-plane.js.map +1 -1
  5. package/dist/api/figma-api.d.ts.map +1 -1
  6. package/dist/api/figma-api.js +5 -2
  7. package/dist/api/figma-api.js.map +1 -1
  8. package/dist/commands/deploy.d.ts.map +1 -1
  9. package/dist/commands/deploy.js +3 -18
  10. package/dist/commands/deploy.js.map +1 -1
  11. package/dist/commands/init.d.ts.map +1 -1
  12. package/dist/commands/init.js +59 -2
  13. package/dist/commands/init.js.map +1 -1
  14. package/dist/config/oauth.js +2 -1
  15. package/dist/config/oauth.js.map +1 -1
  16. package/dist/db-content-api/generated/content-api-types.d.ts +3129 -0
  17. package/dist/db-content-api/generated/content-api-types.d.ts.map +1 -0
  18. package/dist/db-content-api/generated/content-api-types.js +7 -0
  19. package/dist/db-content-api/generated/content-api-types.js.map +1 -0
  20. package/dist/db-content-api/index.d.ts +31 -0
  21. package/dist/db-content-api/index.d.ts.map +1 -0
  22. package/dist/db-content-api/index.js +842 -0
  23. package/dist/db-content-api/index.js.map +1 -0
  24. package/dist/db-content-api/types.d.ts +31 -0
  25. package/dist/db-content-api/types.d.ts.map +1 -0
  26. package/dist/db-content-api/types.js +7 -0
  27. package/dist/db-content-api/types.js.map +1 -0
  28. package/dist/index.d.ts +1 -0
  29. package/dist/index.d.ts.map +1 -1
  30. package/dist/index.js +2 -0
  31. package/dist/index.js.map +1 -1
  32. package/dist/oauth/endpoints/getLoginEndpoint.js +1 -1
  33. package/dist/oauth/endpoints/getLoginEndpoint.js.map +1 -1
  34. package/dist/oauth/strategy/index.d.ts.map +1 -1
  35. package/dist/oauth/strategy/index.js +4 -0
  36. package/dist/oauth/strategy/index.js.map +1 -1
  37. package/dist/plugin/build-config.d.ts.map +1 -1
  38. package/dist/plugin/build-config.js +35 -17
  39. package/dist/plugin/build-config.js.map +1 -1
  40. package/dist/utils/payload-config-ast.d.ts +5 -0
  41. package/dist/utils/payload-config-ast.d.ts.map +1 -1
  42. package/dist/utils/payload-config-ast.js +29 -2
  43. package/dist/utils/payload-config-ast.js.map +1 -1
  44. package/dist/utils/payload-config-modifier.d.ts.map +1 -1
  45. package/dist/utils/payload-config-modifier.js +4 -0
  46. package/dist/utils/payload-config-modifier.js.map +1 -1
  47. package/dist/utils/payload-package-check.d.ts +5 -0
  48. package/dist/utils/payload-package-check.d.ts.map +1 -1
  49. package/dist/utils/payload-package-check.js +41 -0
  50. package/dist/utils/payload-package-check.js.map +1 -1
  51. package/package.json +3 -1
  52. package/dist/db-adapter.d.ts +0 -17
  53. package/dist/db-adapter.d.ts.map +0 -1
  54. package/dist/db-adapter.js +0 -760
  55. package/dist/db-adapter.js.map +0 -1
@@ -0,0 +1,3129 @@
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
+ '/api/me': {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ get: {
14
+ parameters: {
15
+ query?: never;
16
+ header?: never;
17
+ path?: never;
18
+ cookie?: never;
19
+ };
20
+ requestBody?: never;
21
+ responses: {
22
+ /** @description Current authentication context */
23
+ 200: {
24
+ headers: {
25
+ [name: string]: unknown;
26
+ };
27
+ content: {
28
+ 'application/json': components['schemas']['AuthContextResponse'];
29
+ };
30
+ };
31
+ /** @description Authentication required */
32
+ 401: {
33
+ headers: {
34
+ [name: string]: unknown;
35
+ };
36
+ content: {
37
+ 'application/json': {
38
+ message: string;
39
+ };
40
+ };
41
+ };
42
+ };
43
+ };
44
+ put?: never;
45
+ post?: never;
46
+ delete?: never;
47
+ options?: never;
48
+ head?: never;
49
+ patch?: never;
50
+ trace?: never;
51
+ };
52
+ '/health': {
53
+ parameters: {
54
+ query?: never;
55
+ header?: never;
56
+ path?: never;
57
+ cookie?: never;
58
+ };
59
+ get: {
60
+ parameters: {
61
+ query?: never;
62
+ header?: never;
63
+ path?: never;
64
+ cookie?: never;
65
+ };
66
+ requestBody?: never;
67
+ responses: {
68
+ /** @description OK */
69
+ 200: {
70
+ headers: {
71
+ [name: string]: unknown;
72
+ };
73
+ content: {
74
+ 'application/json': components['schemas']['HealthResponse'];
75
+ };
76
+ };
77
+ };
78
+ };
79
+ put?: never;
80
+ post?: never;
81
+ delete?: never;
82
+ options?: never;
83
+ head?: never;
84
+ patch?: never;
85
+ trace?: never;
86
+ };
87
+ '/api/v0/api_keys': {
88
+ parameters: {
89
+ query?: never;
90
+ header?: never;
91
+ path?: never;
92
+ cookie?: never;
93
+ };
94
+ get: {
95
+ parameters: {
96
+ query: {
97
+ contentSystemId: string;
98
+ };
99
+ header?: never;
100
+ path?: never;
101
+ cookie?: never;
102
+ };
103
+ requestBody?: never;
104
+ responses: {
105
+ /** @description API keys retrieved */
106
+ 200: {
107
+ headers: {
108
+ [name: string]: unknown;
109
+ };
110
+ content: {
111
+ 'application/json': components['schemas']['ListApiKeysResponse'];
112
+ };
113
+ };
114
+ /** @description Bad request */
115
+ 400: {
116
+ headers: {
117
+ [name: string]: unknown;
118
+ };
119
+ content: {
120
+ 'application/json': {
121
+ /** @example Error message describing the issue. */
122
+ message: string;
123
+ };
124
+ };
125
+ };
126
+ /** @description Forbidden */
127
+ 403: {
128
+ headers: {
129
+ [name: string]: unknown;
130
+ };
131
+ content: {
132
+ 'application/json': {
133
+ /** @example Error message describing the issue. */
134
+ message: string;
135
+ };
136
+ };
137
+ };
138
+ /** @description Internal server error */
139
+ 500: {
140
+ headers: {
141
+ [name: string]: unknown;
142
+ };
143
+ content: {
144
+ 'application/json': {
145
+ /** @example Error message describing the issue. */
146
+ message: string;
147
+ };
148
+ };
149
+ };
150
+ };
151
+ };
152
+ put?: never;
153
+ post: {
154
+ parameters: {
155
+ query?: never;
156
+ header?: never;
157
+ path?: never;
158
+ cookie?: never;
159
+ };
160
+ requestBody?: {
161
+ content: {
162
+ 'application/json': components['schemas']['CreateApiKeyRequest'];
163
+ };
164
+ };
165
+ responses: {
166
+ /** @description API key created */
167
+ 201: {
168
+ headers: {
169
+ [name: string]: unknown;
170
+ };
171
+ content: {
172
+ 'application/json': components['schemas']['CreateApiKeyResponse'];
173
+ };
174
+ };
175
+ /** @description Bad request */
176
+ 400: {
177
+ headers: {
178
+ [name: string]: unknown;
179
+ };
180
+ content: {
181
+ 'application/json': {
182
+ /** @example Error message describing the issue. */
183
+ message: string;
184
+ };
185
+ };
186
+ };
187
+ /** @description Forbidden */
188
+ 403: {
189
+ headers: {
190
+ [name: string]: unknown;
191
+ };
192
+ content: {
193
+ 'application/json': {
194
+ /** @example Error message describing the issue. */
195
+ message: string;
196
+ };
197
+ };
198
+ };
199
+ /** @description Internal server error */
200
+ 500: {
201
+ headers: {
202
+ [name: string]: unknown;
203
+ };
204
+ content: {
205
+ 'application/json': {
206
+ /** @example Error message describing the issue. */
207
+ message: string;
208
+ };
209
+ };
210
+ };
211
+ };
212
+ };
213
+ delete?: never;
214
+ options?: never;
215
+ head?: never;
216
+ patch?: never;
217
+ trace?: never;
218
+ };
219
+ '/api/v0/api_keys/{id}': {
220
+ parameters: {
221
+ query?: never;
222
+ header?: never;
223
+ path?: never;
224
+ cookie?: never;
225
+ };
226
+ get?: never;
227
+ put?: never;
228
+ post?: never;
229
+ delete: {
230
+ parameters: {
231
+ query?: never;
232
+ header?: never;
233
+ path: {
234
+ id: string;
235
+ };
236
+ cookie?: never;
237
+ };
238
+ requestBody?: never;
239
+ responses: {
240
+ /** @description API key deleted successfully */
241
+ 204: {
242
+ headers: {
243
+ [name: string]: unknown;
244
+ };
245
+ content?: never;
246
+ };
247
+ /** @description Bad request */
248
+ 400: {
249
+ headers: {
250
+ [name: string]: unknown;
251
+ };
252
+ content: {
253
+ 'application/json': {
254
+ /** @example Error message describing the issue. */
255
+ message: string;
256
+ };
257
+ };
258
+ };
259
+ /** @description Forbidden */
260
+ 403: {
261
+ headers: {
262
+ [name: string]: unknown;
263
+ };
264
+ content: {
265
+ 'application/json': {
266
+ /** @example Error message describing the issue. */
267
+ message: string;
268
+ };
269
+ };
270
+ };
271
+ /** @description Not found */
272
+ 404: {
273
+ headers: {
274
+ [name: string]: unknown;
275
+ };
276
+ content: {
277
+ 'application/json': {
278
+ /** @example Error message describing the issue. */
279
+ message: string;
280
+ };
281
+ };
282
+ };
283
+ /** @description Internal server error */
284
+ 500: {
285
+ headers: {
286
+ [name: string]: unknown;
287
+ };
288
+ content: {
289
+ 'application/json': {
290
+ /** @example Error message describing the issue. */
291
+ message: string;
292
+ };
293
+ };
294
+ };
295
+ };
296
+ };
297
+ options?: never;
298
+ head?: never;
299
+ patch?: never;
300
+ trace?: never;
301
+ };
302
+ '/api/v0/content_systems': {
303
+ parameters: {
304
+ query?: never;
305
+ header?: never;
306
+ path?: never;
307
+ cookie?: never;
308
+ };
309
+ get: {
310
+ parameters: {
311
+ query?: never;
312
+ header?: never;
313
+ path?: never;
314
+ cookie?: never;
315
+ };
316
+ requestBody?: never;
317
+ responses: {
318
+ /** @description Content systems retrieved */
319
+ 200: {
320
+ headers: {
321
+ [name: string]: unknown;
322
+ };
323
+ content: {
324
+ 'application/json': {
325
+ data: components['schemas']['ContentSystem'][];
326
+ total: number;
327
+ };
328
+ };
329
+ };
330
+ /** @description Bad request */
331
+ 400: {
332
+ headers: {
333
+ [name: string]: unknown;
334
+ };
335
+ content: {
336
+ 'application/json': {
337
+ /** @example Error message describing the issue. */
338
+ message: string;
339
+ };
340
+ };
341
+ };
342
+ /** @description Forbidden */
343
+ 403: {
344
+ headers: {
345
+ [name: string]: unknown;
346
+ };
347
+ content: {
348
+ 'application/json': {
349
+ /** @example Error message describing the issue. */
350
+ message: string;
351
+ };
352
+ };
353
+ };
354
+ /** @description Internal server error */
355
+ 500: {
356
+ headers: {
357
+ [name: string]: unknown;
358
+ };
359
+ content: {
360
+ 'application/json': {
361
+ /** @example Error message describing the issue. */
362
+ message: string;
363
+ };
364
+ };
365
+ };
366
+ };
367
+ };
368
+ put?: never;
369
+ post: {
370
+ parameters: {
371
+ query?: never;
372
+ header?: never;
373
+ path?: never;
374
+ cookie?: never;
375
+ };
376
+ requestBody?: {
377
+ content: {
378
+ 'application/json': components['schemas']['CreateContentSystemRequest'];
379
+ };
380
+ };
381
+ responses: {
382
+ /** @description Content system created */
383
+ 201: {
384
+ headers: {
385
+ [name: string]: unknown;
386
+ };
387
+ content: {
388
+ 'application/json': components['schemas']['CreateContentSystemResponse'];
389
+ };
390
+ };
391
+ /** @description Bad request */
392
+ 400: {
393
+ headers: {
394
+ [name: string]: unknown;
395
+ };
396
+ content: {
397
+ 'application/json': {
398
+ /** @example Error message describing the issue. */
399
+ message: string;
400
+ };
401
+ };
402
+ };
403
+ /** @description Forbidden */
404
+ 403: {
405
+ headers: {
406
+ [name: string]: unknown;
407
+ };
408
+ content: {
409
+ 'application/json': {
410
+ /** @example Error message describing the issue. */
411
+ message: string;
412
+ };
413
+ };
414
+ };
415
+ /** @description Conflict */
416
+ 409: {
417
+ headers: {
418
+ [name: string]: unknown;
419
+ };
420
+ content: {
421
+ 'application/json': {
422
+ /** @example Error message describing the issue. */
423
+ message: string;
424
+ };
425
+ };
426
+ };
427
+ /** @description Unprocessable entity */
428
+ 422: {
429
+ headers: {
430
+ [name: string]: unknown;
431
+ };
432
+ content: {
433
+ 'application/json': {
434
+ /** @example Error message describing the issue. */
435
+ message: string;
436
+ };
437
+ };
438
+ };
439
+ /** @description Internal server error */
440
+ 500: {
441
+ headers: {
442
+ [name: string]: unknown;
443
+ };
444
+ content: {
445
+ 'application/json': {
446
+ /** @example Error message describing the issue. */
447
+ message: string;
448
+ };
449
+ };
450
+ };
451
+ };
452
+ };
453
+ delete?: never;
454
+ options?: never;
455
+ head?: never;
456
+ patch?: never;
457
+ trace?: never;
458
+ };
459
+ '/api/v0/content_systems/{id}': {
460
+ parameters: {
461
+ query?: never;
462
+ header?: never;
463
+ path?: never;
464
+ cookie?: never;
465
+ };
466
+ get: {
467
+ parameters: {
468
+ query?: never;
469
+ header?: never;
470
+ path: {
471
+ id: string;
472
+ };
473
+ cookie?: never;
474
+ };
475
+ requestBody?: never;
476
+ responses: {
477
+ /** @description Content system retrieved */
478
+ 200: {
479
+ headers: {
480
+ [name: string]: unknown;
481
+ };
482
+ content: {
483
+ 'application/json': components['schemas']['RetrieveContentSystemResponse'];
484
+ };
485
+ };
486
+ /** @description Bad request */
487
+ 400: {
488
+ headers: {
489
+ [name: string]: unknown;
490
+ };
491
+ content: {
492
+ 'application/json': {
493
+ /** @example Error message describing the issue. */
494
+ message: string;
495
+ };
496
+ };
497
+ };
498
+ /** @description Forbidden */
499
+ 403: {
500
+ headers: {
501
+ [name: string]: unknown;
502
+ };
503
+ content: {
504
+ 'application/json': {
505
+ /** @example Error message describing the issue. */
506
+ message: string;
507
+ };
508
+ };
509
+ };
510
+ /** @description Not found */
511
+ 404: {
512
+ headers: {
513
+ [name: string]: unknown;
514
+ };
515
+ content: {
516
+ 'application/json': {
517
+ /** @example Error message describing the issue. */
518
+ message: string;
519
+ };
520
+ };
521
+ };
522
+ /** @description Internal server error */
523
+ 500: {
524
+ headers: {
525
+ [name: string]: unknown;
526
+ };
527
+ content: {
528
+ 'application/json': {
529
+ /** @example Error message describing the issue. */
530
+ message: string;
531
+ };
532
+ };
533
+ };
534
+ };
535
+ };
536
+ put: {
537
+ parameters: {
538
+ query?: never;
539
+ header?: never;
540
+ path: {
541
+ id: string;
542
+ };
543
+ cookie?: never;
544
+ };
545
+ requestBody?: {
546
+ content: {
547
+ 'application/json': components['schemas']['UpdateContentSystemRequest'];
548
+ };
549
+ };
550
+ responses: {
551
+ /** @description Content system updated */
552
+ 200: {
553
+ headers: {
554
+ [name: string]: unknown;
555
+ };
556
+ content: {
557
+ 'application/json': components['schemas']['UpdateContentSystemResponse'];
558
+ };
559
+ };
560
+ /** @description Bad request */
561
+ 400: {
562
+ headers: {
563
+ [name: string]: unknown;
564
+ };
565
+ content: {
566
+ 'application/json': {
567
+ /** @example Error message describing the issue. */
568
+ message: string;
569
+ };
570
+ };
571
+ };
572
+ /** @description Forbidden */
573
+ 403: {
574
+ headers: {
575
+ [name: string]: unknown;
576
+ };
577
+ content: {
578
+ 'application/json': {
579
+ /** @example Error message describing the issue. */
580
+ message: string;
581
+ };
582
+ };
583
+ };
584
+ /** @description Not found */
585
+ 404: {
586
+ headers: {
587
+ [name: string]: unknown;
588
+ };
589
+ content: {
590
+ 'application/json': {
591
+ /** @example Error message describing the issue. */
592
+ message: string;
593
+ };
594
+ };
595
+ };
596
+ /** @description Conflict */
597
+ 409: {
598
+ headers: {
599
+ [name: string]: unknown;
600
+ };
601
+ content: {
602
+ 'application/json': {
603
+ /** @example Error message describing the issue. */
604
+ message: string;
605
+ };
606
+ };
607
+ };
608
+ /** @description Internal server error */
609
+ 500: {
610
+ headers: {
611
+ [name: string]: unknown;
612
+ };
613
+ content: {
614
+ 'application/json': {
615
+ /** @example Error message describing the issue. */
616
+ message: string;
617
+ };
618
+ };
619
+ };
620
+ };
621
+ };
622
+ post?: never;
623
+ delete: {
624
+ parameters: {
625
+ query?: never;
626
+ header?: never;
627
+ path: {
628
+ id: string;
629
+ };
630
+ cookie?: never;
631
+ };
632
+ requestBody?: never;
633
+ responses: {
634
+ /** @description Content system deleted successfully */
635
+ 204: {
636
+ headers: {
637
+ [name: string]: unknown;
638
+ };
639
+ content?: never;
640
+ };
641
+ /** @description Forbidden */
642
+ 403: {
643
+ headers: {
644
+ [name: string]: unknown;
645
+ };
646
+ content: {
647
+ 'application/json': {
648
+ /** @example Error message describing the issue. */
649
+ message: string;
650
+ };
651
+ };
652
+ };
653
+ /** @description Not found */
654
+ 404: {
655
+ headers: {
656
+ [name: string]: unknown;
657
+ };
658
+ content: {
659
+ 'application/json': {
660
+ /** @example Error message describing the issue. */
661
+ message: string;
662
+ };
663
+ };
664
+ };
665
+ /** @description Internal server error */
666
+ 500: {
667
+ headers: {
668
+ [name: string]: unknown;
669
+ };
670
+ content: {
671
+ 'application/json': {
672
+ /** @example Error message describing the issue. */
673
+ message: string;
674
+ };
675
+ };
676
+ };
677
+ };
678
+ };
679
+ options?: never;
680
+ head?: never;
681
+ patch?: never;
682
+ trace?: never;
683
+ };
684
+ '/api/v0/collections': {
685
+ parameters: {
686
+ query?: never;
687
+ header?: never;
688
+ path?: never;
689
+ cookie?: never;
690
+ };
691
+ get: {
692
+ parameters: {
693
+ query: {
694
+ contentSystemId: string;
695
+ key?: string;
696
+ };
697
+ header?: never;
698
+ path?: never;
699
+ cookie?: never;
700
+ };
701
+ requestBody?: never;
702
+ responses: {
703
+ /** @description Collections retrieved */
704
+ 200: {
705
+ headers: {
706
+ [name: string]: unknown;
707
+ };
708
+ content: {
709
+ 'application/json': {
710
+ data: components['schemas']['Collection'][];
711
+ total: number;
712
+ };
713
+ };
714
+ };
715
+ /** @description Bad request */
716
+ 400: {
717
+ headers: {
718
+ [name: string]: unknown;
719
+ };
720
+ content: {
721
+ 'application/json': {
722
+ /** @example Error message describing the issue. */
723
+ message: string;
724
+ };
725
+ };
726
+ };
727
+ /** @description Forbidden */
728
+ 403: {
729
+ headers: {
730
+ [name: string]: unknown;
731
+ };
732
+ content: {
733
+ 'application/json': {
734
+ /** @example Error message describing the issue. */
735
+ message: string;
736
+ };
737
+ };
738
+ };
739
+ /** @description Internal server error */
740
+ 500: {
741
+ headers: {
742
+ [name: string]: unknown;
743
+ };
744
+ content: {
745
+ 'application/json': {
746
+ /** @example Error message describing the issue. */
747
+ message: string;
748
+ };
749
+ };
750
+ };
751
+ };
752
+ };
753
+ put?: never;
754
+ post: {
755
+ parameters: {
756
+ query?: never;
757
+ header?: never;
758
+ path?: never;
759
+ cookie?: never;
760
+ };
761
+ requestBody?: {
762
+ content: {
763
+ 'application/json': components['schemas']['CreateCollectionRequest'];
764
+ };
765
+ };
766
+ responses: {
767
+ /** @description Collection created */
768
+ 201: {
769
+ headers: {
770
+ [name: string]: unknown;
771
+ };
772
+ content: {
773
+ 'application/json': components['schemas']['CreateCollectionResponse'];
774
+ };
775
+ };
776
+ /** @description Bad request */
777
+ 400: {
778
+ headers: {
779
+ [name: string]: unknown;
780
+ };
781
+ content: {
782
+ 'application/json': {
783
+ /** @example Error message describing the issue. */
784
+ message: string;
785
+ };
786
+ };
787
+ };
788
+ /** @description Forbidden */
789
+ 403: {
790
+ headers: {
791
+ [name: string]: unknown;
792
+ };
793
+ content: {
794
+ 'application/json': {
795
+ /** @example Error message describing the issue. */
796
+ message: string;
797
+ };
798
+ };
799
+ };
800
+ /** @description Not found */
801
+ 404: {
802
+ headers: {
803
+ [name: string]: unknown;
804
+ };
805
+ content: {
806
+ 'application/json': {
807
+ /** @example Error message describing the issue. */
808
+ message: string;
809
+ };
810
+ };
811
+ };
812
+ /** @description Conflict */
813
+ 409: {
814
+ headers: {
815
+ [name: string]: unknown;
816
+ };
817
+ content: {
818
+ 'application/json': {
819
+ /** @example Error message describing the issue. */
820
+ message: string;
821
+ };
822
+ };
823
+ };
824
+ /** @description Unprocessable entity */
825
+ 422: {
826
+ headers: {
827
+ [name: string]: unknown;
828
+ };
829
+ content: {
830
+ 'application/json': {
831
+ /** @example Error message describing the issue. */
832
+ message: string;
833
+ };
834
+ };
835
+ };
836
+ /** @description Internal server error */
837
+ 500: {
838
+ headers: {
839
+ [name: string]: unknown;
840
+ };
841
+ content: {
842
+ 'application/json': {
843
+ /** @example Error message describing the issue. */
844
+ message: string;
845
+ };
846
+ };
847
+ };
848
+ };
849
+ };
850
+ delete?: never;
851
+ options?: never;
852
+ head?: never;
853
+ patch?: never;
854
+ trace?: never;
855
+ };
856
+ '/api/v0/collections/{id}': {
857
+ parameters: {
858
+ query?: never;
859
+ header?: never;
860
+ path?: never;
861
+ cookie?: never;
862
+ };
863
+ get: {
864
+ parameters: {
865
+ query?: never;
866
+ header?: never;
867
+ path: {
868
+ id: string;
869
+ };
870
+ cookie?: never;
871
+ };
872
+ requestBody?: never;
873
+ responses: {
874
+ /** @description Collection retrieved */
875
+ 200: {
876
+ headers: {
877
+ [name: string]: unknown;
878
+ };
879
+ content: {
880
+ 'application/json': components['schemas']['RetrieveCollectionResponse'];
881
+ };
882
+ };
883
+ /** @description Bad request */
884
+ 400: {
885
+ headers: {
886
+ [name: string]: unknown;
887
+ };
888
+ content: {
889
+ 'application/json': {
890
+ /** @example Error message describing the issue. */
891
+ message: string;
892
+ };
893
+ };
894
+ };
895
+ /** @description Not found */
896
+ 404: {
897
+ headers: {
898
+ [name: string]: unknown;
899
+ };
900
+ content: {
901
+ 'application/json': {
902
+ /** @example Error message describing the issue. */
903
+ message: string;
904
+ };
905
+ };
906
+ };
907
+ /** @description Internal server error */
908
+ 500: {
909
+ headers: {
910
+ [name: string]: unknown;
911
+ };
912
+ content: {
913
+ 'application/json': {
914
+ /** @example Error message describing the issue. */
915
+ message: string;
916
+ };
917
+ };
918
+ };
919
+ };
920
+ };
921
+ put: {
922
+ parameters: {
923
+ query?: never;
924
+ header?: never;
925
+ path: {
926
+ id: string;
927
+ };
928
+ cookie?: never;
929
+ };
930
+ requestBody?: {
931
+ content: {
932
+ 'application/json': components['schemas']['UpdateCollectionRequest'];
933
+ };
934
+ };
935
+ responses: {
936
+ /** @description Collection updated */
937
+ 200: {
938
+ headers: {
939
+ [name: string]: unknown;
940
+ };
941
+ content: {
942
+ 'application/json': components['schemas']['UpdateCollectionResponse'];
943
+ };
944
+ };
945
+ /** @description Bad request */
946
+ 400: {
947
+ headers: {
948
+ [name: string]: unknown;
949
+ };
950
+ content: {
951
+ 'application/json': {
952
+ /** @example Error message describing the issue. */
953
+ message: string;
954
+ };
955
+ };
956
+ };
957
+ /** @description Forbidden */
958
+ 403: {
959
+ headers: {
960
+ [name: string]: unknown;
961
+ };
962
+ content: {
963
+ 'application/json': {
964
+ /** @example Error message describing the issue. */
965
+ message: string;
966
+ };
967
+ };
968
+ };
969
+ /** @description Not found */
970
+ 404: {
971
+ headers: {
972
+ [name: string]: unknown;
973
+ };
974
+ content: {
975
+ 'application/json': {
976
+ /** @example Error message describing the issue. */
977
+ message: string;
978
+ };
979
+ };
980
+ };
981
+ /** @description Conflict */
982
+ 409: {
983
+ headers: {
984
+ [name: string]: unknown;
985
+ };
986
+ content: {
987
+ 'application/json': {
988
+ /** @example Error message describing the issue. */
989
+ message: string;
990
+ };
991
+ };
992
+ };
993
+ /** @description Internal server error */
994
+ 500: {
995
+ headers: {
996
+ [name: string]: unknown;
997
+ };
998
+ content: {
999
+ 'application/json': {
1000
+ /** @example Error message describing the issue. */
1001
+ message: string;
1002
+ };
1003
+ };
1004
+ };
1005
+ };
1006
+ };
1007
+ post?: never;
1008
+ delete: {
1009
+ parameters: {
1010
+ query?: never;
1011
+ header?: never;
1012
+ path: {
1013
+ id: string;
1014
+ };
1015
+ cookie?: never;
1016
+ };
1017
+ requestBody?: never;
1018
+ responses: {
1019
+ /** @description Collection deleted successfully */
1020
+ 204: {
1021
+ headers: {
1022
+ [name: string]: unknown;
1023
+ };
1024
+ content?: never;
1025
+ };
1026
+ /** @description Not found */
1027
+ 404: {
1028
+ headers: {
1029
+ [name: string]: unknown;
1030
+ };
1031
+ content: {
1032
+ 'application/json': {
1033
+ /** @example Error message describing the issue. */
1034
+ message: string;
1035
+ };
1036
+ };
1037
+ };
1038
+ /** @description Internal server error */
1039
+ 500: {
1040
+ headers: {
1041
+ [name: string]: unknown;
1042
+ };
1043
+ content: {
1044
+ 'application/json': {
1045
+ /** @example Error message describing the issue. */
1046
+ message: string;
1047
+ };
1048
+ };
1049
+ };
1050
+ };
1051
+ };
1052
+ options?: never;
1053
+ head?: never;
1054
+ patch?: never;
1055
+ trace?: never;
1056
+ };
1057
+ '/api/v0/documents:count': {
1058
+ parameters: {
1059
+ query?: never;
1060
+ header?: never;
1061
+ path?: never;
1062
+ cookie?: never;
1063
+ };
1064
+ get?: never;
1065
+ put?: never;
1066
+ post: {
1067
+ parameters: {
1068
+ query?: never;
1069
+ header?: never;
1070
+ path?: never;
1071
+ cookie?: never;
1072
+ };
1073
+ requestBody?: {
1074
+ content: {
1075
+ 'application/json': components['schemas']['CountDocumentRequest'];
1076
+ };
1077
+ };
1078
+ responses: {
1079
+ /** @description Document count */
1080
+ 200: {
1081
+ headers: {
1082
+ [name: string]: unknown;
1083
+ };
1084
+ content: {
1085
+ 'application/json': components['schemas']['CountDocumentResponse'];
1086
+ };
1087
+ };
1088
+ /** @description Bad request */
1089
+ 400: {
1090
+ headers: {
1091
+ [name: string]: unknown;
1092
+ };
1093
+ content: {
1094
+ 'application/json': {
1095
+ /** @example Error message describing the issue. */
1096
+ message: string;
1097
+ };
1098
+ };
1099
+ };
1100
+ /** @description Forbidden */
1101
+ 403: {
1102
+ headers: {
1103
+ [name: string]: unknown;
1104
+ };
1105
+ content: {
1106
+ 'application/json': {
1107
+ /** @example Error message describing the issue. */
1108
+ message: string;
1109
+ };
1110
+ };
1111
+ };
1112
+ /** @description Not found */
1113
+ 404: {
1114
+ headers: {
1115
+ [name: string]: unknown;
1116
+ };
1117
+ content: {
1118
+ 'application/json': {
1119
+ /** @example Error message describing the issue. */
1120
+ message: string;
1121
+ };
1122
+ };
1123
+ };
1124
+ /** @description Internal server error */
1125
+ 500: {
1126
+ headers: {
1127
+ [name: string]: unknown;
1128
+ };
1129
+ content: {
1130
+ 'application/json': {
1131
+ /** @example Error message describing the issue. */
1132
+ message: string;
1133
+ };
1134
+ };
1135
+ };
1136
+ };
1137
+ };
1138
+ delete?: never;
1139
+ options?: never;
1140
+ head?: never;
1141
+ patch?: never;
1142
+ trace?: never;
1143
+ };
1144
+ '/api/v0/documents:create': {
1145
+ parameters: {
1146
+ query?: never;
1147
+ header?: never;
1148
+ path?: never;
1149
+ cookie?: never;
1150
+ };
1151
+ get?: never;
1152
+ put?: never;
1153
+ post: {
1154
+ parameters: {
1155
+ query?: never;
1156
+ header?: never;
1157
+ path?: never;
1158
+ cookie?: never;
1159
+ };
1160
+ requestBody?: {
1161
+ content: {
1162
+ 'application/json': components['schemas']['CreateDocumentRequest'];
1163
+ };
1164
+ };
1165
+ responses: {
1166
+ /** @description Document created */
1167
+ 201: {
1168
+ headers: {
1169
+ [name: string]: unknown;
1170
+ };
1171
+ content: {
1172
+ 'application/json': components['schemas']['CreateDocumentResponse'];
1173
+ };
1174
+ };
1175
+ /** @description Bad request */
1176
+ 400: {
1177
+ headers: {
1178
+ [name: string]: unknown;
1179
+ };
1180
+ content: {
1181
+ 'application/json': {
1182
+ /** @example Error message describing the issue. */
1183
+ message: string;
1184
+ };
1185
+ };
1186
+ };
1187
+ /** @description Forbidden */
1188
+ 403: {
1189
+ headers: {
1190
+ [name: string]: unknown;
1191
+ };
1192
+ content: {
1193
+ 'application/json': {
1194
+ /** @example Error message describing the issue. */
1195
+ message: string;
1196
+ };
1197
+ };
1198
+ };
1199
+ /** @description Not found */
1200
+ 404: {
1201
+ headers: {
1202
+ [name: string]: unknown;
1203
+ };
1204
+ content: {
1205
+ 'application/json': {
1206
+ /** @example Error message describing the issue. */
1207
+ message: string;
1208
+ };
1209
+ };
1210
+ };
1211
+ /** @description Conflict */
1212
+ 409: {
1213
+ headers: {
1214
+ [name: string]: unknown;
1215
+ };
1216
+ content: {
1217
+ 'application/json': {
1218
+ /** @example Error message describing the issue. */
1219
+ message: string;
1220
+ };
1221
+ };
1222
+ };
1223
+ /** @description Internal server error */
1224
+ 500: {
1225
+ headers: {
1226
+ [name: string]: unknown;
1227
+ };
1228
+ content: {
1229
+ 'application/json': {
1230
+ /** @example Error message describing the issue. */
1231
+ message: string;
1232
+ };
1233
+ };
1234
+ };
1235
+ };
1236
+ };
1237
+ delete?: never;
1238
+ options?: never;
1239
+ head?: never;
1240
+ patch?: never;
1241
+ trace?: never;
1242
+ };
1243
+ '/api/v0/documents:find': {
1244
+ parameters: {
1245
+ query?: never;
1246
+ header?: never;
1247
+ path?: never;
1248
+ cookie?: never;
1249
+ };
1250
+ get?: never;
1251
+ put?: never;
1252
+ post: {
1253
+ parameters: {
1254
+ query?: never;
1255
+ header?: never;
1256
+ path?: never;
1257
+ cookie?: never;
1258
+ };
1259
+ requestBody?: {
1260
+ content: {
1261
+ 'application/json': components['schemas']['FindDocumentsRequest'];
1262
+ };
1263
+ };
1264
+ responses: {
1265
+ /** @description Documents found */
1266
+ 200: {
1267
+ headers: {
1268
+ [name: string]: unknown;
1269
+ };
1270
+ content: {
1271
+ 'application/json': components['schemas']['FindDocumentsResponse'];
1272
+ };
1273
+ };
1274
+ /** @description Bad request */
1275
+ 400: {
1276
+ headers: {
1277
+ [name: string]: unknown;
1278
+ };
1279
+ content: {
1280
+ 'application/json': {
1281
+ /** @example Error message describing the issue. */
1282
+ message: string;
1283
+ };
1284
+ };
1285
+ };
1286
+ /** @description Forbidden */
1287
+ 403: {
1288
+ headers: {
1289
+ [name: string]: unknown;
1290
+ };
1291
+ content: {
1292
+ 'application/json': {
1293
+ /** @example Error message describing the issue. */
1294
+ message: string;
1295
+ };
1296
+ };
1297
+ };
1298
+ /** @description Not found */
1299
+ 404: {
1300
+ headers: {
1301
+ [name: string]: unknown;
1302
+ };
1303
+ content: {
1304
+ 'application/json': {
1305
+ /** @example Error message describing the issue. */
1306
+ message: string;
1307
+ };
1308
+ };
1309
+ };
1310
+ /** @description Internal server error */
1311
+ 500: {
1312
+ headers: {
1313
+ [name: string]: unknown;
1314
+ };
1315
+ content: {
1316
+ 'application/json': {
1317
+ /** @example Error message describing the issue. */
1318
+ message: string;
1319
+ };
1320
+ };
1321
+ };
1322
+ };
1323
+ };
1324
+ delete?: never;
1325
+ options?: never;
1326
+ head?: never;
1327
+ patch?: never;
1328
+ trace?: never;
1329
+ };
1330
+ '/api/v0/documents:update': {
1331
+ parameters: {
1332
+ query?: never;
1333
+ header?: never;
1334
+ path?: never;
1335
+ cookie?: never;
1336
+ };
1337
+ get?: never;
1338
+ put?: never;
1339
+ post: {
1340
+ parameters: {
1341
+ query?: never;
1342
+ header?: never;
1343
+ path?: never;
1344
+ cookie?: never;
1345
+ };
1346
+ requestBody?: {
1347
+ content: {
1348
+ 'application/json': components['schemas']['UpdateDocumentRequest'];
1349
+ };
1350
+ };
1351
+ responses: {
1352
+ /** @description Documents updated */
1353
+ 200: {
1354
+ headers: {
1355
+ [name: string]: unknown;
1356
+ };
1357
+ content: {
1358
+ 'application/json': components['schemas']['UpdateDocumentResponse'];
1359
+ };
1360
+ };
1361
+ /** @description Bad request */
1362
+ 400: {
1363
+ headers: {
1364
+ [name: string]: unknown;
1365
+ };
1366
+ content: {
1367
+ 'application/json': {
1368
+ /** @example Error message describing the issue. */
1369
+ message: string;
1370
+ };
1371
+ };
1372
+ };
1373
+ /** @description Forbidden */
1374
+ 403: {
1375
+ headers: {
1376
+ [name: string]: unknown;
1377
+ };
1378
+ content: {
1379
+ 'application/json': {
1380
+ /** @example Error message describing the issue. */
1381
+ message: string;
1382
+ };
1383
+ };
1384
+ };
1385
+ /** @description Not found */
1386
+ 404: {
1387
+ headers: {
1388
+ [name: string]: unknown;
1389
+ };
1390
+ content: {
1391
+ 'application/json': {
1392
+ /** @example Error message describing the issue. */
1393
+ message: string;
1394
+ };
1395
+ };
1396
+ };
1397
+ /** @description Conflict */
1398
+ 409: {
1399
+ headers: {
1400
+ [name: string]: unknown;
1401
+ };
1402
+ content: {
1403
+ 'application/json': {
1404
+ /** @example Error message describing the issue. */
1405
+ message: string;
1406
+ };
1407
+ };
1408
+ };
1409
+ /** @description Internal server error */
1410
+ 500: {
1411
+ headers: {
1412
+ [name: string]: unknown;
1413
+ };
1414
+ content: {
1415
+ 'application/json': {
1416
+ /** @example Error message describing the issue. */
1417
+ message: string;
1418
+ };
1419
+ };
1420
+ };
1421
+ };
1422
+ };
1423
+ delete?: never;
1424
+ options?: never;
1425
+ head?: never;
1426
+ patch?: never;
1427
+ trace?: never;
1428
+ };
1429
+ '/api/v0/documents:delete': {
1430
+ parameters: {
1431
+ query?: never;
1432
+ header?: never;
1433
+ path?: never;
1434
+ cookie?: never;
1435
+ };
1436
+ get?: never;
1437
+ put?: never;
1438
+ post: {
1439
+ parameters: {
1440
+ query?: never;
1441
+ header?: never;
1442
+ path?: never;
1443
+ cookie?: never;
1444
+ };
1445
+ requestBody?: {
1446
+ content: {
1447
+ 'application/json': components['schemas']['DeleteDocumentRequest'];
1448
+ };
1449
+ };
1450
+ responses: {
1451
+ /** @description Documents deleted */
1452
+ 200: {
1453
+ headers: {
1454
+ [name: string]: unknown;
1455
+ };
1456
+ content: {
1457
+ 'application/json': components['schemas']['DeleteDocumentResponse'];
1458
+ };
1459
+ };
1460
+ /** @description Bad request */
1461
+ 400: {
1462
+ headers: {
1463
+ [name: string]: unknown;
1464
+ };
1465
+ content: {
1466
+ 'application/json': {
1467
+ /** @example Error message describing the issue. */
1468
+ message: string;
1469
+ };
1470
+ };
1471
+ };
1472
+ /** @description Forbidden */
1473
+ 403: {
1474
+ headers: {
1475
+ [name: string]: unknown;
1476
+ };
1477
+ content: {
1478
+ 'application/json': {
1479
+ /** @example Error message describing the issue. */
1480
+ message: string;
1481
+ };
1482
+ };
1483
+ };
1484
+ /** @description Not found */
1485
+ 404: {
1486
+ headers: {
1487
+ [name: string]: unknown;
1488
+ };
1489
+ content: {
1490
+ 'application/json': {
1491
+ /** @example Error message describing the issue. */
1492
+ message: string;
1493
+ };
1494
+ };
1495
+ };
1496
+ /** @description Internal server error */
1497
+ 500: {
1498
+ headers: {
1499
+ [name: string]: unknown;
1500
+ };
1501
+ content: {
1502
+ 'application/json': {
1503
+ /** @example Error message describing the issue. */
1504
+ message: string;
1505
+ };
1506
+ };
1507
+ };
1508
+ };
1509
+ };
1510
+ delete?: never;
1511
+ options?: never;
1512
+ head?: never;
1513
+ patch?: never;
1514
+ trace?: never;
1515
+ };
1516
+ '/api/v0/document_versions:count': {
1517
+ parameters: {
1518
+ query?: never;
1519
+ header?: never;
1520
+ path?: never;
1521
+ cookie?: never;
1522
+ };
1523
+ get?: never;
1524
+ put?: never;
1525
+ post: {
1526
+ parameters: {
1527
+ query?: never;
1528
+ header?: never;
1529
+ path?: never;
1530
+ cookie?: never;
1531
+ };
1532
+ requestBody?: {
1533
+ content: {
1534
+ 'application/json': components['schemas']['CountDocumentVersionRequest'];
1535
+ };
1536
+ };
1537
+ responses: {
1538
+ /** @description Document version count */
1539
+ 200: {
1540
+ headers: {
1541
+ [name: string]: unknown;
1542
+ };
1543
+ content: {
1544
+ 'application/json': components['schemas']['CountDocumentVersionResponse'];
1545
+ };
1546
+ };
1547
+ /** @description Bad request */
1548
+ 400: {
1549
+ headers: {
1550
+ [name: string]: unknown;
1551
+ };
1552
+ content: {
1553
+ 'application/json': {
1554
+ /** @example Error message describing the issue. */
1555
+ message: string;
1556
+ };
1557
+ };
1558
+ };
1559
+ /** @description Forbidden */
1560
+ 403: {
1561
+ headers: {
1562
+ [name: string]: unknown;
1563
+ };
1564
+ content: {
1565
+ 'application/json': {
1566
+ /** @example Error message describing the issue. */
1567
+ message: string;
1568
+ };
1569
+ };
1570
+ };
1571
+ /** @description Not found */
1572
+ 404: {
1573
+ headers: {
1574
+ [name: string]: unknown;
1575
+ };
1576
+ content: {
1577
+ 'application/json': {
1578
+ /** @example Error message describing the issue. */
1579
+ message: string;
1580
+ };
1581
+ };
1582
+ };
1583
+ /** @description Internal server error */
1584
+ 500: {
1585
+ headers: {
1586
+ [name: string]: unknown;
1587
+ };
1588
+ content: {
1589
+ 'application/json': {
1590
+ /** @example Error message describing the issue. */
1591
+ message: string;
1592
+ };
1593
+ };
1594
+ };
1595
+ };
1596
+ };
1597
+ delete?: never;
1598
+ options?: never;
1599
+ head?: never;
1600
+ patch?: never;
1601
+ trace?: never;
1602
+ };
1603
+ '/api/v0/document_versions:create': {
1604
+ parameters: {
1605
+ query?: never;
1606
+ header?: never;
1607
+ path?: never;
1608
+ cookie?: never;
1609
+ };
1610
+ get?: never;
1611
+ put?: never;
1612
+ post: {
1613
+ parameters: {
1614
+ query?: never;
1615
+ header?: never;
1616
+ path?: never;
1617
+ cookie?: never;
1618
+ };
1619
+ requestBody?: {
1620
+ content: {
1621
+ 'application/json': components['schemas']['CreateDocumentVersionRequest'];
1622
+ };
1623
+ };
1624
+ responses: {
1625
+ /** @description Document version created */
1626
+ 201: {
1627
+ headers: {
1628
+ [name: string]: unknown;
1629
+ };
1630
+ content: {
1631
+ 'application/json': components['schemas']['CreateDocumentVersionResponse'];
1632
+ };
1633
+ };
1634
+ /** @description Bad request */
1635
+ 400: {
1636
+ headers: {
1637
+ [name: string]: unknown;
1638
+ };
1639
+ content: {
1640
+ 'application/json': {
1641
+ /** @example Error message describing the issue. */
1642
+ message: string;
1643
+ };
1644
+ };
1645
+ };
1646
+ /** @description Forbidden */
1647
+ 403: {
1648
+ headers: {
1649
+ [name: string]: unknown;
1650
+ };
1651
+ content: {
1652
+ 'application/json': {
1653
+ /** @example Error message describing the issue. */
1654
+ message: string;
1655
+ };
1656
+ };
1657
+ };
1658
+ /** @description Not found */
1659
+ 404: {
1660
+ headers: {
1661
+ [name: string]: unknown;
1662
+ };
1663
+ content: {
1664
+ 'application/json': {
1665
+ /** @example Error message describing the issue. */
1666
+ message: string;
1667
+ };
1668
+ };
1669
+ };
1670
+ /** @description Internal server error */
1671
+ 500: {
1672
+ headers: {
1673
+ [name: string]: unknown;
1674
+ };
1675
+ content: {
1676
+ 'application/json': {
1677
+ /** @example Error message describing the issue. */
1678
+ message: string;
1679
+ };
1680
+ };
1681
+ };
1682
+ };
1683
+ };
1684
+ delete?: never;
1685
+ options?: never;
1686
+ head?: never;
1687
+ patch?: never;
1688
+ trace?: never;
1689
+ };
1690
+ '/api/v0/document_versions:find': {
1691
+ parameters: {
1692
+ query?: never;
1693
+ header?: never;
1694
+ path?: never;
1695
+ cookie?: never;
1696
+ };
1697
+ get?: never;
1698
+ put?: never;
1699
+ post: {
1700
+ parameters: {
1701
+ query?: never;
1702
+ header?: never;
1703
+ path?: never;
1704
+ cookie?: never;
1705
+ };
1706
+ requestBody?: {
1707
+ content: {
1708
+ 'application/json': components['schemas']['FindDocumentVersionsRequest'];
1709
+ };
1710
+ };
1711
+ responses: {
1712
+ /** @description Document versions found */
1713
+ 200: {
1714
+ headers: {
1715
+ [name: string]: unknown;
1716
+ };
1717
+ content: {
1718
+ 'application/json': components['schemas']['FindDocumentVersionsResponse'];
1719
+ };
1720
+ };
1721
+ /** @description Bad request */
1722
+ 400: {
1723
+ headers: {
1724
+ [name: string]: unknown;
1725
+ };
1726
+ content: {
1727
+ 'application/json': {
1728
+ /** @example Error message describing the issue. */
1729
+ message: string;
1730
+ };
1731
+ };
1732
+ };
1733
+ /** @description Forbidden */
1734
+ 403: {
1735
+ headers: {
1736
+ [name: string]: unknown;
1737
+ };
1738
+ content: {
1739
+ 'application/json': {
1740
+ /** @example Error message describing the issue. */
1741
+ message: string;
1742
+ };
1743
+ };
1744
+ };
1745
+ /** @description Not found */
1746
+ 404: {
1747
+ headers: {
1748
+ [name: string]: unknown;
1749
+ };
1750
+ content: {
1751
+ 'application/json': {
1752
+ /** @example Error message describing the issue. */
1753
+ message: string;
1754
+ };
1755
+ };
1756
+ };
1757
+ /** @description Internal server error */
1758
+ 500: {
1759
+ headers: {
1760
+ [name: string]: unknown;
1761
+ };
1762
+ content: {
1763
+ 'application/json': {
1764
+ /** @example Error message describing the issue. */
1765
+ message: string;
1766
+ };
1767
+ };
1768
+ };
1769
+ };
1770
+ };
1771
+ delete?: never;
1772
+ options?: never;
1773
+ head?: never;
1774
+ patch?: never;
1775
+ trace?: never;
1776
+ };
1777
+ '/api/v0/document_versions:update': {
1778
+ parameters: {
1779
+ query?: never;
1780
+ header?: never;
1781
+ path?: never;
1782
+ cookie?: never;
1783
+ };
1784
+ get?: never;
1785
+ put?: never;
1786
+ post: {
1787
+ parameters: {
1788
+ query?: never;
1789
+ header?: never;
1790
+ path?: never;
1791
+ cookie?: never;
1792
+ };
1793
+ requestBody?: {
1794
+ content: {
1795
+ 'application/json': components['schemas']['UpdateDocumentVersionRequest'];
1796
+ };
1797
+ };
1798
+ responses: {
1799
+ /** @description Document versions updated */
1800
+ 200: {
1801
+ headers: {
1802
+ [name: string]: unknown;
1803
+ };
1804
+ content: {
1805
+ 'application/json': components['schemas']['UpdateDocumentVersionResponse'];
1806
+ };
1807
+ };
1808
+ /** @description Bad request */
1809
+ 400: {
1810
+ headers: {
1811
+ [name: string]: unknown;
1812
+ };
1813
+ content: {
1814
+ 'application/json': {
1815
+ /** @example Error message describing the issue. */
1816
+ message: string;
1817
+ };
1818
+ };
1819
+ };
1820
+ /** @description Forbidden */
1821
+ 403: {
1822
+ headers: {
1823
+ [name: string]: unknown;
1824
+ };
1825
+ content: {
1826
+ 'application/json': {
1827
+ /** @example Error message describing the issue. */
1828
+ message: string;
1829
+ };
1830
+ };
1831
+ };
1832
+ /** @description Not found */
1833
+ 404: {
1834
+ headers: {
1835
+ [name: string]: unknown;
1836
+ };
1837
+ content: {
1838
+ 'application/json': {
1839
+ /** @example Error message describing the issue. */
1840
+ message: string;
1841
+ };
1842
+ };
1843
+ };
1844
+ /** @description Internal server error */
1845
+ 500: {
1846
+ headers: {
1847
+ [name: string]: unknown;
1848
+ };
1849
+ content: {
1850
+ 'application/json': {
1851
+ /** @example Error message describing the issue. */
1852
+ message: string;
1853
+ };
1854
+ };
1855
+ };
1856
+ };
1857
+ };
1858
+ delete?: never;
1859
+ options?: never;
1860
+ head?: never;
1861
+ patch?: never;
1862
+ trace?: never;
1863
+ };
1864
+ '/api/v0/document_versions:delete': {
1865
+ parameters: {
1866
+ query?: never;
1867
+ header?: never;
1868
+ path?: never;
1869
+ cookie?: never;
1870
+ };
1871
+ get?: never;
1872
+ put?: never;
1873
+ post: {
1874
+ parameters: {
1875
+ query?: never;
1876
+ header?: never;
1877
+ path?: never;
1878
+ cookie?: never;
1879
+ };
1880
+ requestBody?: {
1881
+ content: {
1882
+ 'application/json': components['schemas']['DeleteDocumentVersionRequest'];
1883
+ };
1884
+ };
1885
+ responses: {
1886
+ /** @description Document versions deleted */
1887
+ 200: {
1888
+ headers: {
1889
+ [name: string]: unknown;
1890
+ };
1891
+ content: {
1892
+ 'application/json': components['schemas']['DeleteDocumentVersionResponse'];
1893
+ };
1894
+ };
1895
+ /** @description Bad request */
1896
+ 400: {
1897
+ headers: {
1898
+ [name: string]: unknown;
1899
+ };
1900
+ content: {
1901
+ 'application/json': {
1902
+ /** @example Error message describing the issue. */
1903
+ message: string;
1904
+ };
1905
+ };
1906
+ };
1907
+ /** @description Forbidden */
1908
+ 403: {
1909
+ headers: {
1910
+ [name: string]: unknown;
1911
+ };
1912
+ content: {
1913
+ 'application/json': {
1914
+ /** @example Error message describing the issue. */
1915
+ message: string;
1916
+ };
1917
+ };
1918
+ };
1919
+ /** @description Not found */
1920
+ 404: {
1921
+ headers: {
1922
+ [name: string]: unknown;
1923
+ };
1924
+ content: {
1925
+ 'application/json': {
1926
+ /** @example Error message describing the issue. */
1927
+ message: string;
1928
+ };
1929
+ };
1930
+ };
1931
+ /** @description Internal server error */
1932
+ 500: {
1933
+ headers: {
1934
+ [name: string]: unknown;
1935
+ };
1936
+ content: {
1937
+ 'application/json': {
1938
+ /** @example Error message describing the issue. */
1939
+ message: string;
1940
+ };
1941
+ };
1942
+ };
1943
+ };
1944
+ };
1945
+ delete?: never;
1946
+ options?: never;
1947
+ head?: never;
1948
+ patch?: never;
1949
+ trace?: never;
1950
+ };
1951
+ '/api/v0/uploads/file': {
1952
+ parameters: {
1953
+ query?: never;
1954
+ header?: never;
1955
+ path?: never;
1956
+ cookie?: never;
1957
+ };
1958
+ get?: never;
1959
+ put?: never;
1960
+ post: {
1961
+ parameters: {
1962
+ query?: never;
1963
+ header?: never;
1964
+ path?: never;
1965
+ cookie?: never;
1966
+ };
1967
+ requestBody?: {
1968
+ content: {
1969
+ 'multipart/form-data': components['schemas']['UploadFileRequest'];
1970
+ };
1971
+ };
1972
+ responses: {
1973
+ /** @description File uploaded successfully */
1974
+ 200: {
1975
+ headers: {
1976
+ [name: string]: unknown;
1977
+ };
1978
+ content: {
1979
+ 'application/json': components['schemas']['UploadFileResponse'];
1980
+ };
1981
+ };
1982
+ /** @description Bad request */
1983
+ 400: {
1984
+ headers: {
1985
+ [name: string]: unknown;
1986
+ };
1987
+ content: {
1988
+ 'application/json': {
1989
+ /** @example Error message describing the issue. */
1990
+ message: string;
1991
+ };
1992
+ };
1993
+ };
1994
+ /** @description Forbidden - Super user uploads not supported */
1995
+ 403: {
1996
+ headers: {
1997
+ [name: string]: unknown;
1998
+ };
1999
+ content: {
2000
+ 'application/json': {
2001
+ /** @example Error message describing the issue. */
2002
+ message: string;
2003
+ };
2004
+ };
2005
+ };
2006
+ /** @description Internal server error */
2007
+ 500: {
2008
+ headers: {
2009
+ [name: string]: unknown;
2010
+ };
2011
+ content: {
2012
+ 'application/json': {
2013
+ /** @example Error message describing the issue. */
2014
+ message: string;
2015
+ };
2016
+ };
2017
+ };
2018
+ };
2019
+ };
2020
+ delete?: never;
2021
+ options?: never;
2022
+ head?: never;
2023
+ patch?: never;
2024
+ trace?: never;
2025
+ };
2026
+ '/api/v0/uploads/download': {
2027
+ parameters: {
2028
+ query?: never;
2029
+ header?: never;
2030
+ path?: never;
2031
+ cookie?: never;
2032
+ };
2033
+ get?: never;
2034
+ put?: never;
2035
+ post: {
2036
+ parameters: {
2037
+ query?: never;
2038
+ header?: never;
2039
+ path?: never;
2040
+ cookie?: never;
2041
+ };
2042
+ requestBody?: {
2043
+ content: {
2044
+ 'application/json': components['schemas']['DownloadFileRequest'];
2045
+ };
2046
+ };
2047
+ responses: {
2048
+ /** @description File downloaded successfully */
2049
+ 200: {
2050
+ headers: {
2051
+ [name: string]: unknown;
2052
+ };
2053
+ content: {
2054
+ 'application/octet-stream': string;
2055
+ };
2056
+ };
2057
+ /** @description Bad request */
2058
+ 400: {
2059
+ headers: {
2060
+ [name: string]: unknown;
2061
+ };
2062
+ content: {
2063
+ 'application/json': {
2064
+ /** @example Error message describing the issue. */
2065
+ message: string;
2066
+ };
2067
+ };
2068
+ };
2069
+ /** @description Forbidden - Super user downloads not supported */
2070
+ 403: {
2071
+ headers: {
2072
+ [name: string]: unknown;
2073
+ };
2074
+ content: {
2075
+ 'application/json': {
2076
+ /** @example Error message describing the issue. */
2077
+ message: string;
2078
+ };
2079
+ };
2080
+ };
2081
+ /** @description File not found */
2082
+ 404: {
2083
+ headers: {
2084
+ [name: string]: unknown;
2085
+ };
2086
+ content: {
2087
+ 'application/json': {
2088
+ /** @example Error message describing the issue. */
2089
+ message: string;
2090
+ };
2091
+ };
2092
+ };
2093
+ /** @description Internal server error */
2094
+ 500: {
2095
+ headers: {
2096
+ [name: string]: unknown;
2097
+ };
2098
+ content: {
2099
+ 'application/json': {
2100
+ /** @example Error message describing the issue. */
2101
+ message: string;
2102
+ };
2103
+ };
2104
+ };
2105
+ };
2106
+ };
2107
+ delete?: never;
2108
+ options?: never;
2109
+ head?: never;
2110
+ patch?: never;
2111
+ trace?: never;
2112
+ };
2113
+ '/api/v0/uploads/multipart/initiate': {
2114
+ parameters: {
2115
+ query?: never;
2116
+ header?: never;
2117
+ path?: never;
2118
+ cookie?: never;
2119
+ };
2120
+ get?: never;
2121
+ put?: never;
2122
+ post: {
2123
+ parameters: {
2124
+ query?: never;
2125
+ header?: never;
2126
+ path?: never;
2127
+ cookie?: never;
2128
+ };
2129
+ requestBody?: {
2130
+ content: {
2131
+ 'application/json': components['schemas']['InitiateMultipartUploadRequest'];
2132
+ };
2133
+ };
2134
+ responses: {
2135
+ /** @description Multipart upload initiated */
2136
+ 200: {
2137
+ headers: {
2138
+ [name: string]: unknown;
2139
+ };
2140
+ content: {
2141
+ 'application/json': components['schemas']['InitiateMultipartUploadResponse'];
2142
+ };
2143
+ };
2144
+ /** @description Bad request */
2145
+ 400: {
2146
+ headers: {
2147
+ [name: string]: unknown;
2148
+ };
2149
+ content: {
2150
+ 'application/json': {
2151
+ /** @example Error message describing the issue. */
2152
+ message: string;
2153
+ };
2154
+ };
2155
+ };
2156
+ /** @description Forbidden - Super user uploads not supported */
2157
+ 403: {
2158
+ headers: {
2159
+ [name: string]: unknown;
2160
+ };
2161
+ content: {
2162
+ 'application/json': {
2163
+ /** @example Error message describing the issue. */
2164
+ message: string;
2165
+ };
2166
+ };
2167
+ };
2168
+ /** @description Internal server error */
2169
+ 500: {
2170
+ headers: {
2171
+ [name: string]: unknown;
2172
+ };
2173
+ content: {
2174
+ 'application/json': {
2175
+ /** @example Error message describing the issue. */
2176
+ message: string;
2177
+ };
2178
+ };
2179
+ };
2180
+ };
2181
+ };
2182
+ delete?: never;
2183
+ options?: never;
2184
+ head?: never;
2185
+ patch?: never;
2186
+ trace?: never;
2187
+ };
2188
+ '/api/v0/uploads/multipart/parts': {
2189
+ parameters: {
2190
+ query?: never;
2191
+ header?: never;
2192
+ path?: never;
2193
+ cookie?: never;
2194
+ };
2195
+ get?: never;
2196
+ put?: never;
2197
+ post: {
2198
+ parameters: {
2199
+ query?: never;
2200
+ header?: never;
2201
+ path?: never;
2202
+ cookie?: never;
2203
+ };
2204
+ requestBody?: {
2205
+ content: {
2206
+ 'application/json': components['schemas']['GenerateUploadPartUrlsRequest'];
2207
+ };
2208
+ };
2209
+ responses: {
2210
+ /** @description Upload part URLs generated */
2211
+ 200: {
2212
+ headers: {
2213
+ [name: string]: unknown;
2214
+ };
2215
+ content: {
2216
+ 'application/json': components['schemas']['GenerateUploadPartUrlsResponse'];
2217
+ };
2218
+ };
2219
+ /** @description Bad request */
2220
+ 400: {
2221
+ headers: {
2222
+ [name: string]: unknown;
2223
+ };
2224
+ content: {
2225
+ 'application/json': {
2226
+ /** @example Error message describing the issue. */
2227
+ message: string;
2228
+ };
2229
+ };
2230
+ };
2231
+ /** @description Forbidden - Super user uploads not supported */
2232
+ 403: {
2233
+ headers: {
2234
+ [name: string]: unknown;
2235
+ };
2236
+ content: {
2237
+ 'application/json': {
2238
+ /** @example Error message describing the issue. */
2239
+ message: string;
2240
+ };
2241
+ };
2242
+ };
2243
+ /** @description Internal server error */
2244
+ 500: {
2245
+ headers: {
2246
+ [name: string]: unknown;
2247
+ };
2248
+ content: {
2249
+ 'application/json': {
2250
+ /** @example Error message describing the issue. */
2251
+ message: string;
2252
+ };
2253
+ };
2254
+ };
2255
+ };
2256
+ };
2257
+ delete?: never;
2258
+ options?: never;
2259
+ head?: never;
2260
+ patch?: never;
2261
+ trace?: never;
2262
+ };
2263
+ '/api/v0/uploads/multipart/complete': {
2264
+ parameters: {
2265
+ query?: never;
2266
+ header?: never;
2267
+ path?: never;
2268
+ cookie?: never;
2269
+ };
2270
+ get?: never;
2271
+ put?: never;
2272
+ post: {
2273
+ parameters: {
2274
+ query?: never;
2275
+ header?: never;
2276
+ path?: never;
2277
+ cookie?: never;
2278
+ };
2279
+ requestBody?: {
2280
+ content: {
2281
+ 'application/json': components['schemas']['CompleteMultipartUploadRequest'];
2282
+ };
2283
+ };
2284
+ responses: {
2285
+ /** @description Multipart upload completed */
2286
+ 200: {
2287
+ headers: {
2288
+ [name: string]: unknown;
2289
+ };
2290
+ content: {
2291
+ 'application/json': components['schemas']['CompleteMultipartUploadResponse'];
2292
+ };
2293
+ };
2294
+ /** @description Bad request */
2295
+ 400: {
2296
+ headers: {
2297
+ [name: string]: unknown;
2298
+ };
2299
+ content: {
2300
+ 'application/json': {
2301
+ /** @example Error message describing the issue. */
2302
+ message: string;
2303
+ };
2304
+ };
2305
+ };
2306
+ /** @description Forbidden - Super user uploads not supported */
2307
+ 403: {
2308
+ headers: {
2309
+ [name: string]: unknown;
2310
+ };
2311
+ content: {
2312
+ 'application/json': {
2313
+ /** @example Error message describing the issue. */
2314
+ message: string;
2315
+ };
2316
+ };
2317
+ };
2318
+ /** @description Internal server error */
2319
+ 500: {
2320
+ headers: {
2321
+ [name: string]: unknown;
2322
+ };
2323
+ content: {
2324
+ 'application/json': {
2325
+ /** @example Error message describing the issue. */
2326
+ message: string;
2327
+ };
2328
+ };
2329
+ };
2330
+ };
2331
+ };
2332
+ delete?: never;
2333
+ options?: never;
2334
+ head?: never;
2335
+ patch?: never;
2336
+ trace?: never;
2337
+ };
2338
+ '/api/v0/uploads/multipart/abort': {
2339
+ parameters: {
2340
+ query?: never;
2341
+ header?: never;
2342
+ path?: never;
2343
+ cookie?: never;
2344
+ };
2345
+ get?: never;
2346
+ put?: never;
2347
+ post: {
2348
+ parameters: {
2349
+ query?: never;
2350
+ header?: never;
2351
+ path?: never;
2352
+ cookie?: never;
2353
+ };
2354
+ requestBody?: {
2355
+ content: {
2356
+ 'application/json': components['schemas']['AbortMultipartUploadRequest'];
2357
+ };
2358
+ };
2359
+ responses: {
2360
+ /** @description Multipart upload aborted */
2361
+ 200: {
2362
+ headers: {
2363
+ [name: string]: unknown;
2364
+ };
2365
+ content: {
2366
+ 'application/json': components['schemas']['AbortMultipartUploadResponse'];
2367
+ };
2368
+ };
2369
+ /** @description Bad request */
2370
+ 400: {
2371
+ headers: {
2372
+ [name: string]: unknown;
2373
+ };
2374
+ content: {
2375
+ 'application/json': {
2376
+ /** @example Error message describing the issue. */
2377
+ message: string;
2378
+ };
2379
+ };
2380
+ };
2381
+ /** @description Forbidden - Super user uploads not supported */
2382
+ 403: {
2383
+ headers: {
2384
+ [name: string]: unknown;
2385
+ };
2386
+ content: {
2387
+ 'application/json': {
2388
+ /** @example Error message describing the issue. */
2389
+ message: string;
2390
+ };
2391
+ };
2392
+ };
2393
+ /** @description Internal server error */
2394
+ 500: {
2395
+ headers: {
2396
+ [name: string]: unknown;
2397
+ };
2398
+ content: {
2399
+ 'application/json': {
2400
+ /** @example Error message describing the issue. */
2401
+ message: string;
2402
+ };
2403
+ };
2404
+ };
2405
+ };
2406
+ };
2407
+ delete?: never;
2408
+ options?: never;
2409
+ head?: never;
2410
+ patch?: never;
2411
+ trace?: never;
2412
+ };
2413
+ };
2414
+ export type webhooks = Record<string, never>;
2415
+ export type components = {
2416
+ schemas: {
2417
+ AuthContextResponse: {
2418
+ /**
2419
+ * @description Type of authentication scope
2420
+ * @example project
2421
+ * @enum {string}
2422
+ */
2423
+ scopeType: 'super_user' | 'project';
2424
+ /**
2425
+ * @description Content system ID if scopeType is project, undefined for super_user
2426
+ * @example 4cfea8de-4f44-4efd-a8fc-7d539249e9f1
2427
+ */
2428
+ contentSystemScope?: string;
2429
+ };
2430
+ HealthResponse: {
2431
+ /** @example ok */
2432
+ status: string;
2433
+ /** @example connected */
2434
+ database: string;
2435
+ /** @example available */
2436
+ s3: string;
2437
+ /** @example 2026-01-01T00:00:00.000Z */
2438
+ timestamp: string;
2439
+ };
2440
+ ApiKey: {
2441
+ /** @example 123abc */
2442
+ id: string;
2443
+ /** @example My API Key */
2444
+ name: string;
2445
+ /** @example 123def */
2446
+ contentSystemId: string;
2447
+ /** @example BRTRKFsL */
2448
+ shortToken: string;
2449
+ /**
2450
+ * Format: date
2451
+ * @example 2024-01-01T00:00:00.000Z
2452
+ */
2453
+ createdAt: string;
2454
+ /**
2455
+ * Format: date
2456
+ * @example 2024-01-01T00:00:00.000Z
2457
+ */
2458
+ updatedAt: string;
2459
+ };
2460
+ ListApiKeysResponse: {
2461
+ data: components['schemas']['ApiKey'][];
2462
+ total: number;
2463
+ };
2464
+ CreateApiKeyResponse: {
2465
+ /** @example 123abc */
2466
+ id: string;
2467
+ /** @example 123def */
2468
+ contentSystemId: string;
2469
+ /** @example BRTRKFsL */
2470
+ shortToken: string;
2471
+ /**
2472
+ * @description Full API key - only returned on creation
2473
+ * @example figma_BRTRKFsL_51FwqftsmMDHHbJAMEXXHCgG
2474
+ */
2475
+ fullToken: string;
2476
+ /**
2477
+ * Format: date
2478
+ * @example 2024-01-01T00:00:00.000Z
2479
+ */
2480
+ createdAt: string;
2481
+ /**
2482
+ * Format: date
2483
+ * @example 2024-01-01T00:00:00.000Z
2484
+ */
2485
+ updatedAt: string;
2486
+ };
2487
+ CreateApiKeyRequest: {
2488
+ /** @example My API Key */
2489
+ name: string;
2490
+ /** @example 123def */
2491
+ contentSystemId: string;
2492
+ };
2493
+ ContentSystem: {
2494
+ /** @example cms-xxxxx-xxxxx */
2495
+ id: string;
2496
+ /** @example demo-tenant */
2497
+ owningKey: string;
2498
+ /** @example Demo CMS */
2499
+ name: string;
2500
+ /**
2501
+ * Format: date
2502
+ * @example 2024-01-01T00:00:00Z
2503
+ */
2504
+ createdAt: string;
2505
+ /**
2506
+ * Format: date
2507
+ * @example 2024-01-01T00:00:00Z
2508
+ */
2509
+ updatedAt: string;
2510
+ };
2511
+ CreateContentSystemResponse: {
2512
+ /** @example cms-xxxxx-xxxxx */
2513
+ id: string;
2514
+ /** @example demo-tenant */
2515
+ owningKey: string;
2516
+ /** @example Demo CMS */
2517
+ name: string;
2518
+ /**
2519
+ * Format: date
2520
+ * @example 2024-01-01T00:00:00Z
2521
+ */
2522
+ createdAt: string;
2523
+ /**
2524
+ * Format: date
2525
+ * @example 2024-01-01T00:00:00Z
2526
+ */
2527
+ updatedAt: string;
2528
+ };
2529
+ CreateContentSystemRequest: {
2530
+ /** @example demo-tenant */
2531
+ owningKey: string;
2532
+ /** @example Demo CMS */
2533
+ name: string;
2534
+ };
2535
+ RetrieveContentSystemResponse: {
2536
+ /** @example cms-xxxxx-xxxxx */
2537
+ id: string;
2538
+ /** @example demo-tenant */
2539
+ owningKey: string;
2540
+ /** @example Demo CMS */
2541
+ name: string;
2542
+ /**
2543
+ * Format: date
2544
+ * @example 2024-01-01T00:00:00Z
2545
+ */
2546
+ createdAt: string;
2547
+ /**
2548
+ * Format: date
2549
+ * @example 2024-01-01T00:00:00Z
2550
+ */
2551
+ updatedAt: string;
2552
+ };
2553
+ UpdateContentSystemResponse: {
2554
+ /** @example cms-xxxxx-xxxxx */
2555
+ id: string;
2556
+ /** @example demo-tenant */
2557
+ owningKey: string;
2558
+ /** @example Demo CMS */
2559
+ name: string;
2560
+ /**
2561
+ * Format: date
2562
+ * @example 2024-01-01T00:00:00Z
2563
+ */
2564
+ createdAt: string;
2565
+ /**
2566
+ * Format: date
2567
+ * @example 2024-01-01T00:00:00Z
2568
+ */
2569
+ updatedAt: string;
2570
+ };
2571
+ UpdateContentSystemRequest: {
2572
+ /** @example demo-tenant */
2573
+ owningKey?: string;
2574
+ /** @example Demo CMS */
2575
+ name?: string;
2576
+ };
2577
+ Collection: {
2578
+ /** @example col-xxxxx-xxxxx */
2579
+ id: string;
2580
+ /** @example cms-xxxxx-xxxxx */
2581
+ contentSystemId: string;
2582
+ /** @example posts */
2583
+ key: string;
2584
+ /**
2585
+ * Format: date
2586
+ * @example 2024-01-01T00:00:00Z
2587
+ */
2588
+ createdAt: string;
2589
+ /**
2590
+ * Format: date
2591
+ * @example 2024-01-01T00:00:00Z
2592
+ */
2593
+ updatedAt: string;
2594
+ };
2595
+ CreateCollectionResponse: {
2596
+ /** @example col-xxxxx-xxxxx */
2597
+ id: string;
2598
+ /** @example cms-xxxxx-xxxxx */
2599
+ contentSystemId: string;
2600
+ /** @example posts */
2601
+ key: string;
2602
+ /**
2603
+ * Format: date
2604
+ * @example 2024-01-01T00:00:00Z
2605
+ */
2606
+ createdAt: string;
2607
+ /**
2608
+ * Format: date
2609
+ * @example 2024-01-01T00:00:00Z
2610
+ */
2611
+ updatedAt: string;
2612
+ };
2613
+ CreateCollectionRequest: {
2614
+ /** @example posts */
2615
+ key: string;
2616
+ /** @example cms-xxxxx-xxxxx */
2617
+ contentSystemId: string;
2618
+ };
2619
+ RetrieveCollectionResponse: {
2620
+ /** @example col-xxxxx-xxxxx */
2621
+ id: string;
2622
+ /** @example cms-xxxxx-xxxxx */
2623
+ contentSystemId: string;
2624
+ /** @example posts */
2625
+ key: string;
2626
+ /**
2627
+ * Format: date
2628
+ * @example 2024-01-01T00:00:00Z
2629
+ */
2630
+ createdAt: string;
2631
+ /**
2632
+ * Format: date
2633
+ * @example 2024-01-01T00:00:00Z
2634
+ */
2635
+ updatedAt: string;
2636
+ };
2637
+ UpdateCollectionResponse: {
2638
+ /** @example col-xxxxx-xxxxx */
2639
+ id: string;
2640
+ /** @example cms-xxxxx-xxxxx */
2641
+ contentSystemId: string;
2642
+ /** @example posts */
2643
+ key: string;
2644
+ /**
2645
+ * Format: date
2646
+ * @example 2024-01-01T00:00:00Z
2647
+ */
2648
+ createdAt: string;
2649
+ /**
2650
+ * Format: date
2651
+ * @example 2024-01-01T00:00:00Z
2652
+ */
2653
+ updatedAt: string;
2654
+ };
2655
+ UpdateCollectionRequest: {
2656
+ /** @example posts */
2657
+ key: string;
2658
+ };
2659
+ CountDocumentResponse: {
2660
+ result: {
2661
+ /** @example 1 */
2662
+ count: number;
2663
+ };
2664
+ };
2665
+ DataValue: string | number | boolean | unknown | components['schemas']['DataValue'][] | {
2666
+ [key: string]: components['schemas']['DataValue'];
2667
+ } | unknown;
2668
+ /**
2669
+ * @example {
2670
+ * "and": [
2671
+ * {
2672
+ * "path": "status",
2673
+ * "operator": "equals",
2674
+ * "value": "published"
2675
+ * },
2676
+ * {
2677
+ * "path": "createdAt",
2678
+ * "operator": "greater_than",
2679
+ * "value": "2025-01-01T00:00:00Z"
2680
+ * }
2681
+ * ]
2682
+ * }
2683
+ */
2684
+ WhereClause: {
2685
+ and: components['schemas']['WhereClause'][];
2686
+ } | {
2687
+ or: components['schemas']['WhereClause'][];
2688
+ } | {
2689
+ path: string;
2690
+ operator: 'equals' | 'not_equals' | 'in' | 'not_in' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'like' | 'not_like' | 'all' | 'contains' | 'exists' | 'intersects' | 'near' | 'within';
2691
+ value: components['schemas']['DataValue'];
2692
+ };
2693
+ CountDocumentRequest: {
2694
+ /** @example cms-xxxxx-xxxxx */
2695
+ contentSystemId: string;
2696
+ /** @example col-xxxxx-xxxxx */
2697
+ collectionKey: string;
2698
+ where?: components['schemas']['WhereClause'];
2699
+ };
2700
+ /**
2701
+ * @example {
2702
+ * "title": "Placeholder title",
2703
+ * "content": "This is placeholder content"
2704
+ * }
2705
+ */
2706
+ DocumentData: {
2707
+ [key: string]: components['schemas']['DataValue'];
2708
+ };
2709
+ Document: {
2710
+ /** @example doc-xxxxx-xxxxx */
2711
+ id: string;
2712
+ /** @example cms-xxxxx-xxxxx */
2713
+ contentSystemId: string;
2714
+ /** @example col-xxxxx-xxxxx */
2715
+ collectionId: string;
2716
+ /** @example doc-key */
2717
+ key: string;
2718
+ data: components['schemas']['DocumentData'];
2719
+ /**
2720
+ * Format: date
2721
+ * @example 2024-01-01T00:00:00Z
2722
+ */
2723
+ createdAt: string;
2724
+ /**
2725
+ * Format: date
2726
+ * @example 2024-01-01T00:00:00Z
2727
+ */
2728
+ updatedAt: string;
2729
+ };
2730
+ CreateDocumentResponse: {
2731
+ result: {
2732
+ /** @example doc-xxxxx-xxxxx */
2733
+ id: string;
2734
+ } | {
2735
+ data: components['schemas']['Document'];
2736
+ };
2737
+ };
2738
+ JoinClause: unknown;
2739
+ LocaleClause: {
2740
+ locale: string;
2741
+ fallbackLocale: string;
2742
+ paths: string[];
2743
+ };
2744
+ /**
2745
+ * @example {
2746
+ * "mode": "include",
2747
+ * "paths": [
2748
+ * "title",
2749
+ * "author.name",
2750
+ * "tags"
2751
+ * ]
2752
+ * }
2753
+ */
2754
+ SelectClause: {
2755
+ /** @enum {string} */
2756
+ mode: 'exclude' | 'include';
2757
+ paths: string[];
2758
+ };
2759
+ CreateDocumentRequest: {
2760
+ /** @example cms-xxxxx-xxxxx */
2761
+ contentSystemId: string;
2762
+ /** @example col-xxxxx-xxxxx */
2763
+ collectionKey: string;
2764
+ /** @example doc-key */
2765
+ key: string;
2766
+ data: components['schemas']['DocumentData'];
2767
+ returning?: false | {
2768
+ join?: components['schemas']['JoinClause'];
2769
+ locale?: components['schemas']['LocaleClause'];
2770
+ select?: components['schemas']['SelectClause'];
2771
+ };
2772
+ };
2773
+ /**
2774
+ * @example {
2775
+ * "total": 100,
2776
+ * "current": {
2777
+ * "limit": 10,
2778
+ * "offset": 0
2779
+ * },
2780
+ * "next": {
2781
+ * "limit": 10,
2782
+ * "offset": 10
2783
+ * }
2784
+ * }
2785
+ */
2786
+ Pagination: {
2787
+ total: number;
2788
+ current: {
2789
+ limit: number;
2790
+ offset: number;
2791
+ };
2792
+ next?: {
2793
+ limit: number;
2794
+ offset: number;
2795
+ };
2796
+ prev?: {
2797
+ limit: number;
2798
+ offset: number;
2799
+ };
2800
+ };
2801
+ FindDocumentsResponse: {
2802
+ result: {
2803
+ data: components['schemas']['Document'][];
2804
+ pagination: components['schemas']['Pagination'];
2805
+ };
2806
+ };
2807
+ /**
2808
+ * @example [
2809
+ * {
2810
+ * "path": "createdAt",
2811
+ * "direction": "desc"
2812
+ * }
2813
+ * ]
2814
+ */
2815
+ SortClause: {
2816
+ path: string;
2817
+ /** @enum {string} */
2818
+ direction: 'asc' | 'desc';
2819
+ }[];
2820
+ FindDocumentsRequest: {
2821
+ /** @example cms-xxxxx-xxxxx */
2822
+ contentSystemId: string;
2823
+ /** @example col-xxxxx-xxxxx */
2824
+ collectionKey: string;
2825
+ join?: components['schemas']['JoinClause'];
2826
+ /** @example 10 */
2827
+ limit?: number;
2828
+ locale?: components['schemas']['LocaleClause'];
2829
+ /** @example 0 */
2830
+ offset?: number;
2831
+ select?: components['schemas']['SelectClause'];
2832
+ sort?: components['schemas']['SortClause'];
2833
+ where?: components['schemas']['WhereClause'];
2834
+ };
2835
+ UpdateDocumentResponse: {
2836
+ result?: {
2837
+ /** @example 1 */
2838
+ count: number;
2839
+ } | {
2840
+ data: components['schemas']['Document'][];
2841
+ };
2842
+ };
2843
+ /**
2844
+ * @example {
2845
+ * "title": "New Title",
2846
+ * "views": {
2847
+ * "$inc": 1
2848
+ * },
2849
+ * "status": "draft"
2850
+ * }
2851
+ */
2852
+ DataWithOperations: {
2853
+ [key: string]: components['schemas']['DataValue'];
2854
+ };
2855
+ UpdateDocumentRequest: {
2856
+ /** @example cms-xxxxx-xxxxx */
2857
+ contentSystemId: string;
2858
+ /** @example col-xxxxx-xxxxx */
2859
+ collectionKey: string;
2860
+ /** @example false */
2861
+ createOnMissing: false | {
2862
+ documentKey: string;
2863
+ };
2864
+ data: components['schemas']['DataWithOperations'];
2865
+ where: components['schemas']['WhereClause'];
2866
+ returning?: false | {
2867
+ join?: components['schemas']['JoinClause'];
2868
+ locale?: components['schemas']['LocaleClause'];
2869
+ select?: components['schemas']['SelectClause'];
2870
+ };
2871
+ };
2872
+ DeleteDocumentResponse: {
2873
+ result?: {
2874
+ /** @example 1 */
2875
+ count: number;
2876
+ } | {
2877
+ data: components['schemas']['Document'][];
2878
+ };
2879
+ };
2880
+ DeleteDocumentRequest: {
2881
+ /** @example cms-xxxxx-xxxxx */
2882
+ contentSystemId: string;
2883
+ /** @example col-xxxxx-xxxxx */
2884
+ collectionKey: string;
2885
+ where: components['schemas']['WhereClause'];
2886
+ returning?: false | {
2887
+ join?: components['schemas']['JoinClause'];
2888
+ locale?: components['schemas']['LocaleClause'];
2889
+ select?: components['schemas']['SelectClause'];
2890
+ };
2891
+ };
2892
+ CountDocumentVersionResponse: {
2893
+ result: {
2894
+ /** @example 1 */
2895
+ count: number;
2896
+ };
2897
+ };
2898
+ CountDocumentVersionRequest: {
2899
+ /** @example cms-xxxxx-xxxxx */
2900
+ contentSystemId: string;
2901
+ /** @example col-xxxxx-xxxxx */
2902
+ collectionKey: string;
2903
+ where?: components['schemas']['WhereClause'];
2904
+ };
2905
+ DocumentVersion: {
2906
+ /** @example ver-xxxxx-xxxxx */
2907
+ id: string;
2908
+ /** @example cms-xxxxx-xxxxx */
2909
+ contentSystemId: string;
2910
+ /** @example doc-xxxxx-xxxxx */
2911
+ documentId: string;
2912
+ /** @example true */
2913
+ latest: boolean;
2914
+ data: components['schemas']['DocumentData'];
2915
+ /**
2916
+ * Format: date
2917
+ * @example 2024-01-01T00:00:00Z
2918
+ */
2919
+ createdAt: string;
2920
+ /**
2921
+ * Format: date
2922
+ * @example 2024-01-01T00:00:00Z
2923
+ */
2924
+ updatedAt: string;
2925
+ };
2926
+ CreateDocumentVersionResponse: {
2927
+ result: {
2928
+ /** @example ver-xxxxx-xxxxx */
2929
+ id: string;
2930
+ } | {
2931
+ data: components['schemas']['DocumentVersion'];
2932
+ };
2933
+ };
2934
+ CreateDocumentVersionRequest: {
2935
+ /** @example cms-xxxxx-xxxxx */
2936
+ contentSystemId: string;
2937
+ /** @example col-xxxxx-xxxxx */
2938
+ collectionKey: string;
2939
+ /** @example doc-xxxxx-xxxxx */
2940
+ documentKey: string;
2941
+ /** @example true */
2942
+ latest?: boolean;
2943
+ data: components['schemas']['DocumentData'];
2944
+ returning?: false | {
2945
+ join?: components['schemas']['JoinClause'];
2946
+ locale?: components['schemas']['LocaleClause'];
2947
+ select?: components['schemas']['SelectClause'];
2948
+ };
2949
+ };
2950
+ FindDocumentVersionsResponse: {
2951
+ result: {
2952
+ data: components['schemas']['DocumentVersion'][];
2953
+ pagination: components['schemas']['Pagination'];
2954
+ };
2955
+ };
2956
+ FindDocumentVersionsRequest: {
2957
+ /** @example cms-xxxxx-xxxxx */
2958
+ contentSystemId: string;
2959
+ /** @example col-xxxxx-xxxxx */
2960
+ collectionKey: string;
2961
+ join?: components['schemas']['JoinClause'];
2962
+ /** @example 10 */
2963
+ limit?: number;
2964
+ locale?: components['schemas']['LocaleClause'];
2965
+ /** @example 0 */
2966
+ offset?: number;
2967
+ select?: components['schemas']['SelectClause'];
2968
+ sort?: components['schemas']['SortClause'];
2969
+ where?: components['schemas']['WhereClause'];
2970
+ };
2971
+ UpdateDocumentVersionResponse: {
2972
+ result?: {
2973
+ /** @example 1 */
2974
+ count: number;
2975
+ } | {
2976
+ data: components['schemas']['DocumentVersion'][];
2977
+ };
2978
+ };
2979
+ UpdateDocumentVersionRequest: {
2980
+ /** @example cms-xxxxx-xxxxx */
2981
+ contentSystemId: string;
2982
+ /** @example col-xxxxx-xxxxx */
2983
+ collectionKey: string;
2984
+ /** @example false */
2985
+ createOnMissing: false | {
2986
+ documentKey: string;
2987
+ latest: boolean;
2988
+ };
2989
+ data: components['schemas']['DataWithOperations'];
2990
+ where: components['schemas']['WhereClause'];
2991
+ returning?: false | {
2992
+ join?: components['schemas']['JoinClause'];
2993
+ locale?: components['schemas']['LocaleClause'];
2994
+ select?: components['schemas']['SelectClause'];
2995
+ };
2996
+ };
2997
+ DeleteDocumentVersionResponse: {
2998
+ result?: {
2999
+ /** @example 1 */
3000
+ count: number;
3001
+ } | {
3002
+ data: components['schemas']['DocumentVersion'][];
3003
+ };
3004
+ };
3005
+ DeleteDocumentVersionRequest: {
3006
+ /** @example cms-xxxxx-xxxxx */
3007
+ contentSystemId: string;
3008
+ /** @example col-xxxxx-xxxxx */
3009
+ collectionKey: string;
3010
+ where: components['schemas']['WhereClause'];
3011
+ returning?: false | {
3012
+ join?: components['schemas']['JoinClause'];
3013
+ locale?: components['schemas']['LocaleClause'];
3014
+ select?: components['schemas']['SelectClause'];
3015
+ };
3016
+ };
3017
+ UploadFileResponse: {
3018
+ /**
3019
+ * @example true
3020
+ * @enum {boolean}
3021
+ */
3022
+ success: true;
3023
+ };
3024
+ UploadFileRequest: {
3025
+ /**
3026
+ * Format: binary
3027
+ * @description The file to upload
3028
+ */
3029
+ file: string;
3030
+ };
3031
+ DownloadFileRequest: {
3032
+ /** @example document.pdf */
3033
+ filename: string;
3034
+ };
3035
+ InitiateMultipartUploadResponse: {
3036
+ /** @example abc123xyz789 */
3037
+ uploadId: string;
3038
+ };
3039
+ InitiateMultipartUploadRequest: {
3040
+ /** @example large-video.mp4 */
3041
+ filename: string;
3042
+ /** @example video/mp4 */
3043
+ contentType: string;
3044
+ };
3045
+ GenerateUploadPartUrlsResponse: {
3046
+ /**
3047
+ * @example [
3048
+ * {
3049
+ * "partNumber": 1,
3050
+ * "url": "https://s3.amazonaws.com/..."
3051
+ * }
3052
+ * ]
3053
+ */
3054
+ parts: {
3055
+ /** @example 1 */
3056
+ partNumber: number;
3057
+ /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
3058
+ url: string;
3059
+ }[];
3060
+ };
3061
+ GenerateUploadPartUrlsRequest: {
3062
+ /** @example large-video.mp4 */
3063
+ filename: string;
3064
+ /** @example abc123xyz789 */
3065
+ uploadId: string;
3066
+ /**
3067
+ * @example [
3068
+ * 1,
3069
+ * 2,
3070
+ * 3
3071
+ * ]
3072
+ */
3073
+ partNumbers: number[];
3074
+ /**
3075
+ * @default 3600
3076
+ * @example 3600
3077
+ */
3078
+ expiresIn: number;
3079
+ };
3080
+ CompleteMultipartUploadResponse: {
3081
+ /**
3082
+ * @example true
3083
+ * @enum {boolean}
3084
+ */
3085
+ success: true;
3086
+ };
3087
+ CompleteMultipartUploadRequest: {
3088
+ /** @example large-video.mp4 */
3089
+ filename: string;
3090
+ /** @example abc123xyz789 */
3091
+ uploadId: string;
3092
+ /**
3093
+ * @example [
3094
+ * {
3095
+ * "PartNumber": 1,
3096
+ * "ETag": "\"abc123\""
3097
+ * }
3098
+ * ]
3099
+ */
3100
+ parts: {
3101
+ /** @example 1 */
3102
+ PartNumber: number;
3103
+ /** @example "abc123" */
3104
+ ETag: string;
3105
+ }[];
3106
+ };
3107
+ AbortMultipartUploadResponse: {
3108
+ /**
3109
+ * @example true
3110
+ * @enum {boolean}
3111
+ */
3112
+ success: true;
3113
+ };
3114
+ AbortMultipartUploadRequest: {
3115
+ /** @example large-video.mp4 */
3116
+ filename: string;
3117
+ /** @example abc123xyz789 */
3118
+ uploadId: string;
3119
+ };
3120
+ };
3121
+ responses: never;
3122
+ parameters: never;
3123
+ requestBodies: never;
3124
+ headers: never;
3125
+ pathItems: never;
3126
+ };
3127
+ export type $defs = Record<string, never>;
3128
+ export type operations = Record<string, never>;
3129
+ //# sourceMappingURL=content-api-types.d.ts.map