Function ItemsApiAxiosParamCreator
- ItemsApiAxiosParamCreator(
configuration?: Configuration,
): {
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[],
enableTotalRecordCount?: boolean,
enableImages?: boolean,
options?: RawAxiosRequestConfig,
) => Promise<RequestArgs>;
getItemUserData: (
itemId: string,
userId?: string,
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>;
updateItemUserData: (
itemId: string,
updateUserItemDataDto: UpdateUserItemDataDto,
userId?: string,
options?: RawAxiosRequestConfig,
) => Promise<RequestArgs>;
} Returns {
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[],
enableTotalRecordCount?: boolean,
enableImages?: boolean,
options?: RawAxiosRequestConfig,
) => Promise<RequestArgs>;
getItemUserData: (
itemId: string,
userId?: string,
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>;
updateItemUserData: (
itemId: string,
updateUserItemDataDto: UpdateUserItemDataDto,
userId?: string,
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[],
enableTotalRecordCount?: boolean,
enableImages?: boolean,
options?: RawAxiosRequestConfig,
) => Promise<RequestArgs>
getItemUserData: (
itemId: string,
userId?: string,
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>
updateItemUserData: (
itemId: string,
updateUserItemDataDto: UpdateUserItemDataDto,
userId?: string,
options?: RawAxiosRequestConfig,
) => Promise<RequestArgs>
ItemsApi - axios parameter creator
Export