@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
245 lines (242 loc) • 13.1 kB
JavaScript
import globalAxios from 'axios';
import { 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/.
*/
/**
* FilterApi - axios parameter creator
* @export
*/
const FilterApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Gets query filters.
* @param {string} [userId] Optional. User id.
* @param {string} [parentId] Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {boolean} [isAiring] Optional. Is item airing.
* @param {boolean} [isMovie] Optional. Is item movie.
* @param {boolean} [isSports] Optional. Is item sports.
* @param {boolean} [isKids] Optional. Is item kids.
* @param {boolean} [isNews] Optional. Is item news.
* @param {boolean} [isSeries] Optional. Is item series.
* @param {boolean} [recursive] Optional. Search recursive.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getQueryFilters: async (userId, parentId, includeItemTypes, isAiring, isMovie, isSports, isKids, isNews, isSeries, recursive, options = {}) => {
const localVarPath = `/Items/Filters2`;
// 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 (includeItemTypes) {
localVarQueryParameter['includeItemTypes'] = includeItemTypes;
}
if (isAiring !== undefined) {
localVarQueryParameter['isAiring'] = isAiring;
}
if (isMovie !== undefined) {
localVarQueryParameter['isMovie'] = isMovie;
}
if (isSports !== undefined) {
localVarQueryParameter['isSports'] = isSports;
}
if (isKids !== undefined) {
localVarQueryParameter['isKids'] = isKids;
}
if (isNews !== undefined) {
localVarQueryParameter['isNews'] = isNews;
}
if (isSeries !== undefined) {
localVarQueryParameter['isSeries'] = isSeries;
}
if (recursive !== undefined) {
localVarQueryParameter['recursive'] = recursive;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Gets legacy query filters.
* @param {string} [userId] Optional. User id.
* @param {string} [parentId] Optional. Parent id.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getQueryFiltersLegacy: async (userId, parentId, includeItemTypes, mediaTypes, options = {}) => {
const localVarPath = `/Items/Filters`;
// 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 (includeItemTypes) {
localVarQueryParameter['includeItemTypes'] = includeItemTypes;
}
if (mediaTypes) {
localVarQueryParameter['mediaTypes'] = mediaTypes;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* FilterApi - functional programming interface
* @export
*/
const FilterApiFp = function (configuration) {
const localVarAxiosParamCreator = FilterApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Gets query filters.
* @param {string} [userId] Optional. User id.
* @param {string} [parentId] Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {boolean} [isAiring] Optional. Is item airing.
* @param {boolean} [isMovie] Optional. Is item movie.
* @param {boolean} [isSports] Optional. Is item sports.
* @param {boolean} [isKids] Optional. Is item kids.
* @param {boolean} [isNews] Optional. Is item news.
* @param {boolean} [isSeries] Optional. Is item series.
* @param {boolean} [recursive] Optional. Search recursive.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getQueryFilters(userId, parentId, includeItemTypes, isAiring, isMovie, isSports, isKids, isNews, isSeries, recursive, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getQueryFilters(userId, parentId, includeItemTypes, isAiring, isMovie, isSports, isKids, isNews, isSeries, recursive, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FilterApi.getQueryFilters']) === 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 legacy query filters.
* @param {string} [userId] Optional. User id.
* @param {string} [parentId] Optional. Parent id.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FilterApi.getQueryFiltersLegacy']) === 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);
},
};
};
/**
* FilterApi - factory interface
* @export
*/
const FilterApiFactory = function (configuration, basePath, axios) {
const localVarFp = FilterApiFp(configuration);
return {
/**
*
* @summary Gets query filters.
* @param {FilterApiGetQueryFiltersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getQueryFilters(requestParameters = {}, options) {
return localVarFp.getQueryFilters(requestParameters.userId, requestParameters.parentId, requestParameters.includeItemTypes, requestParameters.isAiring, requestParameters.isMovie, requestParameters.isSports, requestParameters.isKids, requestParameters.isNews, requestParameters.isSeries, requestParameters.recursive, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets legacy query filters.
* @param {FilterApiGetQueryFiltersLegacyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getQueryFiltersLegacy(requestParameters = {}, options) {
return localVarFp.getQueryFiltersLegacy(requestParameters.userId, requestParameters.parentId, requestParameters.includeItemTypes, requestParameters.mediaTypes, options).then((request) => request(axios, basePath));
},
};
};
/**
* FilterApi - object-oriented interface
* @export
* @class FilterApi
* @extends {BaseAPI}
*/
class FilterApi extends BaseAPI {
/**
*
* @summary Gets query filters.
* @param {FilterApiGetQueryFiltersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilterApi
*/
getQueryFilters(requestParameters = {}, options) {
return FilterApiFp(this.configuration).getQueryFilters(requestParameters.userId, requestParameters.parentId, requestParameters.includeItemTypes, requestParameters.isAiring, requestParameters.isMovie, requestParameters.isSports, requestParameters.isKids, requestParameters.isNews, requestParameters.isSeries, requestParameters.recursive, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets legacy query filters.
* @param {FilterApiGetQueryFiltersLegacyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilterApi
*/
getQueryFiltersLegacy(requestParameters = {}, options) {
return FilterApiFp(this.configuration).getQueryFiltersLegacy(requestParameters.userId, requestParameters.parentId, requestParameters.includeItemTypes, requestParameters.mediaTypes, options).then((request) => request(this.axios, this.basePath));
}
}
export { FilterApi, FilterApiAxiosParamCreator, FilterApiFactory, FilterApiFp };