@openfilz-sdk/typescript 1.2.2 → 1.2.4

package/dist/api/document-version-controller-api.js

@@ -0,0 +1,284 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentVersionControllerApi = exports.DocumentVersionControllerApiFactory = exports.DocumentVersionControllerApiFp = exports.DocumentVersionControllerApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * DocumentVersionControllerApi - axios parameter creator
+ */
+const DocumentVersionControllerApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Downloads the content of a specific stored version of a file document.
+         * @summary Download a specific document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadVersion: (documentId_1, versionId_1, ...args_1) => __awaiter(this, [documentId_1, versionId_1, ...args_1], void 0, function* (documentId, versionId, options = {}) {
+            // verify required parameter 'documentId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadVersion', 'documentId', documentId);
+            // verify required parameter 'versionId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadVersion', 'versionId', versionId);
+            const localVarPath = `/api/v1/documents/{documentId}/versions/{versionId}/download`
+                .replace('{documentId}', encodeURIComponent(String(documentId)))
+                .replace('{versionId}', encodeURIComponent(String(versionId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+         * @summary List document versions
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listVersions: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
+            // verify required parameter 'documentId' is not null or undefined
+            (0, common_1.assertParamExists)('listVersions', 'documentId', documentId);
+            const localVarPath = `/api/v1/documents/{documentId}/versions`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+         * @summary Restore a previous document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreVersion: (documentId_1, versionId_1, ...args_1) => __awaiter(this, [documentId_1, versionId_1, ...args_1], void 0, function* (documentId, versionId, options = {}) {
+            // verify required parameter 'documentId' is not null or undefined
+            (0, common_1.assertParamExists)('restoreVersion', 'documentId', documentId);
+            // verify required parameter 'versionId' is not null or undefined
+            (0, common_1.assertParamExists)('restoreVersion', 'versionId', versionId);
+            const localVarPath = `/api/v1/documents/{documentId}/versions/{versionId}/restore`
+                .replace('{documentId}', encodeURIComponent(String(documentId)))
+                .replace('{versionId}', encodeURIComponent(String(versionId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.DocumentVersionControllerApiAxiosParamCreator = DocumentVersionControllerApiAxiosParamCreator;
+/**
+ * DocumentVersionControllerApi - functional programming interface
+ */
+const DocumentVersionControllerApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.DocumentVersionControllerApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Downloads the content of a specific stored version of a file document.
+         * @summary Download a specific document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadVersion(documentId, versionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadVersion(documentId, versionId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentVersionControllerApi.downloadVersion']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+         * @summary List document versions
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listVersions(documentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listVersions(documentId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentVersionControllerApi.listVersions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+         * @summary Restore a previous document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreVersion(documentId, versionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.restoreVersion(documentId, versionId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentVersionControllerApi.restoreVersion']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.DocumentVersionControllerApiFp = DocumentVersionControllerApiFp;
+/**
+ * DocumentVersionControllerApi - factory interface
+ */
+const DocumentVersionControllerApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.DocumentVersionControllerApiFp)(configuration);
+    return {
+        /**
+         * Downloads the content of a specific stored version of a file document.
+         * @summary Download a specific document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadVersion(documentId, versionId, options) {
+            return localVarFp.downloadVersion(documentId, versionId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+         * @summary List document versions
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listVersions(documentId, options) {
+            return localVarFp.listVersions(documentId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+         * @summary Restore a previous document version
+         * @param {string} documentId
+         * @param {string} versionId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreVersion(documentId, versionId, options) {
+            return localVarFp.restoreVersion(documentId, versionId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.DocumentVersionControllerApiFactory = DocumentVersionControllerApiFactory;
+/**
+ * DocumentVersionControllerApi - object-oriented interface
+ */
+class DocumentVersionControllerApi extends base_1.BaseAPI {
+    /**
+     * Downloads the content of a specific stored version of a file document.
+     * @summary Download a specific document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadVersion(documentId, versionId, options) {
+        return (0, exports.DocumentVersionControllerApiFp)(this.configuration).downloadVersion(documentId, versionId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+     * @summary List document versions
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVersions(documentId, options) {
+        return (0, exports.DocumentVersionControllerApiFp)(this.configuration).listVersions(documentId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+     * @summary Restore a previous document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreVersion(documentId, versionId, options) {
+        return (0, exports.DocumentVersionControllerApiFp)(this.configuration).restoreVersion(documentId, versionId, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.DocumentVersionControllerApi = DocumentVersionControllerApi;

package/dist/api.d.ts

@@ -13,6 +13,7 @@ export * from './api/audit-controller-api';
 export * from './api/dashboard-api';
 export * from './api/document-controller-api';
 export * from './api/document-suggestion-controller-api';
+export * from './api/document-version-controller-api';
 export * from './api/favorites-api';
 export * from './api/file-controller-api';
 export * from './api/folder-controller-api';

package/dist/api.js

@@ -31,6 +31,7 @@ __exportStar(require("./api/audit-controller-api"), exports);
 __exportStar(require("./api/dashboard-api"), exports);
 __exportStar(require("./api/document-controller-api"), exports);
 __exportStar(require("./api/document-suggestion-controller-api"), exports);
+__exportStar(require("./api/document-version-controller-api"), exports);
 __exportStar(require("./api/favorites-api"), exports);
 __exportStar(require("./api/file-controller-api"), exports);
 __exportStar(require("./api/folder-controller-api"), exports);

package/dist/esm/api/document-version-controller-api.d.ts

@@ -0,0 +1,140 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { DocumentVersionInfo } from '../models';
+import type { RestoreVersionResponse } from '../models';
+/**
+ * DocumentVersionControllerApi - axios parameter creator
+ */
+export declare const DocumentVersionControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Downloads the content of a specific stored version of a file document.
+     * @summary Download a specific document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadVersion: (documentId: string, versionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+     * @summary List document versions
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVersions: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+     * @summary Restore a previous document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreVersion: (documentId: string, versionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentVersionControllerApi - functional programming interface
+ */
+export declare const DocumentVersionControllerApiFp: (configuration?: Configuration) => {
+    /**
+     * Downloads the content of a specific stored version of a file document.
+     * @summary Download a specific document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+     * @summary List document versions
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVersions(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DocumentVersionInfo>>>;
+    /**
+     * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+     * @summary Restore a previous document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestoreVersionResponse>>;
+};
+/**
+ * DocumentVersionControllerApi - factory interface
+ */
+export declare const DocumentVersionControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Downloads the content of a specific stored version of a file document.
+     * @summary Download a specific document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+     * @summary List document versions
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVersions(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DocumentVersionInfo>>;
+    /**
+     * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+     * @summary Restore a previous document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): AxiosPromise<RestoreVersionResponse>;
+};
+/**
+ * DocumentVersionControllerApi - object-oriented interface
+ */
+export declare class DocumentVersionControllerApi extends BaseAPI {
+    /**
+     * Downloads the content of a specific stored version of a file document.
+     * @summary Download a specific document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+     * @summary List document versions
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVersions(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentVersionInfo[], any, {}>>;
+    /**
+     * Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
+     * @summary Restore a previous document version
+     * @param {string} documentId
+     * @param {string} versionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreVersion(documentId: string, versionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RestoreVersionResponse, any, {}>>;
+}