@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
260 lines (257 loc) • 15 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/.
*/
/**
* YearsApi - axios parameter creator
* @export
*/
const YearsApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Gets a year.
* @param {number} year The year.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getYear: async (year, userId, options = {}) => {
// verify required parameter 'year' is not null or undefined
assertParamExists('getYear', 'year', year);
const localVarPath = `/Years/{year}`
.replace(`{${"year"}}`, encodeURIComponent(String(year)));
// 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 Get years.
* @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
* @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>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @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 {boolean} [enableUserData] Optional. Include user data.
* @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 {string} [userId] User Id.
* @param {boolean} [recursive] Search recursively.
* @param {boolean} [enableImages] Optional. Include image information in output.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getYears: async (startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options = {}) => {
const localVarPath = `/Years`;
// 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 (startIndex !== undefined) {
localVarQueryParameter['startIndex'] = startIndex;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (sortOrder) {
localVarQueryParameter['sortOrder'] = sortOrder;
}
if (parentId !== undefined) {
localVarQueryParameter['parentId'] = parentId;
}
if (fields) {
localVarQueryParameter['fields'] = fields;
}
if (excludeItemTypes) {
localVarQueryParameter['excludeItemTypes'] = excludeItemTypes;
}
if (includeItemTypes) {
localVarQueryParameter['includeItemTypes'] = includeItemTypes;
}
if (mediaTypes) {
localVarQueryParameter['mediaTypes'] = mediaTypes;
}
if (sortBy) {
localVarQueryParameter['sortBy'] = sortBy;
}
if (enableUserData !== undefined) {
localVarQueryParameter['enableUserData'] = enableUserData;
}
if (imageTypeLimit !== undefined) {
localVarQueryParameter['imageTypeLimit'] = imageTypeLimit;
}
if (enableImageTypes) {
localVarQueryParameter['enableImageTypes'] = enableImageTypes;
}
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
if (recursive !== undefined) {
localVarQueryParameter['recursive'] = recursive;
}
if (enableImages !== undefined) {
localVarQueryParameter['enableImages'] = enableImages;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* YearsApi - functional programming interface
* @export
*/
const YearsApiFp = function (configuration) {
const localVarAxiosParamCreator = YearsApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Gets a year.
* @param {number} year The year.
* @param {string} [userId] Optional. Filter by user id, and attach user data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getYear(year, userId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getYear(year, 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['YearsApi.getYear']) === 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 Get years.
* @param {number} [startIndex] Skips over a given number of items within the results. Use for paging.
* @param {number} [limit] Optional. The maximum number of records to return.
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
* @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>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @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 {boolean} [enableUserData] Optional. Include user data.
* @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 {string} [userId] User Id.
* @param {boolean} [recursive] Search recursively.
* @param {boolean} [enableImages] Optional. Include image information in output.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['YearsApi.getYears']) === 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);
},
};
};
/**
* YearsApi - factory interface
* @export
*/
const YearsApiFactory = function (configuration, basePath, axios) {
const localVarFp = YearsApiFp(configuration);
return {
/**
*
* @summary Gets a year.
* @param {YearsApiGetYearRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getYear(requestParameters, options) {
return localVarFp.getYear(requestParameters.year, requestParameters.userId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get years.
* @param {YearsApiGetYearsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getYears(requestParameters = {}, options) {
return localVarFp.getYears(requestParameters.startIndex, requestParameters.limit, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.mediaTypes, requestParameters.sortBy, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.userId, requestParameters.recursive, requestParameters.enableImages, options).then((request) => request(axios, basePath));
},
};
};
/**
* YearsApi - object-oriented interface
* @export
* @class YearsApi
* @extends {BaseAPI}
*/
class YearsApi extends BaseAPI {
/**
*
* @summary Gets a year.
* @param {YearsApiGetYearRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof YearsApi
*/
getYear(requestParameters, options) {
return YearsApiFp(this.configuration).getYear(requestParameters.year, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get years.
* @param {YearsApiGetYearsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof YearsApi
*/
getYears(requestParameters = {}, options) {
return YearsApiFp(this.configuration).getYears(requestParameters.startIndex, requestParameters.limit, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.mediaTypes, requestParameters.sortBy, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.userId, requestParameters.recursive, requestParameters.enableImages, options).then((request) => request(this.axios, this.basePath));
}
}
export { YearsApi, YearsApiAxiosParamCreator, YearsApiFactory, YearsApiFp };