paperus 0.0.0-stage → 0.0.8

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 (36) hide show
  1. package/README.md +16 -2
  2. package/dist/generated/client/client.gen.d.ts +2 -0
  3. package/dist/generated/client/client.gen.js +216 -0
  4. package/dist/generated/client/index.d.ts +10 -0
  5. package/dist/generated/client/index.js +6 -0
  6. package/dist/generated/client/types.gen.d.ts +120 -0
  7. package/dist/generated/client/types.gen.js +2 -0
  8. package/dist/generated/client/utils.gen.d.ts +37 -0
  9. package/dist/generated/client/utils.gen.js +228 -0
  10. package/dist/generated/client.gen.d.ts +12 -0
  11. package/dist/generated/client.gen.js +3 -0
  12. package/dist/generated/core/auth.gen.d.ts +25 -0
  13. package/dist/generated/core/auth.gen.js +14 -0
  14. package/dist/generated/core/bodySerializer.gen.d.ts +25 -0
  15. package/dist/generated/core/bodySerializer.gen.js +57 -0
  16. package/dist/generated/core/params.gen.d.ts +43 -0
  17. package/dist/generated/core/params.gen.js +109 -0
  18. package/dist/generated/core/pathSerializer.gen.d.ts +33 -0
  19. package/dist/generated/core/pathSerializer.gen.js +106 -0
  20. package/dist/generated/core/queryKeySerializer.gen.d.ts +18 -0
  21. package/dist/generated/core/queryKeySerializer.gen.js +92 -0
  22. package/dist/generated/core/serverSentEvents.gen.d.ts +71 -0
  23. package/dist/generated/core/serverSentEvents.gen.js +132 -0
  24. package/dist/generated/core/types.gen.d.ts +83 -0
  25. package/dist/generated/core/types.gen.js +2 -0
  26. package/dist/generated/core/utils.gen.d.ts +19 -0
  27. package/dist/generated/core/utils.gen.js +87 -0
  28. package/dist/generated/index.d.ts +2 -0
  29. package/dist/generated/index.js +2 -0
  30. package/dist/generated/sdk.gen.d.ts +718 -0
  31. package/dist/generated/sdk.gen.js +991 -0
  32. package/dist/generated/types.gen.d.ts +4999 -0
  33. package/dist/generated/types.gen.js +2 -0
  34. package/dist/index.d.ts +20 -0
  35. package/dist/index.js +19 -0
  36. package/package.json +38 -5
@@ -0,0 +1,4999 @@
1
+ export type ClientOptions = {
2
+ baseUrl: `${string}://${string}` | (string & {});
3
+ };
4
+ /**
5
+ * Authentication
6
+ */
7
+ export type Authentication = {
8
+ /**
9
+ * Redirect Uri
10
+ */
11
+ redirect_uri: string;
12
+ /**
13
+ * Secret Set
14
+ */
15
+ secret_set: boolean;
16
+ /**
17
+ * Secret From Environment
18
+ */
19
+ secret_from_environment: boolean;
20
+ /**
21
+ * Linked
22
+ */
23
+ linked: number;
24
+ /**
25
+ * Sessions
26
+ */
27
+ sessions: number;
28
+ };
29
+ /**
30
+ * BackupConfig
31
+ *
32
+ * When backups run on their own (checked every hour by the worker).
33
+ */
34
+ export type BackupConfig = {
35
+ /**
36
+ * Schedule
37
+ */
38
+ schedule?: 'off' | 'daily' | 'weekly';
39
+ /**
40
+ * Hour
41
+ */
42
+ hour?: number;
43
+ /**
44
+ * With Files
45
+ */
46
+ with_files?: boolean;
47
+ /**
48
+ * Keep
49
+ */
50
+ keep?: number;
51
+ };
52
+ /**
53
+ * BackupOut
54
+ */
55
+ export type BackupOut = {
56
+ /**
57
+ * Name
58
+ */
59
+ name: string;
60
+ /**
61
+ * Created At
62
+ */
63
+ created_at: string;
64
+ /**
65
+ * Paperus Version
66
+ */
67
+ paperus_version: string;
68
+ /**
69
+ * With Files
70
+ */
71
+ with_files: boolean;
72
+ /**
73
+ * Files
74
+ */
75
+ files: number;
76
+ /**
77
+ * Size
78
+ */
79
+ size: number;
80
+ /**
81
+ * Items
82
+ */
83
+ items: number;
84
+ };
85
+ /**
86
+ * BackupRequest
87
+ */
88
+ export type BackupRequest = {
89
+ /**
90
+ * With Files
91
+ */
92
+ with_files?: boolean;
93
+ };
94
+ /**
95
+ * Backups
96
+ */
97
+ export type Backups = {
98
+ /**
99
+ * Path
100
+ */
101
+ path: string;
102
+ /**
103
+ * Files Size
104
+ */
105
+ files_size: number;
106
+ /**
107
+ * Backups
108
+ */
109
+ backups: Array<BackupOut>;
110
+ config: BackupConfig;
111
+ };
112
+ /**
113
+ * Body_set_avatar
114
+ */
115
+ export type BodySetAvatar = {
116
+ /**
117
+ * Upload
118
+ */
119
+ upload: Blob | File;
120
+ };
121
+ /**
122
+ * Body_start_import
123
+ */
124
+ export type BodyStartImport = {
125
+ /**
126
+ * Upload
127
+ */
128
+ upload: Blob | File;
129
+ /**
130
+ * Library Id
131
+ */
132
+ library_id?: string | null;
133
+ };
134
+ /**
135
+ * Body_upload_new_item
136
+ */
137
+ export type BodyUploadNewItem = {
138
+ /**
139
+ * Upload
140
+ */
141
+ upload: Blob | File;
142
+ /**
143
+ * Library Id
144
+ */
145
+ library_id?: string | null;
146
+ };
147
+ /**
148
+ * Body_upload_to_item
149
+ */
150
+ export type BodyUploadToItem = {
151
+ /**
152
+ * Upload
153
+ */
154
+ upload: Blob | File;
155
+ role?: FileRole;
156
+ };
157
+ /**
158
+ * Body_upload_to_version
159
+ */
160
+ export type BodyUploadToVersion = {
161
+ /**
162
+ * Upload
163
+ */
164
+ upload: Blob | File;
165
+ role?: FileRole;
166
+ };
167
+ /**
168
+ * CollectionChange
169
+ *
170
+ * Only the fields given are changed; ``parent_id: null`` moves to the top.
171
+ *
172
+ * ``library_id`` gives the collection, with the collections inside it, to
173
+ * another library the person may change, e.g. from their own to a group
174
+ * or back (members may delete a group's collections anyway). It lands at
175
+ * the top level there unless ``parent_id`` names a collection there.
176
+ * Papers a group's collection may not hold leave it, unless
177
+ * ``add_papers`` puts them into the group.
178
+ */
179
+ export type CollectionChange = {
180
+ /**
181
+ * Name
182
+ */
183
+ name?: string | null;
184
+ /**
185
+ * Description
186
+ */
187
+ description?: string | null;
188
+ /**
189
+ * Parent Id
190
+ */
191
+ parent_id?: string | null;
192
+ /**
193
+ * Library Id
194
+ */
195
+ library_id?: string | null;
196
+ /**
197
+ * Add Papers
198
+ */
199
+ add_papers?: boolean;
200
+ };
201
+ /**
202
+ * CollectionChanged
203
+ */
204
+ export type CollectionChanged = {
205
+ /**
206
+ * Id
207
+ */
208
+ id: string;
209
+ /**
210
+ * Library Id
211
+ */
212
+ library_id: string;
213
+ /**
214
+ * Name
215
+ */
216
+ name: string;
217
+ /**
218
+ * Description
219
+ */
220
+ description: string | null;
221
+ /**
222
+ * Parent Id
223
+ */
224
+ parent_id: string | null;
225
+ /**
226
+ * Count
227
+ */
228
+ count: number;
229
+ /**
230
+ * Direct
231
+ */
232
+ direct?: number;
233
+ /**
234
+ * Recent
235
+ */
236
+ recent?: Array<ItemPreview>;
237
+ /**
238
+ * Pinned
239
+ */
240
+ pinned?: boolean;
241
+ /**
242
+ * Left Out
243
+ */
244
+ left_out?: number;
245
+ };
246
+ /**
247
+ * CollectionIn
248
+ */
249
+ export type CollectionIn = {
250
+ /**
251
+ * Name
252
+ */
253
+ name: string;
254
+ /**
255
+ * Description
256
+ */
257
+ description?: string | null;
258
+ /**
259
+ * Parent Id
260
+ */
261
+ parent_id?: string | null;
262
+ /**
263
+ * Library Id
264
+ */
265
+ library_id?: string | null;
266
+ };
267
+ /**
268
+ * CollectionOut
269
+ */
270
+ export type CollectionOut = {
271
+ /**
272
+ * Id
273
+ */
274
+ id: string;
275
+ /**
276
+ * Library Id
277
+ */
278
+ library_id: string;
279
+ /**
280
+ * Name
281
+ */
282
+ name: string;
283
+ /**
284
+ * Description
285
+ */
286
+ description: string | null;
287
+ /**
288
+ * Parent Id
289
+ */
290
+ parent_id: string | null;
291
+ /**
292
+ * Count
293
+ */
294
+ count: number;
295
+ /**
296
+ * Direct
297
+ */
298
+ direct?: number;
299
+ /**
300
+ * Recent
301
+ */
302
+ recent?: Array<ItemPreview>;
303
+ /**
304
+ * Pinned
305
+ */
306
+ pinned?: boolean;
307
+ };
308
+ /**
309
+ * CopyReport
310
+ */
311
+ export type CopyReport = {
312
+ /**
313
+ * At
314
+ */
315
+ at: string;
316
+ /**
317
+ * Files
318
+ */
319
+ files?: number;
320
+ /**
321
+ * Bytes
322
+ */
323
+ bytes?: number;
324
+ /**
325
+ * Written
326
+ */
327
+ written?: number;
328
+ /**
329
+ * Removed
330
+ */
331
+ removed?: number;
332
+ /**
333
+ * Error
334
+ */
335
+ error?: string | null;
336
+ };
337
+ /**
338
+ * CreatedToken
339
+ */
340
+ export type CreatedToken = {
341
+ /**
342
+ * Id
343
+ */
344
+ id: string;
345
+ /**
346
+ * Name
347
+ */
348
+ name: string;
349
+ /**
350
+ * Hint
351
+ */
352
+ hint: string;
353
+ /**
354
+ * Scopes
355
+ */
356
+ scopes: Array<Scope>;
357
+ /**
358
+ * Library Ids
359
+ */
360
+ library_ids: Array<string> | null;
361
+ /**
362
+ * Created At
363
+ */
364
+ created_at: string;
365
+ /**
366
+ * Expires At
367
+ */
368
+ expires_at: string | null;
369
+ /**
370
+ * Last Used At
371
+ */
372
+ last_used_at: string | null;
373
+ /**
374
+ * Token
375
+ */
376
+ token: string;
377
+ };
378
+ /**
379
+ * DefaultLibrary
380
+ */
381
+ export type DefaultLibrary = {
382
+ /**
383
+ * Library Id
384
+ */
385
+ library_id: string;
386
+ };
387
+ /**
388
+ * Disk
389
+ */
390
+ export type Disk = {
391
+ /**
392
+ * Total
393
+ */
394
+ total: number;
395
+ /**
396
+ * Used
397
+ */
398
+ used: number;
399
+ /**
400
+ * Free
401
+ */
402
+ free: number;
403
+ };
404
+ /**
405
+ * DuplicateOut
406
+ */
407
+ export type DuplicateOut = {
408
+ keep: ItemOut;
409
+ merge: ItemOut;
410
+ /**
411
+ * Reasons
412
+ */
413
+ reasons: Array<string>;
414
+ /**
415
+ * Why
416
+ */
417
+ why: Array<string>;
418
+ /**
419
+ * Can Merge
420
+ */
421
+ can_merge: boolean;
422
+ };
423
+ /**
424
+ * Emptied
425
+ */
426
+ export type Emptied = {
427
+ /**
428
+ * Items
429
+ */
430
+ items: number;
431
+ /**
432
+ * Notes
433
+ */
434
+ notes: number;
435
+ /**
436
+ * Files
437
+ */
438
+ files: number;
439
+ };
440
+ /**
441
+ * FileOut
442
+ */
443
+ export type FileOut = {
444
+ /**
445
+ * Id
446
+ */
447
+ id: string;
448
+ /**
449
+ * Version Id
450
+ */
451
+ version_id: string;
452
+ role: FileRole;
453
+ /**
454
+ * Filename
455
+ */
456
+ filename: string;
457
+ /**
458
+ * Media Type
459
+ */
460
+ media_type: string;
461
+ /**
462
+ * Size
463
+ */
464
+ size: number;
465
+ /**
466
+ * Sha256
467
+ */
468
+ sha256: string;
469
+ source: FileSource;
470
+ text_status: TextStatus;
471
+ /**
472
+ * Created At
473
+ */
474
+ created_at: string;
475
+ /**
476
+ * Deleted At
477
+ */
478
+ deleted_at: string | null;
479
+ };
480
+ /**
481
+ * FileRole
482
+ */
483
+ export type FileRole = 'main' | 'supplementary' | 'slides' | 'transcript' | 'recording' | 'other';
484
+ /**
485
+ * FileSource
486
+ *
487
+ * Where a file came from; matters for sharing rules.
488
+ */
489
+ export type FileSource = 'upload' | 'open_access' | 'browser' | 'import';
490
+ /**
491
+ * GroupChange
492
+ */
493
+ export type GroupChange = {
494
+ /**
495
+ * Name
496
+ */
497
+ name?: string | null;
498
+ /**
499
+ * Description
500
+ */
501
+ description?: string | null;
502
+ /**
503
+ * Parent Id
504
+ */
505
+ parent_id?: string | null;
506
+ };
507
+ /**
508
+ * GroupIn
509
+ */
510
+ export type GroupIn = {
511
+ /**
512
+ * Name
513
+ */
514
+ name: string;
515
+ /**
516
+ * Description
517
+ */
518
+ description?: string | null;
519
+ /**
520
+ * Parent Id
521
+ */
522
+ parent_id?: string | null;
523
+ /**
524
+ * Admin Id
525
+ */
526
+ admin_id?: string | null;
527
+ };
528
+ /**
529
+ * GroupOut
530
+ */
531
+ export type GroupOut = {
532
+ /**
533
+ * Id
534
+ */
535
+ id: string;
536
+ /**
537
+ * Name
538
+ */
539
+ name: string;
540
+ /**
541
+ * Description
542
+ */
543
+ description: string | null;
544
+ /**
545
+ * Parent Id
546
+ */
547
+ parent_id: string | null;
548
+ /**
549
+ * Library Id
550
+ */
551
+ library_id: string;
552
+ role: Role | null;
553
+ /**
554
+ * Can Manage
555
+ */
556
+ can_manage: boolean;
557
+ /**
558
+ * Members
559
+ */
560
+ members: number;
561
+ /**
562
+ * Items
563
+ */
564
+ items: number | null;
565
+ /**
566
+ * Created At
567
+ */
568
+ created_at: string;
569
+ };
570
+ /**
571
+ * HTTPValidationError
572
+ */
573
+ export type HttpValidationError = {
574
+ /**
575
+ * Detail
576
+ */
577
+ detail?: Array<ValidationError>;
578
+ };
579
+ /**
580
+ * HandOver
581
+ *
582
+ * To a group or to another person (one of the two).
583
+ */
584
+ export type HandOver = {
585
+ /**
586
+ * Group Id
587
+ */
588
+ group_id?: string | null;
589
+ /**
590
+ * User Id
591
+ */
592
+ user_id?: string | null;
593
+ };
594
+ /**
595
+ * IdentifierIn
596
+ */
597
+ export type IdentifierIn = {
598
+ scheme: Scheme;
599
+ /**
600
+ * Value
601
+ */
602
+ value: string;
603
+ };
604
+ /**
605
+ * IdentifierOut
606
+ */
607
+ export type IdentifierOut = {
608
+ scheme: Scheme;
609
+ /**
610
+ * Value
611
+ */
612
+ value: string;
613
+ };
614
+ /**
615
+ * ImportOut
616
+ */
617
+ export type ImportOut = {
618
+ /**
619
+ * Id
620
+ */
621
+ id: string;
622
+ /**
623
+ * Filename
624
+ */
625
+ filename: string;
626
+ /**
627
+ * Library Id
628
+ */
629
+ library_id: string;
630
+ /**
631
+ * Format
632
+ */
633
+ format: string | null;
634
+ status: ImportStatus;
635
+ /**
636
+ * Done
637
+ */
638
+ done: number;
639
+ /**
640
+ * Total
641
+ */
642
+ total: number;
643
+ /**
644
+ * Report
645
+ */
646
+ report: {
647
+ [key: string]: unknown;
648
+ } | null;
649
+ /**
650
+ * Error
651
+ */
652
+ error: string | null;
653
+ /**
654
+ * Created At
655
+ */
656
+ created_at: string;
657
+ /**
658
+ * Finished At
659
+ */
660
+ finished_at: string | null;
661
+ };
662
+ /**
663
+ * ImportStatus
664
+ */
665
+ export type ImportStatus = 'waiting' | 'running' | 'done' | 'failed';
666
+ /**
667
+ * ItemDetail
668
+ */
669
+ export type ItemDetail = {
670
+ /**
671
+ * Id
672
+ */
673
+ id: string;
674
+ /**
675
+ * Library Id
676
+ */
677
+ library_id: string;
678
+ /**
679
+ * Type
680
+ */
681
+ type: string;
682
+ /**
683
+ * Title
684
+ */
685
+ title: string;
686
+ /**
687
+ * Authors
688
+ */
689
+ authors: Array<string>;
690
+ /**
691
+ * Year
692
+ */
693
+ year: number | null;
694
+ /**
695
+ * Container Title
696
+ */
697
+ container_title: string | null;
698
+ /**
699
+ * Identifiers
700
+ */
701
+ identifiers: Array<IdentifierOut>;
702
+ /**
703
+ * Created At
704
+ */
705
+ created_at: string;
706
+ /**
707
+ * Change
708
+ */
709
+ change: number;
710
+ /**
711
+ * Changed At
712
+ */
713
+ changed_at: string;
714
+ /**
715
+ * Viewed At
716
+ */
717
+ viewed_at?: string | null;
718
+ /**
719
+ * Deleted At
720
+ */
721
+ deleted_at: string | null;
722
+ /**
723
+ * Processing
724
+ */
725
+ processing: boolean;
726
+ /**
727
+ * Tags
728
+ */
729
+ tags: Array<ItemTagOut>;
730
+ /**
731
+ * Collection Ids
732
+ */
733
+ collection_ids: Array<string>;
734
+ /**
735
+ * Favourite
736
+ */
737
+ favourite?: boolean;
738
+ /**
739
+ * Csl
740
+ */
741
+ csl: {
742
+ [key: string]: unknown;
743
+ };
744
+ /**
745
+ * Overrides
746
+ */
747
+ overrides: {
748
+ [key: string]: unknown;
749
+ };
750
+ /**
751
+ * Preferred Version Id
752
+ */
753
+ preferred_version_id: string | null;
754
+ /**
755
+ * Versions
756
+ */
757
+ versions: Array<VersionOut>;
758
+ };
759
+ /**
760
+ * ItemIds
761
+ */
762
+ export type ItemIds = {
763
+ /**
764
+ * Item Ids
765
+ */
766
+ item_ids: Array<string>;
767
+ };
768
+ /**
769
+ * ItemIn
770
+ */
771
+ export type ItemIn = {
772
+ /**
773
+ * Doi
774
+ */
775
+ doi?: string | null;
776
+ /**
777
+ * Metadata
778
+ */
779
+ metadata?: {
780
+ [key: string]: unknown;
781
+ } | null;
782
+ /**
783
+ * Identifiers
784
+ */
785
+ identifiers?: Array<IdentifierIn>;
786
+ kind?: VersionKind | null;
787
+ /**
788
+ * Label
789
+ */
790
+ label?: string | null;
791
+ /**
792
+ * Library Id
793
+ */
794
+ library_id?: string | null;
795
+ };
796
+ /**
797
+ * ItemOut
798
+ */
799
+ export type ItemOut = {
800
+ /**
801
+ * Id
802
+ */
803
+ id: string;
804
+ /**
805
+ * Library Id
806
+ */
807
+ library_id: string;
808
+ /**
809
+ * Type
810
+ */
811
+ type: string;
812
+ /**
813
+ * Title
814
+ */
815
+ title: string;
816
+ /**
817
+ * Authors
818
+ */
819
+ authors: Array<string>;
820
+ /**
821
+ * Year
822
+ */
823
+ year: number | null;
824
+ /**
825
+ * Container Title
826
+ */
827
+ container_title: string | null;
828
+ /**
829
+ * Identifiers
830
+ */
831
+ identifiers: Array<IdentifierOut>;
832
+ /**
833
+ * Created At
834
+ */
835
+ created_at: string;
836
+ /**
837
+ * Change
838
+ */
839
+ change: number;
840
+ /**
841
+ * Changed At
842
+ */
843
+ changed_at: string;
844
+ /**
845
+ * Viewed At
846
+ */
847
+ viewed_at?: string | null;
848
+ /**
849
+ * Deleted At
850
+ */
851
+ deleted_at: string | null;
852
+ /**
853
+ * Processing
854
+ */
855
+ processing: boolean;
856
+ /**
857
+ * Tags
858
+ */
859
+ tags: Array<ItemTagOut>;
860
+ /**
861
+ * Collection Ids
862
+ */
863
+ collection_ids: Array<string>;
864
+ /**
865
+ * Favourite
866
+ */
867
+ favourite?: boolean;
868
+ };
869
+ /**
870
+ * ItemPreview
871
+ */
872
+ export type ItemPreview = {
873
+ /**
874
+ * Id
875
+ */
876
+ id: string;
877
+ /**
878
+ * Title
879
+ */
880
+ title: string;
881
+ };
882
+ /**
883
+ * ItemTagOut
884
+ */
885
+ export type ItemTagOut = {
886
+ /**
887
+ * Id
888
+ */
889
+ id: string;
890
+ /**
891
+ * Name
892
+ */
893
+ name: string;
894
+ color: TagColor | null;
895
+ source: TagSource;
896
+ };
897
+ /**
898
+ * Joining
899
+ */
900
+ export type Joining = {
901
+ /**
902
+ * Group Id
903
+ */
904
+ group_id: string;
905
+ /**
906
+ * Role
907
+ */
908
+ role?: 'reader' | 'member';
909
+ };
910
+ /**
911
+ * KnownFile
912
+ */
913
+ export type KnownFile = {
914
+ /**
915
+ * Item Id
916
+ */
917
+ item_id: string;
918
+ file: FileOut;
919
+ };
920
+ /**
921
+ * LibraryOut
922
+ */
923
+ export type LibraryOut = {
924
+ /**
925
+ * Id
926
+ */
927
+ id: string;
928
+ /**
929
+ * Name
930
+ */
931
+ name: string;
932
+ /**
933
+ * Kind
934
+ */
935
+ kind: 'personal' | 'group';
936
+ /**
937
+ * Group Id
938
+ */
939
+ group_id: string | null;
940
+ /**
941
+ * Path
942
+ */
943
+ path: Array<string>;
944
+ role: Role | null;
945
+ /**
946
+ * Writable
947
+ */
948
+ writable: boolean;
949
+ /**
950
+ * Default
951
+ */
952
+ default: boolean;
953
+ };
954
+ /**
955
+ * LinkChange
956
+ */
957
+ export type LinkChange = {
958
+ /**
959
+ * Page
960
+ */
961
+ page?: number | null;
962
+ };
963
+ /**
964
+ * LinkIn
965
+ */
966
+ export type LinkIn = {
967
+ /**
968
+ * Item Id
969
+ */
970
+ item_id: string;
971
+ /**
972
+ * Page
973
+ */
974
+ page?: number | null;
975
+ };
976
+ /**
977
+ * LoginMethods
978
+ */
979
+ export type LoginMethods = {
980
+ /**
981
+ * Password
982
+ */
983
+ password: boolean;
984
+ /**
985
+ * Oidc Label
986
+ */
987
+ oidc_label: string | null;
988
+ };
989
+ /**
990
+ * LoginRequest
991
+ */
992
+ export type LoginRequest = {
993
+ /**
994
+ * Username
995
+ */
996
+ username: string;
997
+ /**
998
+ * Password
999
+ */
1000
+ password: string;
1001
+ };
1002
+ /**
1003
+ * LoginResponse
1004
+ */
1005
+ export type LoginResponse = {
1006
+ /**
1007
+ * Token
1008
+ */
1009
+ token: string;
1010
+ user: UserOut;
1011
+ };
1012
+ /**
1013
+ * MLModel
1014
+ */
1015
+ export type MlModel = {
1016
+ /**
1017
+ * Name
1018
+ */
1019
+ name: string;
1020
+ /**
1021
+ * Task
1022
+ */
1023
+ task: string;
1024
+ /**
1025
+ * Dimensions
1026
+ */
1027
+ dimensions: number;
1028
+ /**
1029
+ * Max Tokens
1030
+ */
1031
+ max_tokens: number;
1032
+ /**
1033
+ * Loaded
1034
+ */
1035
+ loaded: boolean;
1036
+ /**
1037
+ * Cached Bytes
1038
+ */
1039
+ cached_bytes: number | null;
1040
+ /**
1041
+ * Description
1042
+ */
1043
+ description?: string;
1044
+ /**
1045
+ * Licence
1046
+ */
1047
+ licence?: string;
1048
+ /**
1049
+ * Download Mb
1050
+ */
1051
+ download_mb?: number;
1052
+ /**
1053
+ * Scores
1054
+ */
1055
+ scores?: {
1056
+ [key: string]: number;
1057
+ };
1058
+ /**
1059
+ * Benchmarks
1060
+ */
1061
+ benchmarks?: {
1062
+ [key: string]: string;
1063
+ };
1064
+ };
1065
+ /**
1066
+ * MLService
1067
+ */
1068
+ export type MlService = {
1069
+ /**
1070
+ * Url
1071
+ */
1072
+ url: string;
1073
+ /**
1074
+ * Ok
1075
+ */
1076
+ ok: boolean;
1077
+ /**
1078
+ * Error
1079
+ */
1080
+ error: string | null;
1081
+ };
1082
+ /**
1083
+ * MLServiceState
1084
+ */
1085
+ export type MlServiceState = {
1086
+ /**
1087
+ * Url
1088
+ */
1089
+ url: string;
1090
+ /**
1091
+ * Threads
1092
+ */
1093
+ threads: number;
1094
+ /**
1095
+ * Keep
1096
+ */
1097
+ keep: Array<string>;
1098
+ /**
1099
+ * Cores
1100
+ */
1101
+ cores: number;
1102
+ /**
1103
+ * Loaded
1104
+ */
1105
+ loaded: Array<string>;
1106
+ /**
1107
+ * Loading
1108
+ */
1109
+ loading?: Array<string>;
1110
+ };
1111
+ /**
1112
+ * MLSpeed
1113
+ */
1114
+ export type MlSpeed = {
1115
+ /**
1116
+ * Model
1117
+ */
1118
+ model: string;
1119
+ /**
1120
+ * Loading
1121
+ */
1122
+ loading?: boolean;
1123
+ /**
1124
+ * Passages
1125
+ */
1126
+ passages?: number;
1127
+ /**
1128
+ * Seconds
1129
+ */
1130
+ seconds?: number;
1131
+ /**
1132
+ * Passages Per Second
1133
+ */
1134
+ passages_per_second?: number;
1135
+ /**
1136
+ * Url
1137
+ */
1138
+ url?: string | null;
1139
+ };
1140
+ /**
1141
+ * MLStatus
1142
+ */
1143
+ export type MlStatus = {
1144
+ /**
1145
+ * Services
1146
+ */
1147
+ services: Array<MlService>;
1148
+ /**
1149
+ * Models
1150
+ */
1151
+ models: Array<MlModel>;
1152
+ service?: MlServiceState | null;
1153
+ };
1154
+ /**
1155
+ * MemberIn
1156
+ */
1157
+ export type MemberIn = {
1158
+ role: Role;
1159
+ };
1160
+ /**
1161
+ * MemberOut
1162
+ */
1163
+ export type MemberOut = {
1164
+ /**
1165
+ * User Id
1166
+ */
1167
+ user_id: string;
1168
+ /**
1169
+ * Username
1170
+ */
1171
+ username: string;
1172
+ role: Role;
1173
+ direct_role: Role | null;
1174
+ /**
1175
+ * Inherited From
1176
+ */
1177
+ inherited_from: string | null;
1178
+ /**
1179
+ * Avatar Url
1180
+ */
1181
+ avatar_url?: string | null;
1182
+ };
1183
+ /**
1184
+ * MergeInto
1185
+ */
1186
+ export type MergeInto = {
1187
+ /**
1188
+ * Into
1189
+ */
1190
+ into: string;
1191
+ };
1192
+ /**
1193
+ * MergeOut
1194
+ */
1195
+ export type MergeOut = {
1196
+ /**
1197
+ * Steps
1198
+ */
1199
+ steps: Array<MergeStep>;
1200
+ item: ItemDetail;
1201
+ };
1202
+ /**
1203
+ * MergePreview
1204
+ */
1205
+ export type MergePreview = {
1206
+ /**
1207
+ * Steps
1208
+ */
1209
+ steps: Array<MergeStep>;
1210
+ };
1211
+ /**
1212
+ * MergeStep
1213
+ */
1214
+ export type MergeStep = {
1215
+ /**
1216
+ * Kind
1217
+ */
1218
+ kind: 'version' | 'file' | 'tag' | 'collection' | 'note';
1219
+ /**
1220
+ * Name
1221
+ */
1222
+ name: string;
1223
+ /**
1224
+ * Action
1225
+ */
1226
+ action: 'move' | 'already' | 'stays';
1227
+ /**
1228
+ * Reason
1229
+ */
1230
+ reason: string | null;
1231
+ };
1232
+ /**
1233
+ * MetadataSource
1234
+ */
1235
+ export type MetadataSource = 'lookup' | 'manual' | 'import' | 'sync' | 'file';
1236
+ /**
1237
+ * MovePreview
1238
+ *
1239
+ * What moving a collection (with those inside) into a library does.
1240
+ */
1241
+ export type MovePreview = {
1242
+ /**
1243
+ * Papers
1244
+ */
1245
+ papers: number;
1246
+ /**
1247
+ * Not In Library
1248
+ */
1249
+ not_in_library: number;
1250
+ };
1251
+ /**
1252
+ * NewItemUpload
1253
+ */
1254
+ export type NewItemUpload = {
1255
+ /**
1256
+ * Item Id
1257
+ */
1258
+ item_id: string;
1259
+ file: FileOut;
1260
+ /**
1261
+ * Existing
1262
+ */
1263
+ existing?: boolean;
1264
+ };
1265
+ /**
1266
+ * NewToken
1267
+ */
1268
+ export type NewToken = {
1269
+ /**
1270
+ * Name
1271
+ */
1272
+ name: string;
1273
+ /**
1274
+ * Scopes
1275
+ */
1276
+ scopes: Array<Scope>;
1277
+ /**
1278
+ * Library Ids
1279
+ */
1280
+ library_ids?: Array<string> | null;
1281
+ /**
1282
+ * Expires In Days
1283
+ */
1284
+ expires_in_days?: number | null;
1285
+ };
1286
+ /**
1287
+ * NewUser
1288
+ */
1289
+ export type NewUser = {
1290
+ /**
1291
+ * Username
1292
+ */
1293
+ username: string;
1294
+ /**
1295
+ * Password
1296
+ */
1297
+ password: string;
1298
+ /**
1299
+ * Is Admin
1300
+ */
1301
+ is_admin?: boolean;
1302
+ };
1303
+ /**
1304
+ * NoteChange
1305
+ */
1306
+ export type NoteChange = {
1307
+ /**
1308
+ * Text
1309
+ */
1310
+ text: string;
1311
+ };
1312
+ /**
1313
+ * NoteDetail
1314
+ */
1315
+ export type NoteDetail = {
1316
+ /**
1317
+ * Id
1318
+ */
1319
+ id: string;
1320
+ /**
1321
+ * Library Id
1322
+ */
1323
+ library_id: string;
1324
+ /**
1325
+ * Title
1326
+ */
1327
+ title: string;
1328
+ /**
1329
+ * Excerpt
1330
+ */
1331
+ excerpt: string;
1332
+ /**
1333
+ * Items
1334
+ */
1335
+ items: Array<NoteLinkOut>;
1336
+ /**
1337
+ * Collection Ids
1338
+ */
1339
+ collection_ids: Array<string>;
1340
+ /**
1341
+ * Created At
1342
+ */
1343
+ created_at: string;
1344
+ /**
1345
+ * Changed At
1346
+ */
1347
+ changed_at: string;
1348
+ /**
1349
+ * Changed By
1350
+ */
1351
+ changed_by: string | null;
1352
+ /**
1353
+ * Change
1354
+ */
1355
+ change: number;
1356
+ /**
1357
+ * Deleted At
1358
+ */
1359
+ deleted_at: string | null;
1360
+ /**
1361
+ * Text
1362
+ */
1363
+ text: string;
1364
+ };
1365
+ /**
1366
+ * NoteIds
1367
+ */
1368
+ export type NoteIds = {
1369
+ /**
1370
+ * Note Ids
1371
+ */
1372
+ note_ids: Array<string>;
1373
+ };
1374
+ /**
1375
+ * NoteIn
1376
+ */
1377
+ export type NoteIn = {
1378
+ /**
1379
+ * Text
1380
+ */
1381
+ text?: string;
1382
+ /**
1383
+ * Library Id
1384
+ */
1385
+ library_id?: string | null;
1386
+ /**
1387
+ * Items
1388
+ */
1389
+ items?: Array<LinkIn>;
1390
+ /**
1391
+ * Collection Id
1392
+ */
1393
+ collection_id?: string | null;
1394
+ };
1395
+ /**
1396
+ * NoteLinkOut
1397
+ */
1398
+ export type NoteLinkOut = {
1399
+ /**
1400
+ * Item Id
1401
+ */
1402
+ item_id: string;
1403
+ /**
1404
+ * Title
1405
+ */
1406
+ title: string;
1407
+ /**
1408
+ * Page
1409
+ */
1410
+ page: number | null;
1411
+ };
1412
+ /**
1413
+ * NoteOut
1414
+ */
1415
+ export type NoteOut = {
1416
+ /**
1417
+ * Id
1418
+ */
1419
+ id: string;
1420
+ /**
1421
+ * Library Id
1422
+ */
1423
+ library_id: string;
1424
+ /**
1425
+ * Title
1426
+ */
1427
+ title: string;
1428
+ /**
1429
+ * Excerpt
1430
+ */
1431
+ excerpt: string;
1432
+ /**
1433
+ * Items
1434
+ */
1435
+ items: Array<NoteLinkOut>;
1436
+ /**
1437
+ * Collection Ids
1438
+ */
1439
+ collection_ids: Array<string>;
1440
+ /**
1441
+ * Created At
1442
+ */
1443
+ created_at: string;
1444
+ /**
1445
+ * Changed At
1446
+ */
1447
+ changed_at: string;
1448
+ /**
1449
+ * Changed By
1450
+ */
1451
+ changed_by: string | null;
1452
+ /**
1453
+ * Change
1454
+ */
1455
+ change: number;
1456
+ /**
1457
+ * Deleted At
1458
+ */
1459
+ deleted_at: string | null;
1460
+ };
1461
+ /**
1462
+ * Owner
1463
+ */
1464
+ export type Owner = {
1465
+ /**
1466
+ * Library Id
1467
+ */
1468
+ library_id: string;
1469
+ };
1470
+ /**
1471
+ * Pair
1472
+ */
1473
+ export type Pair = {
1474
+ /**
1475
+ * A
1476
+ */
1477
+ a: string;
1478
+ /**
1479
+ * B
1480
+ */
1481
+ b: string;
1482
+ };
1483
+ /**
1484
+ * Passage
1485
+ */
1486
+ export type Passage = {
1487
+ /**
1488
+ * Passage Id
1489
+ */
1490
+ passage_id: string;
1491
+ /**
1492
+ * Kind
1493
+ */
1494
+ kind?: 'paper' | 'note';
1495
+ /**
1496
+ * Item Id
1497
+ */
1498
+ item_id: string | null;
1499
+ /**
1500
+ * Item Title
1501
+ */
1502
+ item_title: string;
1503
+ /**
1504
+ * Version Id
1505
+ */
1506
+ version_id: string | null;
1507
+ /**
1508
+ * File Id
1509
+ */
1510
+ file_id: string | null;
1511
+ /**
1512
+ * Note Id
1513
+ */
1514
+ note_id?: string | null;
1515
+ /**
1516
+ * Position
1517
+ */
1518
+ position: number;
1519
+ /**
1520
+ * Page
1521
+ */
1522
+ page: number | null;
1523
+ /**
1524
+ * Snippet
1525
+ */
1526
+ snippet: string;
1527
+ /**
1528
+ * Score
1529
+ */
1530
+ score: number;
1531
+ /**
1532
+ * Matched
1533
+ */
1534
+ matched: Array<'keyword' | 'meaning'>;
1535
+ /**
1536
+ * In References
1537
+ */
1538
+ in_references: boolean;
1539
+ };
1540
+ /**
1541
+ * PasswordChange
1542
+ */
1543
+ export type PasswordChange = {
1544
+ /**
1545
+ * Current
1546
+ */
1547
+ current: string;
1548
+ /**
1549
+ * New
1550
+ */
1551
+ new: string;
1552
+ };
1553
+ /**
1554
+ * Private
1555
+ *
1556
+ * What a person's own library holds (the trash included).
1557
+ */
1558
+ export type Private = {
1559
+ /**
1560
+ * Items
1561
+ */
1562
+ items: number;
1563
+ /**
1564
+ * Notes
1565
+ */
1566
+ notes: number;
1567
+ /**
1568
+ * Tags
1569
+ */
1570
+ tags: number;
1571
+ /**
1572
+ * Collections
1573
+ */
1574
+ collections: number;
1575
+ };
1576
+ /**
1577
+ * Problem
1578
+ */
1579
+ export type Problem = {
1580
+ /**
1581
+ * File Id
1582
+ */
1583
+ file_id: string;
1584
+ /**
1585
+ * Filename
1586
+ */
1587
+ filename: string;
1588
+ /**
1589
+ * Item Id
1590
+ */
1591
+ item_id: string;
1592
+ /**
1593
+ * Title
1594
+ */
1595
+ title: string;
1596
+ };
1597
+ /**
1598
+ * ProviderCheck
1599
+ */
1600
+ export type ProviderCheck = {
1601
+ /**
1602
+ * Issuer
1603
+ */
1604
+ issuer: string;
1605
+ };
1606
+ /**
1607
+ * ProviderFound
1608
+ */
1609
+ export type ProviderFound = {
1610
+ /**
1611
+ * Ok
1612
+ */
1613
+ ok: boolean;
1614
+ /**
1615
+ * Error
1616
+ */
1617
+ error?: string | null;
1618
+ /**
1619
+ * Authorization Endpoint
1620
+ */
1621
+ authorization_endpoint?: string | null;
1622
+ };
1623
+ /**
1624
+ * ReadableCopy
1625
+ */
1626
+ export type ReadableCopy = {
1627
+ /**
1628
+ * Path
1629
+ */
1630
+ path: string;
1631
+ /**
1632
+ * Free Bytes
1633
+ */
1634
+ free_bytes: number | null;
1635
+ report: CopyReport | null;
1636
+ /**
1637
+ * Variables
1638
+ */
1639
+ variables: {
1640
+ [key: string]: string;
1641
+ };
1642
+ /**
1643
+ * Links Possible
1644
+ */
1645
+ links_possible: boolean;
1646
+ };
1647
+ /**
1648
+ * Report
1649
+ */
1650
+ export type Report = {
1651
+ /**
1652
+ * Checked At
1653
+ */
1654
+ checked_at: string;
1655
+ /**
1656
+ * Deep
1657
+ */
1658
+ deep: boolean;
1659
+ /**
1660
+ * Contents
1661
+ */
1662
+ contents: number;
1663
+ /**
1664
+ * Missing
1665
+ */
1666
+ missing: number;
1667
+ /**
1668
+ * Damaged
1669
+ */
1670
+ damaged: number;
1671
+ /**
1672
+ * Problems
1673
+ */
1674
+ problems: Array<Problem>;
1675
+ /**
1676
+ * Unused
1677
+ */
1678
+ unused: number;
1679
+ /**
1680
+ * Unused Bytes
1681
+ */
1682
+ unused_bytes: number;
1683
+ /**
1684
+ * Removed
1685
+ */
1686
+ removed?: number;
1687
+ };
1688
+ /**
1689
+ * RestoreCheckOut
1690
+ *
1691
+ * Where the backup's files would come from. Files are stored by their
1692
+ * SHA-256, so one already in the storage is the very same file: nothing
1693
+ * is overwritten, missing ones are copied back, extra ones stay.
1694
+ */
1695
+ export type RestoreCheckOut = {
1696
+ /**
1697
+ * With Files
1698
+ */
1699
+ with_files: boolean;
1700
+ /**
1701
+ * Needed
1702
+ */
1703
+ needed: number;
1704
+ /**
1705
+ * In Storage
1706
+ */
1707
+ in_storage: number;
1708
+ /**
1709
+ * From Backup
1710
+ */
1711
+ from_backup: number;
1712
+ /**
1713
+ * Missing
1714
+ */
1715
+ missing: number;
1716
+ /**
1717
+ * Affected
1718
+ */
1719
+ affected: Array<string>;
1720
+ /**
1721
+ * Affected Count
1722
+ */
1723
+ affected_count: number;
1724
+ /**
1725
+ * Extra
1726
+ */
1727
+ extra: number | null;
1728
+ };
1729
+ /**
1730
+ * RestoreRequest
1731
+ */
1732
+ export type RestoreRequest = {
1733
+ /**
1734
+ * Name
1735
+ */
1736
+ name: string;
1737
+ };
1738
+ /**
1739
+ * RevisionOut
1740
+ */
1741
+ export type RevisionOut = {
1742
+ /**
1743
+ * Id
1744
+ */
1745
+ id: string;
1746
+ /**
1747
+ * Text
1748
+ */
1749
+ text: string;
1750
+ /**
1751
+ * Written By
1752
+ */
1753
+ written_by: string | null;
1754
+ /**
1755
+ * Written At
1756
+ */
1757
+ written_at: string;
1758
+ };
1759
+ /**
1760
+ * Role
1761
+ *
1762
+ * What a member may do in a group (and every group inside it).
1763
+ */
1764
+ export type Role = 'reader' | 'member' | 'admin';
1765
+ /**
1766
+ * Scheme
1767
+ */
1768
+ export type Scheme = 'doi' | 'arxiv' | 'isbn' | 'pmid' | 'url';
1769
+ /**
1770
+ * Scope
1771
+ */
1772
+ export type Scope = 'search' | 'papers.read' | 'files.read' | 'papers.write' | 'tags.write' | 'collections.write' | 'notes.write' | 'groups.read';
1773
+ /**
1774
+ * Secret
1775
+ */
1776
+ export type Secret = {
1777
+ /**
1778
+ * Secret
1779
+ */
1780
+ secret?: string | null;
1781
+ };
1782
+ /**
1783
+ * SetupState
1784
+ */
1785
+ export type SetupState = {
1786
+ /**
1787
+ * Needed
1788
+ */
1789
+ needed: boolean;
1790
+ /**
1791
+ * Backup Path
1792
+ */
1793
+ backup_path: string | null;
1794
+ /**
1795
+ * Backups
1796
+ */
1797
+ backups: Array<BackupOut>;
1798
+ };
1799
+ /**
1800
+ * Stats
1801
+ */
1802
+ export type Stats = {
1803
+ /**
1804
+ * Items
1805
+ */
1806
+ items: number;
1807
+ /**
1808
+ * Files
1809
+ */
1810
+ files: number;
1811
+ /**
1812
+ * Files Pending
1813
+ */
1814
+ files_pending: number;
1815
+ /**
1816
+ * Chunks
1817
+ */
1818
+ chunks: number;
1819
+ /**
1820
+ * Embedded
1821
+ */
1822
+ embedded: number;
1823
+ /**
1824
+ * Embedding Model
1825
+ */
1826
+ embedding_model: string;
1827
+ /**
1828
+ * Jobs
1829
+ */
1830
+ jobs: {
1831
+ [key: string]: {
1832
+ [key: string]: number;
1833
+ };
1834
+ };
1835
+ storage: Usage;
1836
+ };
1837
+ /**
1838
+ * Storage
1839
+ */
1840
+ export type Storage = {
1841
+ /**
1842
+ * Library Bytes
1843
+ */
1844
+ library_bytes: number;
1845
+ /**
1846
+ * Disk Total
1847
+ */
1848
+ disk_total: number | null;
1849
+ /**
1850
+ * Disk Free
1851
+ */
1852
+ disk_free: number | null;
1853
+ };
1854
+ /**
1855
+ * SystemConfig
1856
+ */
1857
+ export type SystemConfig = {
1858
+ /**
1859
+ * Embedding Model
1860
+ */
1861
+ embedding_model: string;
1862
+ /**
1863
+ * Ml Threads
1864
+ */
1865
+ ml_threads?: number | null;
1866
+ /**
1867
+ * Public Url
1868
+ */
1869
+ public_url?: string | null;
1870
+ /**
1871
+ * Contact Email
1872
+ */
1873
+ contact_email?: string | null;
1874
+ /**
1875
+ * Max Upload Mb
1876
+ */
1877
+ max_upload_mb?: number | null;
1878
+ /**
1879
+ * Trash Days
1880
+ */
1881
+ trash_days?: number | null;
1882
+ /**
1883
+ * Log Level
1884
+ */
1885
+ log_level?: 'debug' | 'info' | 'warning' | 'error';
1886
+ /**
1887
+ * Jobs Text
1888
+ */
1889
+ jobs_text?: number;
1890
+ /**
1891
+ * Jobs Ml
1892
+ */
1893
+ jobs_ml?: number;
1894
+ /**
1895
+ * Jobs Import
1896
+ */
1897
+ jobs_import?: number;
1898
+ /**
1899
+ * Night Hour
1900
+ */
1901
+ night_hour?: number;
1902
+ /**
1903
+ * Integrity Schedule
1904
+ */
1905
+ integrity_schedule?: 'off' | 'daily' | 'weekly';
1906
+ /**
1907
+ * Session Days
1908
+ */
1909
+ session_days?: number;
1910
+ /**
1911
+ * Password Min Length
1912
+ */
1913
+ password_min_length?: number;
1914
+ /**
1915
+ * Password Login
1916
+ */
1917
+ password_login?: boolean;
1918
+ /**
1919
+ * Oidc Enabled
1920
+ */
1921
+ oidc_enabled?: boolean;
1922
+ /**
1923
+ * Oidc Issuer
1924
+ */
1925
+ oidc_issuer?: string | null;
1926
+ /**
1927
+ * Oidc Client Id
1928
+ */
1929
+ oidc_client_id?: string | null;
1930
+ /**
1931
+ * Oidc Label
1932
+ */
1933
+ oidc_label?: string;
1934
+ /**
1935
+ * Oidc Username Claim
1936
+ */
1937
+ oidc_username_claim?: string;
1938
+ /**
1939
+ * Oidc Create Accounts
1940
+ */
1941
+ oidc_create_accounts?: boolean;
1942
+ /**
1943
+ * Copy Enabled
1944
+ */
1945
+ copy_enabled?: boolean;
1946
+ /**
1947
+ * Copy Template
1948
+ */
1949
+ copy_template?: string;
1950
+ /**
1951
+ * Copy Links
1952
+ */
1953
+ copy_links?: boolean;
1954
+ /**
1955
+ * New User Groups
1956
+ */
1957
+ new_user_groups?: Array<Joining>;
1958
+ };
1959
+ /**
1960
+ * TagChange
1961
+ *
1962
+ * Only the fields given are changed; ``null`` clears colour or description.
1963
+ */
1964
+ export type TagChange = {
1965
+ /**
1966
+ * Name
1967
+ */
1968
+ name?: string | null;
1969
+ color?: TagColor | null;
1970
+ /**
1971
+ * Description
1972
+ */
1973
+ description?: string | null;
1974
+ /**
1975
+ * Library Id
1976
+ */
1977
+ library_id?: string | null;
1978
+ };
1979
+ /**
1980
+ * TagColor
1981
+ *
1982
+ * Colours a tag can have; the website gives each a light and dark shade.
1983
+ */
1984
+ export type TagColor = 'gray' | 'brown' | 'red' | 'rose' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'emerald' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'pink';
1985
+ /**
1986
+ * TagIn
1987
+ */
1988
+ export type TagIn = {
1989
+ /**
1990
+ * Name
1991
+ */
1992
+ name: string;
1993
+ /**
1994
+ * Library Id
1995
+ */
1996
+ library_id?: string | null;
1997
+ };
1998
+ /**
1999
+ * TagNew
2000
+ */
2001
+ export type TagNew = {
2002
+ /**
2003
+ * Name
2004
+ */
2005
+ name: string;
2006
+ color?: TagColor | null;
2007
+ /**
2008
+ * Description
2009
+ */
2010
+ description?: string | null;
2011
+ /**
2012
+ * Library Id
2013
+ */
2014
+ library_id?: string | null;
2015
+ };
2016
+ /**
2017
+ * TagOut
2018
+ */
2019
+ export type TagOut = {
2020
+ /**
2021
+ * Id
2022
+ */
2023
+ id: string;
2024
+ /**
2025
+ * Library Id
2026
+ */
2027
+ library_id: string;
2028
+ /**
2029
+ * Name
2030
+ */
2031
+ name: string;
2032
+ color: TagColor | null;
2033
+ /**
2034
+ * Description
2035
+ */
2036
+ description: string | null;
2037
+ /**
2038
+ * Count
2039
+ */
2040
+ count: number;
2041
+ /**
2042
+ * Sources
2043
+ */
2044
+ sources: {
2045
+ [key in TagSource]?: number;
2046
+ };
2047
+ /**
2048
+ * Created At
2049
+ */
2050
+ created_at: string;
2051
+ /**
2052
+ * Last Used
2053
+ */
2054
+ last_used: string | null;
2055
+ };
2056
+ /**
2057
+ * TagSource
2058
+ *
2059
+ * Who put a tag on an item (Zotero keeps manual and automatic apart).
2060
+ */
2061
+ export type TagSource = 'manual' | 'automatic' | 'ai';
2062
+ /**
2063
+ * TemplateIn
2064
+ */
2065
+ export type TemplateIn = {
2066
+ /**
2067
+ * Template
2068
+ */
2069
+ template: string;
2070
+ };
2071
+ /**
2072
+ * TemplatePreview
2073
+ */
2074
+ export type TemplatePreview = {
2075
+ /**
2076
+ * Paths
2077
+ */
2078
+ paths: Array<string>;
2079
+ /**
2080
+ * Error
2081
+ */
2082
+ error?: string | null;
2083
+ };
2084
+ /**
2085
+ * TextStatus
2086
+ */
2087
+ export type TextStatus = 'pending' | 'done' | 'no_text' | 'unsupported' | 'failed';
2088
+ /**
2089
+ * TokenOut
2090
+ */
2091
+ export type TokenOut = {
2092
+ /**
2093
+ * Id
2094
+ */
2095
+ id: string;
2096
+ /**
2097
+ * Name
2098
+ */
2099
+ name: string;
2100
+ /**
2101
+ * Hint
2102
+ */
2103
+ hint: string;
2104
+ /**
2105
+ * Scopes
2106
+ */
2107
+ scopes: Array<Scope>;
2108
+ /**
2109
+ * Library Ids
2110
+ */
2111
+ library_ids: Array<string> | null;
2112
+ /**
2113
+ * Created At
2114
+ */
2115
+ created_at: string;
2116
+ /**
2117
+ * Expires At
2118
+ */
2119
+ expires_at: string | null;
2120
+ /**
2121
+ * Last Used At
2122
+ */
2123
+ last_used_at: string | null;
2124
+ };
2125
+ /**
2126
+ * Usage
2127
+ */
2128
+ export type Usage = {
2129
+ /**
2130
+ * Library Bytes
2131
+ */
2132
+ library_bytes: number;
2133
+ disk: Disk | null;
2134
+ /**
2135
+ * Backups Bytes
2136
+ */
2137
+ backups_bytes: number | null;
2138
+ backups_disk: Disk | null;
2139
+ };
2140
+ /**
2141
+ * UserBrief
2142
+ */
2143
+ export type UserBrief = {
2144
+ /**
2145
+ * Id
2146
+ */
2147
+ id: string;
2148
+ /**
2149
+ * Username
2150
+ */
2151
+ username: string;
2152
+ };
2153
+ /**
2154
+ * UserChange
2155
+ *
2156
+ * Only the fields given change.
2157
+ */
2158
+ export type UserChange = {
2159
+ /**
2160
+ * Password
2161
+ */
2162
+ password?: string | null;
2163
+ /**
2164
+ * Is Admin
2165
+ */
2166
+ is_admin?: boolean | null;
2167
+ /**
2168
+ * Active
2169
+ */
2170
+ active?: boolean | null;
2171
+ };
2172
+ /**
2173
+ * UserOut
2174
+ */
2175
+ export type UserOut = {
2176
+ /**
2177
+ * Id
2178
+ */
2179
+ id: string;
2180
+ /**
2181
+ * Username
2182
+ */
2183
+ username: string;
2184
+ /**
2185
+ * Is Admin
2186
+ */
2187
+ is_admin: boolean;
2188
+ /**
2189
+ * Seen Hints
2190
+ */
2191
+ seen_hints: Array<string>;
2192
+ /**
2193
+ * Oidc Linked
2194
+ */
2195
+ oidc_linked?: boolean;
2196
+ /**
2197
+ * Avatar Url
2198
+ */
2199
+ avatar_url?: string | null;
2200
+ };
2201
+ /**
2202
+ * UserRow
2203
+ */
2204
+ export type UserRow = {
2205
+ /**
2206
+ * Id
2207
+ */
2208
+ id: string;
2209
+ /**
2210
+ * Username
2211
+ */
2212
+ username: string;
2213
+ /**
2214
+ * Is Admin
2215
+ */
2216
+ is_admin: boolean;
2217
+ /**
2218
+ * Created At
2219
+ */
2220
+ created_at: string;
2221
+ /**
2222
+ * Last Login At
2223
+ */
2224
+ last_login_at: string | null;
2225
+ /**
2226
+ * Deactivated At
2227
+ */
2228
+ deactivated_at: string | null;
2229
+ /**
2230
+ * Groups
2231
+ */
2232
+ groups: number;
2233
+ /**
2234
+ * Papers
2235
+ */
2236
+ papers: number;
2237
+ /**
2238
+ * Avatar Url
2239
+ */
2240
+ avatar_url?: string | null;
2241
+ };
2242
+ /**
2243
+ * ValidationError
2244
+ */
2245
+ export type ValidationError = {
2246
+ /**
2247
+ * Location
2248
+ */
2249
+ loc: Array<string | number>;
2250
+ /**
2251
+ * Message
2252
+ */
2253
+ msg: string;
2254
+ /**
2255
+ * Error Type
2256
+ */
2257
+ type: string;
2258
+ /**
2259
+ * Input
2260
+ */
2261
+ input?: unknown;
2262
+ /**
2263
+ * Context
2264
+ */
2265
+ ctx?: {
2266
+ [key: string]: unknown;
2267
+ };
2268
+ };
2269
+ /**
2270
+ * VersionIn
2271
+ *
2272
+ * A version by DOI (metadata is looked up) or with metadata typed in.
2273
+ *
2274
+ * Examples: ``{"doi": "10.1038/…"}``; meeting notes:
2275
+ * ``{"metadata": {"type": "document", "genre": "Meeting notes",
2276
+ * "title": "Group meeting", "issued": {"date-parts": [[2026, 11, 4]]}}}``.
2277
+ */
2278
+ export type VersionIn = {
2279
+ /**
2280
+ * Doi
2281
+ */
2282
+ doi?: string | null;
2283
+ /**
2284
+ * Metadata
2285
+ */
2286
+ metadata?: {
2287
+ [key: string]: unknown;
2288
+ } | null;
2289
+ /**
2290
+ * Identifiers
2291
+ */
2292
+ identifiers?: Array<IdentifierIn>;
2293
+ kind?: VersionKind | null;
2294
+ /**
2295
+ * Label
2296
+ */
2297
+ label?: string | null;
2298
+ };
2299
+ /**
2300
+ * VersionKind
2301
+ */
2302
+ export type VersionKind = 'draft' | 'submitted' | 'preprint' | 'accepted' | 'published' | 'edition' | 'other';
2303
+ /**
2304
+ * VersionOut
2305
+ */
2306
+ export type VersionOut = {
2307
+ /**
2308
+ * Id
2309
+ */
2310
+ id: string;
2311
+ kind: VersionKind;
2312
+ /**
2313
+ * Label
2314
+ */
2315
+ label: string | null;
2316
+ /**
2317
+ * Pinned
2318
+ */
2319
+ pinned: boolean;
2320
+ metadata_source: MetadataSource;
2321
+ /**
2322
+ * Identifiers
2323
+ */
2324
+ identifiers: Array<IdentifierOut>;
2325
+ /**
2326
+ * Csl
2327
+ */
2328
+ csl: {
2329
+ [key: string]: unknown;
2330
+ };
2331
+ /**
2332
+ * Files
2333
+ */
2334
+ files: Array<FileOut>;
2335
+ /**
2336
+ * Created At
2337
+ */
2338
+ created_at: string;
2339
+ };
2340
+ export type HealthData = {
2341
+ body?: never;
2342
+ path?: never;
2343
+ query?: never;
2344
+ url: '/api/health';
2345
+ };
2346
+ export type HealthResponses = {
2347
+ /**
2348
+ * Response Health
2349
+ *
2350
+ * Successful Response
2351
+ */
2352
+ 200: {
2353
+ [key: string]: string;
2354
+ };
2355
+ };
2356
+ export type HealthResponse = HealthResponses[keyof HealthResponses];
2357
+ export type HealthDbData = {
2358
+ body?: never;
2359
+ path?: never;
2360
+ query?: never;
2361
+ url: '/api/health/db';
2362
+ };
2363
+ export type HealthDbResponses = {
2364
+ /**
2365
+ * Response Health Db
2366
+ *
2367
+ * Successful Response
2368
+ */
2369
+ 200: {
2370
+ [key: string]: string;
2371
+ };
2372
+ };
2373
+ export type HealthDbResponse = HealthDbResponses[keyof HealthDbResponses];
2374
+ export type LoginData = {
2375
+ body: LoginRequest;
2376
+ path?: never;
2377
+ query?: never;
2378
+ url: '/api/auth/login';
2379
+ };
2380
+ export type LoginErrors = {
2381
+ /**
2382
+ * Validation Error
2383
+ */
2384
+ 422: HttpValidationError;
2385
+ };
2386
+ export type LoginError = LoginErrors[keyof LoginErrors];
2387
+ export type LoginResponses = {
2388
+ /**
2389
+ * Successful Response
2390
+ */
2391
+ 200: LoginResponse;
2392
+ };
2393
+ export type LoginResponse2 = LoginResponses[keyof LoginResponses];
2394
+ export type LoginMethodsData = {
2395
+ body?: never;
2396
+ path?: never;
2397
+ query?: never;
2398
+ url: '/api/auth/methods';
2399
+ };
2400
+ export type LoginMethodsResponses = {
2401
+ /**
2402
+ * Successful Response
2403
+ */
2404
+ 200: LoginMethods;
2405
+ };
2406
+ export type LoginMethodsResponse = LoginMethodsResponses[keyof LoginMethodsResponses];
2407
+ export type OidcStartData = {
2408
+ body?: never;
2409
+ path?: never;
2410
+ query?: {
2411
+ /**
2412
+ * Next
2413
+ */
2414
+ next?: string;
2415
+ /**
2416
+ * Link
2417
+ */
2418
+ link?: boolean;
2419
+ };
2420
+ url: '/api/auth/oidc/start';
2421
+ };
2422
+ export type OidcStartErrors = {
2423
+ /**
2424
+ * Validation Error
2425
+ */
2426
+ 422: HttpValidationError;
2427
+ };
2428
+ export type OidcStartError = OidcStartErrors[keyof OidcStartErrors];
2429
+ export type OidcStartResponses = {
2430
+ /**
2431
+ * Successful Response
2432
+ */
2433
+ 200: unknown;
2434
+ };
2435
+ export type OidcCallbackData = {
2436
+ body?: never;
2437
+ path?: never;
2438
+ query?: {
2439
+ /**
2440
+ * Code
2441
+ */
2442
+ code?: string | null;
2443
+ /**
2444
+ * State
2445
+ */
2446
+ state?: string | null;
2447
+ /**
2448
+ * Error
2449
+ */
2450
+ error?: string | null;
2451
+ /**
2452
+ * Error Description
2453
+ */
2454
+ error_description?: string | null;
2455
+ };
2456
+ url: '/api/auth/oidc/callback';
2457
+ };
2458
+ export type OidcCallbackErrors = {
2459
+ /**
2460
+ * Validation Error
2461
+ */
2462
+ 422: HttpValidationError;
2463
+ };
2464
+ export type OidcCallbackError = OidcCallbackErrors[keyof OidcCallbackErrors];
2465
+ export type OidcCallbackResponses = {
2466
+ /**
2467
+ * Successful Response
2468
+ */
2469
+ 200: unknown;
2470
+ };
2471
+ export type UnlinkOidcData = {
2472
+ body?: never;
2473
+ path?: never;
2474
+ query?: never;
2475
+ url: '/api/auth/oidc/link';
2476
+ };
2477
+ export type UnlinkOidcResponses = {
2478
+ /**
2479
+ * Successful Response
2480
+ */
2481
+ 204: void;
2482
+ };
2483
+ export type UnlinkOidcResponse = UnlinkOidcResponses[keyof UnlinkOidcResponses];
2484
+ export type LogoutData = {
2485
+ body?: never;
2486
+ path?: never;
2487
+ query?: never;
2488
+ url: '/api/auth/logout';
2489
+ };
2490
+ export type LogoutResponses = {
2491
+ /**
2492
+ * Successful Response
2493
+ */
2494
+ 204: void;
2495
+ };
2496
+ export type LogoutResponse = LogoutResponses[keyof LogoutResponses];
2497
+ export type MeData = {
2498
+ body?: never;
2499
+ path?: never;
2500
+ query?: never;
2501
+ url: '/api/auth/me';
2502
+ };
2503
+ export type MeResponses = {
2504
+ /**
2505
+ * Successful Response
2506
+ */
2507
+ 200: UserOut;
2508
+ };
2509
+ export type MeResponse = MeResponses[keyof MeResponses];
2510
+ export type ChangePasswordData = {
2511
+ body: PasswordChange;
2512
+ path?: never;
2513
+ query?: never;
2514
+ url: '/api/auth/password';
2515
+ };
2516
+ export type ChangePasswordErrors = {
2517
+ /**
2518
+ * Validation Error
2519
+ */
2520
+ 422: HttpValidationError;
2521
+ };
2522
+ export type ChangePasswordError = ChangePasswordErrors[keyof ChangePasswordErrors];
2523
+ export type ChangePasswordResponses = {
2524
+ /**
2525
+ * Successful Response
2526
+ */
2527
+ 204: void;
2528
+ };
2529
+ export type ChangePasswordResponse = ChangePasswordResponses[keyof ChangePasswordResponses];
2530
+ export type MarkHintSeenData = {
2531
+ body?: never;
2532
+ path: {
2533
+ /**
2534
+ * Hint
2535
+ */
2536
+ hint: string;
2537
+ };
2538
+ query?: never;
2539
+ url: '/api/auth/hints/{hint}';
2540
+ };
2541
+ export type MarkHintSeenErrors = {
2542
+ /**
2543
+ * Validation Error
2544
+ */
2545
+ 422: HttpValidationError;
2546
+ };
2547
+ export type MarkHintSeenError = MarkHintSeenErrors[keyof MarkHintSeenErrors];
2548
+ export type MarkHintSeenResponses = {
2549
+ /**
2550
+ * Successful Response
2551
+ */
2552
+ 204: void;
2553
+ };
2554
+ export type MarkHintSeenResponse = MarkHintSeenResponses[keyof MarkHintSeenResponses];
2555
+ export type RemoveAvatarData = {
2556
+ body?: never;
2557
+ path?: never;
2558
+ query?: never;
2559
+ url: '/api/me/avatar';
2560
+ };
2561
+ export type RemoveAvatarResponses = {
2562
+ /**
2563
+ * Successful Response
2564
+ */
2565
+ 200: UserOut;
2566
+ };
2567
+ export type RemoveAvatarResponse = RemoveAvatarResponses[keyof RemoveAvatarResponses];
2568
+ export type SetAvatarData = {
2569
+ body: BodySetAvatar;
2570
+ path?: never;
2571
+ query?: never;
2572
+ url: '/api/me/avatar';
2573
+ };
2574
+ export type SetAvatarErrors = {
2575
+ /**
2576
+ * Validation Error
2577
+ */
2578
+ 422: HttpValidationError;
2579
+ };
2580
+ export type SetAvatarError = SetAvatarErrors[keyof SetAvatarErrors];
2581
+ export type SetAvatarResponses = {
2582
+ /**
2583
+ * Successful Response
2584
+ */
2585
+ 200: UserOut;
2586
+ };
2587
+ export type SetAvatarResponse = SetAvatarResponses[keyof SetAvatarResponses];
2588
+ export type GetAvatarData = {
2589
+ body?: never;
2590
+ path: {
2591
+ /**
2592
+ * User Id
2593
+ */
2594
+ user_id: string;
2595
+ };
2596
+ query?: never;
2597
+ url: '/api/users/{user_id}/avatar';
2598
+ };
2599
+ export type GetAvatarErrors = {
2600
+ /**
2601
+ * Validation Error
2602
+ */
2603
+ 422: HttpValidationError;
2604
+ };
2605
+ export type GetAvatarError = GetAvatarErrors[keyof GetAvatarErrors];
2606
+ export type GetAvatarResponses = {
2607
+ /**
2608
+ * Successful Response
2609
+ */
2610
+ 200: unknown;
2611
+ };
2612
+ export type ListItemsData = {
2613
+ body?: never;
2614
+ path?: never;
2615
+ query?: {
2616
+ /**
2617
+ * Limit
2618
+ */
2619
+ limit?: number;
2620
+ /**
2621
+ * Before
2622
+ */
2623
+ before?: string | null;
2624
+ /**
2625
+ * Trashed
2626
+ */
2627
+ trashed?: boolean;
2628
+ /**
2629
+ * Since
2630
+ */
2631
+ since?: number | null;
2632
+ /**
2633
+ * Tag
2634
+ */
2635
+ tag?: Array<string> | null;
2636
+ /**
2637
+ * Collection
2638
+ */
2639
+ collection?: string | null;
2640
+ /**
2641
+ * Nested
2642
+ */
2643
+ nested?: boolean;
2644
+ /**
2645
+ * Title
2646
+ */
2647
+ title?: string | null;
2648
+ /**
2649
+ * Library
2650
+ */
2651
+ library?: string | null;
2652
+ /**
2653
+ * Sort
2654
+ */
2655
+ sort?: 'added' | 'recent' | 'opened';
2656
+ /**
2657
+ * Offset
2658
+ */
2659
+ offset?: number;
2660
+ /**
2661
+ * Unsorted
2662
+ */
2663
+ unsorted?: boolean;
2664
+ /**
2665
+ * Favourite
2666
+ */
2667
+ favourite?: boolean;
2668
+ /**
2669
+ * Id
2670
+ */
2671
+ id?: Array<string> | null;
2672
+ };
2673
+ url: '/api/items';
2674
+ };
2675
+ export type ListItemsErrors = {
2676
+ /**
2677
+ * Validation Error
2678
+ */
2679
+ 422: HttpValidationError;
2680
+ };
2681
+ export type ListItemsError = ListItemsErrors[keyof ListItemsErrors];
2682
+ export type ListItemsResponses = {
2683
+ /**
2684
+ * Response List Items
2685
+ *
2686
+ * Successful Response
2687
+ */
2688
+ 200: Array<ItemOut>;
2689
+ };
2690
+ export type ListItemsResponse = ListItemsResponses[keyof ListItemsResponses];
2691
+ export type AddItemData = {
2692
+ body: ItemIn;
2693
+ path?: never;
2694
+ query?: never;
2695
+ url: '/api/items';
2696
+ };
2697
+ export type AddItemErrors = {
2698
+ /**
2699
+ * Validation Error
2700
+ */
2701
+ 422: HttpValidationError;
2702
+ };
2703
+ export type AddItemError = AddItemErrors[keyof AddItemErrors];
2704
+ export type AddItemResponses = {
2705
+ /**
2706
+ * Successful Response
2707
+ */
2708
+ 201: ItemDetail;
2709
+ };
2710
+ export type AddItemResponse = AddItemResponses[keyof AddItemResponses];
2711
+ export type AddVersionData = {
2712
+ body: VersionIn;
2713
+ path: {
2714
+ /**
2715
+ * Item Id
2716
+ */
2717
+ item_id: string;
2718
+ };
2719
+ query?: never;
2720
+ url: '/api/items/{item_id}/versions';
2721
+ };
2722
+ export type AddVersionErrors = {
2723
+ /**
2724
+ * Validation Error
2725
+ */
2726
+ 422: HttpValidationError;
2727
+ };
2728
+ export type AddVersionError = AddVersionErrors[keyof AddVersionErrors];
2729
+ export type AddVersionResponses = {
2730
+ /**
2731
+ * Successful Response
2732
+ */
2733
+ 201: ItemDetail;
2734
+ };
2735
+ export type AddVersionResponse = AddVersionResponses[keyof AddVersionResponses];
2736
+ export type PinVersionData = {
2737
+ body?: never;
2738
+ path: {
2739
+ /**
2740
+ * Version Id
2741
+ */
2742
+ version_id: string;
2743
+ };
2744
+ query?: never;
2745
+ url: '/api/versions/{version_id}/pin';
2746
+ };
2747
+ export type PinVersionErrors = {
2748
+ /**
2749
+ * Validation Error
2750
+ */
2751
+ 422: HttpValidationError;
2752
+ };
2753
+ export type PinVersionError = PinVersionErrors[keyof PinVersionErrors];
2754
+ export type PinVersionResponses = {
2755
+ /**
2756
+ * Successful Response
2757
+ */
2758
+ 200: ItemDetail;
2759
+ };
2760
+ export type PinVersionResponse = PinVersionResponses[keyof PinVersionResponses];
2761
+ export type SetOverridesData = {
2762
+ /**
2763
+ * Overrides
2764
+ */
2765
+ body: {
2766
+ [key: string]: unknown;
2767
+ };
2768
+ headers?: {
2769
+ /**
2770
+ * If-Match
2771
+ */
2772
+ 'if-match'?: string | null;
2773
+ };
2774
+ path: {
2775
+ /**
2776
+ * Item Id
2777
+ */
2778
+ item_id: string;
2779
+ };
2780
+ query?: never;
2781
+ url: '/api/items/{item_id}/overrides';
2782
+ };
2783
+ export type SetOverridesErrors = {
2784
+ /**
2785
+ * Validation Error
2786
+ */
2787
+ 422: HttpValidationError;
2788
+ };
2789
+ export type SetOverridesError = SetOverridesErrors[keyof SetOverridesErrors];
2790
+ export type SetOverridesResponses = {
2791
+ /**
2792
+ * Successful Response
2793
+ */
2794
+ 200: ItemDetail;
2795
+ };
2796
+ export type SetOverridesResponse = SetOverridesResponses[keyof SetOverridesResponses];
2797
+ export type TrashItemData = {
2798
+ body?: never;
2799
+ path: {
2800
+ /**
2801
+ * Item Id
2802
+ */
2803
+ item_id: string;
2804
+ };
2805
+ query?: never;
2806
+ url: '/api/items/{item_id}';
2807
+ };
2808
+ export type TrashItemErrors = {
2809
+ /**
2810
+ * Validation Error
2811
+ */
2812
+ 422: HttpValidationError;
2813
+ };
2814
+ export type TrashItemError = TrashItemErrors[keyof TrashItemErrors];
2815
+ export type TrashItemResponses = {
2816
+ /**
2817
+ * Successful Response
2818
+ */
2819
+ 204: void;
2820
+ };
2821
+ export type TrashItemResponse = TrashItemResponses[keyof TrashItemResponses];
2822
+ export type GetItemData = {
2823
+ body?: never;
2824
+ path: {
2825
+ /**
2826
+ * Item Id
2827
+ */
2828
+ item_id: string;
2829
+ };
2830
+ query?: never;
2831
+ url: '/api/items/{item_id}';
2832
+ };
2833
+ export type GetItemErrors = {
2834
+ /**
2835
+ * Validation Error
2836
+ */
2837
+ 422: HttpValidationError;
2838
+ };
2839
+ export type GetItemError = GetItemErrors[keyof GetItemErrors];
2840
+ export type GetItemResponses = {
2841
+ /**
2842
+ * Successful Response
2843
+ */
2844
+ 200: ItemDetail;
2845
+ };
2846
+ export type GetItemResponse = GetItemResponses[keyof GetItemResponses];
2847
+ export type SetOwnerData = {
2848
+ body: Owner;
2849
+ path: {
2850
+ /**
2851
+ * Item Id
2852
+ */
2853
+ item_id: string;
2854
+ };
2855
+ query?: never;
2856
+ url: '/api/items/{item_id}/owner';
2857
+ };
2858
+ export type SetOwnerErrors = {
2859
+ /**
2860
+ * Validation Error
2861
+ */
2862
+ 422: HttpValidationError;
2863
+ };
2864
+ export type SetOwnerError = SetOwnerErrors[keyof SetOwnerErrors];
2865
+ export type SetOwnerResponses = {
2866
+ /**
2867
+ * Successful Response
2868
+ */
2869
+ 200: ItemDetail;
2870
+ };
2871
+ export type SetOwnerResponse = SetOwnerResponses[keyof SetOwnerResponses];
2872
+ export type RestoreItemData = {
2873
+ body?: never;
2874
+ path: {
2875
+ /**
2876
+ * Item Id
2877
+ */
2878
+ item_id: string;
2879
+ };
2880
+ query?: never;
2881
+ url: '/api/items/{item_id}/restore';
2882
+ };
2883
+ export type RestoreItemErrors = {
2884
+ /**
2885
+ * Validation Error
2886
+ */
2887
+ 422: HttpValidationError;
2888
+ };
2889
+ export type RestoreItemError = RestoreItemErrors[keyof RestoreItemErrors];
2890
+ export type RestoreItemResponses = {
2891
+ /**
2892
+ * Successful Response
2893
+ */
2894
+ 200: ItemDetail;
2895
+ };
2896
+ export type RestoreItemResponse = RestoreItemResponses[keyof RestoreItemResponses];
2897
+ export type UnstarItemData = {
2898
+ body?: never;
2899
+ path: {
2900
+ /**
2901
+ * Item Id
2902
+ */
2903
+ item_id: string;
2904
+ };
2905
+ query?: never;
2906
+ url: '/api/items/{item_id}/favourite';
2907
+ };
2908
+ export type UnstarItemErrors = {
2909
+ /**
2910
+ * Validation Error
2911
+ */
2912
+ 422: HttpValidationError;
2913
+ };
2914
+ export type UnstarItemError = UnstarItemErrors[keyof UnstarItemErrors];
2915
+ export type UnstarItemResponses = {
2916
+ /**
2917
+ * Successful Response
2918
+ */
2919
+ 204: void;
2920
+ };
2921
+ export type UnstarItemResponse = UnstarItemResponses[keyof UnstarItemResponses];
2922
+ export type StarItemData = {
2923
+ body?: never;
2924
+ path: {
2925
+ /**
2926
+ * Item Id
2927
+ */
2928
+ item_id: string;
2929
+ };
2930
+ query?: never;
2931
+ url: '/api/items/{item_id}/favourite';
2932
+ };
2933
+ export type StarItemErrors = {
2934
+ /**
2935
+ * Validation Error
2936
+ */
2937
+ 422: HttpValidationError;
2938
+ };
2939
+ export type StarItemError = StarItemErrors[keyof StarItemErrors];
2940
+ export type StarItemResponses = {
2941
+ /**
2942
+ * Successful Response
2943
+ */
2944
+ 204: void;
2945
+ };
2946
+ export type StarItemResponse = StarItemResponses[keyof StarItemResponses];
2947
+ export type MarkViewedData = {
2948
+ body?: never;
2949
+ path: {
2950
+ /**
2951
+ * Item Id
2952
+ */
2953
+ item_id: string;
2954
+ };
2955
+ query?: never;
2956
+ url: '/api/items/{item_id}/viewed';
2957
+ };
2958
+ export type MarkViewedErrors = {
2959
+ /**
2960
+ * Validation Error
2961
+ */
2962
+ 422: HttpValidationError;
2963
+ };
2964
+ export type MarkViewedError = MarkViewedErrors[keyof MarkViewedErrors];
2965
+ export type MarkViewedResponses = {
2966
+ /**
2967
+ * Successful Response
2968
+ */
2969
+ 204: void;
2970
+ };
2971
+ export type MarkViewedResponse = MarkViewedResponses[keyof MarkViewedResponses];
2972
+ export type ListDuplicatesData = {
2973
+ body?: never;
2974
+ path: {
2975
+ /**
2976
+ * Item Id
2977
+ */
2978
+ item_id: string;
2979
+ };
2980
+ query?: never;
2981
+ url: '/api/items/{item_id}/duplicates';
2982
+ };
2983
+ export type ListDuplicatesErrors = {
2984
+ /**
2985
+ * Validation Error
2986
+ */
2987
+ 422: HttpValidationError;
2988
+ };
2989
+ export type ListDuplicatesError = ListDuplicatesErrors[keyof ListDuplicatesErrors];
2990
+ export type ListDuplicatesResponses = {
2991
+ /**
2992
+ * Response List Duplicates
2993
+ *
2994
+ * Successful Response
2995
+ */
2996
+ 200: Array<ItemOut>;
2997
+ };
2998
+ export type ListDuplicatesResponse = ListDuplicatesResponses[keyof ListDuplicatesResponses];
2999
+ export type PreviewMergeData = {
3000
+ body?: never;
3001
+ path: {
3002
+ /**
3003
+ * Item Id
3004
+ */
3005
+ item_id: string;
3006
+ };
3007
+ query: {
3008
+ /**
3009
+ * Into
3010
+ */
3011
+ into: string;
3012
+ };
3013
+ url: '/api/items/{item_id}/merge-preview';
3014
+ };
3015
+ export type PreviewMergeErrors = {
3016
+ /**
3017
+ * Validation Error
3018
+ */
3019
+ 422: HttpValidationError;
3020
+ };
3021
+ export type PreviewMergeError = PreviewMergeErrors[keyof PreviewMergeErrors];
3022
+ export type PreviewMergeResponses = {
3023
+ /**
3024
+ * Successful Response
3025
+ */
3026
+ 200: MergePreview;
3027
+ };
3028
+ export type PreviewMergeResponse = PreviewMergeResponses[keyof PreviewMergeResponses];
3029
+ export type MergeItemData = {
3030
+ body: MergeInto;
3031
+ path: {
3032
+ /**
3033
+ * Item Id
3034
+ */
3035
+ item_id: string;
3036
+ };
3037
+ query?: never;
3038
+ url: '/api/items/{item_id}/merge';
3039
+ };
3040
+ export type MergeItemErrors = {
3041
+ /**
3042
+ * Validation Error
3043
+ */
3044
+ 422: HttpValidationError;
3045
+ };
3046
+ export type MergeItemError = MergeItemErrors[keyof MergeItemErrors];
3047
+ export type MergeItemResponses = {
3048
+ /**
3049
+ * Successful Response
3050
+ */
3051
+ 200: MergeOut;
3052
+ };
3053
+ export type MergeItemResponse = MergeItemResponses[keyof MergeItemResponses];
3054
+ export type FindUploadData = {
3055
+ body?: never;
3056
+ path: {
3057
+ /**
3058
+ * Sha256
3059
+ */
3060
+ sha256: string;
3061
+ };
3062
+ query?: never;
3063
+ url: '/api/uploads/{sha256}';
3064
+ };
3065
+ export type FindUploadErrors = {
3066
+ /**
3067
+ * Validation Error
3068
+ */
3069
+ 422: HttpValidationError;
3070
+ };
3071
+ export type FindUploadError = FindUploadErrors[keyof FindUploadErrors];
3072
+ export type FindUploadResponses = {
3073
+ /**
3074
+ * Successful Response
3075
+ */
3076
+ 200: KnownFile;
3077
+ };
3078
+ export type FindUploadResponse = FindUploadResponses[keyof FindUploadResponses];
3079
+ export type UploadNewItemData = {
3080
+ body: BodyUploadNewItem;
3081
+ path?: never;
3082
+ query?: never;
3083
+ url: '/api/uploads';
3084
+ };
3085
+ export type UploadNewItemErrors = {
3086
+ /**
3087
+ * Validation Error
3088
+ */
3089
+ 422: HttpValidationError;
3090
+ };
3091
+ export type UploadNewItemError = UploadNewItemErrors[keyof UploadNewItemErrors];
3092
+ export type UploadNewItemResponses = {
3093
+ /**
3094
+ * Successful Response
3095
+ */
3096
+ 201: NewItemUpload;
3097
+ };
3098
+ export type UploadNewItemResponse = UploadNewItemResponses[keyof UploadNewItemResponses];
3099
+ export type UploadToVersionData = {
3100
+ body: BodyUploadToVersion;
3101
+ path: {
3102
+ /**
3103
+ * Version Id
3104
+ */
3105
+ version_id: string;
3106
+ };
3107
+ query?: never;
3108
+ url: '/api/versions/{version_id}/files';
3109
+ };
3110
+ export type UploadToVersionErrors = {
3111
+ /**
3112
+ * Validation Error
3113
+ */
3114
+ 422: HttpValidationError;
3115
+ };
3116
+ export type UploadToVersionError = UploadToVersionErrors[keyof UploadToVersionErrors];
3117
+ export type UploadToVersionResponses = {
3118
+ /**
3119
+ * Successful Response
3120
+ */
3121
+ 201: FileOut;
3122
+ };
3123
+ export type UploadToVersionResponse = UploadToVersionResponses[keyof UploadToVersionResponses];
3124
+ export type UploadToItemData = {
3125
+ body: BodyUploadToItem;
3126
+ path: {
3127
+ /**
3128
+ * Item Id
3129
+ */
3130
+ item_id: string;
3131
+ };
3132
+ query?: never;
3133
+ url: '/api/items/{item_id}/files';
3134
+ };
3135
+ export type UploadToItemErrors = {
3136
+ /**
3137
+ * Validation Error
3138
+ */
3139
+ 422: HttpValidationError;
3140
+ };
3141
+ export type UploadToItemError = UploadToItemErrors[keyof UploadToItemErrors];
3142
+ export type UploadToItemResponses = {
3143
+ /**
3144
+ * Successful Response
3145
+ */
3146
+ 201: FileOut;
3147
+ };
3148
+ export type UploadToItemResponse = UploadToItemResponses[keyof UploadToItemResponses];
3149
+ export type DownloadFileData = {
3150
+ body?: never;
3151
+ path: {
3152
+ /**
3153
+ * File Id
3154
+ */
3155
+ file_id: string;
3156
+ };
3157
+ query?: never;
3158
+ url: '/api/files/{file_id}/content';
3159
+ };
3160
+ export type DownloadFileErrors = {
3161
+ /**
3162
+ * Validation Error
3163
+ */
3164
+ 422: HttpValidationError;
3165
+ };
3166
+ export type DownloadFileError = DownloadFileErrors[keyof DownloadFileErrors];
3167
+ export type DownloadFileResponses = {
3168
+ /**
3169
+ * Successful Response
3170
+ */
3171
+ 200: unknown;
3172
+ };
3173
+ export type TrashFileData = {
3174
+ body?: never;
3175
+ path: {
3176
+ /**
3177
+ * File Id
3178
+ */
3179
+ file_id: string;
3180
+ };
3181
+ query?: never;
3182
+ url: '/api/files/{file_id}';
3183
+ };
3184
+ export type TrashFileErrors = {
3185
+ /**
3186
+ * Validation Error
3187
+ */
3188
+ 422: HttpValidationError;
3189
+ };
3190
+ export type TrashFileError = TrashFileErrors[keyof TrashFileErrors];
3191
+ export type TrashFileResponses = {
3192
+ /**
3193
+ * Successful Response
3194
+ */
3195
+ 204: void;
3196
+ };
3197
+ export type TrashFileResponse = TrashFileResponses[keyof TrashFileResponses];
3198
+ export type RestoreFileData = {
3199
+ body?: never;
3200
+ path: {
3201
+ /**
3202
+ * File Id
3203
+ */
3204
+ file_id: string;
3205
+ };
3206
+ query?: never;
3207
+ url: '/api/files/{file_id}/restore';
3208
+ };
3209
+ export type RestoreFileErrors = {
3210
+ /**
3211
+ * Validation Error
3212
+ */
3213
+ 422: HttpValidationError;
3214
+ };
3215
+ export type RestoreFileError = RestoreFileErrors[keyof RestoreFileErrors];
3216
+ export type RestoreFileResponses = {
3217
+ /**
3218
+ * Successful Response
3219
+ */
3220
+ 200: FileOut;
3221
+ };
3222
+ export type RestoreFileResponse = RestoreFileResponses[keyof RestoreFileResponses];
3223
+ export type SearchData = {
3224
+ body?: never;
3225
+ path?: never;
3226
+ query: {
3227
+ /**
3228
+ * Q
3229
+ */
3230
+ q: string;
3231
+ /**
3232
+ * Limit
3233
+ */
3234
+ limit?: number;
3235
+ /**
3236
+ * Mode
3237
+ */
3238
+ mode?: 'hybrid' | 'keyword' | 'meaning';
3239
+ /**
3240
+ * Type
3241
+ */
3242
+ type?: Array<string> | null;
3243
+ /**
3244
+ * Library
3245
+ */
3246
+ library?: string | null;
3247
+ /**
3248
+ * Per Item
3249
+ */
3250
+ per_item?: number | null;
3251
+ /**
3252
+ * Item
3253
+ */
3254
+ item?: string | null;
3255
+ };
3256
+ url: '/api/search';
3257
+ };
3258
+ export type SearchErrors = {
3259
+ /**
3260
+ * Validation Error
3261
+ */
3262
+ 422: HttpValidationError;
3263
+ };
3264
+ export type SearchError = SearchErrors[keyof SearchErrors];
3265
+ export type SearchResponses = {
3266
+ /**
3267
+ * Response Search
3268
+ *
3269
+ * Successful Response
3270
+ */
3271
+ 200: Array<Passage>;
3272
+ };
3273
+ export type SearchResponse = SearchResponses[keyof SearchResponses];
3274
+ export type ExportCitationsData = {
3275
+ body?: never;
3276
+ path?: never;
3277
+ query?: {
3278
+ /**
3279
+ * Format
3280
+ */
3281
+ format?: 'bibtex' | 'csl-json';
3282
+ /**
3283
+ * Item
3284
+ */
3285
+ item?: Array<string> | null;
3286
+ /**
3287
+ * Collection
3288
+ */
3289
+ collection?: string | null;
3290
+ /**
3291
+ * Nested
3292
+ */
3293
+ nested?: boolean;
3294
+ /**
3295
+ * Download
3296
+ */
3297
+ download?: boolean;
3298
+ };
3299
+ url: '/api/citations';
3300
+ };
3301
+ export type ExportCitationsErrors = {
3302
+ /**
3303
+ * Validation Error
3304
+ */
3305
+ 422: HttpValidationError;
3306
+ };
3307
+ export type ExportCitationsError = ExportCitationsErrors[keyof ExportCitationsErrors];
3308
+ export type ExportCitationsResponses = {
3309
+ /**
3310
+ * Successful Response
3311
+ */
3312
+ 200: unknown;
3313
+ };
3314
+ export type ListNotesData = {
3315
+ body?: never;
3316
+ path?: never;
3317
+ query?: {
3318
+ /**
3319
+ * Item
3320
+ */
3321
+ item?: string | null;
3322
+ /**
3323
+ * Collection
3324
+ */
3325
+ collection?: string | null;
3326
+ /**
3327
+ * Nested
3328
+ */
3329
+ nested?: boolean;
3330
+ /**
3331
+ * Trashed
3332
+ */
3333
+ trashed?: boolean;
3334
+ /**
3335
+ * Limit
3336
+ */
3337
+ limit?: number;
3338
+ /**
3339
+ * Offset
3340
+ */
3341
+ offset?: number;
3342
+ };
3343
+ url: '/api/notes';
3344
+ };
3345
+ export type ListNotesErrors = {
3346
+ /**
3347
+ * Validation Error
3348
+ */
3349
+ 422: HttpValidationError;
3350
+ };
3351
+ export type ListNotesError = ListNotesErrors[keyof ListNotesErrors];
3352
+ export type ListNotesResponses = {
3353
+ /**
3354
+ * Response List Notes
3355
+ *
3356
+ * Successful Response
3357
+ */
3358
+ 200: Array<NoteOut>;
3359
+ };
3360
+ export type ListNotesResponse = ListNotesResponses[keyof ListNotesResponses];
3361
+ export type CreateNoteData = {
3362
+ body: NoteIn;
3363
+ path?: never;
3364
+ query?: never;
3365
+ url: '/api/notes';
3366
+ };
3367
+ export type CreateNoteErrors = {
3368
+ /**
3369
+ * Validation Error
3370
+ */
3371
+ 422: HttpValidationError;
3372
+ };
3373
+ export type CreateNoteError = CreateNoteErrors[keyof CreateNoteErrors];
3374
+ export type CreateNoteResponses = {
3375
+ /**
3376
+ * Successful Response
3377
+ */
3378
+ 201: NoteDetail;
3379
+ };
3380
+ export type CreateNoteResponse = CreateNoteResponses[keyof CreateNoteResponses];
3381
+ export type TrashNoteData = {
3382
+ body?: never;
3383
+ path: {
3384
+ /**
3385
+ * Note Id
3386
+ */
3387
+ note_id: string;
3388
+ };
3389
+ query?: never;
3390
+ url: '/api/notes/{note_id}';
3391
+ };
3392
+ export type TrashNoteErrors = {
3393
+ /**
3394
+ * Validation Error
3395
+ */
3396
+ 422: HttpValidationError;
3397
+ };
3398
+ export type TrashNoteError = TrashNoteErrors[keyof TrashNoteErrors];
3399
+ export type TrashNoteResponses = {
3400
+ /**
3401
+ * Successful Response
3402
+ */
3403
+ 204: void;
3404
+ };
3405
+ export type TrashNoteResponse = TrashNoteResponses[keyof TrashNoteResponses];
3406
+ export type ReadNoteData = {
3407
+ body?: never;
3408
+ path: {
3409
+ /**
3410
+ * Note Id
3411
+ */
3412
+ note_id: string;
3413
+ };
3414
+ query?: never;
3415
+ url: '/api/notes/{note_id}';
3416
+ };
3417
+ export type ReadNoteErrors = {
3418
+ /**
3419
+ * Validation Error
3420
+ */
3421
+ 422: HttpValidationError;
3422
+ };
3423
+ export type ReadNoteError = ReadNoteErrors[keyof ReadNoteErrors];
3424
+ export type ReadNoteResponses = {
3425
+ /**
3426
+ * Successful Response
3427
+ */
3428
+ 200: NoteDetail;
3429
+ };
3430
+ export type ReadNoteResponse = ReadNoteResponses[keyof ReadNoteResponses];
3431
+ export type ChangeNoteData = {
3432
+ body: NoteChange;
3433
+ headers?: {
3434
+ /**
3435
+ * If-Match
3436
+ */
3437
+ 'if-match'?: string | null;
3438
+ };
3439
+ path: {
3440
+ /**
3441
+ * Note Id
3442
+ */
3443
+ note_id: string;
3444
+ };
3445
+ query?: never;
3446
+ url: '/api/notes/{note_id}';
3447
+ };
3448
+ export type ChangeNoteErrors = {
3449
+ /**
3450
+ * Validation Error
3451
+ */
3452
+ 422: HttpValidationError;
3453
+ };
3454
+ export type ChangeNoteError = ChangeNoteErrors[keyof ChangeNoteErrors];
3455
+ export type ChangeNoteResponses = {
3456
+ /**
3457
+ * Successful Response
3458
+ */
3459
+ 200: NoteDetail;
3460
+ };
3461
+ export type ChangeNoteResponse = ChangeNoteResponses[keyof ChangeNoteResponses];
3462
+ export type UnlinkItemData = {
3463
+ body?: never;
3464
+ path: {
3465
+ /**
3466
+ * Note Id
3467
+ */
3468
+ note_id: string;
3469
+ /**
3470
+ * Item Id
3471
+ */
3472
+ item_id: string;
3473
+ };
3474
+ query?: never;
3475
+ url: '/api/notes/{note_id}/items/{item_id}';
3476
+ };
3477
+ export type UnlinkItemErrors = {
3478
+ /**
3479
+ * Validation Error
3480
+ */
3481
+ 422: HttpValidationError;
3482
+ };
3483
+ export type UnlinkItemError = UnlinkItemErrors[keyof UnlinkItemErrors];
3484
+ export type UnlinkItemResponses = {
3485
+ /**
3486
+ * Successful Response
3487
+ */
3488
+ 200: NoteDetail;
3489
+ };
3490
+ export type UnlinkItemResponse = UnlinkItemResponses[keyof UnlinkItemResponses];
3491
+ export type LinkItemData = {
3492
+ body: LinkChange;
3493
+ path: {
3494
+ /**
3495
+ * Note Id
3496
+ */
3497
+ note_id: string;
3498
+ /**
3499
+ * Item Id
3500
+ */
3501
+ item_id: string;
3502
+ };
3503
+ query?: never;
3504
+ url: '/api/notes/{note_id}/items/{item_id}';
3505
+ };
3506
+ export type LinkItemErrors = {
3507
+ /**
3508
+ * Validation Error
3509
+ */
3510
+ 422: HttpValidationError;
3511
+ };
3512
+ export type LinkItemError = LinkItemErrors[keyof LinkItemErrors];
3513
+ export type LinkItemResponses = {
3514
+ /**
3515
+ * Successful Response
3516
+ */
3517
+ 200: NoteDetail;
3518
+ };
3519
+ export type LinkItemResponse = LinkItemResponses[keyof LinkItemResponses];
3520
+ export type SetNoteOwnerData = {
3521
+ body: Owner;
3522
+ path: {
3523
+ /**
3524
+ * Note Id
3525
+ */
3526
+ note_id: string;
3527
+ };
3528
+ query?: never;
3529
+ url: '/api/notes/{note_id}/owner';
3530
+ };
3531
+ export type SetNoteOwnerErrors = {
3532
+ /**
3533
+ * Validation Error
3534
+ */
3535
+ 422: HttpValidationError;
3536
+ };
3537
+ export type SetNoteOwnerError = SetNoteOwnerErrors[keyof SetNoteOwnerErrors];
3538
+ export type SetNoteOwnerResponses = {
3539
+ /**
3540
+ * Successful Response
3541
+ */
3542
+ 200: NoteDetail;
3543
+ };
3544
+ export type SetNoteOwnerResponse = SetNoteOwnerResponses[keyof SetNoteOwnerResponses];
3545
+ export type RestoreNoteData = {
3546
+ body?: never;
3547
+ path: {
3548
+ /**
3549
+ * Note Id
3550
+ */
3551
+ note_id: string;
3552
+ };
3553
+ query?: never;
3554
+ url: '/api/notes/{note_id}/restore';
3555
+ };
3556
+ export type RestoreNoteErrors = {
3557
+ /**
3558
+ * Validation Error
3559
+ */
3560
+ 422: HttpValidationError;
3561
+ };
3562
+ export type RestoreNoteError = RestoreNoteErrors[keyof RestoreNoteErrors];
3563
+ export type RestoreNoteResponses = {
3564
+ /**
3565
+ * Successful Response
3566
+ */
3567
+ 200: NoteDetail;
3568
+ };
3569
+ export type RestoreNoteResponse = RestoreNoteResponses[keyof RestoreNoteResponses];
3570
+ export type NoteHistoryData = {
3571
+ body?: never;
3572
+ path: {
3573
+ /**
3574
+ * Note Id
3575
+ */
3576
+ note_id: string;
3577
+ };
3578
+ query?: never;
3579
+ url: '/api/notes/{note_id}/history';
3580
+ };
3581
+ export type NoteHistoryErrors = {
3582
+ /**
3583
+ * Validation Error
3584
+ */
3585
+ 422: HttpValidationError;
3586
+ };
3587
+ export type NoteHistoryError = NoteHistoryErrors[keyof NoteHistoryErrors];
3588
+ export type NoteHistoryResponses = {
3589
+ /**
3590
+ * Response Note History
3591
+ *
3592
+ * Successful Response
3593
+ */
3594
+ 200: Array<RevisionOut>;
3595
+ };
3596
+ export type NoteHistoryResponse = NoteHistoryResponses[keyof NoteHistoryResponses];
3597
+ export type NoteMarkdownData = {
3598
+ body?: never;
3599
+ path: {
3600
+ /**
3601
+ * Note Id
3602
+ */
3603
+ note_id: string;
3604
+ };
3605
+ query?: never;
3606
+ url: '/api/notes/{note_id}/markdown';
3607
+ };
3608
+ export type NoteMarkdownErrors = {
3609
+ /**
3610
+ * Validation Error
3611
+ */
3612
+ 422: HttpValidationError;
3613
+ };
3614
+ export type NoteMarkdownError = NoteMarkdownErrors[keyof NoteMarkdownErrors];
3615
+ export type NoteMarkdownResponses = {
3616
+ /**
3617
+ * Successful Response
3618
+ */
3619
+ 200: unknown;
3620
+ };
3621
+ export type AddNotesData = {
3622
+ body: NoteIds;
3623
+ path: {
3624
+ /**
3625
+ * Collection Id
3626
+ */
3627
+ collection_id: string;
3628
+ };
3629
+ query?: never;
3630
+ url: '/api/collections/{collection_id}/notes';
3631
+ };
3632
+ export type AddNotesErrors = {
3633
+ /**
3634
+ * Validation Error
3635
+ */
3636
+ 422: HttpValidationError;
3637
+ };
3638
+ export type AddNotesError = AddNotesErrors[keyof AddNotesErrors];
3639
+ export type AddNotesResponses = {
3640
+ /**
3641
+ * Successful Response
3642
+ */
3643
+ 204: void;
3644
+ };
3645
+ export type AddNotesResponse = AddNotesResponses[keyof AddNotesResponses];
3646
+ export type RemoveNoteData = {
3647
+ body?: never;
3648
+ path: {
3649
+ /**
3650
+ * Collection Id
3651
+ */
3652
+ collection_id: string;
3653
+ /**
3654
+ * Note Id
3655
+ */
3656
+ note_id: string;
3657
+ };
3658
+ query?: never;
3659
+ url: '/api/collections/{collection_id}/notes/{note_id}';
3660
+ };
3661
+ export type RemoveNoteErrors = {
3662
+ /**
3663
+ * Validation Error
3664
+ */
3665
+ 422: HttpValidationError;
3666
+ };
3667
+ export type RemoveNoteError = RemoveNoteErrors[keyof RemoveNoteErrors];
3668
+ export type RemoveNoteResponses = {
3669
+ /**
3670
+ * Successful Response
3671
+ */
3672
+ 204: void;
3673
+ };
3674
+ export type RemoveNoteResponse = RemoveNoteResponses[keyof RemoveNoteResponses];
3675
+ export type ListImportsData = {
3676
+ body?: never;
3677
+ path?: never;
3678
+ query?: never;
3679
+ url: '/api/imports';
3680
+ };
3681
+ export type ListImportsResponses = {
3682
+ /**
3683
+ * Response List Imports
3684
+ *
3685
+ * Successful Response
3686
+ */
3687
+ 200: Array<ImportOut>;
3688
+ };
3689
+ export type ListImportsResponse = ListImportsResponses[keyof ListImportsResponses];
3690
+ export type StartImportData = {
3691
+ body: BodyStartImport;
3692
+ path?: never;
3693
+ query?: never;
3694
+ url: '/api/imports';
3695
+ };
3696
+ export type StartImportErrors = {
3697
+ /**
3698
+ * Validation Error
3699
+ */
3700
+ 422: HttpValidationError;
3701
+ };
3702
+ export type StartImportError = StartImportErrors[keyof StartImportErrors];
3703
+ export type StartImportResponses = {
3704
+ /**
3705
+ * Successful Response
3706
+ */
3707
+ 201: ImportOut;
3708
+ };
3709
+ export type StartImportResponse = StartImportResponses[keyof StartImportResponses];
3710
+ export type GetImportData = {
3711
+ body?: never;
3712
+ path: {
3713
+ /**
3714
+ * Import Id
3715
+ */
3716
+ import_id: string;
3717
+ };
3718
+ query?: never;
3719
+ url: '/api/imports/{import_id}';
3720
+ };
3721
+ export type GetImportErrors = {
3722
+ /**
3723
+ * Validation Error
3724
+ */
3725
+ 422: HttpValidationError;
3726
+ };
3727
+ export type GetImportError = GetImportErrors[keyof GetImportErrors];
3728
+ export type GetImportResponses = {
3729
+ /**
3730
+ * Successful Response
3731
+ */
3732
+ 200: ImportOut;
3733
+ };
3734
+ export type GetImportResponse = GetImportResponses[keyof GetImportResponses];
3735
+ export type ListDuplicatesEverywhereData = {
3736
+ body?: never;
3737
+ path?: never;
3738
+ query?: never;
3739
+ url: '/api/duplicates';
3740
+ };
3741
+ export type ListDuplicatesEverywhereResponses = {
3742
+ /**
3743
+ * Response List Duplicates Everywhere
3744
+ *
3745
+ * Successful Response
3746
+ */
3747
+ 200: Array<DuplicateOut>;
3748
+ };
3749
+ export type ListDuplicatesEverywhereResponse = ListDuplicatesEverywhereResponses[keyof ListDuplicatesEverywhereResponses];
3750
+ export type MarkDifferentData = {
3751
+ body: Pair;
3752
+ path?: never;
3753
+ query?: never;
3754
+ url: '/api/duplicates/different';
3755
+ };
3756
+ export type MarkDifferentErrors = {
3757
+ /**
3758
+ * Validation Error
3759
+ */
3760
+ 422: HttpValidationError;
3761
+ };
3762
+ export type MarkDifferentError = MarkDifferentErrors[keyof MarkDifferentErrors];
3763
+ export type MarkDifferentResponses = {
3764
+ /**
3765
+ * Successful Response
3766
+ */
3767
+ 204: void;
3768
+ };
3769
+ export type MarkDifferentResponse = MarkDifferentResponses[keyof MarkDifferentResponses];
3770
+ export type EmptyTrashData = {
3771
+ body?: never;
3772
+ path?: never;
3773
+ query?: never;
3774
+ url: '/api/trash';
3775
+ };
3776
+ export type EmptyTrashResponses = {
3777
+ /**
3778
+ * Successful Response
3779
+ */
3780
+ 200: Emptied;
3781
+ };
3782
+ export type EmptyTrashResponse = EmptyTrashResponses[keyof EmptyTrashResponses];
3783
+ export type StorageData = {
3784
+ body?: never;
3785
+ path?: never;
3786
+ query?: never;
3787
+ url: '/api/storage';
3788
+ };
3789
+ export type StorageResponses = {
3790
+ /**
3791
+ * Successful Response
3792
+ */
3793
+ 200: Storage;
3794
+ };
3795
+ export type StorageResponse = StorageResponses[keyof StorageResponses];
3796
+ export type GetConfigData = {
3797
+ body?: never;
3798
+ path?: never;
3799
+ query?: never;
3800
+ url: '/api/admin/config';
3801
+ };
3802
+ export type GetConfigResponses = {
3803
+ /**
3804
+ * Successful Response
3805
+ */
3806
+ 200: SystemConfig;
3807
+ };
3808
+ export type GetConfigResponse = GetConfigResponses[keyof GetConfigResponses];
3809
+ export type SetConfigData = {
3810
+ body: SystemConfig;
3811
+ path?: never;
3812
+ query?: never;
3813
+ url: '/api/admin/config';
3814
+ };
3815
+ export type SetConfigErrors = {
3816
+ /**
3817
+ * Validation Error
3818
+ */
3819
+ 422: HttpValidationError;
3820
+ };
3821
+ export type SetConfigError = SetConfigErrors[keyof SetConfigErrors];
3822
+ export type SetConfigResponses = {
3823
+ /**
3824
+ * Successful Response
3825
+ */
3826
+ 200: SystemConfig;
3827
+ };
3828
+ export type SetConfigResponse = SetConfigResponses[keyof SetConfigResponses];
3829
+ export type MlStatusData = {
3830
+ body?: never;
3831
+ path?: never;
3832
+ query?: never;
3833
+ url: '/api/admin/ml';
3834
+ };
3835
+ export type MlStatusResponses = {
3836
+ /**
3837
+ * Successful Response
3838
+ */
3839
+ 200: MlStatus;
3840
+ };
3841
+ export type MlStatusResponse = MlStatusResponses[keyof MlStatusResponses];
3842
+ export type MeasureMlSpeedData = {
3843
+ body?: never;
3844
+ path: {
3845
+ /**
3846
+ * Name
3847
+ */
3848
+ name: string;
3849
+ };
3850
+ query?: never;
3851
+ url: '/api/admin/ml/models/{name}/speed';
3852
+ };
3853
+ export type MeasureMlSpeedErrors = {
3854
+ /**
3855
+ * Validation Error
3856
+ */
3857
+ 422: HttpValidationError;
3858
+ };
3859
+ export type MeasureMlSpeedError = MeasureMlSpeedErrors[keyof MeasureMlSpeedErrors];
3860
+ export type MeasureMlSpeedResponses = {
3861
+ /**
3862
+ * Successful Response
3863
+ */
3864
+ 200: MlSpeed;
3865
+ };
3866
+ export type MeasureMlSpeedResponse = MeasureMlSpeedResponses[keyof MeasureMlSpeedResponses];
3867
+ export type DeleteMlModelData = {
3868
+ body?: never;
3869
+ path: {
3870
+ /**
3871
+ * Name
3872
+ */
3873
+ name: string;
3874
+ };
3875
+ query?: never;
3876
+ url: '/api/admin/ml/models/{name}';
3877
+ };
3878
+ export type DeleteMlModelErrors = {
3879
+ /**
3880
+ * Validation Error
3881
+ */
3882
+ 422: HttpValidationError;
3883
+ };
3884
+ export type DeleteMlModelError = DeleteMlModelErrors[keyof DeleteMlModelErrors];
3885
+ export type DeleteMlModelResponses = {
3886
+ /**
3887
+ * Successful Response
3888
+ */
3889
+ 204: void;
3890
+ };
3891
+ export type DeleteMlModelResponse = DeleteMlModelResponses[keyof DeleteMlModelResponses];
3892
+ export type StatsData = {
3893
+ body?: never;
3894
+ path?: never;
3895
+ query?: never;
3896
+ url: '/api/admin/stats';
3897
+ };
3898
+ export type StatsResponses = {
3899
+ /**
3900
+ * Successful Response
3901
+ */
3902
+ 200: Stats;
3903
+ };
3904
+ export type StatsResponse = StatsResponses[keyof StatsResponses];
3905
+ export type RunJobData = {
3906
+ body?: never;
3907
+ path: {
3908
+ /**
3909
+ * Job
3910
+ */
3911
+ job: string;
3912
+ };
3913
+ query?: never;
3914
+ url: '/api/admin/jobs/{job}';
3915
+ };
3916
+ export type RunJobErrors = {
3917
+ /**
3918
+ * Validation Error
3919
+ */
3920
+ 422: HttpValidationError;
3921
+ };
3922
+ export type RunJobError = RunJobErrors[keyof RunJobErrors];
3923
+ export type RunJobResponses = {
3924
+ /**
3925
+ * Response Run Job
3926
+ *
3927
+ * Successful Response
3928
+ */
3929
+ 202: {
3930
+ [key: string]: unknown;
3931
+ };
3932
+ };
3933
+ export type RunJobResponse = RunJobResponses[keyof RunJobResponses];
3934
+ export type IntegrityReportData = {
3935
+ body?: never;
3936
+ path?: never;
3937
+ query?: never;
3938
+ url: '/api/admin/integrity';
3939
+ };
3940
+ export type IntegrityReportResponses = {
3941
+ /**
3942
+ * Response Integrity Report
3943
+ *
3944
+ * Successful Response
3945
+ */
3946
+ 200: Report | null;
3947
+ };
3948
+ export type IntegrityReportResponse = IntegrityReportResponses[keyof IntegrityReportResponses];
3949
+ export type AuthenticationData = {
3950
+ body?: never;
3951
+ path?: never;
3952
+ query?: never;
3953
+ url: '/api/admin/authentication';
3954
+ };
3955
+ export type AuthenticationResponses = {
3956
+ /**
3957
+ * Successful Response
3958
+ */
3959
+ 200: Authentication;
3960
+ };
3961
+ export type AuthenticationResponse = AuthenticationResponses[keyof AuthenticationResponses];
3962
+ export type SetOidcSecretData = {
3963
+ body: Secret;
3964
+ path?: never;
3965
+ query?: never;
3966
+ url: '/api/admin/authentication/secret';
3967
+ };
3968
+ export type SetOidcSecretErrors = {
3969
+ /**
3970
+ * Validation Error
3971
+ */
3972
+ 422: HttpValidationError;
3973
+ };
3974
+ export type SetOidcSecretError = SetOidcSecretErrors[keyof SetOidcSecretErrors];
3975
+ export type SetOidcSecretResponses = {
3976
+ /**
3977
+ * Successful Response
3978
+ */
3979
+ 204: void;
3980
+ };
3981
+ export type SetOidcSecretResponse = SetOidcSecretResponses[keyof SetOidcSecretResponses];
3982
+ export type CheckProviderData = {
3983
+ body: ProviderCheck;
3984
+ path?: never;
3985
+ query?: never;
3986
+ url: '/api/admin/authentication/check';
3987
+ };
3988
+ export type CheckProviderErrors = {
3989
+ /**
3990
+ * Validation Error
3991
+ */
3992
+ 422: HttpValidationError;
3993
+ };
3994
+ export type CheckProviderError = CheckProviderErrors[keyof CheckProviderErrors];
3995
+ export type CheckProviderResponses = {
3996
+ /**
3997
+ * Successful Response
3998
+ */
3999
+ 200: ProviderFound;
4000
+ };
4001
+ export type CheckProviderResponse = CheckProviderResponses[keyof CheckProviderResponses];
4002
+ export type EndAllSessionsData = {
4003
+ body?: never;
4004
+ path?: never;
4005
+ query?: never;
4006
+ url: '/api/admin/sessions';
4007
+ };
4008
+ export type EndAllSessionsResponses = {
4009
+ /**
4010
+ * Response End All Sessions
4011
+ *
4012
+ * Successful Response
4013
+ */
4014
+ 200: {
4015
+ [key: string]: number;
4016
+ };
4017
+ };
4018
+ export type EndAllSessionsResponse = EndAllSessionsResponses[keyof EndAllSessionsResponses];
4019
+ export type ReadableCopyData = {
4020
+ body?: never;
4021
+ path?: never;
4022
+ query?: never;
4023
+ url: '/api/admin/readable-copy';
4024
+ };
4025
+ export type ReadableCopyResponses = {
4026
+ /**
4027
+ * Successful Response
4028
+ */
4029
+ 200: ReadableCopy;
4030
+ };
4031
+ export type ReadableCopyResponse = ReadableCopyResponses[keyof ReadableCopyResponses];
4032
+ export type PreviewTemplateData = {
4033
+ body: TemplateIn;
4034
+ path?: never;
4035
+ query?: never;
4036
+ url: '/api/admin/readable-copy/preview';
4037
+ };
4038
+ export type PreviewTemplateErrors = {
4039
+ /**
4040
+ * Validation Error
4041
+ */
4042
+ 422: HttpValidationError;
4043
+ };
4044
+ export type PreviewTemplateError = PreviewTemplateErrors[keyof PreviewTemplateErrors];
4045
+ export type PreviewTemplateResponses = {
4046
+ /**
4047
+ * Successful Response
4048
+ */
4049
+ 200: TemplatePreview;
4050
+ };
4051
+ export type PreviewTemplateResponse = PreviewTemplateResponses[keyof PreviewTemplateResponses];
4052
+ export type ListTagsData = {
4053
+ body?: never;
4054
+ path?: never;
4055
+ query?: never;
4056
+ url: '/api/tags';
4057
+ };
4058
+ export type ListTagsResponses = {
4059
+ /**
4060
+ * Response List Tags
4061
+ *
4062
+ * Successful Response
4063
+ */
4064
+ 200: Array<TagOut>;
4065
+ };
4066
+ export type ListTagsResponse = ListTagsResponses[keyof ListTagsResponses];
4067
+ export type CreateTagData = {
4068
+ body: TagNew;
4069
+ path?: never;
4070
+ query?: never;
4071
+ url: '/api/tags';
4072
+ };
4073
+ export type CreateTagErrors = {
4074
+ /**
4075
+ * Validation Error
4076
+ */
4077
+ 422: HttpValidationError;
4078
+ };
4079
+ export type CreateTagError = CreateTagErrors[keyof CreateTagErrors];
4080
+ export type CreateTagResponses = {
4081
+ /**
4082
+ * Successful Response
4083
+ */
4084
+ 201: TagOut;
4085
+ };
4086
+ export type CreateTagResponse = CreateTagResponses[keyof CreateTagResponses];
4087
+ export type AddTagData = {
4088
+ body: TagIn;
4089
+ path: {
4090
+ /**
4091
+ * Item Id
4092
+ */
4093
+ item_id: string;
4094
+ };
4095
+ query?: never;
4096
+ url: '/api/items/{item_id}/tags';
4097
+ };
4098
+ export type AddTagErrors = {
4099
+ /**
4100
+ * Validation Error
4101
+ */
4102
+ 422: HttpValidationError;
4103
+ };
4104
+ export type AddTagError = AddTagErrors[keyof AddTagErrors];
4105
+ export type AddTagResponses = {
4106
+ /**
4107
+ * Response Add Tag
4108
+ *
4109
+ * Successful Response
4110
+ */
4111
+ 201: Array<ItemTagOut>;
4112
+ };
4113
+ export type AddTagResponse = AddTagResponses[keyof AddTagResponses];
4114
+ export type RemoveTagData = {
4115
+ body?: never;
4116
+ path: {
4117
+ /**
4118
+ * Item Id
4119
+ */
4120
+ item_id: string;
4121
+ /**
4122
+ * Tag Id
4123
+ */
4124
+ tag_id: string;
4125
+ };
4126
+ query?: never;
4127
+ url: '/api/items/{item_id}/tags/{tag_id}';
4128
+ };
4129
+ export type RemoveTagErrors = {
4130
+ /**
4131
+ * Validation Error
4132
+ */
4133
+ 422: HttpValidationError;
4134
+ };
4135
+ export type RemoveTagError = RemoveTagErrors[keyof RemoveTagErrors];
4136
+ export type RemoveTagResponses = {
4137
+ /**
4138
+ * Response Remove Tag
4139
+ *
4140
+ * Successful Response
4141
+ */
4142
+ 200: Array<ItemTagOut>;
4143
+ };
4144
+ export type RemoveTagResponse = RemoveTagResponses[keyof RemoveTagResponses];
4145
+ export type DeleteTagData = {
4146
+ body?: never;
4147
+ path: {
4148
+ /**
4149
+ * Tag Id
4150
+ */
4151
+ tag_id: string;
4152
+ };
4153
+ query?: never;
4154
+ url: '/api/tags/{tag_id}';
4155
+ };
4156
+ export type DeleteTagErrors = {
4157
+ /**
4158
+ * Validation Error
4159
+ */
4160
+ 422: HttpValidationError;
4161
+ };
4162
+ export type DeleteTagError = DeleteTagErrors[keyof DeleteTagErrors];
4163
+ export type DeleteTagResponses = {
4164
+ /**
4165
+ * Successful Response
4166
+ */
4167
+ 204: void;
4168
+ };
4169
+ export type DeleteTagResponse = DeleteTagResponses[keyof DeleteTagResponses];
4170
+ export type ChangeTagData = {
4171
+ body: TagChange;
4172
+ path: {
4173
+ /**
4174
+ * Tag Id
4175
+ */
4176
+ tag_id: string;
4177
+ };
4178
+ query?: never;
4179
+ url: '/api/tags/{tag_id}';
4180
+ };
4181
+ export type ChangeTagErrors = {
4182
+ /**
4183
+ * Validation Error
4184
+ */
4185
+ 422: HttpValidationError;
4186
+ };
4187
+ export type ChangeTagError = ChangeTagErrors[keyof ChangeTagErrors];
4188
+ export type ChangeTagResponses = {
4189
+ /**
4190
+ * Successful Response
4191
+ */
4192
+ 200: TagOut;
4193
+ };
4194
+ export type ChangeTagResponse = ChangeTagResponses[keyof ChangeTagResponses];
4195
+ export type ListCollectionsData = {
4196
+ body?: never;
4197
+ path?: never;
4198
+ query?: never;
4199
+ url: '/api/collections';
4200
+ };
4201
+ export type ListCollectionsResponses = {
4202
+ /**
4203
+ * Response List Collections
4204
+ *
4205
+ * Successful Response
4206
+ */
4207
+ 200: Array<CollectionOut>;
4208
+ };
4209
+ export type ListCollectionsResponse = ListCollectionsResponses[keyof ListCollectionsResponses];
4210
+ export type CreateCollectionData = {
4211
+ body: CollectionIn;
4212
+ path?: never;
4213
+ query?: never;
4214
+ url: '/api/collections';
4215
+ };
4216
+ export type CreateCollectionErrors = {
4217
+ /**
4218
+ * Validation Error
4219
+ */
4220
+ 422: HttpValidationError;
4221
+ };
4222
+ export type CreateCollectionError = CreateCollectionErrors[keyof CreateCollectionErrors];
4223
+ export type CreateCollectionResponses = {
4224
+ /**
4225
+ * Successful Response
4226
+ */
4227
+ 201: CollectionOut;
4228
+ };
4229
+ export type CreateCollectionResponse = CreateCollectionResponses[keyof CreateCollectionResponses];
4230
+ export type DeleteCollectionData = {
4231
+ body?: never;
4232
+ path: {
4233
+ /**
4234
+ * Collection Id
4235
+ */
4236
+ collection_id: string;
4237
+ };
4238
+ query?: never;
4239
+ url: '/api/collections/{collection_id}';
4240
+ };
4241
+ export type DeleteCollectionErrors = {
4242
+ /**
4243
+ * Validation Error
4244
+ */
4245
+ 422: HttpValidationError;
4246
+ };
4247
+ export type DeleteCollectionError = DeleteCollectionErrors[keyof DeleteCollectionErrors];
4248
+ export type DeleteCollectionResponses = {
4249
+ /**
4250
+ * Successful Response
4251
+ */
4252
+ 204: void;
4253
+ };
4254
+ export type DeleteCollectionResponse = DeleteCollectionResponses[keyof DeleteCollectionResponses];
4255
+ export type ChangeCollectionData = {
4256
+ body: CollectionChange;
4257
+ path: {
4258
+ /**
4259
+ * Collection Id
4260
+ */
4261
+ collection_id: string;
4262
+ };
4263
+ query?: never;
4264
+ url: '/api/collections/{collection_id}';
4265
+ };
4266
+ export type ChangeCollectionErrors = {
4267
+ /**
4268
+ * Validation Error
4269
+ */
4270
+ 422: HttpValidationError;
4271
+ };
4272
+ export type ChangeCollectionError = ChangeCollectionErrors[keyof ChangeCollectionErrors];
4273
+ export type ChangeCollectionResponses = {
4274
+ /**
4275
+ * Successful Response
4276
+ */
4277
+ 200: CollectionChanged;
4278
+ };
4279
+ export type ChangeCollectionResponse = ChangeCollectionResponses[keyof ChangeCollectionResponses];
4280
+ export type PreviewMoveData = {
4281
+ body?: never;
4282
+ path: {
4283
+ /**
4284
+ * Collection Id
4285
+ */
4286
+ collection_id: string;
4287
+ };
4288
+ query: {
4289
+ /**
4290
+ * Library
4291
+ */
4292
+ library: string;
4293
+ };
4294
+ url: '/api/collections/{collection_id}/move-preview';
4295
+ };
4296
+ export type PreviewMoveErrors = {
4297
+ /**
4298
+ * Validation Error
4299
+ */
4300
+ 422: HttpValidationError;
4301
+ };
4302
+ export type PreviewMoveError = PreviewMoveErrors[keyof PreviewMoveErrors];
4303
+ export type PreviewMoveResponses = {
4304
+ /**
4305
+ * Successful Response
4306
+ */
4307
+ 200: MovePreview;
4308
+ };
4309
+ export type PreviewMoveResponse = PreviewMoveResponses[keyof PreviewMoveResponses];
4310
+ export type UnpinCollectionData = {
4311
+ body?: never;
4312
+ path: {
4313
+ /**
4314
+ * Collection Id
4315
+ */
4316
+ collection_id: string;
4317
+ };
4318
+ query?: never;
4319
+ url: '/api/collections/{collection_id}/pin';
4320
+ };
4321
+ export type UnpinCollectionErrors = {
4322
+ /**
4323
+ * Validation Error
4324
+ */
4325
+ 422: HttpValidationError;
4326
+ };
4327
+ export type UnpinCollectionError = UnpinCollectionErrors[keyof UnpinCollectionErrors];
4328
+ export type UnpinCollectionResponses = {
4329
+ /**
4330
+ * Successful Response
4331
+ */
4332
+ 204: void;
4333
+ };
4334
+ export type UnpinCollectionResponse = UnpinCollectionResponses[keyof UnpinCollectionResponses];
4335
+ export type PinCollectionData = {
4336
+ body?: never;
4337
+ path: {
4338
+ /**
4339
+ * Collection Id
4340
+ */
4341
+ collection_id: string;
4342
+ };
4343
+ query?: never;
4344
+ url: '/api/collections/{collection_id}/pin';
4345
+ };
4346
+ export type PinCollectionErrors = {
4347
+ /**
4348
+ * Validation Error
4349
+ */
4350
+ 422: HttpValidationError;
4351
+ };
4352
+ export type PinCollectionError = PinCollectionErrors[keyof PinCollectionErrors];
4353
+ export type PinCollectionResponses = {
4354
+ /**
4355
+ * Successful Response
4356
+ */
4357
+ 204: void;
4358
+ };
4359
+ export type PinCollectionResponse = PinCollectionResponses[keyof PinCollectionResponses];
4360
+ export type AddItemsData = {
4361
+ body: ItemIds;
4362
+ path: {
4363
+ /**
4364
+ * Collection Id
4365
+ */
4366
+ collection_id: string;
4367
+ };
4368
+ query?: never;
4369
+ url: '/api/collections/{collection_id}/items';
4370
+ };
4371
+ export type AddItemsErrors = {
4372
+ /**
4373
+ * Validation Error
4374
+ */
4375
+ 422: HttpValidationError;
4376
+ };
4377
+ export type AddItemsError = AddItemsErrors[keyof AddItemsErrors];
4378
+ export type AddItemsResponses = {
4379
+ /**
4380
+ * Successful Response
4381
+ */
4382
+ 200: CollectionOut;
4383
+ };
4384
+ export type AddItemsResponse = AddItemsResponses[keyof AddItemsResponses];
4385
+ export type RemoveItemData = {
4386
+ body?: never;
4387
+ path: {
4388
+ /**
4389
+ * Collection Id
4390
+ */
4391
+ collection_id: string;
4392
+ /**
4393
+ * Item Id
4394
+ */
4395
+ item_id: string;
4396
+ };
4397
+ query?: never;
4398
+ url: '/api/collections/{collection_id}/items/{item_id}';
4399
+ };
4400
+ export type RemoveItemErrors = {
4401
+ /**
4402
+ * Validation Error
4403
+ */
4404
+ 422: HttpValidationError;
4405
+ };
4406
+ export type RemoveItemError = RemoveItemErrors[keyof RemoveItemErrors];
4407
+ export type RemoveItemResponses = {
4408
+ /**
4409
+ * Successful Response
4410
+ */
4411
+ 200: CollectionOut;
4412
+ };
4413
+ export type RemoveItemResponse = RemoveItemResponses[keyof RemoveItemResponses];
4414
+ export type ListLibrariesData = {
4415
+ body?: never;
4416
+ path?: never;
4417
+ query?: never;
4418
+ url: '/api/libraries';
4419
+ };
4420
+ export type ListLibrariesResponses = {
4421
+ /**
4422
+ * Response List Libraries
4423
+ *
4424
+ * Successful Response
4425
+ */
4426
+ 200: Array<LibraryOut>;
4427
+ };
4428
+ export type ListLibrariesResponse = ListLibrariesResponses[keyof ListLibrariesResponses];
4429
+ export type SetDefaultLibraryData = {
4430
+ body: DefaultLibrary;
4431
+ path?: never;
4432
+ query?: never;
4433
+ url: '/api/me/default-library';
4434
+ };
4435
+ export type SetDefaultLibraryErrors = {
4436
+ /**
4437
+ * Validation Error
4438
+ */
4439
+ 422: HttpValidationError;
4440
+ };
4441
+ export type SetDefaultLibraryError = SetDefaultLibraryErrors[keyof SetDefaultLibraryErrors];
4442
+ export type SetDefaultLibraryResponses = {
4443
+ /**
4444
+ * Successful Response
4445
+ */
4446
+ 204: void;
4447
+ };
4448
+ export type SetDefaultLibraryResponse = SetDefaultLibraryResponses[keyof SetDefaultLibraryResponses];
4449
+ export type ListGroupsData = {
4450
+ body?: never;
4451
+ path?: never;
4452
+ query?: never;
4453
+ url: '/api/groups';
4454
+ };
4455
+ export type ListGroupsResponses = {
4456
+ /**
4457
+ * Response List Groups
4458
+ *
4459
+ * Successful Response
4460
+ */
4461
+ 200: Array<GroupOut>;
4462
+ };
4463
+ export type ListGroupsResponse = ListGroupsResponses[keyof ListGroupsResponses];
4464
+ export type CreateGroupData = {
4465
+ body: GroupIn;
4466
+ path?: never;
4467
+ query?: never;
4468
+ url: '/api/groups';
4469
+ };
4470
+ export type CreateGroupErrors = {
4471
+ /**
4472
+ * Validation Error
4473
+ */
4474
+ 422: HttpValidationError;
4475
+ };
4476
+ export type CreateGroupError = CreateGroupErrors[keyof CreateGroupErrors];
4477
+ export type CreateGroupResponses = {
4478
+ /**
4479
+ * Successful Response
4480
+ */
4481
+ 201: GroupOut;
4482
+ };
4483
+ export type CreateGroupResponse = CreateGroupResponses[keyof CreateGroupResponses];
4484
+ export type DeleteGroupData = {
4485
+ body?: never;
4486
+ path: {
4487
+ /**
4488
+ * Group Id
4489
+ */
4490
+ group_id: string;
4491
+ };
4492
+ query?: never;
4493
+ url: '/api/groups/{group_id}';
4494
+ };
4495
+ export type DeleteGroupErrors = {
4496
+ /**
4497
+ * Validation Error
4498
+ */
4499
+ 422: HttpValidationError;
4500
+ };
4501
+ export type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors];
4502
+ export type DeleteGroupResponses = {
4503
+ /**
4504
+ * Successful Response
4505
+ */
4506
+ 204: void;
4507
+ };
4508
+ export type DeleteGroupResponse = DeleteGroupResponses[keyof DeleteGroupResponses];
4509
+ export type ChangeGroupData = {
4510
+ body: GroupChange;
4511
+ path: {
4512
+ /**
4513
+ * Group Id
4514
+ */
4515
+ group_id: string;
4516
+ };
4517
+ query?: never;
4518
+ url: '/api/groups/{group_id}';
4519
+ };
4520
+ export type ChangeGroupErrors = {
4521
+ /**
4522
+ * Validation Error
4523
+ */
4524
+ 422: HttpValidationError;
4525
+ };
4526
+ export type ChangeGroupError = ChangeGroupErrors[keyof ChangeGroupErrors];
4527
+ export type ChangeGroupResponses = {
4528
+ /**
4529
+ * Successful Response
4530
+ */
4531
+ 200: GroupOut;
4532
+ };
4533
+ export type ChangeGroupResponse = ChangeGroupResponses[keyof ChangeGroupResponses];
4534
+ export type ListMembersData = {
4535
+ body?: never;
4536
+ path: {
4537
+ /**
4538
+ * Group Id
4539
+ */
4540
+ group_id: string;
4541
+ };
4542
+ query?: never;
4543
+ url: '/api/groups/{group_id}/members';
4544
+ };
4545
+ export type ListMembersErrors = {
4546
+ /**
4547
+ * Validation Error
4548
+ */
4549
+ 422: HttpValidationError;
4550
+ };
4551
+ export type ListMembersError = ListMembersErrors[keyof ListMembersErrors];
4552
+ export type ListMembersResponses = {
4553
+ /**
4554
+ * Response List Members
4555
+ *
4556
+ * Successful Response
4557
+ */
4558
+ 200: Array<MemberOut>;
4559
+ };
4560
+ export type ListMembersResponse = ListMembersResponses[keyof ListMembersResponses];
4561
+ export type RemoveMemberData = {
4562
+ body?: never;
4563
+ path: {
4564
+ /**
4565
+ * Group Id
4566
+ */
4567
+ group_id: string;
4568
+ /**
4569
+ * User Id
4570
+ */
4571
+ user_id: string;
4572
+ };
4573
+ query?: never;
4574
+ url: '/api/groups/{group_id}/members/{user_id}';
4575
+ };
4576
+ export type RemoveMemberErrors = {
4577
+ /**
4578
+ * Validation Error
4579
+ */
4580
+ 422: HttpValidationError;
4581
+ };
4582
+ export type RemoveMemberError = RemoveMemberErrors[keyof RemoveMemberErrors];
4583
+ export type RemoveMemberResponses = {
4584
+ /**
4585
+ * Response Remove Member
4586
+ *
4587
+ * Successful Response
4588
+ */
4589
+ 200: Array<MemberOut>;
4590
+ };
4591
+ export type RemoveMemberResponse = RemoveMemberResponses[keyof RemoveMemberResponses];
4592
+ export type SetMemberData = {
4593
+ body: MemberIn;
4594
+ path: {
4595
+ /**
4596
+ * Group Id
4597
+ */
4598
+ group_id: string;
4599
+ /**
4600
+ * User Id
4601
+ */
4602
+ user_id: string;
4603
+ };
4604
+ query?: never;
4605
+ url: '/api/groups/{group_id}/members/{user_id}';
4606
+ };
4607
+ export type SetMemberErrors = {
4608
+ /**
4609
+ * Validation Error
4610
+ */
4611
+ 422: HttpValidationError;
4612
+ };
4613
+ export type SetMemberError = SetMemberErrors[keyof SetMemberErrors];
4614
+ export type SetMemberResponses = {
4615
+ /**
4616
+ * Response Set Member
4617
+ *
4618
+ * Successful Response
4619
+ */
4620
+ 200: Array<MemberOut>;
4621
+ };
4622
+ export type SetMemberResponse = SetMemberResponses[keyof SetMemberResponses];
4623
+ export type LeaveGroupData = {
4624
+ body?: never;
4625
+ path: {
4626
+ /**
4627
+ * Group Id
4628
+ */
4629
+ group_id: string;
4630
+ };
4631
+ query?: never;
4632
+ url: '/api/groups/{group_id}/leave';
4633
+ };
4634
+ export type LeaveGroupErrors = {
4635
+ /**
4636
+ * Validation Error
4637
+ */
4638
+ 422: HttpValidationError;
4639
+ };
4640
+ export type LeaveGroupError = LeaveGroupErrors[keyof LeaveGroupErrors];
4641
+ export type LeaveGroupResponses = {
4642
+ /**
4643
+ * Successful Response
4644
+ */
4645
+ 204: void;
4646
+ };
4647
+ export type LeaveGroupResponse = LeaveGroupResponses[keyof LeaveGroupResponses];
4648
+ export type FindUsersData = {
4649
+ body?: never;
4650
+ path?: never;
4651
+ query?: {
4652
+ /**
4653
+ * Q
4654
+ */
4655
+ q?: string;
4656
+ };
4657
+ url: '/api/users';
4658
+ };
4659
+ export type FindUsersErrors = {
4660
+ /**
4661
+ * Validation Error
4662
+ */
4663
+ 422: HttpValidationError;
4664
+ };
4665
+ export type FindUsersError = FindUsersErrors[keyof FindUsersErrors];
4666
+ export type FindUsersResponses = {
4667
+ /**
4668
+ * Response Find Users
4669
+ *
4670
+ * Successful Response
4671
+ */
4672
+ 200: Array<UserBrief>;
4673
+ };
4674
+ export type FindUsersResponse = FindUsersResponses[keyof FindUsersResponses];
4675
+ export type ListUsersData = {
4676
+ body?: never;
4677
+ path?: never;
4678
+ query?: never;
4679
+ url: '/api/admin/users';
4680
+ };
4681
+ export type ListUsersResponses = {
4682
+ /**
4683
+ * Response List Users
4684
+ *
4685
+ * Successful Response
4686
+ */
4687
+ 200: Array<UserRow>;
4688
+ };
4689
+ export type ListUsersResponse = ListUsersResponses[keyof ListUsersResponses];
4690
+ export type CreateUserData = {
4691
+ body: NewUser;
4692
+ path?: never;
4693
+ query?: never;
4694
+ url: '/api/admin/users';
4695
+ };
4696
+ export type CreateUserErrors = {
4697
+ /**
4698
+ * Validation Error
4699
+ */
4700
+ 422: HttpValidationError;
4701
+ };
4702
+ export type CreateUserError = CreateUserErrors[keyof CreateUserErrors];
4703
+ export type CreateUserResponses = {
4704
+ /**
4705
+ * Successful Response
4706
+ */
4707
+ 201: UserRow;
4708
+ };
4709
+ export type CreateUserResponse = CreateUserResponses[keyof CreateUserResponses];
4710
+ export type ChangeUserData = {
4711
+ body: UserChange;
4712
+ path: {
4713
+ /**
4714
+ * User Id
4715
+ */
4716
+ user_id: string;
4717
+ };
4718
+ query?: never;
4719
+ url: '/api/admin/users/{user_id}';
4720
+ };
4721
+ export type ChangeUserErrors = {
4722
+ /**
4723
+ * Validation Error
4724
+ */
4725
+ 422: HttpValidationError;
4726
+ };
4727
+ export type ChangeUserError = ChangeUserErrors[keyof ChangeUserErrors];
4728
+ export type ChangeUserResponses = {
4729
+ /**
4730
+ * Successful Response
4731
+ */
4732
+ 200: UserRow;
4733
+ };
4734
+ export type ChangeUserResponse = ChangeUserResponses[keyof ChangeUserResponses];
4735
+ export type PrivateThingsData = {
4736
+ body?: never;
4737
+ path: {
4738
+ /**
4739
+ * User Id
4740
+ */
4741
+ user_id: string;
4742
+ };
4743
+ query?: never;
4744
+ url: '/api/admin/users/{user_id}/private';
4745
+ };
4746
+ export type PrivateThingsErrors = {
4747
+ /**
4748
+ * Validation Error
4749
+ */
4750
+ 422: HttpValidationError;
4751
+ };
4752
+ export type PrivateThingsError = PrivateThingsErrors[keyof PrivateThingsErrors];
4753
+ export type PrivateThingsResponses = {
4754
+ /**
4755
+ * Successful Response
4756
+ */
4757
+ 200: Private;
4758
+ };
4759
+ export type PrivateThingsResponse = PrivateThingsResponses[keyof PrivateThingsResponses];
4760
+ export type HandOverData = {
4761
+ body: HandOver;
4762
+ path: {
4763
+ /**
4764
+ * User Id
4765
+ */
4766
+ user_id: string;
4767
+ };
4768
+ query?: never;
4769
+ url: '/api/admin/users/{user_id}/hand-over';
4770
+ };
4771
+ export type HandOverErrors = {
4772
+ /**
4773
+ * Validation Error
4774
+ */
4775
+ 422: HttpValidationError;
4776
+ };
4777
+ export type HandOverError = HandOverErrors[keyof HandOverErrors];
4778
+ export type HandOverResponses = {
4779
+ /**
4780
+ * Successful Response
4781
+ */
4782
+ 200: Private;
4783
+ };
4784
+ export type HandOverResponse = HandOverResponses[keyof HandOverResponses];
4785
+ export type ListBackupsData = {
4786
+ body?: never;
4787
+ path?: never;
4788
+ query?: never;
4789
+ url: '/api/admin/backups';
4790
+ };
4791
+ export type ListBackupsResponses = {
4792
+ /**
4793
+ * Successful Response
4794
+ */
4795
+ 200: Backups;
4796
+ };
4797
+ export type ListBackupsResponse = ListBackupsResponses[keyof ListBackupsResponses];
4798
+ export type StartBackupData = {
4799
+ body: BackupRequest;
4800
+ path?: never;
4801
+ query?: never;
4802
+ url: '/api/admin/backups';
4803
+ };
4804
+ export type StartBackupErrors = {
4805
+ /**
4806
+ * Validation Error
4807
+ */
4808
+ 422: HttpValidationError;
4809
+ };
4810
+ export type StartBackupError = StartBackupErrors[keyof StartBackupErrors];
4811
+ export type StartBackupResponses = {
4812
+ /**
4813
+ * Successful Response
4814
+ */
4815
+ 202: unknown;
4816
+ };
4817
+ export type SetBackupConfigData = {
4818
+ body: BackupConfig;
4819
+ path?: never;
4820
+ query?: never;
4821
+ url: '/api/admin/backups/config';
4822
+ };
4823
+ export type SetBackupConfigErrors = {
4824
+ /**
4825
+ * Validation Error
4826
+ */
4827
+ 422: HttpValidationError;
4828
+ };
4829
+ export type SetBackupConfigError = SetBackupConfigErrors[keyof SetBackupConfigErrors];
4830
+ export type SetBackupConfigResponses = {
4831
+ /**
4832
+ * Successful Response
4833
+ */
4834
+ 200: BackupConfig;
4835
+ };
4836
+ export type SetBackupConfigResponse = SetBackupConfigResponses[keyof SetBackupConfigResponses];
4837
+ export type DeleteBackupData = {
4838
+ body?: never;
4839
+ path: {
4840
+ /**
4841
+ * Name
4842
+ */
4843
+ name: string;
4844
+ };
4845
+ query?: never;
4846
+ url: '/api/admin/backups/{name}';
4847
+ };
4848
+ export type DeleteBackupErrors = {
4849
+ /**
4850
+ * Validation Error
4851
+ */
4852
+ 422: HttpValidationError;
4853
+ };
4854
+ export type DeleteBackupError = DeleteBackupErrors[keyof DeleteBackupErrors];
4855
+ export type DeleteBackupResponses = {
4856
+ /**
4857
+ * Successful Response
4858
+ */
4859
+ 204: void;
4860
+ };
4861
+ export type DeleteBackupResponse = DeleteBackupResponses[keyof DeleteBackupResponses];
4862
+ export type CheckRestoreData = {
4863
+ body?: never;
4864
+ path?: never;
4865
+ query: {
4866
+ /**
4867
+ * Name
4868
+ */
4869
+ name: string;
4870
+ };
4871
+ url: '/api/setup/restore-check';
4872
+ };
4873
+ export type CheckRestoreErrors = {
4874
+ /**
4875
+ * Validation Error
4876
+ */
4877
+ 422: HttpValidationError;
4878
+ };
4879
+ export type CheckRestoreError = CheckRestoreErrors[keyof CheckRestoreErrors];
4880
+ export type CheckRestoreResponses = {
4881
+ /**
4882
+ * Successful Response
4883
+ */
4884
+ 200: RestoreCheckOut;
4885
+ };
4886
+ export type CheckRestoreResponse = CheckRestoreResponses[keyof CheckRestoreResponses];
4887
+ export type SetupStateData = {
4888
+ body?: never;
4889
+ path?: never;
4890
+ query?: never;
4891
+ url: '/api/setup';
4892
+ };
4893
+ export type SetupStateResponses = {
4894
+ /**
4895
+ * Successful Response
4896
+ */
4897
+ 200: SetupState;
4898
+ };
4899
+ export type SetupStateResponse = SetupStateResponses[keyof SetupStateResponses];
4900
+ export type CreateFirstAdminData = {
4901
+ body: NewUser;
4902
+ path?: never;
4903
+ query?: never;
4904
+ url: '/api/setup/admin';
4905
+ };
4906
+ export type CreateFirstAdminErrors = {
4907
+ /**
4908
+ * Validation Error
4909
+ */
4910
+ 422: HttpValidationError;
4911
+ };
4912
+ export type CreateFirstAdminError = CreateFirstAdminErrors[keyof CreateFirstAdminErrors];
4913
+ export type CreateFirstAdminResponses = {
4914
+ /**
4915
+ * Successful Response
4916
+ */
4917
+ 201: LoginResponse;
4918
+ };
4919
+ export type CreateFirstAdminResponse = CreateFirstAdminResponses[keyof CreateFirstAdminResponses];
4920
+ export type RestoreOnFirstStartData = {
4921
+ body: RestoreRequest;
4922
+ path?: never;
4923
+ query?: never;
4924
+ url: '/api/setup/restore';
4925
+ };
4926
+ export type RestoreOnFirstStartErrors = {
4927
+ /**
4928
+ * Validation Error
4929
+ */
4930
+ 422: HttpValidationError;
4931
+ };
4932
+ export type RestoreOnFirstStartError = RestoreOnFirstStartErrors[keyof RestoreOnFirstStartErrors];
4933
+ export type RestoreOnFirstStartResponses = {
4934
+ /**
4935
+ * Successful Response
4936
+ */
4937
+ 204: void;
4938
+ };
4939
+ export type RestoreOnFirstStartResponse = RestoreOnFirstStartResponses[keyof RestoreOnFirstStartResponses];
4940
+ export type ListTokensData = {
4941
+ body?: never;
4942
+ path?: never;
4943
+ query?: never;
4944
+ url: '/api/me/tokens';
4945
+ };
4946
+ export type ListTokensResponses = {
4947
+ /**
4948
+ * Response List Tokens
4949
+ *
4950
+ * Successful Response
4951
+ */
4952
+ 200: Array<TokenOut>;
4953
+ };
4954
+ export type ListTokensResponse = ListTokensResponses[keyof ListTokensResponses];
4955
+ export type CreateTokenData = {
4956
+ body: NewToken;
4957
+ path?: never;
4958
+ query?: never;
4959
+ url: '/api/me/tokens';
4960
+ };
4961
+ export type CreateTokenErrors = {
4962
+ /**
4963
+ * Validation Error
4964
+ */
4965
+ 422: HttpValidationError;
4966
+ };
4967
+ export type CreateTokenError = CreateTokenErrors[keyof CreateTokenErrors];
4968
+ export type CreateTokenResponses = {
4969
+ /**
4970
+ * Successful Response
4971
+ */
4972
+ 201: CreatedToken;
4973
+ };
4974
+ export type CreateTokenResponse = CreateTokenResponses[keyof CreateTokenResponses];
4975
+ export type RevokeTokenData = {
4976
+ body?: never;
4977
+ path: {
4978
+ /**
4979
+ * Token Id
4980
+ */
4981
+ token_id: string;
4982
+ };
4983
+ query?: never;
4984
+ url: '/api/me/tokens/{token_id}';
4985
+ };
4986
+ export type RevokeTokenErrors = {
4987
+ /**
4988
+ * Validation Error
4989
+ */
4990
+ 422: HttpValidationError;
4991
+ };
4992
+ export type RevokeTokenError = RevokeTokenErrors[keyof RevokeTokenErrors];
4993
+ export type RevokeTokenResponses = {
4994
+ /**
4995
+ * Successful Response
4996
+ */
4997
+ 204: void;
4998
+ };
4999
+ export type RevokeTokenResponse = RevokeTokenResponses[keyof RevokeTokenResponses];