@openfilz-sdk/typescript-ee 1.14.5 → 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 (45) 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 +8 -3
  4. package/api/collaboration-controller-api.ts +4 -4
  5. package/api/comments-api.ts +152 -0
  6. package/api/notifications-api.ts +8 -8
  7. package/dist/api/collaboration-controller-api.d.ts +4 -4
  8. package/dist/api/collaboration-controller-api.js +4 -4
  9. package/dist/api/comments-api.d.ts +67 -0
  10. package/dist/api/comments-api.js +140 -0
  11. package/dist/api/notifications-api.d.ts +8 -8
  12. package/dist/api/notifications-api.js +8 -8
  13. package/dist/esm/api/collaboration-controller-api.d.ts +4 -4
  14. package/dist/esm/api/collaboration-controller-api.js +4 -4
  15. package/dist/esm/api/comments-api.d.ts +67 -0
  16. package/dist/esm/api/comments-api.js +140 -0
  17. package/dist/esm/api/notifications-api.d.ts +8 -8
  18. package/dist/esm/api/notifications-api.js +8 -8
  19. package/dist/esm/models/index.d.ts +3 -0
  20. package/dist/esm/models/index.js +3 -0
  21. package/dist/esm/models/mention-access-item.d.ts +29 -0
  22. package/dist/esm/models/mention-access-item.js +21 -0
  23. package/dist/esm/models/mention-access-preview.d.ts +15 -0
  24. package/dist/esm/models/mention-access-preview.js +14 -0
  25. package/dist/esm/models/mention-access-request.d.ts +21 -0
  26. package/dist/esm/models/mention-access-request.js +14 -0
  27. package/dist/models/index.d.ts +3 -0
  28. package/dist/models/index.js +3 -0
  29. package/dist/models/mention-access-item.d.ts +29 -0
  30. package/dist/models/mention-access-item.js +24 -0
  31. package/dist/models/mention-access-preview.d.ts +15 -0
  32. package/dist/models/mention-access-preview.js +15 -0
  33. package/dist/models/mention-access-request.d.ts +21 -0
  34. package/dist/models/mention-access-request.js +15 -0
  35. package/docs/CollaborationControllerApi.md +1 -1
  36. package/docs/CommentsApi.md +106 -0
  37. package/docs/MentionAccessItem.md +32 -0
  38. package/docs/MentionAccessPreview.md +20 -0
  39. package/docs/MentionAccessRequest.md +22 -0
  40. package/docs/NotificationsApi.md +2 -2
  41. package/models/index.ts +3 -0
  42. package/models/mention-access-item.ts +38 -0
  43. package/models/mention-access-preview.ts +23 -0
  44. package/models/mention-access-request.ts +27 -0
  45. package/package.json +1 -1
@@ -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
@@ -18,8 +18,8 @@ import type { NotificationDTO } from '../models';
18
18
  */
19
19
  export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * Retrieve all notifications for the authenticated user
22
- * @summary Get all notifications
21
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
22
+ * @summary Get notifications
23
23
  * @param {*} [options] Override http request option.
24
24
  * @throws {RequiredError}
25
25
  */
@@ -59,8 +59,8 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
59
59
  */
60
60
  export declare const NotificationsApiFp: (configuration?: Configuration) => {
61
61
  /**
62
- * Retrieve all notifications for the authenticated user
63
- * @summary Get all notifications
62
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
63
+ * @summary Get notifications
64
64
  * @param {*} [options] Override http request option.
65
65
  * @throws {RequiredError}
66
66
  */
@@ -100,8 +100,8 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
100
100
  */
101
101
  export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
102
102
  /**
103
- * Retrieve all notifications for the authenticated user
104
- * @summary Get all notifications
103
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
104
+ * @summary Get notifications
105
105
  * @param {*} [options] Override http request option.
106
106
  * @throws {RequiredError}
107
107
  */
@@ -141,8 +141,8 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
141
141
  */
142
142
  export declare class NotificationsApi extends BaseAPI {
143
143
  /**
144
- * Retrieve all notifications for the authenticated user
145
- * @summary Get all notifications
144
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
145
+ * @summary Get notifications
146
146
  * @param {*} [options] Override http request option.
147
147
  * @throws {RequiredError}
148
148
  */
@@ -35,8 +35,8 @@ const base_1 = require("../base");
35
35
  const NotificationsApiAxiosParamCreator = function (configuration) {
36
36
  return {
37
37
  /**
38
- * Retrieve all notifications for the authenticated user
39
- * @summary Get all notifications
38
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
39
+ * @summary Get notifications
40
40
  * @param {*} [options] Override http request option.
41
41
  * @throws {RequiredError}
42
42
  */
@@ -191,8 +191,8 @@ const NotificationsApiFp = function (configuration) {
191
191
  const localVarAxiosParamCreator = (0, exports.NotificationsApiAxiosParamCreator)(configuration);
192
192
  return {
193
193
  /**
194
- * Retrieve all notifications for the authenticated user
195
- * @summary Get all notifications
194
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
195
+ * @summary Get notifications
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
@@ -276,8 +276,8 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
276
276
  const localVarFp = (0, exports.NotificationsApiFp)(configuration);
277
277
  return {
278
278
  /**
279
- * Retrieve all notifications for the authenticated user
280
- * @summary Get all notifications
279
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
280
+ * @summary Get notifications
281
281
  * @param {*} [options] Override http request option.
282
282
  * @throws {RequiredError}
283
283
  */
@@ -329,8 +329,8 @@ exports.NotificationsApiFactory = NotificationsApiFactory;
329
329
  */
330
330
  class NotificationsApi extends base_1.BaseAPI {
331
331
  /**
332
- * Retrieve all notifications for the authenticated user
333
- * @summary Get all notifications
332
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
333
+ * @summary Get notifications
334
334
  * @param {*} [options] Override http request option.
335
335
  * @throws {RequiredError}
336
336
  */
@@ -82,7 +82,7 @@ export declare const CollaborationControllerApiAxiosParamCreator: (configuration
82
82
  */
83
83
  deleteSharedDocuments: (deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
84
  /**
85
- * Deletes a team. Requires ADMIN_USERS role.
85
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
86
86
  * @summary Delete a team
87
87
  * @param {string} teamId
88
88
  * @param {*} [options] Override http request option.
@@ -210,7 +210,7 @@ export declare const CollaborationControllerApiFp: (configuration?: Configuratio
210
210
  */
211
211
  deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
212
212
  /**
213
- * Deletes a team. Requires ADMIN_USERS role.
213
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
214
214
  * @summary Delete a team
215
215
  * @param {string} teamId
216
216
  * @param {*} [options] Override http request option.
@@ -338,7 +338,7 @@ export declare const CollaborationControllerApiFactory: (configuration?: Configu
338
338
  */
339
339
  deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
340
340
  /**
341
- * Deletes a team. Requires ADMIN_USERS role.
341
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
342
342
  * @summary Delete a team
343
343
  * @param {string} teamId
344
344
  * @param {*} [options] Override http request option.
@@ -466,7 +466,7 @@ export declare class CollaborationControllerApi extends BaseAPI {
466
466
  */
467
467
  deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}, any>>;
468
468
  /**
469
- * Deletes a team. Requires ADMIN_USERS role.
469
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
470
470
  * @summary Delete a team
471
471
  * @param {string} teamId
472
472
  * @param {*} [options] Override http request option.
@@ -270,7 +270,7 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
270
270
  };
271
271
  }),
272
272
  /**
273
- * Deletes a team. Requires ADMIN_USERS role.
273
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
274
274
  * @summary Delete a team
275
275
  * @param {string} teamId
276
276
  * @param {*} [options] Override http request option.
@@ -661,7 +661,7 @@ export const CollaborationControllerApiFp = function (configuration) {
661
661
  });
662
662
  },
663
663
  /**
664
- * Deletes a team. Requires ADMIN_USERS role.
664
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
665
665
  * @summary Delete a team
666
666
  * @param {string} teamId
667
667
  * @param {*} [options] Override http request option.
@@ -870,7 +870,7 @@ export const CollaborationControllerApiFactory = function (configuration, basePa
870
870
  return localVarFp.deleteSharedDocuments(deleteShareRequest, options).then((request) => request(axios, basePath));
871
871
  },
872
872
  /**
873
- * Deletes a team. Requires ADMIN_USERS role.
873
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
874
874
  * @summary Delete a team
875
875
  * @param {string} teamId
876
876
  * @param {*} [options] Override http request option.
@@ -1029,7 +1029,7 @@ export class CollaborationControllerApi extends BaseAPI {
1029
1029
  return CollaborationControllerApiFp(this.configuration).deleteSharedDocuments(deleteShareRequest, options).then((request) => request(this.axios, this.basePath));
1030
1030
  }
1031
1031
  /**
1032
- * Deletes a team. Requires ADMIN_USERS role.
1032
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
1033
1033
  * @summary Delete a team
1034
1034
  * @param {string} teamId
1035
1035
  * @param {*} [options] Override http request option.
@@ -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
@@ -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
@@ -18,8 +18,8 @@ import type { NotificationDTO } from '../models';
18
18
  */
19
19
  export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * Retrieve all notifications for the authenticated user
22
- * @summary Get all notifications
21
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
22
+ * @summary Get notifications
23
23
  * @param {*} [options] Override http request option.
24
24
  * @throws {RequiredError}
25
25
  */
@@ -59,8 +59,8 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
59
59
  */
60
60
  export declare const NotificationsApiFp: (configuration?: Configuration) => {
61
61
  /**
62
- * Retrieve all notifications for the authenticated user
63
- * @summary Get all notifications
62
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
63
+ * @summary Get notifications
64
64
  * @param {*} [options] Override http request option.
65
65
  * @throws {RequiredError}
66
66
  */
@@ -100,8 +100,8 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
100
100
  */
101
101
  export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
102
102
  /**
103
- * Retrieve all notifications for the authenticated user
104
- * @summary Get all notifications
103
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
104
+ * @summary Get notifications
105
105
  * @param {*} [options] Override http request option.
106
106
  * @throws {RequiredError}
107
107
  */
@@ -141,8 +141,8 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
141
141
  */
142
142
  export declare class NotificationsApi extends BaseAPI {
143
143
  /**
144
- * Retrieve all notifications for the authenticated user
145
- * @summary Get all notifications
144
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
145
+ * @summary Get notifications
146
146
  * @param {*} [options] Override http request option.
147
147
  * @throws {RequiredError}
148
148
  */