@openfilz-sdk/typescript-ee 1.14.6 → 1.14.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +7 -2
  4. package/api/comments-api.ts +152 -0
  5. package/dist/api/comments-api.d.ts +67 -0
  6. package/dist/api/comments-api.js +140 -0
  7. package/dist/esm/api/comments-api.d.ts +67 -0
  8. package/dist/esm/api/comments-api.js +140 -0
  9. package/dist/esm/models/index.d.ts +3 -0
  10. package/dist/esm/models/index.js +3 -0
  11. package/dist/esm/models/mention-access-item.d.ts +29 -0
  12. package/dist/esm/models/mention-access-item.js +21 -0
  13. package/dist/esm/models/mention-access-preview.d.ts +15 -0
  14. package/dist/esm/models/mention-access-preview.js +14 -0
  15. package/dist/esm/models/mention-access-request.d.ts +21 -0
  16. package/dist/esm/models/mention-access-request.js +14 -0
  17. package/dist/models/index.d.ts +3 -0
  18. package/dist/models/index.js +3 -0
  19. package/dist/models/mention-access-item.d.ts +29 -0
  20. package/dist/models/mention-access-item.js +24 -0
  21. package/dist/models/mention-access-preview.d.ts +15 -0
  22. package/dist/models/mention-access-preview.js +15 -0
  23. package/dist/models/mention-access-request.d.ts +21 -0
  24. package/dist/models/mention-access-request.js +15 -0
  25. package/docs/CommentsApi.md +106 -0
  26. package/docs/MentionAccessItem.md +32 -0
  27. package/docs/MentionAccessPreview.md +20 -0
  28. package/docs/MentionAccessRequest.md +22 -0
  29. package/models/index.ts +3 -0
  30. package/models/mention-access-item.ts +38 -0
  31. package/models/mention-access-preview.ts +23 -0
  32. package/models/mention-access-request.ts +27 -0
  33. package/package.json +1 -1
@@ -97,6 +97,74 @@ export const CommentsApiAxiosParamCreator = function (configuration) {
97
97
  options: localVarRequestOptions,
98
98
  };
99
99
  }),
100
+ /**
101
+ * 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.
102
+ * @summary Give mentioned users comment access
103
+ * @param {MentionAccessRequest} mentionAccessRequest
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ grantMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
108
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
109
+ assertParamExists('grantMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
110
+ const localVarPath = `/api/v1/documents/comments/mention-access/grant`;
111
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
112
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
113
+ let baseOptions;
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ }
117
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
118
+ const localVarHeaderParameter = {};
119
+ const localVarQueryParameter = {};
120
+ // authentication keycloak_auth required
121
+ // http bearer authentication required
122
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
123
+ localVarHeaderParameter['Content-Type'] = 'application/json';
124
+ localVarHeaderParameter['Accept'] = 'application/json';
125
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
126
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
127
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
128
+ localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration);
129
+ return {
130
+ url: toPathString(localVarUrlObj),
131
+ options: localVarRequestOptions,
132
+ };
133
+ }),
134
+ /**
135
+ * 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.
136
+ * @summary Preview comment access for mentioned users
137
+ * @param {MentionAccessRequest} mentionAccessRequest
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ previewMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
142
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
143
+ assertParamExists('previewMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
144
+ const localVarPath = `/api/v1/documents/comments/mention-access`;
145
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
146
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
147
+ let baseOptions;
148
+ if (configuration) {
149
+ baseOptions = configuration.baseOptions;
150
+ }
151
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
152
+ const localVarHeaderParameter = {};
153
+ const localVarQueryParameter = {};
154
+ // authentication keycloak_auth required
155
+ // http bearer authentication required
156
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
157
+ localVarHeaderParameter['Content-Type'] = 'application/json';
158
+ localVarHeaderParameter['Accept'] = 'application/json';
159
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
160
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
161
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
162
+ localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration);
163
+ return {
164
+ url: toPathString(localVarUrlObj),
165
+ options: localVarRequestOptions,
166
+ };
167
+ }),
100
168
  /**
101
169
  * Update an existing comment. Only the comment creator can update their comment.
102
170
  * @summary Update a comment
@@ -175,6 +243,38 @@ export const CommentsApiFp = function (configuration) {
175
243
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
176
244
  });
177
245
  },
246
+ /**
247
+ * 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.
248
+ * @summary Give mentioned users comment access
249
+ * @param {MentionAccessRequest} mentionAccessRequest
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ */
253
+ grantMentionAccess(mentionAccessRequest, options) {
254
+ return __awaiter(this, void 0, void 0, function* () {
255
+ var _a, _b, _c;
256
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.grantMentionAccess(mentionAccessRequest, options);
257
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
258
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CommentsApi.grantMentionAccess']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
259
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
260
+ });
261
+ },
262
+ /**
263
+ * 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.
264
+ * @summary Preview comment access for mentioned users
265
+ * @param {MentionAccessRequest} mentionAccessRequest
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ previewMentionAccess(mentionAccessRequest, options) {
270
+ return __awaiter(this, void 0, void 0, function* () {
271
+ var _a, _b, _c;
272
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.previewMentionAccess(mentionAccessRequest, options);
273
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
274
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CommentsApi.previewMentionAccess']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
275
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
276
+ });
277
+ },
178
278
  /**
179
279
  * Update an existing comment. Only the comment creator can update their comment.
180
280
  * @summary Update a comment
@@ -220,6 +320,26 @@ export const CommentsApiFactory = function (configuration, basePath, axios) {
220
320
  deleteComment(id, options) {
221
321
  return localVarFp.deleteComment(id, options).then((request) => request(axios, basePath));
222
322
  },
323
+ /**
324
+ * 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.
325
+ * @summary Give mentioned users comment access
326
+ * @param {MentionAccessRequest} mentionAccessRequest
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ */
330
+ grantMentionAccess(mentionAccessRequest, options) {
331
+ return localVarFp.grantMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
332
+ },
333
+ /**
334
+ * 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.
335
+ * @summary Preview comment access for mentioned users
336
+ * @param {MentionAccessRequest} mentionAccessRequest
337
+ * @param {*} [options] Override http request option.
338
+ * @throws {RequiredError}
339
+ */
340
+ previewMentionAccess(mentionAccessRequest, options) {
341
+ return localVarFp.previewMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
342
+ },
223
343
  /**
224
344
  * Update an existing comment. Only the comment creator can update their comment.
225
345
  * @summary Update a comment
@@ -257,6 +377,26 @@ export class CommentsApi extends BaseAPI {
257
377
  deleteComment(id, options) {
258
378
  return CommentsApiFp(this.configuration).deleteComment(id, options).then((request) => request(this.axios, this.basePath));
259
379
  }
380
+ /**
381
+ * 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.
382
+ * @summary Give mentioned users comment access
383
+ * @param {MentionAccessRequest} mentionAccessRequest
384
+ * @param {*} [options] Override http request option.
385
+ * @throws {RequiredError}
386
+ */
387
+ grantMentionAccess(mentionAccessRequest, options) {
388
+ return CommentsApiFp(this.configuration).grantMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
389
+ }
390
+ /**
391
+ * 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.
392
+ * @summary Preview comment access for mentioned users
393
+ * @param {MentionAccessRequest} mentionAccessRequest
394
+ * @param {*} [options] Override http request option.
395
+ * @throws {RequiredError}
396
+ */
397
+ previewMentionAccess(mentionAccessRequest, options) {
398
+ return CommentsApiFp(this.configuration).previewMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
399
+ }
260
400
  /**
261
401
  * Update an existing comment. Only the comment creator can update their comment.
262
402
  * @summary Update a comment
@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
109
109
  export * from './mcp-agent-token-config';
110
110
  export * from './mcp-agent-token-info';
111
111
  export * from './mcp-agent-token-response';
112
+ export * from './mention-access-item';
113
+ export * from './mention-access-preview';
114
+ export * from './mention-access-request';
112
115
  export * from './merge-request';
113
116
  export * from './merge-source';
114
117
  export * from './metadata-key-suggestion';
@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
109
109
  export * from './mcp-agent-token-config';
110
110
  export * from './mcp-agent-token-info';
111
111
  export * from './mcp-agent-token-response';
112
+ export * from './mention-access-item';
113
+ export * from './mention-access-preview';
114
+ export * from './mention-access-request';
112
115
  export * from './merge-request';
113
116
  export * from './merge-source';
114
117
  export * from './metadata-key-suggestion';
@@ -0,0 +1,29 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface MentionAccessItem {
13
+ 'docId'?: string;
14
+ 'docName'?: string;
15
+ 'userId'?: string;
16
+ 'userName'?: string;
17
+ 'userEmail'?: string;
18
+ 'canRead'?: boolean;
19
+ 'action'?: MentionAccessItemActionEnum;
20
+ }
21
+ export declare const MentionAccessItemActionEnum: {
22
+ readonly Share: "SHARE";
23
+ readonly Upgrade: "UPGRADE";
24
+ readonly RequestShare: "REQUEST_SHARE";
25
+ readonly RequestUpgrade: "REQUEST_UPGRADE";
26
+ readonly NotLicensed: "NOT_LICENSED";
27
+ readonly NotAllowed: "NOT_ALLOWED";
28
+ };
29
+ export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];
@@ -0,0 +1,21 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const MentionAccessItemActionEnum = {
15
+ Share: 'SHARE',
16
+ Upgrade: 'UPGRADE',
17
+ RequestShare: 'REQUEST_SHARE',
18
+ RequestUpgrade: 'REQUEST_UPGRADE',
19
+ NotLicensed: 'NOT_LICENSED',
20
+ NotAllowed: 'NOT_ALLOWED',
21
+ };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { MentionAccessItem } from './mention-access-item';
13
+ export interface MentionAccessPreview {
14
+ 'items'?: Array<MentionAccessItem>;
15
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,21 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface MentionAccessRequest {
13
+ /**
14
+ * Document IDs the comment is saved on (at most 200)
15
+ */
16
+ 'docIds': Set<string>;
17
+ /**
18
+ * User IDs mentioned in the comment (at most 100)
19
+ */
20
+ 'mentionedUserIds': Set<string>;
21
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -109,6 +109,9 @@ export * from './list-ai-models-request';
109
109
  export * from './mcp-agent-token-config';
110
110
  export * from './mcp-agent-token-info';
111
111
  export * from './mcp-agent-token-response';
112
+ export * from './mention-access-item';
113
+ export * from './mention-access-preview';
114
+ export * from './mention-access-request';
112
115
  export * from './merge-request';
113
116
  export * from './merge-source';
114
117
  export * from './metadata-key-suggestion';
@@ -125,6 +125,9 @@ __exportStar(require("./list-ai-models-request"), exports);
125
125
  __exportStar(require("./mcp-agent-token-config"), exports);
126
126
  __exportStar(require("./mcp-agent-token-info"), exports);
127
127
  __exportStar(require("./mcp-agent-token-response"), exports);
128
+ __exportStar(require("./mention-access-item"), exports);
129
+ __exportStar(require("./mention-access-preview"), exports);
130
+ __exportStar(require("./mention-access-request"), exports);
128
131
  __exportStar(require("./merge-request"), exports);
129
132
  __exportStar(require("./merge-source"), exports);
130
133
  __exportStar(require("./metadata-key-suggestion"), exports);
@@ -0,0 +1,29 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface MentionAccessItem {
13
+ 'docId'?: string;
14
+ 'docName'?: string;
15
+ 'userId'?: string;
16
+ 'userName'?: string;
17
+ 'userEmail'?: string;
18
+ 'canRead'?: boolean;
19
+ 'action'?: MentionAccessItemActionEnum;
20
+ }
21
+ export declare const MentionAccessItemActionEnum: {
22
+ readonly Share: "SHARE";
23
+ readonly Upgrade: "UPGRADE";
24
+ readonly RequestShare: "REQUEST_SHARE";
25
+ readonly RequestUpgrade: "REQUEST_UPGRADE";
26
+ readonly NotLicensed: "NOT_LICENSED";
27
+ readonly NotAllowed: "NOT_ALLOWED";
28
+ };
29
+ export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MentionAccessItemActionEnum = void 0;
17
+ exports.MentionAccessItemActionEnum = {
18
+ Share: 'SHARE',
19
+ Upgrade: 'UPGRADE',
20
+ RequestShare: 'REQUEST_SHARE',
21
+ RequestUpgrade: 'REQUEST_UPGRADE',
22
+ NotLicensed: 'NOT_LICENSED',
23
+ NotAllowed: 'NOT_ALLOWED',
24
+ };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { MentionAccessItem } from './mention-access-item';
13
+ export interface MentionAccessPreview {
14
+ 'items'?: Array<MentionAccessItem>;
15
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,21 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface MentionAccessRequest {
13
+ /**
14
+ * Document IDs the comment is saved on (at most 200)
15
+ */
16
+ 'docIds': Set<string>;
17
+ /**
18
+ * User IDs mentioned in the comment (at most 100)
19
+ */
20
+ 'mentionedUserIds': Set<string>;
21
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -6,6 +6,8 @@ All URIs are relative to *http://localhost:8081*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createComment**](#createcomment) | **POST** /api/v1/documents/comments | Create a comment|
8
8
  |[**deleteComment**](#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment|
9
+ |[**grantMentionAccess**](#grantmentionaccess) | **POST** /api/v1/documents/comments/mention-access/grant | Give mentioned users comment access|
10
+ |[**previewMentionAccess**](#previewmentionaccess) | **POST** /api/v1/documents/comments/mention-access | Preview comment access for mentioned users|
9
11
  |[**updateComment**](#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment|
10
12
 
11
13
  # **createComment**
@@ -104,6 +106,110 @@ void (empty response body)
104
106
  - **Accept**: Not defined
105
107
 
106
108
 
109
+ ### HTTP response details
110
+ | Status code | Description | Response headers |
111
+ |-------------|-------------|------------------|
112
+ |**200** | OK | - |
113
+
114
+ [[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)
115
+
116
+ # **grantMentionAccess**
117
+ > ShareResultResponse grantMentionAccess(mentionAccessRequest)
118
+
119
+ 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.
120
+
121
+ ### Example
122
+
123
+ ```typescript
124
+ import {
125
+ CommentsApi,
126
+ Configuration,
127
+ MentionAccessRequest
128
+ } from '@openfilz-sdk/typescript-ee';
129
+
130
+ const configuration = new Configuration();
131
+ const apiInstance = new CommentsApi(configuration);
132
+
133
+ let mentionAccessRequest: MentionAccessRequest; //
134
+
135
+ const { status, data } = await apiInstance.grantMentionAccess(
136
+ mentionAccessRequest
137
+ );
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ |Name | Type | Description | Notes|
143
+ |------------- | ------------- | ------------- | -------------|
144
+ | **mentionAccessRequest** | **MentionAccessRequest**| | |
145
+
146
+
147
+ ### Return type
148
+
149
+ **ShareResultResponse**
150
+
151
+ ### Authorization
152
+
153
+ [keycloak_auth](../README.md#keycloak_auth)
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: application/json
158
+ - **Accept**: application/json
159
+
160
+
161
+ ### HTTP response details
162
+ | Status code | Description | Response headers |
163
+ |-------------|-------------|------------------|
164
+ |**200** | OK | - |
165
+
166
+ [[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)
167
+
168
+ # **previewMentionAccess**
169
+ > MentionAccessPreview previewMentionAccess(mentionAccessRequest)
170
+
171
+ 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.
172
+
173
+ ### Example
174
+
175
+ ```typescript
176
+ import {
177
+ CommentsApi,
178
+ Configuration,
179
+ MentionAccessRequest
180
+ } from '@openfilz-sdk/typescript-ee';
181
+
182
+ const configuration = new Configuration();
183
+ const apiInstance = new CommentsApi(configuration);
184
+
185
+ let mentionAccessRequest: MentionAccessRequest; //
186
+
187
+ const { status, data } = await apiInstance.previewMentionAccess(
188
+ mentionAccessRequest
189
+ );
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ |Name | Type | Description | Notes|
195
+ |------------- | ------------- | ------------- | -------------|
196
+ | **mentionAccessRequest** | **MentionAccessRequest**| | |
197
+
198
+
199
+ ### Return type
200
+
201
+ **MentionAccessPreview**
202
+
203
+ ### Authorization
204
+
205
+ [keycloak_auth](../README.md#keycloak_auth)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
107
213
  ### HTTP response details
108
214
  | Status code | Description | Response headers |
109
215
  |-------------|-------------|------------------|
@@ -0,0 +1,32 @@
1
+ # MentionAccessItem
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **docId** | **string** | | [optional] [default to undefined]
9
+ **docName** | **string** | | [optional] [default to undefined]
10
+ **userId** | **string** | | [optional] [default to undefined]
11
+ **userName** | **string** | | [optional] [default to undefined]
12
+ **userEmail** | **string** | | [optional] [default to undefined]
13
+ **canRead** | **boolean** | | [optional] [default to undefined]
14
+ **action** | **string** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { MentionAccessItem } from '@openfilz-sdk/typescript-ee';
20
+
21
+ const instance: MentionAccessItem = {
22
+ docId,
23
+ docName,
24
+ userId,
25
+ userName,
26
+ userEmail,
27
+ canRead,
28
+ action,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # MentionAccessPreview
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array&lt;MentionAccessItem&gt;**](MentionAccessItem.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { MentionAccessPreview } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: MentionAccessPreview = {
16
+ items,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # MentionAccessRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **docIds** | **Set&lt;string&gt;** | Document IDs the comment is saved on (at most 200) | [default to undefined]
9
+ **mentionedUserIds** | **Set&lt;string&gt;** | User IDs mentioned in the comment (at most 100) | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { MentionAccessRequest } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: MentionAccessRequest = {
17
+ docIds,
18
+ mentionedUserIds,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)