@tdanks2000/tmdb-wrapper 1.0.0 → 1.0.2

package/dist/endpoints/tvSeasons.d.ts

@@ -1,25 +1,70 @@
-import { AggregateCredits, AppendToResponse, AppendToResponseTvSeasonKey, BaseEndpoint, ChangeOption, Changes, Credits, ExternalIds, Images, LanguageOption, SeasonDetails, SeasonSelection, Translations, TvSeasonChangeValue, Videos } from '@/@types';
-export interface TvSeasonImageSearchOptions extends LanguageOption {
+import { AggregateCredits, AppendToResponse, AppendToResponseTvSeasonKey, BaseEndpoint, ChangeOption, Changes, Credits, ExternalIds, Images, LanguageOption, SeasonDetails, SeasonSelection, Translations, TvSeasonChangeValue, TvSeasonImageSearchOptions, TvSeasonVideoSearchOptions, Videos } from '../@types';
+/**
+ * Represents an endpoint for accessing TV season-related information.
+ */
+export declare class TvSeasonsEndpoint extends BaseEndpoint {
     /**
-     * a list of ISO-639-1 values to query
+     * Constructs a new TvSeasonsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
      */
-    include_image_language?: string[];
-}
-export interface TvSeasonVideoSearchOptions extends LanguageOption {
+    constructor(access_token: string);
     /**
-     * a list of ISO-639-1 values to query
+     * Retrieves details of a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {AppendToResponseTvSeasonKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AppendToResponse<SeasonDetails, AppendToResponseTvSeasonKey[], 'tvSeason'>>}
+     * A Promise that resolves with the details of the TV season.
      */
-    include_video_language?: string[];
-}
-export declare class TvSeasonsEndpoint extends BaseEndpoint {
-    constructor(access_token: string);
     details<T extends AppendToResponseTvSeasonKey[] | undefined>(seasonSelection: SeasonSelection, appendToResponse?: T, options?: LanguageOption): Promise<AppendToResponse<SeasonDetails, T, "tvSeason">>;
+    /**
+     * Retrieves aggregate credits for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AggregateCredits>} A Promise that resolves with the aggregate credits for the TV season.
+     */
     aggregateCredits(seasonSelection: SeasonSelection, options?: LanguageOption): Promise<AggregateCredits>;
+    /**
+     * Retrieves changes related to a specific TV season asynchronously.
+     * @param {number} seasonId - The ID of the TV season.
+     * @param {ChangeOption} [options] - Optional parameters for specifying changes.
+     * @returns {Promise<Changes<TvSeasonChangeValue>>} A Promise that resolves with the changes related to the TV season.
+     */
     changes(seasonId: number, options?: ChangeOption): Promise<Changes<TvSeasonChangeValue>>;
+    /**
+     * Retrieves credits for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Credits>} A Promise that resolves with the credits for the TV season.
+     */
     credits(seasonSelection: SeasonSelection, options?: LanguageOption): Promise<Credits>;
+    /**
+     * Retrieves external IDs for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs for the TV season.
+     */
     externalIds(seasonSelection: SeasonSelection, options?: LanguageOption): Promise<ExternalIds>;
+    /**
+     * Retrieves images for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {TvSeasonImageSearchOptions} [options] - Optional parameters for specifying image search options.
+     * @returns {Promise<Images>} A Promise that resolves with the images for the TV season.
+     */
     images(seasonSelection: SeasonSelection, options?: TvSeasonImageSearchOptions): Promise<Images>;
+    /**
+     * Retrieves videos for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {TvSeasonVideoSearchOptions} [options] - Optional parameters for specifying video search options.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos for the TV season.
+     */
     videos(seasonSelection: SeasonSelection, options?: TvSeasonVideoSearchOptions): Promise<Videos>;
+    /**
+     * Retrieves translations for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Translations>} A Promise that resolves with the translations for the TV season.
+     */
     translations(seasonSelection: SeasonSelection, options?: LanguageOption): Promise<Translations>;
 }
 //# sourceMappingURL=tvSeasons.d.ts.map

package/dist/endpoints/tvSeasons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tvSeasons.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvSeasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,WAAW,EACX,MAAM,EACN,cAAc,EACd,aAAa,EACb,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,MAAM,EACP,MAAM,UAAU,CAAC;AAMlB,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,qBAAa,iBAAkB,SAAQ,YAAY;gBACrC,YAAY,EAAE,MAAM;IAI1B,OAAO,CAAC,CAAC,SAAS,2BAA2B,EAAE,GAAG,SAAS,EAC/D,eAAe,EAAE,eAAe,EAChC,gBAAgB,CAAC,EAAE,CAAC,EACpB,OAAO,CAAC,EAAE,cAAc;IAapB,gBAAgB,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAI3E,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIhD,OAAO,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAIlE,WAAW,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAItE,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,0BAA0B;IAQ7E,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,0BAA0B;IAQ7E,YAAY,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;CAG9E"}
+{"version":3,"file":"tvSeasons.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvSeasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,WAAW,EACX,MAAM,EACN,cAAc,EACd,aAAa,EACb,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,0BAA0B,EAC1B,0BAA0B,EAC1B,MAAM,EACP,MAAM,UAAU,CAAC;AAMlB;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,SAAS,2BAA2B,EAAE,GAAG,SAAS,EAC/D,eAAe,EAAE,eAAe,EAChC,gBAAgB,CAAC,EAAE,CAAC,EACpB,OAAO,CAAC,EAAE,cAAc;IAa1B;;;;;OAKG;IACG,gBAAgB,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAIjF;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAItD;;;;;OAKG;IACG,OAAO,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAIxE;;;;;OAKG;IACG,WAAW,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAI5E;;;;;OAKG;IACG,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,0BAA0B;IAQnF;;;;;OAKG;IACG,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,0BAA0B;IAQnF;;;;;OAKG;IACG,YAAY,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;CAG9E"}

package/dist/endpoints/tvSeasons.js

@@ -10,40 +10,85 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TvSeasonsEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
 const BASE_SEASON = (seasonSelection) => {
     return `/tv/${seasonSelection.tvShowID}/season/${seasonSelection.seasonNumber}`;
 };
+/**
+ * Represents an endpoint for accessing TV season-related information.
+ */
 class TvSeasonsEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new TvSeasonsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves details of a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {AppendToResponseTvSeasonKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AppendToResponse<SeasonDetails, AppendToResponseTvSeasonKey[], 'tvSeason'>>}
+     * A Promise that resolves with the details of the TV season.
+     */
     details(seasonSelection, appendToResponse, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const combinedOptions = Object.assign({ append_to_response: appendToResponse ? appendToResponse.join(',') : undefined }, options);
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}`, combinedOptions);
         });
     }
+    /**
+     * Retrieves aggregate credits for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AggregateCredits>} A Promise that resolves with the aggregate credits for the TV season.
+     */
     aggregateCredits(seasonSelection, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/aggregate_credits`, options);
         });
     }
+    /**
+     * Retrieves changes related to a specific TV season asynchronously.
+     * @param {number} seasonId - The ID of the TV season.
+     * @param {ChangeOption} [options] - Optional parameters for specifying changes.
+     * @returns {Promise<Changes<TvSeasonChangeValue>>} A Promise that resolves with the changes related to the TV season.
+     */
     changes(seasonId, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/tv/season/${seasonId}/changes`, options);
         });
     }
+    /**
+     * Retrieves credits for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Credits>} A Promise that resolves with the credits for the TV season.
+     */
     credits(seasonSelection, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/credits`, options);
         });
     }
+    /**
+     * Retrieves external IDs for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs for the TV season.
+     */
     externalIds(seasonSelection, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/external_ids`, options);
         });
     }
+    /**
+     * Retrieves images for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {TvSeasonImageSearchOptions} [options] - Optional parameters for specifying image search options.
+     * @returns {Promise<Images>} A Promise that resolves with the images for the TV season.
+     */
     images(seasonSelection, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -54,6 +99,12 @@ class TvSeasonsEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/images`, computedOptions);
         });
     }
+    /**
+     * Retrieves videos for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {TvSeasonVideoSearchOptions} [options] - Optional parameters for specifying video search options.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos for the TV season.
+     */
     videos(seasonSelection, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,6 +115,12 @@ class TvSeasonsEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/videos`, computedOptions);
         });
     }
+    /**
+     * Retrieves translations for a specific TV season asynchronously.
+     * @param {SeasonSelection} seasonSelection - The selection criteria for the TV season.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Translations>} A Promise that resolves with the translations for the TV season.
+     */
     translations(seasonSelection, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEASON(seasonSelection)}/translations`, options);

package/dist/endpoints/tvShows.d.ts

@@ -1,33 +1,164 @@
-import { AggregateCredits, AlternativeTitles, AppendToResponse, AppendToResponseTvKey, BaseEndpoint, ChangeOption, Changes, ContentRatings, Credits, EpisodeGroups, ExternalIds, Images, Keywords, LanguageOption, Latesttv, OnTheAir, PageOption, Populartv, Recommendations, Reviews, ScreenedTheatrically, SeasonDetails, Similartv, TimezoneOption, TopRatedtv, Translations, TvShowChangeValue, TvShowDetails, TvShowImageOptions, TvShowVideoOptions, Videos, WatchProviders, tvAiringToday } from '@/@types';
+import { AggregateCredits, AlternativeTitles, AppendToResponse, AppendToResponseTvKey, BaseEndpoint, ChangeOption, Changes, ContentRatings, Credits, EpisodeGroups, ExternalIds, Images, Keywords, LanguageOption, Latesttv, OnTheAir, PageOption, Populartv, Recommendations, Reviews, ScreenedTheatrically, SeasonDetails, Similartv, TimezoneOption, TopRatedtv, Translations, TvShowChangeValue, TvShowDetails, TvShowImageOptions, TvShowVideoOptions, Videos, WatchProviders, tvAiringToday } from '../@types';
+/**
+ * Represents an endpoint for accessing TV show-related information.
+ */
 export declare class TvShowsEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new TvShowsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
-    details<T extends AppendToResponseTvKey[] | undefined>(id: number, appendToResponse?: T, language?: string): Promise<AppendToResponse<TvShowDetails, T, "tvShow">>;
+    /**
+     * Retrieves details of a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {AppendToResponseTvKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {string} [language] - The language for the response.
+     * @returns {Promise<AppendToResponse<TvShowDetails, AppendToResponseTvKey[], 'tvShow'>>}
+     * A Promise that resolves with the details of the TV show.
+     */
+    details<T extends AppendToResponseTvKey[] | undefined>(id: number, appendToResponse?: T, language?: string): Promise<AppendToResponse<TvShowDetails, T, 'tvShow'>>;
+    /**
+     * Retrieves alternative titles of a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<AlternativeTitles>} A Promise that resolves with the alternative titles of the TV show.
+     */
     alternativeTitles(id: number): Promise<AlternativeTitles>;
+    /**
+     * Retrieves changes for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {ChangeOption} [options] - Additional options for the request.
+     * @returns {Promise<Changes<TvShowChangeValue>>}
+     * A Promise that resolves with the changes for the TV show.
+     */
     changes(id: number, options?: ChangeOption): Promise<Changes<TvShowChangeValue>>;
+    /**
+     * Retrieves content ratings for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ContentRatings>} A Promise that resolves with the content ratings of the TV show.
+     */
     contentRatings(id: number): Promise<ContentRatings>;
+    /**
+     * Retrieves aggregate credits for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<AggregateCredits>} A Promise that resolves with the aggregate credits of the TV show.
+     */
     aggregateCredits(id: number, options?: LanguageOption): Promise<AggregateCredits>;
+    /**
+     * Retrieves credits for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<Credits>} A Promise that resolves with the credits of the TV show.
+     */
     credits(id: number, options?: LanguageOption): Promise<Credits>;
+    /**
+     * Retrieves details of a specific season of a TV show asynchronously.
+     * @param {number} tvId - The ID of the TV show.
+     * @param {number} seasonNumber - The season number.
+     * @returns {Promise<SeasonDetails>} A Promise that resolves with the details of the season.
+     */
     season(tvId: number, seasonNumber: number): Promise<SeasonDetails>;
+    /**
+     * Retrieves episode groups for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<EpisodeGroups>} A Promise that resolves with the episode groups of the TV show.
+     */
     episodeGroups(id: number): Promise<EpisodeGroups>;
+    /**
+     * Retrieves external IDs for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs of the TV show.
+     */
     externalIds(id: number): Promise<ExternalIds>;
+    /**
+     * Retrieves images for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {TvShowImageOptions} [options] - Additional options for the request.
+     * @returns {Promise<Images>} A Promise that resolves with the images of the TV show.
+     */
     images(id: number, options?: TvShowImageOptions): Promise<Images>;
+    /**
+     * Retrieves keywords for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<Keywords>} A Promise that resolves with the keywords of the TV show.
+     */
     keywords(id: number): Promise<Keywords>;
+    /**
+     * Retrieves recommendations for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Recommendations>} A Promise that resolves with the recommendations for the TV show.
+     */
     recommendations(id: number, options?: LanguageOption & PageOption): Promise<Recommendations>;
+    /**
+     * Retrieves reviews for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Reviews>} A Promise that resolves with the reviews of the TV show.
+     */
     reviews(id: number, options?: LanguageOption & PageOption): Promise<Reviews>;
+    /**
+     * Retrieves information about whether the TV show was screened theatrically asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ScreenedTheatrically>} A Promise that resolves with information about theatrical screenings.
+     */
     screenedTheatrically(id: number): Promise<ScreenedTheatrically>;
+    /**
+     * Retrieves similar TV shows for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Similartv>} A Promise that resolves with the similar TV shows.
+     */
     similar(id: number, options?: LanguageOption & PageOption): Promise<Similartv>;
+    /**
+     * Retrieves translations for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<Translations>} A Promise that resolves with the translations of the TV show.
+     */
     translations(id: number): Promise<Translations>;
+    /**
+     * Retrieves videos for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {TvShowVideoOptions} [options] - Additional options for the request.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos of the TV show.
+     */
     videos(id: number, options?: TvShowVideoOptions): Promise<Videos>;
     /**
-     * Powered by JustWatch
-     * @param id
+     * Retrieves watch providers for a specific TV show asynchronously.
+     * Powered by JustWatch.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<WatchProviders>} A Promise that resolves with the watch providers of the TV show.
      */
     watchProviders(id: number): Promise<WatchProviders>;
+    /**
+     * Retrieves the latest TV show asynchronously.
+     * @returns {Promise<Latesttv>} A Promise that resolves with the latest TV show.
+     */
     latest(): Promise<Latesttv>;
+    /**
+     * Retrieves TV shows that are currently on the air asynchronously.
+     * @param {PageOption & LanguageOption & TimezoneOption} [options] - Additional options for the request.
+     * @returns {Promise<OnTheAir>} A Promise that resolves with TV shows currently on the air.
+     */
     onTheAir(options?: PageOption & LanguageOption & TimezoneOption): Promise<OnTheAir>;
+    /**
+     * Retrieves TV shows that are airing today asynchronously.
+     * @param {PageOption & LanguageOption & TimezoneOption} [options] - Additional options for the request.
+     * @returns {Promise<tvAiringToday>} A Promise that resolves with TV shows airing today.
+     */
     airingToday(options?: PageOption & LanguageOption & TimezoneOption): Promise<tvAiringToday>;
+    /**
+     * Retrieves popular TV shows asynchronously.
+     * @param {PageOption & LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<Populartv>} A Promise that resolves with popular TV shows.
+     */
     popular(options?: PageOption & LanguageOption): Promise<Populartv>;
+    /**
+     * Retrieves top-rated TV shows asynchronously.
+     * @param {PageOption & LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<TopRatedtv>} A Promise that resolves with top-rated TV shows.
+     */
     topRated(options?: PageOption & LanguageOption): Promise<TopRatedtv>;
 }
 //# sourceMappingURL=tvShows.d.ts.map

package/dist/endpoints/tvShows.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tvShows.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvShows.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,cAAc,EACd,OAAO,EACP,aAAa,EACb,WAAW,EACX,MAAM,EACN,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,SAAS,EACT,eAAe,EACf,OAAO,EACP,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EACN,cAAc,EACd,aAAa,EACd,MAAM,UAAU,CAAC;AAIlB,qBAAa,eAAgB,SAAQ,YAAY;IACnC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,OAAO,CAAC,CAAC,SAAS,qBAAqB,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM;IAQ1G,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIzD,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAIhF,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAInD,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIjF,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI7C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQjE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvC,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5F,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5E,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI/D,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAI9E,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI/C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvE;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAInD,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;IAI3B,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAInF,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAI3F,OAAO,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAIlE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;CAG3E"}
+{"version":3,"file":"tvShows.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvShows.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,cAAc,EACd,OAAO,EACP,aAAa,EACb,WAAW,EACX,MAAM,EACN,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,SAAS,EACT,eAAe,EACf,OAAO,EACP,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EACN,cAAc,EACd,aAAa,EACd,MAAM,UAAU,CAAC;AAIlB;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAKnC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJnD;;;OAGG;gBAC4B,YAAY,EAAE,MAAM;IAInD;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,SAAS,qBAAqB,EAAE,GAAG,SAAS,EACzD,EAAE,EAAE,MAAM,EACV,gBAAgB,CAAC,EAAE,CAAC,EACpB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAQxD;;;;OAIG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;;OAMG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAItF;;;;OAIG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzD;;;;;OAKG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIvF;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrE;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIxE;;;;OAIG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvD;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInD;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvE;;;;OAIG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI7C;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlG;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;OAIG;IACG,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIrE;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAIpF;;;;OAIG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrD;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvE;;;;;OAKG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzD;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;IAIjC;;;;OAIG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIzF;;;;OAIG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjG;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAIxE;;;;OAIG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;CAG3E"}

package/dist/endpoints/tvShows.js

@@ -10,13 +10,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TvShowsEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
 const BASE_TV = '/tv';
+/**
+ * Represents an endpoint for accessing TV show-related information.
+ */
 class TvShowsEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new TvShowsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
         this.access_token = access_token;
     }
+    /**
+     * Retrieves details of a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {AppendToResponseTvKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {string} [language] - The language for the response.
+     * @returns {Promise<AppendToResponse<TvShowDetails, AppendToResponseTvKey[], 'tvShow'>>}
+     * A Promise that resolves with the details of the TV show.
+     */
     details(id, appendToResponse, language) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = {
@@ -26,46 +41,97 @@ class TvShowsEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_TV}/${id}`, options);
         });
     }
+    /**
+     * Retrieves alternative titles of a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<AlternativeTitles>} A Promise that resolves with the alternative titles of the TV show.
+     */
     alternativeTitles(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/alternative_titles`);
         });
     }
+    /**
+     * Retrieves changes for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {ChangeOption} [options] - Additional options for the request.
+     * @returns {Promise<Changes<TvShowChangeValue>>}
+     * A Promise that resolves with the changes for the TV show.
+     */
     changes(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/changes`, options);
         });
     }
+    /**
+     * Retrieves content ratings for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ContentRatings>} A Promise that resolves with the content ratings of the TV show.
+     */
     contentRatings(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/content_ratings`);
         });
     }
+    /**
+     * Retrieves aggregate credits for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<AggregateCredits>} A Promise that resolves with the aggregate credits of the TV show.
+     */
     aggregateCredits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/aggregate_credits`, options);
         });
     }
+    /**
+     * Retrieves credits for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<Credits>} A Promise that resolves with the credits of the TV show.
+     */
     credits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/credits`, options);
         });
     }
+    /**
+     * Retrieves details of a specific season of a TV show asynchronously.
+     * @param {number} tvId - The ID of the TV show.
+     * @param {number} seasonNumber - The season number.
+     * @returns {Promise<SeasonDetails>} A Promise that resolves with the details of the season.
+     */
     season(tvId, seasonNumber) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${tvId}/season/${seasonNumber}`);
         });
     }
+    /**
+     * Retrieves episode groups for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<EpisodeGroups>} A Promise that resolves with the episode groups of the TV show.
+     */
     episodeGroups(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/episode_groups`);
         });
     }
+    /**
+     * Retrieves external IDs for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs of the TV show.
+     */
     externalIds(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/external_ids`);
         });
     }
+    /**
+     * Retrieves images for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {TvShowImageOptions} [options] - Additional options for the request.
+     * @returns {Promise<Images>} A Promise that resolves with the images of the TV show.
+     */
     images(id, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -76,36 +142,75 @@ class TvShowsEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_TV}/${id}/images`, computedOptions);
         });
     }
+    /**
+     * Retrieves keywords for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<Keywords>} A Promise that resolves with the keywords of the TV show.
+     */
     keywords(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/keywords`);
         });
     }
+    /**
+     * Retrieves recommendations for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Recommendations>} A Promise that resolves with the recommendations for the TV show.
+     */
     recommendations(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/recommendations`, options);
         });
     }
+    /**
+     * Retrieves reviews for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Reviews>} A Promise that resolves with the reviews of the TV show.
+     */
     reviews(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/reviews`, options);
         });
     }
+    /**
+     * Retrieves information about whether the TV show was screened theatrically asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<ScreenedTheatrically>} A Promise that resolves with information about theatrical screenings.
+     */
     screenedTheatrically(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/screened_theatrically`);
         });
     }
+    /**
+     * Retrieves similar TV shows for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {LanguageOption & PageOption} [options] - Additional options for the request.
+     * @returns {Promise<Similartv>} A Promise that resolves with the similar TV shows.
+     */
     similar(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/similar`, options);
         });
     }
+    /**
+     * Retrieves translations for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<Translations>} A Promise that resolves with the translations of the TV show.
+     */
     translations(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/translations`);
         });
     }
+    /**
+     * Retrieves videos for a specific TV show asynchronously.
+     * @param {number} id - The ID of the TV show.
+     * @param {TvShowVideoOptions} [options] - Additional options for the request.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos of the TV show.
+     */
     videos(id, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -117,34 +222,60 @@ class TvShowsEndpoint extends _types_1.BaseEndpoint {
         });
     }
     /**
-     * Powered by JustWatch
-     * @param id
+     * Retrieves watch providers for a specific TV show asynchronously.
+     * Powered by JustWatch.
+     * @param {number} id - The ID of the TV show.
+     * @returns {Promise<WatchProviders>} A Promise that resolves with the watch providers of the TV show.
      */
     watchProviders(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/${id}/watch/providers`);
         });
     }
+    /**
+     * Retrieves the latest TV show asynchronously.
+     * @returns {Promise<Latesttv>} A Promise that resolves with the latest TV show.
+     */
     latest() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/latest`);
         });
     }
+    /**
+     * Retrieves TV shows that are currently on the air asynchronously.
+     * @param {PageOption & LanguageOption & TimezoneOption} [options] - Additional options for the request.
+     * @returns {Promise<OnTheAir>} A Promise that resolves with TV shows currently on the air.
+     */
     onTheAir(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/on_the_air`, options);
         });
     }
+    /**
+     * Retrieves TV shows that are airing today asynchronously.
+     * @param {PageOption & LanguageOption & TimezoneOption} [options] - Additional options for the request.
+     * @returns {Promise<tvAiringToday>} A Promise that resolves with TV shows airing today.
+     */
     airingToday(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/airing_today`, options);
         });
     }
+    /**
+     * Retrieves popular TV shows asynchronously.
+     * @param {PageOption & LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<Populartv>} A Promise that resolves with popular TV shows.
+     */
     popular(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/popular`, options);
         });
     }
+    /**
+     * Retrieves top-rated TV shows asynchronously.
+     * @param {PageOption & LanguageOption} [options] - Additional options for the request.
+     * @returns {Promise<TopRatedtv>} A Promise that resolves with top-rated TV shows.
+     */
     topRated(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_TV}/top_rated`, options);