@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/dist/api/archive-controller-api.d.ts

@@ -0,0 +1,239 @@
+/**
+ * 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 { ArchivePreflight } from '../models';
+/**
+ * ArchiveControllerApi - axios parameter creator
+ */
+export declare const ArchiveControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * ArchiveControllerApi - functional programming interface
+ */
+export declare const ArchiveControllerApiFp: (configuration?: Configuration) => {
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArchivePreflight>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+};
+/**
+ * ArchiveControllerApi - factory interface
+ */
+export declare const ArchiveControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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;
+    }>;
+    /**
+     * 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;
+    }>;
+    /**
+     * 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>;
+    /**
+     * 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;
+    }>;
+    /**
+     * 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;
+    }>;
+};
+/**
+ * ArchiveControllerApi - object-oriented interface
+ */
+export declare 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}
+     */
+    archive(documentId: string, onBehalfOf?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}, any>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}, any>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ArchivePreflight, any, {}, any>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}, any>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}, any>>;
+}