@jellyfin/sdk 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -0,0 +1,127 @@
+<!-- markdownlint-disable MD024 -->
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [0.12.0] - 2025-10-21
+
+### Security
+
+* Bumped axios peer dependency version ([#939](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/939)). Note that this axios vulnerability only affected applications running in node.js.
+
+### Added
+
+* `getUri` utility method ([#867](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/867)).
+
+### Changed
+
+* Updated minimum Jellyfin version to 10.10.0 ([#942](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/942)).
+* Updated OpenAPI spec for Jellyfin 10.11.0 ([#931](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/931)).
+
+### Removed
+
+* Duplicate `ItemSortBy` enum ([#842](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/842)).
+* `addPlayedIndicator` from `ImageRequestParameters` ([#841](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/841)).
+
+## [0.11.0] - 2024-10-28
+
+### Changed
+
+* Updated OpenAPI spec for Jellyfin 10.10.0 ([#816](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/816)).
+
+### Removed
+
+* Deprecated image url function ([#731](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/731)).
+
+## [0.10.0] - 2024-06-03
+
+### Changed
+
+* Update build target to ES2018 ([#712](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/712)).
+
+## [0.9.0] - 2024-05-14
+
+### Changed
+
+* Update OpenAPI spec for Jellyfin 10.9.1 ([#694](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/694)).
+
+## [0.8.2] - 2023-04-12
+
+## [0.8.1] - 2023-03-31
+
+## [0.8.0] - 2023-03-30
+
+### Changed
+
+* Fully target ES6/ES2015 ([#341](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/341)).
+* Axios major version upgrade ([#300](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/300)).
+
+## [0.7.0] - 2023-09-16
+
+### Changed
+
+* Rename package to @jellyfin/sdk ([#262](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/262)).
+
+## [0.6.0] - 2022-07-14
+
+### Changed
+
+* Update OpenAPI spec for Jellyfin 10.8.1 ([#208](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/208)).
+
+## [0.5.0] - 2022-06-17
+
+### Changed
+
+* Build directory is now `lib` instead of `dist`.
+  Any imports used that were previously in `dist` will need updated ([#147](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/147)).
+* API classes are no longer exposed via getters.
+  Instead you need to call a function passing the `Api` instance as a parameter.
+  For example: `getSystemApi(api)`.
+  While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking ([#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)).
+* `BaseItemKind` is now included in the generated client.
+  Imports will need updated ([#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187)).
+
+### Removed
+
+* Duplicated exports were removed.
+  Any imports may need updated if you referenced one of the duplicates ([#148](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/148)).
+
+## [0.4.1] - 2022-02-17
+
+## [0.4.0] - 2022-02-17
+
+## [0.3.1] - 2022-02-03
+
+## [0.3.0] - 2021-10-18
+
+## [0.2.0] - 2021-10-08
+
+## [0.1.2] - 2021-09-19
+
+## [0.1.1] - 2021-09-19
+
+## [0.1.0] - 2021-09-19
+
+[unreleased]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.11.0...v0.12.0
+[0.11.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.8.2...v0.9.0
+[0.8.2]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.8.1...v0.8.2
+[0.8.1]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/releases/tag/v0.1.0

package/README.md

@@ -35,6 +35,7 @@ yarn add @jellyfin/sdk
 
 | SDK Version | Jellyfin Version |
 |:-:|:-:|
+| 0.12.0 | 10.11.x |
 | 0.11.0 | 10.10.x |
 | 0.10.0 | 10.9.x |
 | 0.9.0 | 10.9.x |
@@ -109,51 +110,7 @@ await api.logout();
 
 ## Breaking Changes
 
-### v0.11.0
-
-* Updated OpenAPI spec for Jellyfin 10.10.0. [#816](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/816)
-
-### v0.10.0
-
-* Updated build target to ES2018. [#712](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/712)
-
-### v0.9.0
-
-* Updated OpenAPI spec for Jellyfin 10.9.1. [#694](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/694)
-
-### v0.8.0
-
-* The library is now fully targeted to ES6/ES2015.
-  [#341](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/341)
-* Axios received a major version upgrade.
-  [#300](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/300)
-
-### v0.7.0
-
-* Renamed package to @jellyfin/sdk.
-  [#262](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/262)
-
-### v0.6.0
-
-* Updated OpenAPI spec for Jellyfin 10.8.1.
-  [#208](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/208)
-
-### v0.5.0
-
-* Build directory is now `lib` instead of `dist`.
-  Any imports used that were previously in `dist` will need updated.
-  [#147](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/147)
-* Duplicated exports were removed.
-  Any imports may need updated if you referenced one of the duplicates.
-  [#148](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/148)
-* API classes are no longer exposed via getters.
-  Instead you need to call a function passing the `Api` instance as a parameter.
-  For example: `getSystemApi(api)`.
-  While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking.
-  [#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)
-* `BaseItemKind` is now included in the generated client.
-  Imports will need updated.
-  [#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187)
+[See the CHANGELOG](./CHANGELOG.md)
 
 ## Roadmap to 1.0
 

package/lib/api.d.ts

@@ -24,6 +24,13 @@ export declare class Api {
      * @param password The user password if required.
      */
     authenticateUserByName(username: string, password?: string): Promise<AxiosResponse<AuthenticationResult>>;
+    /**
+     * Gets a full URI for a relative URL to the Jellyfin server for a given SDK Api instance.
+     * @param url The relative URL.
+     * @param params Any URL parameters.
+     * @returns The complete URI with protocol, host, and base URL (if any).
+     */
+    getUri(url: string, params?: object): string;
     /**
      * Convenience method for logging out and updating the internal state.
      */

package/lib/api.js

@@ -38,6 +38,19 @@ class Api {
             return response;
         });
     }
+    /**
+     * Gets a full URI for a relative URL to the Jellyfin server for a given SDK Api instance.
+     * @param url The relative URL.
+     * @param params Any URL parameters.
+     * @returns The complete URI with protocol, host, and base URL (if any).
+     */
+    getUri(url, params) {
+        return this.axiosInstance.getUri({
+            baseURL: this.basePath,
+            url,
+            params
+        });
+    }
     /**
      * Convenience method for logging out and updating the internal state.
      */

package/lib/generated-client/api/activity-log-api.d.ts

@@ -106,5 +106,5 @@ export declare class ActivityLogApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ActivityLogApi
      */
-    getLogEntries(requestParameters?: ActivityLogApiGetLogEntriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityLogEntryQueryResult, any>>;
+    getLogEntries(requestParameters?: ActivityLogApiGetLogEntriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivityLogEntryQueryResult, any, {}>>;
 }

package/lib/generated-client/api/api-key-api.d.ts

@@ -140,7 +140,7 @@ export declare class ApiKeyApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ApiKeyApi
      */
-    createKey(requestParameters: ApiKeyApiCreateKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    createKey(requestParameters: ApiKeyApiCreateKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Get all keys.
@@ -148,7 +148,7 @@ export declare class ApiKeyApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ApiKeyApi
      */
-    getKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationInfoQueryResult, any>>;
+    getKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationInfoQueryResult, any, {}>>;
     /**
      *
      * @summary Remove an api key.
@@ -157,5 +157,5 @@ export declare class ApiKeyApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ApiKeyApi
      */
-    revokeKey(requestParameters: ApiKeyApiRevokeKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    revokeKey(requestParameters: ApiKeyApiRevokeKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }

package/lib/generated-client/api/artists-api.d.ts

@@ -668,7 +668,7 @@ export declare class ArtistsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ArtistsApi
      */
-    getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
+    getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
     /**
      *
      * @summary Gets an artist by name.
@@ -677,7 +677,7 @@ export declare class ArtistsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ArtistsApi
      */
-    getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
+    getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any, {}>>;
     /**
      *
      * @summary Gets all artists from a given item, folder, or the entire library.
@@ -686,5 +686,5 @@ export declare class ArtistsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ArtistsApi
      */
-    getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
+    getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
 }

package/lib/generated-client/api/audio-api.d.ts

@@ -117,7 +117,7 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
      * @param {boolean} [requireAvc] Optional. Whether to require avc.
      * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
      * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
      * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
      * @param {string} [liveStreamId] The live stream id.
@@ -235,7 +235,7 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
      * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
      * @param {boolean} [requireAvc] Optional. Whether to require avc.
      * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
      * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
      * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
      * @param {string} [liveStreamId] The live stream id.
@@ -359,7 +359,7 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
      * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
      * @param {boolean} [requireAvc] Optional. Whether to require avc.
      * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
      * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
      * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
      * @param {string} [liveStreamId] The live stream id.
@@ -477,7 +477,7 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
      * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
      * @param {boolean} [requireAvc] Optional. Whether to require avc.
      * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+     * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
      * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
      * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
      * @param {string} [liveStreamId] The live stream id.
@@ -1073,7 +1073,7 @@ export interface AudioApiGetAudioStreamByContainerRequest {
      */
     readonly deInterlace?: boolean;
     /**
-     * Optional. Whether to require a non anamporphic stream.
+     * Optional. Whether to require a non anamorphic stream.
      * @type {boolean}
      * @memberof AudioApiGetAudioStreamByContainer
      */
@@ -1691,7 +1691,7 @@ export interface AudioApiHeadAudioStreamByContainerRequest {
      */
     readonly deInterlace?: boolean;
     /**
-     * Optional. Whether to require a non anamporphic stream.
+     * Optional. Whether to require a non anamorphic stream.
      * @type {boolean}
      * @memberof AudioApiHeadAudioStreamByContainer
      */
@@ -1786,7 +1786,7 @@ export declare class AudioApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AudioApi
      */
-    getAudioStream(requestParameters: AudioApiGetAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    getAudioStream(requestParameters: AudioApiGetAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
     /**
      *
      * @summary Gets an audio stream.
@@ -1795,7 +1795,7 @@ export declare class AudioApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AudioApi
      */
-    getAudioStreamByContainer(requestParameters: AudioApiGetAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    getAudioStreamByContainer(requestParameters: AudioApiGetAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
     /**
      *
      * @summary Gets an audio stream.
@@ -1804,7 +1804,7 @@ export declare class AudioApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AudioApi
      */
-    headAudioStream(requestParameters: AudioApiHeadAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    headAudioStream(requestParameters: AudioApiHeadAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
     /**
      *
      * @summary Gets an audio stream.
@@ -1813,5 +1813,5 @@ export declare class AudioApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AudioApi
      */
-    headAudioStreamByContainer(requestParameters: AudioApiHeadAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    headAudioStreamByContainer(requestParameters: AudioApiHeadAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
 }

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

@@ -287,7 +287,7 @@ const AudioApiAxiosParamCreator = function (configuration) {
          * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
          * @param {boolean} [requireAvc] Optional. Whether to require avc.
          * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
          * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
          * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
          * @param {string} [liveStreamId] The live stream id.
@@ -741,7 +741,7 @@ const AudioApiAxiosParamCreator = function (configuration) {
          * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
          * @param {boolean} [requireAvc] Optional. Whether to require avc.
          * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
          * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
          * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
          * @param {string} [liveStreamId] The live stream id.
@@ -1040,7 +1040,7 @@ const AudioApiFp = function (configuration) {
          * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
          * @param {boolean} [requireAvc] Optional. Whether to require avc.
          * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
          * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
          * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
          * @param {string} [liveStreamId] The live stream id.
@@ -1166,7 +1166,7 @@ const AudioApiFp = function (configuration) {
          * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
          * @param {boolean} [requireAvc] Optional. Whether to require avc.
          * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
-         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream.
+         * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
          * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
          * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
          * @param {string} [liveStreamId] The live stream id.

package/lib/generated-client/api/backup-api.d.ts

@@ -0,0 +1,209 @@
+/**
+ * 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 { BackupManifestDto } from '../models';
+import type { BackupOptionsDto } from '../models';
+import type { BackupRestoreRequestDto } from '../models';
+/**
+ * BackupApi - axios parameter creator
+ * @export
+ */
+export declare const BackupApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Creates a new Backup.
+     * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBackup: (backupOptionsDto?: BackupOptionsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets the descriptor from an existing archive is present.
+     * @param {string} path The data to start a restore process.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBackup: (path: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets a list of all currently present backups in the backup directory.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBackups: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Restores to a backup by restarting the server and applying the backup.
+     * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startRestoreBackup: (backupRestoreRequestDto: BackupRestoreRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BackupApi - functional programming interface
+ * @export
+ */
+export declare const BackupApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Creates a new Backup.
+     * @param {BackupOptionsDto} [backupOptionsDto] The backup options.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBackup(backupOptionsDto?: BackupOptionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackupManifestDto>>;
+    /**
+     *
+     * @summary Gets the descriptor from an existing archive is present.
+     * @param {string} path The data to start a restore process.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBackup(path: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackupManifestDto>>;
+    /**
+     *
+     * @summary Gets a list of all currently present backups in the backup directory.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBackups(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BackupManifestDto>>>;
+    /**
+     *
+     * @summary Restores to a backup by restarting the server and applying the backup.
+     * @param {BackupRestoreRequestDto} backupRestoreRequestDto The data to start a restore process.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startRestoreBackup(backupRestoreRequestDto: BackupRestoreRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * BackupApi - factory interface
+ * @export
+ */
+export declare const BackupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Creates a new Backup.
+     * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBackup(requestParameters?: BackupApiCreateBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackupManifestDto>;
+    /**
+     *
+     * @summary Gets the descriptor from an existing archive is present.
+     * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBackup(requestParameters: BackupApiGetBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackupManifestDto>;
+    /**
+     *
+     * @summary Gets a list of all currently present backups in the backup directory.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBackups(options?: RawAxiosRequestConfig): AxiosPromise<Array<BackupManifestDto>>;
+    /**
+     *
+     * @summary Restores to a backup by restarting the server and applying the backup.
+     * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startRestoreBackup(requestParameters: BackupApiStartRestoreBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for createBackup operation in BackupApi.
+ * @export
+ * @interface BackupApiCreateBackupRequest
+ */
+export interface BackupApiCreateBackupRequest {
+    /**
+     * The backup options.
+     * @type {BackupOptionsDto}
+     * @memberof BackupApiCreateBackup
+     */
+    readonly backupOptionsDto?: BackupOptionsDto;
+}
+/**
+ * Request parameters for getBackup operation in BackupApi.
+ * @export
+ * @interface BackupApiGetBackupRequest
+ */
+export interface BackupApiGetBackupRequest {
+    /**
+     * The data to start a restore process.
+     * @type {string}
+     * @memberof BackupApiGetBackup
+     */
+    readonly path: string;
+}
+/**
+ * Request parameters for startRestoreBackup operation in BackupApi.
+ * @export
+ * @interface BackupApiStartRestoreBackupRequest
+ */
+export interface BackupApiStartRestoreBackupRequest {
+    /**
+     * The data to start a restore process.
+     * @type {BackupRestoreRequestDto}
+     * @memberof BackupApiStartRestoreBackup
+     */
+    readonly backupRestoreRequestDto: BackupRestoreRequestDto;
+}
+/**
+ * BackupApi - object-oriented interface
+ * @export
+ * @class BackupApi
+ * @extends {BaseAPI}
+ */
+export declare class BackupApi extends BaseAPI {
+    /**
+     *
+     * @summary Creates a new Backup.
+     * @param {BackupApiCreateBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BackupApi
+     */
+    createBackup(requestParameters?: BackupApiCreateBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto, any, {}>>;
+    /**
+     *
+     * @summary Gets the descriptor from an existing archive is present.
+     * @param {BackupApiGetBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BackupApi
+     */
+    getBackup(requestParameters: BackupApiGetBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto, any, {}>>;
+    /**
+     *
+     * @summary Gets a list of all currently present backups in the backup directory.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BackupApi
+     */
+    listBackups(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackupManifestDto[], any, {}>>;
+    /**
+     *
+     * @summary Restores to a backup by restarting the server and applying the backup.
+     * @param {BackupApiStartRestoreBackupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BackupApi
+     */
+    startRestoreBackup(requestParameters: BackupApiStartRestoreBackupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}