Class LibraryApi

LibraryApi - object-oriented interface

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:38

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

deleteItem

deleteItem(
requestParameters: LibraryApiDeleteItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiDeleteItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4284

deleteItems

deleteItems(
requestParameters?: LibraryApiDeleteItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiDeleteItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4295

getAncestors

getAncestors(
requestParameters: LibraryApiGetAncestorsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[], any, {}>>
Parameters
- requestParameters: LibraryApiGetAncestorsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4306

getDownload

getDownload(
requestParameters: LibraryApiGetDownloadRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: LibraryApiGetDownloadRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4317

getFile

getFile(
requestParameters: LibraryApiGetFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: LibraryApiGetFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4328

getIntros

getIntros(
requestParameters: LibraryApiGetIntrosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetIntrosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4339

getItem

getItem(
requestParameters: LibraryApiGetItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any, {}>>
Parameters
- requestParameters: LibraryApiGetItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4350

getItemCollections

getItemCollections(
requestParameters: LibraryApiGetItemCollectionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetItemCollectionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4361

getItemCounts

getItemCounts(
requestParameters?: LibraryApiGetItemCountsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ItemCounts, any, {}>>
Parameters
- requestParameters: LibraryApiGetItemCountsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemCounts, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4372

getItems

getItems(
requestParameters?: LibraryApiGetItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4383

getLatestMedia

getLatestMedia(
requestParameters?: LibraryApiGetLatestMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[], any, {}>>
Parameters
- requestParameters: LibraryApiGetLatestMediaRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4394

getLibraryOptionsInfo

getLibraryOptionsInfo(
requestParameters?: LibraryApiGetLibraryOptionsInfoRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LibraryOptionsResultDto, any, {}>>
Parameters
- requestParameters: LibraryApiGetLibraryOptionsInfoRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LibraryOptionsResultDto, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4405

getLocalTrailers

getLocalTrailers(
requestParameters: LibraryApiGetLocalTrailersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[], any, {}>>
Parameters
- requestParameters: LibraryApiGetLocalTrailersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4416

getMediaFolders

getMediaFolders(
requestParameters?: LibraryApiGetMediaFoldersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetMediaFoldersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4427

getPhysicalPaths

getPhysicalPaths(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string[], any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4437

getResumeItems

getResumeItems(
requestParameters?: LibraryApiGetResumeItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetResumeItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4448

getRootFolder

getRootFolder(
requestParameters?: LibraryApiGetRootFolderRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any, {}>>
Parameters
- requestParameters: LibraryApiGetRootFolderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4459

getSimilarAlbums

getSimilarAlbums(
requestParameters: LibraryApiGetSimilarAlbumsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarAlbumsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4470

getSimilarArtists

getSimilarArtists(
requestParameters: LibraryApiGetSimilarArtistsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarArtistsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4481

getSimilarItems

getSimilarItems(
requestParameters: LibraryApiGetSimilarItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4492

getSimilarMovies

getSimilarMovies(
requestParameters: LibraryApiGetSimilarMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarMoviesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4503

getSimilarShows

getSimilarShows(
requestParameters: LibraryApiGetSimilarShowsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarShowsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4514

getSimilarTrailers

getSimilarTrailers(
requestParameters: LibraryApiGetSimilarTrailersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetSimilarTrailersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4525

getSpecialFeatures

getSpecialFeatures(
requestParameters: LibraryApiGetSpecialFeaturesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[], any, {}>>
Parameters
- requestParameters: LibraryApiGetSpecialFeaturesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4536

getThemeMedia

getThemeMedia(
requestParameters: LibraryApiGetThemeMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AllThemeMediaResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetThemeMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AllThemeMediaResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4547

getThemeSongs

getThemeSongs(
requestParameters: LibraryApiGetThemeSongsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ThemeMediaResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetThemeSongsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4558

getThemeVideos

getThemeVideos(
requestParameters: LibraryApiGetThemeVideosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ThemeMediaResult, any, {}>>
Parameters
- requestParameters: LibraryApiGetThemeVideosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4569

postAddedMovies

postAddedMovies(
requestParameters?: LibraryApiPostAddedMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiPostAddedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4580

postAddedSeries

postAddedSeries(
requestParameters?: LibraryApiPostAddedSeriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiPostAddedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4591

postUpdatedMedia

postUpdatedMedia(
requestParameters: LibraryApiPostUpdatedMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiPostUpdatedMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4602

postUpdatedMovies

postUpdatedMovies(
requestParameters?: LibraryApiPostUpdatedMoviesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiPostUpdatedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4613

postUpdatedSeries

postUpdatedSeries(
requestParameters?: LibraryApiPostUpdatedSeriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiPostUpdatedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4624

refreshItem

refreshItem(
requestParameters: LibraryApiRefreshItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: LibraryApiRefreshItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4635

refreshLibrary

refreshLibrary(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/library-api.ts:4645

Class LibraryApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LibraryApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteItem

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

deleteItems

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

getAncestors

Parameters

Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws

getDownload

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getFile

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getIntros

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

getItem

Parameters

Returns Promise<AxiosResponse<BaseItemDto, any, {}>>

Throws

getItemCollections

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

getItemCounts

Parameters

Returns Promise<AxiosResponse<ItemCounts, any, {}>>

Throws

getItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

getLatestMedia

Parameters

Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws

getLibraryOptionsInfo

Parameters

Returns Promise<AxiosResponse<LibraryOptionsResultDto, any, {}>>

Throws

getLocalTrailers

Parameters

Returns Promise<AxiosResponse<BaseItemDto[], any, {}>>

Throws

getMediaFolders

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

getPhysicalPaths

Parameters

Returns Promise<AxiosResponse<string[], any, {}>>

Throws

getResumeItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

getRootFolder

`Protected`axios

`Protected`basePath

`Protected`configuration