UNPKG

@jellyfin/sdk

Version:
658 lines (657 loc) • 27.1 kB
/** * 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 { BaseItemDto } from '../models'; import type { BaseItemDtoQueryResult } from '../models'; import type { BaseItemKind } from '../models'; import type { ImageType } from '../models'; import type { ItemFields } from '../models'; import type { UserItemDataDto } from '../models'; /** * UserLibraryApi - axios parameter creator * @export */ export declare const UserLibraryApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Deletes a user\'s saved personal rating for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserItemRating: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets intros to play before the main media item plays. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntros: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets an item from a user\'s library. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItem: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets latest media. * @param {string} [userId] User id. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {boolean} [isPlayed] Filter by items that are played, or not. * @param {boolean} [enableImages] Optional. include image information in output. * @param {number} [imageTypeLimit] Optional. the max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. include user data. * @param {number} [limit] Return item limit. * @param {boolean} [groupItems] Whether or not to group items into a parent container. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestMedia: (userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets local trailers for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLocalTrailers: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets the root folder from a user\'s library. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootFolder: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets special features for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpecialFeatures: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Marks an item as a favorite. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ markFavoriteItem: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Unmarks item as a favorite. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unmarkFavoriteItem: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Updates a user\'s rating for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserItemRating: (itemId: string, userId?: string, likes?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * UserLibraryApi - functional programming interface * @export */ export declare const UserLibraryApiFp: (configuration?: Configuration) => { /** * * @summary Deletes a user\'s saved personal rating for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserItemRating(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>; /** * * @summary Gets intros to play before the main media item plays. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntros(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>; /** * * @summary Gets an item from a user\'s library. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItem(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>; /** * * @summary Gets latest media. * @param {string} [userId] User id. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {boolean} [isPlayed] Filter by items that are played, or not. * @param {boolean} [enableImages] Optional. include image information in output. * @param {number} [imageTypeLimit] Optional. the max number of images to return, per image type. * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. include user data. * @param {number} [limit] Return item limit. * @param {boolean} [groupItems] Whether or not to group items into a parent container. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestMedia(userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>; /** * * @summary Gets local trailers for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLocalTrailers(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>; /** * * @summary Gets the root folder from a user\'s library. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootFolder(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>; /** * * @summary Gets special features for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpecialFeatures(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>; /** * * @summary Marks an item as a favorite. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ markFavoriteItem(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>; /** * * @summary Unmarks item as a favorite. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unmarkFavoriteItem(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>; /** * * @summary Updates a user\'s rating for an item. * @param {string} itemId Item id. * @param {string} [userId] User id. * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserItemRating(itemId: string, userId?: string, likes?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>; }; /** * UserLibraryApi - factory interface * @export */ export declare const UserLibraryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Deletes a user\'s saved personal rating for an item. * @param {UserLibraryApiDeleteUserItemRatingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserItemRating(requestParameters: UserLibraryApiDeleteUserItemRatingRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>; /** * * @summary Gets intros to play before the main media item plays. * @param {UserLibraryApiGetIntrosRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntros(requestParameters: UserLibraryApiGetIntrosRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>; /** * * @summary Gets an item from a user\'s library. * @param {UserLibraryApiGetItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItem(requestParameters: UserLibraryApiGetItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>; /** * * @summary Gets latest media. * @param {UserLibraryApiGetLatestMediaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLatestMedia(requestParameters?: UserLibraryApiGetLatestMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>; /** * * @summary Gets local trailers for an item. * @param {UserLibraryApiGetLocalTrailersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLocalTrailers(requestParameters: UserLibraryApiGetLocalTrailersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>; /** * * @summary Gets the root folder from a user\'s library. * @param {UserLibraryApiGetRootFolderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootFolder(requestParameters?: UserLibraryApiGetRootFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>; /** * * @summary Gets special features for an item. * @param {UserLibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpecialFeatures(requestParameters: UserLibraryApiGetSpecialFeaturesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>; /** * * @summary Marks an item as a favorite. * @param {UserLibraryApiMarkFavoriteItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ markFavoriteItem(requestParameters: UserLibraryApiMarkFavoriteItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>; /** * * @summary Unmarks item as a favorite. * @param {UserLibraryApiUnmarkFavoriteItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unmarkFavoriteItem(requestParameters: UserLibraryApiUnmarkFavoriteItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>; /** * * @summary Updates a user\'s rating for an item. * @param {UserLibraryApiUpdateUserItemRatingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserItemRating(requestParameters: UserLibraryApiUpdateUserItemRatingRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>; }; /** * Request parameters for deleteUserItemRating operation in UserLibraryApi. * @export * @interface UserLibraryApiDeleteUserItemRatingRequest */ export interface UserLibraryApiDeleteUserItemRatingRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiDeleteUserItemRating */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiDeleteUserItemRating */ readonly userId?: string; } /** * Request parameters for getIntros operation in UserLibraryApi. * @export * @interface UserLibraryApiGetIntrosRequest */ export interface UserLibraryApiGetIntrosRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiGetIntros */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiGetIntros */ readonly userId?: string; } /** * Request parameters for getItem operation in UserLibraryApi. * @export * @interface UserLibraryApiGetItemRequest */ export interface UserLibraryApiGetItemRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiGetItem */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiGetItem */ readonly userId?: string; } /** * Request parameters for getLatestMedia operation in UserLibraryApi. * @export * @interface UserLibraryApiGetLatestMediaRequest */ export interface UserLibraryApiGetLatestMediaRequest { /** * User id. * @type {string} * @memberof UserLibraryApiGetLatestMedia */ readonly userId?: string; /** * Specify this to localize the search to a specific item or folder. Omit to use the root. * @type {string} * @memberof UserLibraryApiGetLatestMedia */ readonly parentId?: string; /** * Optional. Specify additional fields of information to return in the output. * @type {Array<ItemFields>} * @memberof UserLibraryApiGetLatestMedia */ readonly fields?: Array<ItemFields>; /** * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @type {Array<BaseItemKind>} * @memberof UserLibraryApiGetLatestMedia */ readonly includeItemTypes?: Array<BaseItemKind>; /** * Filter by items that are played, or not. * @type {boolean} * @memberof UserLibraryApiGetLatestMedia */ readonly isPlayed?: boolean; /** * Optional. include image information in output. * @type {boolean} * @memberof UserLibraryApiGetLatestMedia */ readonly enableImages?: boolean; /** * Optional. the max number of images to return, per image type. * @type {number} * @memberof UserLibraryApiGetLatestMedia */ readonly imageTypeLimit?: number; /** * Optional. The image types to include in the output. * @type {Array<ImageType>} * @memberof UserLibraryApiGetLatestMedia */ readonly enableImageTypes?: Array<ImageType>; /** * Optional. include user data. * @type {boolean} * @memberof UserLibraryApiGetLatestMedia */ readonly enableUserData?: boolean; /** * Return item limit. * @type {number} * @memberof UserLibraryApiGetLatestMedia */ readonly limit?: number; /** * Whether or not to group items into a parent container. * @type {boolean} * @memberof UserLibraryApiGetLatestMedia */ readonly groupItems?: boolean; } /** * Request parameters for getLocalTrailers operation in UserLibraryApi. * @export * @interface UserLibraryApiGetLocalTrailersRequest */ export interface UserLibraryApiGetLocalTrailersRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiGetLocalTrailers */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiGetLocalTrailers */ readonly userId?: string; } /** * Request parameters for getRootFolder operation in UserLibraryApi. * @export * @interface UserLibraryApiGetRootFolderRequest */ export interface UserLibraryApiGetRootFolderRequest { /** * User id. * @type {string} * @memberof UserLibraryApiGetRootFolder */ readonly userId?: string; } /** * Request parameters for getSpecialFeatures operation in UserLibraryApi. * @export * @interface UserLibraryApiGetSpecialFeaturesRequest */ export interface UserLibraryApiGetSpecialFeaturesRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiGetSpecialFeatures */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiGetSpecialFeatures */ readonly userId?: string; } /** * Request parameters for markFavoriteItem operation in UserLibraryApi. * @export * @interface UserLibraryApiMarkFavoriteItemRequest */ export interface UserLibraryApiMarkFavoriteItemRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiMarkFavoriteItem */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiMarkFavoriteItem */ readonly userId?: string; } /** * Request parameters for unmarkFavoriteItem operation in UserLibraryApi. * @export * @interface UserLibraryApiUnmarkFavoriteItemRequest */ export interface UserLibraryApiUnmarkFavoriteItemRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiUnmarkFavoriteItem */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiUnmarkFavoriteItem */ readonly userId?: string; } /** * Request parameters for updateUserItemRating operation in UserLibraryApi. * @export * @interface UserLibraryApiUpdateUserItemRatingRequest */ export interface UserLibraryApiUpdateUserItemRatingRequest { /** * Item id. * @type {string} * @memberof UserLibraryApiUpdateUserItemRating */ readonly itemId: string; /** * User id. * @type {string} * @memberof UserLibraryApiUpdateUserItemRating */ readonly userId?: string; /** * Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @type {boolean} * @memberof UserLibraryApiUpdateUserItemRating */ readonly likes?: boolean; } /** * UserLibraryApi - object-oriented interface * @export * @class UserLibraryApi * @extends {BaseAPI} */ export declare class UserLibraryApi extends BaseAPI { /** * * @summary Deletes a user\'s saved personal rating for an item. * @param {UserLibraryApiDeleteUserItemRatingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ deleteUserItemRating(requestParameters: UserLibraryApiDeleteUserItemRatingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>; /** * * @summary Gets intros to play before the main media item plays. * @param {UserLibraryApiGetIntrosRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getIntros(requestParameters: UserLibraryApiGetIntrosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>; /** * * @summary Gets an item from a user\'s library. * @param {UserLibraryApiGetItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getItem(requestParameters: UserLibraryApiGetItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>; /** * * @summary Gets latest media. * @param {UserLibraryApiGetLatestMediaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getLatestMedia(requestParameters?: UserLibraryApiGetLatestMediaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any>>; /** * * @summary Gets local trailers for an item. * @param {UserLibraryApiGetLocalTrailersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getLocalTrailers(requestParameters: UserLibraryApiGetLocalTrailersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any>>; /** * * @summary Gets the root folder from a user\'s library. * @param {UserLibraryApiGetRootFolderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getRootFolder(requestParameters?: UserLibraryApiGetRootFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>; /** * * @summary Gets special features for an item. * @param {UserLibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ getSpecialFeatures(requestParameters: UserLibraryApiGetSpecialFeaturesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any>>; /** * * @summary Marks an item as a favorite. * @param {UserLibraryApiMarkFavoriteItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ markFavoriteItem(requestParameters: UserLibraryApiMarkFavoriteItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>; /** * * @summary Unmarks item as a favorite. * @param {UserLibraryApiUnmarkFavoriteItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ unmarkFavoriteItem(requestParameters: UserLibraryApiUnmarkFavoriteItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>; /** * * @summary Updates a user\'s rating for an item. * @param {UserLibraryApiUpdateUserItemRatingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserLibraryApi */ updateUserItemRating(requestParameters: UserLibraryApiUpdateUserItemRatingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>; }