@jellyfin/sdk/lib/generated-client/api/library-structure-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 { AddVirtualFolderDto } from '../models';
import type { CollectionTypeOptions } from '../models';
import type { MediaPathDto } from '../models';
import type { UpdateLibraryOptionsDto } from '../models';
import type { UpdateMediaPathRequestDto } from '../models';
import type { VirtualFolderInfo } from '../models';
/**
 * LibraryStructureApi - axios parameter creator
 * @export
 */
export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Add a media path to a library.
     * @param {MediaPathDto} mediaPathDto The media path dto.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Adds a virtual folder.
     * @param {string} [name] The name of the virtual folder.
     * @param {CollectionTypeOptions} [collectionType] The type of the collection.
     * @param {Array<string>} [paths] The paths of the virtual folder.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {AddVirtualFolderDto} [addVirtualFolderDto] The library options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: Array<string>, refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets all virtual folders.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getVirtualFolders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Remove a media path.
     * @param {string} [name] The name of the library.
     * @param {string} [path] The path to remove.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Removes a virtual folder.
     * @param {string} [name] The name of the folder.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Renames a virtual folder.
     * @param {string} [name] The name of the virtual folder.
     * @param {string} [newName] The new name.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update library options.
     * @param {UpdateLibraryOptionsDto} [updateLibraryOptionsDto] The library name and options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates a media path.
     * @param {UpdateMediaPathRequestDto} updateMediaPathRequestDto The name of the library and path infos.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * LibraryStructureApi - functional programming interface
 * @export
 */
export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Add a media path to a library.
     * @param {MediaPathDto} mediaPathDto The media path dto.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Adds a virtual folder.
     * @param {string} [name] The name of the virtual folder.
     * @param {CollectionTypeOptions} [collectionType] The type of the collection.
     * @param {Array<string>} [paths] The paths of the virtual folder.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {AddVirtualFolderDto} [addVirtualFolderDto] The library options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: Array<string>, refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Gets all virtual folders.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getVirtualFolders(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VirtualFolderInfo>>>;
    /**
     *
     * @summary Remove a media path.
     * @param {string} [name] The name of the library.
     * @param {string} [path] The path to remove.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Removes a virtual folder.
     * @param {string} [name] The name of the folder.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Renames a virtual folder.
     * @param {string} [name] The name of the virtual folder.
     * @param {string} [newName] The new name.
     * @param {boolean} [refreshLibrary] Whether to refresh the library.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Update library options.
     * @param {UpdateLibraryOptionsDto} [updateLibraryOptionsDto] The library name and options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Updates a media path.
     * @param {UpdateMediaPathRequestDto} updateMediaPathRequestDto The name of the library and path infos.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * LibraryStructureApi - factory interface
 * @export
 */
export declare const LibraryStructureApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Add a media path to a library.
     * @param {LibraryStructureApiAddMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addMediaPath(requestParameters: LibraryStructureApiAddMediaPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Adds a virtual folder.
     * @param {LibraryStructureApiAddVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addVirtualFolder(requestParameters?: LibraryStructureApiAddVirtualFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Gets all virtual folders.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getVirtualFolders(options?: RawAxiosRequestConfig): AxiosPromise<Array<VirtualFolderInfo>>;
    /**
     *
     * @summary Remove a media path.
     * @param {LibraryStructureApiRemoveMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeMediaPath(requestParameters?: LibraryStructureApiRemoveMediaPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Removes a virtual folder.
     * @param {LibraryStructureApiRemoveVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeVirtualFolder(requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Renames a virtual folder.
     * @param {LibraryStructureApiRenameVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    renameVirtualFolder(requestParameters?: LibraryStructureApiRenameVirtualFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Update library options.
     * @param {LibraryStructureApiUpdateLibraryOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateLibraryOptions(requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Updates a media path.
     * @param {LibraryStructureApiUpdateMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateMediaPath(requestParameters: LibraryStructureApiUpdateMediaPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for addMediaPath operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiAddMediaPathRequest
 */
export interface LibraryStructureApiAddMediaPathRequest {
    /**
     * The media path dto.
     * @type {MediaPathDto}
     * @memberof LibraryStructureApiAddMediaPath
     */
    readonly mediaPathDto: MediaPathDto;
    /**
     * Whether to refresh the library.
     * @type {boolean}
     * @memberof LibraryStructureApiAddMediaPath
     */
    readonly refreshLibrary?: boolean;
}
/**
 * Request parameters for addVirtualFolder operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiAddVirtualFolderRequest
 */
export interface LibraryStructureApiAddVirtualFolderRequest {
    /**
     * The name of the virtual folder.
     * @type {string}
     * @memberof LibraryStructureApiAddVirtualFolder
     */
    readonly name?: string;
    /**
     * The type of the collection.
     * @type {CollectionTypeOptions}
     * @memberof LibraryStructureApiAddVirtualFolder
     */
    readonly collectionType?: CollectionTypeOptions;
    /**
     * The paths of the virtual folder.
     * @type {Array<string>}
     * @memberof LibraryStructureApiAddVirtualFolder
     */
    readonly paths?: Array<string>;
    /**
     * Whether to refresh the library.
     * @type {boolean}
     * @memberof LibraryStructureApiAddVirtualFolder
     */
    readonly refreshLibrary?: boolean;
    /**
     * The library options.
     * @type {AddVirtualFolderDto}
     * @memberof LibraryStructureApiAddVirtualFolder
     */
    readonly addVirtualFolderDto?: AddVirtualFolderDto;
}
/**
 * Request parameters for removeMediaPath operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiRemoveMediaPathRequest
 */
export interface LibraryStructureApiRemoveMediaPathRequest {
    /**
     * The name of the library.
     * @type {string}
     * @memberof LibraryStructureApiRemoveMediaPath
     */
    readonly name?: string;
    /**
     * The path to remove.
     * @type {string}
     * @memberof LibraryStructureApiRemoveMediaPath
     */
    readonly path?: string;
    /**
     * Whether to refresh the library.
     * @type {boolean}
     * @memberof LibraryStructureApiRemoveMediaPath
     */
    readonly refreshLibrary?: boolean;
}
/**
 * Request parameters for removeVirtualFolder operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiRemoveVirtualFolderRequest
 */
export interface LibraryStructureApiRemoveVirtualFolderRequest {
    /**
     * The name of the folder.
     * @type {string}
     * @memberof LibraryStructureApiRemoveVirtualFolder
     */
    readonly name?: string;
    /**
     * Whether to refresh the library.
     * @type {boolean}
     * @memberof LibraryStructureApiRemoveVirtualFolder
     */
    readonly refreshLibrary?: boolean;
}
/**
 * Request parameters for renameVirtualFolder operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiRenameVirtualFolderRequest
 */
export interface LibraryStructureApiRenameVirtualFolderRequest {
    /**
     * The name of the virtual folder.
     * @type {string}
     * @memberof LibraryStructureApiRenameVirtualFolder
     */
    readonly name?: string;
    /**
     * The new name.
     * @type {string}
     * @memberof LibraryStructureApiRenameVirtualFolder
     */
    readonly newName?: string;
    /**
     * Whether to refresh the library.
     * @type {boolean}
     * @memberof LibraryStructureApiRenameVirtualFolder
     */
    readonly refreshLibrary?: boolean;
}
/**
 * Request parameters for updateLibraryOptions operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiUpdateLibraryOptionsRequest
 */
export interface LibraryStructureApiUpdateLibraryOptionsRequest {
    /**
     * The library name and options.
     * @type {UpdateLibraryOptionsDto}
     * @memberof LibraryStructureApiUpdateLibraryOptions
     */
    readonly updateLibraryOptionsDto?: UpdateLibraryOptionsDto;
}
/**
 * Request parameters for updateMediaPath operation in LibraryStructureApi.
 * @export
 * @interface LibraryStructureApiUpdateMediaPathRequest
 */
export interface LibraryStructureApiUpdateMediaPathRequest {
    /**
     * The name of the library and path infos.
     * @type {UpdateMediaPathRequestDto}
     * @memberof LibraryStructureApiUpdateMediaPath
     */
    readonly updateMediaPathRequestDto: UpdateMediaPathRequestDto;
}
/**
 * LibraryStructureApi - object-oriented interface
 * @export
 * @class LibraryStructureApi
 * @extends {BaseAPI}
 */
export declare class LibraryStructureApi extends BaseAPI {
    /**
     *
     * @summary Add a media path to a library.
     * @param {LibraryStructureApiAddMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    addMediaPath(requestParameters: LibraryStructureApiAddMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Adds a virtual folder.
     * @param {LibraryStructureApiAddVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    addVirtualFolder(requestParameters?: LibraryStructureApiAddVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Gets all virtual folders.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    getVirtualFolders(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualFolderInfo[], any>>;
    /**
     *
     * @summary Remove a media path.
     * @param {LibraryStructureApiRemoveMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    removeMediaPath(requestParameters?: LibraryStructureApiRemoveMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Removes a virtual folder.
     * @param {LibraryStructureApiRemoveVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    removeVirtualFolder(requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Renames a virtual folder.
     * @param {LibraryStructureApiRenameVirtualFolderRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    renameVirtualFolder(requestParameters?: LibraryStructureApiRenameVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Update library options.
     * @param {LibraryStructureApiUpdateLibraryOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    updateLibraryOptions(requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Updates a media path.
     * @param {LibraryStructureApiUpdateMediaPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LibraryStructureApi
     */
    updateMediaPath(requestParameters: LibraryStructureApiUpdateMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}