tsarr 2.9.0 → 2.10.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.
Files changed (49) hide show
  1. package/README.md +7 -5
  2. package/dist/cli/commands/bazarr.d.ts +2 -0
  3. package/dist/cli/commands/bazarr.d.ts.map +1 -1
  4. package/dist/cli/commands/config.d.ts.map +1 -1
  5. package/dist/cli/commands/lidarr.d.ts +2 -0
  6. package/dist/cli/commands/lidarr.d.ts.map +1 -1
  7. package/dist/cli/commands/radarr.d.ts.map +1 -1
  8. package/dist/cli/commands/readarr.d.ts +2 -0
  9. package/dist/cli/commands/readarr.d.ts.map +1 -1
  10. package/dist/cli/commands/sonarr.d.ts.map +1 -1
  11. package/dist/cli/index.js +2138 -2405
  12. package/dist/clients/base.d.ts +136 -0
  13. package/dist/clients/base.d.ts.map +1 -0
  14. package/dist/clients/bazarr.d.ts +1 -1
  15. package/dist/clients/bazarr.d.ts.map +1 -1
  16. package/dist/clients/bazarr.js +100 -3
  17. package/dist/clients/lidarr.d.ts +24 -681
  18. package/dist/clients/lidarr.d.ts.map +1 -1
  19. package/dist/clients/lidarr.js +323 -196
  20. package/dist/clients/prowlarr.d.ts +25 -638
  21. package/dist/clients/prowlarr.d.ts.map +1 -1
  22. package/dist/clients/prowlarr.js +331 -175
  23. package/dist/clients/qbittorrent.d.ts +1 -17
  24. package/dist/clients/qbittorrent.d.ts.map +1 -1
  25. package/dist/clients/qbittorrent.js +97 -2
  26. package/dist/clients/radarr.d.ts +4 -657
  27. package/dist/clients/radarr.d.ts.map +1 -1
  28. package/dist/clients/radarr.js +323 -164
  29. package/dist/clients/readarr.d.ts +4 -635
  30. package/dist/clients/readarr.d.ts.map +1 -1
  31. package/dist/clients/readarr.js +323 -164
  32. package/dist/clients/seerr.d.ts +1 -1
  33. package/dist/clients/seerr.d.ts.map +1 -1
  34. package/dist/clients/seerr.js +100 -3
  35. package/dist/clients/sonarr.d.ts +181 -772
  36. package/dist/clients/sonarr.d.ts.map +1 -1
  37. package/dist/clients/sonarr.js +346 -157
  38. package/dist/core/client.d.ts +3 -0
  39. package/dist/core/client.d.ts.map +1 -1
  40. package/dist/core/fetch.d.ts +23 -0
  41. package/dist/core/fetch.d.ts.map +1 -0
  42. package/dist/core/index.d.ts +1 -0
  43. package/dist/core/index.d.ts.map +1 -1
  44. package/dist/core/types.d.ts +7 -0
  45. package/dist/core/types.d.ts.map +1 -1
  46. package/dist/index.js +1 -1
  47. package/dist/tsarr-2.10.0.tgz +0 -0
  48. package/package.json +2 -4
  49. package/dist/tsarr-2.9.0.tgz +0 -0
@@ -1,6 +1,7 @@
1
+ import { ServarrBaseClient, type ServarrOps } from '../clients/base';
1
2
  import type { ServarrClientConfig } from '../core/types';
2
3
  import * as ReadarrApi from '../generated/readarr/index';
3
- import type { AuthorResourceWritable, BookFileListResource, BookFileResourceWritable, BookResource, CommandResource, CustomFormatResource, DevelopmentConfigResource, DownloadClientResource, HostConfigResource, ImportListResource, IndexerResource, MediaManagementConfigResource, MetadataProviderConfigResource, NamingConfigResource, NotificationResource, QualityProfileResource, TagResource, UiConfigResource } from '../generated/readarr/types.gen';
4
+ import type { AuthorResourceWritable, BookFileListResource, BookFileResourceWritable, BookResource, CustomFormatResource, DevelopmentConfigResource, ImportListResource, MediaManagementConfigResource, MetadataProviderConfigResource, NamingConfigResource, QualityProfileResource } from '../generated/readarr/types.gen';
4
5
  /**
5
6
  * Readarr API client for book management
6
7
  *
@@ -14,29 +15,9 @@ import type { AuthorResourceWritable, BookFileListResource, BookFileResourceWrit
14
15
  * const authors = await readarr.getAuthors();
15
16
  * ```
16
17
  */
17
- export declare class ReadarrClient {
18
- private clientConfig;
18
+ export declare class ReadarrClient extends ServarrBaseClient {
19
+ protected readonly ops: ServarrOps;
19
20
  constructor(config: ServarrClientConfig);
20
- getSystemStatus(): Promise<({
21
- data: undefined;
22
- error: unknown;
23
- } | {
24
- data: ReadarrApi.SystemResource;
25
- error: undefined;
26
- }) & {
27
- request: Request;
28
- response: Response;
29
- }>;
30
- getHealth(): Promise<({
31
- data: undefined;
32
- error: unknown;
33
- } | {
34
- data: ReadarrApi.HealthResource[];
35
- error: undefined;
36
- }) & {
37
- request: Request;
38
- response: Response;
39
- }>;
40
21
  /**
41
22
  * Get all authors in the library
42
23
  */
@@ -123,26 +104,6 @@ export declare class ReadarrClient {
123
104
  request: Request;
124
105
  response: Response;
125
106
  }>;
126
- runCommand(command: CommandResource): Promise<({
127
- data: undefined;
128
- error: unknown;
129
- } | {
130
- data: ReadarrApi.CommandResource;
131
- error: undefined;
132
- }) & {
133
- request: Request;
134
- response: Response;
135
- }>;
136
- getCommands(): Promise<({
137
- data: undefined;
138
- error: unknown;
139
- } | {
140
- data: ReadarrApi.CommandResource[];
141
- error: undefined;
142
- }) & {
143
- request: Request;
144
- response: Response;
145
- }>;
146
107
  getRootFolders(): Promise<({
147
108
  data: undefined;
148
109
  error: unknown;
@@ -173,45 +134,6 @@ export declare class ReadarrClient {
173
134
  request: Request;
174
135
  response: Response;
175
136
  }>;
176
- /**
177
- * Get host configuration settings
178
- */
179
- getHostConfig(): Promise<({
180
- data: undefined;
181
- error: unknown;
182
- } | {
183
- data: ReadarrApi.HostConfigResource;
184
- error: undefined;
185
- }) & {
186
- request: Request;
187
- response: Response;
188
- }>;
189
- /**
190
- * Get host configuration by ID
191
- */
192
- getHostConfigById(id: number): Promise<({
193
- data: undefined;
194
- error: unknown;
195
- } | {
196
- data: ReadarrApi.HostConfigResource;
197
- error: undefined;
198
- }) & {
199
- request: Request;
200
- response: Response;
201
- }>;
202
- /**
203
- * Update host configuration
204
- */
205
- updateHostConfig(id: number, config: HostConfigResource): Promise<({
206
- data: undefined;
207
- error: unknown;
208
- } | {
209
- data: ReadarrApi.HostConfigResource;
210
- error: undefined;
211
- }) & {
212
- request: Request;
213
- response: Response;
214
- }>;
215
137
  /**
216
138
  * Get naming configuration settings
217
139
  */
@@ -303,45 +225,6 @@ export declare class ReadarrClient {
303
225
  request: Request;
304
226
  response: Response;
305
227
  }>;
306
- /**
307
- * Get UI configuration settings
308
- */
309
- getUiConfig(): Promise<({
310
- data: undefined;
311
- error: unknown;
312
- } | {
313
- data: ReadarrApi.UiConfigResource;
314
- error: undefined;
315
- }) & {
316
- request: Request;
317
- response: Response;
318
- }>;
319
- /**
320
- * Get UI configuration by ID
321
- */
322
- getUiConfigById(id: number): Promise<({
323
- data: undefined;
324
- error: unknown;
325
- } | {
326
- data: ReadarrApi.UiConfigResource;
327
- error: undefined;
328
- }) & {
329
- request: Request;
330
- response: Response;
331
- }>;
332
- /**
333
- * Update UI configuration
334
- */
335
- updateUiConfig(id: number, config: UiConfigResource): Promise<({
336
- data: undefined;
337
- error: unknown;
338
- } | {
339
- data: ReadarrApi.UiConfigResource;
340
- error: undefined;
341
- }) & {
342
- request: Request;
343
- response: Response;
344
- }>;
345
228
  /**
346
229
  * Get development configuration settings
347
230
  */
@@ -420,84 +303,6 @@ export declare class ReadarrClient {
420
303
  request: Request;
421
304
  response: Response;
422
305
  }>;
423
- /**
424
- * Restart the Readarr application
425
- */
426
- restartSystem(): Promise<({
427
- data: undefined;
428
- error: unknown;
429
- } | {
430
- data: unknown;
431
- error: undefined;
432
- }) & {
433
- request: Request;
434
- response: Response;
435
- }>;
436
- /**
437
- * Shutdown the Readarr application
438
- */
439
- shutdownSystem(): Promise<({
440
- data: undefined;
441
- error: unknown;
442
- } | {
443
- data: unknown;
444
- error: undefined;
445
- }) & {
446
- request: Request;
447
- response: Response;
448
- }>;
449
- /**
450
- * Get system backup files
451
- */
452
- getSystemBackups(): Promise<({
453
- data: undefined;
454
- error: unknown;
455
- } | {
456
- data: ReadarrApi.BackupResource[];
457
- error: undefined;
458
- }) & {
459
- request: Request;
460
- response: Response;
461
- }>;
462
- /**
463
- * Delete a system backup by ID
464
- */
465
- deleteSystemBackup(id: number): Promise<({
466
- data: undefined;
467
- error: unknown;
468
- } | {
469
- data: unknown;
470
- error: undefined;
471
- }) & {
472
- request: Request;
473
- response: Response;
474
- }>;
475
- /**
476
- * Restore system backup by ID
477
- */
478
- restoreSystemBackup(id: number): Promise<({
479
- data: undefined;
480
- error: unknown;
481
- } | {
482
- data: unknown;
483
- error: undefined;
484
- }) & {
485
- request: Request;
486
- response: Response;
487
- }>;
488
- /**
489
- * Upload and restore system backup
490
- */
491
- uploadSystemBackup(): Promise<({
492
- data: undefined;
493
- error: unknown;
494
- } | {
495
- data: unknown;
496
- error: undefined;
497
- }) & {
498
- request: Request;
499
- response: Response;
500
- }>;
501
306
  /**
502
307
  * Get system logs
503
308
  */
@@ -511,32 +316,6 @@ export declare class ReadarrClient {
511
316
  request: Request;
512
317
  response: Response;
513
318
  }>;
514
- /**
515
- * Get log files
516
- */
517
- getLogFiles(): Promise<({
518
- data: undefined;
519
- error: unknown;
520
- } | {
521
- data: ReadarrApi.LogFileResource[];
522
- error: undefined;
523
- }) & {
524
- request: Request;
525
- response: Response;
526
- }>;
527
- /**
528
- * Get specific log file by filename
529
- */
530
- getLogFileByName(filename: string): Promise<({
531
- data: undefined;
532
- error: unknown;
533
- } | {
534
- data: unknown;
535
- error: undefined;
536
- }) & {
537
- request: Request;
538
- response: Response;
539
- }>;
540
319
  /**
541
320
  * Get disk space information
542
321
  */
@@ -550,97 +329,6 @@ export declare class ReadarrClient {
550
329
  request: Request;
551
330
  response: Response;
552
331
  }>;
553
- /**
554
- * Get all tags
555
- */
556
- getTags(): Promise<({
557
- data: undefined;
558
- error: unknown;
559
- } | {
560
- data: ReadarrApi.TagResource[];
561
- error: undefined;
562
- }) & {
563
- request: Request;
564
- response: Response;
565
- }>;
566
- /**
567
- * Add a new tag
568
- */
569
- addTag(tag: TagResource): Promise<({
570
- data: undefined;
571
- error: unknown;
572
- } | {
573
- data: ReadarrApi.TagResource;
574
- error: undefined;
575
- }) & {
576
- request: Request;
577
- response: Response;
578
- }>;
579
- /**
580
- * Get a specific tag by ID
581
- */
582
- getTag(id: number): Promise<({
583
- data: undefined;
584
- error: unknown;
585
- } | {
586
- data: ReadarrApi.TagResource;
587
- error: undefined;
588
- }) & {
589
- request: Request;
590
- response: Response;
591
- }>;
592
- /**
593
- * Update an existing tag
594
- */
595
- updateTag(id: number, tag: TagResource): Promise<({
596
- data: undefined;
597
- error: unknown;
598
- } | {
599
- data: ReadarrApi.TagResource;
600
- error: undefined;
601
- }) & {
602
- request: Request;
603
- response: Response;
604
- }>;
605
- /**
606
- * Delete a tag
607
- */
608
- deleteTag(id: number): Promise<({
609
- data: undefined;
610
- error: unknown;
611
- } | {
612
- data: unknown;
613
- error: undefined;
614
- }) & {
615
- request: Request;
616
- response: Response;
617
- }>;
618
- /**
619
- * Get detailed tag information
620
- */
621
- getTagDetails(): Promise<({
622
- data: undefined;
623
- error: unknown;
624
- } | {
625
- data: ReadarrApi.TagDetailsResource[];
626
- error: undefined;
627
- }) & {
628
- request: Request;
629
- response: Response;
630
- }>;
631
- /**
632
- * Get detailed tag information by ID
633
- */
634
- getTagDetailById(id: number): Promise<({
635
- data: undefined;
636
- error: unknown;
637
- } | {
638
- data: ReadarrApi.TagDetailsResource;
639
- error: undefined;
640
- }) & {
641
- request: Request;
642
- response: Response;
643
- }>;
644
332
  /**
645
333
  * Add a new book
646
334
  */
@@ -947,214 +635,6 @@ export declare class ReadarrClient {
947
635
  request: Request;
948
636
  response: Response;
949
637
  }>;
950
- /**
951
- * Get all download clients
952
- */
953
- getDownloadClients(): Promise<({
954
- data: undefined;
955
- error: unknown;
956
- } | {
957
- data: ReadarrApi.DownloadClientResource[];
958
- error: undefined;
959
- }) & {
960
- request: Request;
961
- response: Response;
962
- }>;
963
- /**
964
- * Get a specific download client by ID
965
- */
966
- getDownloadClient(id: number): Promise<({
967
- data: undefined;
968
- error: unknown;
969
- } | {
970
- data: ReadarrApi.DownloadClientResource;
971
- error: undefined;
972
- }) & {
973
- request: Request;
974
- response: Response;
975
- }>;
976
- /**
977
- * Add a new download client
978
- */
979
- addDownloadClient(client: DownloadClientResource): Promise<({
980
- data: undefined;
981
- error: unknown;
982
- } | {
983
- data: ReadarrApi.DownloadClientResource;
984
- error: undefined;
985
- }) & {
986
- request: Request;
987
- response: Response;
988
- }>;
989
- /**
990
- * Update an existing download client
991
- */
992
- updateDownloadClient(id: number, client: DownloadClientResource): Promise<({
993
- data: undefined;
994
- error: unknown;
995
- } | {
996
- data: ReadarrApi.DownloadClientResource;
997
- error: undefined;
998
- }) & {
999
- request: Request;
1000
- response: Response;
1001
- }>;
1002
- /**
1003
- * Delete a download client
1004
- */
1005
- deleteDownloadClient(id: number): Promise<({
1006
- data: undefined;
1007
- error: unknown;
1008
- } | {
1009
- data: unknown;
1010
- error: undefined;
1011
- }) & {
1012
- request: Request;
1013
- response: Response;
1014
- }>;
1015
- /**
1016
- * Get download client schema for available client types
1017
- */
1018
- getDownloadClientSchema(): Promise<({
1019
- data: undefined;
1020
- error: unknown;
1021
- } | {
1022
- data: ReadarrApi.DownloadClientResource[];
1023
- error: undefined;
1024
- }) & {
1025
- request: Request;
1026
- response: Response;
1027
- }>;
1028
- /**
1029
- * Test a download client configuration
1030
- */
1031
- testDownloadClient(client: DownloadClientResource): Promise<({
1032
- data: undefined;
1033
- error: unknown;
1034
- } | {
1035
- data: unknown;
1036
- error: undefined;
1037
- }) & {
1038
- request: Request;
1039
- response: Response;
1040
- }>;
1041
- /**
1042
- * Test all download clients
1043
- */
1044
- testAllDownloadClients(): Promise<({
1045
- data: undefined;
1046
- error: unknown;
1047
- } | {
1048
- data: unknown;
1049
- error: undefined;
1050
- }) & {
1051
- request: Request;
1052
- response: Response;
1053
- }>;
1054
- /**
1055
- * Get all indexers
1056
- */
1057
- getIndexers(): Promise<({
1058
- data: undefined;
1059
- error: unknown;
1060
- } | {
1061
- data: ReadarrApi.IndexerResource[];
1062
- error: undefined;
1063
- }) & {
1064
- request: Request;
1065
- response: Response;
1066
- }>;
1067
- /**
1068
- * Get a specific indexer by ID
1069
- */
1070
- getIndexer(id: number): Promise<({
1071
- data: undefined;
1072
- error: unknown;
1073
- } | {
1074
- data: ReadarrApi.IndexerResource;
1075
- error: undefined;
1076
- }) & {
1077
- request: Request;
1078
- response: Response;
1079
- }>;
1080
- /**
1081
- * Add a new indexer
1082
- */
1083
- addIndexer(indexer: IndexerResource): Promise<({
1084
- data: undefined;
1085
- error: unknown;
1086
- } | {
1087
- data: ReadarrApi.IndexerResource;
1088
- error: undefined;
1089
- }) & {
1090
- request: Request;
1091
- response: Response;
1092
- }>;
1093
- /**
1094
- * Update an existing indexer
1095
- */
1096
- updateIndexer(id: number, indexer: IndexerResource): Promise<({
1097
- data: undefined;
1098
- error: unknown;
1099
- } | {
1100
- data: ReadarrApi.IndexerResource;
1101
- error: undefined;
1102
- }) & {
1103
- request: Request;
1104
- response: Response;
1105
- }>;
1106
- /**
1107
- * Delete an indexer
1108
- */
1109
- deleteIndexer(id: number): Promise<({
1110
- data: undefined;
1111
- error: unknown;
1112
- } | {
1113
- data: unknown;
1114
- error: undefined;
1115
- }) & {
1116
- request: Request;
1117
- response: Response;
1118
- }>;
1119
- /**
1120
- * Get indexer schema for available indexer types
1121
- */
1122
- getIndexerSchema(): Promise<({
1123
- data: undefined;
1124
- error: unknown;
1125
- } | {
1126
- data: ReadarrApi.IndexerResource[];
1127
- error: undefined;
1128
- }) & {
1129
- request: Request;
1130
- response: Response;
1131
- }>;
1132
- /**
1133
- * Test an indexer configuration
1134
- */
1135
- testIndexer(indexer: IndexerResource): Promise<({
1136
- data: undefined;
1137
- error: unknown;
1138
- } | {
1139
- data: unknown;
1140
- error: undefined;
1141
- }) & {
1142
- request: Request;
1143
- response: Response;
1144
- }>;
1145
- /**
1146
- * Test all indexers
1147
- */
1148
- testAllIndexers(): Promise<({
1149
- data: undefined;
1150
- error: unknown;
1151
- } | {
1152
- data: unknown;
1153
- error: undefined;
1154
- }) & {
1155
- request: Request;
1156
- response: Response;
1157
- }>;
1158
638
  /**
1159
639
  * Get all import lists
1160
640
  */
@@ -1259,110 +739,6 @@ export declare class ReadarrClient {
1259
739
  request: Request;
1260
740
  response: Response;
1261
741
  }>;
1262
- /**
1263
- * Get all notification providers
1264
- */
1265
- getNotifications(): Promise<({
1266
- data: undefined;
1267
- error: unknown;
1268
- } | {
1269
- data: ReadarrApi.NotificationResource[];
1270
- error: undefined;
1271
- }) & {
1272
- request: Request;
1273
- response: Response;
1274
- }>;
1275
- /**
1276
- * Get a specific notification provider by ID
1277
- */
1278
- getNotification(id: number): Promise<({
1279
- data: undefined;
1280
- error: unknown;
1281
- } | {
1282
- data: ReadarrApi.NotificationResource;
1283
- error: undefined;
1284
- }) & {
1285
- request: Request;
1286
- response: Response;
1287
- }>;
1288
- /**
1289
- * Add a new notification provider
1290
- */
1291
- addNotification(notification: NotificationResource): Promise<({
1292
- data: undefined;
1293
- error: unknown;
1294
- } | {
1295
- data: ReadarrApi.NotificationResource;
1296
- error: undefined;
1297
- }) & {
1298
- request: Request;
1299
- response: Response;
1300
- }>;
1301
- /**
1302
- * Update an existing notification provider
1303
- */
1304
- updateNotification(id: number, notification: NotificationResource): Promise<({
1305
- data: undefined;
1306
- error: unknown;
1307
- } | {
1308
- data: ReadarrApi.NotificationResource;
1309
- error: undefined;
1310
- }) & {
1311
- request: Request;
1312
- response: Response;
1313
- }>;
1314
- /**
1315
- * Delete a notification provider
1316
- */
1317
- deleteNotification(id: number): Promise<({
1318
- data: undefined;
1319
- error: unknown;
1320
- } | {
1321
- data: unknown;
1322
- error: undefined;
1323
- }) & {
1324
- request: Request;
1325
- response: Response;
1326
- }>;
1327
- /**
1328
- * Get notification schema for available notification types
1329
- */
1330
- getNotificationSchema(): Promise<({
1331
- data: undefined;
1332
- error: unknown;
1333
- } | {
1334
- data: ReadarrApi.NotificationResource[];
1335
- error: undefined;
1336
- }) & {
1337
- request: Request;
1338
- response: Response;
1339
- }>;
1340
- /**
1341
- * Test a notification configuration
1342
- */
1343
- testNotification(notification: NotificationResource): Promise<({
1344
- data: undefined;
1345
- error: unknown;
1346
- } | {
1347
- data: unknown;
1348
- error: undefined;
1349
- }) & {
1350
- request: Request;
1351
- response: Response;
1352
- }>;
1353
- /**
1354
- * Test all notifications
1355
- */
1356
- testAllNotifications(): Promise<({
1357
- data: undefined;
1358
- error: unknown;
1359
- } | {
1360
- data: unknown;
1361
- error: undefined;
1362
- }) & {
1363
- request: Request;
1364
- response: Response;
1365
- }>;
1366
742
  /**
1367
743
  * Get activity history
1368
744
  */
@@ -1571,13 +947,6 @@ export declare class ReadarrClient {
1571
947
  request: Request;
1572
948
  response: Response;
1573
949
  }>;
1574
- updateConfig(newConfig: Partial<ServarrClientConfig>): {
1575
- baseUrl: string;
1576
- apiKey: string;
1577
- timeout?: number;
1578
- headers?: Record<string, string>;
1579
- };
1580
950
  }
1581
- export * from './readarr-types';
1582
951
  export * from './readarr-types.js';
1583
952
  //# sourceMappingURL=readarr.d.ts.map