@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
1,013 lines • 69.1 kB
TypeScript
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* Do not edit the class manually.
*
* Jellyfin API
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { AllThemeMediaResult } from '../models';
import type { BaseItemDto } from '../models';
import type { BaseItemDtoQueryResult } from '../models';
import type { CollectionType } from '../models';
import type { ItemCounts } from '../models';
import type { ItemFields } from '../models';
import type { ItemSortBy } from '../models';
import type { LibraryOptionsResultDto } from '../models';
import type { MediaUpdateInfoDto } from '../models';
import type { SortOrder } from '../models';
import type { ThemeMediaResult } from '../models';
/**
* LibraryApi - axios parameter creator
* @export
*/
export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Deletes an item from the library and filesystem.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItem: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Deletes items from the library and filesystem.
* @param {Array<string>} [ids] The item ids.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItems: (ids?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets all parents of an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAncestors: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets critic review for an item.
* @param {string} itemId
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
getCriticReviews: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Downloads item media.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDownload: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get the original file of an item.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFile: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get item counts.
* @param {string} [userId] Optional. Get counts from a specific user\'s library.
* @param {boolean} [isFavorite] Optional. Get counts of favorite items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemCounts: (userId?: string, isFavorite?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets the library options info.
* @param {CollectionType} [libraryContentType] Library content type.
* @param {boolean} [isNewLibrary] Whether this is a new library.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLibraryOptionsInfo: (libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets all user media folders.
* @param {boolean} [isHidden] Optional. Filter by folders that are marked hidden, or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMediaFolders: (isHidden?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets a list of physical paths from virtual folders.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPhysicalPaths: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarAlbums: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarArtists: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarItems: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarMovies: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarShows: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarTrailers: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get theme songs and videos for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get theme songs for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get theme videos for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {string} [tmdbId] The tmdbId.
* @param {string} [imdbId] The imdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedMovies: (tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {string} [tvdbId] The tvdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedSeries: (tvdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {MediaUpdateInfoDto} mediaUpdateInfoDto The update paths.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {string} [tmdbId] The tmdbId.
* @param {string} [imdbId] The imdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {string} [tvdbId] The tvdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedSeries: (tvdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Starts a library scan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
refreshLibrary: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* LibraryApi - functional programming interface
* @export
*/
export declare const LibraryApiFp: (configuration?: Configuration) => {
/**
*
* @summary Deletes an item from the library and filesystem.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItem(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Deletes items from the library and filesystem.
* @param {Array<string>} [ids] The item ids.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItems(ids?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Gets all parents of an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAncestors(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>;
/**
*
* @summary Gets critic review for an item.
* @param {string} itemId
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
getCriticReviews(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Downloads item media.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDownload(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
/**
*
* @summary Get the original file of an item.
* @param {string} itemId The item id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFile(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
/**
*
* @summary Get item counts.
* @param {string} [userId] Optional. Get counts from a specific user\'s library.
* @param {boolean} [isFavorite] Optional. Get counts of favorite items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemCounts(userId?: string, isFavorite?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>;
/**
*
* @summary Gets the library options info.
* @param {CollectionType} [libraryContentType] Library content type.
* @param {boolean} [isNewLibrary] Whether this is a new library.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>;
/**
*
* @summary Gets all user media folders.
* @param {boolean} [isHidden] Optional. Filter by folders that are marked hidden, or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMediaFolders(isHidden?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets a list of physical paths from virtual folders.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPhysicalPaths(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarAlbums(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarArtists(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarItems(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarMovies(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarShows(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Gets similar items.
* @param {string} itemId The item id.
* @param {Array<string>} [excludeArtistIds] Exclude artist ids.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<ItemFields>} [fields] 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.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarTrailers(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
/**
*
* @summary Get theme songs and videos for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>>;
/**
*
* @summary Get theme songs for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>;
/**
*
* @summary Get theme videos for an item.
* @param {string} itemId The item id.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {boolean} [inheritFromParent] Optional. Determines whether or not parent items should be searched for theme media.
* @param {Array<ItemSortBy>} [sortBy] 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.
* @param {Array<SortOrder>} [sortOrder] Optional. Sort Order - Ascending, Descending.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {string} [tmdbId] The tmdbId.
* @param {string} [imdbId] The imdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedMovies(tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {string} [tvdbId] The tvdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedSeries(tvdbId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {MediaUpdateInfoDto} mediaUpdateInfoDto The update paths.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {string} [tmdbId] The tmdbId.
* @param {string} [imdbId] The imdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {string} [tvdbId] The tvdbId.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedSeries(tvdbId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Starts a library scan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
refreshLibrary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* LibraryApi - factory interface
* @export
*/
export declare const LibraryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Deletes an item from the library and filesystem.
* @param {LibraryApiDeleteItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItem(requestParameters: LibraryApiDeleteItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Deletes items from the library and filesystem.
* @param {LibraryApiDeleteItemsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteItems(requestParameters?: LibraryApiDeleteItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Gets all parents of an item.
* @param {LibraryApiGetAncestorsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAncestors(requestParameters: LibraryApiGetAncestorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>;
/**
*
* @summary Gets critic review for an item.
* @param {LibraryApiGetCriticReviewsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @deprecated
* @throws {RequiredError}
*/
getCriticReviews(requestParameters: LibraryApiGetCriticReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Downloads item media.
* @param {LibraryApiGetDownloadRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDownload(requestParameters: LibraryApiGetDownloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
/**
*
* @summary Get the original file of an item.
* @param {LibraryApiGetFileRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFile(requestParameters: LibraryApiGetFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
/**
*
* @summary Get item counts.
* @param {LibraryApiGetItemCountsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemCounts(requestParameters?: LibraryApiGetItemCountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemCounts>;
/**
*
* @summary Gets the library options info.
* @param {LibraryApiGetLibraryOptionsInfoRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLibraryOptionsInfo(requestParameters?: LibraryApiGetLibraryOptionsInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<LibraryOptionsResultDto>;
/**
*
* @summary Gets all user media folders.
* @param {LibraryApiGetMediaFoldersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMediaFolders(requestParameters?: LibraryApiGetMediaFoldersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets a list of physical paths from virtual folders.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPhysicalPaths(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarAlbumsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarAlbums(requestParameters: LibraryApiGetSimilarAlbumsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarArtistsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarArtists(requestParameters: LibraryApiGetSimilarArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarItemsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarItems(requestParameters: LibraryApiGetSimilarItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarMoviesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarMovies(requestParameters: LibraryApiGetSimilarMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarShowsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarShows(requestParameters: LibraryApiGetSimilarShowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Gets similar items.
* @param {LibraryApiGetSimilarTrailersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSimilarTrailers(requestParameters: LibraryApiGetSimilarTrailersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
/**
*
* @summary Get theme songs and videos for an item.
* @param {LibraryApiGetThemeMediaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeMedia(requestParameters: LibraryApiGetThemeMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<AllThemeMediaResult>;
/**
*
* @summary Get theme songs for an item.
* @param {LibraryApiGetThemeSongsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeSongs(requestParameters: LibraryApiGetThemeSongsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ThemeMediaResult>;
/**
*
* @summary Get theme videos for an item.
* @param {LibraryApiGetThemeVideosRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getThemeVideos(requestParameters: LibraryApiGetThemeVideosRequest, options?: RawAxiosRequestConfig): AxiosPromise<ThemeMediaResult>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {LibraryApiPostAddedMoviesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedMovies(requestParameters?: LibraryApiPostAddedMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {LibraryApiPostAddedSeriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postAddedSeries(requestParameters?: LibraryApiPostAddedSeriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {LibraryApiPostUpdatedMediaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMedia(requestParameters: LibraryApiPostUpdatedMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Reports that new movies have been added by an external source.
* @param {LibraryApiPostUpdatedMoviesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedMovies(requestParameters?: LibraryApiPostUpdatedMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Reports that new episodes of a series have been added by an external source.
* @param {LibraryApiPostUpdatedSeriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postUpdatedSeries(requestParameters?: LibraryApiPostUpdatedSeriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Starts a library scan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
refreshLibrary(options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
* Request parameters for deleteItem operation in LibraryApi.
* @export
* @interface LibraryApiDeleteItemRequest
*/
export interface LibraryApiDeleteItemRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiDeleteItem
*/
readonly itemId: string;
}
/**
* Request parameters for deleteItems operation in LibraryApi.
* @export
* @interface LibraryApiDeleteItemsRequest
*/
export interface LibraryApiDeleteItemsRequest {
/**
* The item ids.
* @type {Array<string>}
* @memberof LibraryApiDeleteItems
*/
readonly ids?: Array<string>;
}
/**
* Request parameters for getAncestors operation in LibraryApi.
* @export
* @interface LibraryApiGetAncestorsRequest
*/
export interface LibraryApiGetAncestorsRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetAncestors
*/
readonly itemId: string;
/**
* Optional. Filter by user id, and attach user data.
* @type {string}
* @memberof LibraryApiGetAncestors
*/
readonly userId?: string;
}
/**
* Request parameters for getCriticReviews operation in LibraryApi.
* @export
* @interface LibraryApiGetCriticReviewsRequest
*/
export interface LibraryApiGetCriticReviewsRequest {
/**
*
* @type {string}
* @memberof LibraryApiGetCriticReviews
*/
readonly itemId: string;
}
/**
* Request parameters for getDownload operation in LibraryApi.
* @export
* @interface LibraryApiGetDownloadRequest
*/
export interface LibraryApiGetDownloadRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetDownload
*/
readonly itemId: string;
}
/**
* Request parameters for getFile operation in LibraryApi.
* @export
* @interface LibraryApiGetFileRequest
*/
export interface LibraryApiGetFileRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetFile
*/
readonly itemId: string;
}
/**
* Request parameters for getItemCounts operation in LibraryApi.
* @export
* @interface LibraryApiGetItemCountsRequest
*/
export interface LibraryApiGetItemCountsRequest {
/**
* Optional. Get counts from a specific user\'s library.
* @type {string}
* @memberof LibraryApiGetItemCounts
*/
readonly userId?: string;
/**
* Optional. Get counts of favorite items.
* @type {boolean}
* @memberof LibraryApiGetItemCounts
*/
readonly isFavorite?: boolean;
}
/**
* Request parameters for getLibraryOptionsInfo operation in LibraryApi.
* @export
* @interface LibraryApiGetLibraryOptionsInfoRequest
*/
export interface LibraryApiGetLibraryOptionsInfoRequest {
/**
* Library content type.
* @type {CollectionType}
* @memberof LibraryApiGetLibraryOptionsInfo
*/
readonly libraryContentType?: CollectionType;
/**
* Whether this is a new library.
* @type {boolean}
* @memberof LibraryApiGetLibraryOptionsInfo
*/
readonly isNewLibrary?: boolean;
}
/**
* Request parameters for getMediaFolders operation in LibraryApi.
* @export
* @interface LibraryApiGetMediaFoldersRequest
*/
export interface LibraryApiGetMediaFoldersRequest {
/**
* Optional. Filter by folders that are marked hidden, or not.
* @type {boolean}
* @memberof LibraryApiGetMediaFolders
*/
readonly isHidden?: boolean;
}
/**
* Request parameters for getSimilarAlbums operation in LibraryApi.
* @export
* @interface LibraryApiGetSimilarAlbumsRequest
*/
export interface LibraryApiGetSimilarAlbumsRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetSimilarAlbums
*/
readonly itemId: string;
/**
* Exclude artist ids.
* @type {Array<string>}
* @memberof LibraryApiGetSimilarAlbums
*/
readonly excludeArtistIds?: Array<string>;
/**
* Optional. Filter by user id, and attach user data.
* @type {string}
* @memberof LibraryApiGetSimilarAlbums
*/
readonly userId?: string;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof LibraryApiGetSimilarAlbums
*/
readonly limit?: number;
/**
* 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.
* @type {Array<ItemFields>}
* @memberof LibraryApiGetSimilarAlbums
*/
readonly fields?: Array<ItemFields>;
}
/**
* Request parameters for getSimilarArtists operation in LibraryApi.
* @export
* @interface LibraryApiGetSimilarArtistsRequest
*/
export interface LibraryApiGetSimilarArtistsRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetSimilarArtists
*/
readonly itemId: string;
/**
* Exclude artist ids.
* @type {Array<string>}
* @memberof LibraryApiGetSimilarArtists
*/
readonly excludeArtistIds?: Array<string>;
/**
* Optional. Filter by user id, and attach user data.
* @type {string}
* @memberof LibraryApiGetSimilarArtists
*/
readonly userId?: string;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof LibraryApiGetSimilarArtists
*/
readonly limit?: number;
/**
* 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.
* @type {Array<ItemFields>}
* @memberof LibraryApiGetSimilarArtists
*/
readonly fields?: Array<ItemFields>;
}
/**
* Request parameters for getSimilarItems operation in LibraryApi.
* @export
* @interface LibraryApiGetSimilarItemsRequest
*/
export interface LibraryApiGetSimilarItemsRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetSimilarItems
*/
readonly itemId: string;
/**
* Exclude artist ids.
* @type {Array<string>}
* @memberof LibraryApiGetSimilarItems
*/
readonly excludeArtistIds?: Array<string>;
/**
* Optional. Filter by user id, and attach user data.
* @type {string}
* @memberof LibraryApiGetSimilarItems
*/
readonly userId?: string;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof LibraryApiGetSimilarItems
*/
readonly limit?: number;
/**
* 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.
* @type {Array<ItemFields>}
* @memberof LibraryApiGetSimilarItems
*/
readonly fields?: Array<ItemFields>;
}
/**
* Request parameters for getSimilarMovies operation in LibraryApi.
* @export
* @interface LibraryApiGetSimilarMoviesRequest
*/
export interface LibraryApiGetSimilarMoviesRequest {
/**
* The item id.
* @type {string}
* @memberof LibraryApiGetSimilarMovies
*/
readonly itemId: string;
/**
* Exclude artist ids.
* @type {Array<string>}
* @memberof LibraryApiGetSimilarMovies
*/
readonly excludeArtistIds?: Array<string>;
/**
* Optional. Filter by user id, and attach user data.
* @type {string}
* @memberof LibraryApiGetSimilarMovies
*/
readonly userId?: string;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof LibraryApiGetSimilarMovies
*/
readonly limit?: number;
/**
* 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.
* @type {Array<ItemFields>}
* @memberof LibraryApiGetSimilarMovies
*/
readonly fields?: Array<ItemFields>;
}
/**
* Request parameters for getSimilarShows operation in LibraryApi.
* @export
* @interface LibraryApiGetSimilarShowsRequest
*/
export interface LibraryApiGetSimilarShowsRequest {
/**
* The item id.
* @type {string}