@jellyfin/sdk 0.9.0 → 0.11.0

package/lib/generated-client/api/library-structure-api.d.ts

@@ -8,15 +8,15 @@
  * 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 { AddVirtualFolderDto } from '../models';
-import { CollectionTypeOptions } from '../models';
-import { MediaPathDto } from '../models';
-import { UpdateLibraryOptionsDto } from '../models';
-import { UpdateMediaPathRequestDto } from '../models';
-import { VirtualFolderInfo } from '../models';
+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
@@ -30,7 +30,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Adds a virtual folder.
@@ -42,14 +42,14 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: Array<string>, refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getVirtualFolders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Remove a media path.
@@ -59,7 +59,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Removes a virtual folder.
@@ -68,7 +68,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Renames a virtual folder.
@@ -78,7 +78,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Update library options.
@@ -86,7 +86,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Updates a media path.
@@ -94,7 +94,7 @@ export declare const LibraryStructureApiAxiosParamCreator: (configuration?: Conf
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * LibraryStructureApi - functional programming interface
@@ -109,7 +109,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Adds a virtual folder.
@@ -121,14 +121,14 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: Array<string>, refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VirtualFolderInfo>>>;
+    getVirtualFolders(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VirtualFolderInfo>>>;
     /**
      *
      * @summary Remove a media path.
@@ -138,7 +138,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Removes a virtual folder.
@@ -147,7 +147,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Renames a virtual folder.
@@ -157,7 +157,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Update library options.
@@ -165,7 +165,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Updates a media path.
@@ -173,7 +173,7 @@ export declare const LibraryStructureApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * LibraryStructureApi - factory interface
@@ -183,76 +183,66 @@ export declare const LibraryStructureApiFactory: (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 {LibraryStructureApiAddMediaPathRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): AxiosPromise<void>;
+    addMediaPath(requestParameters: LibraryStructureApiAddMediaPathRequest, options?: RawAxiosRequestConfig): 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 {LibraryStructureApiAddVirtualFolderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: Array<string>, refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any): AxiosPromise<void>;
+    addVirtualFolder(requestParameters?: LibraryStructureApiAddVirtualFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Gets all virtual folders.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getVirtualFolders(options?: any): AxiosPromise<Array<VirtualFolderInfo>>;
+    getVirtualFolders(options?: RawAxiosRequestConfig): 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 {LibraryStructureApiRemoveMediaPathRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>;
+    removeMediaPath(requestParameters?: LibraryStructureApiRemoveMediaPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Removes a virtual folder.
-     * @param {string} [name] The name of the folder.
-     * @param {boolean} [refreshLibrary] Whether to refresh the library.
+     * @param {LibraryStructureApiRemoveVirtualFolderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>;
+    removeVirtualFolder(requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest, options?: RawAxiosRequestConfig): 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 {LibraryStructureApiRenameVirtualFolderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>;
+    renameVirtualFolder(requestParameters?: LibraryStructureApiRenameVirtualFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Update library options.
-     * @param {UpdateLibraryOptionsDto} [updateLibraryOptionsDto] The library name and options.
+     * @param {LibraryStructureApiUpdateLibraryOptionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any): AxiosPromise<void>;
+    updateLibraryOptions(requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Updates a media path.
-     * @param {UpdateMediaPathRequestDto} updateMediaPathRequestDto The name of the library and path infos.
+     * @param {LibraryStructureApiUpdateMediaPathRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any): AxiosPromise<void>;
+    updateMediaPath(requestParameters: LibraryStructureApiUpdateMediaPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
 /**
  * Request parameters for addMediaPath operation in LibraryStructureApi.
@@ -420,7 +410,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    addMediaPath(requestParameters: LibraryStructureApiAddMediaPathRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    addMediaPath(requestParameters: LibraryStructureApiAddMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Adds a virtual folder.
@@ -429,7 +419,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    addVirtualFolder(requestParameters?: LibraryStructureApiAddVirtualFolderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    addVirtualFolder(requestParameters?: LibraryStructureApiAddVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Gets all virtual folders.
@@ -437,7 +427,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    getVirtualFolders(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualFolderInfo[], any>>;
+    getVirtualFolders(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualFolderInfo[], any>>;
     /**
      *
      * @summary Remove a media path.
@@ -446,7 +436,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    removeMediaPath(requestParameters?: LibraryStructureApiRemoveMediaPathRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    removeMediaPath(requestParameters?: LibraryStructureApiRemoveMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Removes a virtual folder.
@@ -455,7 +445,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    removeVirtualFolder(requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    removeVirtualFolder(requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Renames a virtual folder.
@@ -464,7 +454,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    renameVirtualFolder(requestParameters?: LibraryStructureApiRenameVirtualFolderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    renameVirtualFolder(requestParameters?: LibraryStructureApiRenameVirtualFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Update library options.
@@ -473,7 +463,7 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    updateLibraryOptions(requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    updateLibraryOptions(requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Updates a media path.
@@ -482,5 +472,5 @@ export declare class LibraryStructureApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LibraryStructureApi
      */
-    updateMediaPath(requestParameters: LibraryStructureApiUpdateMediaPathRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    updateMediaPath(requestParameters: LibraryStructureApiUpdateMediaPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }