@openfilz-sdk/typescript-ee 1.14.6 → 1.14.8

package/dist/api/collaboration-controller-api.js

@@ -105,7 +105,7 @@ const CollaborationControllerApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
+         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user  Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
          * @summary Create Share for document(s)
          * @param {ShareRequest} shareRequest
          * @param {*} [options] Override http request option.
@@ -434,6 +434,40 @@ const CollaborationControllerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
+         * @summary Set, change or remove the end date of share(s)
+         * @param {ShareExpiryRequest} shareExpiryRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateShareExpiry: (shareExpiryRequest_1, ...args_1) => __awaiter(this, [shareExpiryRequest_1, ...args_1], void 0, function* (shareExpiryRequest, options = {}) {
+            // verify required parameter 'shareExpiryRequest' is not null or undefined
+            (0, common_1.assertParamExists)('updateShareExpiry', 'shareExpiryRequest', shareExpiryRequest);
+            const localVarPath = `/api/v1/users/share/expiry`;
+            // 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)(shareExpiryRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
          * @summary Update Share for document(s)
@@ -585,7 +619,7 @@ const CollaborationControllerApiFp = function (configuration) {
             });
         },
         /**
-         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
+         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user  Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
          * @summary Create Share for document(s)
          * @param {ShareRequest} shareRequest
          * @param {*} [options] Override http request option.
@@ -744,6 +778,22 @@ const CollaborationControllerApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
+         * @summary Set, change or remove the end date of share(s)
+         * @param {ShareExpiryRequest} shareExpiryRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateShareExpiry(shareExpiryRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateShareExpiry(shareExpiryRequest, 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['CollaborationControllerApi.updateShareExpiry']) === 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);
+            });
+        },
         /**
          * Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
          * @summary Update Share for document(s)
@@ -825,7 +875,7 @@ const CollaborationControllerApiFactory = function (configuration, basePath, axi
             return localVarFp.addTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
+         * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user  Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
          * @summary Create Share for document(s)
          * @param {ShareRequest} shareRequest
          * @param {*} [options] Override http request option.
@@ -924,6 +974,16 @@ const CollaborationControllerApiFactory = function (configuration, basePath, axi
         removeTeamMembers(teamId, requestBody, options) {
             return localVarFp.removeTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
+         * @summary Set, change or remove the end date of share(s)
+         * @param {ShareExpiryRequest} shareExpiryRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateShareExpiry(shareExpiryRequest, options) {
+            return localVarFp.updateShareExpiry(shareExpiryRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
          * @summary Update Share for document(s)
@@ -985,7 +1045,7 @@ class CollaborationControllerApi extends base_1.BaseAPI {
         return (0, exports.CollaborationControllerApiFp)(this.configuration).addTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
+     * Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user  Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
      * @summary Create Share for document(s)
      * @param {ShareRequest} shareRequest
      * @param {*} [options] Override http request option.
@@ -1084,6 +1144,16 @@ class CollaborationControllerApi extends base_1.BaseAPI {
     removeTeamMembers(teamId, requestBody, options) {
         return (0, exports.CollaborationControllerApiFp)(this.configuration).removeTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
+     * @summary Set, change or remove the end date of share(s)
+     * @param {ShareExpiryRequest} shareExpiryRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateShareExpiry(shareExpiryRequest, options) {
+        return (0, exports.CollaborationControllerApiFp)(this.configuration).updateShareExpiry(shareExpiryRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
      * @summary Update Share for document(s)

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

@@ -14,6 +14,9 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { CommentDTO } from '../models';
 import type { CreateCommentRequest } from '../models';
+import type { MentionAccessPreview } from '../models';
+import type { MentionAccessRequest } from '../models';
+import type { ShareResultResponse } from '../models';
 import type { UpdateCommentRequest } from '../models';
 /**
  * CommentsApi - axios parameter creator
@@ -35,6 +38,22 @@ export declare const CommentsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteComment: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+     * @summary Give mentioned users comment access
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+     * @summary Preview comment access for mentioned users
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update an existing comment. Only the comment creator can update their comment.
      * @summary Update a comment
@@ -65,6 +84,22 @@ export declare const CommentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+     * @summary Give mentioned users comment access
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
+    /**
+     * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+     * @summary Preview comment access for mentioned users
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionAccessPreview>>;
     /**
      * Update an existing comment. Only the comment creator can update their comment.
      * @summary Update a comment
@@ -95,6 +130,22 @@ export declare const CommentsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteComment(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+     * @summary Give mentioned users comment access
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
+    /**
+     * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+     * @summary Preview comment access for mentioned users
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<MentionAccessPreview>;
     /**
      * Update an existing comment. Only the comment creator can update their comment.
      * @summary Update a comment
@@ -125,6 +176,22 @@ export declare class CommentsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+     * @summary Give mentioned users comment access
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}, any>>;
+    /**
+     * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+     * @summary Preview comment access for mentioned users
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MentionAccessPreview, any, {}, any>>;
     /**
      * Update an existing comment. Only the comment creator can update their comment.
      * @summary Update a comment

package/dist/api/comments-api.js

@@ -100,6 +100,74 @@ const CommentsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+         * @summary Give mentioned users comment access
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        grantMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
+            // verify required parameter 'mentionAccessRequest' is not null or undefined
+            (0, common_1.assertParamExists)('grantMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
+            const localVarPath = `/api/v1/documents/comments/mention-access/grant`;
+            // 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['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (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)(mentionAccessRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+         * @summary Preview comment access for mentioned users
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        previewMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
+            // verify required parameter 'mentionAccessRequest' is not null or undefined
+            (0, common_1.assertParamExists)('previewMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
+            const localVarPath = `/api/v1/documents/comments/mention-access`;
+            // 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['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (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)(mentionAccessRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Update an existing comment. Only the comment creator can update their comment.
          * @summary Update a comment
@@ -179,6 +247,38 @@ const CommentsApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+         * @summary Give mentioned users comment access
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        grantMentionAccess(mentionAccessRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.grantMentionAccess(mentionAccessRequest, 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['CommentsApi.grantMentionAccess']) === 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 the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+         * @summary Preview comment access for mentioned users
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        previewMentionAccess(mentionAccessRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.previewMentionAccess(mentionAccessRequest, 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['CommentsApi.previewMentionAccess']) === 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);
+            });
+        },
         /**
          * Update an existing comment. Only the comment creator can update their comment.
          * @summary Update a comment
@@ -225,6 +325,26 @@ const CommentsApiFactory = function (configuration, basePath, axios) {
         deleteComment(id, options) {
             return localVarFp.deleteComment(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+         * @summary Give mentioned users comment access
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        grantMentionAccess(mentionAccessRequest, options) {
+            return localVarFp.grantMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+         * @summary Preview comment access for mentioned users
+         * @param {MentionAccessRequest} mentionAccessRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        previewMentionAccess(mentionAccessRequest, options) {
+            return localVarFp.previewMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update an existing comment. Only the comment creator can update their comment.
          * @summary Update a comment
@@ -263,6 +383,26 @@ class CommentsApi extends base_1.BaseAPI {
     deleteComment(id, options) {
         return (0, exports.CommentsApiFp)(this.configuration).deleteComment(id, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
+     * @summary Give mentioned users comment access
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantMentionAccess(mentionAccessRequest, options) {
+        return (0, exports.CommentsApiFp)(this.configuration).grantMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
+     * @summary Preview comment access for mentioned users
+     * @param {MentionAccessRequest} mentionAccessRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewMentionAccess(mentionAccessRequest, options) {
+        return (0, exports.CommentsApiFp)(this.configuration).previewMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update an existing comment. Only the comment creator can update their comment.
      * @summary Update a comment

package/dist/api.d.ts

@@ -18,6 +18,7 @@ export * from './api/aimaintenance-api';
 export * from './api/aisettings-api';
 export * from './api/aitaxonomy-api';
 export * from './api/aiteam-inboxes-api';
+export * from './api/access-requests-api';
 export * from './api/ai-analytics-admin-controller-api';
 export * from './api/ai-archiving-admin-controller-api';
 export * from './api/ai-cloud-usage-admin-controller-api';

package/dist/api.js

@@ -36,6 +36,7 @@ __exportStar(require("./api/aimaintenance-api"), exports);
 __exportStar(require("./api/aisettings-api"), exports);
 __exportStar(require("./api/aitaxonomy-api"), exports);
 __exportStar(require("./api/aiteam-inboxes-api"), exports);
+__exportStar(require("./api/access-requests-api"), exports);
 __exportStar(require("./api/ai-analytics-admin-controller-api"), exports);
 __exportStar(require("./api/ai-archiving-admin-controller-api"), exports);
 __exportStar(require("./api/ai-cloud-usage-admin-controller-api"), exports);

package/dist/esm/api/access-requests-api.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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 { AccessRequestInput } from '../models';
+import type { AccessRequestStatus } from '../models';
+/**
+ * AccessRequestsApi - axios parameter creator
+ */
+export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
+     * @summary Can I open this document, or ask for it?
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myAccessToDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
+     * @summary Ask the owner for access
+     * @param {AccessRequestInput} accessRequestInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAccess: (accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AccessRequestsApi - functional programming interface
+ */
+export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
+    /**
+     * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
+     * @summary Can I open this document, or ask for it?
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
+    /**
+     * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
+     * @summary Ask the owner for access
+     * @param {AccessRequestInput} accessRequestInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
+};
+/**
+ * AccessRequestsApi - factory interface
+ */
+export declare const AccessRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
+     * @summary Can I open this document, or ask for it?
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
+    /**
+     * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
+     * @summary Ask the owner for access
+     * @param {AccessRequestInput} accessRequestInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
+};
+/**
+ * AccessRequestsApi - object-oriented interface
+ */
+export declare class AccessRequestsApi extends BaseAPI {
+    /**
+     * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
+     * @summary Can I open this document, or ask for it?
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
+    /**
+     * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
+     * @summary Ask the owner for access
+     * @param {AccessRequestInput} accessRequestInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
+}