@jellyfin/sdk 0.10.0 → 0.11.0

package/lib/generated-client/api/playlists-api.js

@@ -1,6 +1,6 @@
 import globalAxios from 'axios';
 import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, serializeDataIfNeeded, createRequestFunction } from '../common.js';
-import { BaseAPI, BASE_PATH } from '../base.js';
+import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
 
 /* tslint:disable */
 /* eslint-disable */
@@ -105,6 +105,37 @@ const PlaylistsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Get a playlist.
+         * @param {string} playlistId The playlist id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPlaylist: async (playlistId, options = {}) => {
+            // verify required parameter 'playlistId' is not null or undefined
+            assertParamExists('getPlaylist', 'playlistId', playlistId);
+            const localVarPath = `/Playlists/{playlistId}`
+                .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId)));
+            // 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 the original items of a playlist.
@@ -438,8 +469,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async addItemToPlaylist(playlistId, ids, userId, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.addItemToPlaylist(playlistId, ids, userId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.addItemToPlaylist']) === 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);
         },
         /**
          * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
@@ -453,8 +487,25 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.createPlaylist']) === 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 a playlist.
+         * @param {string} playlistId The playlist id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPlaylist(playlistId, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylist(playlistId, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.getPlaylist']) === 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);
         },
         /**
          *
@@ -472,8 +523,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.getPlaylistItems']) === 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);
         },
         /**
          *
@@ -484,8 +538,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async getPlaylistUser(playlistId, userId, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistUser(playlistId, userId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.getPlaylistUser']) === 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);
         },
         /**
          *
@@ -495,8 +552,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async getPlaylistUsers(playlistId, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistUsers(playlistId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.getPlaylistUsers']) === 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);
         },
         /**
          *
@@ -508,8 +568,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async moveItem(playlistId, itemId, newIndex, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.moveItem(playlistId, itemId, newIndex, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.moveItem']) === 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);
         },
         /**
          *
@@ -520,8 +583,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async removeItemFromPlaylist(playlistId, entryIds, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.removeItemFromPlaylist(playlistId, entryIds, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.removeItemFromPlaylist']) === 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);
         },
         /**
          *
@@ -532,8 +598,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async removeUserFromPlaylist(playlistId, userId, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.removeUserFromPlaylist(playlistId, userId, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.removeUserFromPlaylist']) === 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);
         },
         /**
          *
@@ -544,8 +613,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async updatePlaylist(playlistId, updatePlaylistDto, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaylist(playlistId, updatePlaylistDto, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.updatePlaylist']) === 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);
         },
         /**
          *
@@ -557,8 +629,11 @@ const PlaylistsApiFp = function (configuration) {
          * @throws {RequiredError}
          */
         async updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options) {
+            var _a, _b, _c;
             const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlaylistsApi.updatePlaylistUser']) === 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);
         },
     };
 };
@@ -572,124 +647,112 @@ const PlaylistsApiFactory = function (configuration, basePath, axios) {
         /**
          *
          * @summary Adds items to a playlist.
-         * @param {string} playlistId The playlist id.
-         * @param {Array<string>} [ids] Item id, comma delimited.
-         * @param {string} [userId] The userId.
+         * @param {PlaylistsApiAddItemToPlaylistRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        addItemToPlaylist(playlistId, ids, userId, options) {
-            return localVarFp.addItemToPlaylist(playlistId, ids, userId, options).then((request) => request(axios, basePath));
+        addItemToPlaylist(requestParameters, options) {
+            return localVarFp.addItemToPlaylist(requestParameters.playlistId, requestParameters.ids, requestParameters.userId, options).then((request) => request(axios, basePath));
         },
         /**
          * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
          * @summary Creates a new playlist.
-         * @param {string} [name] The playlist name.
-         * @param {Array<string>} [ids] The item ids.
-         * @param {string} [userId] The user id.
-         * @param {MediaType} [mediaType] The media type.
-         * @param {CreatePlaylistDto} [createPlaylistDto] The create playlist payload.
+         * @param {PlaylistsApiCreatePlaylistRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPlaylist(requestParameters = {}, options) {
+            return localVarFp.createPlaylist(requestParameters.name, requestParameters.ids, requestParameters.userId, requestParameters.mediaType, requestParameters.createPlaylistDto, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Get a playlist.
+         * @param {PlaylistsApiGetPlaylistRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options) {
-            return localVarFp.createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options).then((request) => request(axios, basePath));
+        getPlaylist(requestParameters, options) {
+            return localVarFp.getPlaylist(requestParameters.playlistId, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Gets the original items of a playlist.
-         * @param {string} playlistId The playlist id.
-         * @param {string} [userId] User id.
-         * @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 {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
-         * @param {boolean} [enableImages] Optional. Include image information in output.
-         * @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 {PlaylistsApiGetPlaylistItemsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options) {
-            return localVarFp.getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath));
+        getPlaylistItems(requestParameters, options) {
+            return localVarFp.getPlaylistItems(requestParameters.playlistId, requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Get a playlist user.
-         * @param {string} playlistId The playlist id.
-         * @param {string} userId The user id.
+         * @param {PlaylistsApiGetPlaylistUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPlaylistUser(playlistId, userId, options) {
-            return localVarFp.getPlaylistUser(playlistId, userId, options).then((request) => request(axios, basePath));
+        getPlaylistUser(requestParameters, options) {
+            return localVarFp.getPlaylistUser(requestParameters.playlistId, requestParameters.userId, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Get a playlist\'s users.
-         * @param {string} playlistId The playlist id.
+         * @param {PlaylistsApiGetPlaylistUsersRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPlaylistUsers(playlistId, options) {
-            return localVarFp.getPlaylistUsers(playlistId, options).then((request) => request(axios, basePath));
+        getPlaylistUsers(requestParameters, options) {
+            return localVarFp.getPlaylistUsers(requestParameters.playlistId, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Moves a playlist item.
-         * @param {string} playlistId The playlist id.
-         * @param {string} itemId The item id.
-         * @param {number} newIndex The new index.
+         * @param {PlaylistsApiMoveItemRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        moveItem(playlistId, itemId, newIndex, options) {
-            return localVarFp.moveItem(playlistId, itemId, newIndex, options).then((request) => request(axios, basePath));
+        moveItem(requestParameters, options) {
+            return localVarFp.moveItem(requestParameters.playlistId, requestParameters.itemId, requestParameters.newIndex, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Removes items from a playlist.
-         * @param {string} playlistId The playlist id.
-         * @param {Array<string>} [entryIds] The item ids, comma delimited.
+         * @param {PlaylistsApiRemoveItemFromPlaylistRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        removeItemFromPlaylist(playlistId, entryIds, options) {
-            return localVarFp.removeItemFromPlaylist(playlistId, entryIds, options).then((request) => request(axios, basePath));
+        removeItemFromPlaylist(requestParameters, options) {
+            return localVarFp.removeItemFromPlaylist(requestParameters.playlistId, requestParameters.entryIds, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Remove a user from a playlist\'s users.
-         * @param {string} playlistId The playlist id.
-         * @param {string} userId The user id.
+         * @param {PlaylistsApiRemoveUserFromPlaylistRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        removeUserFromPlaylist(playlistId, userId, options) {
-            return localVarFp.removeUserFromPlaylist(playlistId, userId, options).then((request) => request(axios, basePath));
+        removeUserFromPlaylist(requestParameters, options) {
+            return localVarFp.removeUserFromPlaylist(requestParameters.playlistId, requestParameters.userId, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Updates a playlist.
-         * @param {string} playlistId The playlist id.
-         * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.
+         * @param {PlaylistsApiUpdatePlaylistRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updatePlaylist(playlistId, updatePlaylistDto, options) {
-            return localVarFp.updatePlaylist(playlistId, updatePlaylistDto, options).then((request) => request(axios, basePath));
+        updatePlaylist(requestParameters, options) {
+            return localVarFp.updatePlaylist(requestParameters.playlistId, requestParameters.updatePlaylistDto, options).then((request) => request(axios, basePath));
         },
         /**
          *
          * @summary Modify a user of a playlist\'s users.
-         * @param {string} playlistId The playlist id.
-         * @param {string} userId The user id.
-         * @param {UpdatePlaylistUserDto} updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto.
+         * @param {PlaylistsApiUpdatePlaylistUserRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options) {
-            return localVarFp.updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options).then((request) => request(axios, basePath));
+        updatePlaylistUser(requestParameters, options) {
+            return localVarFp.updatePlaylistUser(requestParameters.playlistId, requestParameters.userId, requestParameters.updatePlaylistUserDto, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -722,6 +785,17 @@ class PlaylistsApi extends BaseAPI {
     createPlaylist(requestParameters = {}, options) {
         return PlaylistsApiFp(this.configuration).createPlaylist(requestParameters.name, requestParameters.ids, requestParameters.userId, requestParameters.mediaType, requestParameters.createPlaylistDto, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Get a playlist.
+     * @param {PlaylistsApiGetPlaylistRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlaylistsApi
+     */
+    getPlaylist(requestParameters, options) {
+        return PlaylistsApiFp(this.configuration).getPlaylist(requestParameters.playlistId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Gets the original items of a playlist.