@lorenzopant/tmdb 1.17.0 → 1.17.2

package/dist/endpoints/tv_episodes.js

@@ -1,136 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class TVEpisodesAPI extends TMDBAPIBase {
-    episodePath(params) {
-        return `${ENDPOINTS.TV_SERIES.DETAILS}/${params.series_id}${ENDPOINTS.TV_SEASONS.DETAILS}/${params.season_number}${ENDPOINTS.TV_EPISODES.DETAILS}/${params.episode_number}`;
-    }
-    episodeSubPath(params, route) {
-        return `${this.episodePath(params)}${route}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}
-     *
-     * Query the details of a TV episode.
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @param append_to_response A comma-separated list of the fields to include in the response.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV episode .
-     * @reference https://developer.themoviedb.org/reference/tv-episode-details
-     */
-    async details(params) {
-        const { language = this.defaultOptions.language, append_to_response, ...rest } = params;
-        const endpoint = this.episodePath(rest);
-        return this.client.request(endpoint, { language, append_to_response });
-    }
-    /**
-     * Changes
-     * GET - https://api.themoviedb.org/3/tv/episode/{episode_id}/changes
-     *
-     * Get the changes for a TV episode. By default only the last 24 hours are returned.
-     * ACCORDING TO TMDB DOCS:
-     * You can query up to 14 days in a single query by using the start_date and end_date query parameters.
-     * BUT NO start_date or end_date query params are specified in the documentation
-     *
-     * NOTE: TV show changes are a little different than movie changes in that there are some edits
-     * on seasons and episodes that will create a top level change entry at the show level.
-     * These can be found under the season and episode keys.
-     * These keys will contain a series_id and episode_id.
-     * You can use the season changes and episode changes methods to look these up individually.
-     *
-     * @param episode_id The ID of the TV episode.
-     * @returns A promise that resolves to the TV episode changes history.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-changes-by-id
-     */
-    async changes(params) {
-        const endpoint = `${ENDPOINTS.TV_SERIES.DETAILS}/${ENDPOINTS.TV_EPISODES.DETAILS}/${params.episode_id}/${ENDPOINTS.TV_EPISODES.CHANGES}`;
-        return this.client.request(endpoint, { ...params });
-    }
-    /**
-     * Credits
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}/credits
-     *
-     * Get the credits for a TV episode.
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @param language The language to use for the response.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-credits
-     */
-    async credits(params) {
-        const { language = this.defaultOptions.language, ...rest } = params;
-        const endpoint = this.episodeSubPath(rest, ENDPOINTS.TV_EPISODES.CREDITS);
-        return this.client.request(endpoint, { language });
-    }
-    /**
-     * External IDs
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}/external_ids
-     *
-     * Get a list of external IDs that have been added to a TV episode.
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @returns A promise that resolves to the TV episode external ids.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-external-ids
-     */
-    async external_ids(params) {
-        const endpoint = this.episodeSubPath(params, ENDPOINTS.TV_EPISODES.EXTERNAL_IDS);
-        return this.client.request(endpoint);
-    }
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}/images
-     *
-     * Fetches still images related to a specific tv episode
-     * The images are returned in various sizes and formats.
-     *
-     * NOTE: If you have a language specified, it will act as a filter on the returned items. You can use the include_image_language param to query additional languages.
-     *
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @param language - (Optional) The language code to filter the images by language.
-     * @param include_image_language - (Optional) A comma-separated list of language codes to include images for.
-     * @returns A promise that resolves to a `TVEpisodeImages` object containing the tv episode's images.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-images
-     */
-    async images(params) {
-        const { language = this.defaultOptions.language, include_image_language, ...rest } = params;
-        const endpoint = this.episodeSubPath(rest, ENDPOINTS.TV_EPISODES.IMAGES);
-        return this.client.request(endpoint, { language, include_image_language });
-    }
-    /**
-     * Translations
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}/translations
-     *
-     * Get the translations that have been added to a TV episode.
-     * Take a read through our language documentation for more information about languages on TMDB.
-     * https://developer.themoviedb.org/docs/languages
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @returns A promise that resolves to the translations of the tv episode.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-translations
-     */
-    async translations(params) {
-        const endpoint = this.episodeSubPath(params, ENDPOINTS.TV_EPISODES.TRANSLATIONS);
-        return this.client.request(endpoint);
-    }
-    /**
-     * Videos
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/episode/{episode_number}/videos
-     *
-     * Get the videos that belong to a TV episode.
-     * @param series_id The ID of the TV series.
-     * @param season_number The number of the season within the TV show
-     * @param episode_number The number of the episode within the season
-     * @returns A promise that resolves to the videos for the tv episode.
-     * @reference https://developer.themoviedb.org/reference/tv-episode-videos
-     */
-    async videos(params) {
-        const endpoint = this.episodeSubPath(params, ENDPOINTS.TV_EPISODES.VIDEOS);
-        return this.client.request(endpoint);
-    }
-}

package/dist/endpoints/tv_seasons.d.ts

@@ -1,128 +0,0 @@
-import { Changes, MediaWatchProviders, TVSeasonAggregateCredits, TVSeasonAggregateCreditsParams, TVSeasonAppendToResponseNamespace, TVSeasonBaseParams, TVSeasonChangesParams, TVSeasonCredits, TVSeasonCreditsParams, TVSeasonDetailsParams, TVSeasonDetailsWithAppends, TVSeasonExternalIDs, TVSeasonImages, TVSeasonImagesParams, TVSeasonTranslations, TVSeasonVideos, TVSeasonVideosParams, TVSeasonWatchProvidersParams, TVSeason } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class TVSeasonsAPI extends TMDBAPIBase {
-    private seasonPath;
-    private seasonSubPath;
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}
-     *
-     * Query the details of a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param append_to_response A comma-separated list of the fields to include in the response.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season details.
-     * @reference https://developer.themoviedb.org/reference/tv-season-details
-     */
-    details<T extends readonly TVSeasonAppendToResponseNamespace[] = []>(params: Omit<TVSeasonDetailsParams, "append_to_response"> & {
-        append_to_response?: T;
-    }): Promise<T extends [] ? TVSeason : TVSeasonDetailsWithAppends<T>>;
-    /**
-     * Aggregate Credits
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/aggregate_credits
-     *
-     * Get the aggregate credits for a TV season.
-     * This returns the full cast and crew across all episodes of the season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season aggregate credits.
-     * @reference https://developer.themoviedb.org/reference/tv-season-aggregate-credits
-     */
-    aggregate_credits(params: TVSeasonAggregateCreditsParams): Promise<TVSeasonAggregateCredits>;
-    /**
-     * Changes
-     * GET - https://api.themoviedb.org/3/tv/season/{season_id}/changes
-     *
-     * Get the changes for a TV season by season ID. By default only the last 24 hours are returned.
-     * You can query up to 14 days in a single query by using the start_date and end_date query parameters.
-     * @param season_id The ID of the TV season.
-     * @param start_date Filter changes by start date (ISO 8601 format, e.g. "2024-01-01").
-     * @param end_date Filter changes by end date (ISO 8601 format, e.g. "2024-01-14").
-     * @param page The page of results to return.
-     * @returns A promise that resolves to the TV season changes history.
-     * @reference https://developer.themoviedb.org/reference/tv-season-changes-by-id
-     */
-    changes(params: TVSeasonChangesParams): Promise<Changes>;
-    /**
-     * Credits
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/credits
-     *
-     * Get the credits for a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season credits.
-     * @reference https://developer.themoviedb.org/reference/tv-season-credits
-     */
-    credits(params: TVSeasonCreditsParams): Promise<TVSeasonCredits>;
-    /**
-     * External IDs
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/external_ids
-     *
-     * Get a list of external IDs that have been added to a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @returns A promise that resolves to the TV season external IDs.
-     * @reference https://developer.themoviedb.org/reference/tv-season-external-ids
-     */
-    external_ids(params: TVSeasonBaseParams): Promise<TVSeasonExternalIDs>;
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/images
-     *
-     * Get the images that belong to a TV season. Returns season posters.
-     *
-     * NOTE: If you have a language specified, it will act as a filter on the returned items.
-     * You can use the include_image_language param to query additional languages.
-     *
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language code to filter images by language.
-     * @param include_image_language A comma-separated list of language codes to include images for.
-     * @returns A promise that resolves to the TV season images.
-     * @reference https://developer.themoviedb.org/reference/tv-season-images
-     */
-    images(params: TVSeasonImagesParams): Promise<TVSeasonImages>;
-    /**
-     * Translations
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/translations
-     *
-     * Get the translations that have been added to a TV season.
-     * Take a read through our language documentation for more information about languages on TMDB.
-     * https://developer.themoviedb.org/docs/languages
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @returns A promise that resolves to the TV season translations.
-     * @reference https://developer.themoviedb.org/reference/tv-season-translations
-     */
-    translations(params: TVSeasonBaseParams): Promise<TVSeasonTranslations>;
-    /**
-     * Videos
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/videos
-     *
-     * Get the videos that belong to a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @param include_video_language A comma-separated list of language codes to include videos for.
-     * @returns A promise that resolves to the TV season videos.
-     * @reference https://developer.themoviedb.org/reference/tv-season-videos
-     */
-    videos(params: TVSeasonVideosParams): Promise<TVSeasonVideos>;
-    /**
-     * Watch Providers
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/watch/providers
-     *
-     * Get the watch providers for a specific TV season.
-     * Powered by our partnership with JustWatch, you can query which streaming services
-     * have the season available.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season watch providers.
-     * @reference https://developer.themoviedb.org/reference/tv-season-watch-providers
-     */
-    watch_providers(params: TVSeasonWatchProvidersParams): Promise<MediaWatchProviders>;
-}

package/dist/endpoints/tv_seasons.js

@@ -1,164 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class TVSeasonsAPI extends TMDBAPIBase {
-    seasonPath(params) {
-        return `${ENDPOINTS.TV_SERIES.DETAILS}/${params.series_id}${ENDPOINTS.TV_SEASONS.DETAILS}/${params.season_number}`;
-    }
-    seasonSubPath(params, route) {
-        return `${this.seasonPath(params)}${route}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}
-     *
-     * Query the details of a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param append_to_response A comma-separated list of the fields to include in the response.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season details.
-     * @reference https://developer.themoviedb.org/reference/tv-season-details
-     */
-    async details(params) {
-        const { language = this.defaultOptions.language, append_to_response, ...rest } = params;
-        const endpoint = this.seasonPath(rest);
-        return this.client.request(endpoint, { language, append_to_response });
-    }
-    /**
-     * Aggregate Credits
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/aggregate_credits
-     *
-     * Get the aggregate credits for a TV season.
-     * This returns the full cast and crew across all episodes of the season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season aggregate credits.
-     * @reference https://developer.themoviedb.org/reference/tv-season-aggregate-credits
-     */
-    async aggregate_credits(params) {
-        const { language = this.defaultOptions.language, ...rest } = params;
-        const endpoint = this.seasonSubPath(rest, ENDPOINTS.TV_SEASONS.AGGREGATE_CREDITS);
-        return this.client.request(endpoint, { language });
-    }
-    /**
-     * Changes
-     * GET - https://api.themoviedb.org/3/tv/season/{season_id}/changes
-     *
-     * Get the changes for a TV season by season ID. By default only the last 24 hours are returned.
-     * You can query up to 14 days in a single query by using the start_date and end_date query parameters.
-     * @param season_id The ID of the TV season.
-     * @param start_date Filter changes by start date (ISO 8601 format, e.g. "2024-01-01").
-     * @param end_date Filter changes by end date (ISO 8601 format, e.g. "2024-01-14").
-     * @param page The page of results to return.
-     * @returns A promise that resolves to the TV season changes history.
-     * @reference https://developer.themoviedb.org/reference/tv-season-changes-by-id
-     */
-    async changes(params) {
-        const { season_id, ...rest } = params;
-        const endpoint = `${ENDPOINTS.TV_SERIES.DETAILS}${ENDPOINTS.TV_SEASONS.DETAILS}/${season_id}${ENDPOINTS.TV_SEASONS.CHANGES}`;
-        return this.client.request(endpoint, { ...rest });
-    }
-    /**
-     * Credits
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/credits
-     *
-     * Get the credits for a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season credits.
-     * @reference https://developer.themoviedb.org/reference/tv-season-credits
-     */
-    async credits(params) {
-        const { language = this.defaultOptions.language, ...rest } = params;
-        const endpoint = this.seasonSubPath(rest, ENDPOINTS.TV_SEASONS.CREDITS);
-        return this.client.request(endpoint, { language });
-    }
-    /**
-     * External IDs
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/external_ids
-     *
-     * Get a list of external IDs that have been added to a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @returns A promise that resolves to the TV season external IDs.
-     * @reference https://developer.themoviedb.org/reference/tv-season-external-ids
-     */
-    async external_ids(params) {
-        const endpoint = this.seasonSubPath(params, ENDPOINTS.TV_SEASONS.EXTERNAL_IDS);
-        return this.client.request(endpoint);
-    }
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/images
-     *
-     * Get the images that belong to a TV season. Returns season posters.
-     *
-     * NOTE: If you have a language specified, it will act as a filter on the returned items.
-     * You can use the include_image_language param to query additional languages.
-     *
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language code to filter images by language.
-     * @param include_image_language A comma-separated list of language codes to include images for.
-     * @returns A promise that resolves to the TV season images.
-     * @reference https://developer.themoviedb.org/reference/tv-season-images
-     */
-    async images(params) {
-        const { language = this.defaultOptions.language, include_image_language, ...rest } = params;
-        const endpoint = this.seasonSubPath(rest, ENDPOINTS.TV_SEASONS.IMAGES);
-        return this.client.request(endpoint, { language, include_image_language });
-    }
-    /**
-     * Translations
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/translations
-     *
-     * Get the translations that have been added to a TV season.
-     * Take a read through our language documentation for more information about languages on TMDB.
-     * https://developer.themoviedb.org/docs/languages
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @returns A promise that resolves to the TV season translations.
-     * @reference https://developer.themoviedb.org/reference/tv-season-translations
-     */
-    async translations(params) {
-        const endpoint = this.seasonSubPath(params, ENDPOINTS.TV_SEASONS.TRANSLATIONS);
-        return this.client.request(endpoint);
-    }
-    /**
-     * Videos
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/videos
-     *
-     * Get the videos that belong to a TV season.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @param include_video_language A comma-separated list of language codes to include videos for.
-     * @returns A promise that resolves to the TV season videos.
-     * @reference https://developer.themoviedb.org/reference/tv-season-videos
-     */
-    async videos(params) {
-        const { language = this.defaultOptions.language, include_video_language, ...rest } = params;
-        const endpoint = this.seasonSubPath(rest, ENDPOINTS.TV_SEASONS.VIDEOS);
-        return this.client.request(endpoint, { language, include_video_language });
-    }
-    /**
-     * Watch Providers
-     * GET - https://api.themoviedb.org/3/tv/{series_id}/season/{season_number}/watch/providers
-     *
-     * Get the watch providers for a specific TV season.
-     * Powered by our partnership with JustWatch, you can query which streaming services
-     * have the season available.
-     * @param series_id The ID of the TV series.
-     * @param season_number The season number within the TV show.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the TV season watch providers.
-     * @reference https://developer.themoviedb.org/reference/tv-season-watch-providers
-     */
-    async watch_providers(params) {
-        const { language = this.defaultOptions.language, ...rest } = params;
-        const endpoint = this.seasonSubPath(rest, ENDPOINTS.TV_SEASONS.WATCH_PROVIDERS);
-        return this.client.request(endpoint, { language });
-    }
-}