@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/api/archive-controller-api.ts

@@ -0,0 +1,440 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { ArchivePreflight } from '../models';
+/**
+ * ArchiveControllerApi - axios parameter creator
+ */
+export const ArchiveControllerApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
+         * @summary Archive a document
+         * @param {string} documentId 
+         * @param {string} [onBehalfOf] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archive: async (documentId: string, onBehalfOf?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('archive', 'documentId', documentId)
+            const localVarPath = `/api/v1/archive/documents/{documentId}`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (onBehalfOf !== undefined) {
+                localVarQueryParameter['onBehalfOf'] = onBehalfOf;
+            }
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
+         * @summary Archive the caller\'s own files in a folder subtree
+         * @param {string} folderId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archiveFolder: async (folderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'folderId' is not null or undefined
+            assertParamExists('archiveFolder', 'folderId', folderId)
+            const localVarPath = `/api/v1/archive/folders/{folderId}`
+                .replace('{folderId}', encodeURIComponent(String(folderId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
+         * @summary What archiving this would actually do
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        preflight: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('preflight', 'documentId', documentId)
+            const localVarPath = `/api/v1/archive/preflight/{documentId}`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
+         * @summary Hand custody of an archived document to another user
+         * @param {string} documentId 
+         * @param {{ [key: string]: string; }} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reassignOwner: async (documentId: string, requestBody: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('reassignOwner', 'documentId', documentId)
+            // verify required parameter 'requestBody' is not null or undefined
+            assertParamExists('reassignOwner', 'requestBody', requestBody)
+            const localVarPath = `/api/v1/archive/documents/{documentId}/owner`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
+         * @summary Restore an archived document into this instance
+         * @param {string} archiveDocumentId 
+         * @param {string} [targetFolderId] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restore: async (archiveDocumentId: string, targetFolderId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'archiveDocumentId' is not null or undefined
+            assertParamExists('restore', 'archiveDocumentId', archiveDocumentId)
+            const localVarPath = `/api/v1/archive/documents/{archiveDocumentId}/restore`
+                .replace('{archiveDocumentId}', encodeURIComponent(String(archiveDocumentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (targetFolderId !== undefined) {
+                localVarQueryParameter['targetFolderId'] = targetFolderId;
+            }
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ArchiveControllerApi - functional programming interface
+ */
+export const ArchiveControllerApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ArchiveControllerApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
+         * @summary Archive a document
+         * @param {string} documentId 
+         * @param {string} [onBehalfOf] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async archive(documentId: string, onBehalfOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.archive(documentId, onBehalfOf, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ArchiveControllerApi.archive']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
+         * @summary Archive the caller\'s own files in a folder subtree
+         * @param {string} folderId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async archiveFolder(folderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.archiveFolder(folderId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ArchiveControllerApi.archiveFolder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
+         * @summary What archiving this would actually do
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async preflight(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivePreflight>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.preflight(documentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ArchiveControllerApi.preflight']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
+         * @summary Hand custody of an archived document to another user
+         * @param {string} documentId 
+         * @param {{ [key: string]: string; }} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async reassignOwner(documentId: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.reassignOwner(documentId, requestBody, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ArchiveControllerApi.reassignOwner']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
+         * @summary Restore an archived document into this instance
+         * @param {string} archiveDocumentId 
+         * @param {string} [targetFolderId] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async restore(archiveDocumentId: string, targetFolderId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.restore(archiveDocumentId, targetFolderId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ArchiveControllerApi.restore']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ArchiveControllerApi - factory interface
+ */
+export const ArchiveControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ArchiveControllerApiFp(configuration)
+    return {
+        /**
+         * Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
+         * @summary Archive a document
+         * @param {string} documentId 
+         * @param {string} [onBehalfOf] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archive(documentId: string, onBehalfOf?: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
+            return localVarFp.archive(documentId, onBehalfOf, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
+         * @summary Archive the caller\'s own files in a folder subtree
+         * @param {string} folderId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archiveFolder(folderId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
+            return localVarFp.archiveFolder(folderId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
+         * @summary What archiving this would actually do
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        preflight(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ArchivePreflight> {
+            return localVarFp.preflight(documentId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
+         * @summary Hand custody of an archived document to another user
+         * @param {string} documentId 
+         * @param {{ [key: string]: string; }} requestBody 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reassignOwner(documentId: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
+            return localVarFp.reassignOwner(documentId, requestBody, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
+         * @summary Restore an archived document into this instance
+         * @param {string} archiveDocumentId 
+         * @param {string} [targetFolderId] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restore(archiveDocumentId: string, targetFolderId?: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
+            return localVarFp.restore(archiveDocumentId, targetFolderId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ArchiveControllerApi - object-oriented interface
+ */
+export class ArchiveControllerApi extends BaseAPI {
+    /**
+     * Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
+     * @summary Archive a document
+     * @param {string} documentId 
+     * @param {string} [onBehalfOf] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public archive(documentId: string, onBehalfOf?: string, options?: RawAxiosRequestConfig) {
+        return ArchiveControllerApiFp(this.configuration).archive(documentId, onBehalfOf, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
+     * @summary Archive the caller\'s own files in a folder subtree
+     * @param {string} folderId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public archiveFolder(folderId: string, options?: RawAxiosRequestConfig) {
+        return ArchiveControllerApiFp(this.configuration).archiveFolder(folderId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
+     * @summary What archiving this would actually do
+     * @param {string} documentId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public preflight(documentId: string, options?: RawAxiosRequestConfig) {
+        return ArchiveControllerApiFp(this.configuration).preflight(documentId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
+     * @summary Hand custody of an archived document to another user
+     * @param {string} documentId 
+     * @param {{ [key: string]: string; }} requestBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public reassignOwner(documentId: string, requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
+        return ArchiveControllerApiFp(this.configuration).reassignOwner(documentId, requestBody, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
+     * @summary Restore an archived document into this instance
+     * @param {string} archiveDocumentId 
+     * @param {string} [targetFolderId] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public restore(archiveDocumentId: string, targetFolderId?: string, options?: RawAxiosRequestConfig) {
+        return ArchiveControllerApiFp(this.configuration).restore(archiveDocumentId, targetFolderId, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api/collaboration-audit-controller-api.ts

@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
+import type { AuditIntegrityStatusResponse } from '../models';
+// @ts-ignore
 import type { AuditVerificationResult } from '../models';
 // @ts-ignore
 import type { EnrichedAuditLog } from '../models';
@@ -32,6 +34,40 @@ import type { SearchByAuditLogRequest } from '../models';
  */
 export const CollaborationAuditControllerApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
+         * @summary Last scheduled audit chain verification
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        auditIntegrityStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/audit/verify/status`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
          * @summary Get audit trail for a resource (enriched with actor azp)
@@ -157,6 +193,18 @@ export const CollaborationAuditControllerApiAxiosParamCreator = function (config
 export const CollaborationAuditControllerApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CollaborationAuditControllerApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
+         * @summary Last scheduled audit chain verification
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async auditIntegrityStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditIntegrityStatusResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.auditIntegrityStatus(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CollaborationAuditControllerApi.auditIntegrityStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
          * @summary Get audit trail for a resource (enriched with actor azp)
@@ -205,6 +253,15 @@ export const CollaborationAuditControllerApiFp = function(configuration?: Config
 export const CollaborationAuditControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = CollaborationAuditControllerApiFp(configuration)
     return {
+        /**
+         * Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
+         * @summary Last scheduled audit chain verification
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        auditIntegrityStatus(options?: RawAxiosRequestConfig): AxiosPromise<AuditIntegrityStatusResponse> {
+            return localVarFp.auditIntegrityStatus(options).then((request) => request(axios, basePath));
+        },
         /**
          * EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
          * @summary Get audit trail for a resource (enriched with actor azp)
@@ -242,6 +299,16 @@ export const CollaborationAuditControllerApiFactory = function (configuration?:
  * CollaborationAuditControllerApi - object-oriented interface
  */
 export class CollaborationAuditControllerApi extends BaseAPI {
+    /**
+     * Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
+     * @summary Last scheduled audit chain verification
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public auditIntegrityStatus(options?: RawAxiosRequestConfig) {
+        return CollaborationAuditControllerApiFp(this.configuration).auditIntegrityStatus(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
      * @summary Get audit trail for a resource (enriched with actor azp)

package/api/document-controller-api.ts

@@ -30,6 +30,8 @@ import type { DeleteMetadataRequest } from '../models';
 // @ts-ignore
 import type { DocumentInfo } from '../models';
 // @ts-ignore
+import type { DocumentIntegrityRecord } from '../models';
+// @ts-ignore
 import type { DocumentPosition } from '../models';
 // @ts-ignore
 import type { ElementInfo } from '../models';
@@ -335,6 +337,44 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDocumentIntegrity: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('getDocumentIntegrity', 'documentId', documentId)
+            const localVarPath = `/api/v1/documents/{documentId}/integrity`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -826,6 +866,19 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentInfo']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DocumentIntegrityRecord>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentIntegrity(documentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentIntegrity']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -1026,6 +1079,16 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
         getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo> {
             return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+         * @summary Get a document\'s integrity ledger
+         * @param {string} documentId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DocumentIntegrityRecord>> {
+            return localVarFp.getDocumentIntegrity(documentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves metadata for a document. Can filter by keys.
          * @summary Search metadata of a document
@@ -1207,6 +1270,17 @@ export class DocumentControllerApi extends BaseAPI {
         return DocumentControllerApiFp(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+     * @summary Get a document\'s integrity ledger
+     * @param {string} documentId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig) {
+        return DocumentControllerApiFp(this.configuration).getDocumentIntegrity(documentId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Retrieves metadata for a document. Can filter by keys.
      * @summary Search metadata of a document