tsarr 1.1.1 → 1.1.2

package/dist/clients/radarr.d.ts

@@ -0,0 +1,1007 @@
+import type { ServarrClientConfig } from '../core/types.js';
+import * as RadarrApi from '../generated/radarr/index.js';
+import type { CommandResource, CustomFormatBulkResource, CustomFormatResource, DownloadClientBulkResource, DownloadClientResource, ImportListResource, IndexerResource, MovieResource, NotificationResource, QualityProfileResource } from '../generated/radarr/types.gen.js';
+/**
+ * Radarr API client for movie management
+ *
+ * @example
+ * ```typescript
+ * const radarr = new RadarrClient({
+ *   baseUrl: 'http://localhost:7878',
+ *   apiKey: 'your-api-key'
+ * });
+ *
+ * const movies = await radarr.getMovies();
+ * ```
+ */
+export declare class RadarrClient {
+    private clientConfig;
+    constructor(config: ServarrClientConfig);
+    /**
+     * Get Radarr system status and version information
+     */
+    getSystemStatus(): Promise<({
+        data: RadarrApi.SystemResource;
+        error: undefined;
+    } | {
+        data: undefined;
+        error: unknown;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get system health check results
+     */
+    getHealth(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3HealthResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all movies in the library
+     */
+    getMovies(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3MovieResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific movie by ID
+     */
+    getMovie(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.MovieResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Add a new movie to the library
+     */
+    addMovie(movie: MovieResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.MovieResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    updateMovie(id: number, movie: MovieResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.MovieResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    deleteMovie(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Search for movies using TMDB database
+     */
+    searchMovies(term: string): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3MovieLookupResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Execute a Radarr command (scan, search, etc.)
+     */
+    runCommand(command: CommandResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.CommandResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    getCommands(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3CommandResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all configured root folders
+     */
+    getRootFolders(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3RootfolderResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    addRootFolder(path: string): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.RootFolderResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    deleteRootFolder(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    getFilesystem(path?: string): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    getMediaFiles(path: string): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Import physical movie files into the library
+     */
+    importMovies(movies: any[]): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.PostApiV3MovieImportResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all quality profiles
+     */
+    getQualityProfiles(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3QualityprofileResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific quality profile by ID
+     */
+    getQualityProfile(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QualityProfileResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Create a new quality profile
+     */
+    addQualityProfile(profile: QualityProfileResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QualityProfileResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing quality profile
+     */
+    updateQualityProfile(id: number, profile: QualityProfileResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QualityProfileResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete a quality profile
+     */
+    deleteQualityProfile(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get quality profile schema for creating new profiles
+     */
+    getQualityProfileSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QualityProfileResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all custom formats
+     */
+    getCustomFormats(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3CustomformatResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific custom format by ID
+     */
+    getCustomFormat(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.CustomFormatResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Create a new custom format
+     */
+    addCustomFormat(format: CustomFormatResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.CustomFormatResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing custom format
+     */
+    updateCustomFormat(id: number, format: CustomFormatResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.CustomFormatResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete a custom format
+     */
+    deleteCustomFormat(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Bulk update custom formats
+     */
+    updateCustomFormatsBulk(formats: CustomFormatBulkResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.CustomFormatResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Bulk delete custom formats
+     */
+    deleteCustomFormatsBulk(ids: number[]): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get custom format schema for creating new formats
+     */
+    getCustomFormatSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all download clients
+     */
+    getDownloadClients(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3DownloadclientResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific download client by ID
+     */
+    getDownloadClient(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.DownloadClientResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Add a new download client
+     */
+    addDownloadClient(client: DownloadClientResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.DownloadClientResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing download client
+     */
+    updateDownloadClient(id: number, client: DownloadClientResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.DownloadClientResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete a download client
+     */
+    deleteDownloadClient(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Bulk update download clients
+     */
+    updateDownloadClientsBulk(clients: DownloadClientBulkResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.DownloadClientResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Bulk delete download clients
+     */
+    deleteDownloadClientsBulk(ids: number[]): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get download client schema for available client types
+     */
+    getDownloadClientSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3DownloadclientSchemaResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test a download client configuration
+     */
+    testDownloadClient(client: DownloadClientResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test all download clients
+     */
+    testAllDownloadClients(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all notification providers
+     */
+    getNotifications(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3NotificationResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific notification provider by ID
+     */
+    getNotification(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.NotificationResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Add a new notification provider
+     */
+    addNotification(notification: NotificationResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.NotificationResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing notification provider
+     */
+    updateNotification(id: number, notification: NotificationResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.NotificationResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete a notification provider
+     */
+    deleteNotification(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get notification schema for available notification types
+     */
+    getNotificationSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3NotificationSchemaResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test a notification configuration
+     */
+    testNotification(notification: NotificationResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test all notifications
+     */
+    testAllNotifications(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get upcoming movie releases in calendar format
+     */
+    getCalendar(startDate?: string, endDate?: string, unmonitored?: boolean): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3CalendarResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get calendar feed in iCal format
+     */
+    getCalendarFeed(pastDays?: number, futureDays?: number, tags?: string): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get download queue with optional filtering
+     */
+    getQueue(page?: number, pageSize?: number, sortKey?: string, sortDirection?: string, includeUnknownMovieItems?: boolean): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QueueResourcePagingResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Remove an item from the download queue
+     */
+    removeQueueItem(id: number, removeFromClient?: boolean, blocklist?: boolean): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Bulk remove items from the download queue
+     */
+    removeQueueItemsBulk(ids: number[], removeFromClient?: boolean, blocklist?: boolean): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Force grab/download a queue item
+     */
+    grabQueueItem(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Force grab/download multiple queue items
+     */
+    grabQueueItemsBulk(ids: number[]): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get detailed queue information
+     */
+    getQueueDetails(movieId?: number, includeMovie?: boolean): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3QueueDetailsResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get queue status summary
+     */
+    getQueueStatus(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.QueueStatusResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all import lists
+     */
+    getImportLists(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3ImportlistResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific import list by ID
+     */
+    getImportList(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.ImportListResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Add a new import list
+     */
+    addImportList(importList: ImportListResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.ImportListResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing import list
+     */
+    updateImportList(id: number, importList: ImportListResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.ImportListResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete an import list
+     */
+    deleteImportList(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get import list schema for available list types
+     */
+    getImportListSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3ImportlistSchemaResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test an import list configuration
+     */
+    testImportList(importList: ImportListResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test all import lists
+     */
+    testAllImportLists(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get all indexers
+     */
+    getIndexers(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3IndexerResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get a specific indexer by ID
+     */
+    getIndexer(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.IndexerResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Add a new indexer
+     */
+    addIndexer(indexer: IndexerResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.IndexerResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Update an existing indexer
+     */
+    updateIndexer(id: number, indexer: IndexerResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.IndexerResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Delete an indexer
+     */
+    deleteIndexer(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get indexer schema for available indexer types
+     */
+    getIndexerSchema(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3IndexerSchemaResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test an indexer configuration
+     */
+    testIndexer(indexer: IndexerResource): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Test all indexers
+     */
+    testAllIndexers(): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get activity history
+     */
+    getHistory(page?: number, pageSize?: number, sortKey?: string, sortDirection?: string, movieId?: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.HistoryResourcePagingResource;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get history since a specific date
+     */
+    getHistorySince(date: string, movieId?: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3HistorySinceResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Get history for a specific movie
+     */
+    getMovieHistory(movieId: number, eventType?: any): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: RadarrApi.GetApiV3HistoryMovieResponse;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    /**
+     * Mark a failed download as failed in history
+     */
+    markHistoryItemFailed(id: number): Promise<({
+        data: undefined;
+        error: unknown;
+    } | {
+        data: unknown;
+        error: undefined;
+    }) & {
+        request: Request;
+        response: Response;
+    }>;
+    updateConfig(newConfig: Partial<ServarrClientConfig>): {
+        baseUrl: string;
+        apiKey: string;
+        timeout?: number;
+        headers?: Record<string, string>;
+    };
+}
+//# sourceMappingURL=radarr.d.ts.map