@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
808 lines (805 loc) • 44.9 kB
JavaScript
import globalAxios from 'axios';
import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
/* tslint:disable */
/* eslint-disable */
/**
* 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/.
*/
/**
* UserLibraryApi - axios parameter creator
* @export
*/
const UserLibraryApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('deleteUserItemRating', 'itemId', itemId);
const localVarPath = `/UserItems/{itemId}/Rating`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('getIntros', 'itemId', itemId);
const localVarPath = `/Items/{itemId}/Intros`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('getItem', 'itemId', itemId);
const localVarPath = `/Items/{itemId}`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, options = {}) => {
const localVarPath = `/Items/Latest`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
if (parentId !== undefined) {
localVarQueryParameter['parentId'] = parentId;
}
if (fields) {
localVarQueryParameter['fields'] = fields;
}
if (includeItemTypes) {
localVarQueryParameter['includeItemTypes'] = includeItemTypes;
}
if (isPlayed !== undefined) {
localVarQueryParameter['isPlayed'] = isPlayed;
}
if (enableImages !== undefined) {
localVarQueryParameter['enableImages'] = enableImages;
}
if (imageTypeLimit !== undefined) {
localVarQueryParameter['imageTypeLimit'] = imageTypeLimit;
}
if (enableImageTypes) {
localVarQueryParameter['enableImageTypes'] = enableImageTypes;
}
if (enableUserData !== undefined) {
localVarQueryParameter['enableUserData'] = enableUserData;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (groupItems !== undefined) {
localVarQueryParameter['groupItems'] = groupItems;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('getLocalTrailers', 'itemId', itemId);
const localVarPath = `/Items/{itemId}/LocalTrailers`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Gets the root folder from a user\'s library.
* @param {string} [userId] User id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRootFolder: async (userId, options = {}) => {
const localVarPath = `/Items/Root`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('getSpecialFeatures', 'itemId', itemId);
const localVarPath = `/Items/{itemId}/SpecialFeatures`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('markFavoriteItem', 'itemId', itemId);
const localVarPath = `/UserFavoriteItems/{itemId}`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('unmarkFavoriteItem', 'itemId', itemId);
const localVarPath = `/UserFavoriteItems/{itemId}`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @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: async (itemId, userId, likes, options = {}) => {
// verify required parameter 'itemId' is not null or undefined
assertParamExists('updateUserItemRating', 'itemId', itemId);
const localVarPath = `/UserItems/{itemId}/Rating`
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
if (likes !== undefined) {
localVarQueryParameter['likes'] = likes;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* UserLibraryApi - functional programming interface
* @export
*/
const UserLibraryApiFp = function (configuration) {
const localVarAxiosParamCreator = UserLibraryApiAxiosParamCreator(configuration);
return {
/**
*
* @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}
*/
async deleteUserItemRating(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserItemRating(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.deleteUserItemRating']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async getIntros(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getIntros(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getIntros']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async getItem(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getItem(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getLatestMedia']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async getLocalTrailers(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getLocalTrailers(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getLocalTrailers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Gets the root folder from a user\'s library.
* @param {string} [userId] User id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getRootFolder(userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getRootFolder(userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getRootFolder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async getSpecialFeatures(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecialFeatures(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.getSpecialFeatures']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async markFavoriteItem(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.markFavoriteItem(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.markFavoriteItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Unmarks item as a favorite.
* @param {string} itemId Item id.
* @param {string} [userId] User id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async unmarkFavoriteItem(itemId, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.unmarkFavoriteItem(itemId, userId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.unmarkFavoriteItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @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}
*/
async updateUserItemRating(itemId, userId, likes, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserItemRating(itemId, userId, likes, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UserLibraryApi.updateUserItemRating']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* UserLibraryApi - factory interface
* @export
*/
const UserLibraryApiFactory = function (configuration, basePath, axios) {
const localVarFp = UserLibraryApiFp(configuration);
return {
/**
*
* @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, options) {
return localVarFp.deleteUserItemRating(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @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, options) {
return localVarFp.getIntros(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets an item from a user\'s library.
* @param {UserLibraryApiGetItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItem(requestParameters, options) {
return localVarFp.getItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets latest media.
* @param {UserLibraryApiGetLatestMediaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLatestMedia(requestParameters = {}, options) {
return localVarFp.getLatestMedia(requestParameters.userId, requestParameters.parentId, requestParameters.fields, requestParameters.includeItemTypes, requestParameters.isPlayed, requestParameters.enableImages, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.enableUserData, requestParameters.limit, requestParameters.groupItems, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets local trailers for an item.
* @param {UserLibraryApiGetLocalTrailersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLocalTrailers(requestParameters, options) {
return localVarFp.getLocalTrailers(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @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 = {}, options) {
return localVarFp.getRootFolder(requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets special features for an item.
* @param {UserLibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSpecialFeatures(requestParameters, options) {
return localVarFp.getSpecialFeatures(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Marks an item as a favorite.
* @param {UserLibraryApiMarkFavoriteItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
markFavoriteItem(requestParameters, options) {
return localVarFp.markFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Unmarks item as a favorite.
* @param {UserLibraryApiUnmarkFavoriteItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unmarkFavoriteItem(requestParameters, options) {
return localVarFp.unmarkFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Updates a user\'s rating for an item.
* @param {UserLibraryApiUpdateUserItemRatingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateUserItemRating(requestParameters, options) {
return localVarFp.updateUserItemRating(requestParameters.itemId, requestParameters.userId, requestParameters.likes, options).then((request) => request(axios, basePath));
},
};
};
/**
* UserLibraryApi - object-oriented interface
* @export
* @class UserLibraryApi
* @extends {BaseAPI}
*/
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, options) {
return UserLibraryApiFp(this.configuration).deleteUserItemRating(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @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, options) {
return UserLibraryApiFp(this.configuration).getIntros(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @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, options) {
return UserLibraryApiFp(this.configuration).getItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets latest media.
* @param {UserLibraryApiGetLatestMediaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserLibraryApi
*/
getLatestMedia(requestParameters = {}, options) {
return UserLibraryApiFp(this.configuration).getLatestMedia(requestParameters.userId, requestParameters.parentId, requestParameters.fields, requestParameters.includeItemTypes, requestParameters.isPlayed, requestParameters.enableImages, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.enableUserData, requestParameters.limit, requestParameters.groupItems, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets local trailers for an item.
* @param {UserLibraryApiGetLocalTrailersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserLibraryApi
*/
getLocalTrailers(requestParameters, options) {
return UserLibraryApiFp(this.configuration).getLocalTrailers(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @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 = {}, options) {
return UserLibraryApiFp(this.configuration).getRootFolder(requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets special features for an item.
* @param {UserLibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserLibraryApi
*/
getSpecialFeatures(requestParameters, options) {
return UserLibraryApiFp(this.configuration).getSpecialFeatures(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Marks an item as a favorite.
* @param {UserLibraryApiMarkFavoriteItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserLibraryApi
*/
markFavoriteItem(requestParameters, options) {
return UserLibraryApiFp(this.configuration).markFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Unmarks item as a favorite.
* @param {UserLibraryApiUnmarkFavoriteItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserLibraryApi
*/
unmarkFavoriteItem(requestParameters, options) {
return UserLibraryApiFp(this.configuration).unmarkFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @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, options) {
return UserLibraryApiFp(this.configuration).updateUserItemRating(requestParameters.itemId, requestParameters.userId, requestParameters.likes, options).then((request) => request(this.axios, this.basePath));
}
}
export { UserLibraryApi, UserLibraryApiAxiosParamCreator, UserLibraryApiFactory, UserLibraryApiFp };