@openfilz-sdk/typescript-ee 1.12.17 → 1.12.18

package/api/sharing-api.ts

@@ -0,0 +1,210 @@
+/* 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 { ShareInheritance } from '../models';
+// @ts-ignore
+import type { ShareInheritanceRequest } from '../models';
+/**
+ * SharingApi - axios parameter creator
+ */
+export const SharingApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Does the document receive the shares of its ancestors?
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getShareInheritance: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            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, 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,
+            };
+        },
+        /**
+         * 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: async (id: string, shareInheritanceRequest: ShareInheritanceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('setShareInheritance', 'id', id)
+            // verify required parameter 'shareInheritanceRequest' is not null or undefined
+            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, 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(shareInheritanceRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SharingApi - functional programming interface
+ */
+export const SharingApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SharingApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Does the document receive the shares of its ancestors?
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getShareInheritance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareInheritance>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getShareInheritance(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharingApi.getShareInheritance']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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}
+         */
+        async setShareInheritance(id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareInheritance>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setShareInheritance(id, shareInheritanceRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharingApi.setShareInheritance']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * SharingApi - factory interface
+ */
+export const SharingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = 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: string, options?: RawAxiosRequestConfig): AxiosPromise<ShareInheritance> {
+            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: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareInheritance> {
+            return localVarFp.setShareInheritance(id, shareInheritanceRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * SharingApi - object-oriented interface
+ */
+export 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}
+     */
+    public getShareInheritance(id: string, options?: RawAxiosRequestConfig) {
+        return 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}
+     */
+    public setShareInheritance(id: string, shareInheritanceRequest: ShareInheritanceRequest, options?: RawAxiosRequestConfig) {
+        return SharingApiFp(this.configuration).setShareInheritance(id, shareInheritanceRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api.ts

@@ -51,6 +51,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';
@@ -58,6 +59,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';