Class LibraryApi

LibraryApi - object-oriented interface

Export

LibraryApi

Hierarchy

BaseAPI
- LibraryApi

Constructors

constructor

new LibraryApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): LibraryApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LibraryApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteItem

deleteItem(
requestParameters: LibraryApiDeleteItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiDeleteItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2447

deleteItems

deleteItems(
requestParameters?: LibraryApiDeleteItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiDeleteItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2459

getAncestors

getAncestors(
requestParameters: LibraryApiGetAncestorsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[]>>
Parameters
- requestParameters: LibraryApiGetAncestorsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[]>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2471

getCriticReviews

getCriticReviews(
requestParameters: LibraryApiGetCriticReviewsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetCriticReviewsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Deprecated
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2484

getDownload

getDownload(
requestParameters: LibraryApiGetDownloadRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: LibraryApiGetDownloadRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2496

getFile

getFile(
requestParameters: LibraryApiGetFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: LibraryApiGetFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2508

getItemCounts

getItemCounts(
requestParameters?: LibraryApiGetItemCountsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ItemCounts>>
Parameters
- requestParameters: LibraryApiGetItemCountsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemCounts>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2520

getLibraryOptionsInfo

getLibraryOptionsInfo(
requestParameters?: LibraryApiGetLibraryOptionsInfoRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LibraryOptionsResultDto>>
Parameters
- requestParameters: LibraryApiGetLibraryOptionsInfoRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LibraryOptionsResultDto>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2532

getMediaFolders

getMediaFolders(
requestParameters?: LibraryApiGetMediaFoldersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetMediaFoldersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2544

getPhysicalPaths

getPhysicalPaths(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string[]>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string[]>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2555

getSimilarAlbums

getSimilarAlbums(
requestParameters: LibraryApiGetSimilarAlbumsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarAlbumsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2567

getSimilarArtists

getSimilarArtists(
requestParameters: LibraryApiGetSimilarArtistsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarArtistsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2579

getSimilarItems

getSimilarItems(
requestParameters: LibraryApiGetSimilarItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2591

getSimilarMovies

getSimilarMovies(
requestParameters: LibraryApiGetSimilarMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarMoviesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2603

getSimilarShows

getSimilarShows(
requestParameters: LibraryApiGetSimilarShowsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarShowsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2615

getSimilarTrailers

getSimilarTrailers(
requestParameters: LibraryApiGetSimilarTrailersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: LibraryApiGetSimilarTrailersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2627

getThemeMedia

getThemeMedia(
requestParameters: LibraryApiGetThemeMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AllThemeMediaResult>>
Parameters
- requestParameters: LibraryApiGetThemeMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AllThemeMediaResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2639

getThemeSongs

getThemeSongs(
requestParameters: LibraryApiGetThemeSongsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ThemeMediaResult>>
Parameters
- requestParameters: LibraryApiGetThemeSongsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2651

getThemeVideos

getThemeVideos(
requestParameters: LibraryApiGetThemeVideosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ThemeMediaResult>>
Parameters
- requestParameters: LibraryApiGetThemeVideosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2663

postAddedMovies

postAddedMovies(
requestParameters?: LibraryApiPostAddedMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiPostAddedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2675

postAddedSeries

postAddedSeries(
requestParameters?: LibraryApiPostAddedSeriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiPostAddedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2687

postUpdatedMedia

postUpdatedMedia(
requestParameters: LibraryApiPostUpdatedMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiPostUpdatedMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2699

postUpdatedMovies

postUpdatedMovies(
requestParameters?: LibraryApiPostUpdatedMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiPostUpdatedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2711

postUpdatedSeries

postUpdatedSeries(
requestParameters?: LibraryApiPostUpdatedSeriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LibraryApiPostUpdatedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2723

refreshLibrary

refreshLibrary(options?: RawAxiosRequestConfig): Promise<AxiosResponse<void>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2734

Class LibraryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LibraryApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteItem

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

deleteItems

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

getAncestors

Parameters

Returns Promise<AxiosResponse<BaseItemDto[]>>

Throws

Memberof

getCriticReviews

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Deprecated

Throws

Memberof

getDownload

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

getFile

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

getItemCounts

Parameters

Returns Promise<AxiosResponse<ItemCounts>>

Throws

Memberof

getLibraryOptionsInfo

Parameters

Returns Promise<AxiosResponse<LibraryOptionsResultDto>>

Throws

Memberof

getMediaFolders

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Throws

Memberof

getPhysicalPaths

Parameters

Returns Promise<AxiosResponse<string[]>>

Throws

Memberof

getSimilarAlbums

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Throws

Memberof

getSimilarArtists

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Throws

Memberof

getSimilarItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

`Protected`axios

`Protected`basePath

`Protected`configuration