@jellyfin/sdk

/** * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * Do not edit the class manually. * * Jellyfin API * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { BaseItemDto } from '../models'; import type { BaseItemDtoQueryResult } from '../models'; import type { ChannelMappingOptionsDto } from '../models'; import type { ChannelType } from '../models'; import type { GetProgramsDto } from '../models'; import type { GuideInfo } from '../models'; import type { ImageType } from '../models'; import type { ItemFields } from '../models'; import type { ItemSortBy } from '../models'; import type { ListingsProviderInfo } from '../models'; import type { LiveTvInfo } from '../models'; import type { NameIdPair } from '../models'; import type { RecordingStatus } from '../models'; import type { SeriesTimerInfoDto } from '../models'; import type { SeriesTimerInfoDtoQueryResult } from '../models'; import type { SetChannelMappingDto } from '../models'; import type { SortOrder } from '../models'; import type { TimerInfoDto } from '../models'; import type { TimerInfoDtoQueryResult } from '../models'; import type { TunerChannelMapping } from '../models'; import type { TunerHostInfo } from '../models'; /** * LiveTvApi - axios parameter creator * @export */ export declare const LiveTvApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Adds a listings provider. * @param {string} [pw] Password. * @param {boolean} [validateListings] Validate listings. * @param {boolean} [validateLogin] Validate login. * @param {ListingsProviderInfo} [listingsProviderInfo] New listings info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Adds a tuner host. * @param {TunerHostInfo} [tunerHostInfo] New tuner host. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Cancels a live tv series timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSeriesTimer: (timerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Cancels a live tv timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelTimer: (timerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Creates a live tv series timer. * @param {SeriesTimerInfoDto} [seriesTimerInfoDto] New series timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Creates a live tv timer. * @param {TimerInfoDto} [timerInfoDto] New timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTimer: (timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Delete listing provider. * @param {string} [id] Listing provider id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteListingProvider: (id?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Deletes a live tv recording. * @param {string} recordingId Recording id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording: (recordingId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Deletes a tuner host. * @param {string} [id] Tuner host id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTunerHost: (id?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Discover tuners. * @param {boolean} [newDevicesOnly] Only discover new tuners. * @param {*} [options] Override http request option. * @throws {RequiredError} */ discoverTuners: (newDevicesOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Discover tuners. * @param {boolean} [newDevicesOnly] Only discover new tuners. * @param {*} [options] Override http request option. * @throws {RequiredError} */ discvoverTuners: (newDevicesOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv channel. * @param {string} channelId Channel id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannel: (channelId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get channel mapping options. * @param {string} [providerId] Provider id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelMappingOptions: (providerId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets default listings provider info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefaultListingProvider: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets the default values for a new timer. * @param {string} [programId] Optional. To attach default values based on a program. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefaultTimer: (programId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get guid info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGuideInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available lineups. * @param {string} [id] Provider id. * @param {string} [type] Provider type. * @param {string} [location] Location. * @param {string} [country] Country. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLineups: (id?: string, type?: string, location?: string, country?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv recording stream. * @param {string} recordingId Recording id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveRecordingFile: (recordingId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv channel stream. * @param {string} streamId Stream id. * @param {string} container Container type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveStreamFile: (streamId: string, container: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available live tv channels. * @param {ChannelType} [type] Optional. Filter by channel type. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [isFavorite] Optional. Filter by channels that are favorites, or not. * @param {boolean} [isLiked] Optional. Filter by channels that are liked, or not. * @param {boolean} [isDisliked] Optional. Filter by channels that are disliked, or not. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] \"Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {Array<ItemSortBy>} [sortBy] Optional. Key to sort by. * @param {SortOrder} [sortOrder] Optional. Sort order. * @param {boolean} [enableFavoriteSorting] Optional. Incorporate favorite and like status into channel sorting. * @param {boolean} [addCurrentProgram] Optional. Adds current program info to each channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available live tv services. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available live tv epgs. * @param {Array<string>} [channelIds] The channels to return guide information for. * @param {string} [userId] Optional. Filter by user id. * @param {string} [minStartDate] Optional. The minimum premiere start date. * @param {boolean} [hasAired] Optional. Filter by programs that have completed airing, or not. * @param {boolean} [isAiring] Optional. Filter by programs that are currently airing, or not. * @param {string} [maxStartDate] Optional. The maximum premiere start date. * @param {string} [minEndDate] Optional. The minimum premiere end date. * @param {string} [maxEndDate] Optional. The maximum premiere end date. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending. * @param {Array<string>} [genres] The genres to return guide information for. * @param {Array<string>} [genreIds] The genre ids to return guide information for. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {string} [seriesTimerId] Optional. Filter by series timer id. * @param {string} [librarySeriesId] Optional. Filter by library series id. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableTotalRecordCount] Retrieve total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvPrograms: (channelIds?: Array<string>, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv program. * @param {string} programId Program id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProgram: (programId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available live tv epgs. * @param {GetProgramsDto} [getProgramsDto] Request body. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrograms: (getProgramsDto?: GetProgramsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets recommended live tv epgs. * @param {string} [userId] Optional. filter by user id. * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [isAiring] Optional. Filter by programs that are currently airing, or not. * @param {boolean} [hasAired] Optional. Filter by programs that have completed airing, or not. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<string>} [genreIds] The genres to return guide information for. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. include user data. * @param {boolean} [enableTotalRecordCount] Retrieve total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, genreIds?: Array<string>, fields?: Array<ItemFields>, enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv recording. * @param {string} recordingId Recording id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecording: (recordingId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets recording folders. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingFolders: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get recording group. * @param {string} groupId Group id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingGroup: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets live tv recording groups. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingGroups: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets live tv recordings. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {RecordingStatus} [status] Optional. Filter by recording status. * @param {boolean} [isInProgress] Optional. Filter by recordings that are in progress, or not. * @param {string} [seriesTimerId] Optional. Filter by recordings belonging to a series timer. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isLibraryItem] Optional. Filter for is library item. * @param {boolean} [enableTotalRecordCount] Optional. Return total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets live tv recording series. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {string} [groupId] Optional. Filter by recording group. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {RecordingStatus} [status] Optional. Filter by recording status. * @param {boolean} [isInProgress] Optional. Filter by recordings that are in progress, or not. * @param {string} [seriesTimerId] Optional. Filter by recordings belonging to a series timer. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {boolean} [enableTotalRecordCount] Optional. Return total record count. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets available countries. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchedulesDirectCountries: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a live tv series timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSeriesTimer: (timerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets live tv series timers. * @param {string} [sortBy] Optional. Sort by SortName or Priority. * @param {SortOrder} [sortOrder] Optional. Sort in Ascending or Descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets a timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTimer: (timerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets the live tv timers. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [seriesTimerId] Optional. Filter by timers belonging to a series timer. * @param {boolean} [isActive] Optional. Filter by timers that are active. * @param {boolean} [isScheduled] Optional. Filter by timers that are scheduled. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get tuner host types. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTunerHostTypes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Resets a tv tuner. * @param {string} tunerId Tuner id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetTuner: (tunerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Set channel mappings. * @param {SetChannelMappingDto} setChannelMappingDto The set channel mapping dto. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Updates a live tv series timer. * @param {string} timerId Timer id. * @param {SeriesTimerInfoDto} [seriesTimerInfoDto] New series timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Updates a live tv timer. * @param {string} timerId Timer id. * @param {TimerInfoDto} [timerInfoDto] New timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * LiveTvApi - functional programming interface * @export */ export declare const LiveTvApiFp: (configuration?: Configuration) => { /** * * @summary Adds a listings provider. * @param {string} [pw] Password. * @param {boolean} [validateListings] Validate listings. * @param {boolean} [validateLogin] Validate login. * @param {ListingsProviderInfo} [listingsProviderInfo] New listings info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>; /** * * @summary Adds a tuner host. * @param {TunerHostInfo} [tunerHostInfo] New tuner host. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTunerHost(tunerHostInfo?: TunerHostInfo, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>>; /** * * @summary Cancels a live tv series timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Cancels a live tv timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Creates a live tv series timer. * @param {SeriesTimerInfoDto} [seriesTimerInfoDto] New series timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Creates a live tv timer. * @param {TimerInfoDto} [timerInfoDto] New timer info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTimer(timerInfoDto?: TimerInfoDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Delete listing provider. * @param {string} [id] Listing provider id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteListingProvider(id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Deletes a live tv recording. * @param {string} recordingId Recording id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording(recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Deletes a tuner host. * @param {string} [id] Tuner host id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTunerHost(id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Discover tuners. * @param {boolean} [newDevicesOnly] Only discover new tuners. * @param {*} [options] Override http request option. * @throws {RequiredError} */ discoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TunerHostInfo>>>; /** * * @summary Discover tuners. * @param {boolean} [newDevicesOnly] Only discover new tuners. * @param {*} [options] Override http request option. * @throws {RequiredError} */ discvoverTuners(newDevicesOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TunerHostInfo>>>; /** * * @summary Gets a live tv channel. * @param {string} channelId Channel id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannel(channelId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>; /** * * @summary Get channel mapping options. * @param {string} [providerId] Provider id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelMappingOptions(providerId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>>; /** * * @summary Gets default listings provider info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefaultListingProvider(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>; /** * * @summary Gets the default values for a new timer. * @param {string} [programId] Optional. To attach default values based on a program. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefaultTimer(programId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>; /** * * @summary Get guid info. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGuideInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>>; /** * * @summary Gets available lineups. * @param {string} [id] Provider id. * @param {string} [type] Provider type. * @param {string} [location] Location. * @param {string} [country] Country. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLineups(id?: string, type?: string, location?: string, country?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NameIdPair>>>; /** * * @summary Gets a live tv recording stream. * @param {string} recordingId Recording id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveRecordingFile(recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets a live tv channel stream. * @param {string} streamId Stream id. * @param {string} container Container type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveStreamFile(streamId: string, container: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets available live tv channels. * @param {ChannelType} [type] Optional. Filter by channel type. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [isFavorite] Optional. Filter by channels that are favorites, or not. * @param {boolean} [isLiked] Optional. Filter by channels that are liked, or not. * @param {boolean} [isDisliked] Optional. Filter by channels that are disliked, or not. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] \"Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {Array<ItemSortBy>} [sortBy] Optional. Key to sort by. * @param {SortOrder} [sortOrder] Optional. Sort order. * @param {boolean} [enableFavoriteSorting] Optional. Incorporate favorite and like status into channel sorting. * @param {boolean} [addCurrentProgram] Optional. Adds current program info to each channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets available live tv services. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>>; /** * * @summary Gets available live tv epgs. * @param {Array<string>} [channelIds] The channels to return guide information for. * @param {string} [userId] Optional. Filter by user id. * @param {string} [minStartDate] Optional. The minimum premiere start date. * @param {boolean} [hasAired] Optional. Filter by programs that have completed airing, or not. * @param {boolean} [isAiring] Optional. Filter by programs that are currently airing, or not. * @param {string} [maxStartDate] Optional. The maximum premiere start date. * @param {string} [minEndDate] Optional. The minimum premiere end date. * @param {string} [maxEndDate] Optional. The maximum premiere end date. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending. * @param {Array<string>} [genres] The genres to return guide information for. * @param {Array<string>} [genreIds] The genre ids to return guide information for. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {string} [seriesTimerId] Optional. Filter by series timer id. * @param {string} [librarySeriesId] Optional. Filter by library series id. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableTotalRecordCount] Retrieve total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveTvPrograms(channelIds?: Array<string>, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets a live tv program. * @param {string} programId Program id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProgram(programId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>; /** * * @summary Gets available live tv epgs. * @param {GetProgramsDto} [getProgramsDto] Request body. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrograms(getProgramsDto?: GetProgramsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets recommended live tv epgs. * @param {string} [userId] Optional. filter by user id. * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [isAiring] Optional. Filter by programs that are currently airing, or not. * @param {boolean} [hasAired] Optional. Filter by programs that have completed airing, or not. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<string>} [genreIds] The genres to return guide information for. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. include user data. * @param {boolean} [enableTotalRecordCount] Retrieve total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, genreIds?: Array<string>, fields?: Array<ItemFields>, enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets a live tv recording. * @param {string} recordingId Recording id. * @param {string} [userId] Optional. Attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecording(recordingId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>; /** * * @summary Gets recording folders. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingFolders(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Get recording group. * @param {string} groupId Group id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingGroup(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Gets live tv recording groups. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingGroups(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets live tv recordings. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {RecordingStatus} [status] Optional. Filter by recording status. * @param {boolean} [isInProgress] Optional. Filter by recordings that are in progress, or not. * @param {string} [seriesTimerId] Optional. Filter by recordings belonging to a series timer. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {boolean} [isMovie] Optional. Filter for movies. * @param {boolean} [isSeries] Optional. Filter for series. * @param {boolean} [isKids] Optional. Filter for kids. * @param {boolean} [isSports] Optional. Filter for sports. * @param {boolean} [isNews] Optional. Filter for news. * @param {boolean} [isLibraryItem] Optional. Filter for is library item. * @param {boolean} [enableTotalRecordCount] Optional. Return total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets live tv recording series. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [userId] Optional. Filter by user and attach user data. * @param {string} [groupId] Optional. Filter by recording group. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {RecordingStatus} [status] Optional. Filter by recording status. * @param {boolean} [isInProgress] Optional. Filter by recordings that are in progress, or not. * @param {string} [seriesTimerId] Optional. Filter by recordings belonging to a series timer. * @param {boolean} [enableImages] Optional. Include image information in output. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. * @param {boolean} [enableTotalRecordCount] Optional. Return total record count. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets available countries. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchedulesDirectCountries(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets a live tv series timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSeriesTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>; /** * * @summary Gets live tv series timers. * @param {string} [sortBy] Optional. Sort by SortName or Priority. * @param {SortOrder} [sortOrder] Optional. Sort in Ascending or Descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSeriesTimers(sortBy?: string, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>>; /** * * @summary Gets a timer. * @param {string} timerId Timer id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTimer(timerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>>; /** * * @summary Gets the live tv timers. * @param {string} [channelId] Optional. Filter by channel id. * @param {string} [seriesTimerId] Optional. Filter by timers belonging to a series timer. * @param {boolean} [isActive] Optional. Filter by timers that are active. * @param {boolean} [isScheduled] Optional. Filter by timers that are scheduled. * @param {*}