@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
@@ -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
- 2e2b81d484dd69119d9e1ac16b1a2a53b1bd59f21634227ee4365e0456a687af
1
+ e314baf547051c02a7a055fd51c85629232ae4a88aae0c8f071625539563c9f7
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.14.5
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.5 --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
@@ -224,7 +226,7 @@ Class | Method | HTTP request | Description
224
226
  *McpTokenAdminControllerApi* | [**mint**](docs/McpTokenAdminControllerApi.md#mint) | **POST** /api/v1/admin/mcp/tokens | Mint an MCP agent token for a dedicated user (admin only)
225
227
  *McpTokenAdminControllerApi* | [**revoke1**](docs/McpTokenAdminControllerApi.md#revoke1) | **DELETE** /api/v1/admin/mcp/tokens/{jti} | Revoke an MCP agent token
226
228
  *MetadataKeyControllerApi* | [**listMetadataKeys**](docs/MetadataKeyControllerApi.md#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys
227
- *NotificationsApi* | [**getNotifications**](docs/NotificationsApi.md#getnotifications) | **GET** /api/v1/notifications | Get all notifications
229
+ *NotificationsApi* | [**getNotifications**](docs/NotificationsApi.md#getnotifications) | **GET** /api/v1/notifications | Get notifications
228
230
  *NotificationsApi* | [**getUnreadCount**](docs/NotificationsApi.md#getunreadcount) | **GET** /api/v1/notifications/unread/count | Get unread notification count
229
231
  *NotificationsApi* | [**markAllAsRead**](docs/NotificationsApi.md#markallasread) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read
230
232
  *NotificationsApi* | [**markAsRead**](docs/NotificationsApi.md#markasread) | **PUT** /api/v1/notifications/{id}/read | Mark notification as read
@@ -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)
@@ -316,7 +316,7 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
316
316
  };
317
317
  },
318
318
  /**
319
- * Deletes a team. Requires ADMIN_USERS role.
319
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
320
320
  * @summary Delete a team
321
321
  * @param {string} teamId
322
322
  * @param {*} [options] Override http request option.
@@ -727,7 +727,7 @@ export const CollaborationControllerApiFp = function(configuration?: Configurati
727
727
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
728
728
  },
729
729
  /**
730
- * Deletes a team. Requires ADMIN_USERS role.
730
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
731
731
  * @summary Delete a team
732
732
  * @param {string} teamId
733
733
  * @param {*} [options] Override http request option.
@@ -913,7 +913,7 @@ export const CollaborationControllerApiFactory = function (configuration?: Confi
913
913
  return localVarFp.deleteSharedDocuments(deleteShareRequest, options).then((request) => request(axios, basePath));
914
914
  },
915
915
  /**
916
- * Deletes a team. Requires ADMIN_USERS role.
916
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
917
917
  * @summary Delete a team
918
918
  * @param {string} teamId
919
919
  * @param {*} [options] Override http request option.
@@ -1080,7 +1080,7 @@ export class CollaborationControllerApi extends BaseAPI {
1080
1080
  }
1081
1081
 
1082
1082
  /**
1083
- * Deletes a team. Requires ADMIN_USERS role.
1083
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
1084
1084
  * @summary Delete a team
1085
1085
  * @param {string} teamId
1086
1086
  * @param {*} [options] Override http request option.
@@ -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
@@ -29,8 +29,8 @@ import type { NotificationDTO } from '../models';
29
29
  export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
30
30
  return {
31
31
  /**
32
- * Retrieve all notifications for the authenticated user
33
- * @summary Get all notifications
32
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
33
+ * @summary Get notifications
34
34
  * @param {*} [options] Override http request option.
35
35
  * @throws {RequiredError}
36
36
  */
@@ -210,8 +210,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
210
210
  const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
211
211
  return {
212
212
  /**
213
- * Retrieve all notifications for the authenticated user
214
- * @summary Get all notifications
213
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
214
+ * @summary Get notifications
215
215
  * @param {*} [options] Override http request option.
216
216
  * @throws {RequiredError}
217
217
  */
@@ -280,8 +280,8 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
280
280
  const localVarFp = NotificationsApiFp(configuration)
281
281
  return {
282
282
  /**
283
- * Retrieve all notifications for the authenticated user
284
- * @summary Get all notifications
283
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
284
+ * @summary Get notifications
285
285
  * @param {*} [options] Override http request option.
286
286
  * @throws {RequiredError}
287
287
  */
@@ -333,8 +333,8 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
333
333
  */
334
334
  export class NotificationsApi extends BaseAPI {
335
335
  /**
336
- * Retrieve all notifications for the authenticated user
337
- * @summary Get all notifications
336
+ * The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
337
+ * @summary Get notifications
338
338
  * @param {*} [options] Override http request option.
339
339
  * @throws {RequiredError}
340
340
  */
@@ -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.
@@ -273,7 +273,7 @@ const CollaborationControllerApiAxiosParamCreator = function (configuration) {
273
273
  };
274
274
  }),
275
275
  /**
276
- * Deletes a team. Requires ADMIN_USERS role.
276
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
277
277
  * @summary Delete a team
278
278
  * @param {string} teamId
279
279
  * @param {*} [options] Override http request option.
@@ -665,7 +665,7 @@ const CollaborationControllerApiFp = function (configuration) {
665
665
  });
666
666
  },
667
667
  /**
668
- * Deletes a team. Requires ADMIN_USERS role.
668
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
669
669
  * @summary Delete a team
670
670
  * @param {string} teamId
671
671
  * @param {*} [options] Override http request option.
@@ -875,7 +875,7 @@ const CollaborationControllerApiFactory = function (configuration, basePath, axi
875
875
  return localVarFp.deleteSharedDocuments(deleteShareRequest, options).then((request) => request(axios, basePath));
876
876
  },
877
877
  /**
878
- * Deletes a team. Requires ADMIN_USERS role.
878
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
879
879
  * @summary Delete a team
880
880
  * @param {string} teamId
881
881
  * @param {*} [options] Override http request option.
@@ -1035,7 +1035,7 @@ class CollaborationControllerApi extends base_1.BaseAPI {
1035
1035
  return (0, exports.CollaborationControllerApiFp)(this.configuration).deleteSharedDocuments(deleteShareRequest, options).then((request) => request(this.axios, this.basePath));
1036
1036
  }
1037
1037
  /**
1038
- * Deletes a team. Requires ADMIN_USERS role.
1038
+ * Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
1039
1039
  * @summary Delete a team
1040
1040
  * @param {string} teamId
1041
1041
  * @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