Function LibraryApiFp

Returns {
    deleteItem(itemId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    deleteItems(ids?: string[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getAncestors(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>)>;
    getCriticReviews(itemId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getDownload(itemId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getFile(itemId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getItemCounts(userId?: string, isFavorite?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>)>;
    getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>)>;
    getMediaFolders(isHidden?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getPhysicalPaths(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>;
    getSimilarAlbums(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSimilarArtists(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSimilarItems(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSimilarMovies(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSimilarShows(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getSimilarTrailers(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>)>;
    getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>;
    getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>;
    postAddedMovies(tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    postAddedSeries(tvdbId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    postUpdatedSeries(tvdbId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    refreshLibrary(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• deleteItem:function

  • deleteItem(itemId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • itemId: string

      The item id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Deletes an item from the library and filesystem.

    Throws

• deleteItems:function

  • deleteItems(ids?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionalids: string[]

      The item ids.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Deletes items from the library and filesystem.

    Throws

• getAncestors:function

  • getAncestors(itemId, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>)>

    Summary

    Gets all parents of an item.

    Throws

• getCriticReviews:function

  • getCriticReviews(itemId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets critic review for an item.

    Deprecated

    Throws

• getDownload:function

  • getDownload(itemId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The item id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Downloads item media.

    Throws

• getFile:function

  • getFile(itemId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The item id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Get the original file of an item.

    Throws

• getItemCounts:function

  • getItemCounts(userId?, isFavorite?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>)>

  • Parameters

    • OptionaluserId: string

      Optional. Get counts from a specific user&#39;s library.
    • OptionalisFavorite: boolean

      Optional. Get counts of favorite items.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>)>

    Summary

    Get item counts.

    Throws

• getLibraryOptionsInfo:function

  • getLibraryOptionsInfo(libraryContentType?, isNewLibrary?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>)>

  • Parameters

    • OptionallibraryContentType: CollectionType

      Library content type.
    • OptionalisNewLibrary: boolean

      Whether this is a new library.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>)>

    Summary

    Gets the library options info.

    Throws

• getMediaFolders:function

  • getMediaFolders(isHidden?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • OptionalisHidden: boolean

      Optional. Filter by folders that are marked hidden, or not.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets all user media folders.

    Throws

• getPhysicalPaths:function

  • getPhysicalPaths(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>

    Summary

    Gets a list of physical paths from virtual folders.

    Throws

• getSimilarAlbums:function

  • getSimilarAlbums(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getSimilarArtists:function

  • getSimilarArtists(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getSimilarItems:function

  • getSimilarItems(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getSimilarMovies:function

  • getSimilarMovies(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getSimilarShows:function

  • getSimilarShows(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getSimilarTrailers:function

  • getSimilarTrailers(itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionalexcludeArtistIds: string[]

      Exclude artist ids.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets similar items.

    Throws

• getThemeMedia:function

  • getThemeMedia(itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • OptionalinheritFromParent: boolean

      Optional. Determines whether or not parent items should be searched for theme media.
    • OptionalsortBy: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
    • OptionalsortOrder: SortOrder[]

      Optional. Sort Order - Ascending, Descending.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>)>

    Summary

    Get theme songs and videos for an item.

    Throws

• getThemeSongs:function

  • getThemeSongs(itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • OptionalinheritFromParent: boolean

      Optional. Determines whether or not parent items should be searched for theme media.
    • OptionalsortBy: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
    • OptionalsortOrder: SortOrder[]

      Optional. Sort Order - Ascending, Descending.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>

    Summary

    Get theme songs for an item.

    Throws

• getThemeVideos:function

  • getThemeVideos(itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • OptionalinheritFromParent: boolean

      Optional. Determines whether or not parent items should be searched for theme media.
    • OptionalsortBy: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
    • OptionalsortOrder: SortOrder[]

      Optional. Sort Order - Ascending, Descending.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>)>

    Summary

    Get theme videos for an item.

    Throws

• postAddedMovies:function

  • postAddedMovies(tmdbId?, imdbId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • OptionaltmdbId: string

      The tmdbId.
    • OptionalimdbId: string

      The imdbId.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postAddedSeries:function

  • postAddedSeries(tvdbId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • OptionaltvdbId: string

      The tvdbId.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Reports that new episodes of a series have been added by an external source.

    Throws

• postUpdatedMedia:function

  • postUpdatedMedia(mediaUpdateInfoDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • mediaUpdateInfoDto: MediaUpdateInfoDto

      The update paths.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postUpdatedMovies:function

  • postUpdatedMovies(tmdbId?, imdbId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • OptionaltmdbId: string

      The tmdbId.
    • OptionalimdbId: string

      The imdbId.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postUpdatedSeries:function

  • postUpdatedSeries(tvdbId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • OptionaltvdbId: string

      The tvdbId.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Reports that new episodes of a series have been added by an external source.

    Throws

• refreshLibrary:function

  • refreshLibrary(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Starts a library scan.

    Throws