Class TvClient

Constructors

constructor

new TvClient(axiosInstance: AxiosInstance): TvClient
Parameters
- axiosInstance: AxiosInstance
Returns TvClient
- Defined in client/tv/index.ts:70

Methods

addEpisodeRating

addEpisodeRating(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params: AddRatingParams,
    request: AddRatingRequest,
): Promise<TMDBResponse>
Rate a TV episode and save it to your rated list.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- params: AddRatingParams
- request: AddRatingRequest
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/tv-episode-add-rating
- Defined in client/tv/index.ts:680

addRating

addRating(
    id: number,
    params: AddRatingParams,
    request: AddRatingRequest,
): Promise<TMDBResponse>
Rate a TV show and save it to your rated list.
Parameters
- id: number
- params: AddRatingParams
- request: AddRatingRequest
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/tv-series-add-rating
- Defined in client/tv/index.ts:339

deleteEpisodeRating

deleteEpisodeRating(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params: DeleteRatingParams,
): Promise<TMDBResponse>
Delete a user rating for a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- params: DeleteRatingParams
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/tv-episode-delete-rating
- Defined in client/tv/index.ts:699

deleteRating

deleteRating(id: number, params: DeleteRatingParams): Promise<TMDBResponse>
Delete a user rating for a TV show.
Parameters
- id: number
- params: DeleteRatingParams
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/tv-series-delete-rating
- Defined in client/tv/index.ts:356

getAccountStates

getAccountStates(
id: number,
params?: TvSeriesAccountStatesParams,
): Promise<TvSeriesAccountStates>
Get the rating, watchlist and favourite status of an account for a TV show.
Parameters
- id: number
- Optionalparams: TvSeriesAccountStatesParams
Returns Promise<TvSeriesAccountStates>
See
https://developer.themoviedb.org/reference/tv-series-account-states
- Defined in client/tv/index.ts:137

getAggregateCredits

getAggregateCredits(
id: number,
params?: TvAggregateCreditsParams,
): Promise<TvAggregateCreditsResponse>
Get the aggregate credits (cast and crew) that have been added to a TV show.
Parameters
- id: number
- Optionalparams: TvAggregateCreditsParams
Returns Promise<TvAggregateCreditsResponse>
See
https://developer.themoviedb.org/reference/tv-series-aggregate-credits
- Defined in client/tv/index.ts:151

getContentRatings

getContentRatings(id: number): Promise<TvContentRatingsResponse>
Get the content ratings that have been added to a TV show.
Parameters
- id: number
Returns Promise<TvContentRatingsResponse>
See
https://developer.themoviedb.org/reference/tv-series-content-ratings
- Defined in client/tv/index.ts:186

getCredits

getCredits(id: number, params?: TvCreditsParams): Promise<TvCreditsResponse>
Get the credits (cast and crew) for a TV show.
Parameters
- id: number
- Optionalparams: TvCreditsParams
Returns Promise<TvCreditsResponse>
See
https://developer.themoviedb.org/reference/tv-series-credits
- Defined in client/tv/index.ts:195

getDetails

getDetails<T extends readonly TvAppendToResponseValue[] = never>(
id: number,
params?: TvSeriesDetailsParams & { append_to_response?: T },
): Promise<TvAppendToResponseResult<T>>
Get the details of a TV show by ID.
Type Parameters
- T extends readonly TvAppendToResponseValue[] = never
Parameters
- id: number
- Optionalparams: TvSeriesDetailsParams & { append_to_response?: T }
Returns Promise<TvAppendToResponseResult<T>>
See
https://developer.themoviedb.org/reference/tv-series-details
- Defined in client/tv/index.ts:120

getEpisodeAccountStates

getEpisodeAccountStates(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvSeriesAccountStatesParams,
): Promise<TvEpisodeAccountStates>
Get the rating, watchlist and favourite status of an account for a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvSeriesAccountStatesParams
Returns Promise<TvEpisodeAccountStates>
See
https://developer.themoviedb.org/reference/tv-episode-account-states
- Defined in client/tv/index.ts:559

getEpisodeChangesById

getEpisodeChangesById(
episodeId: number,
params?: TvSeriesChangesParams,
): Promise<TvSeriesChangesResponse>
Get the recent changes for a TV episode by episode ID.
Parameters
- episodeId: number
- Optionalparams: TvSeriesChangesParams
Returns Promise<TvSeriesChangesResponse>
See
https://developer.themoviedb.org/reference/tv-episode-changes-by-id
- Defined in client/tv/index.ts:578

getEpisodeCredits

getEpisodeCredits(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvEpisodeCreditsParams,
): Promise<TvEpisodeCreditsResponse>
Get the credits (cast, crew and guest stars) for a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvEpisodeCreditsParams
Returns Promise<TvEpisodeCreditsResponse>
See
https://developer.themoviedb.org/reference/tv-episode-credits
- Defined in client/tv/index.ts:595

getEpisodeDetails

getEpisodeDetails(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvEpisodeDetailsParams,
): Promise<TvEpisodeDetails>
Get the details of a TV episode by episode number.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvEpisodeDetailsParams
Returns Promise<TvEpisodeDetails>
See
https://developer.themoviedb.org/reference/tv-episode-details
- Defined in client/tv/index.ts:537

getEpisodeExternalIds

getEpisodeExternalIds(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
): Promise<TvEpisodeExternalIdsResponse>
Get the external IDs for a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
Returns Promise<TvEpisodeExternalIdsResponse>
See
https://developer.themoviedb.org/reference/tv-episode-external-ids
- Defined in client/tv/index.ts:612

getEpisodeGroupDetails

getEpisodeGroupDetails(id: string): Promise<TvEpisodeGroupDetails>
Get the details of a TV episode group by ID.
Parameters
- id: string
Returns Promise<TvEpisodeGroupDetails>
See
https://developer.themoviedb.org/reference/tv-episode-group-details
- Defined in client/tv/index.ts:716

getEpisodeGroups

getEpisodeGroups(id: number): Promise<TvEpisodeGroupsResponse>
Get the episode groups that have been added to a TV show.
Parameters
- id: number
Returns Promise<TvEpisodeGroupsResponse>
See
https://developer.themoviedb.org/reference/tv-series-episode-groups
- Defined in client/tv/index.ts:204

getEpisodeImages

getEpisodeImages(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvSeriesImagesParams,
): Promise<TvEpisodeImagesResponse>
Get the images that belong to a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvSeriesImagesParams
Returns Promise<TvEpisodeImagesResponse>
See
https://developer.themoviedb.org/reference/tv-episode-images
- Defined in client/tv/index.ts:627

getEpisodeTranslations

getEpisodeTranslations(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
): Promise<TvSeriesTranslationsResponse>
Get the translations for a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
Returns Promise<TvSeriesTranslationsResponse>
See
https://developer.themoviedb.org/reference/tv-episode-translations
- Defined in client/tv/index.ts:646

getEpisodeVideos

getEpisodeVideos(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvSeriesVideosParams,
): Promise<TvSeriesVideosResponse>
Get the videos that belong to a TV episode.
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvSeriesVideosParams
Returns Promise<TvSeriesVideosResponse>
See
https://developer.themoviedb.org/reference/tv-episode-videos
- Defined in client/tv/index.ts:661

getExternalIds

getExternalIds(id: number): Promise<TvSeriesExternalIdsResponse>
Get a list of external IDs that have been added to a TV show.
Parameters
- id: number
Returns Promise<TvSeriesExternalIdsResponse>
See
https://developer.themoviedb.org/reference/tv-series-external-ids
- Defined in client/tv/index.ts:213

getImages

getImages(
id: number,
params?: TvSeriesImagesParams,
): Promise<TvSeriesImagesResponse>
Get the images that belong to a TV show.
Parameters
- id: number
- Optionalparams: TvSeriesImagesParams
Returns Promise<TvSeriesImagesResponse>
See
https://developer.themoviedb.org/reference/tv-series-images
- Defined in client/tv/index.ts:222

getKeywords

getKeywords(id: number): Promise<TvSeriesKeywordsResponse>
Get a list of keywords that have been added to a TV show.
Parameters
- id: number
Returns Promise<TvSeriesKeywordsResponse>
See
https://developer.themoviedb.org/reference/tv-series-keywords
- Defined in client/tv/index.ts:233

getLatest

getLatest(): Promise<TvSeriesDetails>
Get the newest TV show ID.

Returns Promise<TvSeriesDetails>
See
https://developer.themoviedb.org/reference/tv-series-latest
- Defined in client/tv/index.ts:242

getLists

getLists(
id: number,
params?: TvSeriesListsParams,
): Promise<TvSeriesListsResponse>
Get the lists that a TV show has been added to.
Parameters
- id: number
- Optionalparams: TvSeriesListsParams
Returns Promise<TvSeriesListsResponse>
See
https://developer.themoviedb.org/reference/tv-series-lists
- Defined in client/tv/index.ts:251

getOnTheAir

getOnTheAir(params?: TvAiringTodayParams): Promise<TvListResponse>
Get a list of TV shows that air in the next 7 days.
Parameters
- Optionalparams: TvAiringTodayParams
Returns Promise<TvListResponse>
See
https://developer.themoviedb.org/reference/tv-series-on-the-air-list
- Defined in client/tv/index.ts:87

getPopular

getPopular(params?: TvListParams): Promise<TvListResponse>
Get a list of TV shows ordered by popularity.
Parameters
- Optionalparams: TvListParams
Returns Promise<TvListResponse>
See
https://developer.themoviedb.org/reference/tv-series-popular-list
- Defined in client/tv/index.ts:98

getRecommendations

getRecommendations(
id: number,
params?: TvSeriesRecommendationsParams,
): Promise<TvListResponse>
Get the recommended TV shows for a TV show.
Parameters
- id: number
- Optionalparams: TvSeriesRecommendationsParams
Returns Promise<TvListResponse>
See
https://developer.themoviedb.org/reference/tv-series-recommendations
- Defined in client/tv/index.ts:262

getReviews

getReviews(
id: number,
params?: TvSeriesReviewsParams,
): Promise<TvSeriesReviewsResponse>
Get the reviews for a TV show.
Parameters
- id: number
- Optionalparams: TvSeriesReviewsParams
Returns Promise<TvSeriesReviewsResponse>
See
https://developer.themoviedb.org/reference/tv-series-reviews
- Defined in client/tv/index.ts:276

getScreenedTheatrically

getScreenedTheatrically(id: number): Promise<TvScreenedTheatricallyResponse>
Get the seasons and episodes that have screened theatrically.
Parameters
- id: number
Returns Promise<TvScreenedTheatricallyResponse>
See
https://developer.themoviedb.org/reference/tv-series-screened-theatrically
- Defined in client/tv/index.ts:287

getSeasonAccountStates

getSeasonAccountStates(
    seriesId: number,
    seasonNumber: number,
    params?: TvSeriesAccountStatesParams,
): Promise<TvSeasonAccountStates>
Get the rating, watchlist and favourite status of an account for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvSeriesAccountStatesParams
Returns Promise<TvSeasonAccountStates>
See
https://developer.themoviedb.org/reference/tv-season-account-states
- Defined in client/tv/index.ts:392

getSeasonAggregateCredits

getSeasonAggregateCredits(
    seriesId: number,
    seasonNumber: number,
    params?: TvAggregateCreditsParams,
): Promise<TvAggregateCreditsResponse>
Get the aggregate credits (cast and crew) for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvAggregateCreditsParams
Returns Promise<TvAggregateCreditsResponse>
See
https://developer.themoviedb.org/reference/tv-season-aggregate-credits
- Defined in client/tv/index.ts:410

getSeasonChangesById

getSeasonChangesById(
seasonId: number,
params?: TvSeriesChangesParams,
): Promise<TvSeriesChangesResponse>
Get the recent changes for a TV season by season ID.
Parameters
- seasonId: number
- Optionalparams: TvSeriesChangesParams
Returns Promise<TvSeriesChangesResponse>
See
https://developer.themoviedb.org/reference/tv-season-changes-by-id
- Defined in client/tv/index.ts:426

getSeasonCredits

getSeasonCredits(
    seriesId: number,
    seasonNumber: number,
    params?: TvCreditsParams,
): Promise<TvCreditsResponse>
Get the credits (cast and crew) for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvCreditsParams
Returns Promise<TvCreditsResponse>
See
https://developer.themoviedb.org/reference/tv-season-credits
- Defined in client/tv/index.ts:443

getSeasonDetails

getSeasonDetails(
    seriesId: number,
    seasonNumber: number,
    params?: TvSeasonDetailsParams,
): Promise<TvSeasonDetails>
Get the details of a TV season by season number.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvSeasonDetailsParams
Returns Promise<TvSeasonDetails>
See
https://developer.themoviedb.org/reference/tv-season-details
- Defined in client/tv/index.ts:371

getSeasonExternalIds

getSeasonExternalIds(
seriesId: number,
seasonNumber: number,
): Promise<TvSeasonExternalIdsResponse>
Get the external IDs for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
Returns Promise<TvSeasonExternalIdsResponse>
See
https://developer.themoviedb.org/reference/tv-season-external-ids
- Defined in client/tv/index.ts:459

getSeasonImages

getSeasonImages(
    seriesId: number,
    seasonNumber: number,
    params?: TvSeriesImagesParams,
): Promise<TvSeasonImagesResponse>
Get the images that belong to a TV season.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvSeriesImagesParams
Returns Promise<TvSeasonImagesResponse>
See
https://developer.themoviedb.org/reference/tv-season-images
- Defined in client/tv/index.ts:473

getSeasonTranslations

getSeasonTranslations(
seriesId: number,
seasonNumber: number,
): Promise<TvSeriesTranslationsResponse>
Get the translations for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
Returns Promise<TvSeriesTranslationsResponse>
See
https://developer.themoviedb.org/reference/tv-season-translations
- Defined in client/tv/index.ts:491

getSeasonVideos

getSeasonVideos(
    seriesId: number,
    seasonNumber: number,
    params?: TvSeriesVideosParams,
): Promise<TvSeriesVideosResponse>
Get the videos that belong to a TV season.
Parameters
- seriesId: number
- seasonNumber: number
- Optionalparams: TvSeriesVideosParams
Returns Promise<TvSeriesVideosResponse>
See
https://developer.themoviedb.org/reference/tv-season-videos
- Defined in client/tv/index.ts:505

getSeasonWatchProviders

getSeasonWatchProviders(
seriesId: number,
seasonNumber: number,
): Promise<TvSeriesWatchProvidersResponse>
Get the list of streaming providers for a TV season.
Parameters
- seriesId: number
- seasonNumber: number
Returns Promise<TvSeriesWatchProvidersResponse>
See
https://developer.themoviedb.org/reference/tv-season-watch-providers
- Defined in client/tv/index.ts:523

getSimilar

getSimilar(
id: number,
params?: TvSeriesRecommendationsParams,
): Promise<TvListResponse>
Get the similar TV shows based on genres and keywords.
Parameters
- id: number
- Optionalparams: TvSeriesRecommendationsParams
Returns Promise<TvListResponse>
See
https://developer.themoviedb.org/reference/tv-series-similar
- Defined in client/tv/index.ts:296

getTopRated

getTopRated(params?: TvListParams): Promise<TvListResponse>
Get a list of TV shows ordered by rating.
Parameters
- Optionalparams: TvListParams
Returns Promise<TvListResponse>
See
https://developer.themoviedb.org/reference/tv-series-top-rated-list
- Defined in client/tv/index.ts:109

getTranslations

getTranslations(id: number): Promise<TvSeriesTranslationsResponse>
Get the translations that have been added to a TV show.
Parameters
- id: number
Returns Promise<TvSeriesTranslationsResponse>
See
https://developer.themoviedb.org/reference/tv-series-translations
- Defined in client/tv/index.ts:310

getVideos

getVideos(
id: number,
params?: TvSeriesVideosParams,
): Promise<TvSeriesVideosResponse>
Get the videos that belong to a TV show.
Parameters
- id: number
- Optionalparams: TvSeriesVideosParams
Returns Promise<TvSeriesVideosResponse>
See
https://developer.themoviedb.org/reference/tv-series-videos
- Defined in client/tv/index.ts:319

getWatchProviders

getWatchProviders(id: number): Promise<TvSeriesWatchProvidersResponse>
Get the list of streaming providers for a TV show.
Parameters
- id: number
Returns Promise<TvSeriesWatchProvidersResponse>
See
https://developer.themoviedb.org/reference/tv-series-watch-providers
- Defined in client/tv/index.ts:330

Class TvClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TvClient

Methods

addEpisodeRating

Parameters

Returns Promise<TMDBResponse>

See

addRating

Parameters

Returns Promise<TMDBResponse>

See

deleteEpisodeRating

Parameters

Returns Promise<TMDBResponse>

See

deleteRating

Parameters

Returns Promise<TMDBResponse>

See

getAccountStates

Parameters

Returns Promise<TvSeriesAccountStates>

See

getAggregateCredits

Parameters

Returns Promise<TvAggregateCreditsResponse>

See

getAiringToday

Parameters

Returns Promise<TvListResponse>

See

getAlternativeTitles

Parameters

Returns Promise<TvSeriesAlternativeTitlesResponse>

See

getChanges

Parameters

Returns Promise<TvSeriesChangesResponse>

See

getContentRatings

Parameters

Returns Promise<TvContentRatingsResponse>

See

getCredits

Parameters

Returns Promise<TvCreditsResponse>

See

getDetails

Type Parameters

Parameters

Returns Promise<TvAppendToResponseResult<T>>

See

getEpisodeAccountStates

Parameters

Returns Promise<TvEpisodeAccountStates>

See

getEpisodeChangesById

Parameters

Returns Promise<TvSeriesChangesResponse>

See

getEpisodeCredits

Parameters

Returns Promise<TvEpisodeCreditsResponse>

See

getEpisodeDetails

Parameters

Returns Promise<TvEpisodeDetails>

See

getEpisodeExternalIds

Parameters

Returns Promise<TvEpisodeExternalIdsResponse>

See

getEpisodeGroupDetails

Parameters