@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
>
;
getCriticReviews
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getPhysicalPaths
:
(
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
>
;
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
>
;
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
>
;
getCriticReviews
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getPhysicalPaths
:
(
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
>
;
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
>
;
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
getCriticReviews
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Deprecated
Throws
getDownload
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getFile
:
(
itemId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getItemCounts
:
(
userId
?:
string
,
isFavorite
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getLibraryOptionsInfo
:
(
libraryContentType
?:
CollectionType
,
isNewLibrary
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getMediaFolders
:
(
isHidden
?:
boolean
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getPhysicalPaths
:
(
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
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
refreshLibrary
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
Export
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@jellyfin/sdk
Loading...
LibraryApi - axios parameter creator