@jellyfin/sdk/lib/generated-client/api/playlists-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * 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 type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { BaseItemDtoQueryResult } from '../models';
import type { CreatePlaylistDto } from '../models';
import type { ImageType } from '../models';
import type { ItemFields } from '../models';
import type { MediaType } from '../models';
import type { PlaylistCreationResult } from '../models';
import type { PlaylistDto } from '../models';
import type { PlaylistUserPermissions } from '../models';
import type { UpdatePlaylistDto } from '../models';
import type { UpdatePlaylistUserDto } from '../models';
/**
 * PlaylistsApi - axios parameter creator
 * @export
 */
export declare const PlaylistsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addItemToPlaylist: (playlistId: string, ids?: Array<string>, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * 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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPlaylist: (name?: string, ids?: Array<string>, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get a playlist.
     * @param {string} playlistId The playlist id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylist: (playlistId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistItems: (playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get a playlist user.
     * @param {string} playlistId The playlist id.
     * @param {string} userId The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUser: (playlistId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get a playlist\'s users.
     * @param {string} playlistId The playlist id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUsers: (playlistId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Moves a playlist item.
     * @param {string} playlistId The playlist id.
     * @param {string} itemId The item id.
     * @param {number} newIndex The new index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    moveItem: (playlistId: string, itemId: string, newIndex: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Removes items from a playlist.
     * @param {string} playlistId The playlist id.
     * @param {Array<string>} [entryIds] The item ids, comma delimited.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeItemFromPlaylist: (playlistId: string, entryIds?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Remove a user from a playlist\'s users.
     * @param {string} playlistId The playlist id.
     * @param {string} userId The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeUserFromPlaylist: (playlistId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates a playlist.
     * @param {string} playlistId The playlist id.
     * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylist: (playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylistUser: (playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * PlaylistsApi - functional programming interface
 * @export
 */
export declare const PlaylistsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addItemToPlaylist(playlistId: string, ids?: Array<string>, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPlaylist(name?: string, ids?: Array<string>, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>>;
    /**
     *
     * @summary Get a playlist.
     * @param {string} playlistId The playlist id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylist(playlistId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistDto>>;
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistItems(playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
    /**
     *
     * @summary Get a playlist user.
     * @param {string} playlistId The playlist id.
     * @param {string} userId The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUser(playlistId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistUserPermissions>>;
    /**
     *
     * @summary Get a playlist\'s users.
     * @param {string} playlistId The playlist id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUsers(playlistId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PlaylistUserPermissions>>>;
    /**
     *
     * @summary Moves a playlist item.
     * @param {string} playlistId The playlist id.
     * @param {string} itemId The item id.
     * @param {number} newIndex The new index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    moveItem(playlistId: string, itemId: string, newIndex: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Removes items from a playlist.
     * @param {string} playlistId The playlist id.
     * @param {Array<string>} [entryIds] The item ids, comma delimited.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeItemFromPlaylist(playlistId: string, entryIds?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Remove a user from a playlist\'s users.
     * @param {string} playlistId The playlist id.
     * @param {string} userId The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeUserFromPlaylist(playlistId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Updates a playlist.
     * @param {string} playlistId The playlist id.
     * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylist(playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylistUser(playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * PlaylistsApi - factory interface
 * @export
 */
export declare const PlaylistsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Adds items to a playlist.
     * @param {PlaylistsApiAddItemToPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addItemToPlaylist(requestParameters: PlaylistsApiAddItemToPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * 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 {PlaylistsApiCreatePlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPlaylist(requestParameters?: PlaylistsApiCreatePlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistCreationResult>;
    /**
     *
     * @summary Get a playlist.
     * @param {PlaylistsApiGetPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylist(requestParameters: PlaylistsApiGetPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistDto>;
    /**
     *
     * @summary Gets the original items of a playlist.
     * @param {PlaylistsApiGetPlaylistItemsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistItems(requestParameters: PlaylistsApiGetPlaylistItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    /**
     *
     * @summary Get a playlist user.
     * @param {PlaylistsApiGetPlaylistUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUser(requestParameters: PlaylistsApiGetPlaylistUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistUserPermissions>;
    /**
     *
     * @summary Get a playlist\'s users.
     * @param {PlaylistsApiGetPlaylistUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPlaylistUsers(requestParameters: PlaylistsApiGetPlaylistUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<PlaylistUserPermissions>>;
    /**
     *
     * @summary Moves a playlist item.
     * @param {PlaylistsApiMoveItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    moveItem(requestParameters: PlaylistsApiMoveItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Removes items from a playlist.
     * @param {PlaylistsApiRemoveItemFromPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeItemFromPlaylist(requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Remove a user from a playlist\'s users.
     * @param {PlaylistsApiRemoveUserFromPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeUserFromPlaylist(requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Updates a playlist.
     * @param {PlaylistsApiUpdatePlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylist(requestParameters: PlaylistsApiUpdatePlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Modify a user of a playlist\'s users.
     * @param {PlaylistsApiUpdatePlaylistUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePlaylistUser(requestParameters: PlaylistsApiUpdatePlaylistUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for addItemToPlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiAddItemToPlaylistRequest
 */
export interface PlaylistsApiAddItemToPlaylistRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiAddItemToPlaylist
     */
    readonly playlistId: string;
    /**
     * Item id, comma delimited.
     * @type {Array<string>}
     * @memberof PlaylistsApiAddItemToPlaylist
     */
    readonly ids?: Array<string>;
    /**
     * The userId.
     * @type {string}
     * @memberof PlaylistsApiAddItemToPlaylist
     */
    readonly userId?: string;
}
/**
 * Request parameters for createPlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiCreatePlaylistRequest
 */
export interface PlaylistsApiCreatePlaylistRequest {
    /**
     * The playlist name.
     * @type {string}
     * @memberof PlaylistsApiCreatePlaylist
     */
    readonly name?: string;
    /**
     * The item ids.
     * @type {Array<string>}
     * @memberof PlaylistsApiCreatePlaylist
     */
    readonly ids?: Array<string>;
    /**
     * The user id.
     * @type {string}
     * @memberof PlaylistsApiCreatePlaylist
     */
    readonly userId?: string;
    /**
     * The media type.
     * @type {MediaType}
     * @memberof PlaylistsApiCreatePlaylist
     */
    readonly mediaType?: MediaType;
    /**
     * The create playlist payload.
     * @type {CreatePlaylistDto}
     * @memberof PlaylistsApiCreatePlaylist
     */
    readonly createPlaylistDto?: CreatePlaylistDto;
}
/**
 * Request parameters for getPlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiGetPlaylistRequest
 */
export interface PlaylistsApiGetPlaylistRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylist
     */
    readonly playlistId: string;
}
/**
 * Request parameters for getPlaylistItems operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiGetPlaylistItemsRequest
 */
export interface PlaylistsApiGetPlaylistItemsRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly playlistId: string;
    /**
     * User id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly userId?: string;
    /**
     * Optional. The record index to start at. All items with a lower index will be dropped from the results.
     * @type {number}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly startIndex?: number;
    /**
     * Optional. The maximum number of records to return.
     * @type {number}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly limit?: number;
    /**
     * Optional. Specify additional fields of information to return in the output.
     * @type {Array<ItemFields>}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly fields?: Array<ItemFields>;
    /**
     * Optional. Include image information in output.
     * @type {boolean}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly enableImages?: boolean;
    /**
     * Optional. Include user data.
     * @type {boolean}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly enableUserData?: boolean;
    /**
     * Optional. The max number of images to return, per image type.
     * @type {number}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly imageTypeLimit?: number;
    /**
     * Optional. The image types to include in the output.
     * @type {Array<ImageType>}
     * @memberof PlaylistsApiGetPlaylistItems
     */
    readonly enableImageTypes?: Array<ImageType>;
}
/**
 * Request parameters for getPlaylistUser operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiGetPlaylistUserRequest
 */
export interface PlaylistsApiGetPlaylistUserRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylistUser
     */
    readonly playlistId: string;
    /**
     * The user id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylistUser
     */
    readonly userId: string;
}
/**
 * Request parameters for getPlaylistUsers operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiGetPlaylistUsersRequest
 */
export interface PlaylistsApiGetPlaylistUsersRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiGetPlaylistUsers
     */
    readonly playlistId: string;
}
/**
 * Request parameters for moveItem operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiMoveItemRequest
 */
export interface PlaylistsApiMoveItemRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiMoveItem
     */
    readonly playlistId: string;
    /**
     * The item id.
     * @type {string}
     * @memberof PlaylistsApiMoveItem
     */
    readonly itemId: string;
    /**
     * The new index.
     * @type {number}
     * @memberof PlaylistsApiMoveItem
     */
    readonly newIndex: number;
}
/**
 * Request parameters for removeItemFromPlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiRemoveItemFromPlaylistRequest
 */
export interface PlaylistsApiRemoveItemFromPlaylistRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiRemoveItemFromPlaylist
     */
    readonly playlistId: string;
    /**
     * The item ids, comma delimited.
     * @type {Array<string>}
     * @memberof PlaylistsApiRemoveItemFromPlaylist
     */
    readonly entryIds?: Array<string>;
}
/**
 * Request parameters for removeUserFromPlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiRemoveUserFromPlaylistRequest
 */
export interface PlaylistsApiRemoveUserFromPlaylistRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiRemoveUserFromPlaylist
     */
    readonly playlistId: string;
    /**
     * The user id.
     * @type {string}
     * @memberof PlaylistsApiRemoveUserFromPlaylist
     */
    readonly userId: string;
}
/**
 * Request parameters for updatePlaylist operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiUpdatePlaylistRequest
 */
export interface PlaylistsApiUpdatePlaylistRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiUpdatePlaylist
     */
    readonly playlistId: string;
    /**
     * The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.
     * @type {UpdatePlaylistDto}
     * @memberof PlaylistsApiUpdatePlaylist
     */
    readonly updatePlaylistDto: UpdatePlaylistDto;
}
/**
 * Request parameters for updatePlaylistUser operation in PlaylistsApi.
 * @export
 * @interface PlaylistsApiUpdatePlaylistUserRequest
 */
export interface PlaylistsApiUpdatePlaylistUserRequest {
    /**
     * The playlist id.
     * @type {string}
     * @memberof PlaylistsApiUpdatePlaylistUser
     */
    readonly playlistId: string;
    /**
     * The user id.
     * @type {string}
     * @memberof PlaylistsApiUpdatePlaylistUser
     */
    readonly userId: string;
    /**
     * The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto.
     * @type {UpdatePlaylistUserDto}
     * @memberof PlaylistsApiUpdatePlaylistUser
     */
    readonly updatePlaylistUserDto: UpdatePlaylistUserDto;
}
/**
 * PlaylistsApi - object-oriented interface
 * @export
 * @class PlaylistsApi
 * @extends {BaseAPI}
 */
export declare class PlaylistsApi extends BaseAPI {
    /**
     *
     * @summary Adds items to a playlist.
     * @param {PlaylistsApiAddItemToPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    addItemToPlaylist(requestParameters: PlaylistsApiAddItemToPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 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 {PlaylistsApiCreatePlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    createPlaylist(requestParameters?: PlaylistsApiCreatePlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaylistCreationResult, any>>;
    /**
     *
     * @summary Get a playlist.
     * @param {PlaylistsApiGetPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    getPlaylist(requestParameters: PlaylistsApiGetPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaylistDto, any>>;
    /**
     *
     * @summary Gets the original items of a playlist.
     * @param {PlaylistsApiGetPlaylistItemsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    getPlaylistItems(requestParameters: PlaylistsApiGetPlaylistItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
    /**
     *
     * @summary Get a playlist user.
     * @param {PlaylistsApiGetPlaylistUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    getPlaylistUser(requestParameters: PlaylistsApiGetPlaylistUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaylistUserPermissions, any>>;
    /**
     *
     * @summary Get a playlist\'s users.
     * @param {PlaylistsApiGetPlaylistUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    getPlaylistUsers(requestParameters: PlaylistsApiGetPlaylistUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaylistUserPermissions[], any>>;
    /**
     *
     * @summary Moves a playlist item.
     * @param {PlaylistsApiMoveItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    moveItem(requestParameters: PlaylistsApiMoveItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Removes items from a playlist.
     * @param {PlaylistsApiRemoveItemFromPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    removeItemFromPlaylist(requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Remove a user from a playlist\'s users.
     * @param {PlaylistsApiRemoveUserFromPlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    removeUserFromPlaylist(requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Updates a playlist.
     * @param {PlaylistsApiUpdatePlaylistRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    updatePlaylist(requestParameters: PlaylistsApiUpdatePlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Modify a user of a playlist\'s users.
     * @param {PlaylistsApiUpdatePlaylistUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlaylistsApi
     */
    updatePlaylistUser(requestParameters: PlaylistsApiUpdatePlaylistUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}