@jellyfin/sdk
Preparing search index...
generated-client
TvShowsApiAxiosParamCreator
Function TvShowsApiAxiosParamCreator
TvShowsApiAxiosParamCreator
(
configuration
?:
Configuration
,
)
:
{
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
<
RequestArgs
>
;
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
<
RequestArgs
>
;
getSeasons
:
(
seriesId
:
string
,
userId
?:
string
,
fields
?:
ItemFields
[]
,
isSpecialSeason
?:
boolean
,
isMissing
?:
boolean
,
adjacentTo
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getUpcomingEpisodes
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
parentId
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
TvShowsApi - axios parameter creator
Parameters
Optional
configuration
:
Configuration
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
<
RequestArgs
>
;
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
<
RequestArgs
>
;
getSeasons
:
(
seriesId
:
string
,
userId
?:
string
,
fields
?:
ItemFields
[]
,
isSpecialSeason
?:
boolean
,
isMissing
?:
boolean
,
adjacentTo
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getUpcomingEpisodes
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
parentId
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
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
<
RequestArgs
>
Throws
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
<
RequestArgs
>
Throws
getSeasons
:
(
seriesId
:
string
,
userId
?:
string
,
fields
?:
ItemFields
[]
,
isSpecialSeason
?:
boolean
,
isMissing
?:
boolean
,
adjacentTo
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getUpcomingEpisodes
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
parentId
?:
string
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
Export
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@jellyfin/sdk
Loading...
TvShowsApi - axios parameter creator