@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
@@ -211,6 +211,9 @@ docs/McpAgentTokenInfo.md
211
211
  docs/McpAgentTokenResponse.md
212
212
  docs/McpDiscoveryControllerApi.md
213
213
  docs/McpTokenAdminControllerApi.md
214
+ docs/MentionAccessItem.md
215
+ docs/MentionAccessPreview.md
216
+ docs/MentionAccessRequest.md
214
217
  docs/MergeRequest.md
215
218
  docs/MergeSource.md
216
219
  docs/MetadataKeyControllerApi.md
@@ -498,6 +501,9 @@ models/list-ai-models-request.ts
498
501
  models/mcp-agent-token-config.ts
499
502
  models/mcp-agent-token-info.ts
500
503
  models/mcp-agent-token-response.ts
504
+ models/mention-access-item.ts
505
+ models/mention-access-preview.ts
506
+ models/mention-access-request.ts
501
507
  models/merge-request.ts
502
508
  models/merge-source.ts
503
509
  models/metadata-key-suggestion.ts
@@ -1 +1 @@
1
- f934993d994e1399aefd36e15e29a9546e6005d5afa7c057ce2d970dbababce0
1
+ e314baf547051c02a7a055fd51c85629232ae4a88aae0c8f071625539563c9f7
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.14.6
1
+ ## @openfilz-sdk/typescript-ee@1.14.7
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript-ee@1.14.6 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.14.7 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -126,6 +126,8 @@ Class | Method | HTTP request | Description
126
126
  *CollaborationControllerApi* | [**updateUser**](docs/CollaborationControllerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update a user
127
127
  *CommentsApi* | [**createComment**](docs/CommentsApi.md#createcomment) | **POST** /api/v1/documents/comments | Create a comment
128
128
  *CommentsApi* | [**deleteComment**](docs/CommentsApi.md#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment
129
+ *CommentsApi* | [**grantMentionAccess**](docs/CommentsApi.md#grantmentionaccess) | **POST** /api/v1/documents/comments/mention-access/grant | Give mentioned users comment access
130
+ *CommentsApi* | [**previewMentionAccess**](docs/CommentsApi.md#previewmentionaccess) | **POST** /api/v1/documents/comments/mention-access | Preview comment access for mentioned users
129
131
  *CommentsApi* | [**updateComment**](docs/CommentsApi.md#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment
130
132
  *DashboardApi* | [**getDashboardStatistics**](docs/DashboardApi.md#getdashboardstatistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics
131
133
  *DelegatedBrowseGrantsAdminApi* | [**browseFolders**](docs/DelegatedBrowseGrantsAdminApi.md#browsefolders) | **GET** /api/v1/admin/delegated/folders | Browse folders on behalf of the grantor
@@ -479,6 +481,9 @@ Class | Method | HTTP request | Description
479
481
  - [McpAgentTokenConfig](docs/McpAgentTokenConfig.md)
480
482
  - [McpAgentTokenInfo](docs/McpAgentTokenInfo.md)
481
483
  - [McpAgentTokenResponse](docs/McpAgentTokenResponse.md)
484
+ - [MentionAccessItem](docs/MentionAccessItem.md)
485
+ - [MentionAccessPreview](docs/MentionAccessPreview.md)
486
+ - [MentionAccessRequest](docs/MentionAccessRequest.md)
482
487
  - [MergeRequest](docs/MergeRequest.md)
483
488
  - [MergeSource](docs/MergeSource.md)
484
489
  - [MetadataKeySuggestion](docs/MetadataKeySuggestion.md)
@@ -26,6 +26,12 @@ import type { CommentDTO } from '../models';
26
26
  // @ts-ignore
27
27
  import type { CreateCommentRequest } from '../models';
28
28
  // @ts-ignore
29
+ import type { MentionAccessPreview } from '../models';
30
+ // @ts-ignore
31
+ import type { MentionAccessRequest } from '../models';
32
+ // @ts-ignore
33
+ import type { ShareResultResponse } from '../models';
34
+ // @ts-ignore
29
35
  import type { UpdateCommentRequest } from '../models';
30
36
  /**
31
37
  * CommentsApi - axios parameter creator
@@ -108,6 +114,84 @@ export const CommentsApiAxiosParamCreator = function (configuration?: Configurat
108
114
  options: localVarRequestOptions,
109
115
  };
110
116
  },
117
+ /**
118
+ * 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.
119
+ * @summary Give mentioned users comment access
120
+ * @param {MentionAccessRequest} mentionAccessRequest
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ */
124
+ grantMentionAccess: async (mentionAccessRequest: MentionAccessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
125
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
126
+ assertParamExists('grantMentionAccess', 'mentionAccessRequest', mentionAccessRequest)
127
+ const localVarPath = `/api/v1/documents/comments/mention-access/grant`;
128
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
129
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
130
+ let baseOptions;
131
+ if (configuration) {
132
+ baseOptions = configuration.baseOptions;
133
+ }
134
+
135
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
136
+ const localVarHeaderParameter = {} as any;
137
+ const localVarQueryParameter = {} as any;
138
+
139
+ // authentication keycloak_auth required
140
+ // http bearer authentication required
141
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
142
+
143
+ localVarHeaderParameter['Content-Type'] = 'application/json';
144
+ localVarHeaderParameter['Accept'] = 'application/json';
145
+
146
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
147
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
148
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
149
+ localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration)
150
+
151
+ return {
152
+ url: toPathString(localVarUrlObj),
153
+ options: localVarRequestOptions,
154
+ };
155
+ },
156
+ /**
157
+ * 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.
158
+ * @summary Preview comment access for mentioned users
159
+ * @param {MentionAccessRequest} mentionAccessRequest
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ previewMentionAccess: async (mentionAccessRequest: MentionAccessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
164
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
165
+ assertParamExists('previewMentionAccess', 'mentionAccessRequest', mentionAccessRequest)
166
+ const localVarPath = `/api/v1/documents/comments/mention-access`;
167
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
168
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
169
+ let baseOptions;
170
+ if (configuration) {
171
+ baseOptions = configuration.baseOptions;
172
+ }
173
+
174
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
175
+ const localVarHeaderParameter = {} as any;
176
+ const localVarQueryParameter = {} as any;
177
+
178
+ // authentication keycloak_auth required
179
+ // http bearer authentication required
180
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
181
+
182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
183
+ localVarHeaderParameter['Accept'] = 'application/json';
184
+
185
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
186
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
188
+ localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration)
189
+
190
+ return {
191
+ url: toPathString(localVarUrlObj),
192
+ options: localVarRequestOptions,
193
+ };
194
+ },
111
195
  /**
112
196
  * Update an existing comment. Only the comment creator can update their comment.
113
197
  * @summary Update a comment
@@ -186,6 +270,32 @@ export const CommentsApiFp = function(configuration?: Configuration) {
186
270
  const localVarOperationServerBasePath = operationServerMap['CommentsApi.deleteComment']?.[localVarOperationServerIndex]?.url;
187
271
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
188
272
  },
273
+ /**
274
+ * 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.
275
+ * @summary Give mentioned users comment access
276
+ * @param {MentionAccessRequest} mentionAccessRequest
277
+ * @param {*} [options] Override http request option.
278
+ * @throws {RequiredError}
279
+ */
280
+ async grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>> {
281
+ const localVarAxiosArgs = await localVarAxiosParamCreator.grantMentionAccess(mentionAccessRequest, options);
282
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
283
+ const localVarOperationServerBasePath = operationServerMap['CommentsApi.grantMentionAccess']?.[localVarOperationServerIndex]?.url;
284
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
285
+ },
286
+ /**
287
+ * 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.
288
+ * @summary Preview comment access for mentioned users
289
+ * @param {MentionAccessRequest} mentionAccessRequest
290
+ * @param {*} [options] Override http request option.
291
+ * @throws {RequiredError}
292
+ */
293
+ async previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionAccessPreview>> {
294
+ const localVarAxiosArgs = await localVarAxiosParamCreator.previewMentionAccess(mentionAccessRequest, options);
295
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
296
+ const localVarOperationServerBasePath = operationServerMap['CommentsApi.previewMentionAccess']?.[localVarOperationServerIndex]?.url;
297
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
298
+ },
189
299
  /**
190
300
  * Update an existing comment. Only the comment creator can update their comment.
191
301
  * @summary Update a comment
@@ -229,6 +339,26 @@ export const CommentsApiFactory = function (configuration?: Configuration, baseP
229
339
  deleteComment(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
230
340
  return localVarFp.deleteComment(id, options).then((request) => request(axios, basePath));
231
341
  },
342
+ /**
343
+ * 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.
344
+ * @summary Give mentioned users comment access
345
+ * @param {MentionAccessRequest} mentionAccessRequest
346
+ * @param {*} [options] Override http request option.
347
+ * @throws {RequiredError}
348
+ */
349
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse> {
350
+ return localVarFp.grantMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
351
+ },
352
+ /**
353
+ * 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.
354
+ * @summary Preview comment access for mentioned users
355
+ * @param {MentionAccessRequest} mentionAccessRequest
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<MentionAccessPreview> {
360
+ return localVarFp.previewMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
361
+ },
232
362
  /**
233
363
  * Update an existing comment. Only the comment creator can update their comment.
234
364
  * @summary Update a comment
@@ -269,6 +399,28 @@ export class CommentsApi extends BaseAPI {
269
399
  return CommentsApiFp(this.configuration).deleteComment(id, options).then((request) => request(this.axios, this.basePath));
270
400
  }
271
401
 
402
+ /**
403
+ * 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.
404
+ * @summary Give mentioned users comment access
405
+ * @param {MentionAccessRequest} mentionAccessRequest
406
+ * @param {*} [options] Override http request option.
407
+ * @throws {RequiredError}
408
+ */
409
+ public grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) {
410
+ return CommentsApiFp(this.configuration).grantMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
411
+ }
412
+
413
+ /**
414
+ * 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.
415
+ * @summary Preview comment access for mentioned users
416
+ * @param {MentionAccessRequest} mentionAccessRequest
417
+ * @param {*} [options] Override http request option.
418
+ * @throws {RequiredError}
419
+ */
420
+ public previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) {
421
+ return CommentsApiFp(this.configuration).previewMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
422
+ }
423
+
272
424
  /**
273
425
  * Update an existing comment. Only the comment creator can update their comment.
274
426
  * @summary Update a comment
@@ -14,6 +14,9 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { CommentDTO } from '../models';
16
16
  import type { CreateCommentRequest } from '../models';
17
+ import type { MentionAccessPreview } from '../models';
18
+ import type { MentionAccessRequest } from '../models';
19
+ import type { ShareResultResponse } from '../models';
17
20
  import type { UpdateCommentRequest } from '../models';
18
21
  /**
19
22
  * CommentsApi - axios parameter creator
@@ -35,6 +38,22 @@ export declare const CommentsApiAxiosParamCreator: (configuration?: Configuratio
35
38
  * @throws {RequiredError}
36
39
  */
37
40
  deleteComment: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ * 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.
43
+ * @summary Give mentioned users comment access
44
+ * @param {MentionAccessRequest} mentionAccessRequest
45
+ * @param {*} [options] Override http request option.
46
+ * @throws {RequiredError}
47
+ */
48
+ grantMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
49
+ /**
50
+ * 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.
51
+ * @summary Preview comment access for mentioned users
52
+ * @param {MentionAccessRequest} mentionAccessRequest
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ previewMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
57
  /**
39
58
  * Update an existing comment. Only the comment creator can update their comment.
40
59
  * @summary Update a comment
@@ -65,6 +84,22 @@ export declare const CommentsApiFp: (configuration?: Configuration) => {
65
84
  * @throws {RequiredError}
66
85
  */
67
86
  deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
87
+ /**
88
+ * 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.
89
+ * @summary Give mentioned users comment access
90
+ * @param {MentionAccessRequest} mentionAccessRequest
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
95
+ /**
96
+ * 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.
97
+ * @summary Preview comment access for mentioned users
98
+ * @param {MentionAccessRequest} mentionAccessRequest
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionAccessPreview>>;
68
103
  /**
69
104
  * Update an existing comment. Only the comment creator can update their comment.
70
105
  * @summary Update a comment
@@ -95,6 +130,22 @@ export declare const CommentsApiFactory: (configuration?: Configuration, basePat
95
130
  * @throws {RequiredError}
96
131
  */
97
132
  deleteComment(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
133
+ /**
134
+ * 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.
135
+ * @summary Give mentioned users comment access
136
+ * @param {MentionAccessRequest} mentionAccessRequest
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
141
+ /**
142
+ * 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.
143
+ * @summary Preview comment access for mentioned users
144
+ * @param {MentionAccessRequest} mentionAccessRequest
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<MentionAccessPreview>;
98
149
  /**
99
150
  * Update an existing comment. Only the comment creator can update their comment.
100
151
  * @summary Update a comment
@@ -125,6 +176,22 @@ export declare class CommentsApi extends BaseAPI {
125
176
  * @throws {RequiredError}
126
177
  */
127
178
  deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
179
+ /**
180
+ * 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.
181
+ * @summary Give mentioned users comment access
182
+ * @param {MentionAccessRequest} mentionAccessRequest
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}, any>>;
187
+ /**
188
+ * 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.
189
+ * @summary Preview comment access for mentioned users
190
+ * @param {MentionAccessRequest} mentionAccessRequest
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MentionAccessPreview, any, {}, any>>;
128
195
  /**
129
196
  * Update an existing comment. Only the comment creator can update their comment.
130
197
  * @summary Update a comment
@@ -100,6 +100,74 @@ const CommentsApiAxiosParamCreator = function (configuration) {
100
100
  options: localVarRequestOptions,
101
101
  };
102
102
  }),
103
+ /**
104
+ * 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.
105
+ * @summary Give mentioned users comment access
106
+ * @param {MentionAccessRequest} mentionAccessRequest
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ grantMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
111
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
112
+ (0, common_1.assertParamExists)('grantMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
113
+ const localVarPath = `/api/v1/documents/comments/mention-access/grant`;
114
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
115
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
116
+ let baseOptions;
117
+ if (configuration) {
118
+ baseOptions = configuration.baseOptions;
119
+ }
120
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
121
+ const localVarHeaderParameter = {};
122
+ const localVarQueryParameter = {};
123
+ // authentication keycloak_auth required
124
+ // http bearer authentication required
125
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
126
+ localVarHeaderParameter['Content-Type'] = 'application/json';
127
+ localVarHeaderParameter['Accept'] = 'application/json';
128
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
129
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
130
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
131
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mentionAccessRequest, localVarRequestOptions, configuration);
132
+ return {
133
+ url: (0, common_1.toPathString)(localVarUrlObj),
134
+ options: localVarRequestOptions,
135
+ };
136
+ }),
137
+ /**
138
+ * 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.
139
+ * @summary Preview comment access for mentioned users
140
+ * @param {MentionAccessRequest} mentionAccessRequest
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ previewMentionAccess: (mentionAccessRequest_1, ...args_1) => __awaiter(this, [mentionAccessRequest_1, ...args_1], void 0, function* (mentionAccessRequest, options = {}) {
145
+ // verify required parameter 'mentionAccessRequest' is not null or undefined
146
+ (0, common_1.assertParamExists)('previewMentionAccess', 'mentionAccessRequest', mentionAccessRequest);
147
+ const localVarPath = `/api/v1/documents/comments/mention-access`;
148
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
149
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
150
+ let baseOptions;
151
+ if (configuration) {
152
+ baseOptions = configuration.baseOptions;
153
+ }
154
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
155
+ const localVarHeaderParameter = {};
156
+ const localVarQueryParameter = {};
157
+ // authentication keycloak_auth required
158
+ // http bearer authentication required
159
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
160
+ localVarHeaderParameter['Content-Type'] = 'application/json';
161
+ localVarHeaderParameter['Accept'] = 'application/json';
162
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
163
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
164
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
165
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mentionAccessRequest, localVarRequestOptions, configuration);
166
+ return {
167
+ url: (0, common_1.toPathString)(localVarUrlObj),
168
+ options: localVarRequestOptions,
169
+ };
170
+ }),
103
171
  /**
104
172
  * Update an existing comment. Only the comment creator can update their comment.
105
173
  * @summary Update a comment
@@ -179,6 +247,38 @@ const CommentsApiFp = function (configuration) {
179
247
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
180
248
  });
181
249
  },
250
+ /**
251
+ * 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.
252
+ * @summary Give mentioned users comment access
253
+ * @param {MentionAccessRequest} mentionAccessRequest
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ grantMentionAccess(mentionAccessRequest, options) {
258
+ return __awaiter(this, void 0, void 0, function* () {
259
+ var _a, _b, _c;
260
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.grantMentionAccess(mentionAccessRequest, options);
261
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
262
+ 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;
263
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
264
+ });
265
+ },
266
+ /**
267
+ * 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.
268
+ * @summary Preview comment access for mentioned users
269
+ * @param {MentionAccessRequest} mentionAccessRequest
270
+ * @param {*} [options] Override http request option.
271
+ * @throws {RequiredError}
272
+ */
273
+ previewMentionAccess(mentionAccessRequest, options) {
274
+ return __awaiter(this, void 0, void 0, function* () {
275
+ var _a, _b, _c;
276
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.previewMentionAccess(mentionAccessRequest, options);
277
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
278
+ 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;
279
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
280
+ });
281
+ },
182
282
  /**
183
283
  * Update an existing comment. Only the comment creator can update their comment.
184
284
  * @summary Update a comment
@@ -225,6 +325,26 @@ const CommentsApiFactory = function (configuration, basePath, axios) {
225
325
  deleteComment(id, options) {
226
326
  return localVarFp.deleteComment(id, options).then((request) => request(axios, basePath));
227
327
  },
328
+ /**
329
+ * 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.
330
+ * @summary Give mentioned users comment access
331
+ * @param {MentionAccessRequest} mentionAccessRequest
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ grantMentionAccess(mentionAccessRequest, options) {
336
+ return localVarFp.grantMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
337
+ },
338
+ /**
339
+ * 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.
340
+ * @summary Preview comment access for mentioned users
341
+ * @param {MentionAccessRequest} mentionAccessRequest
342
+ * @param {*} [options] Override http request option.
343
+ * @throws {RequiredError}
344
+ */
345
+ previewMentionAccess(mentionAccessRequest, options) {
346
+ return localVarFp.previewMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
347
+ },
228
348
  /**
229
349
  * Update an existing comment. Only the comment creator can update their comment.
230
350
  * @summary Update a comment
@@ -263,6 +383,26 @@ class CommentsApi extends base_1.BaseAPI {
263
383
  deleteComment(id, options) {
264
384
  return (0, exports.CommentsApiFp)(this.configuration).deleteComment(id, options).then((request) => request(this.axios, this.basePath));
265
385
  }
386
+ /**
387
+ * 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.
388
+ * @summary Give mentioned users comment access
389
+ * @param {MentionAccessRequest} mentionAccessRequest
390
+ * @param {*} [options] Override http request option.
391
+ * @throws {RequiredError}
392
+ */
393
+ grantMentionAccess(mentionAccessRequest, options) {
394
+ return (0, exports.CommentsApiFp)(this.configuration).grantMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
395
+ }
396
+ /**
397
+ * 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.
398
+ * @summary Preview comment access for mentioned users
399
+ * @param {MentionAccessRequest} mentionAccessRequest
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ */
403
+ previewMentionAccess(mentionAccessRequest, options) {
404
+ return (0, exports.CommentsApiFp)(this.configuration).previewMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
405
+ }
266
406
  /**
267
407
  * Update an existing comment. Only the comment creator can update their comment.
268
408
  * @summary Update a comment
@@ -14,6 +14,9 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { CommentDTO } from '../models';
16
16
  import type { CreateCommentRequest } from '../models';
17
+ import type { MentionAccessPreview } from '../models';
18
+ import type { MentionAccessRequest } from '../models';
19
+ import type { ShareResultResponse } from '../models';
17
20
  import type { UpdateCommentRequest } from '../models';
18
21
  /**
19
22
  * CommentsApi - axios parameter creator
@@ -35,6 +38,22 @@ export declare const CommentsApiAxiosParamCreator: (configuration?: Configuratio
35
38
  * @throws {RequiredError}
36
39
  */
37
40
  deleteComment: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ * 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.
43
+ * @summary Give mentioned users comment access
44
+ * @param {MentionAccessRequest} mentionAccessRequest
45
+ * @param {*} [options] Override http request option.
46
+ * @throws {RequiredError}
47
+ */
48
+ grantMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
49
+ /**
50
+ * 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.
51
+ * @summary Preview comment access for mentioned users
52
+ * @param {MentionAccessRequest} mentionAccessRequest
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ previewMentionAccess: (mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
57
  /**
39
58
  * Update an existing comment. Only the comment creator can update their comment.
40
59
  * @summary Update a comment
@@ -65,6 +84,22 @@ export declare const CommentsApiFp: (configuration?: Configuration) => {
65
84
  * @throws {RequiredError}
66
85
  */
67
86
  deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
87
+ /**
88
+ * 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.
89
+ * @summary Give mentioned users comment access
90
+ * @param {MentionAccessRequest} mentionAccessRequest
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
95
+ /**
96
+ * 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.
97
+ * @summary Preview comment access for mentioned users
98
+ * @param {MentionAccessRequest} mentionAccessRequest
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionAccessPreview>>;
68
103
  /**
69
104
  * Update an existing comment. Only the comment creator can update their comment.
70
105
  * @summary Update a comment
@@ -95,6 +130,22 @@ export declare const CommentsApiFactory: (configuration?: Configuration, basePat
95
130
  * @throws {RequiredError}
96
131
  */
97
132
  deleteComment(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
133
+ /**
134
+ * 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.
135
+ * @summary Give mentioned users comment access
136
+ * @param {MentionAccessRequest} mentionAccessRequest
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
141
+ /**
142
+ * 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.
143
+ * @summary Preview comment access for mentioned users
144
+ * @param {MentionAccessRequest} mentionAccessRequest
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<MentionAccessPreview>;
98
149
  /**
99
150
  * Update an existing comment. Only the comment creator can update their comment.
100
151
  * @summary Update a comment
@@ -125,6 +176,22 @@ export declare class CommentsApi extends BaseAPI {
125
176
  * @throws {RequiredError}
126
177
  */
127
178
  deleteComment(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
179
+ /**
180
+ * 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.
181
+ * @summary Give mentioned users comment access
182
+ * @param {MentionAccessRequest} mentionAccessRequest
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}, any>>;
187
+ /**
188
+ * 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.
189
+ * @summary Preview comment access for mentioned users
190
+ * @param {MentionAccessRequest} mentionAccessRequest
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MentionAccessPreview, any, {}, any>>;
128
195
  /**
129
196
  * Update an existing comment. Only the comment creator can update their comment.
130
197
  * @summary Update a comment