Function TvShowsApiFp

Returns {
    getEpisodes(seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: ItemSortBy, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSeasons(seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}

• getEpisodes:function

  • getEpisodes(seriesId, userId?, fields?, season?, seasonId?, isMissing?, adjacentTo?, startItemId?, startIndex?, limit?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, sortBy?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • seriesId: string

      The series id.
    • OptionaluserId: string

      The user id.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionalseason: number

      Optional filter by season number.
    • OptionalseasonId: string

      Optional. Filter by season id.
    • OptionalisMissing: boolean

      Optional. Filter by items that are missing episodes or not.
    • OptionaladjacentTo: string

      Optional. Return items that are siblings of a supplied item.
    • OptionalstartItemId: string

      Optional. Skip through the list until a given item is found.
    • OptionalstartIndex: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • OptionalenableImages: boolean

      Optional, include image information in output.
    • OptionalimageTypeLimit: number

      Optional, the max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalsortBy: ItemSortBy

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets episodes for a tv season.

    Throws

• getNextUp:function

  • getNextUp(userId?, startIndex?, limit?, fields?, seriesId?, parentId?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, nextUpDateCutoff?, enableTotalRecordCount?, disableFirstEpisode?, enableResumable?, enableRewatching?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • OptionaluserId: string

      The user id of the user to get the next up episodes for.
    • OptionalstartIndex: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalseriesId: string

      Optional. Filter by series id.
    • OptionalparentId: string

      Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalnextUpDateCutoff: string

      Optional. Starting date of shows to show in Next Up section.
    • OptionalenableTotalRecordCount: boolean

      Whether to enable the total records count. Defaults to true.
    • OptionaldisableFirstEpisode: boolean

      Whether to disable sending the first episode in a series as next up.
    • OptionalenableResumable: boolean

      Whether to include resumable episodes in next up results.
    • OptionalenableRewatching: boolean

      Whether to include watched episodes in next up results.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets a list of next up episodes.

    Throws

• getSeasons:function

  • getSeasons(seriesId, userId?, fields?, isSpecialSeason?, isMissing?, adjacentTo?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • seriesId: string

      The series id.
    • OptionaluserId: string

      The user id.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • OptionalisSpecialSeason: boolean

      Optional. Filter by special season.
    • OptionalisMissing: boolean

      Optional. Filter by items that are missing episodes or not.
    • OptionaladjacentTo: string

      Optional. Return items that are siblings of a supplied item.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets seasons for a tv series.

    Throws

• getUpcomingEpisodes:function

  • getUpcomingEpisodes(userId?, startIndex?, limit?, fields?, parentId?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • OptionaluserId: string

      The user id of the user to get the upcoming episodes for.
    • OptionalstartIndex: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalparentId: string

      Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets a list of upcoming episodes.

    Throws