tsarr 2.9.1 → 2.11.0

package/dist/clients/readarr.d.ts

@@ -1,4 +1,5 @@
 import { ServarrBaseClient, type ServarrOps } from '../clients/base';
+import type { ServarrClientConfig } from '../core/types';
 import * as ReadarrApi from '../generated/readarr/index';
 import type { AuthorResourceWritable, BookFileListResource, BookFileResourceWritable, BookResource, CustomFormatResource, DevelopmentConfigResource, ImportListResource, MediaManagementConfigResource, MetadataProviderConfigResource, NamingConfigResource, QualityProfileResource } from '../generated/readarr/types.gen';
 /**
@@ -16,7 +17,7 @@ import type { AuthorResourceWritable, BookFileListResource, BookFileResourceWrit
  */
 export declare class ReadarrClient extends ServarrBaseClient {
     protected readonly ops: ServarrOps;
-    protected configureRawClient(): void;
+    constructor(config: ServarrClientConfig);
     /**
      * Get all authors in the library
      */
@@ -27,8 +28,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.AuthorResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getAuthor(id: number): Promise<({
         data: undefined;
@@ -37,8 +38,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.AuthorResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     addAuthor(author: AuthorResourceWritable): Promise<({
         data: undefined;
@@ -47,8 +48,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.AuthorResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     updateAuthor(id: number, author: AuthorResourceWritable): Promise<({
         data: undefined;
@@ -57,8 +58,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.AuthorResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     deleteAuthor(id: number): Promise<({
         data: undefined;
@@ -67,8 +68,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getBooks(): Promise<({
         data: undefined;
@@ -77,8 +78,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getBook(id: number): Promise<({
         data: undefined;
@@ -87,8 +88,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Search for authors using Goodreads database
@@ -100,8 +101,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getRootFolders(): Promise<({
         data: undefined;
@@ -110,8 +111,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.RootFolderResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     addRootFolder(path: string): Promise<({
         data: undefined;
@@ -120,8 +121,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.RootFolderResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     deleteRootFolder(id: number): Promise<({
         data: undefined;
@@ -130,8 +131,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get naming configuration settings
@@ -143,8 +144,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.NamingConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get naming configuration by ID
@@ -156,8 +157,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.NamingConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update naming configuration
@@ -169,8 +170,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.NamingConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get naming configuration examples
@@ -182,8 +183,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get media management configuration settings
@@ -195,8 +196,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MediaManagementConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get media management configuration by ID
@@ -208,8 +209,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MediaManagementConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update media management configuration
@@ -221,8 +222,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MediaManagementConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get development configuration settings
@@ -234,8 +235,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.DevelopmentConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get development configuration by ID
@@ -247,8 +248,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.DevelopmentConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update development configuration
@@ -260,8 +261,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.DevelopmentConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get metadata provider configuration settings
@@ -273,8 +274,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MetadataProviderConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get metadata provider configuration by ID
@@ -286,8 +287,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MetadataProviderConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update metadata provider configuration
@@ -299,8 +300,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.MetadataProviderConfigResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get system logs
@@ -312,8 +313,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.LogResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get disk space information
@@ -325,8 +326,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.DiskSpaceResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Add a new book
@@ -338,8 +339,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update an existing book
@@ -351,8 +352,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Delete a book
@@ -364,8 +365,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Search for books
@@ -377,8 +378,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getCalendar(start?: string, end?: string, unmonitored?: boolean): Promise<({
         data: undefined;
@@ -387,8 +388,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     getCalendarFeed(pastDays?: number, futureDays?: number, tagList?: string): Promise<({
         data: undefined;
@@ -397,8 +398,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get book files by author, book, or specific file IDs
@@ -410,8 +411,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookFileResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get a specific book file by ID
@@ -423,8 +424,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookFileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update a book file
@@ -436,8 +437,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookFileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Delete a book file from disk
@@ -449,8 +450,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Bulk update book files using the editor endpoint
@@ -462,8 +463,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Bulk delete book files
@@ -475,8 +476,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get all quality profiles
@@ -488,8 +489,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QualityProfileResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get a specific quality profile by ID
@@ -501,8 +502,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QualityProfileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Create a new quality profile
@@ -514,8 +515,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QualityProfileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update an existing quality profile
@@ -527,8 +528,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QualityProfileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Delete a quality profile
@@ -540,8 +541,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get quality profile schema
@@ -553,8 +554,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QualityProfileResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get all custom formats
@@ -566,8 +567,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.CustomFormatResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get a specific custom format by ID
@@ -579,8 +580,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.CustomFormatResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Create a new custom format
@@ -592,8 +593,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.CustomFormatResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update an existing custom format
@@ -605,8 +606,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.CustomFormatResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Delete a custom format
@@ -618,8 +619,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get custom format schema
@@ -631,8 +632,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get all import lists
@@ -644,8 +645,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.ImportListResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get a specific import list by ID
@@ -657,8 +658,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.ImportListResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Add a new import list
@@ -670,8 +671,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.ImportListResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Update an existing import list
@@ -683,8 +684,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.ImportListResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Delete an import list
@@ -696,8 +697,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get import list schema for available list types
@@ -709,8 +710,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.ImportListResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Test an import list configuration
@@ -722,8 +723,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Test all import lists
@@ -735,8 +736,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get activity history
@@ -748,8 +749,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.HistoryResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get history since a specific date
@@ -761,8 +762,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.HistoryResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get history for a specific author
@@ -774,8 +775,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.HistoryResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Mark a failed download as failed in history
@@ -787,8 +788,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get download queue
@@ -800,8 +801,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QueueResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Remove an item from the download queue
@@ -813,8 +814,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Bulk remove items from the download queue
@@ -826,8 +827,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Force grab a queue item
@@ -839,8 +840,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Force grab multiple queue items
@@ -852,8 +853,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get detailed queue information
@@ -865,8 +866,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QueueResource[];
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get queue status summary
@@ -878,8 +879,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.QueueStatusResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get blocked releases
@@ -891,8 +892,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BlocklistResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Remove a release from the blocklist
@@ -904,8 +905,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Bulk remove releases from the blocklist
@@ -917,8 +918,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: unknown;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get books with missing files
@@ -930,8 +931,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
     /**
      * Get books below cutoff quality
@@ -943,8 +944,8 @@ export declare class ReadarrClient extends ServarrBaseClient {
         data: ReadarrApi.BookResourcePagingResource;
         error: undefined;
     }) & {
-        request: Request;
-        response: Response;
+        request?: Request;
+        response?: Response;
     }>;
 }
 export * from './readarr-types.js';