@magritte/api 0.0.0-stage → 0.1.0

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.
@@ -0,0 +1,4899 @@
1
+ import * as z from 'zod';
2
+
3
+ /**
4
+ * AlbumRead
5
+ */
6
+ export declare type AlbumRead = {
7
+ /**
8
+ * Id
9
+ */
10
+ id: number;
11
+ /**
12
+ * Title
13
+ */
14
+ title: string;
15
+ /**
16
+ * Artist Id
17
+ */
18
+ artist_id: number | null;
19
+ /**
20
+ * Artworks
21
+ *
22
+ * The artworks of this album
23
+ */
24
+ artworks?: Array<ArtworkRead>;
25
+ };
26
+
27
+ /**
28
+ * AlbumRead
29
+ */
30
+ export declare const AlbumReadSchema: z.ZodObject<{
31
+ id: z.ZodInt;
32
+ title: z.ZodString;
33
+ artist_id: z.ZodNullable<z.ZodInt>;
34
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
35
+ id: z.ZodInt;
36
+ kind: z.ZodEnum<{
37
+ front_cover: "front_cover";
38
+ }>;
39
+ image_url: z.ZodString;
40
+ background_color: z.ZodNullable<z.ZodString>;
41
+ primary_color: z.ZodNullable<z.ZodString>;
42
+ secondary_color: z.ZodNullable<z.ZodString>;
43
+ tertiary_color: z.ZodNullable<z.ZodString>;
44
+ }, z.core.$strip>>>;
45
+ }, z.core.$strip>;
46
+
47
+ /**
48
+ * AlbumUpdate
49
+ */
50
+ export declare type AlbumUpdate = {
51
+ /**
52
+ * Title
53
+ */
54
+ title?: string | null;
55
+ /**
56
+ * Artist Id
57
+ */
58
+ artist_id?: number | null;
59
+ };
60
+
61
+ /**
62
+ * AlbumUpdate
63
+ */
64
+ export declare const AlbumUpdateSchema: z.ZodObject<{
65
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
66
+ artist_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
67
+ }, z.core.$strip>;
68
+
69
+ export declare interface API {
70
+ readonly client: APIClient;
71
+ readonly fileAccess: FileAccess;
72
+ readonly userEventsManager: UserEventsManager;
73
+ readonly userSessionManager: UserSessionManager;
74
+ }
75
+
76
+ export declare class APIClient {
77
+ private readonly options;
78
+ private readonly subscribers;
79
+ constructor({ baseUrl, userSessionManager }: APIClientOptions);
80
+ subscribe(subscriber: (event: APIClientEvent) => void): () => void;
81
+ /** Access the instance status of the API, fetching it if it's not already loaded */
82
+ instanceStatus(): Promise<InstanceStatusRead>;
83
+ signUp(body: SignUp): Promise<UserProfileMeRead>;
84
+ signIn(body: BodySignInSignInPost): Promise<Token>;
85
+ verifyEmail(token: string): Promise<OperationResult>;
86
+ resetPassword(body: ResetPassword): Promise<OperationResult>;
87
+ resetPasswordComplete(body: CompleteResetPassword): Promise<OperationResult>;
88
+ readMe(): Promise<UserProfileMeRead>;
89
+ updateMe(body: UserProfileMeUpdate): Promise<UserProfileMeRead>;
90
+ readNotifications(query?: ReadNotificationsUsersNotificationsGetData["query"]): Promise<NotificationsRead>;
91
+ readNotification(notification_id: number): Promise<NotificationRead>;
92
+ updateNotification(notification_id: number, body: NotificationUpdate): Promise<NotificationRead>;
93
+ deleteNotification(notification_id: number): Promise<OperationResult>;
94
+ markAllNotificationsRead(): Promise<OperationResult>;
95
+ streamUserEventsPreflight(): Promise<UserEventPreflight>;
96
+ readUser(id_or_username: number | string): Promise<UserProfileRead>;
97
+ readAllUsers(query?: ReadUsersUsersAllGetData["query"]): Promise<UserProfilesRead>;
98
+ readUserAdmin(id_or_username: number | string): Promise<UserAdminRead>;
99
+ readAllUsersAdmin(query?: ReadUsersAdminUsersAdminAllGetData["query"]): Promise<UserAdminsRead>;
100
+ updateUserAdmin(user_id: number, body: UserAdminUpdate): Promise<UserAdminRead>;
101
+ deleteUserAdmin(user_id: number): Promise<OperationResult>;
102
+ readFilesPreflight(): Promise<UserFileAccessPreflight>;
103
+ readLibraries(): Promise<readonly LibraryRead[]>;
104
+ readLibraryHomeSubpaths(query: ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetData["query"]): Promise<LibraryHomePathRead>;
105
+ createLibrary(body: LibraryCreate): Promise<LibraryRead>;
106
+ updateLibrary(library_id: number, body: LibraryUpdate): Promise<LibraryRead>;
107
+ readLibrary(library_id: number): Promise<LibraryRead>;
108
+ readLibraryPermissions(library_id: number): Promise<readonly LibraryPermissionRead[]>;
109
+ createLibraryPermission(library_id: number, body: LibraryPermissionCreate): Promise<LibraryPermissionRead>;
110
+ updateLibraryPermission(library_id: number, user_id: number, body: LibraryPermissionUpdate): Promise<LibraryPermissionRead>;
111
+ deleteLibraryPermission(library_id: number, user_id: number): Promise<OperationResult>;
112
+ readLibraryIgnoredResources(library_id: number, query?: ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetData["query"]): Promise<LibraryMediaReadLibraryIgnoredResourceRead>;
113
+ deleteLibraryIgnoredResource(library_id: number, ignored_resource_id: number): Promise<OperationResult>;
114
+ updateLibraryAlbum(library_id: number, album_id: number, body: AlbumUpdate): Promise<AlbumRead>;
115
+ deleteLibraryAlbum(library_id: number, album_id: number): Promise<void>;
116
+ readLibraryAlbum(library_id: number, album_id: number): Promise<AlbumRead>;
117
+ readLibraryAlbums(library_id: number, query?: ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetData["query"]): Promise<LibraryMediaReadAlbumRead>;
118
+ updateLibraryArtist(library_id: number, artist_id: number, body: ArtistUpdate): Promise<ArtistRead>;
119
+ deleteLibraryArtist(library_id: number, artist_id: number): Promise<void>;
120
+ readLibraryArtist(library_id: number, artist_id: number): Promise<ArtistRead>;
121
+ readLibraryArtists(library_id: number, query?: ReadLibraryArtistsLibrariesLibraryIdArtistsGetData["query"]): Promise<LibraryMediaReadArtistRead>;
122
+ updateLibrarySong(library_id: number, song_id: number, body: SongUpdate): Promise<SongRead>;
123
+ deleteLibrarySong(library_id: number, song_id: number, query?: DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteData["query"]): Promise<void>;
124
+ readLibrarySong(library_id: number, song_id: number): Promise<SongRead>;
125
+ readLibrarySongs(library_id: number, query?: ReadLibrarySongsLibrariesLibraryIdSongsGetData["query"]): Promise<LibraryMediaReadSongRead>;
126
+ createArtwork(body: ArtworkCreate): Promise<ArtworkRead>;
127
+ updateArtwork(artwork_id: number, body: ArtworkUpdate): Promise<ArtworkRead>;
128
+ deleteArtwork(artwork_id: number): Promise<void>;
129
+ readAllSources(query?: ReadAllSourcesSourcesAllGetData["query"]): Promise<LibraryMediaReadSourceRead>;
130
+ createSource(body: SourceCreate): Promise<SourceRead>;
131
+ updateSource(source_id: number, body: SourceUpdate): Promise<SourceRead>;
132
+ deleteSource(source_id: number): Promise<void>;
133
+ readSourceChanges(query: ReadSourceChangesSourcesChangesGetData["query"]): Promise<SourceChangesRead>;
134
+ ingestPlaybackEvents(body: IngestPlaybackEvent[]): Promise<PlaybackEventIngestResult>;
135
+ ingestFiles(library_id: number, files: Array<Blob | File>): Promise<OperationResult>;
136
+ ingestSongs(library_id: number, body: BulkIngestSongs): Promise<readonly SongRead[]>;
137
+ requestSyncLibrary(library_id: number): Promise<OperationResult>;
138
+ importExtension(body: ExtensionImportAdmin): Promise<OperationResult>;
139
+ updateExtension(extension_id: number): Promise<OperationResult>;
140
+ deleteExtension(extension_id: number): Promise<OperationResult>;
141
+ readAvailableExtensions(query?: ReadAvailableExtensionsExtensionsAvailableGetData["query"]): Promise<LibraryMediaReadExtensionRead>;
142
+ installExtension(extension_id: number): Promise<OperationResult>;
143
+ uninstallExtension(extension_id: number): Promise<OperationResult>;
144
+ readInstalledExtensions(query?: ReadInstalledExtensionsExtensionsInstalledGetData["query"]): Promise<LibraryMediaReadExtensionRead>;
145
+ }
146
+
147
+ export declare type APIClientEvent = {
148
+ type: "unauthorized";
149
+ };
150
+
151
+ export declare interface APIClientOptions {
152
+ readonly baseUrl: string;
153
+ readonly userSessionManager: UserSessionManager;
154
+ }
155
+
156
+ export declare interface APIOptions {
157
+ readonly baseUrl: string;
158
+ readonly userSessionManager?: UserSessionManager;
159
+ }
160
+
161
+ /**
162
+ * ArtistRead
163
+ */
164
+ export declare type ArtistRead = {
165
+ /**
166
+ * Id
167
+ */
168
+ id: number;
169
+ /**
170
+ * Name
171
+ */
172
+ name: string;
173
+ /**
174
+ * Artworks
175
+ *
176
+ * The artworks of this artist
177
+ */
178
+ artworks?: Array<ArtworkRead>;
179
+ };
180
+
181
+ /**
182
+ * ArtistRead
183
+ */
184
+ export declare const ArtistReadSchema: z.ZodObject<{
185
+ id: z.ZodInt;
186
+ name: z.ZodString;
187
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
188
+ id: z.ZodInt;
189
+ kind: z.ZodEnum<{
190
+ front_cover: "front_cover";
191
+ }>;
192
+ image_url: z.ZodString;
193
+ background_color: z.ZodNullable<z.ZodString>;
194
+ primary_color: z.ZodNullable<z.ZodString>;
195
+ secondary_color: z.ZodNullable<z.ZodString>;
196
+ tertiary_color: z.ZodNullable<z.ZodString>;
197
+ }, z.core.$strip>>>;
198
+ }, z.core.$strip>;
199
+
200
+ /**
201
+ * ArtistUpdate
202
+ */
203
+ export declare type ArtistUpdate = {
204
+ /**
205
+ * Name
206
+ */
207
+ name?: string | null;
208
+ };
209
+
210
+ /**
211
+ * ArtistUpdate
212
+ */
213
+ export declare const ArtistUpdateSchema: z.ZodObject<{
214
+ name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
215
+ }, z.core.$strip>;
216
+
217
+ /**
218
+ * ArtworkCreate
219
+ */
220
+ export declare type ArtworkCreate = {
221
+ kind: ArtworkKind;
222
+ /**
223
+ * Image Url
224
+ */
225
+ image_url: string;
226
+ /**
227
+ * Background Color
228
+ */
229
+ background_color: string | null;
230
+ /**
231
+ * Primary Color
232
+ */
233
+ primary_color: string | null;
234
+ /**
235
+ * Secondary Color
236
+ */
237
+ secondary_color: string | null;
238
+ /**
239
+ * Tertiary Color
240
+ */
241
+ tertiary_color: string | null;
242
+ };
243
+
244
+ /**
245
+ * ArtworkCreate
246
+ */
247
+ export declare const ArtworkCreateSchema: z.ZodObject<{
248
+ kind: z.ZodEnum<{
249
+ front_cover: "front_cover";
250
+ }>;
251
+ image_url: z.ZodString;
252
+ background_color: z.ZodNullable<z.ZodString>;
253
+ primary_color: z.ZodNullable<z.ZodString>;
254
+ secondary_color: z.ZodNullable<z.ZodString>;
255
+ tertiary_color: z.ZodNullable<z.ZodString>;
256
+ }, z.core.$strip>;
257
+
258
+ /**
259
+ * ArtworkKind
260
+ */
261
+ export declare type ArtworkKind = "front_cover";
262
+
263
+ /**
264
+ * ArtworkKind
265
+ */
266
+ export declare const ArtworkKindSchema: z.ZodEnum<{
267
+ front_cover: "front_cover";
268
+ }>;
269
+
270
+ /**
271
+ * ArtworkRead
272
+ */
273
+ export declare type ArtworkRead = {
274
+ /**
275
+ * Id
276
+ */
277
+ id: number;
278
+ kind: ArtworkKind;
279
+ /**
280
+ * Image Url
281
+ */
282
+ image_url: string;
283
+ /**
284
+ * Background Color
285
+ */
286
+ background_color: string | null;
287
+ /**
288
+ * Primary Color
289
+ */
290
+ primary_color: string | null;
291
+ /**
292
+ * Secondary Color
293
+ */
294
+ secondary_color: string | null;
295
+ /**
296
+ * Tertiary Color
297
+ */
298
+ tertiary_color: string | null;
299
+ };
300
+
301
+ /**
302
+ * ArtworkRead
303
+ */
304
+ export declare const ArtworkReadSchema: z.ZodObject<{
305
+ id: z.ZodInt;
306
+ kind: z.ZodEnum<{
307
+ front_cover: "front_cover";
308
+ }>;
309
+ image_url: z.ZodString;
310
+ background_color: z.ZodNullable<z.ZodString>;
311
+ primary_color: z.ZodNullable<z.ZodString>;
312
+ secondary_color: z.ZodNullable<z.ZodString>;
313
+ tertiary_color: z.ZodNullable<z.ZodString>;
314
+ }, z.core.$strip>;
315
+
316
+ /**
317
+ * ArtworkUpdate
318
+ */
319
+ export declare type ArtworkUpdate = {
320
+ kind?: ArtworkKind | null;
321
+ /**
322
+ * Image Url
323
+ */
324
+ image_url?: string | null;
325
+ /**
326
+ * Background Color
327
+ */
328
+ background_color?: string | null;
329
+ /**
330
+ * Primary Color
331
+ */
332
+ primary_color?: string | null;
333
+ /**
334
+ * Secondary Color
335
+ */
336
+ secondary_color?: string | null;
337
+ /**
338
+ * Tertiary Color
339
+ */
340
+ tertiary_color?: string | null;
341
+ };
342
+
343
+ /**
344
+ * ArtworkUpdate
345
+ */
346
+ export declare const ArtworkUpdateSchema: z.ZodObject<{
347
+ kind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
348
+ front_cover: "front_cover";
349
+ }>>>;
350
+ image_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
351
+ background_color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
352
+ primary_color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
353
+ secondary_color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
354
+ tertiary_color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
355
+ }, z.core.$strip>;
356
+
357
+ /**
358
+ * Body_ingest_files_libraries__library_id__ingest_files_post
359
+ */
360
+ export declare type BodyIngestFilesLibrariesLibraryIdIngestFilesPost = {
361
+ /**
362
+ * Files
363
+ */
364
+ files: Array<Blob | File>;
365
+ };
366
+
367
+ /**
368
+ * Body_ingest_files_libraries__library_id__ingest_files_post
369
+ */
370
+ export declare const BodyIngestFilesLibrariesLibraryIdIngestFilesPostSchema: z.ZodObject<{
371
+ files: z.ZodArray<z.ZodString>;
372
+ }, z.core.$strip>;
373
+
374
+ /**
375
+ * Body_sign_in_sign_in_post
376
+ */
377
+ export declare type BodySignInSignInPost = {
378
+ /**
379
+ * Grant Type
380
+ */
381
+ grant_type?: string | null;
382
+ /**
383
+ * Username
384
+ */
385
+ username: string;
386
+ /**
387
+ * Password
388
+ */
389
+ password: string;
390
+ /**
391
+ * Scope
392
+ */
393
+ scope?: string;
394
+ /**
395
+ * Client Id
396
+ */
397
+ client_id?: string | null;
398
+ /**
399
+ * Client Secret
400
+ */
401
+ client_secret?: string | null;
402
+ };
403
+
404
+ /**
405
+ * Body_sign_in_sign_in_post
406
+ */
407
+ export declare const BodySignInSignInPostSchema: z.ZodObject<{
408
+ grant_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
409
+ username: z.ZodString;
410
+ password: z.ZodString;
411
+ scope: z.ZodOptional<z.ZodString>;
412
+ client_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
413
+ client_secret: z.ZodOptional<z.ZodNullable<z.ZodString>>;
414
+ }, z.core.$strip>;
415
+
416
+ /**
417
+ * BulkIngestSongs
418
+ */
419
+ export declare type BulkIngestSongs = {
420
+ /**
421
+ * Songs
422
+ */
423
+ songs: Array<IngestSong>;
424
+ };
425
+
426
+ /**
427
+ * BulkIngestSongs
428
+ */
429
+ export declare const BulkIngestSongsSchema: z.ZodObject<{
430
+ songs: z.ZodArray<z.ZodObject<{
431
+ artist_name: z.ZodNullable<z.ZodString>;
432
+ album_title: z.ZodNullable<z.ZodString>;
433
+ artworks: z.ZodArray<z.ZodObject<{
434
+ kind: z.ZodEnum<{
435
+ front_cover: "front_cover";
436
+ }>;
437
+ image_url: z.ZodString;
438
+ background_color: z.ZodNullable<z.ZodString>;
439
+ primary_color: z.ZodNullable<z.ZodString>;
440
+ secondary_color: z.ZodNullable<z.ZodString>;
441
+ tertiary_color: z.ZodNullable<z.ZodString>;
442
+ }, z.core.$strip>>;
443
+ sources: z.ZodArray<z.ZodObject<{
444
+ url: z.ZodString;
445
+ mime_type: z.ZodNullable<z.ZodString>;
446
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
447
+ extension_tag: z.ZodNullable<z.ZodString>;
448
+ }, z.core.$strip>>;
449
+ start_time: z.ZodNumber;
450
+ end_time: z.ZodNumber;
451
+ title: z.ZodNullable<z.ZodString>;
452
+ album_artist: z.ZodNullable<z.ZodString>;
453
+ composer: z.ZodNullable<z.ZodString>;
454
+ genre: z.ZodNullable<z.ZodString>;
455
+ release_date: z.ZodNullable<z.ZodString>;
456
+ track_number: z.ZodNullable<z.ZodInt>;
457
+ track_total: z.ZodNullable<z.ZodInt>;
458
+ disc_number: z.ZodNullable<z.ZodInt>;
459
+ disc_total: z.ZodNullable<z.ZodInt>;
460
+ lyrics: z.ZodNullable<z.ZodString>;
461
+ rating: z.ZodNullable<z.ZodNumber>;
462
+ bpm: z.ZodNullable<z.ZodInt>;
463
+ comment: z.ZodNullable<z.ZodString>;
464
+ grouping: z.ZodNullable<z.ZodString>;
465
+ mcn: z.ZodNullable<z.ZodString>;
466
+ isrc: z.ZodNullable<z.ZodString>;
467
+ music_brainz_release_id: z.ZodNullable<z.ZodString>;
468
+ music_brainz_recording_id: z.ZodNullable<z.ZodString>;
469
+ }, z.core.$strip>>;
470
+ }, z.core.$strip>;
471
+
472
+ export declare type ClientOptions = {
473
+ baseUrl: `${string}://${string}` | (string & {});
474
+ };
475
+
476
+ /**
477
+ * CompleteResetPassword
478
+ */
479
+ export declare type CompleteResetPassword = {
480
+ /**
481
+ * Email
482
+ */
483
+ email: string;
484
+ /**
485
+ * Token
486
+ */
487
+ token: string;
488
+ /**
489
+ * New Password
490
+ */
491
+ new_password: string;
492
+ };
493
+
494
+ /**
495
+ * CompleteResetPassword
496
+ */
497
+ export declare const CompleteResetPasswordSchema: z.ZodObject<{
498
+ email: z.ZodEmail;
499
+ token: z.ZodString;
500
+ new_password: z.ZodString;
501
+ }, z.core.$strip>;
502
+
503
+ export declare function createAPI({ baseUrl, userSessionManager, }: APIOptions): API;
504
+
505
+ export declare type CreateArtworkArtworksCreatePostData = {
506
+ body: ArtworkCreate;
507
+ path?: never;
508
+ query?: never;
509
+ url: "/artworks/create";
510
+ };
511
+
512
+ export declare type CreateArtworkArtworksCreatePostError = CreateArtworkArtworksCreatePostErrors[keyof CreateArtworkArtworksCreatePostErrors];
513
+
514
+ export declare type CreateArtworkArtworksCreatePostErrors = {
515
+ /**
516
+ * Validation Error
517
+ */
518
+ 422: HttpValidationError;
519
+ };
520
+
521
+ export declare type CreateArtworkArtworksCreatePostResponse = CreateArtworkArtworksCreatePostResponses[keyof CreateArtworkArtworksCreatePostResponses];
522
+
523
+ export declare type CreateArtworkArtworksCreatePostResponses = {
524
+ /**
525
+ * Successful Response
526
+ */
527
+ 200: ArtworkRead;
528
+ };
529
+
530
+ export declare type CreateLibraryLibrariesCreatePostData = {
531
+ body: LibraryCreate;
532
+ path?: never;
533
+ query?: never;
534
+ url: "/libraries/create";
535
+ };
536
+
537
+ export declare type CreateLibraryLibrariesCreatePostError = CreateLibraryLibrariesCreatePostErrors[keyof CreateLibraryLibrariesCreatePostErrors];
538
+
539
+ export declare type CreateLibraryLibrariesCreatePostErrors = {
540
+ /**
541
+ * Validation Error
542
+ */
543
+ 422: HttpValidationError;
544
+ };
545
+
546
+ export declare type CreateLibraryLibrariesCreatePostResponse = CreateLibraryLibrariesCreatePostResponses[keyof CreateLibraryLibrariesCreatePostResponses];
547
+
548
+ export declare type CreateLibraryLibrariesCreatePostResponses = {
549
+ /**
550
+ * Successful Response
551
+ */
552
+ 200: LibraryRead;
553
+ };
554
+
555
+ export declare type CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostData = {
556
+ body: LibraryPermissionCreate;
557
+ path: {
558
+ /**
559
+ * Library Id
560
+ */
561
+ library_id: number;
562
+ };
563
+ query?: never;
564
+ url: "/libraries/{library_id}/permission/create";
565
+ };
566
+
567
+ export declare type CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostError = CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostErrors[keyof CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostErrors];
568
+
569
+ export declare type CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostErrors = {
570
+ /**
571
+ * Validation Error
572
+ */
573
+ 422: HttpValidationError;
574
+ };
575
+
576
+ export declare type CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostResponse = CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostResponses[keyof CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostResponses];
577
+
578
+ export declare type CreateLibraryPermissionLibrariesLibraryIdPermissionCreatePostResponses = {
579
+ /**
580
+ * Successful Response
581
+ */
582
+ 200: LibraryPermissionRead;
583
+ };
584
+
585
+ export declare type CreateSourceSourcesCreatePostData = {
586
+ body: SourceCreate;
587
+ path?: never;
588
+ query?: never;
589
+ url: "/sources/create";
590
+ };
591
+
592
+ export declare type CreateSourceSourcesCreatePostError = CreateSourceSourcesCreatePostErrors[keyof CreateSourceSourcesCreatePostErrors];
593
+
594
+ export declare type CreateSourceSourcesCreatePostErrors = {
595
+ /**
596
+ * Validation Error
597
+ */
598
+ 422: HttpValidationError;
599
+ };
600
+
601
+ export declare type CreateSourceSourcesCreatePostResponse = CreateSourceSourcesCreatePostResponses[keyof CreateSourceSourcesCreatePostResponses];
602
+
603
+ export declare type CreateSourceSourcesCreatePostResponses = {
604
+ /**
605
+ * Successful Response
606
+ */
607
+ 200: SourceRead;
608
+ };
609
+
610
+ export declare type DeleteArtworkArtworksArtworkIdDeleteData = {
611
+ body?: never;
612
+ path: {
613
+ /**
614
+ * Artwork Id
615
+ */
616
+ artwork_id: number;
617
+ };
618
+ query?: never;
619
+ url: "/artworks/{artwork_id}";
620
+ };
621
+
622
+ export declare type DeleteArtworkArtworksArtworkIdDeleteError = DeleteArtworkArtworksArtworkIdDeleteErrors[keyof DeleteArtworkArtworksArtworkIdDeleteErrors];
623
+
624
+ export declare type DeleteArtworkArtworksArtworkIdDeleteErrors = {
625
+ /**
626
+ * Validation Error
627
+ */
628
+ 422: HttpValidationError;
629
+ };
630
+
631
+ export declare type DeleteArtworkArtworksArtworkIdDeleteResponses = {
632
+ /**
633
+ * Successful Response
634
+ */
635
+ 200: unknown;
636
+ };
637
+
638
+ export declare type DeleteExtensionExtensionsAvailableExtensionIdDeleteData = {
639
+ body?: never;
640
+ path: {
641
+ /**
642
+ * Extension Id
643
+ */
644
+ extension_id: number;
645
+ };
646
+ query?: never;
647
+ url: "/extensions/available/{extension_id}";
648
+ };
649
+
650
+ export declare type DeleteExtensionExtensionsAvailableExtensionIdDeleteError = DeleteExtensionExtensionsAvailableExtensionIdDeleteErrors[keyof DeleteExtensionExtensionsAvailableExtensionIdDeleteErrors];
651
+
652
+ export declare type DeleteExtensionExtensionsAvailableExtensionIdDeleteErrors = {
653
+ /**
654
+ * Validation Error
655
+ */
656
+ 422: HttpValidationError;
657
+ };
658
+
659
+ export declare type DeleteExtensionExtensionsAvailableExtensionIdDeleteResponse = DeleteExtensionExtensionsAvailableExtensionIdDeleteResponses[keyof DeleteExtensionExtensionsAvailableExtensionIdDeleteResponses];
660
+
661
+ export declare type DeleteExtensionExtensionsAvailableExtensionIdDeleteResponses = {
662
+ /**
663
+ * Successful Response
664
+ */
665
+ 200: OperationResult;
666
+ };
667
+
668
+ export declare type DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteData = {
669
+ body?: never;
670
+ path: {
671
+ /**
672
+ * Library Id
673
+ */
674
+ library_id: number;
675
+ /**
676
+ * Album Id
677
+ */
678
+ album_id: number;
679
+ };
680
+ query?: never;
681
+ url: "/libraries/{library_id}/albums/{album_id}";
682
+ };
683
+
684
+ export declare type DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteError = DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteErrors[keyof DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteErrors];
685
+
686
+ export declare type DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteErrors = {
687
+ /**
688
+ * Validation Error
689
+ */
690
+ 422: HttpValidationError;
691
+ };
692
+
693
+ export declare type DeleteLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdDeleteResponses = {
694
+ /**
695
+ * Successful Response
696
+ */
697
+ 200: unknown;
698
+ };
699
+
700
+ export declare type DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteData = {
701
+ body?: never;
702
+ path: {
703
+ /**
704
+ * Library Id
705
+ */
706
+ library_id: number;
707
+ /**
708
+ * Artist Id
709
+ */
710
+ artist_id: number;
711
+ };
712
+ query?: never;
713
+ url: "/libraries/{library_id}/artists/{artist_id}";
714
+ };
715
+
716
+ export declare type DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteError = DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteErrors[keyof DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteErrors];
717
+
718
+ export declare type DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteErrors = {
719
+ /**
720
+ * Validation Error
721
+ */
722
+ 422: HttpValidationError;
723
+ };
724
+
725
+ export declare type DeleteLibraryArtistLibrariesLibraryIdArtistsArtistIdDeleteResponses = {
726
+ /**
727
+ * Successful Response
728
+ */
729
+ 200: unknown;
730
+ };
731
+
732
+ export declare type DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteData = {
733
+ body?: never;
734
+ path: {
735
+ /**
736
+ * Library Id
737
+ */
738
+ library_id: number;
739
+ /**
740
+ * Ignored Resource Id
741
+ */
742
+ ignored_resource_id: number;
743
+ };
744
+ query?: never;
745
+ url: "/libraries/{library_id}/ignored/{ignored_resource_id}";
746
+ };
747
+
748
+ export declare type DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteError = DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteErrors[keyof DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteErrors];
749
+
750
+ export declare type DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteErrors = {
751
+ /**
752
+ * Validation Error
753
+ */
754
+ 422: HttpValidationError;
755
+ };
756
+
757
+ export declare type DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteResponse = DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteResponses[keyof DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteResponses];
758
+
759
+ export declare type DeleteLibraryIgnoredResourceLibrariesLibraryIdIgnoredIgnoredResourceIdDeleteResponses = {
760
+ /**
761
+ * Successful Response
762
+ */
763
+ 200: OperationResult;
764
+ };
765
+
766
+ export declare type DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteData = {
767
+ body?: never;
768
+ path: {
769
+ /**
770
+ * Library Id
771
+ */
772
+ library_id: number;
773
+ /**
774
+ * User Id
775
+ */
776
+ user_id: number;
777
+ };
778
+ query?: never;
779
+ url: "/libraries/{library_id}/permission/{user_id}";
780
+ };
781
+
782
+ export declare type DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteError = DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteErrors[keyof DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteErrors];
783
+
784
+ export declare type DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteErrors = {
785
+ /**
786
+ * Validation Error
787
+ */
788
+ 422: HttpValidationError;
789
+ };
790
+
791
+ export declare type DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteResponse = DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteResponses[keyof DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteResponses];
792
+
793
+ export declare type DeleteLibraryPermissionLibrariesLibraryIdPermissionUserIdDeleteResponses = {
794
+ /**
795
+ * Successful Response
796
+ */
797
+ 200: OperationResult;
798
+ };
799
+
800
+ export declare type DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteData = {
801
+ body?: never;
802
+ path: {
803
+ /**
804
+ * Library Id
805
+ */
806
+ library_id: number;
807
+ /**
808
+ * Song Id
809
+ */
810
+ song_id: number;
811
+ };
812
+ query?: {
813
+ /**
814
+ * Suppress Source File
815
+ */
816
+ suppress_source_file?: boolean;
817
+ };
818
+ url: "/libraries/{library_id}/songs/{song_id}";
819
+ };
820
+
821
+ export declare type DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteError = DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteErrors[keyof DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteErrors];
822
+
823
+ export declare type DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteErrors = {
824
+ /**
825
+ * Validation Error
826
+ */
827
+ 422: HttpValidationError;
828
+ };
829
+
830
+ export declare type DeleteLibrarySongLibrariesLibraryIdSongsSongIdDeleteResponses = {
831
+ /**
832
+ * Successful Response
833
+ */
834
+ 200: unknown;
835
+ };
836
+
837
+ export declare type DeleteNotificationUsersNotificationsNotificationIdDeleteData = {
838
+ body?: never;
839
+ path: {
840
+ /**
841
+ * Notification Id
842
+ */
843
+ notification_id: number;
844
+ };
845
+ query?: never;
846
+ url: "/users/notifications/{notification_id}";
847
+ };
848
+
849
+ export declare type DeleteNotificationUsersNotificationsNotificationIdDeleteError = DeleteNotificationUsersNotificationsNotificationIdDeleteErrors[keyof DeleteNotificationUsersNotificationsNotificationIdDeleteErrors];
850
+
851
+ export declare type DeleteNotificationUsersNotificationsNotificationIdDeleteErrors = {
852
+ /**
853
+ * Validation Error
854
+ */
855
+ 422: HttpValidationError;
856
+ };
857
+
858
+ export declare type DeleteNotificationUsersNotificationsNotificationIdDeleteResponse = DeleteNotificationUsersNotificationsNotificationIdDeleteResponses[keyof DeleteNotificationUsersNotificationsNotificationIdDeleteResponses];
859
+
860
+ export declare type DeleteNotificationUsersNotificationsNotificationIdDeleteResponses = {
861
+ /**
862
+ * Successful Response
863
+ */
864
+ 200: OperationResult;
865
+ };
866
+
867
+ export declare type DeleteSourceSourcesSourceIdDeleteData = {
868
+ body?: never;
869
+ path: {
870
+ /**
871
+ * Source Id
872
+ */
873
+ source_id: number;
874
+ };
875
+ query?: never;
876
+ url: "/sources/{source_id}";
877
+ };
878
+
879
+ export declare type DeleteSourceSourcesSourceIdDeleteError = DeleteSourceSourcesSourceIdDeleteErrors[keyof DeleteSourceSourcesSourceIdDeleteErrors];
880
+
881
+ export declare type DeleteSourceSourcesSourceIdDeleteErrors = {
882
+ /**
883
+ * Validation Error
884
+ */
885
+ 422: HttpValidationError;
886
+ };
887
+
888
+ export declare type DeleteSourceSourcesSourceIdDeleteResponses = {
889
+ /**
890
+ * Successful Response
891
+ */
892
+ 200: unknown;
893
+ };
894
+
895
+ export declare type DeleteUserAdminUsersAdminAllUserIdDeleteData = {
896
+ body?: never;
897
+ path: {
898
+ /**
899
+ * User Id
900
+ */
901
+ user_id: number;
902
+ };
903
+ query?: never;
904
+ url: "/users/admin/all/{user_id}";
905
+ };
906
+
907
+ export declare type DeleteUserAdminUsersAdminAllUserIdDeleteError = DeleteUserAdminUsersAdminAllUserIdDeleteErrors[keyof DeleteUserAdminUsersAdminAllUserIdDeleteErrors];
908
+
909
+ export declare type DeleteUserAdminUsersAdminAllUserIdDeleteErrors = {
910
+ /**
911
+ * Validation Error
912
+ */
913
+ 422: HttpValidationError;
914
+ };
915
+
916
+ export declare type DeleteUserAdminUsersAdminAllUserIdDeleteResponse = DeleteUserAdminUsersAdminAllUserIdDeleteResponses[keyof DeleteUserAdminUsersAdminAllUserIdDeleteResponses];
917
+
918
+ export declare type DeleteUserAdminUsersAdminAllUserIdDeleteResponses = {
919
+ /**
920
+ * Successful Response
921
+ */
922
+ 200: OperationResult;
923
+ };
924
+
925
+ /** The maximum length of embedded text such as the lyrics of a song. */
926
+ export declare const EMBEDDED_TEXT_MAX_LENGTH = 5000;
927
+
928
+ /**
929
+ * ExtensionCommand
930
+ */
931
+ export declare type ExtensionCommand = {
932
+ /**
933
+ * Id
934
+ *
935
+ * Unique identifier for the command
936
+ */
937
+ id: string;
938
+ /**
939
+ * Searchterms
940
+ *
941
+ * The static search terms for the command
942
+ */
943
+ searchTerms: string;
944
+ /**
945
+ * Requiredinputkinds
946
+ *
947
+ * The kinds of the inputs this command requires to execute
948
+ */
949
+ requiredInputKinds: Array<string>;
950
+ /**
951
+ * Highlightavailability
952
+ *
953
+ * Whether the command should be highlighted when it becomes available
954
+ */
955
+ highlightAvailability?: boolean;
956
+ [key: string]: unknown;
957
+ };
958
+
959
+ /**
960
+ * ExtensionCommand
961
+ */
962
+ export declare const ExtensionCommandSchema: z.ZodObject<{
963
+ id: z.ZodString;
964
+ searchTerms: z.ZodString;
965
+ requiredInputKinds: z.ZodArray<z.ZodString>;
966
+ highlightAvailability: z.ZodOptional<z.ZodBoolean>;
967
+ }, z.core.$strip>;
968
+
969
+ /**
970
+ * ExtensionImportAdmin
971
+ */
972
+ export declare type ExtensionImportAdmin = {
973
+ /**
974
+ * Manifest Url
975
+ */
976
+ manifest_url: string;
977
+ };
978
+
979
+ /**
980
+ * ExtensionImportAdmin
981
+ */
982
+ export declare const ExtensionImportAdminSchema: z.ZodObject<{
983
+ manifest_url: z.ZodURL;
984
+ }, z.core.$strip>;
985
+
986
+ /**
987
+ * ExtensionManifest
988
+ */
989
+ export declare type ExtensionManifest = {
990
+ /**
991
+ * Name
992
+ *
993
+ * A friendly name for the extension
994
+ */
995
+ name: string;
996
+ /**
997
+ * Id
998
+ *
999
+ * A unique identifier for the extension
1000
+ */
1001
+ id: string;
1002
+ /**
1003
+ * Version
1004
+ *
1005
+ * The version of the extension
1006
+ */
1007
+ version: string;
1008
+ /**
1009
+ * Description
1010
+ *
1011
+ * An optional description of the extension
1012
+ */
1013
+ description?: string | null;
1014
+ /**
1015
+ * Url
1016
+ *
1017
+ * The possibly relative URL of the extension
1018
+ */
1019
+ url: string;
1020
+ /**
1021
+ * Icon Url
1022
+ *
1023
+ * The possibly relative URL of the extension's icon, if any
1024
+ */
1025
+ icon_url?: string | null;
1026
+ /**
1027
+ * Preferredwidth
1028
+ *
1029
+ * The preferred width of the extension as a CSS dimension
1030
+ */
1031
+ preferredWidth?: string | null;
1032
+ /**
1033
+ * Preferredheight
1034
+ *
1035
+ * The preferred height of the extension as a CSS dimension
1036
+ */
1037
+ preferredHeight?: string | null;
1038
+ /**
1039
+ * Permissions
1040
+ *
1041
+ * An optional array of permissions required by the extension
1042
+ */
1043
+ permissions?: Array<ExtensionPermissions | string> | null;
1044
+ /**
1045
+ * Sourceschemes
1046
+ *
1047
+ * An optional array of source schemes supported by the extension
1048
+ */
1049
+ sourceSchemes?: Array<string> | null;
1050
+ /**
1051
+ * Commands
1052
+ *
1053
+ * An optional array of commands supported by the extension
1054
+ */
1055
+ commands?: Array<ExtensionCommand> | null;
1056
+ /**
1057
+ * An optional search command supported by the extension
1058
+ */
1059
+ searchCommand?: ExtensionSearchCommand | null;
1060
+ [key: string]: unknown;
1061
+ };
1062
+
1063
+ /**
1064
+ * ExtensionManifest
1065
+ */
1066
+ export declare const ExtensionManifestSchema: z.ZodObject<{
1067
+ name: z.ZodString;
1068
+ id: z.ZodString;
1069
+ version: z.ZodString;
1070
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1071
+ url: z.ZodString;
1072
+ icon_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1073
+ preferredWidth: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1074
+ preferredHeight: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1075
+ permissions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
1076
+ "run:background": "run:background";
1077
+ "run:eager": "run:eager";
1078
+ "commands:input:read": "commands:input:read";
1079
+ "commands:input:add": "commands:input:add";
1080
+ "commands:query": "commands:query";
1081
+ "commands:run": "commands:run";
1082
+ "libraries:read": "libraries:read";
1083
+ "libraries:write": "libraries:write";
1084
+ "playback:read": "playback:read";
1085
+ "playback:control": "playback:control";
1086
+ }>, z.ZodString]>>>>;
1087
+ sourceSchemes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
1088
+ commands: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
1089
+ id: z.ZodString;
1090
+ searchTerms: z.ZodString;
1091
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1092
+ highlightAvailability: z.ZodOptional<z.ZodBoolean>;
1093
+ }, z.core.$strip>>>>;
1094
+ searchCommand: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1095
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1096
+ }, z.core.$strip>>>;
1097
+ }, z.core.$strip>;
1098
+
1099
+ /**
1100
+ * ExtensionPermissions
1101
+ */
1102
+ export declare type ExtensionPermissions = "run:background" | "run:eager" | "commands:input:read" | "commands:input:add" | "commands:query" | "commands:run" | "libraries:read" | "libraries:write" | "playback:read" | "playback:control";
1103
+
1104
+ /**
1105
+ * ExtensionPermissions
1106
+ */
1107
+ export declare const ExtensionPermissionsSchema: z.ZodEnum<{
1108
+ "run:background": "run:background";
1109
+ "run:eager": "run:eager";
1110
+ "commands:input:read": "commands:input:read";
1111
+ "commands:input:add": "commands:input:add";
1112
+ "commands:query": "commands:query";
1113
+ "commands:run": "commands:run";
1114
+ "libraries:read": "libraries:read";
1115
+ "libraries:write": "libraries:write";
1116
+ "playback:read": "playback:read";
1117
+ "playback:control": "playback:control";
1118
+ }>;
1119
+
1120
+ /**
1121
+ * ExtensionRead
1122
+ */
1123
+ export declare type ExtensionRead = {
1124
+ /**
1125
+ * Id
1126
+ */
1127
+ id: number;
1128
+ manifest: ExtensionManifest;
1129
+ };
1130
+
1131
+ /**
1132
+ * ExtensionRead
1133
+ */
1134
+ export declare const ExtensionReadSchema: z.ZodObject<{
1135
+ id: z.ZodInt;
1136
+ manifest: z.ZodObject<{
1137
+ name: z.ZodString;
1138
+ id: z.ZodString;
1139
+ version: z.ZodString;
1140
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1141
+ url: z.ZodString;
1142
+ icon_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1143
+ preferredWidth: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1144
+ preferredHeight: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1145
+ permissions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
1146
+ "run:background": "run:background";
1147
+ "run:eager": "run:eager";
1148
+ "commands:input:read": "commands:input:read";
1149
+ "commands:input:add": "commands:input:add";
1150
+ "commands:query": "commands:query";
1151
+ "commands:run": "commands:run";
1152
+ "libraries:read": "libraries:read";
1153
+ "libraries:write": "libraries:write";
1154
+ "playback:read": "playback:read";
1155
+ "playback:control": "playback:control";
1156
+ }>, z.ZodString]>>>>;
1157
+ sourceSchemes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
1158
+ commands: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
1159
+ id: z.ZodString;
1160
+ searchTerms: z.ZodString;
1161
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1162
+ highlightAvailability: z.ZodOptional<z.ZodBoolean>;
1163
+ }, z.core.$strip>>>>;
1164
+ searchCommand: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1165
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1166
+ }, z.core.$strip>>>;
1167
+ }, z.core.$strip>;
1168
+ }, z.core.$strip>;
1169
+
1170
+ /**
1171
+ * ExtensionSearchCommand
1172
+ */
1173
+ export declare type ExtensionSearchCommand = {
1174
+ /**
1175
+ * Requiredinputkinds
1176
+ *
1177
+ * The kinds of the inputs the search command requires to execute
1178
+ */
1179
+ requiredInputKinds: Array<string>;
1180
+ [key: string]: unknown;
1181
+ };
1182
+
1183
+ /**
1184
+ * ExtensionSearchCommand
1185
+ */
1186
+ export declare const ExtensionSearchCommandSchema: z.ZodObject<{
1187
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1188
+ }, z.core.$strip>;
1189
+
1190
+ /**
1191
+ * Helper object which manages a file access token.
1192
+ */
1193
+ export declare class FileAccess {
1194
+ private readonly client;
1195
+ private _token;
1196
+ private _expiresAt;
1197
+ private _pending;
1198
+ /**
1199
+ * Construct a file access helper.
1200
+ *
1201
+ * @param client The API client files will be accessed through.
1202
+ */
1203
+ constructor(client: APIClient);
1204
+ /**
1205
+ * Indicates whether the file access helper has a valid token.
1206
+ */
1207
+ get hasValidToken(): boolean;
1208
+ /**
1209
+ * Returns a file access token, fetching one if required.
1210
+ *
1211
+ * @param options Customizes how the token is handled.
1212
+ * @returns A file access token.
1213
+ */
1214
+ token(options?: FileAccessTokenOptions): Promise<string>;
1215
+ }
1216
+
1217
+ export declare interface FileAccessTokenOptions {
1218
+ /**
1219
+ * Whether to refresh the token even if the current one is valid.
1220
+ */
1221
+ readonly refresh?: boolean;
1222
+ }
1223
+
1224
+ /**
1225
+ * HTTPValidationError
1226
+ */
1227
+ export declare type HttpValidationError = {
1228
+ /**
1229
+ * Detail
1230
+ */
1231
+ detail?: Array<ValidationError>;
1232
+ };
1233
+
1234
+ /**
1235
+ * HTTPValidationError
1236
+ */
1237
+ export declare const HttpValidationErrorSchema: z.ZodObject<{
1238
+ detail: z.ZodOptional<z.ZodArray<z.ZodObject<{
1239
+ loc: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
1240
+ msg: z.ZodString;
1241
+ type: z.ZodString;
1242
+ input: z.ZodOptional<z.ZodUnknown>;
1243
+ ctx: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1244
+ }, z.core.$strip>>>;
1245
+ }, z.core.$strip>;
1246
+
1247
+ export declare type ImportExtensionExtensionsAvailableImportPostData = {
1248
+ body: ExtensionImportAdmin;
1249
+ path?: never;
1250
+ query?: never;
1251
+ url: "/extensions/available/import";
1252
+ };
1253
+
1254
+ export declare type ImportExtensionExtensionsAvailableImportPostError = ImportExtensionExtensionsAvailableImportPostErrors[keyof ImportExtensionExtensionsAvailableImportPostErrors];
1255
+
1256
+ export declare type ImportExtensionExtensionsAvailableImportPostErrors = {
1257
+ /**
1258
+ * Validation Error
1259
+ */
1260
+ 422: HttpValidationError;
1261
+ };
1262
+
1263
+ export declare type ImportExtensionExtensionsAvailableImportPostResponse = ImportExtensionExtensionsAvailableImportPostResponses[keyof ImportExtensionExtensionsAvailableImportPostResponses];
1264
+
1265
+ export declare type ImportExtensionExtensionsAvailableImportPostResponses = {
1266
+ /**
1267
+ * Successful Response
1268
+ */
1269
+ 200: OperationResult;
1270
+ };
1271
+
1272
+ /** The maximum number of items that can be ingested in a single batch. */
1273
+ export declare const INGEST_BATCH_MAX_SIZE = 50;
1274
+
1275
+ /**
1276
+ * IngestArtwork
1277
+ */
1278
+ export declare type IngestArtwork = {
1279
+ kind: ArtworkKind;
1280
+ /**
1281
+ * Image Url
1282
+ */
1283
+ image_url: string;
1284
+ /**
1285
+ * Background Color
1286
+ */
1287
+ background_color: string | null;
1288
+ /**
1289
+ * Primary Color
1290
+ */
1291
+ primary_color: string | null;
1292
+ /**
1293
+ * Secondary Color
1294
+ */
1295
+ secondary_color: string | null;
1296
+ /**
1297
+ * Tertiary Color
1298
+ */
1299
+ tertiary_color: string | null;
1300
+ };
1301
+
1302
+ /**
1303
+ * IngestArtwork
1304
+ */
1305
+ export declare const IngestArtworkSchema: z.ZodObject<{
1306
+ kind: z.ZodEnum<{
1307
+ front_cover: "front_cover";
1308
+ }>;
1309
+ image_url: z.ZodString;
1310
+ background_color: z.ZodNullable<z.ZodString>;
1311
+ primary_color: z.ZodNullable<z.ZodString>;
1312
+ secondary_color: z.ZodNullable<z.ZodString>;
1313
+ tertiary_color: z.ZodNullable<z.ZodString>;
1314
+ }, z.core.$strip>;
1315
+
1316
+ export declare type IngestFilesLibrariesLibraryIdIngestFilesPostData = {
1317
+ body: BodyIngestFilesLibrariesLibraryIdIngestFilesPost;
1318
+ path: {
1319
+ /**
1320
+ * Library Id
1321
+ */
1322
+ library_id: number;
1323
+ };
1324
+ query?: never;
1325
+ url: "/libraries/{library_id}/ingest/files";
1326
+ };
1327
+
1328
+ export declare type IngestFilesLibrariesLibraryIdIngestFilesPostError = IngestFilesLibrariesLibraryIdIngestFilesPostErrors[keyof IngestFilesLibrariesLibraryIdIngestFilesPostErrors];
1329
+
1330
+ export declare type IngestFilesLibrariesLibraryIdIngestFilesPostErrors = {
1331
+ /**
1332
+ * Validation Error
1333
+ */
1334
+ 422: HttpValidationError;
1335
+ };
1336
+
1337
+ export declare type IngestFilesLibrariesLibraryIdIngestFilesPostResponse = IngestFilesLibrariesLibraryIdIngestFilesPostResponses[keyof IngestFilesLibrariesLibraryIdIngestFilesPostResponses];
1338
+
1339
+ export declare type IngestFilesLibrariesLibraryIdIngestFilesPostResponses = {
1340
+ /**
1341
+ * Successful Response
1342
+ */
1343
+ 200: OperationResult;
1344
+ };
1345
+
1346
+ /**
1347
+ * IngestPlaybackEvent
1348
+ */
1349
+ export declare type IngestPlaybackEvent = {
1350
+ /**
1351
+ * Recorded At
1352
+ *
1353
+ * When the event was recorded
1354
+ */
1355
+ recorded_at: string;
1356
+ /**
1357
+ * The kind of event which happened
1358
+ */
1359
+ kind: PlaybackEventKind;
1360
+ /**
1361
+ * Song Id
1362
+ *
1363
+ * ID of the song involved in this playback event
1364
+ */
1365
+ song_id: number;
1366
+ /**
1367
+ * Start Time
1368
+ *
1369
+ * The current time in the song when the event started
1370
+ */
1371
+ start_time: number;
1372
+ /**
1373
+ * End Time
1374
+ *
1375
+ * The current time in the song when the event ended
1376
+ */
1377
+ end_time: number;
1378
+ };
1379
+
1380
+ /**
1381
+ * IngestPlaybackEvent
1382
+ */
1383
+ export declare const IngestPlaybackEventSchema: z.ZodObject<{
1384
+ recorded_at: z.ZodISODateTime;
1385
+ kind: z.ZodEnum<{
1386
+ play: "play";
1387
+ pause: "pause";
1388
+ stop: "stop";
1389
+ fast_forward: "fast_forward";
1390
+ rewind: "rewind";
1391
+ }>;
1392
+ song_id: z.ZodInt;
1393
+ start_time: z.ZodInt;
1394
+ end_time: z.ZodInt;
1395
+ }, z.core.$strip>;
1396
+
1397
+ export declare type IngestPlaybackEventsPlaybackEventsIngestPostData = {
1398
+ /**
1399
+ * Ingestable Events
1400
+ *
1401
+ * Playback events to ingest, max 100
1402
+ */
1403
+ body: Array<IngestPlaybackEvent>;
1404
+ path?: never;
1405
+ query?: never;
1406
+ url: "/playback-events/ingest";
1407
+ };
1408
+
1409
+ export declare type IngestPlaybackEventsPlaybackEventsIngestPostError = IngestPlaybackEventsPlaybackEventsIngestPostErrors[keyof IngestPlaybackEventsPlaybackEventsIngestPostErrors];
1410
+
1411
+ export declare type IngestPlaybackEventsPlaybackEventsIngestPostErrors = {
1412
+ /**
1413
+ * Validation Error
1414
+ */
1415
+ 422: HttpValidationError;
1416
+ };
1417
+
1418
+ export declare type IngestPlaybackEventsPlaybackEventsIngestPostResponse = IngestPlaybackEventsPlaybackEventsIngestPostResponses[keyof IngestPlaybackEventsPlaybackEventsIngestPostResponses];
1419
+
1420
+ export declare type IngestPlaybackEventsPlaybackEventsIngestPostResponses = {
1421
+ /**
1422
+ * Successful Response
1423
+ */
1424
+ 200: PlaybackEventIngestResult;
1425
+ };
1426
+
1427
+ /**
1428
+ * IngestSong
1429
+ */
1430
+ export declare type IngestSong = {
1431
+ /**
1432
+ * Artist Name
1433
+ */
1434
+ artist_name: string | null;
1435
+ /**
1436
+ * Album Title
1437
+ */
1438
+ album_title: string | null;
1439
+ /**
1440
+ * Artworks
1441
+ */
1442
+ artworks: Array<IngestArtwork>;
1443
+ /**
1444
+ * Sources
1445
+ */
1446
+ sources: Array<IngestSource>;
1447
+ /**
1448
+ * Start Time
1449
+ */
1450
+ start_time: number;
1451
+ /**
1452
+ * End Time
1453
+ */
1454
+ end_time: number;
1455
+ /**
1456
+ * Title
1457
+ */
1458
+ title: string | null;
1459
+ /**
1460
+ * Album Artist
1461
+ */
1462
+ album_artist: string | null;
1463
+ /**
1464
+ * Composer
1465
+ */
1466
+ composer: string | null;
1467
+ /**
1468
+ * Genre
1469
+ */
1470
+ genre: string | null;
1471
+ /**
1472
+ * Release Date
1473
+ */
1474
+ release_date: string | null;
1475
+ /**
1476
+ * Track Number
1477
+ */
1478
+ track_number: number | null;
1479
+ /**
1480
+ * Track Total
1481
+ */
1482
+ track_total: number | null;
1483
+ /**
1484
+ * Disc Number
1485
+ */
1486
+ disc_number: number | null;
1487
+ /**
1488
+ * Disc Total
1489
+ */
1490
+ disc_total: number | null;
1491
+ /**
1492
+ * Lyrics
1493
+ */
1494
+ lyrics: string | null;
1495
+ /**
1496
+ * Rating
1497
+ */
1498
+ rating: number | null;
1499
+ /**
1500
+ * Bpm
1501
+ */
1502
+ bpm: number | null;
1503
+ /**
1504
+ * Comment
1505
+ */
1506
+ comment: string | null;
1507
+ /**
1508
+ * Grouping
1509
+ */
1510
+ grouping: string | null;
1511
+ /**
1512
+ * Mcn
1513
+ */
1514
+ mcn: string | null;
1515
+ /**
1516
+ * Isrc
1517
+ */
1518
+ isrc: string | null;
1519
+ /**
1520
+ * Music Brainz Release Id
1521
+ */
1522
+ music_brainz_release_id: string | null;
1523
+ /**
1524
+ * Music Brainz Recording Id
1525
+ */
1526
+ music_brainz_recording_id: string | null;
1527
+ };
1528
+
1529
+ /**
1530
+ * IngestSong
1531
+ */
1532
+ export declare const IngestSongSchema: z.ZodObject<{
1533
+ artist_name: z.ZodNullable<z.ZodString>;
1534
+ album_title: z.ZodNullable<z.ZodString>;
1535
+ artworks: z.ZodArray<z.ZodObject<{
1536
+ kind: z.ZodEnum<{
1537
+ front_cover: "front_cover";
1538
+ }>;
1539
+ image_url: z.ZodString;
1540
+ background_color: z.ZodNullable<z.ZodString>;
1541
+ primary_color: z.ZodNullable<z.ZodString>;
1542
+ secondary_color: z.ZodNullable<z.ZodString>;
1543
+ tertiary_color: z.ZodNullable<z.ZodString>;
1544
+ }, z.core.$strip>>;
1545
+ sources: z.ZodArray<z.ZodObject<{
1546
+ url: z.ZodString;
1547
+ mime_type: z.ZodNullable<z.ZodString>;
1548
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
1549
+ extension_tag: z.ZodNullable<z.ZodString>;
1550
+ }, z.core.$strip>>;
1551
+ start_time: z.ZodNumber;
1552
+ end_time: z.ZodNumber;
1553
+ title: z.ZodNullable<z.ZodString>;
1554
+ album_artist: z.ZodNullable<z.ZodString>;
1555
+ composer: z.ZodNullable<z.ZodString>;
1556
+ genre: z.ZodNullable<z.ZodString>;
1557
+ release_date: z.ZodNullable<z.ZodString>;
1558
+ track_number: z.ZodNullable<z.ZodInt>;
1559
+ track_total: z.ZodNullable<z.ZodInt>;
1560
+ disc_number: z.ZodNullable<z.ZodInt>;
1561
+ disc_total: z.ZodNullable<z.ZodInt>;
1562
+ lyrics: z.ZodNullable<z.ZodString>;
1563
+ rating: z.ZodNullable<z.ZodNumber>;
1564
+ bpm: z.ZodNullable<z.ZodInt>;
1565
+ comment: z.ZodNullable<z.ZodString>;
1566
+ grouping: z.ZodNullable<z.ZodString>;
1567
+ mcn: z.ZodNullable<z.ZodString>;
1568
+ isrc: z.ZodNullable<z.ZodString>;
1569
+ music_brainz_release_id: z.ZodNullable<z.ZodString>;
1570
+ music_brainz_recording_id: z.ZodNullable<z.ZodString>;
1571
+ }, z.core.$strip>;
1572
+
1573
+ export declare type IngestSongsLibrariesLibraryIdIngestSongsPostData = {
1574
+ body: BulkIngestSongs;
1575
+ path: {
1576
+ /**
1577
+ * Library Id
1578
+ */
1579
+ library_id: number;
1580
+ };
1581
+ query?: never;
1582
+ url: "/libraries/{library_id}/ingest/songs";
1583
+ };
1584
+
1585
+ export declare type IngestSongsLibrariesLibraryIdIngestSongsPostError = IngestSongsLibrariesLibraryIdIngestSongsPostErrors[keyof IngestSongsLibrariesLibraryIdIngestSongsPostErrors];
1586
+
1587
+ export declare type IngestSongsLibrariesLibraryIdIngestSongsPostErrors = {
1588
+ /**
1589
+ * Validation Error
1590
+ */
1591
+ 422: HttpValidationError;
1592
+ };
1593
+
1594
+ export declare type IngestSongsLibrariesLibraryIdIngestSongsPostResponse = IngestSongsLibrariesLibraryIdIngestSongsPostResponses[keyof IngestSongsLibrariesLibraryIdIngestSongsPostResponses];
1595
+
1596
+ export declare type IngestSongsLibrariesLibraryIdIngestSongsPostResponses = {
1597
+ /**
1598
+ * Response Ingest Songs Libraries Library Id Ingest Songs Post
1599
+ *
1600
+ * Successful Response
1601
+ */
1602
+ 200: Array<SongRead>;
1603
+ };
1604
+
1605
+ /**
1606
+ * IngestSource
1607
+ */
1608
+ export declare type IngestSource = {
1609
+ /**
1610
+ * Url
1611
+ */
1612
+ url: string;
1613
+ /**
1614
+ * Mime Type
1615
+ */
1616
+ mime_type: string | null;
1617
+ /**
1618
+ * Extension Manifest Id
1619
+ */
1620
+ extension_manifest_id: string | null;
1621
+ /**
1622
+ * Extension Tag
1623
+ */
1624
+ extension_tag: string | null;
1625
+ };
1626
+
1627
+ /**
1628
+ * IngestSource
1629
+ */
1630
+ export declare const IngestSourceSchema: z.ZodObject<{
1631
+ url: z.ZodString;
1632
+ mime_type: z.ZodNullable<z.ZodString>;
1633
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
1634
+ extension_tag: z.ZodNullable<z.ZodString>;
1635
+ }, z.core.$strip>;
1636
+
1637
+ export declare type InstallExtensionExtensionsAvailableExtensionIdInstallPostData = {
1638
+ body?: never;
1639
+ path: {
1640
+ /**
1641
+ * Extension Id
1642
+ */
1643
+ extension_id: number;
1644
+ };
1645
+ query?: never;
1646
+ url: "/extensions/available/{extension_id}/install";
1647
+ };
1648
+
1649
+ export declare type InstallExtensionExtensionsAvailableExtensionIdInstallPostError = InstallExtensionExtensionsAvailableExtensionIdInstallPostErrors[keyof InstallExtensionExtensionsAvailableExtensionIdInstallPostErrors];
1650
+
1651
+ export declare type InstallExtensionExtensionsAvailableExtensionIdInstallPostErrors = {
1652
+ /**
1653
+ * Validation Error
1654
+ */
1655
+ 422: HttpValidationError;
1656
+ };
1657
+
1658
+ export declare type InstallExtensionExtensionsAvailableExtensionIdInstallPostResponse = InstallExtensionExtensionsAvailableExtensionIdInstallPostResponses[keyof InstallExtensionExtensionsAvailableExtensionIdInstallPostResponses];
1659
+
1660
+ export declare type InstallExtensionExtensionsAvailableExtensionIdInstallPostResponses = {
1661
+ /**
1662
+ * Successful Response
1663
+ */
1664
+ 200: OperationResult;
1665
+ };
1666
+
1667
+ /**
1668
+ * InstanceStatusRead
1669
+ */
1670
+ export declare type InstanceStatusRead = {
1671
+ /**
1672
+ * Env
1673
+ */
1674
+ env: "dev" | "ci" | "prod";
1675
+ /**
1676
+ * Version
1677
+ */
1678
+ version: string;
1679
+ /**
1680
+ * Uploads Enabled
1681
+ */
1682
+ uploads_enabled: boolean;
1683
+ /**
1684
+ * Email Enabled
1685
+ */
1686
+ email_enabled: boolean;
1687
+ /**
1688
+ * First Setup Complete
1689
+ */
1690
+ first_setup_complete: boolean;
1691
+ };
1692
+
1693
+ /**
1694
+ * InstanceStatusRead
1695
+ */
1696
+ export declare const InstanceStatusReadSchema: z.ZodObject<{
1697
+ env: z.ZodEnum<{
1698
+ dev: "dev";
1699
+ ci: "ci";
1700
+ prod: "prod";
1701
+ }>;
1702
+ version: z.ZodString;
1703
+ uploads_enabled: z.ZodBoolean;
1704
+ email_enabled: z.ZodBoolean;
1705
+ first_setup_complete: z.ZodBoolean;
1706
+ }, z.core.$strip>;
1707
+
1708
+ /**
1709
+ * LibraryCreate
1710
+ */
1711
+ export declare type LibraryCreate = {
1712
+ /**
1713
+ * Name
1714
+ */
1715
+ name: string;
1716
+ /**
1717
+ * Home Path
1718
+ */
1719
+ home_path: string | null;
1720
+ /**
1721
+ * Uploads Enabled
1722
+ */
1723
+ uploads_enabled: boolean;
1724
+ cover_artwork: ArtworkRead | null;
1725
+ };
1726
+
1727
+ /**
1728
+ * LibraryCreate
1729
+ */
1730
+ export declare const LibraryCreateSchema: z.ZodObject<{
1731
+ name: z.ZodString;
1732
+ home_path: z.ZodNullable<z.ZodString>;
1733
+ uploads_enabled: z.ZodBoolean;
1734
+ cover_artwork: z.ZodNullable<z.ZodObject<{
1735
+ id: z.ZodInt;
1736
+ kind: z.ZodEnum<{
1737
+ front_cover: "front_cover";
1738
+ }>;
1739
+ image_url: z.ZodString;
1740
+ background_color: z.ZodNullable<z.ZodString>;
1741
+ primary_color: z.ZodNullable<z.ZodString>;
1742
+ secondary_color: z.ZodNullable<z.ZodString>;
1743
+ tertiary_color: z.ZodNullable<z.ZodString>;
1744
+ }, z.core.$strip>>;
1745
+ }, z.core.$strip>;
1746
+
1747
+ /**
1748
+ * LibraryHomePathRead
1749
+ */
1750
+ export declare type LibraryHomePathRead = {
1751
+ /**
1752
+ * Relative To
1753
+ */
1754
+ relative_to: string;
1755
+ /**
1756
+ * Subpaths
1757
+ */
1758
+ subpaths: Array<string>;
1759
+ };
1760
+
1761
+ /**
1762
+ * LibraryHomePathRead
1763
+ */
1764
+ export declare const LibraryHomePathReadSchema: z.ZodObject<{
1765
+ relative_to: z.ZodString;
1766
+ subpaths: z.ZodArray<z.ZodString>;
1767
+ }, z.core.$strip>;
1768
+
1769
+ /**
1770
+ * LibraryIgnoredResourceRead
1771
+ */
1772
+ export declare type LibraryIgnoredResourceRead = {
1773
+ /**
1774
+ * Id
1775
+ */
1776
+ id: number;
1777
+ /**
1778
+ * Url
1779
+ */
1780
+ url: string;
1781
+ };
1782
+
1783
+ /**
1784
+ * LibraryIgnoredResourceRead
1785
+ */
1786
+ export declare const LibraryIgnoredResourceReadSchema: z.ZodObject<{
1787
+ id: z.ZodInt;
1788
+ url: z.ZodString;
1789
+ }, z.core.$strip>;
1790
+
1791
+ /**
1792
+ * LibraryMediaRead[AlbumRead]
1793
+ */
1794
+ export declare type LibraryMediaReadAlbumRead = {
1795
+ /**
1796
+ * Items
1797
+ */
1798
+ items: Array<AlbumRead>;
1799
+ /**
1800
+ * Offset
1801
+ */
1802
+ offset: number;
1803
+ /**
1804
+ * Limit
1805
+ */
1806
+ limit: number;
1807
+ /**
1808
+ * Total
1809
+ */
1810
+ total: number;
1811
+ };
1812
+
1813
+ /**
1814
+ * LibraryMediaRead[AlbumRead]
1815
+ */
1816
+ export declare const LibraryMediaReadAlbumReadSchema: z.ZodObject<{
1817
+ items: z.ZodArray<z.ZodObject<{
1818
+ id: z.ZodInt;
1819
+ title: z.ZodString;
1820
+ artist_id: z.ZodNullable<z.ZodInt>;
1821
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
1822
+ id: z.ZodInt;
1823
+ kind: z.ZodEnum<{
1824
+ front_cover: "front_cover";
1825
+ }>;
1826
+ image_url: z.ZodString;
1827
+ background_color: z.ZodNullable<z.ZodString>;
1828
+ primary_color: z.ZodNullable<z.ZodString>;
1829
+ secondary_color: z.ZodNullable<z.ZodString>;
1830
+ tertiary_color: z.ZodNullable<z.ZodString>;
1831
+ }, z.core.$strip>>>;
1832
+ }, z.core.$strip>>;
1833
+ offset: z.ZodInt;
1834
+ limit: z.ZodInt;
1835
+ total: z.ZodInt;
1836
+ }, z.core.$strip>;
1837
+
1838
+ /**
1839
+ * LibraryMediaRead[ArtistRead]
1840
+ */
1841
+ export declare type LibraryMediaReadArtistRead = {
1842
+ /**
1843
+ * Items
1844
+ */
1845
+ items: Array<ArtistRead>;
1846
+ /**
1847
+ * Offset
1848
+ */
1849
+ offset: number;
1850
+ /**
1851
+ * Limit
1852
+ */
1853
+ limit: number;
1854
+ /**
1855
+ * Total
1856
+ */
1857
+ total: number;
1858
+ };
1859
+
1860
+ /**
1861
+ * LibraryMediaRead[ArtistRead]
1862
+ */
1863
+ export declare const LibraryMediaReadArtistReadSchema: z.ZodObject<{
1864
+ items: z.ZodArray<z.ZodObject<{
1865
+ id: z.ZodInt;
1866
+ name: z.ZodString;
1867
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
1868
+ id: z.ZodInt;
1869
+ kind: z.ZodEnum<{
1870
+ front_cover: "front_cover";
1871
+ }>;
1872
+ image_url: z.ZodString;
1873
+ background_color: z.ZodNullable<z.ZodString>;
1874
+ primary_color: z.ZodNullable<z.ZodString>;
1875
+ secondary_color: z.ZodNullable<z.ZodString>;
1876
+ tertiary_color: z.ZodNullable<z.ZodString>;
1877
+ }, z.core.$strip>>>;
1878
+ }, z.core.$strip>>;
1879
+ offset: z.ZodInt;
1880
+ limit: z.ZodInt;
1881
+ total: z.ZodInt;
1882
+ }, z.core.$strip>;
1883
+
1884
+ /**
1885
+ * LibraryMediaRead[ExtensionRead]
1886
+ */
1887
+ export declare type LibraryMediaReadExtensionRead = {
1888
+ /**
1889
+ * Items
1890
+ */
1891
+ items: Array<ExtensionRead>;
1892
+ /**
1893
+ * Offset
1894
+ */
1895
+ offset: number;
1896
+ /**
1897
+ * Limit
1898
+ */
1899
+ limit: number;
1900
+ /**
1901
+ * Total
1902
+ */
1903
+ total: number;
1904
+ };
1905
+
1906
+ /**
1907
+ * LibraryMediaRead[ExtensionRead]
1908
+ */
1909
+ export declare const LibraryMediaReadExtensionReadSchema: z.ZodObject<{
1910
+ items: z.ZodArray<z.ZodObject<{
1911
+ id: z.ZodInt;
1912
+ manifest: z.ZodObject<{
1913
+ name: z.ZodString;
1914
+ id: z.ZodString;
1915
+ version: z.ZodString;
1916
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1917
+ url: z.ZodString;
1918
+ icon_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1919
+ preferredWidth: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1920
+ preferredHeight: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1921
+ permissions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
1922
+ "run:background": "run:background";
1923
+ "run:eager": "run:eager";
1924
+ "commands:input:read": "commands:input:read";
1925
+ "commands:input:add": "commands:input:add";
1926
+ "commands:query": "commands:query";
1927
+ "commands:run": "commands:run";
1928
+ "libraries:read": "libraries:read";
1929
+ "libraries:write": "libraries:write";
1930
+ "playback:read": "playback:read";
1931
+ "playback:control": "playback:control";
1932
+ }>, z.ZodString]>>>>;
1933
+ sourceSchemes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
1934
+ commands: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
1935
+ id: z.ZodString;
1936
+ searchTerms: z.ZodString;
1937
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1938
+ highlightAvailability: z.ZodOptional<z.ZodBoolean>;
1939
+ }, z.core.$strip>>>>;
1940
+ searchCommand: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1941
+ requiredInputKinds: z.ZodArray<z.ZodString>;
1942
+ }, z.core.$strip>>>;
1943
+ }, z.core.$strip>;
1944
+ }, z.core.$strip>>;
1945
+ offset: z.ZodInt;
1946
+ limit: z.ZodInt;
1947
+ total: z.ZodInt;
1948
+ }, z.core.$strip>;
1949
+
1950
+ /**
1951
+ * LibraryMediaRead[LibraryIgnoredResourceRead]
1952
+ */
1953
+ export declare type LibraryMediaReadLibraryIgnoredResourceRead = {
1954
+ /**
1955
+ * Items
1956
+ */
1957
+ items: Array<LibraryIgnoredResourceRead>;
1958
+ /**
1959
+ * Offset
1960
+ */
1961
+ offset: number;
1962
+ /**
1963
+ * Limit
1964
+ */
1965
+ limit: number;
1966
+ /**
1967
+ * Total
1968
+ */
1969
+ total: number;
1970
+ };
1971
+
1972
+ /**
1973
+ * LibraryMediaRead[LibraryIgnoredResourceRead]
1974
+ */
1975
+ export declare const LibraryMediaReadLibraryIgnoredResourceReadSchema: z.ZodObject<{
1976
+ items: z.ZodArray<z.ZodObject<{
1977
+ id: z.ZodInt;
1978
+ url: z.ZodString;
1979
+ }, z.core.$strip>>;
1980
+ offset: z.ZodInt;
1981
+ limit: z.ZodInt;
1982
+ total: z.ZodInt;
1983
+ }, z.core.$strip>;
1984
+
1985
+ /**
1986
+ * LibraryMediaRead[SongRead]
1987
+ */
1988
+ export declare type LibraryMediaReadSongRead = {
1989
+ /**
1990
+ * Items
1991
+ */
1992
+ items: Array<SongRead>;
1993
+ /**
1994
+ * Offset
1995
+ */
1996
+ offset: number;
1997
+ /**
1998
+ * Limit
1999
+ */
2000
+ limit: number;
2001
+ /**
2002
+ * Total
2003
+ */
2004
+ total: number;
2005
+ };
2006
+
2007
+ /**
2008
+ * LibraryMediaRead[SongRead]
2009
+ */
2010
+ export declare const LibraryMediaReadSongReadSchema: z.ZodObject<{
2011
+ items: z.ZodArray<z.ZodObject<{
2012
+ id: z.ZodInt;
2013
+ artist_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2014
+ artist_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2015
+ album_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2016
+ album_title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2017
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
2018
+ id: z.ZodInt;
2019
+ kind: z.ZodEnum<{
2020
+ front_cover: "front_cover";
2021
+ }>;
2022
+ image_url: z.ZodString;
2023
+ background_color: z.ZodNullable<z.ZodString>;
2024
+ primary_color: z.ZodNullable<z.ZodString>;
2025
+ secondary_color: z.ZodNullable<z.ZodString>;
2026
+ tertiary_color: z.ZodNullable<z.ZodString>;
2027
+ }, z.core.$strip>>>;
2028
+ sources: z.ZodOptional<z.ZodArray<z.ZodObject<{
2029
+ id: z.ZodInt;
2030
+ url: z.ZodString;
2031
+ mime_type: z.ZodNullable<z.ZodString>;
2032
+ is_invalid: z.ZodBoolean;
2033
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
2034
+ extension_tag: z.ZodNullable<z.ZodString>;
2035
+ }, z.core.$strip>>>;
2036
+ start_time: z.ZodOptional<z.ZodNumber>;
2037
+ end_time: z.ZodNumber;
2038
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2039
+ album_artist: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2040
+ composer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2041
+ genre: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2042
+ release_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2043
+ track_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2044
+ track_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2045
+ disc_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2046
+ disc_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2047
+ lyrics: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2048
+ rating: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
2049
+ bpm: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2050
+ comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2051
+ grouping: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2052
+ mcn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2053
+ isrc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2054
+ music_brainz_release_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2055
+ music_brainz_recording_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2056
+ }, z.core.$strip>>;
2057
+ offset: z.ZodInt;
2058
+ limit: z.ZodInt;
2059
+ total: z.ZodInt;
2060
+ }, z.core.$strip>;
2061
+
2062
+ /**
2063
+ * LibraryMediaRead[SourceRead]
2064
+ */
2065
+ export declare type LibraryMediaReadSourceRead = {
2066
+ /**
2067
+ * Items
2068
+ */
2069
+ items: Array<SourceRead>;
2070
+ /**
2071
+ * Offset
2072
+ */
2073
+ offset: number;
2074
+ /**
2075
+ * Limit
2076
+ */
2077
+ limit: number;
2078
+ /**
2079
+ * Total
2080
+ */
2081
+ total: number;
2082
+ };
2083
+
2084
+ /**
2085
+ * LibraryMediaRead[SourceRead]
2086
+ */
2087
+ export declare const LibraryMediaReadSourceReadSchema: z.ZodObject<{
2088
+ items: z.ZodArray<z.ZodObject<{
2089
+ id: z.ZodInt;
2090
+ url: z.ZodString;
2091
+ mime_type: z.ZodNullable<z.ZodString>;
2092
+ is_invalid: z.ZodBoolean;
2093
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
2094
+ extension_tag: z.ZodNullable<z.ZodString>;
2095
+ }, z.core.$strip>>;
2096
+ offset: z.ZodInt;
2097
+ limit: z.ZodInt;
2098
+ total: z.ZodInt;
2099
+ }, z.core.$strip>;
2100
+
2101
+ /**
2102
+ * LibraryPermissionCreate
2103
+ */
2104
+ export declare type LibraryPermissionCreate = {
2105
+ /**
2106
+ * User Id
2107
+ */
2108
+ user_id: number;
2109
+ /**
2110
+ * Can Add
2111
+ */
2112
+ can_add: boolean;
2113
+ /**
2114
+ * Can Edit
2115
+ */
2116
+ can_edit: boolean;
2117
+ /**
2118
+ * Can Remove
2119
+ */
2120
+ can_remove: boolean;
2121
+ };
2122
+
2123
+ /**
2124
+ * LibraryPermissionCreate
2125
+ */
2126
+ export declare const LibraryPermissionCreateSchema: z.ZodObject<{
2127
+ user_id: z.ZodInt;
2128
+ can_add: z.ZodBoolean;
2129
+ can_edit: z.ZodBoolean;
2130
+ can_remove: z.ZodBoolean;
2131
+ }, z.core.$strip>;
2132
+
2133
+ /**
2134
+ * LibraryPermissionRead
2135
+ */
2136
+ export declare type LibraryPermissionRead = {
2137
+ /**
2138
+ * User Id
2139
+ */
2140
+ user_id: number;
2141
+ /**
2142
+ * Username
2143
+ */
2144
+ username: string;
2145
+ /**
2146
+ * Can Add
2147
+ */
2148
+ can_add: boolean;
2149
+ /**
2150
+ * Can Edit
2151
+ */
2152
+ can_edit: boolean;
2153
+ /**
2154
+ * Can Remove
2155
+ */
2156
+ can_remove: boolean;
2157
+ };
2158
+
2159
+ /**
2160
+ * LibraryPermissionRead
2161
+ */
2162
+ export declare const LibraryPermissionReadSchema: z.ZodObject<{
2163
+ user_id: z.ZodInt;
2164
+ username: z.ZodString;
2165
+ can_add: z.ZodBoolean;
2166
+ can_edit: z.ZodBoolean;
2167
+ can_remove: z.ZodBoolean;
2168
+ }, z.core.$strip>;
2169
+
2170
+ /**
2171
+ * LibraryPermissionUpdate
2172
+ */
2173
+ export declare type LibraryPermissionUpdate = {
2174
+ /**
2175
+ * Can Add
2176
+ */
2177
+ can_add?: boolean | null;
2178
+ /**
2179
+ * Can Edit
2180
+ */
2181
+ can_edit?: boolean | null;
2182
+ /**
2183
+ * Can Remove
2184
+ */
2185
+ can_remove?: boolean | null;
2186
+ };
2187
+
2188
+ /**
2189
+ * LibraryPermissionUpdate
2190
+ */
2191
+ export declare const LibraryPermissionUpdateSchema: z.ZodObject<{
2192
+ can_add: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
2193
+ can_edit: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
2194
+ can_remove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
2195
+ }, z.core.$strip>;
2196
+
2197
+ /**
2198
+ * LibraryRead
2199
+ */
2200
+ export declare type LibraryRead = {
2201
+ /**
2202
+ * Id
2203
+ */
2204
+ id: number;
2205
+ /**
2206
+ * Name
2207
+ */
2208
+ name: string;
2209
+ /**
2210
+ * Home Path
2211
+ */
2212
+ home_path: string | null;
2213
+ /**
2214
+ * Uploads Enabled
2215
+ */
2216
+ uploads_enabled: boolean;
2217
+ cover_artwork: ArtworkRead | null;
2218
+ };
2219
+
2220
+ /**
2221
+ * LibraryRead
2222
+ */
2223
+ export declare const LibraryReadSchema: z.ZodObject<{
2224
+ id: z.ZodInt;
2225
+ name: z.ZodString;
2226
+ home_path: z.ZodNullable<z.ZodString>;
2227
+ uploads_enabled: z.ZodBoolean;
2228
+ cover_artwork: z.ZodNullable<z.ZodObject<{
2229
+ id: z.ZodInt;
2230
+ kind: z.ZodEnum<{
2231
+ front_cover: "front_cover";
2232
+ }>;
2233
+ image_url: z.ZodString;
2234
+ background_color: z.ZodNullable<z.ZodString>;
2235
+ primary_color: z.ZodNullable<z.ZodString>;
2236
+ secondary_color: z.ZodNullable<z.ZodString>;
2237
+ tertiary_color: z.ZodNullable<z.ZodString>;
2238
+ }, z.core.$strip>>;
2239
+ }, z.core.$strip>;
2240
+
2241
+ /**
2242
+ * LibraryUpdate
2243
+ */
2244
+ export declare type LibraryUpdate = {
2245
+ /**
2246
+ * Name
2247
+ */
2248
+ name?: string | null;
2249
+ /**
2250
+ * Uploads Enabled
2251
+ */
2252
+ uploads_enabled?: boolean | null;
2253
+ cover_artwork?: ArtworkRead | null;
2254
+ };
2255
+
2256
+ /**
2257
+ * LibraryUpdate
2258
+ */
2259
+ export declare const LibraryUpdateSchema: z.ZodObject<{
2260
+ name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
2261
+ uploads_enabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
2262
+ cover_artwork: z.ZodOptional<z.ZodNullable<z.ZodObject<{
2263
+ id: z.ZodInt;
2264
+ kind: z.ZodEnum<{
2265
+ front_cover: "front_cover";
2266
+ }>;
2267
+ image_url: z.ZodString;
2268
+ background_color: z.ZodNullable<z.ZodString>;
2269
+ primary_color: z.ZodNullable<z.ZodString>;
2270
+ secondary_color: z.ZodNullable<z.ZodString>;
2271
+ tertiary_color: z.ZodNullable<z.ZodString>;
2272
+ }, z.core.$strip>>>;
2273
+ }, z.core.$strip>;
2274
+
2275
+ /** The maximum number of items to read per page. */
2276
+ export declare const LIMIT_MAX = 250;
2277
+
2278
+ export declare type MarkAllNotificationsReadUsersNotificationsMarkAllReadPostData = {
2279
+ body?: never;
2280
+ path?: never;
2281
+ query?: never;
2282
+ url: "/users/notifications/mark-all-read";
2283
+ };
2284
+
2285
+ export declare type MarkAllNotificationsReadUsersNotificationsMarkAllReadPostResponse = MarkAllNotificationsReadUsersNotificationsMarkAllReadPostResponses[keyof MarkAllNotificationsReadUsersNotificationsMarkAllReadPostResponses];
2286
+
2287
+ export declare type MarkAllNotificationsReadUsersNotificationsMarkAllReadPostResponses = {
2288
+ /**
2289
+ * Successful Response
2290
+ */
2291
+ 200: OperationResult;
2292
+ };
2293
+
2294
+ /**
2295
+ * NotificationRead
2296
+ */
2297
+ export declare type NotificationRead = {
2298
+ /**
2299
+ * Id
2300
+ */
2301
+ id: number;
2302
+ /**
2303
+ * Title
2304
+ */
2305
+ title: string;
2306
+ /**
2307
+ * Description
2308
+ */
2309
+ description: string | null;
2310
+ /**
2311
+ * Progress
2312
+ */
2313
+ progress: number | null;
2314
+ /**
2315
+ * Is Read
2316
+ */
2317
+ is_read: boolean;
2318
+ };
2319
+
2320
+ /**
2321
+ * NotificationRead
2322
+ */
2323
+ export declare const NotificationReadSchema: z.ZodObject<{
2324
+ id: z.ZodInt;
2325
+ title: z.ZodString;
2326
+ description: z.ZodNullable<z.ZodString>;
2327
+ progress: z.ZodNullable<z.ZodNumber>;
2328
+ is_read: z.ZodBoolean;
2329
+ }, z.core.$strip>;
2330
+
2331
+ /**
2332
+ * NotificationsRead
2333
+ */
2334
+ export declare type NotificationsRead = {
2335
+ /**
2336
+ * Items
2337
+ */
2338
+ items: Array<NotificationRead>;
2339
+ /**
2340
+ * Offset
2341
+ */
2342
+ offset: number;
2343
+ /**
2344
+ * Limit
2345
+ */
2346
+ limit: number;
2347
+ /**
2348
+ * Total
2349
+ */
2350
+ total: number;
2351
+ };
2352
+
2353
+ /**
2354
+ * NotificationsRead
2355
+ */
2356
+ export declare const NotificationsReadSchema: z.ZodObject<{
2357
+ items: z.ZodArray<z.ZodObject<{
2358
+ id: z.ZodInt;
2359
+ title: z.ZodString;
2360
+ description: z.ZodNullable<z.ZodString>;
2361
+ progress: z.ZodNullable<z.ZodNumber>;
2362
+ is_read: z.ZodBoolean;
2363
+ }, z.core.$strip>>;
2364
+ offset: z.ZodInt;
2365
+ limit: z.ZodInt;
2366
+ total: z.ZodInt;
2367
+ }, z.core.$strip>;
2368
+
2369
+ /**
2370
+ * NotificationUpdate
2371
+ */
2372
+ export declare type NotificationUpdate = {
2373
+ /**
2374
+ * Is Read
2375
+ */
2376
+ is_read?: boolean | null;
2377
+ };
2378
+
2379
+ /**
2380
+ * NotificationUpdate
2381
+ */
2382
+ export declare const NotificationUpdateSchema: z.ZodObject<{
2383
+ is_read: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
2384
+ }, z.core.$strip>;
2385
+
2386
+ /**
2387
+ * OAuth2Scope
2388
+ */
2389
+ export declare type OAuth2Scope = "profile" | "library:read" | "library:write" | "admin";
2390
+
2391
+ /**
2392
+ * OAuth2Scope
2393
+ */
2394
+ export declare const OAuth2ScopeSchema: z.ZodEnum<{
2395
+ profile: "profile";
2396
+ "library:read": "library:read";
2397
+ "library:write": "library:write";
2398
+ admin: "admin";
2399
+ }>;
2400
+
2401
+ /**
2402
+ * OperationResult
2403
+ */
2404
+ export declare type OperationResult = {
2405
+ /**
2406
+ * Message
2407
+ */
2408
+ message: string;
2409
+ /**
2410
+ * Row Count
2411
+ */
2412
+ row_count?: number | null;
2413
+ };
2414
+
2415
+ /**
2416
+ * OperationResult
2417
+ */
2418
+ export declare const OperationResultSchema: z.ZodObject<{
2419
+ message: z.ZodString;
2420
+ row_count: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
2421
+ }, z.core.$strip>;
2422
+
2423
+ /** The maximum length of a file path. */
2424
+ export declare const PATH_MAX_LENGTH = 2000;
2425
+
2426
+ /**
2427
+ * PlaybackEventIngestResult
2428
+ */
2429
+ export declare type PlaybackEventIngestResult = {
2430
+ /**
2431
+ * Accepted Count
2432
+ */
2433
+ accepted_count: number;
2434
+ /**
2435
+ * Rejected Events
2436
+ */
2437
+ rejected_events: Array<IngestPlaybackEvent>;
2438
+ };
2439
+
2440
+ /**
2441
+ * PlaybackEventIngestResult
2442
+ */
2443
+ export declare const PlaybackEventIngestResultSchema: z.ZodObject<{
2444
+ accepted_count: z.ZodInt;
2445
+ rejected_events: z.ZodArray<z.ZodObject<{
2446
+ recorded_at: z.ZodISODateTime;
2447
+ kind: z.ZodEnum<{
2448
+ play: "play";
2449
+ pause: "pause";
2450
+ stop: "stop";
2451
+ fast_forward: "fast_forward";
2452
+ rewind: "rewind";
2453
+ }>;
2454
+ song_id: z.ZodInt;
2455
+ start_time: z.ZodInt;
2456
+ end_time: z.ZodInt;
2457
+ }, z.core.$strip>>;
2458
+ }, z.core.$strip>;
2459
+
2460
+ /**
2461
+ * PlaybackEventKind
2462
+ */
2463
+ export declare type PlaybackEventKind = "play" | "pause" | "stop" | "fast_forward" | "rewind";
2464
+
2465
+ /**
2466
+ * PlaybackEventKind
2467
+ */
2468
+ export declare const PlaybackEventKindSchema: z.ZodEnum<{
2469
+ play: "play";
2470
+ pause: "pause";
2471
+ stop: "stop";
2472
+ fast_forward: "fast_forward";
2473
+ rewind: "rewind";
2474
+ }>;
2475
+
2476
+ export declare type ReadAllSourcesSourcesAllGetData = {
2477
+ body?: never;
2478
+ path?: never;
2479
+ query?: {
2480
+ /**
2481
+ * Offset
2482
+ *
2483
+ * The page offset to read from
2484
+ */
2485
+ offset?: number;
2486
+ /**
2487
+ * Limit
2488
+ *
2489
+ * How many items to read per page
2490
+ */
2491
+ limit?: number;
2492
+ /**
2493
+ * Library Id
2494
+ */
2495
+ library_id?: number | null;
2496
+ /**
2497
+ * Extension Manifest Id
2498
+ */
2499
+ extension_manifest_id?: string | null;
2500
+ /**
2501
+ * Extension Tags
2502
+ */
2503
+ extension_tags?: Array<string> | null;
2504
+ };
2505
+ url: "/sources/all";
2506
+ };
2507
+
2508
+ export declare type ReadAllSourcesSourcesAllGetError = ReadAllSourcesSourcesAllGetErrors[keyof ReadAllSourcesSourcesAllGetErrors];
2509
+
2510
+ export declare type ReadAllSourcesSourcesAllGetErrors = {
2511
+ /**
2512
+ * Validation Error
2513
+ */
2514
+ 422: HttpValidationError;
2515
+ };
2516
+
2517
+ export declare type ReadAllSourcesSourcesAllGetResponse = ReadAllSourcesSourcesAllGetResponses[keyof ReadAllSourcesSourcesAllGetResponses];
2518
+
2519
+ export declare type ReadAllSourcesSourcesAllGetResponses = {
2520
+ /**
2521
+ * Successful Response
2522
+ */
2523
+ 200: LibraryMediaReadSourceRead;
2524
+ };
2525
+
2526
+ export declare type ReadArtworkImageArtworksArtworkIdImageGetData = {
2527
+ body?: never;
2528
+ path: {
2529
+ /**
2530
+ * Artwork Id
2531
+ */
2532
+ artwork_id: number;
2533
+ };
2534
+ query: {
2535
+ /**
2536
+ * Token
2537
+ *
2538
+ * A feature token
2539
+ */
2540
+ token: string;
2541
+ };
2542
+ url: "/artworks/{artwork_id}/image";
2543
+ };
2544
+
2545
+ export declare type ReadArtworkImageArtworksArtworkIdImageGetError = ReadArtworkImageArtworksArtworkIdImageGetErrors[keyof ReadArtworkImageArtworksArtworkIdImageGetErrors];
2546
+
2547
+ export declare type ReadArtworkImageArtworksArtworkIdImageGetErrors = {
2548
+ /**
2549
+ * Validation Error
2550
+ */
2551
+ 422: HttpValidationError;
2552
+ };
2553
+
2554
+ export declare type ReadArtworkImageArtworksArtworkIdImageGetResponses = {
2555
+ /**
2556
+ * Successful Response
2557
+ */
2558
+ 200: unknown;
2559
+ };
2560
+
2561
+ export declare type ReadAvailableExtensionsExtensionsAvailableGetData = {
2562
+ body?: never;
2563
+ path?: never;
2564
+ query?: {
2565
+ /**
2566
+ * Offset
2567
+ *
2568
+ * The page offset to read from
2569
+ */
2570
+ offset?: number;
2571
+ /**
2572
+ * Limit
2573
+ *
2574
+ * How many items to read per page
2575
+ */
2576
+ limit?: number;
2577
+ };
2578
+ url: "/extensions/available";
2579
+ };
2580
+
2581
+ export declare type ReadAvailableExtensionsExtensionsAvailableGetError = ReadAvailableExtensionsExtensionsAvailableGetErrors[keyof ReadAvailableExtensionsExtensionsAvailableGetErrors];
2582
+
2583
+ export declare type ReadAvailableExtensionsExtensionsAvailableGetErrors = {
2584
+ /**
2585
+ * Validation Error
2586
+ */
2587
+ 422: HttpValidationError;
2588
+ };
2589
+
2590
+ export declare type ReadAvailableExtensionsExtensionsAvailableGetResponse = ReadAvailableExtensionsExtensionsAvailableGetResponses[keyof ReadAvailableExtensionsExtensionsAvailableGetResponses];
2591
+
2592
+ export declare type ReadAvailableExtensionsExtensionsAvailableGetResponses = {
2593
+ /**
2594
+ * Successful Response
2595
+ */
2596
+ 200: LibraryMediaReadExtensionRead;
2597
+ };
2598
+
2599
+ export declare type ReadFilesPreflightUsersFilesPreflightPostData = {
2600
+ body?: never;
2601
+ path?: never;
2602
+ query?: never;
2603
+ url: "/users/files/preflight";
2604
+ };
2605
+
2606
+ export declare type ReadFilesPreflightUsersFilesPreflightPostResponse = ReadFilesPreflightUsersFilesPreflightPostResponses[keyof ReadFilesPreflightUsersFilesPreflightPostResponses];
2607
+
2608
+ export declare type ReadFilesPreflightUsersFilesPreflightPostResponses = {
2609
+ /**
2610
+ * Successful Response
2611
+ */
2612
+ 200: UserFileAccessPreflight;
2613
+ };
2614
+
2615
+ export declare type ReadInstalledExtensionsExtensionsInstalledGetData = {
2616
+ body?: never;
2617
+ path?: never;
2618
+ query?: {
2619
+ /**
2620
+ * Offset
2621
+ *
2622
+ * The page offset to read from
2623
+ */
2624
+ offset?: number;
2625
+ /**
2626
+ * Limit
2627
+ *
2628
+ * How many items to read per page
2629
+ */
2630
+ limit?: number;
2631
+ };
2632
+ url: "/extensions/installed";
2633
+ };
2634
+
2635
+ export declare type ReadInstalledExtensionsExtensionsInstalledGetError = ReadInstalledExtensionsExtensionsInstalledGetErrors[keyof ReadInstalledExtensionsExtensionsInstalledGetErrors];
2636
+
2637
+ export declare type ReadInstalledExtensionsExtensionsInstalledGetErrors = {
2638
+ /**
2639
+ * Validation Error
2640
+ */
2641
+ 422: HttpValidationError;
2642
+ };
2643
+
2644
+ export declare type ReadInstalledExtensionsExtensionsInstalledGetResponse = ReadInstalledExtensionsExtensionsInstalledGetResponses[keyof ReadInstalledExtensionsExtensionsInstalledGetResponses];
2645
+
2646
+ export declare type ReadInstalledExtensionsExtensionsInstalledGetResponses = {
2647
+ /**
2648
+ * Successful Response
2649
+ */
2650
+ 200: LibraryMediaReadExtensionRead;
2651
+ };
2652
+
2653
+ export declare type ReadInstanceStatusStatusGetData = {
2654
+ body?: never;
2655
+ path?: never;
2656
+ query?: never;
2657
+ url: "/status";
2658
+ };
2659
+
2660
+ export declare type ReadInstanceStatusStatusGetResponse = ReadInstanceStatusStatusGetResponses[keyof ReadInstanceStatusStatusGetResponses];
2661
+
2662
+ export declare type ReadInstanceStatusStatusGetResponses = {
2663
+ /**
2664
+ * Successful Response
2665
+ */
2666
+ 200: InstanceStatusRead;
2667
+ };
2668
+
2669
+ export declare type ReadLibrariesLibrariesGetData = {
2670
+ body?: never;
2671
+ path?: never;
2672
+ query?: never;
2673
+ url: "/libraries/";
2674
+ };
2675
+
2676
+ export declare type ReadLibrariesLibrariesGetResponse = ReadLibrariesLibrariesGetResponses[keyof ReadLibrariesLibrariesGetResponses];
2677
+
2678
+ export declare type ReadLibrariesLibrariesGetResponses = {
2679
+ /**
2680
+ * Response Read Libraries Libraries Get
2681
+ *
2682
+ * Successful Response
2683
+ */
2684
+ 200: Array<LibraryRead>;
2685
+ };
2686
+
2687
+ export declare type ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetData = {
2688
+ body?: never;
2689
+ path: {
2690
+ /**
2691
+ * Library Id
2692
+ */
2693
+ library_id: number;
2694
+ /**
2695
+ * Album Id
2696
+ */
2697
+ album_id: number;
2698
+ };
2699
+ query?: never;
2700
+ url: "/libraries/{library_id}/albums/{album_id}";
2701
+ };
2702
+
2703
+ export declare type ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetError = ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetErrors[keyof ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetErrors];
2704
+
2705
+ export declare type ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetErrors = {
2706
+ /**
2707
+ * Validation Error
2708
+ */
2709
+ 422: HttpValidationError;
2710
+ };
2711
+
2712
+ export declare type ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetResponse = ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetResponses[keyof ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetResponses];
2713
+
2714
+ export declare type ReadLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdGetResponses = {
2715
+ /**
2716
+ * Successful Response
2717
+ */
2718
+ 200: AlbumRead;
2719
+ };
2720
+
2721
+ export declare type ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetData = {
2722
+ body?: never;
2723
+ path: {
2724
+ /**
2725
+ * Library Id
2726
+ */
2727
+ library_id: number;
2728
+ };
2729
+ query?: {
2730
+ /**
2731
+ * Offset
2732
+ *
2733
+ * The page offset to read from
2734
+ */
2735
+ offset?: number;
2736
+ /**
2737
+ * Limit
2738
+ *
2739
+ * How many items to read per page
2740
+ */
2741
+ limit?: number;
2742
+ /**
2743
+ * Query
2744
+ *
2745
+ * Query string to filter the albums by
2746
+ */
2747
+ query?: string | null;
2748
+ /**
2749
+ * Artist Id
2750
+ *
2751
+ * ID of the artist to filter the songs by
2752
+ */
2753
+ artist_id?: number | null;
2754
+ };
2755
+ url: "/libraries/{library_id}/albums";
2756
+ };
2757
+
2758
+ export declare type ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetError = ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetErrors[keyof ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetErrors];
2759
+
2760
+ export declare type ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetErrors = {
2761
+ /**
2762
+ * Validation Error
2763
+ */
2764
+ 422: HttpValidationError;
2765
+ };
2766
+
2767
+ export declare type ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetResponse = ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetResponses[keyof ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetResponses];
2768
+
2769
+ export declare type ReadLibraryAlbumsLibrariesLibraryIdAlbumsGetResponses = {
2770
+ /**
2771
+ * Successful Response
2772
+ */
2773
+ 200: LibraryMediaReadAlbumRead;
2774
+ };
2775
+
2776
+ export declare type ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetData = {
2777
+ body?: never;
2778
+ path: {
2779
+ /**
2780
+ * Library Id
2781
+ */
2782
+ library_id: number;
2783
+ /**
2784
+ * Artist Id
2785
+ */
2786
+ artist_id: number;
2787
+ };
2788
+ query?: never;
2789
+ url: "/libraries/{library_id}/artists/{artist_id}";
2790
+ };
2791
+
2792
+ export declare type ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetError = ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetErrors[keyof ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetErrors];
2793
+
2794
+ export declare type ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetErrors = {
2795
+ /**
2796
+ * Validation Error
2797
+ */
2798
+ 422: HttpValidationError;
2799
+ };
2800
+
2801
+ export declare type ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetResponse = ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetResponses[keyof ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetResponses];
2802
+
2803
+ export declare type ReadLibraryArtistLibrariesLibraryIdArtistsArtistIdGetResponses = {
2804
+ /**
2805
+ * Successful Response
2806
+ */
2807
+ 200: ArtistRead;
2808
+ };
2809
+
2810
+ export declare type ReadLibraryArtistsLibrariesLibraryIdArtistsGetData = {
2811
+ body?: never;
2812
+ path: {
2813
+ /**
2814
+ * Library Id
2815
+ */
2816
+ library_id: number;
2817
+ };
2818
+ query?: {
2819
+ /**
2820
+ * Offset
2821
+ *
2822
+ * The page offset to read from
2823
+ */
2824
+ offset?: number;
2825
+ /**
2826
+ * Limit
2827
+ *
2828
+ * How many items to read per page
2829
+ */
2830
+ limit?: number;
2831
+ /**
2832
+ * Query
2833
+ *
2834
+ * Query string to filter the artists by
2835
+ */
2836
+ query?: string | null;
2837
+ };
2838
+ url: "/libraries/{library_id}/artists";
2839
+ };
2840
+
2841
+ export declare type ReadLibraryArtistsLibrariesLibraryIdArtistsGetError = ReadLibraryArtistsLibrariesLibraryIdArtistsGetErrors[keyof ReadLibraryArtistsLibrariesLibraryIdArtistsGetErrors];
2842
+
2843
+ export declare type ReadLibraryArtistsLibrariesLibraryIdArtistsGetErrors = {
2844
+ /**
2845
+ * Validation Error
2846
+ */
2847
+ 422: HttpValidationError;
2848
+ };
2849
+
2850
+ export declare type ReadLibraryArtistsLibrariesLibraryIdArtistsGetResponse = ReadLibraryArtistsLibrariesLibraryIdArtistsGetResponses[keyof ReadLibraryArtistsLibrariesLibraryIdArtistsGetResponses];
2851
+
2852
+ export declare type ReadLibraryArtistsLibrariesLibraryIdArtistsGetResponses = {
2853
+ /**
2854
+ * Successful Response
2855
+ */
2856
+ 200: LibraryMediaReadArtistRead;
2857
+ };
2858
+
2859
+ export declare type ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetData = {
2860
+ body?: never;
2861
+ path?: never;
2862
+ query: {
2863
+ /**
2864
+ * Relative To
2865
+ */
2866
+ relative_to: string;
2867
+ };
2868
+ url: "/libraries/home-subpaths";
2869
+ };
2870
+
2871
+ export declare type ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetError = ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetErrors[keyof ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetErrors];
2872
+
2873
+ export declare type ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetErrors = {
2874
+ /**
2875
+ * Validation Error
2876
+ */
2877
+ 422: HttpValidationError;
2878
+ };
2879
+
2880
+ export declare type ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetResponse = ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetResponses[keyof ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetResponses];
2881
+
2882
+ export declare type ReadLibraryHomeSubpathsLibrariesHomeSubpathsGetResponses = {
2883
+ /**
2884
+ * Successful Response
2885
+ */
2886
+ 200: LibraryHomePathRead;
2887
+ };
2888
+
2889
+ export declare type ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetData = {
2890
+ body?: never;
2891
+ path: {
2892
+ /**
2893
+ * Library Id
2894
+ */
2895
+ library_id: number;
2896
+ };
2897
+ query?: {
2898
+ /**
2899
+ * Offset
2900
+ */
2901
+ offset?: number;
2902
+ /**
2903
+ * Limit
2904
+ */
2905
+ limit?: number;
2906
+ };
2907
+ url: "/libraries/{library_id}/ignored";
2908
+ };
2909
+
2910
+ export declare type ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetError = ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetErrors[keyof ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetErrors];
2911
+
2912
+ export declare type ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetErrors = {
2913
+ /**
2914
+ * Validation Error
2915
+ */
2916
+ 422: HttpValidationError;
2917
+ };
2918
+
2919
+ export declare type ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetResponse = ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetResponses[keyof ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetResponses];
2920
+
2921
+ export declare type ReadLibraryIgnoredResourcesLibrariesLibraryIdIgnoredGetResponses = {
2922
+ /**
2923
+ * Successful Response
2924
+ */
2925
+ 200: LibraryMediaReadLibraryIgnoredResourceRead;
2926
+ };
2927
+
2928
+ export declare type ReadLibraryLibrariesLibraryIdGetData = {
2929
+ body?: never;
2930
+ path: {
2931
+ /**
2932
+ * Library Id
2933
+ */
2934
+ library_id: number;
2935
+ };
2936
+ query?: never;
2937
+ url: "/libraries/{library_id}";
2938
+ };
2939
+
2940
+ export declare type ReadLibraryLibrariesLibraryIdGetError = ReadLibraryLibrariesLibraryIdGetErrors[keyof ReadLibraryLibrariesLibraryIdGetErrors];
2941
+
2942
+ export declare type ReadLibraryLibrariesLibraryIdGetErrors = {
2943
+ /**
2944
+ * Validation Error
2945
+ */
2946
+ 422: HttpValidationError;
2947
+ };
2948
+
2949
+ export declare type ReadLibraryLibrariesLibraryIdGetResponse = ReadLibraryLibrariesLibraryIdGetResponses[keyof ReadLibraryLibrariesLibraryIdGetResponses];
2950
+
2951
+ export declare type ReadLibraryLibrariesLibraryIdGetResponses = {
2952
+ /**
2953
+ * Successful Response
2954
+ */
2955
+ 200: LibraryRead;
2956
+ };
2957
+
2958
+ export declare type ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetData = {
2959
+ body?: never;
2960
+ path: {
2961
+ /**
2962
+ * Library Id
2963
+ */
2964
+ library_id: number;
2965
+ };
2966
+ query?: never;
2967
+ url: "/libraries/{library_id}/permissions";
2968
+ };
2969
+
2970
+ export declare type ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetError = ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetErrors[keyof ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetErrors];
2971
+
2972
+ export declare type ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetErrors = {
2973
+ /**
2974
+ * Validation Error
2975
+ */
2976
+ 422: HttpValidationError;
2977
+ };
2978
+
2979
+ export declare type ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetResponse = ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetResponses[keyof ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetResponses];
2980
+
2981
+ export declare type ReadLibraryPermissionsLibrariesLibraryIdPermissionsGetResponses = {
2982
+ /**
2983
+ * Response Read Library Permissions Libraries Library Id Permissions Get
2984
+ *
2985
+ * Successful Response
2986
+ */
2987
+ 200: Array<LibraryPermissionRead>;
2988
+ };
2989
+
2990
+ export declare type ReadLibrarySongLibrariesLibraryIdSongsSongIdGetData = {
2991
+ body?: never;
2992
+ path: {
2993
+ /**
2994
+ * Library Id
2995
+ */
2996
+ library_id: number;
2997
+ /**
2998
+ * Song Id
2999
+ */
3000
+ song_id: number;
3001
+ };
3002
+ query?: never;
3003
+ url: "/libraries/{library_id}/songs/{song_id}";
3004
+ };
3005
+
3006
+ export declare type ReadLibrarySongLibrariesLibraryIdSongsSongIdGetError = ReadLibrarySongLibrariesLibraryIdSongsSongIdGetErrors[keyof ReadLibrarySongLibrariesLibraryIdSongsSongIdGetErrors];
3007
+
3008
+ export declare type ReadLibrarySongLibrariesLibraryIdSongsSongIdGetErrors = {
3009
+ /**
3010
+ * Validation Error
3011
+ */
3012
+ 422: HttpValidationError;
3013
+ };
3014
+
3015
+ export declare type ReadLibrarySongLibrariesLibraryIdSongsSongIdGetResponse = ReadLibrarySongLibrariesLibraryIdSongsSongIdGetResponses[keyof ReadLibrarySongLibrariesLibraryIdSongsSongIdGetResponses];
3016
+
3017
+ export declare type ReadLibrarySongLibrariesLibraryIdSongsSongIdGetResponses = {
3018
+ /**
3019
+ * Successful Response
3020
+ */
3021
+ 200: SongRead;
3022
+ };
3023
+
3024
+ export declare type ReadLibrarySongsLibrariesLibraryIdSongsGetData = {
3025
+ body?: never;
3026
+ path: {
3027
+ /**
3028
+ * Library Id
3029
+ */
3030
+ library_id: number;
3031
+ };
3032
+ query?: {
3033
+ /**
3034
+ * Offset
3035
+ *
3036
+ * The page offset to read from
3037
+ */
3038
+ offset?: number;
3039
+ /**
3040
+ * Limit
3041
+ *
3042
+ * How many items to read per page
3043
+ */
3044
+ limit?: number;
3045
+ /**
3046
+ * Query
3047
+ *
3048
+ * Query string to filter the songs by
3049
+ */
3050
+ query?: string | null;
3051
+ /**
3052
+ * Album Id
3053
+ *
3054
+ * ID of the album to filter the songs by
3055
+ */
3056
+ album_id?: number | null;
3057
+ /**
3058
+ * Artist Id
3059
+ *
3060
+ * ID of the artist to filter the songs by
3061
+ */
3062
+ artist_id?: number | null;
3063
+ /**
3064
+ * Sort By
3065
+ *
3066
+ * How to sort the items
3067
+ */
3068
+ sort_by?: Array<"+artist_name" | "-artist_name" | "+album_title" | "-album_title" | "+title" | "-title" | "+album_artist" | "-album_artist" | "+composer" | "-composer" | "+genre" | "-genre" | "+release_date" | "-release_date" | "+track_number" | "-track_number" | "+track_total" | "-track_total" | "+disc_number" | "-disc_number" | "+disc_total" | "-disc_total" | "+rating" | "-rating" | "+bpm" | "-bpm" | "+grouping" | "-grouping">;
3069
+ };
3070
+ url: "/libraries/{library_id}/songs";
3071
+ };
3072
+
3073
+ export declare type ReadLibrarySongsLibrariesLibraryIdSongsGetError = ReadLibrarySongsLibrariesLibraryIdSongsGetErrors[keyof ReadLibrarySongsLibrariesLibraryIdSongsGetErrors];
3074
+
3075
+ export declare type ReadLibrarySongsLibrariesLibraryIdSongsGetErrors = {
3076
+ /**
3077
+ * Validation Error
3078
+ */
3079
+ 422: HttpValidationError;
3080
+ };
3081
+
3082
+ export declare type ReadLibrarySongsLibrariesLibraryIdSongsGetResponse = ReadLibrarySongsLibrariesLibraryIdSongsGetResponses[keyof ReadLibrarySongsLibrariesLibraryIdSongsGetResponses];
3083
+
3084
+ export declare type ReadLibrarySongsLibrariesLibraryIdSongsGetResponses = {
3085
+ /**
3086
+ * Successful Response
3087
+ */
3088
+ 200: LibraryMediaReadSongRead;
3089
+ };
3090
+
3091
+ export declare type ReadLibrarySongsSortBy = NonNullable<ReadLibrarySongsLibrariesLibraryIdSongsGetData["query"]>["sort_by"];
3092
+
3093
+ export declare type ReadMeUsersMeGetData = {
3094
+ body?: never;
3095
+ path?: never;
3096
+ query?: never;
3097
+ url: "/users/me";
3098
+ };
3099
+
3100
+ export declare type ReadMeUsersMeGetResponse = ReadMeUsersMeGetResponses[keyof ReadMeUsersMeGetResponses];
3101
+
3102
+ export declare type ReadMeUsersMeGetResponses = {
3103
+ /**
3104
+ * Successful Response
3105
+ */
3106
+ 200: UserProfileMeRead;
3107
+ };
3108
+
3109
+ export declare type ReadNotificationsUsersNotificationsGetData = {
3110
+ body?: never;
3111
+ path?: never;
3112
+ query?: {
3113
+ /**
3114
+ * Offset
3115
+ *
3116
+ * The page offset to read from
3117
+ */
3118
+ offset?: number;
3119
+ /**
3120
+ * Limit
3121
+ *
3122
+ * How many items to read per page
3123
+ */
3124
+ limit?: number;
3125
+ };
3126
+ url: "/users/notifications";
3127
+ };
3128
+
3129
+ export declare type ReadNotificationsUsersNotificationsGetError = ReadNotificationsUsersNotificationsGetErrors[keyof ReadNotificationsUsersNotificationsGetErrors];
3130
+
3131
+ export declare type ReadNotificationsUsersNotificationsGetErrors = {
3132
+ /**
3133
+ * Validation Error
3134
+ */
3135
+ 422: HttpValidationError;
3136
+ };
3137
+
3138
+ export declare type ReadNotificationsUsersNotificationsGetResponse = ReadNotificationsUsersNotificationsGetResponses[keyof ReadNotificationsUsersNotificationsGetResponses];
3139
+
3140
+ export declare type ReadNotificationsUsersNotificationsGetResponses = {
3141
+ /**
3142
+ * Successful Response
3143
+ */
3144
+ 200: NotificationsRead;
3145
+ };
3146
+
3147
+ export declare type ReadNotificationUsersNotificationsNotificationIdGetData = {
3148
+ body?: never;
3149
+ path: {
3150
+ /**
3151
+ * Notification Id
3152
+ */
3153
+ notification_id: number;
3154
+ };
3155
+ query?: never;
3156
+ url: "/users/notifications/{notification_id}";
3157
+ };
3158
+
3159
+ export declare type ReadNotificationUsersNotificationsNotificationIdGetError = ReadNotificationUsersNotificationsNotificationIdGetErrors[keyof ReadNotificationUsersNotificationsNotificationIdGetErrors];
3160
+
3161
+ export declare type ReadNotificationUsersNotificationsNotificationIdGetErrors = {
3162
+ /**
3163
+ * Validation Error
3164
+ */
3165
+ 422: HttpValidationError;
3166
+ };
3167
+
3168
+ export declare type ReadNotificationUsersNotificationsNotificationIdGetResponse = ReadNotificationUsersNotificationsNotificationIdGetResponses[keyof ReadNotificationUsersNotificationsNotificationIdGetResponses];
3169
+
3170
+ export declare type ReadNotificationUsersNotificationsNotificationIdGetResponses = {
3171
+ /**
3172
+ * Successful Response
3173
+ */
3174
+ 200: NotificationRead;
3175
+ };
3176
+
3177
+ export declare type ReadSourceChangesSourcesChangesGetData = {
3178
+ body?: never;
3179
+ path?: never;
3180
+ query: {
3181
+ /**
3182
+ * Since
3183
+ */
3184
+ since: string;
3185
+ /**
3186
+ * Ids
3187
+ */
3188
+ ids?: Array<number> | null;
3189
+ };
3190
+ url: "/sources/changes";
3191
+ };
3192
+
3193
+ export declare type ReadSourceChangesSourcesChangesGetError = ReadSourceChangesSourcesChangesGetErrors[keyof ReadSourceChangesSourcesChangesGetErrors];
3194
+
3195
+ export declare type ReadSourceChangesSourcesChangesGetErrors = {
3196
+ /**
3197
+ * Validation Error
3198
+ */
3199
+ 422: HttpValidationError;
3200
+ };
3201
+
3202
+ export declare type ReadSourceChangesSourcesChangesGetResponse = ReadSourceChangesSourcesChangesGetResponses[keyof ReadSourceChangesSourcesChangesGetResponses];
3203
+
3204
+ export declare type ReadSourceChangesSourcesChangesGetResponses = {
3205
+ /**
3206
+ * Successful Response
3207
+ */
3208
+ 200: SourceChangesRead;
3209
+ };
3210
+
3211
+ export declare type ReadSourceSourcesSourceIdGetData = {
3212
+ body?: never;
3213
+ path: {
3214
+ /**
3215
+ * Source Id
3216
+ */
3217
+ source_id: number;
3218
+ };
3219
+ query?: never;
3220
+ url: "/sources/{source_id}";
3221
+ };
3222
+
3223
+ export declare type ReadSourceSourcesSourceIdGetError = ReadSourceSourcesSourceIdGetErrors[keyof ReadSourceSourcesSourceIdGetErrors];
3224
+
3225
+ export declare type ReadSourceSourcesSourceIdGetErrors = {
3226
+ /**
3227
+ * Validation Error
3228
+ */
3229
+ 422: HttpValidationError;
3230
+ };
3231
+
3232
+ export declare type ReadSourceSourcesSourceIdGetResponse = ReadSourceSourcesSourceIdGetResponses[keyof ReadSourceSourcesSourceIdGetResponses];
3233
+
3234
+ export declare type ReadSourceSourcesSourceIdGetResponses = {
3235
+ /**
3236
+ * Successful Response
3237
+ */
3238
+ 200: SourceRead;
3239
+ };
3240
+
3241
+ export declare type ReadUserAdminUsersAdminAllIdOrUsernameGetData = {
3242
+ body?: never;
3243
+ path: {
3244
+ /**
3245
+ * Id Or Username
3246
+ */
3247
+ id_or_username: string;
3248
+ };
3249
+ query?: never;
3250
+ url: "/users/admin/all/{id_or_username}";
3251
+ };
3252
+
3253
+ export declare type ReadUserAdminUsersAdminAllIdOrUsernameGetError = ReadUserAdminUsersAdminAllIdOrUsernameGetErrors[keyof ReadUserAdminUsersAdminAllIdOrUsernameGetErrors];
3254
+
3255
+ export declare type ReadUserAdminUsersAdminAllIdOrUsernameGetErrors = {
3256
+ /**
3257
+ * Validation Error
3258
+ */
3259
+ 422: HttpValidationError;
3260
+ };
3261
+
3262
+ export declare type ReadUserAdminUsersAdminAllIdOrUsernameGetResponse = ReadUserAdminUsersAdminAllIdOrUsernameGetResponses[keyof ReadUserAdminUsersAdminAllIdOrUsernameGetResponses];
3263
+
3264
+ export declare type ReadUserAdminUsersAdminAllIdOrUsernameGetResponses = {
3265
+ /**
3266
+ * Successful Response
3267
+ */
3268
+ 200: UserAdminRead;
3269
+ };
3270
+
3271
+ export declare type ReadUsersAdminUsersAdminAllGetData = {
3272
+ body?: never;
3273
+ path?: never;
3274
+ query?: {
3275
+ /**
3276
+ * Offset
3277
+ *
3278
+ * The page offset to read from
3279
+ */
3280
+ offset?: number;
3281
+ /**
3282
+ * Limit
3283
+ *
3284
+ * How many items to read per page
3285
+ */
3286
+ limit?: number;
3287
+ /**
3288
+ * Query
3289
+ *
3290
+ * Query string to filter the users by
3291
+ */
3292
+ query?: string | null;
3293
+ };
3294
+ url: "/users/admin/all";
3295
+ };
3296
+
3297
+ export declare type ReadUsersAdminUsersAdminAllGetError = ReadUsersAdminUsersAdminAllGetErrors[keyof ReadUsersAdminUsersAdminAllGetErrors];
3298
+
3299
+ export declare type ReadUsersAdminUsersAdminAllGetErrors = {
3300
+ /**
3301
+ * Validation Error
3302
+ */
3303
+ 422: HttpValidationError;
3304
+ };
3305
+
3306
+ export declare type ReadUsersAdminUsersAdminAllGetResponse = ReadUsersAdminUsersAdminAllGetResponses[keyof ReadUsersAdminUsersAdminAllGetResponses];
3307
+
3308
+ export declare type ReadUsersAdminUsersAdminAllGetResponses = {
3309
+ /**
3310
+ * Successful Response
3311
+ */
3312
+ 200: UserAdminsRead;
3313
+ };
3314
+
3315
+ export declare type ReadUsersUsersAllGetData = {
3316
+ body?: never;
3317
+ path?: never;
3318
+ query?: {
3319
+ /**
3320
+ * Offset
3321
+ *
3322
+ * The page offset to read from
3323
+ */
3324
+ offset?: number;
3325
+ /**
3326
+ * Limit
3327
+ *
3328
+ * How many items to read per page
3329
+ */
3330
+ limit?: number;
3331
+ /**
3332
+ * Query
3333
+ *
3334
+ * Query string to filter the users by
3335
+ */
3336
+ query?: string | null;
3337
+ };
3338
+ url: "/users/all";
3339
+ };
3340
+
3341
+ export declare type ReadUsersUsersAllGetError = ReadUsersUsersAllGetErrors[keyof ReadUsersUsersAllGetErrors];
3342
+
3343
+ export declare type ReadUsersUsersAllGetErrors = {
3344
+ /**
3345
+ * Validation Error
3346
+ */
3347
+ 422: HttpValidationError;
3348
+ };
3349
+
3350
+ export declare type ReadUsersUsersAllGetResponse = ReadUsersUsersAllGetResponses[keyof ReadUsersUsersAllGetResponses];
3351
+
3352
+ export declare type ReadUsersUsersAllGetResponses = {
3353
+ /**
3354
+ * Successful Response
3355
+ */
3356
+ 200: UserProfilesRead;
3357
+ };
3358
+
3359
+ export declare type ReadUserUsersAllIdOrUsernameGetData = {
3360
+ body?: never;
3361
+ path: {
3362
+ /**
3363
+ * Id Or Username
3364
+ */
3365
+ id_or_username: string;
3366
+ };
3367
+ query?: never;
3368
+ url: "/users/all/{id_or_username}";
3369
+ };
3370
+
3371
+ export declare type ReadUserUsersAllIdOrUsernameGetError = ReadUserUsersAllIdOrUsernameGetErrors[keyof ReadUserUsersAllIdOrUsernameGetErrors];
3372
+
3373
+ export declare type ReadUserUsersAllIdOrUsernameGetErrors = {
3374
+ /**
3375
+ * Validation Error
3376
+ */
3377
+ 422: HttpValidationError;
3378
+ };
3379
+
3380
+ export declare type ReadUserUsersAllIdOrUsernameGetResponse = ReadUserUsersAllIdOrUsernameGetResponses[keyof ReadUserUsersAllIdOrUsernameGetResponses];
3381
+
3382
+ export declare type ReadUserUsersAllIdOrUsernameGetResponses = {
3383
+ /**
3384
+ * Successful Response
3385
+ */
3386
+ 200: UserProfileRead;
3387
+ };
3388
+
3389
+ export declare type RequestSyncLibraryLibrariesLibraryIdSyncPostData = {
3390
+ body?: never;
3391
+ path: {
3392
+ /**
3393
+ * Library Id
3394
+ */
3395
+ library_id: number;
3396
+ };
3397
+ query?: never;
3398
+ url: "/libraries/{library_id}/sync";
3399
+ };
3400
+
3401
+ export declare type RequestSyncLibraryLibrariesLibraryIdSyncPostError = RequestSyncLibraryLibrariesLibraryIdSyncPostErrors[keyof RequestSyncLibraryLibrariesLibraryIdSyncPostErrors];
3402
+
3403
+ export declare type RequestSyncLibraryLibrariesLibraryIdSyncPostErrors = {
3404
+ /**
3405
+ * Validation Error
3406
+ */
3407
+ 422: HttpValidationError;
3408
+ };
3409
+
3410
+ export declare type RequestSyncLibraryLibrariesLibraryIdSyncPostResponse = RequestSyncLibraryLibrariesLibraryIdSyncPostResponses[keyof RequestSyncLibraryLibrariesLibraryIdSyncPostResponses];
3411
+
3412
+ export declare type RequestSyncLibraryLibrariesLibraryIdSyncPostResponses = {
3413
+ /**
3414
+ * Successful Response
3415
+ */
3416
+ 200: OperationResult;
3417
+ };
3418
+
3419
+ /**
3420
+ * ResetPassword
3421
+ */
3422
+ export declare type ResetPassword = {
3423
+ /**
3424
+ * Email
3425
+ */
3426
+ email: string;
3427
+ };
3428
+
3429
+ export declare type ResetPasswordCompleteResetPasswordCompletePostData = {
3430
+ body: CompleteResetPassword;
3431
+ path?: never;
3432
+ query?: never;
3433
+ url: "/reset-password/complete";
3434
+ };
3435
+
3436
+ export declare type ResetPasswordCompleteResetPasswordCompletePostError = ResetPasswordCompleteResetPasswordCompletePostErrors[keyof ResetPasswordCompleteResetPasswordCompletePostErrors];
3437
+
3438
+ export declare type ResetPasswordCompleteResetPasswordCompletePostErrors = {
3439
+ /**
3440
+ * Validation Error
3441
+ */
3442
+ 422: HttpValidationError;
3443
+ };
3444
+
3445
+ export declare type ResetPasswordCompleteResetPasswordCompletePostResponse = ResetPasswordCompleteResetPasswordCompletePostResponses[keyof ResetPasswordCompleteResetPasswordCompletePostResponses];
3446
+
3447
+ export declare type ResetPasswordCompleteResetPasswordCompletePostResponses = {
3448
+ /**
3449
+ * Successful Response
3450
+ */
3451
+ 200: OperationResult;
3452
+ };
3453
+
3454
+ export declare type ResetPasswordResetPasswordPostData = {
3455
+ body: ResetPassword;
3456
+ path?: never;
3457
+ query?: never;
3458
+ url: "/reset-password";
3459
+ };
3460
+
3461
+ export declare type ResetPasswordResetPasswordPostError = ResetPasswordResetPasswordPostErrors[keyof ResetPasswordResetPasswordPostErrors];
3462
+
3463
+ export declare type ResetPasswordResetPasswordPostErrors = {
3464
+ /**
3465
+ * Validation Error
3466
+ */
3467
+ 422: HttpValidationError;
3468
+ };
3469
+
3470
+ export declare type ResetPasswordResetPasswordPostResponse = ResetPasswordResetPasswordPostResponses[keyof ResetPasswordResetPasswordPostResponses];
3471
+
3472
+ export declare type ResetPasswordResetPasswordPostResponses = {
3473
+ /**
3474
+ * Successful Response
3475
+ */
3476
+ 200: OperationResult;
3477
+ };
3478
+
3479
+ /**
3480
+ * ResetPassword
3481
+ */
3482
+ export declare const ResetPasswordSchema: z.ZodObject<{
3483
+ email: z.ZodEmail;
3484
+ }, z.core.$strip>;
3485
+
3486
+ export declare type SignInSignInPostData = {
3487
+ body: BodySignInSignInPost;
3488
+ path?: never;
3489
+ query?: never;
3490
+ url: "/sign-in";
3491
+ };
3492
+
3493
+ export declare type SignInSignInPostError = SignInSignInPostErrors[keyof SignInSignInPostErrors];
3494
+
3495
+ export declare type SignInSignInPostErrors = {
3496
+ /**
3497
+ * Validation Error
3498
+ */
3499
+ 422: HttpValidationError;
3500
+ };
3501
+
3502
+ export declare type SignInSignInPostResponse = SignInSignInPostResponses[keyof SignInSignInPostResponses];
3503
+
3504
+ export declare type SignInSignInPostResponses = {
3505
+ /**
3506
+ * Successful Response
3507
+ */
3508
+ 200: Token;
3509
+ };
3510
+
3511
+ /**
3512
+ * SignUp
3513
+ */
3514
+ export declare type SignUp = {
3515
+ /**
3516
+ * Email
3517
+ */
3518
+ email?: string | null;
3519
+ /**
3520
+ * Username
3521
+ */
3522
+ username: string;
3523
+ /**
3524
+ * Password
3525
+ */
3526
+ password: string;
3527
+ };
3528
+
3529
+ /**
3530
+ * SignUp
3531
+ */
3532
+ export declare const SignUpSchema: z.ZodObject<{
3533
+ email: z.ZodOptional<z.ZodNullable<z.ZodEmail>>;
3534
+ username: z.ZodString;
3535
+ password: z.ZodString;
3536
+ }, z.core.$strip>;
3537
+
3538
+ export declare type SignUpSignUpPostData = {
3539
+ body: SignUp;
3540
+ path?: never;
3541
+ query?: never;
3542
+ url: "/sign-up";
3543
+ };
3544
+
3545
+ export declare type SignUpSignUpPostError = SignUpSignUpPostErrors[keyof SignUpSignUpPostErrors];
3546
+
3547
+ export declare type SignUpSignUpPostErrors = {
3548
+ /**
3549
+ * Validation Error
3550
+ */
3551
+ 422: HttpValidationError;
3552
+ };
3553
+
3554
+ export declare type SignUpSignUpPostResponse = SignUpSignUpPostResponses[keyof SignUpSignUpPostResponses];
3555
+
3556
+ export declare type SignUpSignUpPostResponses = {
3557
+ /**
3558
+ * Successful Response
3559
+ */
3560
+ 200: UserProfileMeRead;
3561
+ };
3562
+
3563
+ /**
3564
+ * SongRead
3565
+ */
3566
+ export declare type SongRead = {
3567
+ /**
3568
+ * Id
3569
+ */
3570
+ id: number;
3571
+ /**
3572
+ * Artist Id
3573
+ *
3574
+ * ID of this song's artist, if any
3575
+ */
3576
+ artist_id?: number | null;
3577
+ /**
3578
+ * Artist Name
3579
+ *
3580
+ * Name of this song's song, if any
3581
+ */
3582
+ artist_name?: string | null;
3583
+ /**
3584
+ * Album Id
3585
+ *
3586
+ * ID of this song's album, if any
3587
+ */
3588
+ album_id?: number | null;
3589
+ /**
3590
+ * Album Title
3591
+ *
3592
+ * Title of this song's album, if any
3593
+ */
3594
+ album_title?: string | null;
3595
+ /**
3596
+ * Artworks
3597
+ *
3598
+ * The artworks of this song
3599
+ */
3600
+ artworks?: Array<ArtworkRead>;
3601
+ /**
3602
+ * Sources
3603
+ *
3604
+ * The sources of this song
3605
+ */
3606
+ sources?: Array<SourceRead>;
3607
+ /**
3608
+ * Start Time
3609
+ *
3610
+ * Where in the song to start playback
3611
+ */
3612
+ start_time?: number;
3613
+ /**
3614
+ * End Time
3615
+ *
3616
+ * Where in the song to end playback
3617
+ */
3618
+ end_time: number;
3619
+ /**
3620
+ * Title
3621
+ *
3622
+ * The title of the song
3623
+ */
3624
+ title?: string | null;
3625
+ /**
3626
+ * Album Artist
3627
+ *
3628
+ * The song's album artist
3629
+ */
3630
+ album_artist?: string | null;
3631
+ /**
3632
+ * Composer
3633
+ *
3634
+ * The composer of the song
3635
+ */
3636
+ composer?: string | null;
3637
+ /**
3638
+ * Genre
3639
+ *
3640
+ * The genre of the song
3641
+ */
3642
+ genre?: string | null;
3643
+ /**
3644
+ * Release Date
3645
+ *
3646
+ * The release date of the song
3647
+ */
3648
+ release_date?: string | null;
3649
+ /**
3650
+ * Track Number
3651
+ *
3652
+ * The track number of the song
3653
+ */
3654
+ track_number?: number | null;
3655
+ /**
3656
+ * Track Total
3657
+ *
3658
+ * The total number of tracks on the album
3659
+ */
3660
+ track_total?: number | null;
3661
+ /**
3662
+ * Disc Number
3663
+ *
3664
+ * The disc number in the album
3665
+ */
3666
+ disc_number?: number | null;
3667
+ /**
3668
+ * Disc Total
3669
+ *
3670
+ * The total number of discs in the album
3671
+ */
3672
+ disc_total?: number | null;
3673
+ /**
3674
+ * Lyrics
3675
+ *
3676
+ * The lyrics of the song
3677
+ */
3678
+ lyrics?: string | null;
3679
+ /**
3680
+ * Rating
3681
+ *
3682
+ * The rating of the song
3683
+ */
3684
+ rating?: number | null;
3685
+ /**
3686
+ * Bpm
3687
+ *
3688
+ * The beats per minute of the song
3689
+ */
3690
+ bpm?: number | null;
3691
+ /**
3692
+ * Comment
3693
+ *
3694
+ * A user defined comment
3695
+ */
3696
+ comment?: string | null;
3697
+ /**
3698
+ * Grouping
3699
+ *
3700
+ * The grouping of the song
3701
+ */
3702
+ grouping?: string | null;
3703
+ /**
3704
+ * Mcn
3705
+ */
3706
+ mcn?: string | null;
3707
+ /**
3708
+ * Isrc
3709
+ */
3710
+ isrc?: string | null;
3711
+ /**
3712
+ * Music Brainz Release Id
3713
+ */
3714
+ music_brainz_release_id?: string | null;
3715
+ /**
3716
+ * Music Brainz Recording Id
3717
+ */
3718
+ music_brainz_recording_id?: string | null;
3719
+ };
3720
+
3721
+ /**
3722
+ * SongRead
3723
+ */
3724
+ export declare const SongReadSchema: z.ZodObject<{
3725
+ id: z.ZodInt;
3726
+ artist_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3727
+ artist_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3728
+ album_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3729
+ album_title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3730
+ artworks: z.ZodOptional<z.ZodArray<z.ZodObject<{
3731
+ id: z.ZodInt;
3732
+ kind: z.ZodEnum<{
3733
+ front_cover: "front_cover";
3734
+ }>;
3735
+ image_url: z.ZodString;
3736
+ background_color: z.ZodNullable<z.ZodString>;
3737
+ primary_color: z.ZodNullable<z.ZodString>;
3738
+ secondary_color: z.ZodNullable<z.ZodString>;
3739
+ tertiary_color: z.ZodNullable<z.ZodString>;
3740
+ }, z.core.$strip>>>;
3741
+ sources: z.ZodOptional<z.ZodArray<z.ZodObject<{
3742
+ id: z.ZodInt;
3743
+ url: z.ZodString;
3744
+ mime_type: z.ZodNullable<z.ZodString>;
3745
+ is_invalid: z.ZodBoolean;
3746
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
3747
+ extension_tag: z.ZodNullable<z.ZodString>;
3748
+ }, z.core.$strip>>>;
3749
+ start_time: z.ZodOptional<z.ZodNumber>;
3750
+ end_time: z.ZodNumber;
3751
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3752
+ album_artist: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3753
+ composer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3754
+ genre: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3755
+ release_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3756
+ track_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3757
+ track_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3758
+ disc_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3759
+ disc_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3760
+ lyrics: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3761
+ rating: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
3762
+ bpm: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3763
+ comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3764
+ grouping: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3765
+ mcn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3766
+ isrc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3767
+ music_brainz_release_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3768
+ music_brainz_recording_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3769
+ }, z.core.$strip>;
3770
+
3771
+ /**
3772
+ * SongUpdate
3773
+ */
3774
+ export declare type SongUpdate = {
3775
+ /**
3776
+ * Artist Id
3777
+ */
3778
+ artist_id?: number | null;
3779
+ /**
3780
+ * Album Id
3781
+ */
3782
+ album_id?: number | null;
3783
+ /**
3784
+ * Artwork Ids
3785
+ */
3786
+ artwork_ids?: Array<number> | null;
3787
+ /**
3788
+ * Source Ids
3789
+ */
3790
+ source_ids?: Array<number> | null;
3791
+ /**
3792
+ * Start Time
3793
+ */
3794
+ start_time?: number | null;
3795
+ /**
3796
+ * End Time
3797
+ */
3798
+ end_time?: number | null;
3799
+ /**
3800
+ * Title
3801
+ */
3802
+ title?: string | null;
3803
+ /**
3804
+ * Album Artist
3805
+ */
3806
+ album_artist?: string | null;
3807
+ /**
3808
+ * Composer
3809
+ */
3810
+ composer?: string | null;
3811
+ /**
3812
+ * Genre
3813
+ */
3814
+ genre?: string | null;
3815
+ /**
3816
+ * Release Date
3817
+ */
3818
+ release_date?: string | null;
3819
+ /**
3820
+ * Track Number
3821
+ */
3822
+ track_number?: number | null;
3823
+ /**
3824
+ * Track Total
3825
+ */
3826
+ track_total?: number | null;
3827
+ /**
3828
+ * Disc Number
3829
+ */
3830
+ disc_number?: number | null;
3831
+ /**
3832
+ * Disc Total
3833
+ */
3834
+ disc_total?: number | null;
3835
+ /**
3836
+ * Lyrics
3837
+ */
3838
+ lyrics?: string | null;
3839
+ /**
3840
+ * Rating
3841
+ */
3842
+ rating?: number | null;
3843
+ /**
3844
+ * Bpm
3845
+ */
3846
+ bpm?: number | null;
3847
+ /**
3848
+ * Comment
3849
+ */
3850
+ comment?: string | null;
3851
+ /**
3852
+ * Grouping
3853
+ */
3854
+ grouping?: string | null;
3855
+ /**
3856
+ * Mcn
3857
+ */
3858
+ mcn?: string | null;
3859
+ /**
3860
+ * Isrc
3861
+ */
3862
+ isrc?: string | null;
3863
+ /**
3864
+ * Music Brainz Release Id
3865
+ */
3866
+ music_brainz_release_id?: string | null;
3867
+ /**
3868
+ * Music Brainz Recording Id
3869
+ */
3870
+ music_brainz_recording_id?: string | null;
3871
+ };
3872
+
3873
+ /**
3874
+ * SongUpdate
3875
+ */
3876
+ export declare const SongUpdateSchema: z.ZodObject<{
3877
+ artist_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3878
+ album_id: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3879
+ artwork_ids: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodInt>>>;
3880
+ source_ids: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodInt>>>;
3881
+ start_time: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
3882
+ end_time: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
3883
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3884
+ album_artist: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3885
+ composer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3886
+ genre: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3887
+ release_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3888
+ track_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3889
+ track_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3890
+ disc_number: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3891
+ disc_total: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3892
+ lyrics: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3893
+ rating: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
3894
+ bpm: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
3895
+ comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3896
+ grouping: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3897
+ mcn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3898
+ isrc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3899
+ music_brainz_release_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3900
+ music_brainz_recording_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3901
+ }, z.core.$strip>;
3902
+
3903
+ /**
3904
+ * SourceChangesRead
3905
+ */
3906
+ export declare type SourceChangesRead = {
3907
+ /**
3908
+ * Since
3909
+ */
3910
+ since: string;
3911
+ /**
3912
+ * Ids
3913
+ */
3914
+ ids: Array<number>;
3915
+ };
3916
+
3917
+ /**
3918
+ * SourceChangesRead
3919
+ */
3920
+ export declare const SourceChangesReadSchema: z.ZodObject<{
3921
+ since: z.ZodISODateTime;
3922
+ ids: z.ZodArray<z.ZodInt>;
3923
+ }, z.core.$strip>;
3924
+
3925
+ /**
3926
+ * SourceCreate
3927
+ */
3928
+ export declare type SourceCreate = {
3929
+ /**
3930
+ * Url
3931
+ */
3932
+ url: string;
3933
+ /**
3934
+ * Mime Type
3935
+ */
3936
+ mime_type: string | null;
3937
+ /**
3938
+ * Extension Manifest Id
3939
+ */
3940
+ extension_manifest_id: string | null;
3941
+ /**
3942
+ * Extension Tag
3943
+ */
3944
+ extension_tag: string | null;
3945
+ };
3946
+
3947
+ /**
3948
+ * SourceCreate
3949
+ */
3950
+ export declare const SourceCreateSchema: z.ZodObject<{
3951
+ url: z.ZodString;
3952
+ mime_type: z.ZodNullable<z.ZodString>;
3953
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
3954
+ extension_tag: z.ZodNullable<z.ZodString>;
3955
+ }, z.core.$strip>;
3956
+
3957
+ /**
3958
+ * SourceRead
3959
+ */
3960
+ export declare type SourceRead = {
3961
+ /**
3962
+ * Id
3963
+ */
3964
+ id: number;
3965
+ /**
3966
+ * Url
3967
+ */
3968
+ url: string;
3969
+ /**
3970
+ * Mime Type
3971
+ */
3972
+ mime_type: string | null;
3973
+ /**
3974
+ * Is Invalid
3975
+ */
3976
+ is_invalid: boolean;
3977
+ /**
3978
+ * Extension Manifest Id
3979
+ */
3980
+ extension_manifest_id: string | null;
3981
+ /**
3982
+ * Extension Tag
3983
+ */
3984
+ extension_tag: string | null;
3985
+ };
3986
+
3987
+ /**
3988
+ * SourceRead
3989
+ */
3990
+ export declare const SourceReadSchema: z.ZodObject<{
3991
+ id: z.ZodInt;
3992
+ url: z.ZodString;
3993
+ mime_type: z.ZodNullable<z.ZodString>;
3994
+ is_invalid: z.ZodBoolean;
3995
+ extension_manifest_id: z.ZodNullable<z.ZodString>;
3996
+ extension_tag: z.ZodNullable<z.ZodString>;
3997
+ }, z.core.$strip>;
3998
+
3999
+ /**
4000
+ * SourceUpdate
4001
+ */
4002
+ export declare type SourceUpdate = {
4003
+ /**
4004
+ * Url
4005
+ */
4006
+ url?: string | null;
4007
+ /**
4008
+ * Mime Type
4009
+ */
4010
+ mime_type?: string | null;
4011
+ /**
4012
+ * Is Invalid
4013
+ */
4014
+ is_invalid?: boolean | null;
4015
+ /**
4016
+ * Extension Manifest Id
4017
+ */
4018
+ extension_manifest_id?: string | null;
4019
+ /**
4020
+ * Extension Tag
4021
+ */
4022
+ extension_tag?: string | null;
4023
+ };
4024
+
4025
+ /**
4026
+ * SourceUpdate
4027
+ */
4028
+ export declare const SourceUpdateSchema: z.ZodObject<{
4029
+ url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4030
+ mime_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4031
+ is_invalid: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
4032
+ extension_manifest_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4033
+ extension_tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4034
+ }, z.core.$strip>;
4035
+
4036
+ export declare class StorageUserSessionManager implements UserSessionManager {
4037
+ private static _local;
4038
+ static get local(): StorageUserSessionManager;
4039
+ constructor(storage: Storage);
4040
+ private readonly storage;
4041
+ private readonly subscribers;
4042
+ private _current;
4043
+ get session(): UserSession | null;
4044
+ get isSignedIn(): boolean;
4045
+ replaceSession(newSession: UserSession | null): void;
4046
+ hasScope(scope: OAuth2Scope): boolean;
4047
+ subscribe(subscriber: (event: UserSessionManagerEvent) => void): () => void;
4048
+ }
4049
+
4050
+ export declare type StreamSourceFileSourcesSourceIdFileGetData = {
4051
+ body?: never;
4052
+ path: {
4053
+ /**
4054
+ * Source Id
4055
+ */
4056
+ source_id: number;
4057
+ };
4058
+ query: {
4059
+ /**
4060
+ * Token
4061
+ *
4062
+ * A feature token
4063
+ */
4064
+ token: string;
4065
+ };
4066
+ url: "/sources/{source_id}/file";
4067
+ };
4068
+
4069
+ export declare type StreamSourceFileSourcesSourceIdFileGetError = StreamSourceFileSourcesSourceIdFileGetErrors[keyof StreamSourceFileSourcesSourceIdFileGetErrors];
4070
+
4071
+ export declare type StreamSourceFileSourcesSourceIdFileGetErrors = {
4072
+ /**
4073
+ * Validation Error
4074
+ */
4075
+ 422: HttpValidationError;
4076
+ };
4077
+
4078
+ export declare type StreamSourceFileSourcesSourceIdFileGetResponses = {
4079
+ /**
4080
+ * Successful Response
4081
+ */
4082
+ 200: unknown;
4083
+ };
4084
+
4085
+ export declare type StreamUserEventsPreflightUsersEventsPreflightPostData = {
4086
+ body?: never;
4087
+ path?: never;
4088
+ query?: never;
4089
+ url: "/users/events/preflight";
4090
+ };
4091
+
4092
+ export declare type StreamUserEventsPreflightUsersEventsPreflightPostResponse = StreamUserEventsPreflightUsersEventsPreflightPostResponses[keyof StreamUserEventsPreflightUsersEventsPreflightPostResponses];
4093
+
4094
+ export declare type StreamUserEventsPreflightUsersEventsPreflightPostResponses = {
4095
+ /**
4096
+ * Successful Response
4097
+ */
4098
+ 200: UserEventPreflight;
4099
+ };
4100
+
4101
+ /** The maximum length of a common tag such as the name of a song. */
4102
+ export declare const TAG_MAX_LENGTH = 1000;
4103
+
4104
+ /**
4105
+ * Token
4106
+ */
4107
+ export declare type Token = {
4108
+ /**
4109
+ * Scopes
4110
+ */
4111
+ scopes: Array<OAuth2Scope>;
4112
+ /**
4113
+ * Access Token
4114
+ */
4115
+ access_token: string;
4116
+ /**
4117
+ * Token Type
4118
+ */
4119
+ token_type: "bearer";
4120
+ };
4121
+
4122
+ /**
4123
+ * Token
4124
+ */
4125
+ export declare const TokenSchema: z.ZodObject<{
4126
+ scopes: z.ZodArray<z.ZodEnum<{
4127
+ profile: "profile";
4128
+ "library:read": "library:read";
4129
+ "library:write": "library:write";
4130
+ admin: "admin";
4131
+ }>>;
4132
+ access_token: z.ZodString;
4133
+ token_type: z.ZodLiteral<"bearer">;
4134
+ }, z.core.$strip>;
4135
+
4136
+ export declare type UninstallExtensionExtensionsInstalledExtensionIdDeleteData = {
4137
+ body?: never;
4138
+ path: {
4139
+ /**
4140
+ * Extension Id
4141
+ */
4142
+ extension_id: number;
4143
+ };
4144
+ query?: never;
4145
+ url: "/extensions/installed/{extension_id}";
4146
+ };
4147
+
4148
+ export declare type UninstallExtensionExtensionsInstalledExtensionIdDeleteError = UninstallExtensionExtensionsInstalledExtensionIdDeleteErrors[keyof UninstallExtensionExtensionsInstalledExtensionIdDeleteErrors];
4149
+
4150
+ export declare type UninstallExtensionExtensionsInstalledExtensionIdDeleteErrors = {
4151
+ /**
4152
+ * Validation Error
4153
+ */
4154
+ 422: HttpValidationError;
4155
+ };
4156
+
4157
+ export declare type UninstallExtensionExtensionsInstalledExtensionIdDeleteResponse = UninstallExtensionExtensionsInstalledExtensionIdDeleteResponses[keyof UninstallExtensionExtensionsInstalledExtensionIdDeleteResponses];
4158
+
4159
+ export declare type UninstallExtensionExtensionsInstalledExtensionIdDeleteResponses = {
4160
+ /**
4161
+ * Successful Response
4162
+ */
4163
+ 200: OperationResult;
4164
+ };
4165
+
4166
+ export declare type UpdateArtworkArtworksArtworkIdPatchData = {
4167
+ body: ArtworkUpdate;
4168
+ path: {
4169
+ /**
4170
+ * Artwork Id
4171
+ */
4172
+ artwork_id: number;
4173
+ };
4174
+ query?: never;
4175
+ url: "/artworks/{artwork_id}";
4176
+ };
4177
+
4178
+ export declare type UpdateArtworkArtworksArtworkIdPatchError = UpdateArtworkArtworksArtworkIdPatchErrors[keyof UpdateArtworkArtworksArtworkIdPatchErrors];
4179
+
4180
+ export declare type UpdateArtworkArtworksArtworkIdPatchErrors = {
4181
+ /**
4182
+ * Validation Error
4183
+ */
4184
+ 422: HttpValidationError;
4185
+ };
4186
+
4187
+ export declare type UpdateArtworkArtworksArtworkIdPatchResponse = UpdateArtworkArtworksArtworkIdPatchResponses[keyof UpdateArtworkArtworksArtworkIdPatchResponses];
4188
+
4189
+ export declare type UpdateArtworkArtworksArtworkIdPatchResponses = {
4190
+ /**
4191
+ * Successful Response
4192
+ */
4193
+ 200: ArtworkRead;
4194
+ };
4195
+
4196
+ export declare type UpdateExtensionExtensionsAvailableExtensionIdUpdatePostData = {
4197
+ body?: never;
4198
+ path: {
4199
+ /**
4200
+ * Extension Id
4201
+ */
4202
+ extension_id: number;
4203
+ };
4204
+ query?: never;
4205
+ url: "/extensions/available/{extension_id}/update";
4206
+ };
4207
+
4208
+ export declare type UpdateExtensionExtensionsAvailableExtensionIdUpdatePostError = UpdateExtensionExtensionsAvailableExtensionIdUpdatePostErrors[keyof UpdateExtensionExtensionsAvailableExtensionIdUpdatePostErrors];
4209
+
4210
+ export declare type UpdateExtensionExtensionsAvailableExtensionIdUpdatePostErrors = {
4211
+ /**
4212
+ * Validation Error
4213
+ */
4214
+ 422: HttpValidationError;
4215
+ };
4216
+
4217
+ export declare type UpdateExtensionExtensionsAvailableExtensionIdUpdatePostResponse = UpdateExtensionExtensionsAvailableExtensionIdUpdatePostResponses[keyof UpdateExtensionExtensionsAvailableExtensionIdUpdatePostResponses];
4218
+
4219
+ export declare type UpdateExtensionExtensionsAvailableExtensionIdUpdatePostResponses = {
4220
+ /**
4221
+ * Successful Response
4222
+ */
4223
+ 200: OperationResult;
4224
+ };
4225
+
4226
+ export declare type UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchData = {
4227
+ body: AlbumUpdate;
4228
+ path: {
4229
+ /**
4230
+ * Library Id
4231
+ */
4232
+ library_id: number;
4233
+ /**
4234
+ * Album Id
4235
+ */
4236
+ album_id: number;
4237
+ };
4238
+ query?: never;
4239
+ url: "/libraries/{library_id}/albums/{album_id}";
4240
+ };
4241
+
4242
+ export declare type UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchError = UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchErrors[keyof UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchErrors];
4243
+
4244
+ export declare type UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchErrors = {
4245
+ /**
4246
+ * Validation Error
4247
+ */
4248
+ 422: HttpValidationError;
4249
+ };
4250
+
4251
+ export declare type UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchResponse = UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchResponses[keyof UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchResponses];
4252
+
4253
+ export declare type UpdateLibraryAlbumLibrariesLibraryIdAlbumsAlbumIdPatchResponses = {
4254
+ /**
4255
+ * Successful Response
4256
+ */
4257
+ 200: AlbumRead;
4258
+ };
4259
+
4260
+ export declare type UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchData = {
4261
+ body: ArtistUpdate;
4262
+ path: {
4263
+ /**
4264
+ * Library Id
4265
+ */
4266
+ library_id: number;
4267
+ /**
4268
+ * Artist Id
4269
+ */
4270
+ artist_id: number;
4271
+ };
4272
+ query?: never;
4273
+ url: "/libraries/{library_id}/artists/{artist_id}";
4274
+ };
4275
+
4276
+ export declare type UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchError = UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchErrors[keyof UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchErrors];
4277
+
4278
+ export declare type UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchErrors = {
4279
+ /**
4280
+ * Validation Error
4281
+ */
4282
+ 422: HttpValidationError;
4283
+ };
4284
+
4285
+ export declare type UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchResponse = UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchResponses[keyof UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchResponses];
4286
+
4287
+ export declare type UpdateLibraryArtistLibrariesLibraryIdArtistsArtistIdPatchResponses = {
4288
+ /**
4289
+ * Successful Response
4290
+ */
4291
+ 200: ArtistRead;
4292
+ };
4293
+
4294
+ export declare type UpdateLibraryLibrariesLibraryIdPatchData = {
4295
+ body: LibraryUpdate;
4296
+ path: {
4297
+ /**
4298
+ * Library Id
4299
+ */
4300
+ library_id: number;
4301
+ };
4302
+ query?: never;
4303
+ url: "/libraries/{library_id}";
4304
+ };
4305
+
4306
+ export declare type UpdateLibraryLibrariesLibraryIdPatchError = UpdateLibraryLibrariesLibraryIdPatchErrors[keyof UpdateLibraryLibrariesLibraryIdPatchErrors];
4307
+
4308
+ export declare type UpdateLibraryLibrariesLibraryIdPatchErrors = {
4309
+ /**
4310
+ * Validation Error
4311
+ */
4312
+ 422: HttpValidationError;
4313
+ };
4314
+
4315
+ export declare type UpdateLibraryLibrariesLibraryIdPatchResponse = UpdateLibraryLibrariesLibraryIdPatchResponses[keyof UpdateLibraryLibrariesLibraryIdPatchResponses];
4316
+
4317
+ export declare type UpdateLibraryLibrariesLibraryIdPatchResponses = {
4318
+ /**
4319
+ * Successful Response
4320
+ */
4321
+ 200: LibraryRead;
4322
+ };
4323
+
4324
+ export declare type UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchData = {
4325
+ body: LibraryPermissionUpdate;
4326
+ path: {
4327
+ /**
4328
+ * Library Id
4329
+ */
4330
+ library_id: number;
4331
+ /**
4332
+ * User Id
4333
+ */
4334
+ user_id: number;
4335
+ };
4336
+ query?: never;
4337
+ url: "/libraries/{library_id}/permission/{user_id}";
4338
+ };
4339
+
4340
+ export declare type UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchError = UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchErrors[keyof UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchErrors];
4341
+
4342
+ export declare type UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchErrors = {
4343
+ /**
4344
+ * Validation Error
4345
+ */
4346
+ 422: HttpValidationError;
4347
+ };
4348
+
4349
+ export declare type UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchResponse = UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchResponses[keyof UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchResponses];
4350
+
4351
+ export declare type UpdateLibraryPermissionLibrariesLibraryIdPermissionUserIdPatchResponses = {
4352
+ /**
4353
+ * Successful Response
4354
+ */
4355
+ 200: LibraryPermissionRead;
4356
+ };
4357
+
4358
+ export declare type UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchData = {
4359
+ body: SongUpdate;
4360
+ path: {
4361
+ /**
4362
+ * Library Id
4363
+ */
4364
+ library_id: number;
4365
+ /**
4366
+ * Song Id
4367
+ */
4368
+ song_id: number;
4369
+ };
4370
+ query?: never;
4371
+ url: "/libraries/{library_id}/songs/{song_id}";
4372
+ };
4373
+
4374
+ export declare type UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchError = UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchErrors[keyof UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchErrors];
4375
+
4376
+ export declare type UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchErrors = {
4377
+ /**
4378
+ * Validation Error
4379
+ */
4380
+ 422: HttpValidationError;
4381
+ };
4382
+
4383
+ export declare type UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchResponse = UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchResponses[keyof UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchResponses];
4384
+
4385
+ export declare type UpdateLibrarySongLibrariesLibraryIdSongsSongIdPatchResponses = {
4386
+ /**
4387
+ * Successful Response
4388
+ */
4389
+ 200: SongRead;
4390
+ };
4391
+
4392
+ export declare type UpdateMeUsersMePostData = {
4393
+ body: UserProfileMeUpdate;
4394
+ path?: never;
4395
+ query?: never;
4396
+ url: "/users/me";
4397
+ };
4398
+
4399
+ export declare type UpdateMeUsersMePostError = UpdateMeUsersMePostErrors[keyof UpdateMeUsersMePostErrors];
4400
+
4401
+ export declare type UpdateMeUsersMePostErrors = {
4402
+ /**
4403
+ * Validation Error
4404
+ */
4405
+ 422: HttpValidationError;
4406
+ };
4407
+
4408
+ export declare type UpdateMeUsersMePostResponse = UpdateMeUsersMePostResponses[keyof UpdateMeUsersMePostResponses];
4409
+
4410
+ export declare type UpdateMeUsersMePostResponses = {
4411
+ /**
4412
+ * Successful Response
4413
+ */
4414
+ 200: UserProfileMeRead;
4415
+ };
4416
+
4417
+ export declare type UpdateNotificationUsersNotificationsNotificationIdPatchData = {
4418
+ body: NotificationUpdate;
4419
+ path: {
4420
+ /**
4421
+ * Notification Id
4422
+ */
4423
+ notification_id: number;
4424
+ };
4425
+ query?: never;
4426
+ url: "/users/notifications/{notification_id}";
4427
+ };
4428
+
4429
+ export declare type UpdateNotificationUsersNotificationsNotificationIdPatchError = UpdateNotificationUsersNotificationsNotificationIdPatchErrors[keyof UpdateNotificationUsersNotificationsNotificationIdPatchErrors];
4430
+
4431
+ export declare type UpdateNotificationUsersNotificationsNotificationIdPatchErrors = {
4432
+ /**
4433
+ * Validation Error
4434
+ */
4435
+ 422: HttpValidationError;
4436
+ };
4437
+
4438
+ export declare type UpdateNotificationUsersNotificationsNotificationIdPatchResponse = UpdateNotificationUsersNotificationsNotificationIdPatchResponses[keyof UpdateNotificationUsersNotificationsNotificationIdPatchResponses];
4439
+
4440
+ export declare type UpdateNotificationUsersNotificationsNotificationIdPatchResponses = {
4441
+ /**
4442
+ * Successful Response
4443
+ */
4444
+ 200: NotificationRead;
4445
+ };
4446
+
4447
+ export declare type UpdateSourceSourcesSourceIdPatchData = {
4448
+ body: SourceUpdate;
4449
+ path: {
4450
+ /**
4451
+ * Source Id
4452
+ */
4453
+ source_id: number;
4454
+ };
4455
+ query?: never;
4456
+ url: "/sources/{source_id}";
4457
+ };
4458
+
4459
+ export declare type UpdateSourceSourcesSourceIdPatchError = UpdateSourceSourcesSourceIdPatchErrors[keyof UpdateSourceSourcesSourceIdPatchErrors];
4460
+
4461
+ export declare type UpdateSourceSourcesSourceIdPatchErrors = {
4462
+ /**
4463
+ * Validation Error
4464
+ */
4465
+ 422: HttpValidationError;
4466
+ };
4467
+
4468
+ export declare type UpdateSourceSourcesSourceIdPatchResponse = UpdateSourceSourcesSourceIdPatchResponses[keyof UpdateSourceSourcesSourceIdPatchResponses];
4469
+
4470
+ export declare type UpdateSourceSourcesSourceIdPatchResponses = {
4471
+ /**
4472
+ * Successful Response
4473
+ */
4474
+ 200: SourceRead;
4475
+ };
4476
+
4477
+ export declare type UpdateUserAdminUsersAdminAllUserIdPatchData = {
4478
+ body: UserAdminUpdate;
4479
+ path: {
4480
+ /**
4481
+ * User Id
4482
+ */
4483
+ user_id: number;
4484
+ };
4485
+ query?: never;
4486
+ url: "/users/admin/all/{user_id}";
4487
+ };
4488
+
4489
+ export declare type UpdateUserAdminUsersAdminAllUserIdPatchError = UpdateUserAdminUsersAdminAllUserIdPatchErrors[keyof UpdateUserAdminUsersAdminAllUserIdPatchErrors];
4490
+
4491
+ export declare type UpdateUserAdminUsersAdminAllUserIdPatchErrors = {
4492
+ /**
4493
+ * Validation Error
4494
+ */
4495
+ 422: HttpValidationError;
4496
+ };
4497
+
4498
+ export declare type UpdateUserAdminUsersAdminAllUserIdPatchResponse = UpdateUserAdminUsersAdminAllUserIdPatchResponses[keyof UpdateUserAdminUsersAdminAllUserIdPatchResponses];
4499
+
4500
+ export declare type UpdateUserAdminUsersAdminAllUserIdPatchResponses = {
4501
+ /**
4502
+ * Successful Response
4503
+ */
4504
+ 200: UserAdminRead;
4505
+ };
4506
+
4507
+ /** The maximum length of a URL. */
4508
+ export declare const URL_MAX_LENGTH = 8000;
4509
+
4510
+ /**
4511
+ * UserAdminRead
4512
+ */
4513
+ export declare type UserAdminRead = {
4514
+ /**
4515
+ * Id
4516
+ */
4517
+ id: number;
4518
+ /**
4519
+ * Username
4520
+ */
4521
+ username: string;
4522
+ /**
4523
+ * Preferred Name
4524
+ */
4525
+ preferred_name: string | null;
4526
+ /**
4527
+ * Scopes
4528
+ */
4529
+ scopes: Array<OAuth2Scope>;
4530
+ };
4531
+
4532
+ /**
4533
+ * UserAdminRead
4534
+ */
4535
+ export declare const UserAdminReadSchema: z.ZodObject<{
4536
+ id: z.ZodInt;
4537
+ username: z.ZodString;
4538
+ preferred_name: z.ZodNullable<z.ZodString>;
4539
+ scopes: z.ZodArray<z.ZodEnum<{
4540
+ profile: "profile";
4541
+ "library:read": "library:read";
4542
+ "library:write": "library:write";
4543
+ admin: "admin";
4544
+ }>>;
4545
+ }, z.core.$strip>;
4546
+
4547
+ /**
4548
+ * UserAdminsRead
4549
+ */
4550
+ export declare type UserAdminsRead = {
4551
+ /**
4552
+ * Users
4553
+ */
4554
+ users: Array<UserAdminRead>;
4555
+ /**
4556
+ * Offset
4557
+ */
4558
+ offset: number;
4559
+ /**
4560
+ * Limit
4561
+ */
4562
+ limit: number;
4563
+ /**
4564
+ * Total
4565
+ */
4566
+ total: number;
4567
+ };
4568
+
4569
+ /**
4570
+ * UserAdminsRead
4571
+ */
4572
+ export declare const UserAdminsReadSchema: z.ZodObject<{
4573
+ users: z.ZodArray<z.ZodObject<{
4574
+ id: z.ZodInt;
4575
+ username: z.ZodString;
4576
+ preferred_name: z.ZodNullable<z.ZodString>;
4577
+ scopes: z.ZodArray<z.ZodEnum<{
4578
+ profile: "profile";
4579
+ "library:read": "library:read";
4580
+ "library:write": "library:write";
4581
+ admin: "admin";
4582
+ }>>;
4583
+ }, z.core.$strip>>;
4584
+ offset: z.ZodInt;
4585
+ limit: z.ZodInt;
4586
+ total: z.ZodInt;
4587
+ }, z.core.$strip>;
4588
+
4589
+ /**
4590
+ * UserAdminUpdate
4591
+ */
4592
+ export declare type UserAdminUpdate = {
4593
+ /**
4594
+ * Preferred Name
4595
+ */
4596
+ preferred_name?: string | null;
4597
+ /**
4598
+ * Scopes
4599
+ *
4600
+ * The complete set of scopes to grant the user
4601
+ */
4602
+ scopes?: Array<OAuth2Scope> | null;
4603
+ };
4604
+
4605
+ /**
4606
+ * UserAdminUpdate
4607
+ */
4608
+ export declare const UserAdminUpdateSchema: z.ZodObject<{
4609
+ preferred_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4610
+ scopes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
4611
+ profile: "profile";
4612
+ "library:read": "library:read";
4613
+ "library:write": "library:write";
4614
+ admin: "admin";
4615
+ }>>>>;
4616
+ }, z.core.$strip>;
4617
+
4618
+ export declare type UserEvent = {
4619
+ event_type: "notifications_changed" | "libraries_changed" | "extensions_changed";
4620
+ ids: readonly number[];
4621
+ };
4622
+
4623
+ /**
4624
+ * UserEventPreflight
4625
+ */
4626
+ export declare type UserEventPreflight = {
4627
+ /**
4628
+ * Token
4629
+ */
4630
+ token: string;
4631
+ };
4632
+
4633
+ /**
4634
+ * UserEventPreflight
4635
+ */
4636
+ export declare const UserEventPreflightSchema: z.ZodObject<{
4637
+ token: z.ZodString;
4638
+ }, z.core.$strip>;
4639
+
4640
+ export declare class UserEventsManager {
4641
+ private readonly baseUrl;
4642
+ private readonly client;
4643
+ private readonly userSessionManager;
4644
+ private readonly subscribers;
4645
+ private state;
4646
+ constructor(baseUrl: string, client: APIClient, userSessionManager: UserSessionManager);
4647
+ _syncWithUserSession(): Promise<void>;
4648
+ _connect(): Promise<void>;
4649
+ _disconnect(): void;
4650
+ private _onOpen;
4651
+ private _onError;
4652
+ private _onMessage;
4653
+ private _onClose;
4654
+ subscribe(subscriber: (userEvent: UserEvent) => void): () => void;
4655
+ }
4656
+
4657
+ /**
4658
+ * UserFileAccessPreflight
4659
+ */
4660
+ export declare type UserFileAccessPreflight = {
4661
+ /**
4662
+ * Token
4663
+ */
4664
+ token: string;
4665
+ /**
4666
+ * Expires At
4667
+ */
4668
+ expires_at: string;
4669
+ };
4670
+
4671
+ /**
4672
+ * UserFileAccessPreflight
4673
+ */
4674
+ export declare const UserFileAccessPreflightSchema: z.ZodObject<{
4675
+ token: z.ZodString;
4676
+ expires_at: z.ZodISODateTime;
4677
+ }, z.core.$strip>;
4678
+
4679
+ /**
4680
+ * UserProfileMeRead
4681
+ */
4682
+ export declare type UserProfileMeRead = {
4683
+ /**
4684
+ * Id
4685
+ */
4686
+ id: number;
4687
+ /**
4688
+ * Username
4689
+ */
4690
+ username: string;
4691
+ /**
4692
+ * Preferred Name
4693
+ */
4694
+ preferred_name: string | null;
4695
+ /**
4696
+ * Email
4697
+ */
4698
+ email: string | null;
4699
+ /**
4700
+ * Is Email Verified
4701
+ */
4702
+ is_email_verified: boolean;
4703
+ /**
4704
+ * Enable Playback Events
4705
+ */
4706
+ enable_playback_events: boolean;
4707
+ };
4708
+
4709
+ /**
4710
+ * UserProfileMeRead
4711
+ */
4712
+ export declare const UserProfileMeReadSchema: z.ZodObject<{
4713
+ id: z.ZodInt;
4714
+ username: z.ZodString;
4715
+ preferred_name: z.ZodNullable<z.ZodString>;
4716
+ email: z.ZodNullable<z.ZodString>;
4717
+ is_email_verified: z.ZodBoolean;
4718
+ enable_playback_events: z.ZodBoolean;
4719
+ }, z.core.$strip>;
4720
+
4721
+ /**
4722
+ * UserProfileMeUpdate
4723
+ */
4724
+ export declare type UserProfileMeUpdate = {
4725
+ /**
4726
+ * Email
4727
+ */
4728
+ email: string | null;
4729
+ /**
4730
+ * Preferred Name
4731
+ */
4732
+ preferred_name: string | null;
4733
+ /**
4734
+ * Enable Playback Events
4735
+ */
4736
+ enable_playback_events: boolean;
4737
+ };
4738
+
4739
+ /**
4740
+ * UserProfileMeUpdate
4741
+ */
4742
+ export declare const UserProfileMeUpdateSchema: z.ZodObject<{
4743
+ email: z.ZodNullable<z.ZodEmail>;
4744
+ preferred_name: z.ZodNullable<z.ZodString>;
4745
+ enable_playback_events: z.ZodBoolean;
4746
+ }, z.core.$strip>;
4747
+
4748
+ /**
4749
+ * UserProfileRead
4750
+ */
4751
+ export declare type UserProfileRead = {
4752
+ /**
4753
+ * Id
4754
+ */
4755
+ id: number;
4756
+ /**
4757
+ * Username
4758
+ */
4759
+ username: string;
4760
+ /**
4761
+ * Preferred Name
4762
+ */
4763
+ preferred_name: string | null;
4764
+ };
4765
+
4766
+ /**
4767
+ * UserProfileRead
4768
+ */
4769
+ export declare const UserProfileReadSchema: z.ZodObject<{
4770
+ id: z.ZodInt;
4771
+ username: z.ZodString;
4772
+ preferred_name: z.ZodNullable<z.ZodString>;
4773
+ }, z.core.$strip>;
4774
+
4775
+ /**
4776
+ * UserProfilesRead
4777
+ */
4778
+ export declare type UserProfilesRead = {
4779
+ /**
4780
+ * Users
4781
+ */
4782
+ users: Array<UserProfileRead>;
4783
+ /**
4784
+ * Offset
4785
+ */
4786
+ offset: number;
4787
+ /**
4788
+ * Limit
4789
+ */
4790
+ limit: number;
4791
+ /**
4792
+ * Total
4793
+ */
4794
+ total: number;
4795
+ };
4796
+
4797
+ /**
4798
+ * UserProfilesRead
4799
+ */
4800
+ export declare const UserProfilesReadSchema: z.ZodObject<{
4801
+ users: z.ZodArray<z.ZodObject<{
4802
+ id: z.ZodInt;
4803
+ username: z.ZodString;
4804
+ preferred_name: z.ZodNullable<z.ZodString>;
4805
+ }, z.core.$strip>>;
4806
+ offset: z.ZodInt;
4807
+ limit: z.ZodInt;
4808
+ total: z.ZodInt;
4809
+ }, z.core.$strip>;
4810
+
4811
+ export declare interface UserSession {
4812
+ readonly accessToken: string;
4813
+ readonly scopes: readonly OAuth2Scope[];
4814
+ }
4815
+
4816
+ export declare interface UserSessionManager {
4817
+ readonly session: UserSession | null;
4818
+ readonly isSignedIn: boolean;
4819
+ replaceSession(newSession: UserSession | null): void;
4820
+ hasScope(scope: OAuth2Scope): boolean;
4821
+ subscribe(subscriber: (event: UserSessionManagerEvent) => void): () => void;
4822
+ }
4823
+
4824
+ export declare type UserSessionManagerEvent = {
4825
+ type: "currentChanged";
4826
+ };
4827
+
4828
+ /**
4829
+ * ValidationError
4830
+ */
4831
+ export declare type ValidationError = {
4832
+ /**
4833
+ * Location
4834
+ */
4835
+ loc: Array<string | number>;
4836
+ /**
4837
+ * Message
4838
+ */
4839
+ msg: string;
4840
+ /**
4841
+ * Error Type
4842
+ */
4843
+ type: string;
4844
+ /**
4845
+ * Input
4846
+ */
4847
+ input?: unknown;
4848
+ /**
4849
+ * Context
4850
+ */
4851
+ ctx?: {
4852
+ [key: string]: unknown;
4853
+ };
4854
+ };
4855
+
4856
+ /**
4857
+ * ValidationError
4858
+ */
4859
+ export declare const ValidationErrorSchema: z.ZodObject<{
4860
+ loc: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
4861
+ msg: z.ZodString;
4862
+ type: z.ZodString;
4863
+ input: z.ZodOptional<z.ZodUnknown>;
4864
+ ctx: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
4865
+ }, z.core.$strip>;
4866
+
4867
+ export declare type VerifyEmailVerifyEmailPostData = {
4868
+ body?: never;
4869
+ path?: never;
4870
+ query: {
4871
+ /**
4872
+ * Token
4873
+ *
4874
+ * A feature token
4875
+ */
4876
+ token: string;
4877
+ };
4878
+ url: "/verify-email";
4879
+ };
4880
+
4881
+ export declare type VerifyEmailVerifyEmailPostError = VerifyEmailVerifyEmailPostErrors[keyof VerifyEmailVerifyEmailPostErrors];
4882
+
4883
+ export declare type VerifyEmailVerifyEmailPostErrors = {
4884
+ /**
4885
+ * Validation Error
4886
+ */
4887
+ 422: HttpValidationError;
4888
+ };
4889
+
4890
+ export declare type VerifyEmailVerifyEmailPostResponse = VerifyEmailVerifyEmailPostResponses[keyof VerifyEmailVerifyEmailPostResponses];
4891
+
4892
+ export declare type VerifyEmailVerifyEmailPostResponses = {
4893
+ /**
4894
+ * Successful Response
4895
+ */
4896
+ 200: OperationResult;
4897
+ };
4898
+
4899
+ export { }