@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
456 lines (453 loc) • 23.9 kB
JavaScript
import globalAxios from 'axios';
import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, serializeDataIfNeeded, 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/.
*/
/**
* PackageApi - axios parameter creator
* @export
*/
const PackageApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Cancels a package installation.
* @param {string} packageId Installation Id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelPackageInstallation: async (packageId, options = {}) => {
// verify required parameter 'packageId' is not null or undefined
assertParamExists('cancelPackageInstallation', 'packageId', packageId);
const localVarPath = `/Packages/Installing/{packageId}`
.replace(`{${"packageId"}}`, encodeURIComponent(String(packageId)));
// 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);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Gets a package by name or assembly GUID.
* @param {string} name The name of the package.
* @param {string} [assemblyGuid] The GUID of the associated assembly.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackageInfo: async (name, assemblyGuid, options = {}) => {
// verify required parameter 'name' is not null or undefined
assertParamExists('getPackageInfo', 'name', name);
const localVarPath = `/Packages/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// 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 (assemblyGuid !== undefined) {
localVarQueryParameter['assemblyGuid'] = assemblyGuid;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Gets available packages.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackages: async (options = {}) => {
const localVarPath = `/Packages`;
// 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);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Gets all package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRepositories: async (options = {}) => {
const localVarPath = `/Repositories`;
// 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);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Installs a package.
* @param {string} name Package name.
* @param {string} [assemblyGuid] GUID of the associated assembly.
* @param {string} [version] Optional version. Defaults to latest version.
* @param {string} [repositoryUrl] Optional. Specify the repository to install from.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
installPackage: async (name, assemblyGuid, version, repositoryUrl, options = {}) => {
// verify required parameter 'name' is not null or undefined
assertParamExists('installPackage', 'name', name);
const localVarPath = `/Packages/Installed/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// 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 (assemblyGuid !== undefined) {
localVarQueryParameter['assemblyGuid'] = assemblyGuid;
}
if (version !== undefined) {
localVarQueryParameter['version'] = version;
}
if (repositoryUrl !== undefined) {
localVarQueryParameter['repositoryUrl'] = repositoryUrl;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Sets the enabled and existing package repositories.
* @param {Array<RepositoryInfo>} repositoryInfo The list of package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
setRepositories: async (repositoryInfo, options = {}) => {
// verify required parameter 'repositoryInfo' is not null or undefined
assertParamExists('setRepositories', 'repositoryInfo', repositoryInfo);
const localVarPath = `/Repositories`;
// 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);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(repositoryInfo, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* PackageApi - functional programming interface
* @export
*/
const PackageApiFp = function (configuration) {
const localVarAxiosParamCreator = PackageApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Cancels a package installation.
* @param {string} packageId Installation Id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async cancelPackageInstallation(packageId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelPackageInstallation(packageId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.cancelPackageInstallation']) === 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 a package by name or assembly GUID.
* @param {string} name The name of the package.
* @param {string} [assemblyGuid] The GUID of the associated assembly.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPackageInfo(name, assemblyGuid, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageInfo(name, assemblyGuid, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.getPackageInfo']) === 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 available packages.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPackages(options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackages(options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.getPackages']) === 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 all package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getRepositories(options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getRepositories(options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.getRepositories']) === 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 Installs a package.
* @param {string} name Package name.
* @param {string} [assemblyGuid] GUID of the associated assembly.
* @param {string} [version] Optional version. Defaults to latest version.
* @param {string} [repositoryUrl] Optional. Specify the repository to install from.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async installPackage(name, assemblyGuid, version, repositoryUrl, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.installPackage(name, assemblyGuid, version, repositoryUrl, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.installPackage']) === 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 Sets the enabled and existing package repositories.
* @param {Array<RepositoryInfo>} repositoryInfo The list of package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async setRepositories(repositoryInfo, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.setRepositories(repositoryInfo, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PackageApi.setRepositories']) === 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);
},
};
};
/**
* PackageApi - factory interface
* @export
*/
const PackageApiFactory = function (configuration, basePath, axios) {
const localVarFp = PackageApiFp(configuration);
return {
/**
*
* @summary Cancels a package installation.
* @param {PackageApiCancelPackageInstallationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelPackageInstallation(requestParameters, options) {
return localVarFp.cancelPackageInstallation(requestParameters.packageId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets a package by name or assembly GUID.
* @param {PackageApiGetPackageInfoRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackageInfo(requestParameters, options) {
return localVarFp.getPackageInfo(requestParameters.name, requestParameters.assemblyGuid, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets available packages.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackages(options) {
return localVarFp.getPackages(options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets all package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRepositories(options) {
return localVarFp.getRepositories(options).then((request) => request(axios, basePath));
},
/**
*
* @summary Installs a package.
* @param {PackageApiInstallPackageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
installPackage(requestParameters, options) {
return localVarFp.installPackage(requestParameters.name, requestParameters.assemblyGuid, requestParameters.version, requestParameters.repositoryUrl, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Sets the enabled and existing package repositories.
* @param {PackageApiSetRepositoriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
setRepositories(requestParameters, options) {
return localVarFp.setRepositories(requestParameters.repositoryInfo, options).then((request) => request(axios, basePath));
},
};
};
/**
* PackageApi - object-oriented interface
* @export
* @class PackageApi
* @extends {BaseAPI}
*/
class PackageApi extends BaseAPI {
/**
*
* @summary Cancels a package installation.
* @param {PackageApiCancelPackageInstallationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
cancelPackageInstallation(requestParameters, options) {
return PackageApiFp(this.configuration).cancelPackageInstallation(requestParameters.packageId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets a package by name or assembly GUID.
* @param {PackageApiGetPackageInfoRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
getPackageInfo(requestParameters, options) {
return PackageApiFp(this.configuration).getPackageInfo(requestParameters.name, requestParameters.assemblyGuid, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets available packages.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
getPackages(options) {
return PackageApiFp(this.configuration).getPackages(options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Gets all package repositories.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
getRepositories(options) {
return PackageApiFp(this.configuration).getRepositories(options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Installs a package.
* @param {PackageApiInstallPackageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
installPackage(requestParameters, options) {
return PackageApiFp(this.configuration).installPackage(requestParameters.name, requestParameters.assemblyGuid, requestParameters.version, requestParameters.repositoryUrl, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Sets the enabled and existing package repositories.
* @param {PackageApiSetRepositoriesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PackageApi
*/
setRepositories(requestParameters, options) {
return PackageApiFp(this.configuration).setRepositories(requestParameters.repositoryInfo, options).then((request) => request(this.axios, this.basePath));
}
}
export { PackageApi, PackageApiAxiosParamCreator, PackageApiFactory, PackageApiFp };