Function LibraryApiFactory

Returns {
    deleteItem(
        requestParameters: LibraryApiDeleteItemRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    deleteItems(
        requestParameters?: LibraryApiDeleteItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getAncestors(
        requestParameters: LibraryApiGetAncestorsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDto[]>;
    getCriticReviews(
        requestParameters: LibraryApiGetCriticReviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getDownload(
        requestParameters: LibraryApiGetDownloadRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getFile(
        requestParameters: LibraryApiGetFileRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getItemCounts(
        requestParameters?: LibraryApiGetItemCountsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ItemCounts>;
    getLibraryOptionsInfo(
        requestParameters?: LibraryApiGetLibraryOptionsInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LibraryOptionsResultDto>;
    getMediaFolders(
        requestParameters?: LibraryApiGetMediaFoldersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getPhysicalPaths(options?: RawAxiosRequestConfig): AxiosPromise<string[]>;
    getSimilarAlbums(
        requestParameters: LibraryApiGetSimilarAlbumsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarArtists(
        requestParameters: LibraryApiGetSimilarArtistsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarItems(
        requestParameters: LibraryApiGetSimilarItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarMovies(
        requestParameters: LibraryApiGetSimilarMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarShows(
        requestParameters: LibraryApiGetSimilarShowsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarTrailers(
        requestParameters: LibraryApiGetSimilarTrailersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getThemeMedia(
        requestParameters: LibraryApiGetThemeMediaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AllThemeMediaResult>;
    getThemeSongs(
        requestParameters: LibraryApiGetThemeSongsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ThemeMediaResult>;
    getThemeVideos(
        requestParameters: LibraryApiGetThemeVideosRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ThemeMediaResult>;
    postAddedMovies(
        requestParameters?: LibraryApiPostAddedMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postAddedSeries(
        requestParameters?: LibraryApiPostAddedSeriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postUpdatedMedia(
        requestParameters: LibraryApiPostUpdatedMediaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postUpdatedMovies(
        requestParameters?: LibraryApiPostUpdatedMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postUpdatedSeries(
        requestParameters?: LibraryApiPostUpdatedSeriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    refreshLibrary(options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• deleteItem:function

  • deleteItem(
        requestParameters: LibraryApiDeleteItemRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiDeleteItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• deleteItems:function

  • deleteItems(
        requestParameters?: LibraryApiDeleteItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiDeleteItemsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getAncestors:function

  • getAncestors(
        requestParameters: LibraryApiGetAncestorsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDto[]>

  • Parameters

    • requestParameters: LibraryApiGetAncestorsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDto[]>

    Throws

• getCriticReviews:function

  • getCriticReviews(
        requestParameters: LibraryApiGetCriticReviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetCriticReviewsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Deprecated

    Throws

• getDownload:function

  • getDownload(
        requestParameters: LibraryApiGetDownloadRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

  • Parameters

    • requestParameters: LibraryApiGetDownloadRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• getFile:function

  • getFile(
        requestParameters: LibraryApiGetFileRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

  • Parameters

    • requestParameters: LibraryApiGetFileRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• getItemCounts:function

  • getItemCounts(
        requestParameters?: LibraryApiGetItemCountsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ItemCounts>

  • Parameters

    • requestParameters: LibraryApiGetItemCountsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ItemCounts>

    Throws

• getLibraryOptionsInfo:function

  • getLibraryOptionsInfo(
        requestParameters?: LibraryApiGetLibraryOptionsInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LibraryOptionsResultDto>

  • Parameters

    • requestParameters: LibraryApiGetLibraryOptionsInfoRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LibraryOptionsResultDto>

    Throws

• getMediaFolders:function

  • getMediaFolders(
        requestParameters?: LibraryApiGetMediaFoldersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetMediaFoldersRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getPhysicalPaths:function

  • getPhysicalPaths(options?: RawAxiosRequestConfig): AxiosPromise<string[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string[]>

    Throws

• getSimilarAlbums:function

  • getSimilarAlbums(
        requestParameters: LibraryApiGetSimilarAlbumsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarAlbumsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getSimilarArtists:function

  • getSimilarArtists(
        requestParameters: LibraryApiGetSimilarArtistsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarArtistsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getSimilarItems:function

  • getSimilarItems(
        requestParameters: LibraryApiGetSimilarItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarItemsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getSimilarMovies:function

  • getSimilarMovies(
        requestParameters: LibraryApiGetSimilarMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarMoviesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getSimilarShows:function

  • getSimilarShows(
        requestParameters: LibraryApiGetSimilarShowsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarShowsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getSimilarTrailers:function

  • getSimilarTrailers(
        requestParameters: LibraryApiGetSimilarTrailersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarTrailersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getThemeMedia:function

  • getThemeMedia(
        requestParameters: LibraryApiGetThemeMediaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AllThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeMediaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AllThemeMediaResult>

    Throws

• getThemeSongs:function

  • getThemeSongs(
        requestParameters: LibraryApiGetThemeSongsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeSongsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ThemeMediaResult>

    Throws

• getThemeVideos:function

  • getThemeVideos(
        requestParameters: LibraryApiGetThemeVideosRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeVideosRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ThemeMediaResult>

    Throws

• postAddedMovies:function

  • postAddedMovies(
        requestParameters?: LibraryApiPostAddedMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostAddedMoviesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postAddedSeries:function

  • postAddedSeries(
        requestParameters?: LibraryApiPostAddedSeriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostAddedSeriesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postUpdatedMedia:function

  • postUpdatedMedia(
        requestParameters: LibraryApiPostUpdatedMediaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedMediaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postUpdatedMovies:function

  • postUpdatedMovies(
        requestParameters?: LibraryApiPostUpdatedMoviesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedMoviesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postUpdatedSeries:function

  • postUpdatedSeries(
        requestParameters?: LibraryApiPostUpdatedSeriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedSeriesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• refreshLibrary:function

  • refreshLibrary(options?: RawAxiosRequestConfig): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws