@openfilz-sdk/typescript-ee 1.12.17 → 1.12.18

package/dist/api/sharing-api.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { ShareInheritance } from '../models';
+import type { ShareInheritanceRequest } from '../models';
+/**
+ * SharingApi - axios parameter creator
+ */
+export declare const SharingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Does the document receive the shares of its ancestors?
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShareInheritance: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+     * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+     * @param {string} id
+     * @param {ShareInheritanceRequest} shareInheritanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setShareInheritance: (id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SharingApi - functional programming interface
+ */
+export declare const SharingApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Does the document receive the shares of its ancestors?
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShareInheritance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareInheritance>>;
+    /**
+     * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+     * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+     * @param {string} id
+     * @param {ShareInheritanceRequest} shareInheritanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setShareInheritance(id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareInheritance>>;
+};
+/**
+ * SharingApi - factory interface
+ */
+export declare const SharingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Does the document receive the shares of its ancestors?
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShareInheritance(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ShareInheritance>;
+    /**
+     * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+     * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+     * @param {string} id
+     * @param {ShareInheritanceRequest} shareInheritanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setShareInheritance(id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareInheritance>;
+};
+/**
+ * SharingApi - object-oriented interface
+ */
+export declare class SharingApi extends BaseAPI {
+    /**
+     *
+     * @summary Does the document receive the shares of its ancestors?
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShareInheritance(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareInheritance, any, {}, any>>;
+    /**
+     * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+     * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+     * @param {string} id
+     * @param {ShareInheritanceRequest} shareInheritanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setShareInheritance(id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareInheritance, any, {}, any>>;
+}

package/dist/api/sharing-api.js

@@ -0,0 +1,209 @@
+"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.SharingApi = exports.SharingApiFactory = exports.SharingApiFp = exports.SharingApiAxiosParamCreator = 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");
+/**
+ * SharingApi - axios parameter creator
+ */
+const SharingApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Does the document receive the shares of its ancestors?
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getShareInheritance: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('getShareInheritance', 'id', id);
+            const localVarPath = `/api/v1/documents/{id}/share-inheritance`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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,
+            };
+        }),
+        /**
+         * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+         * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+         * @param {string} id
+         * @param {ShareInheritanceRequest} shareInheritanceRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setShareInheritance: (id_1, shareInheritanceRequest_1, ...args_1) => __awaiter(this, [id_1, shareInheritanceRequest_1, ...args_1], void 0, function* (id, shareInheritanceRequest, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('setShareInheritance', 'id', id);
+            // verify required parameter 'shareInheritanceRequest' is not null or undefined
+            (0, common_1.assertParamExists)('setShareInheritance', 'shareInheritanceRequest', shareInheritanceRequest);
+            const localVarPath = `/api/v1/users/share/inheritance/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            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);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(shareInheritanceRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.SharingApiAxiosParamCreator = SharingApiAxiosParamCreator;
+/**
+ * SharingApi - functional programming interface
+ */
+const SharingApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.SharingApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Does the document receive the shares of its ancestors?
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getShareInheritance(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getShareInheritance(id, 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['SharingApi.getShareInheritance']) === 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);
+            });
+        },
+        /**
+         * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+         * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+         * @param {string} id
+         * @param {ShareInheritanceRequest} shareInheritanceRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setShareInheritance(id, shareInheritanceRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setShareInheritance(id, shareInheritanceRequest, 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['SharingApi.setShareInheritance']) === 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.SharingApiFp = SharingApiFp;
+/**
+ * SharingApi - factory interface
+ */
+const SharingApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.SharingApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Does the document receive the shares of its ancestors?
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getShareInheritance(id, options) {
+            return localVarFp.getShareInheritance(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+         * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+         * @param {string} id
+         * @param {ShareInheritanceRequest} shareInheritanceRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setShareInheritance(id, shareInheritanceRequest, options) {
+            return localVarFp.setShareInheritance(id, shareInheritanceRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.SharingApiFactory = SharingApiFactory;
+/**
+ * SharingApi - object-oriented interface
+ */
+class SharingApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Does the document receive the shares of its ancestors?
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShareInheritance(id, options) {
+        return (0, exports.SharingApiFp)(this.configuration).getShareInheritance(id, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+     * @summary Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares
+     * @param {string} id
+     * @param {ShareInheritanceRequest} shareInheritanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setShareInheritance(id, shareInheritanceRequest, options) {
+        return (0, exports.SharingApiFp)(this.configuration).setShareInheritance(id, shareInheritanceRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.SharingApi = SharingApi;

package/dist/api.d.ts

@@ -46,6 +46,7 @@ export * from './api/mcp-discovery-controller-api';
 export * from './api/mcp-token-admin-controller-api';
 export * from './api/notifications-api';
 export * from './api/organisation-settings-api';
+export * from './api/ownership-api';
 export * from './api/pdftools-api';
 export * from './api/quota-administration-api';
 export * from './api/quotas-api';
@@ -53,6 +54,7 @@ export * from './api/scan-agent-api';
 export * from './api/scanner-proxy-api';
 export * from './api/search-administration-api';
 export * from './api/settings-api';
+export * from './api/sharing-api';
 export * from './api/smart-filing-api';
 export * from './api/storage-encryption-administration-api';
 export * from './api/tus-controller-api';

package/dist/api.js

@@ -64,6 +64,7 @@ __exportStar(require("./api/mcp-discovery-controller-api"), exports);
 __exportStar(require("./api/mcp-token-admin-controller-api"), exports);
 __exportStar(require("./api/notifications-api"), exports);
 __exportStar(require("./api/organisation-settings-api"), exports);
+__exportStar(require("./api/ownership-api"), exports);
 __exportStar(require("./api/pdftools-api"), exports);
 __exportStar(require("./api/quota-administration-api"), exports);
 __exportStar(require("./api/quotas-api"), exports);
@@ -71,6 +72,7 @@ __exportStar(require("./api/scan-agent-api"), exports);
 __exportStar(require("./api/scanner-proxy-api"), exports);
 __exportStar(require("./api/search-administration-api"), exports);
 __exportStar(require("./api/settings-api"), exports);
+__exportStar(require("./api/sharing-api"), exports);
 __exportStar(require("./api/smart-filing-api"), exports);
 __exportStar(require("./api/storage-encryption-administration-api"), exports);
 __exportStar(require("./api/tus-controller-api"), exports);