@jellyfin/sdk
Preparing search index...
generated-client
ArtistsApiAxiosParamCreator
Function ArtistsApiAxiosParamCreator
ArtistsApiAxiosParamCreator
(
configuration
?:
Configuration
,
)
:
{
getAlbumArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getArtistByName
:
(
name
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
ArtistsApi - axios parameter creator
Parameters
Optional
configuration
:
Configuration
Returns
{
getAlbumArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getArtistByName
:
(
name
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
getAlbumArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getArtistByName
:
(
name
:
string
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getArtists
:
(
minCommunityRating
?:
number
,
startIndex
?:
number
,
limit
?:
number
,
searchTerm
?:
string
,
parentId
?:
string
,
fields
?:
ItemFields
[]
,
excludeItemTypes
?:
BaseItemKind
[]
,
includeItemTypes
?:
BaseItemKind
[]
,
filters
?:
ItemFilter
[]
,
isFavorite
?:
boolean
,
mediaTypes
?:
MediaType
[]
,
genres
?:
string
[]
,
genreIds
?:
string
[]
,
officialRatings
?:
string
[]
,
tags
?:
string
[]
,
years
?:
number
[]
,
enableUserData
?:
boolean
,
imageTypeLimit
?:
number
,
enableImageTypes
?:
ImageType
[]
,
person
?:
string
,
personIds
?:
string
[]
,
personTypes
?:
string
[]
,
studios
?:
string
[]
,
studioIds
?:
string
[]
,
userId
?:
string
,
nameStartsWithOrGreater
?:
string
,
nameStartsWith
?:
string
,
nameLessThan
?:
string
,
sortBy
?:
ItemSortBy
[]
,
sortOrder
?:
SortOrder
[]
,
enableImages
?:
boolean
,
enableTotalRecordCount
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
Export
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@jellyfin/sdk
Loading...
ArtistsApi - axios parameter creator