@openfilz-sdk/typescript-ee 1.14.5 → 1.14.7

package/dist/esm/api/notifications-api.js

@@ -32,8 +32,8 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
 export const NotificationsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Retrieve all notifications for the authenticated user
-         * @summary Get all notifications
+         * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
+         * @summary Get notifications
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -187,8 +187,8 @@ export const NotificationsApiFp = function (configuration) {
     const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration);
     return {
         /**
-         * Retrieve all notifications for the authenticated user
-         * @summary Get all notifications
+         * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
+         * @summary Get notifications
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -271,8 +271,8 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
     const localVarFp = NotificationsApiFp(configuration);
     return {
         /**
-         * Retrieve all notifications for the authenticated user
-         * @summary Get all notifications
+         * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
+         * @summary Get notifications
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -323,8 +323,8 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
  */
 export class NotificationsApi extends BaseAPI {
     /**
-     * Retrieve all notifications for the authenticated user
-     * @summary Get all notifications
+     * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
+     * @summary Get notifications
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */

package/dist/esm/models/index.d.ts

@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
 export * from './mcp-agent-token-config';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './mention-access-item';
+export * from './mention-access-preview';
+export * from './mention-access-request';
 export * from './merge-request';
 export * from './merge-source';
 export * from './metadata-key-suggestion';

package/dist/esm/models/index.js

@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
 export * from './mcp-agent-token-config';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './mention-access-item';
+export * from './mention-access-preview';
+export * from './mention-access-request';
 export * from './merge-request';
 export * from './merge-source';
 export * from './metadata-key-suggestion';

package/dist/esm/models/mention-access-item.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+export interface MentionAccessItem {
+    'docId'?: string;
+    'docName'?: string;
+    'userId'?: string;
+    'userName'?: string;
+    'userEmail'?: string;
+    'canRead'?: boolean;
+    'action'?: MentionAccessItemActionEnum;
+}
+export declare const MentionAccessItemActionEnum: {
+    readonly Share: "SHARE";
+    readonly Upgrade: "UPGRADE";
+    readonly RequestShare: "REQUEST_SHARE";
+    readonly RequestUpgrade: "REQUEST_UPGRADE";
+    readonly NotLicensed: "NOT_LICENSED";
+    readonly NotAllowed: "NOT_ALLOWED";
+};
+export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];

package/dist/esm/models/mention-access-item.js

@@ -0,0 +1,21 @@
+/* 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.
+ */
+export const MentionAccessItemActionEnum = {
+    Share: 'SHARE',
+    Upgrade: 'UPGRADE',
+    RequestShare: 'REQUEST_SHARE',
+    RequestUpgrade: 'REQUEST_UPGRADE',
+    NotLicensed: 'NOT_LICENSED',
+    NotAllowed: 'NOT_ALLOWED',
+};

package/dist/esm/models/mention-access-preview.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { MentionAccessItem } from './mention-access-item';
+export interface MentionAccessPreview {
+    'items'?: Array<MentionAccessItem>;
+}

package/dist/esm/models/mention-access-preview.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/mention-access-request.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export interface MentionAccessRequest {
+    /**
+     * Document IDs the comment is saved on (at most 200)
+     */
+    'docIds': Set<string>;
+    /**
+     * User IDs mentioned in the comment (at most 100)
+     */
+    'mentionedUserIds': Set<string>;
+}

package/dist/esm/models/mention-access-request.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/models/index.d.ts

@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
 export * from './mcp-agent-token-config';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './mention-access-item';
+export * from './mention-access-preview';
+export * from './mention-access-request';
 export * from './merge-request';
 export * from './merge-source';
 export * from './metadata-key-suggestion';

package/dist/models/index.js

@@ -125,6 +125,9 @@ __exportStar(require("./list-ai-models-request"), exports);
 __exportStar(require("./mcp-agent-token-config"), exports);
 __exportStar(require("./mcp-agent-token-info"), exports);
 __exportStar(require("./mcp-agent-token-response"), exports);
+__exportStar(require("./mention-access-item"), exports);
+__exportStar(require("./mention-access-preview"), exports);
+__exportStar(require("./mention-access-request"), exports);
 __exportStar(require("./merge-request"), exports);
 __exportStar(require("./merge-source"), exports);
 __exportStar(require("./metadata-key-suggestion"), exports);

package/dist/models/mention-access-item.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+export interface MentionAccessItem {
+    'docId'?: string;
+    'docName'?: string;
+    'userId'?: string;
+    'userName'?: string;
+    'userEmail'?: string;
+    'canRead'?: boolean;
+    'action'?: MentionAccessItemActionEnum;
+}
+export declare const MentionAccessItemActionEnum: {
+    readonly Share: "SHARE";
+    readonly Upgrade: "UPGRADE";
+    readonly RequestShare: "REQUEST_SHARE";
+    readonly RequestUpgrade: "REQUEST_UPGRADE";
+    readonly NotLicensed: "NOT_LICENSED";
+    readonly NotAllowed: "NOT_ALLOWED";
+};
+export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];

package/dist/models/mention-access-item.js

@@ -0,0 +1,24 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MentionAccessItemActionEnum = void 0;
+exports.MentionAccessItemActionEnum = {
+    Share: 'SHARE',
+    Upgrade: 'UPGRADE',
+    RequestShare: 'REQUEST_SHARE',
+    RequestUpgrade: 'REQUEST_UPGRADE',
+    NotLicensed: 'NOT_LICENSED',
+    NotAllowed: 'NOT_ALLOWED',
+};

package/dist/models/mention-access-preview.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { MentionAccessItem } from './mention-access-item';
+export interface MentionAccessPreview {
+    'items'?: Array<MentionAccessItem>;
+}

package/dist/models/mention-access-preview.js

@@ -0,0 +1,15 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/mention-access-request.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export interface MentionAccessRequest {
+    /**
+     * Document IDs the comment is saved on (at most 200)
+     */
+    'docIds': Set<string>;
+    /**
+     * User IDs mentioned in the comment (at most 100)
+     */
+    'mentionedUserIds': Set<string>;
+}

package/dist/models/mention-access-request.js

@@ -0,0 +1,15 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/CollaborationControllerApi.md

@@ -389,7 +389,7 @@ const { status, data } = await apiInstance.deleteSharedDocuments(
 # **deleteTeam**
 > deleteTeam()
 
-Deletes a team. Requires ADMIN_USERS role.
+Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
 
 ### Example
 

package/docs/CommentsApi.md

@@ -6,6 +6,8 @@ All URIs are relative to *http://localhost:8081*
 |------------- | ------------- | -------------|
 |[**createComment**](#createcomment) | **POST** /api/v1/documents/comments | Create a comment|
 |[**deleteComment**](#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment|
+|[**grantMentionAccess**](#grantmentionaccess) | **POST** /api/v1/documents/comments/mention-access/grant | Give mentioned users comment access|
+|[**previewMentionAccess**](#previewmentionaccess) | **POST** /api/v1/documents/comments/mention-access | Preview comment access for mentioned users|
 |[**updateComment**](#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment|
 
 # **createComment**
@@ -104,6 +106,110 @@ void (empty response body)
  - **Accept**: Not defined
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **grantMentionAccess**
+> ShareResultResponse grantMentionAccess(mentionAccessRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    CommentsApi,
+    Configuration,
+    MentionAccessRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CommentsApi(configuration);
+
+let mentionAccessRequest: MentionAccessRequest; //
+
+const { status, data } = await apiInstance.grantMentionAccess(
+    mentionAccessRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mentionAccessRequest** | **MentionAccessRequest**|  | |
+
+
+### Return type
+
+**ShareResultResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **previewMentionAccess**
+> MentionAccessPreview previewMentionAccess(mentionAccessRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    CommentsApi,
+    Configuration,
+    MentionAccessRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CommentsApi(configuration);
+
+let mentionAccessRequest: MentionAccessRequest; //
+
+const { status, data } = await apiInstance.previewMentionAccess(
+    mentionAccessRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mentionAccessRequest** | **MentionAccessRequest**|  | |
+
+
+### Return type
+
+**MentionAccessPreview**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/MentionAccessItem.md

@@ -0,0 +1,32 @@
+# MentionAccessItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**docId** | **string** |  | [optional] [default to undefined]
+**docName** | **string** |  | [optional] [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+**userName** | **string** |  | [optional] [default to undefined]
+**userEmail** | **string** |  | [optional] [default to undefined]
+**canRead** | **boolean** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MentionAccessItem } from '@openfilz-sdk/typescript-ee';
+
+const instance: MentionAccessItem = {
+    docId,
+    docName,
+    userId,
+    userName,
+    userEmail,
+    canRead,
+    action,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MentionAccessPreview.md

@@ -0,0 +1,20 @@
+# MentionAccessPreview
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<MentionAccessItem>**](MentionAccessItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MentionAccessPreview } from '@openfilz-sdk/typescript-ee';
+
+const instance: MentionAccessPreview = {
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MentionAccessRequest.md

@@ -0,0 +1,22 @@
+# MentionAccessRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**docIds** | **Set<string>** | Document IDs the comment is saved on (at most 200) | [default to undefined]
+**mentionedUserIds** | **Set<string>** | User IDs mentioned in the comment (at most 100) | [default to undefined]
+
+## Example
+
+```typescript
+import { MentionAccessRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: MentionAccessRequest = {
+    docIds,
+    mentionedUserIds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationsApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getNotifications**](#getnotifications) | **GET** /api/v1/notifications | Get all notifications|
+|[**getNotifications**](#getnotifications) | **GET** /api/v1/notifications | Get notifications|
 |[**getUnreadCount**](#getunreadcount) | **GET** /api/v1/notifications/unread/count | Get unread notification count|
 |[**markAllAsRead**](#markallasread) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read|
 |[**markAsRead**](#markasread) | **PUT** /api/v1/notifications/{id}/read | Mark notification as read|
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8081*
 # **getNotifications**
 > Array<NotificationDTO> getNotifications()
 
-Retrieve all notifications for the authenticated user
+The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
 
 ### Example
 

package/models/index.ts

@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
 export * from './mcp-agent-token-config';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './mention-access-item';
+export * from './mention-access-preview';
+export * from './mention-access-request';
 export * from './merge-request';
 export * from './merge-source';
 export * from './metadata-key-suggestion';

package/models/mention-access-item.ts

@@ -0,0 +1,38 @@
+/* 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.
+ */
+
+
+
+export interface MentionAccessItem {
+    'docId'?: string;
+    'docName'?: string;
+    'userId'?: string;
+    'userName'?: string;
+    'userEmail'?: string;
+    'canRead'?: boolean;
+    'action'?: MentionAccessItemActionEnum;
+}
+
+export const MentionAccessItemActionEnum = {
+    Share: 'SHARE',
+    Upgrade: 'UPGRADE',
+    RequestShare: 'REQUEST_SHARE',
+    RequestUpgrade: 'REQUEST_UPGRADE',
+    NotLicensed: 'NOT_LICENSED',
+    NotAllowed: 'NOT_ALLOWED',
+} as const;
+
+export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];
+
+

package/models/mention-access-preview.ts

@@ -0,0 +1,23 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MentionAccessItem } from './mention-access-item';
+
+export interface MentionAccessPreview {
+    'items'?: Array<MentionAccessItem>;
+}
+

package/models/mention-access-request.ts

@@ -0,0 +1,27 @@
+/* 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.
+ */
+
+
+
+export interface MentionAccessRequest {
+    /**
+     * Document IDs the comment is saved on (at most 200)
+     */
+    'docIds': Set<string>;
+    /**
+     * User IDs mentioned in the comment (at most 100)
+     */
+    'mentionedUserIds': Set<string>;
+}
+