@jellyfin/sdk 0.0.0-unstable.202212091849

package/lib/generated-client/api/remote-image-api.d.ts

@@ -0,0 +1,243 @@
+/**
+ * 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/.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { ImageProviderInfo } from '../models';
+import { ImageType } from '../models';
+import { RemoteImageResult } from '../models';
+/**
+ * RemoteImageApi - axios parameter creator
+ * @export
+ */
+export declare const RemoteImageApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Downloads a remote image for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} type The image type.
+     * @param {string} [imageUrl] The image url.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets available remote image providers for an item.
+     * @param {string} itemId Item Id.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImageProviders: (itemId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets available remote images for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} [type] The image type.
+     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {string} [providerName] Optional. The image provider to use.
+     * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * RemoteImageApi - functional programming interface
+ * @export
+ */
+export declare const RemoteImageApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Downloads a remote image for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} type The image type.
+     * @param {string} [imageUrl] The image url.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Gets available remote image providers for an item.
+     * @param {string} itemId Item Id.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImageProviders(itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImageProviderInfo>>>;
+    /**
+     *
+     * @summary Gets available remote images for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} [type] The image type.
+     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {string} [providerName] Optional. The image provider to use.
+     * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>;
+};
+/**
+ * RemoteImageApi - factory interface
+ * @export
+ */
+export declare const RemoteImageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Downloads a remote image for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} type The image type.
+     * @param {string} [imageUrl] The image url.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: any): AxiosPromise<void>;
+    /**
+     *
+     * @summary Gets available remote image providers for an item.
+     * @param {string} itemId Item Id.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImageProviders(itemId: string, options?: any): AxiosPromise<Array<ImageProviderInfo>>;
+    /**
+     *
+     * @summary Gets available remote images for an item.
+     * @param {string} itemId Item Id.
+     * @param {ImageType} [type] The image type.
+     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * @param {number} [limit] Optional. The maximum number of records to return.
+     * @param {string} [providerName] Optional. The image provider to use.
+     * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): AxiosPromise<RemoteImageResult>;
+};
+/**
+ * Request parameters for downloadRemoteImage operation in RemoteImageApi.
+ * @export
+ * @interface RemoteImageApiDownloadRemoteImageRequest
+ */
+export interface RemoteImageApiDownloadRemoteImageRequest {
+    /**
+     * Item Id.
+     * @type {string}
+     * @memberof RemoteImageApiDownloadRemoteImage
+     */
+    readonly itemId: string;
+    /**
+     * The image type.
+     * @type {ImageType}
+     * @memberof RemoteImageApiDownloadRemoteImage
+     */
+    readonly type: ImageType;
+    /**
+     * The image url.
+     * @type {string}
+     * @memberof RemoteImageApiDownloadRemoteImage
+     */
+    readonly imageUrl?: string;
+}
+/**
+ * Request parameters for getRemoteImageProviders operation in RemoteImageApi.
+ * @export
+ * @interface RemoteImageApiGetRemoteImageProvidersRequest
+ */
+export interface RemoteImageApiGetRemoteImageProvidersRequest {
+    /**
+     * Item Id.
+     * @type {string}
+     * @memberof RemoteImageApiGetRemoteImageProviders
+     */
+    readonly itemId: string;
+}
+/**
+ * Request parameters for getRemoteImages operation in RemoteImageApi.
+ * @export
+ * @interface RemoteImageApiGetRemoteImagesRequest
+ */
+export interface RemoteImageApiGetRemoteImagesRequest {
+    /**
+     * Item Id.
+     * @type {string}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly itemId: string;
+    /**
+     * The image type.
+     * @type {ImageType}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly type?: ImageType;
+    /**
+     * Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * @type {number}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly startIndex?: number;
+    /**
+     * Optional. The maximum number of records to return.
+     * @type {number}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly limit?: number;
+    /**
+     * Optional. The image provider to use.
+     * @type {string}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly providerName?: string;
+    /**
+     * Optional. Include all languages.
+     * @type {boolean}
+     * @memberof RemoteImageApiGetRemoteImages
+     */
+    readonly includeAllLanguages?: boolean;
+}
+/**
+ * RemoteImageApi - object-oriented interface
+ * @export
+ * @class RemoteImageApi
+ * @extends {BaseAPI}
+ */
+export declare class RemoteImageApi extends BaseAPI {
+    /**
+     *
+     * @summary Downloads a remote image for an item.
+     * @param {RemoteImageApiDownloadRemoteImageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    downloadRemoteImage(requestParameters: RemoteImageApiDownloadRemoteImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Gets available remote image providers for an item.
+     * @param {RemoteImageApiGetRemoteImageProvidersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    getRemoteImageProviders(requestParameters: RemoteImageApiGetRemoteImageProvidersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageProviderInfo[], any>>;
+    /**
+     *
+     * @summary Gets available remote images for an item.
+     * @param {RemoteImageApiGetRemoteImagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    getRemoteImages(requestParameters: RemoteImageApiGetRemoteImagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoteImageResult, any>>;
+}

package/lib/generated-client/api/remote-image-api.js

@@ -0,0 +1,300 @@
+/* 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/.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * RemoteImageApi - axios parameter creator
+ * @export
+ */
+export const RemoteImageApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Downloads a remote image for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} type The image type.
+         * @param {string} [imageUrl] The image url.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadRemoteImage: (itemId, type, imageUrl, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('downloadRemoteImage', 'itemId', itemId);
+            // verify required parameter 'type' is not null or undefined
+            assertParamExists('downloadRemoteImage', 'type', type);
+            const localVarPath = `/Items/{itemId}/RemoteImages/Download`
+                .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 = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication CustomAuthentication required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (imageUrl !== undefined) {
+                localVarQueryParameter['imageUrl'] = imageUrl;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Gets available remote image providers for an item.
+         * @param {string} itemId Item Id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImageProviders: (itemId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getRemoteImageProviders', 'itemId', itemId);
+            const localVarPath = `/Items/{itemId}/RemoteImages/Providers`
+                .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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication CustomAuthentication required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Gets available remote images for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} [type] The image type.
+         * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {string} [providerName] Optional. The image provider to use.
+         * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImages: (itemId, type, startIndex, limit, providerName, includeAllLanguages, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getRemoteImages', 'itemId', itemId);
+            const localVarPath = `/Items/{itemId}/RemoteImages`
+                .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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication CustomAuthentication required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (startIndex !== undefined) {
+                localVarQueryParameter['startIndex'] = startIndex;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (providerName !== undefined) {
+                localVarQueryParameter['providerName'] = providerName;
+            }
+            if (includeAllLanguages !== undefined) {
+                localVarQueryParameter['includeAllLanguages'] = includeAllLanguages;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * RemoteImageApi - functional programming interface
+ * @export
+ */
+export const RemoteImageApiFp = function (configuration) {
+    const localVarAxiosParamCreator = RemoteImageApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *
+         * @summary Downloads a remote image for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} type The image type.
+         * @param {string} [imageUrl] The image url.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadRemoteImage(itemId, type, imageUrl, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadRemoteImage(itemId, type, imageUrl, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Gets available remote image providers for an item.
+         * @param {string} itemId Item Id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImageProviders(itemId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemoteImageProviders(itemId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Gets available remote images for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} [type] The image type.
+         * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {string} [providerName] Optional. The image provider to use.
+         * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * RemoteImageApi - factory interface
+ * @export
+ */
+export const RemoteImageApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = RemoteImageApiFp(configuration);
+    return {
+        /**
+         *
+         * @summary Downloads a remote image for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} type The image type.
+         * @param {string} [imageUrl] The image url.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadRemoteImage(itemId, type, imageUrl, options) {
+            return localVarFp.downloadRemoteImage(itemId, type, imageUrl, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Gets available remote image providers for an item.
+         * @param {string} itemId Item Id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImageProviders(itemId, options) {
+            return localVarFp.getRemoteImageProviders(itemId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Gets available remote images for an item.
+         * @param {string} itemId Item Id.
+         * @param {ImageType} [type] The image type.
+         * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
+         * @param {number} [limit] Optional. The maximum number of records to return.
+         * @param {string} [providerName] Optional. The image provider to use.
+         * @param {boolean} [includeAllLanguages] Optional. Include all languages.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages, options) {
+            return localVarFp.getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * RemoteImageApi - object-oriented interface
+ * @export
+ * @class RemoteImageApi
+ * @extends {BaseAPI}
+ */
+export class RemoteImageApi extends BaseAPI {
+    /**
+     *
+     * @summary Downloads a remote image for an item.
+     * @param {RemoteImageApiDownloadRemoteImageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    downloadRemoteImage(requestParameters, options) {
+        return RemoteImageApiFp(this.configuration).downloadRemoteImage(requestParameters.itemId, requestParameters.type, requestParameters.imageUrl, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Gets available remote image providers for an item.
+     * @param {RemoteImageApiGetRemoteImageProvidersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    getRemoteImageProviders(requestParameters, options) {
+        return RemoteImageApiFp(this.configuration).getRemoteImageProviders(requestParameters.itemId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Gets available remote images for an item.
+     * @param {RemoteImageApiGetRemoteImagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RemoteImageApi
+     */
+    getRemoteImages(requestParameters, options) {
+        return RemoteImageApiFp(this.configuration).getRemoteImages(requestParameters.itemId, requestParameters.type, requestParameters.startIndex, requestParameters.limit, requestParameters.providerName, requestParameters.includeAllLanguages, options).then((request) => request(this.axios, this.basePath));
+    }
+}