Class TvEpisodeClient

Index

Constructors

Methods

addRating deleteRating getAccountStates getChangesById getCredits getDetails getExternalIds getImages getTranslations getVideos

Constructors

constructor

new TvEpisodeClient(axiosInstance: AxiosInstance): TvEpisodeClient
Parameters
- axiosInstance: AxiosInstance
Returns TvEpisodeClient
- Defined in client/tv-episode/index.ts:29

Methods

addRating

addRating(
    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-episode/index.ts:178

deleteRating

deleteRating(
    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-episode/index.ts:197

getAccountStates

getAccountStates(
    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-episode/index.ts:57

getChangesById

getChangesById(
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-episode/index.ts:76

getCredits

getCredits(
    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-episode/index.ts:93

getDetails

getDetails<T extends readonly TvEpisodeAppendToResponseValue[] = never>(
    seriesId: number,
    seasonNumber: number,
    episodeNumber: number,
    params?: TvEpisodeDetailsParams & { append_to_response?: T },
): Promise<TvEpisodeAppendToResponseResult<T>>
Get the details of a TV episode by episode number.
Type Parameters
- T extends readonly TvEpisodeAppendToResponseValue[] = never
Parameters
- seriesId: number
- seasonNumber: number
- episodeNumber: number
- Optionalparams: TvEpisodeDetailsParams & { append_to_response?: T }
Returns Promise<TvEpisodeAppendToResponseResult<T>>
See
https://developer.themoviedb.org/reference/tv-episode-details
- Defined in client/tv-episode/index.ts:35

getExternalIds

getExternalIds(
    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-episode/index.ts:110

getImages

getImages(
    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-episode/index.ts:125

getTranslations

getTranslations(
    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-episode/index.ts:144

getVideos

getVideos(
    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-episode/index.ts:159

Class TvEpisodeClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TvEpisodeClient

Methods

addRating

Parameters

Returns Promise<TMDBResponse>

See

deleteRating

Parameters

Returns Promise<TMDBResponse>

See

getAccountStates

Parameters

Returns Promise<TvEpisodeAccountStates>

See

getChangesById

Parameters

Returns Promise<TvSeriesChangesResponse>

See

getCredits

Parameters

Returns Promise<TvEpisodeCreditsResponse>

See

getDetails

Type Parameters

Parameters

Returns Promise<TvEpisodeAppendToResponseResult<T>>

See

getExternalIds

Parameters

Returns Promise<TvEpisodeExternalIdsResponse>

See

getImages

Parameters

Returns Promise<TvEpisodeImagesResponse>

See

getTranslations

Parameters

Returns Promise<TvSeriesTranslationsResponse>

See

getVideos

Parameters

Returns Promise<TvSeriesVideosResponse>

See

Settings

On This Page