paperus 0.0.0-stage → 0.0.9

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