@jellyfin/sdk
Preparing search index...
generated-client
LibraryApiAxiosParamCreator
Function LibraryApiAxiosParamCreator
LibraryApiAxiosParamCreator
(
configuration
?:
Configuration
,
)
:
{
deleteItem
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
deleteItems
:
(
ids
?:
string
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getAncestors
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getIntros
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItem
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCollections
:
(
itemId
:
string
,
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItems
:
(
userId
?:
string
,
maxOfficialRating
?:
string
,
hasThemeSong
?:
boolean
,
hasThemeVideo
?:
boolean
,
hasSubtitles
?:
boolean
,
hasSpecialFeature
?:
boolean
,
hasTrailer
?:
boolean
,
adjacentTo
?:
string
,
indexNumber
?:
number
,
parentIndexNumber
?:
number
,
hasParentalRating
?:
boolean
,
isHd
?:
boolean
,
is4K
?:
boolean
,
locationTypes
?:
LocationType
[]
,
excludeLocationTypes
?:
LocationType
[]
,
isMissing
?:
boolean
,
isUnaired
?:
boolean
,
minCommunityRating
?:
number
,
minCriticRating
?:
number
,
minPremiereDate
?:
string
,
minDateLastSaved
?:
string
,
minDateLastSavedForUser
?:
string
,
maxPremiereDate
?:
string
,
hasOverview
?:
boolean
,
hasImdbId
?:
boolean
,
hasTmdbId
?:
boolean
,
hasTvdbId
?:
boolean
,
isMovie
?:
boolean
,
isSeries
?:
boolean
,
isNews
?:
boolean
,
isKids
?:
boolean
,
isSports
?:
boolean
,
excludeItemIds
?:
string
[]
,
startIndex
?:
number
,
limit
?:
number
,
recursive
?:
boolean
,
searchTerm
?:
string
,
sortOrder
?:
SortOrder
[]
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
imageTypes
?:
ImageType
[]
,
sortBy
?:
ItemSortBy
[]
,
isPlayed
?:
boolean
,
genres
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
artists
?:
string
[]
,
excludeArtistIds
?:
string
[]
,
artistIds
?:
string
[]
,
albumArtistIds
?:
string
[]
,
contributingArtistIds
?:
string
[]
,
albums
?:
string
[]
,
albumIds
?:
string
[]
,
ids
?:
string
[]
,
videoTypes
?:
VideoType
[]
,
minOfficialRating
?:
string
,
isLocked
?:
boolean
,
isPlaceHolder
?:
boolean
,
hasOfficialRating
?:
boolean
,
collapseBoxSetItems
?:
boolean
,
minWidth
?:
number
,
minHeight
?:
number
,
maxWidth
?:
number
,
maxHeight
?:
number
,
is3D
?:
boolean
,
seriesStatus
?:
SeriesStatus
[]
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
studioIds
?:
string
[]
,
genreIds
?:
string
[]
,
audioLanguages
?:
string
[]
,
subtitleLanguages
?:
string
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLatestMedia
:
(
userId
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
isPlayed
?:
boolean
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
limit
?:
number
,
groupItems
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLocalTrailers
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getPhysicalPaths
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getResumeItems
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
mediaTypes
?:
MediaType
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
excludeActiveSessions
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getRootFolder
:
(
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarAlbums
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarArtists
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarItems
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarMovies
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarShows
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarTrailers
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSpecialFeatures
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeMedia
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeSongs
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeVideos
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postAddedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postAddedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedMedia
:
(
mediaUpdateInfoDto
:
MediaUpdateInfoDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
refreshItem
:
(
itemId
:
string
,
metadataRefreshMode
?:
MetadataRefreshMode
,
imageRefreshMode
?:
MetadataRefreshMode
,
replaceAllMetadata
?:
boolean
,
replaceAllImages
?:
boolean
,
regenerateTrickplay
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
refreshLibrary
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
}
LibraryApi - axios parameter creator
Parameters
Optional
configuration
:
Configuration
Returns
{
deleteItem
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
deleteItems
:
(
ids
?:
string
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getAncestors
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getIntros
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItem
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCollections
:
(
itemId
:
string
,
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItems
:
(
userId
?:
string
,
maxOfficialRating
?:
string
,
hasThemeSong
?:
boolean
,
hasThemeVideo
?:
boolean
,
hasSubtitles
?:
boolean
,
hasSpecialFeature
?:
boolean
,
hasTrailer
?:
boolean
,
adjacentTo
?:
string
,
indexNumber
?:
number
,
parentIndexNumber
?:
number
,
hasParentalRating
?:
boolean
,
isHd
?:
boolean
,
is4K
?:
boolean
,
locationTypes
?:
LocationType
[]
,
excludeLocationTypes
?:
LocationType
[]
,
isMissing
?:
boolean
,
isUnaired
?:
boolean
,
minCommunityRating
?:
number
,
minCriticRating
?:
number
,
minPremiereDate
?:
string
,
minDateLastSaved
?:
string
,
minDateLastSavedForUser
?:
string
,
maxPremiereDate
?:
string
,
hasOverview
?:
boolean
,
hasImdbId
?:
boolean
,
hasTmdbId
?:
boolean
,
hasTvdbId
?:
boolean
,
isMovie
?:
boolean
,
isSeries
?:
boolean
,
isNews
?:
boolean
,
isKids
?:
boolean
,
isSports
?:
boolean
,
excludeItemIds
?:
string
[]
,
startIndex
?:
number
,
limit
?:
number
,
recursive
?:
boolean
,
searchTerm
?:
string
,
sortOrder
?:
SortOrder
[]
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
imageTypes
?:
ImageType
[]
,
sortBy
?:
ItemSortBy
[]
,
isPlayed
?:
boolean
,
genres
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
artists
?:
string
[]
,
excludeArtistIds
?:
string
[]
,
artistIds
?:
string
[]
,
albumArtistIds
?:
string
[]
,
contributingArtistIds
?:
string
[]
,
albums
?:
string
[]
,
albumIds
?:
string
[]
,
ids
?:
string
[]
,
videoTypes
?:
VideoType
[]
,
minOfficialRating
?:
string
,
isLocked
?:
boolean
,
isPlaceHolder
?:
boolean
,
hasOfficialRating
?:
boolean
,
collapseBoxSetItems
?:
boolean
,
minWidth
?:
number
,
minHeight
?:
number
,
maxWidth
?:
number
,
maxHeight
?:
number
,
is3D
?:
boolean
,
seriesStatus
?:
SeriesStatus
[]
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
studioIds
?:
string
[]
,
genreIds
?:
string
[]
,
audioLanguages
?:
string
[]
,
subtitleLanguages
?:
string
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLatestMedia
:
(
userId
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
isPlayed
?:
boolean
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
limit
?:
number
,
groupItems
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLocalTrailers
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getPhysicalPaths
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getResumeItems
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
mediaTypes
?:
MediaType
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
excludeActiveSessions
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getRootFolder
:
(
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarAlbums
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarArtists
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarItems
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarMovies
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarShows
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSimilarTrailers
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getSpecialFeatures
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeMedia
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeSongs
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getThemeVideos
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postAddedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postAddedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedMedia
:
(
mediaUpdateInfoDto
:
MediaUpdateInfoDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
postUpdatedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
refreshItem
:
(
itemId
:
string
,
metadataRefreshMode
?:
MetadataRefreshMode
,
imageRefreshMode
?:
MetadataRefreshMode
,
replaceAllMetadata
?:
boolean
,
replaceAllImages
?:
boolean
,
regenerateTrickplay
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
refreshLibrary
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
}
deleteItem
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
deleteItems
:
(
ids
?:
string
[]
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getAncestors
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getIntros
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getItem
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getItemCollections
:
(
itemId
:
string
,
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getItems
:
(
userId
?:
string
,
maxOfficialRating
?:
string
,
hasThemeSong
?:
boolean
,
hasThemeVideo
?:
boolean
,
hasSubtitles
?:
boolean
,
hasSpecialFeature
?:
boolean
,
hasTrailer
?:
boolean
,
adjacentTo
?:
string
,
indexNumber
?:
number
,
parentIndexNumber
?:
number
,
hasParentalRating
?:
boolean
,
isHd
?:
boolean
,
is4K
?:
boolean
,
locationTypes
?:
LocationType
[]
,
excludeLocationTypes
?:
LocationType
[]
,
isMissing
?:
boolean
,
isUnaired
?:
boolean
,
minCommunityRating
?:
number
,
minCriticRating
?:
number
,
minPremiereDate
?:
string
,
minDateLastSaved
?:
string
,
minDateLastSavedForUser
?:
string
,
maxPremiereDate
?:
string
,
hasOverview
?:
boolean
,
hasImdbId
?:
boolean
,
hasTmdbId
?:
boolean
,
hasTvdbId
?:
boolean
,
isMovie
?:
boolean
,
isSeries
?:
boolean
,
isNews
?:
boolean
,
isKids
?:
boolean
,
isSports
?:
boolean
,
excludeItemIds
?:
string
[]
,
startIndex
?:
number
,
limit
?:
number
,
recursive
?:
boolean
,
searchTerm
?:
string
,
sortOrder
?:
SortOrder
[]
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
imageTypes
?:
ImageType
[]
,
sortBy
?:
ItemSortBy
[]
,
isPlayed
?:
boolean
,
genres
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
artists
?:
string
[]
,
excludeArtistIds
?:
string
[]
,
artistIds
?:
string
[]
,
albumArtistIds
?:
string
[]
,
contributingArtistIds
?:
string
[]
,
albums
?:
string
[]
,
albumIds
?:
string
[]
,
ids
?:
string
[]
,
videoTypes
?:
VideoType
[]
,
minOfficialRating
?:
string
,
isLocked
?:
boolean
,
isPlaceHolder
?:
boolean
,
hasOfficialRating
?:
boolean
,
collapseBoxSetItems
?:
boolean
,
minWidth
?:
number
,
minHeight
?:
number
,
maxWidth
?:
number
,
maxHeight
?:
number
,
is3D
?:
boolean
,
seriesStatus
?:
SeriesStatus
[]
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
studioIds
?:
string
[]
,
genreIds
?:
string
[]
,
audioLanguages
?:
string
[]
,
subtitleLanguages
?:
string
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getLatestMedia
:
(
userId
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
isPlayed
?:
boolean
,
enableImages
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
enableUserData
?:
boolean
,
limit
?:
number
,
groupItems
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getLocalTrailers
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getPhysicalPaths
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getResumeItems
:
(
userId
?:
string
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
mediaTypes
?:
MediaType
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
enableTotalRecordCount
?:
boolean
,
enableImages
?:
boolean
,
excludeActiveSessions
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getRootFolder
:
(
userId
?:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarAlbums
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarArtists
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarItems
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarMovies
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarShows
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSimilarTrailers
:
(
itemId
:
string
,
excludeArtistIds
?:
string
[]
,
userId
?:
string
,
limit
?:
number
,
fields
?:
ItemFields
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getSpecialFeatures
:
(
itemId
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getThemeMedia
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getThemeSongs
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getThemeVideos
:
(
itemId
:
string
,
userId
?:
string
,
inheritFromParent
?:
boolean
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
postAddedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
postAddedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
postUpdatedMedia
:
(
mediaUpdateInfoDto
:
MediaUpdateInfoDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
postUpdatedMovies
:
(
tmdbId
?:
string
,
imdbId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
postUpdatedSeries
:
(
tvdbId
?:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
refreshItem
:
(
itemId
:
string
,
metadataRefreshMode
?:
MetadataRefreshMode
,
imageRefreshMode
?:
MetadataRefreshMode
,
replaceAllMetadata
?:
boolean
,
replaceAllImages
?:
boolean
,
regenerateTrickplay
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
refreshLibrary
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@jellyfin/sdk
Loading...
LibraryApi - axios parameter creator