@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
280 lines (277 loc) • 14.4 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/.
*/
/**
* CollectionApi - axios parameter creator
* @export
*/
const CollectionApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Adds items to a collection.
* @param {string} collectionId The collection id.
* @param {Array<string>} ids Item ids, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addToCollection: async (collectionId, ids, options = {}) => {
// verify required parameter 'collectionId' is not null or undefined
assertParamExists('addToCollection', 'collectionId', collectionId);
// verify required parameter 'ids' is not null or undefined
assertParamExists('addToCollection', 'ids', ids);
const localVarPath = `/Collections/{collectionId}/Items`
.replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
// 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 (ids) {
localVarQueryParameter['ids'] = ids;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Creates a new collection.
* @param {string} [name] The name of the collection.
* @param {Array<string>} [ids] Item Ids to add to the collection.
* @param {string} [parentId] Optional. Create the collection within a specific folder.
* @param {boolean} [isLocked] Whether or not to lock the new collection.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollection: async (name, ids, parentId, isLocked, options = {}) => {
const localVarPath = `/Collections`;
// 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 (name !== undefined) {
localVarQueryParameter['name'] = name;
}
if (ids) {
localVarQueryParameter['ids'] = ids;
}
if (parentId !== undefined) {
localVarQueryParameter['parentId'] = parentId;
}
if (isLocked !== undefined) {
localVarQueryParameter['isLocked'] = isLocked;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Removes items from a collection.
* @param {string} collectionId The collection id.
* @param {Array<string>} ids Item ids, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeFromCollection: async (collectionId, ids, options = {}) => {
// verify required parameter 'collectionId' is not null or undefined
assertParamExists('removeFromCollection', 'collectionId', collectionId);
// verify required parameter 'ids' is not null or undefined
assertParamExists('removeFromCollection', 'ids', ids);
const localVarPath = `/Collections/{collectionId}/Items`
.replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
// 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 (ids) {
localVarQueryParameter['ids'] = ids;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* CollectionApi - functional programming interface
* @export
*/
const CollectionApiFp = function (configuration) {
const localVarAxiosParamCreator = CollectionApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Adds items to a collection.
* @param {string} collectionId The collection id.
* @param {Array<string>} ids Item ids, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async addToCollection(collectionId, ids, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.addToCollection(collectionId, ids, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollectionApi.addToCollection']) === 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 Creates a new collection.
* @param {string} [name] The name of the collection.
* @param {Array<string>} [ids] Item Ids to add to the collection.
* @param {string} [parentId] Optional. Create the collection within a specific folder.
* @param {boolean} [isLocked] Whether or not to lock the new collection.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createCollection(name, ids, parentId, isLocked, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.createCollection(name, ids, parentId, isLocked, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollectionApi.createCollection']) === 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 Removes items from a collection.
* @param {string} collectionId The collection id.
* @param {Array<string>} ids Item ids, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async removeFromCollection(collectionId, ids, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.removeFromCollection(collectionId, ids, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollectionApi.removeFromCollection']) === 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);
},
};
};
/**
* CollectionApi - factory interface
* @export
*/
const CollectionApiFactory = function (configuration, basePath, axios) {
const localVarFp = CollectionApiFp(configuration);
return {
/**
*
* @summary Adds items to a collection.
* @param {CollectionApiAddToCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addToCollection(requestParameters, options) {
return localVarFp.addToCollection(requestParameters.collectionId, requestParameters.ids, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Creates a new collection.
* @param {CollectionApiCreateCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollection(requestParameters = {}, options) {
return localVarFp.createCollection(requestParameters.name, requestParameters.ids, requestParameters.parentId, requestParameters.isLocked, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Removes items from a collection.
* @param {CollectionApiRemoveFromCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeFromCollection(requestParameters, options) {
return localVarFp.removeFromCollection(requestParameters.collectionId, requestParameters.ids, options).then((request) => request(axios, basePath));
},
};
};
/**
* CollectionApi - object-oriented interface
* @export
* @class CollectionApi
* @extends {BaseAPI}
*/
class CollectionApi extends BaseAPI {
/**
*
* @summary Adds items to a collection.
* @param {CollectionApiAddToCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionApi
*/
addToCollection(requestParameters, options) {
return CollectionApiFp(this.configuration).addToCollection(requestParameters.collectionId, requestParameters.ids, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Creates a new collection.
* @param {CollectionApiCreateCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionApi
*/
createCollection(requestParameters = {}, options) {
return CollectionApiFp(this.configuration).createCollection(requestParameters.name, requestParameters.ids, requestParameters.parentId, requestParameters.isLocked, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Removes items from a collection.
* @param {CollectionApiRemoveFromCollectionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CollectionApi
*/
removeFromCollection(requestParameters, options) {
return CollectionApiFp(this.configuration).removeFromCollection(requestParameters.collectionId, requestParameters.ids, options).then((request) => request(this.axios, this.basePath));
}
}
export { CollectionApi, CollectionApiAxiosParamCreator, CollectionApiFactory, CollectionApiFp };