Class ShowApi

ShowApi - object-oriented interface

Hierarchy

BaseAPI
- ShowApi

Index

Constructors

Properties

axios basePath configuration

Methods

getEpisodes getNextUp getSeasons getUpcomingEpisodes

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getEpisodes

getEpisodes(
requestParameters: ShowApiGetEpisodesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ShowApiGetEpisodesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/show-api.ts:838

getNextUp

getNextUp(
requestParameters?: ShowApiGetNextUpRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ShowApiGetNextUpRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/show-api.ts:849

getSeasons

getSeasons(
requestParameters: ShowApiGetSeasonsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ShowApiGetSeasonsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/show-api.ts:860

getUpcomingEpisodes

getUpcomingEpisodes(
requestParameters?: ShowApiGetUpcomingEpisodesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ShowApiGetUpcomingEpisodesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/show-api.ts:871