Class TvShowsApi

TvShowsApi - object-oriented interface

Export

TvShowsApi

Hierarchy

BaseAPI
- TvShowsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getEpisodes getNextUp getSeasons getUpcomingEpisodes

Constructors

constructor

new TvShowsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): TvShowsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns TvShowsApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getEpisodes

getEpisodes(
requestParameters: TvShowsApiGetEpisodesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: TvShowsApiGetEpisodesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
TvShowsApi
- Defined in generated-client/api/tv-shows-api.ts:962

getNextUp

getNextUp(
requestParameters?: TvShowsApiGetNextUpRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: TvShowsApiGetNextUpRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
TvShowsApi
- Defined in generated-client/api/tv-shows-api.ts:974

getSeasons

getSeasons(
requestParameters: TvShowsApiGetSeasonsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: TvShowsApiGetSeasonsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
TvShowsApi
- Defined in generated-client/api/tv-shows-api.ts:986

getUpcomingEpisodes

getUpcomingEpisodes(
requestParameters?: TvShowsApiGetUpcomingEpisodesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: TvShowsApiGetUpcomingEpisodesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
TvShowsApi
- Defined in generated-client/api/tv-shows-api.ts:998