@redseat/api 0.1.8 → 0.1.9

package/dist/library.d.ts

@@ -176,7 +176,31 @@ export declare class LibraryApi {
     updatePersonPortrait(personId: string, portrait: FormData): Promise<void>;
     searchSeries(name: string): Promise<ISerie[]>;
     setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>;
+    /**
+     * Searches for available media sources for a specific episode.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @returns Array of available media requests that can be used to download/stream the episode
+     */
     searchEpisodeMedias(serieId: string, season: number, episode: number): Promise<RsRequest[]>;
+    /**
+     * Adds a searched episode media to the database for download/storage.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @param request - The media request to add (typically from searchEpisodeMedias results)
+     * @returns The created media file entry
+     */
+    addSearchedEpisodeMedia(serieId: string, season: number, episode: number, request: RsRequest): Promise<IFile>;
+    /**
+     * Checks if a request can be made permanent (saved for later use).
+     * Tests the availability of the URL and returns a permanent version if valid.
+     * @param request - The request to check for permanence
+     * @returns The request with `permanent: true` if the URL is valid and can be saved
+     * @throws Error if the URL is not available or cannot be made permanent
+     */
+    checkRequestPermanent(request: RsRequest): Promise<RsRequest>;
     getUnassignedFaces(params?: Map<string, string>): Promise<any>;
     getClusters(): Promise<any>;
     assignFaces(request: any): Promise<any>;

package/dist/library.js

@@ -425,10 +425,40 @@ export class LibraryApi {
     async setEpisodeWatched(serieId, season, number, date) {
         await this.client.post(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${number}/watched`), { date });
     }
+    /**
+     * Searches for available media sources for a specific episode.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @returns Array of available media requests that can be used to download/stream the episode
+     */
     async searchEpisodeMedias(serieId, season, episode) {
         const res = await this.client.get(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${episode}/search`));
         return res.data;
     }
+    /**
+     * Adds a searched episode media to the database for download/storage.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @param request - The media request to add (typically from searchEpisodeMedias results)
+     * @returns The created media file entry
+     */
+    async addSearchedEpisodeMedia(serieId, season, episode, request) {
+        const res = await this.client.post(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${episode}/search`), request);
+        return res.data;
+    }
+    /**
+     * Checks if a request can be made permanent (saved for later use).
+     * Tests the availability of the URL and returns a permanent version if valid.
+     * @param request - The request to check for permanence
+     * @returns The request with `permanent: true` if the URL is valid and can be saved
+     * @throws Error if the URL is not available or cannot be made permanent
+     */
+    async checkRequestPermanent(request) {
+        const res = await this.client.post(this.getUrl('/plugins/requests/permanent'), request);
+        return res.data;
+    }
     async getUnassignedFaces(params) {
         const queryParams = {};
         if (params) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@redseat/api",
-    "version": "0.1.8",
+    "version": "0.1.9",
     "description": "TypeScript API client library for interacting with Redseat servers",
     "type": "module",
     "main": "./dist/index.js",