@openfilz-sdk/typescript-ee 1.14.4 → 1.14.6

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 (159) hide show
  1. package/.openapi-generator/FILES +32 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +36 -3
  4. package/api/collaboration-controller-api.ts +12 -12
  5. package/api/directory-administration-api.ts +200 -0
  6. package/api/notifications-api.ts +8 -8
  7. package/api/team-administration-api.ts +221 -4
  8. package/api/teams-api.ts +1090 -0
  9. package/api/user-privacy-api.ts +4 -4
  10. package/api.ts +2 -0
  11. package/dist/api/collaboration-controller-api.d.ts +12 -12
  12. package/dist/api/collaboration-controller-api.js +12 -12
  13. package/dist/api/directory-administration-api.d.ts +99 -0
  14. package/dist/api/directory-administration-api.js +201 -0
  15. package/dist/api/notifications-api.d.ts +8 -8
  16. package/dist/api/notifications-api.js +8 -8
  17. package/dist/api/team-administration-api.d.ts +101 -4
  18. package/dist/api/team-administration-api.js +210 -4
  19. package/dist/api/teams-api.d.ts +499 -0
  20. package/dist/api/teams-api.js +1039 -0
  21. package/dist/api/user-privacy-api.d.ts +4 -4
  22. package/dist/api/user-privacy-api.js +4 -4
  23. package/dist/api.d.ts +2 -0
  24. package/dist/api.js +2 -0
  25. package/dist/esm/api/collaboration-controller-api.d.ts +12 -12
  26. package/dist/esm/api/collaboration-controller-api.js +12 -12
  27. package/dist/esm/api/directory-administration-api.d.ts +99 -0
  28. package/dist/esm/api/directory-administration-api.js +194 -0
  29. package/dist/esm/api/notifications-api.d.ts +8 -8
  30. package/dist/esm/api/notifications-api.js +8 -8
  31. package/dist/esm/api/team-administration-api.d.ts +101 -4
  32. package/dist/esm/api/team-administration-api.js +210 -4
  33. package/dist/esm/api/teams-api.d.ts +499 -0
  34. package/dist/esm/api/teams-api.js +1032 -0
  35. package/dist/esm/api/user-privacy-api.d.ts +4 -4
  36. package/dist/esm/api/user-privacy-api.js +4 -4
  37. package/dist/esm/api.d.ts +2 -0
  38. package/dist/esm/api.js +2 -0
  39. package/dist/esm/models/add-team-owner-request.d.ts +14 -0
  40. package/dist/esm/models/add-team-owner-request.js +14 -0
  41. package/dist/esm/models/create-collaborative-team-request.d.ts +14 -0
  42. package/dist/esm/models/create-collaborative-team-request.js +14 -0
  43. package/dist/esm/models/directory-hidden-request.d.ts +14 -0
  44. package/dist/esm/models/directory-hidden-request.js +14 -0
  45. package/dist/esm/models/enriched-audit-log.d.ts +7 -0
  46. package/dist/esm/models/enriched-audit-log.js +7 -0
  47. package/dist/esm/models/index.d.ts +14 -0
  48. package/dist/esm/models/index.js +14 -0
  49. package/dist/esm/models/invite-to-team-request.d.ts +14 -0
  50. package/dist/esm/models/invite-to-team-request.js +14 -0
  51. package/dist/esm/models/my-team.d.ts +23 -0
  52. package/dist/esm/models/my-team.js +17 -0
  53. package/dist/esm/models/notification-dto.d.ts +5 -0
  54. package/dist/esm/models/notification-dto.js +5 -0
  55. package/dist/esm/models/rename-team-request.d.ts +14 -0
  56. package/dist/esm/models/rename-team-request.js +14 -0
  57. package/dist/esm/models/search-by-audit-log-request.d.ts +7 -0
  58. package/dist/esm/models/search-by-audit-log-request.js +7 -0
  59. package/dist/esm/models/team-capabilities.d.ts +18 -0
  60. package/dist/esm/models/team-capabilities.js +14 -0
  61. package/dist/esm/models/team-details.d.ts +28 -0
  62. package/dist/esm/models/team-details.js +17 -0
  63. package/dist/esm/models/team-invitation-view.d.ts +20 -0
  64. package/dist/esm/models/team-invitation-view.js +14 -0
  65. package/dist/esm/models/team-invite-result.d.ts +23 -0
  66. package/dist/esm/models/team-invite-result.js +20 -0
  67. package/dist/esm/models/team-kind-view.d.ts +23 -0
  68. package/dist/esm/models/team-kind-view.js +17 -0
  69. package/dist/esm/models/team-owner-view.d.ts +16 -0
  70. package/dist/esm/models/team-owner-view.js +14 -0
  71. package/dist/esm/models/team-pending-invitee.d.ts +19 -0
  72. package/dist/esm/models/team-pending-invitee.js +14 -0
  73. package/dist/esm/models/team-person.d.ts +17 -0
  74. package/dist/esm/models/team-person.js +14 -0
  75. package/dist/esm/models/update-user-privacy-request.d.ts +3 -1
  76. package/dist/esm/models/user-privacy-dto.d.ts +8 -0
  77. package/dist/esm/models/user-privacy-dto.js +4 -1
  78. package/dist/models/add-team-owner-request.d.ts +14 -0
  79. package/dist/models/add-team-owner-request.js +15 -0
  80. package/dist/models/create-collaborative-team-request.d.ts +14 -0
  81. package/dist/models/create-collaborative-team-request.js +15 -0
  82. package/dist/models/directory-hidden-request.d.ts +14 -0
  83. package/dist/models/directory-hidden-request.js +15 -0
  84. package/dist/models/enriched-audit-log.d.ts +7 -0
  85. package/dist/models/enriched-audit-log.js +7 -0
  86. package/dist/models/index.d.ts +14 -0
  87. package/dist/models/index.js +14 -0
  88. package/dist/models/invite-to-team-request.d.ts +14 -0
  89. package/dist/models/invite-to-team-request.js +15 -0
  90. package/dist/models/my-team.d.ts +23 -0
  91. package/dist/models/my-team.js +20 -0
  92. package/dist/models/notification-dto.d.ts +5 -0
  93. package/dist/models/notification-dto.js +5 -0
  94. package/dist/models/rename-team-request.d.ts +14 -0
  95. package/dist/models/rename-team-request.js +15 -0
  96. package/dist/models/search-by-audit-log-request.d.ts +7 -0
  97. package/dist/models/search-by-audit-log-request.js +7 -0
  98. package/dist/models/team-capabilities.d.ts +18 -0
  99. package/dist/models/team-capabilities.js +15 -0
  100. package/dist/models/team-details.d.ts +28 -0
  101. package/dist/models/team-details.js +20 -0
  102. package/dist/models/team-invitation-view.d.ts +20 -0
  103. package/dist/models/team-invitation-view.js +15 -0
  104. package/dist/models/team-invite-result.d.ts +23 -0
  105. package/dist/models/team-invite-result.js +23 -0
  106. package/dist/models/team-kind-view.d.ts +23 -0
  107. package/dist/models/team-kind-view.js +20 -0
  108. package/dist/models/team-owner-view.d.ts +16 -0
  109. package/dist/models/team-owner-view.js +15 -0
  110. package/dist/models/team-pending-invitee.d.ts +19 -0
  111. package/dist/models/team-pending-invitee.js +15 -0
  112. package/dist/models/team-person.d.ts +17 -0
  113. package/dist/models/team-person.js +15 -0
  114. package/dist/models/update-user-privacy-request.d.ts +3 -1
  115. package/dist/models/user-privacy-dto.d.ts +8 -0
  116. package/dist/models/user-privacy-dto.js +5 -0
  117. package/docs/AddTeamOwnerRequest.md +20 -0
  118. package/docs/CollaborationControllerApi.md +3 -3
  119. package/docs/CreateCollaborativeTeamRequest.md +20 -0
  120. package/docs/DirectoryAdministrationApi.md +107 -0
  121. package/docs/DirectoryHiddenRequest.md +20 -0
  122. package/docs/InviteToTeamRequest.md +20 -0
  123. package/docs/MyTeam.md +28 -0
  124. package/docs/NotificationsApi.md +2 -2
  125. package/docs/RenameTeamRequest.md +20 -0
  126. package/docs/TeamAdministrationApi.md +153 -1
  127. package/docs/TeamCapabilities.md +28 -0
  128. package/docs/TeamDetails.md +34 -0
  129. package/docs/TeamInvitationView.md +32 -0
  130. package/docs/TeamInviteResult.md +22 -0
  131. package/docs/TeamKindView.md +26 -0
  132. package/docs/TeamOwnerView.md +24 -0
  133. package/docs/TeamPendingInvitee.md +30 -0
  134. package/docs/TeamPerson.md +26 -0
  135. package/docs/TeamsApi.md +724 -0
  136. package/docs/UpdateUserPrivacyRequest.md +5 -1
  137. package/docs/UserPrivacyApi.md +1 -1
  138. package/docs/UserPrivacyDTO.md +6 -0
  139. package/models/add-team-owner-request.ts +20 -0
  140. package/models/create-collaborative-team-request.ts +20 -0
  141. package/models/directory-hidden-request.ts +20 -0
  142. package/models/enriched-audit-log.ts +7 -0
  143. package/models/index.ts +14 -0
  144. package/models/invite-to-team-request.ts +20 -0
  145. package/models/my-team.ts +32 -0
  146. package/models/notification-dto.ts +5 -0
  147. package/models/rename-team-request.ts +20 -0
  148. package/models/search-by-audit-log-request.ts +7 -0
  149. package/models/team-capabilities.ts +24 -0
  150. package/models/team-details.ts +41 -0
  151. package/models/team-invitation-view.ts +26 -0
  152. package/models/team-invite-result.ts +32 -0
  153. package/models/team-kind-view.ts +34 -0
  154. package/models/team-owner-view.ts +22 -0
  155. package/models/team-pending-invitee.ts +25 -0
  156. package/models/team-person.ts +23 -0
  157. package/models/update-user-privacy-request.ts +3 -1
  158. package/models/user-privacy-dto.ts +11 -0
  159. package/package.json +1 -1
@@ -65,7 +65,7 @@ export const UserPrivacyApiAxiosParamCreator = function (configuration?: Configu
65
65
  };
66
66
  },
67
67
  /**
68
- * Idempotent. Audits ADMIN_MONITORING_OPT_OUT_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
68
+ * Idempotent; a null field is left unchanged. Audits ADMIN_MONITORING_OPT_OUT_CHANGED / DIRECTORY_OPT_IN_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
69
69
  * @summary Update my privacy preferences
70
70
  * @param {UpdateUserPrivacyRequest} updateUserPrivacyRequest
71
71
  * @param {*} [options] Override http request option.
@@ -125,7 +125,7 @@ export const UserPrivacyApiFp = function(configuration?: Configuration) {
125
125
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
126
126
  },
127
127
  /**
128
- * Idempotent. Audits ADMIN_MONITORING_OPT_OUT_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
128
+ * Idempotent; a null field is left unchanged. Audits ADMIN_MONITORING_OPT_OUT_CHANGED / DIRECTORY_OPT_IN_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
129
129
  * @summary Update my privacy preferences
130
130
  * @param {UpdateUserPrivacyRequest} updateUserPrivacyRequest
131
131
  * @param {*} [options] Override http request option.
@@ -156,7 +156,7 @@ export const UserPrivacyApiFactory = function (configuration?: Configuration, ba
156
156
  return localVarFp.get(options).then((request) => request(axios, basePath));
157
157
  },
158
158
  /**
159
- * Idempotent. Audits ADMIN_MONITORING_OPT_OUT_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
159
+ * Idempotent; a null field is left unchanged. Audits ADMIN_MONITORING_OPT_OUT_CHANGED / DIRECTORY_OPT_IN_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
160
160
  * @summary Update my privacy preferences
161
161
  * @param {UpdateUserPrivacyRequest} updateUserPrivacyRequest
162
162
  * @param {*} [options] Override http request option.
@@ -183,7 +183,7 @@ export class UserPrivacyApi extends BaseAPI {
183
183
  }
184
184
 
185
185
  /**
186
- * Idempotent. Audits ADMIN_MONITORING_OPT_OUT_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
186
+ * Idempotent; a null field is left unchanged. Audits ADMIN_MONITORING_OPT_OUT_CHANGED / DIRECTORY_OPT_IN_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
187
187
  * @summary Update my privacy preferences
188
188
  * @param {UpdateUserPrivacyRequest} updateUserPrivacyRequest
189
189
  * @param {*} [options] Override http request option.
package/api.ts CHANGED
@@ -35,6 +35,7 @@ export * from './api/delegated-browse-grants-admin-api';
35
35
  export * from './api/delegated-browse-grants-end-user-api';
36
36
  export * from './api/desktop-sync-api';
37
37
  export * from './api/desktop-sync-administration-api';
38
+ export * from './api/directory-administration-api';
38
39
  export * from './api/document-controller-api';
39
40
  export * from './api/document-insights-api';
40
41
  export * from './api/document-suggestion-controller-api';
@@ -65,6 +66,7 @@ export * from './api/sharing-policy-api';
65
66
  export * from './api/smart-filing-api';
66
67
  export * from './api/storage-encryption-administration-api';
67
68
  export * from './api/team-administration-api';
69
+ export * from './api/teams-api';
68
70
  export * from './api/tus-controller-api';
69
71
  export * from './api/upload-token-controller-api';
70
72
  export * from './api/user-privacy-api';
@@ -33,7 +33,7 @@ export declare const CollaborationControllerApiAxiosParamCreator: (configuration
33
33
  */
34
34
  acceptShareRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
- * Adds users to a team. Requires ADMIN_USERS role.
36
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
37
37
  * @summary Add team members
38
38
  * @param {string} teamId
39
39
  * @param {Array<string>} requestBody
@@ -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.
@@ -113,7 +113,7 @@ export declare const CollaborationControllerApiAxiosParamCreator: (configuration
113
113
  */
114
114
  rejectShareRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
115
  /**
116
- * Removes users from a team. Requires ADMIN_USERS role.
116
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
117
117
  * @summary Remove team members
118
118
  * @param {string} teamId
119
119
  * @param {Array<string>} requestBody
@@ -161,7 +161,7 @@ export declare const CollaborationControllerApiFp: (configuration?: Configuratio
161
161
  */
162
162
  acceptShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
163
163
  /**
164
- * Adds users to a team. Requires ADMIN_USERS role.
164
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
165
165
  * @summary Add team members
166
166
  * @param {string} teamId
167
167
  * @param {Array<string>} requestBody
@@ -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.
@@ -241,7 +241,7 @@ export declare const CollaborationControllerApiFp: (configuration?: Configuratio
241
241
  */
242
242
  rejectShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
243
243
  /**
244
- * Removes users from a team. Requires ADMIN_USERS role.
244
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
245
245
  * @summary Remove team members
246
246
  * @param {string} teamId
247
247
  * @param {Array<string>} requestBody
@@ -289,7 +289,7 @@ export declare const CollaborationControllerApiFactory: (configuration?: Configu
289
289
  */
290
290
  acceptShareRequest(id: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
291
291
  /**
292
- * Adds users to a team. Requires ADMIN_USERS role.
292
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
293
293
  * @summary Add team members
294
294
  * @param {string} teamId
295
295
  * @param {Array<string>} requestBody
@@ -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.
@@ -369,7 +369,7 @@ export declare const CollaborationControllerApiFactory: (configuration?: Configu
369
369
  */
370
370
  rejectShareRequest(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
371
371
  /**
372
- * Removes users from a team. Requires ADMIN_USERS role.
372
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
373
373
  * @summary Remove team members
374
374
  * @param {string} teamId
375
375
  * @param {Array<string>} requestBody
@@ -417,7 +417,7 @@ export declare class CollaborationControllerApi extends BaseAPI {
417
417
  */
418
418
  acceptShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any, {}, any>>;
419
419
  /**
420
- * Adds users to a team. Requires ADMIN_USERS role.
420
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
421
421
  * @summary Add team members
422
422
  * @param {string} teamId
423
423
  * @param {Array<string>} requestBody
@@ -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.
@@ -497,7 +497,7 @@ export declare class CollaborationControllerApi extends BaseAPI {
497
497
  */
498
498
  rejectShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
499
499
  /**
500
- * Removes users from a team. Requires ADMIN_USERS role.
500
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
501
501
  * @summary Remove team members
502
502
  * @param {string} teamId
503
503
  * @param {Array<string>} requestBody
@@ -68,7 +68,7 @@ const CollaborationControllerApiAxiosParamCreator = function (configuration) {
68
68
  };
69
69
  }),
70
70
  /**
71
- * Adds users to a team. Requires ADMIN_USERS role.
71
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
72
72
  * @summary Add team members
73
73
  * @param {string} teamId
74
74
  * @param {Array<string>} requestBody
@@ -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.
@@ -398,7 +398,7 @@ const CollaborationControllerApiAxiosParamCreator = function (configuration) {
398
398
  };
399
399
  }),
400
400
  /**
401
- * Removes users from a team. Requires ADMIN_USERS role.
401
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
402
402
  * @summary Remove team members
403
403
  * @param {string} teamId
404
404
  * @param {Array<string>} requestBody
@@ -568,7 +568,7 @@ const CollaborationControllerApiFp = function (configuration) {
568
568
  });
569
569
  },
570
570
  /**
571
- * Adds users to a team. Requires ADMIN_USERS role.
571
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
572
572
  * @summary Add team members
573
573
  * @param {string} teamId
574
574
  * @param {Array<string>} requestBody
@@ -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.
@@ -728,7 +728,7 @@ const CollaborationControllerApiFp = function (configuration) {
728
728
  });
729
729
  },
730
730
  /**
731
- * Removes users from a team. Requires ADMIN_USERS role.
731
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
732
732
  * @summary Remove team members
733
733
  * @param {string} teamId
734
734
  * @param {Array<string>} requestBody
@@ -814,7 +814,7 @@ const CollaborationControllerApiFactory = function (configuration, basePath, axi
814
814
  return localVarFp.acceptShareRequest(id, options).then((request) => request(axios, basePath));
815
815
  },
816
816
  /**
817
- * Adds users to a team. Requires ADMIN_USERS role.
817
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
818
818
  * @summary Add team members
819
819
  * @param {string} teamId
820
820
  * @param {Array<string>} requestBody
@@ -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.
@@ -914,7 +914,7 @@ const CollaborationControllerApiFactory = function (configuration, basePath, axi
914
914
  return localVarFp.rejectShareRequest(id, options).then((request) => request(axios, basePath));
915
915
  },
916
916
  /**
917
- * Removes users from a team. Requires ADMIN_USERS role.
917
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
918
918
  * @summary Remove team members
919
919
  * @param {string} teamId
920
920
  * @param {Array<string>} requestBody
@@ -974,7 +974,7 @@ class CollaborationControllerApi extends base_1.BaseAPI {
974
974
  return (0, exports.CollaborationControllerApiFp)(this.configuration).acceptShareRequest(id, options).then((request) => request(this.axios, this.basePath));
975
975
  }
976
976
  /**
977
- * Adds users to a team. Requires ADMIN_USERS role.
977
+ * Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
978
978
  * @summary Add team members
979
979
  * @param {string} teamId
980
980
  * @param {Array<string>} requestBody
@@ -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.
@@ -1074,7 +1074,7 @@ class CollaborationControllerApi extends base_1.BaseAPI {
1074
1074
  return (0, exports.CollaborationControllerApiFp)(this.configuration).rejectShareRequest(id, options).then((request) => request(this.axios, this.basePath));
1075
1075
  }
1076
1076
  /**
1077
- * Removes users from a team. Requires ADMIN_USERS role.
1077
+ * Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
1078
1078
  * @summary Remove team members
1079
1079
  * @param {string} teamId
1080
1080
  * @param {Array<string>} requestBody
@@ -0,0 +1,99 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { DirectoryHiddenRequest } from '../models';
16
+ /**
17
+ * DirectoryAdministrationApi - axios parameter creator
18
+ */
19
+ export declare const DirectoryAdministrationApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ *
22
+ * @summary Ids of the users hidden from the directory
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ adminListDirectoryHidden: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27
+ /**
28
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
29
+ * @summary Hide a user from the directory, or show them again
30
+ * @param {string} userId
31
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ adminSetDirectoryHidden: (userId: string, directoryHiddenRequest: DirectoryHiddenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
+ };
37
+ /**
38
+ * DirectoryAdministrationApi - functional programming interface
39
+ */
40
+ export declare const DirectoryAdministrationApiFp: (configuration?: Configuration) => {
41
+ /**
42
+ *
43
+ * @summary Ids of the users hidden from the directory
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ adminListDirectoryHidden(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
48
+ /**
49
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
50
+ * @summary Hide a user from the directory, or show them again
51
+ * @param {string} userId
52
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ adminSetDirectoryHidden(userId: string, directoryHiddenRequest: DirectoryHiddenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
57
+ };
58
+ /**
59
+ * DirectoryAdministrationApi - factory interface
60
+ */
61
+ export declare const DirectoryAdministrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62
+ /**
63
+ *
64
+ * @summary Ids of the users hidden from the directory
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ adminListDirectoryHidden(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
69
+ /**
70
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
71
+ * @summary Hide a user from the directory, or show them again
72
+ * @param {string} userId
73
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ adminSetDirectoryHidden(userId: string, directoryHiddenRequest: DirectoryHiddenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
78
+ };
79
+ /**
80
+ * DirectoryAdministrationApi - object-oriented interface
81
+ */
82
+ export declare class DirectoryAdministrationApi extends BaseAPI {
83
+ /**
84
+ *
85
+ * @summary Ids of the users hidden from the directory
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ adminListDirectoryHidden(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}, any>>;
90
+ /**
91
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
92
+ * @summary Hide a user from the directory, or show them again
93
+ * @param {string} userId
94
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ adminSetDirectoryHidden(userId: string, directoryHiddenRequest: DirectoryHiddenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
99
+ }
@@ -0,0 +1,201 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.DirectoryAdministrationApi = exports.DirectoryAdministrationApiFactory = exports.DirectoryAdministrationApiFp = exports.DirectoryAdministrationApiAxiosParamCreator = void 0;
26
+ const axios_1 = require("axios");
27
+ // Some imports not used depending on template conditions
28
+ // @ts-ignore
29
+ const common_1 = require("../common");
30
+ // @ts-ignore
31
+ const base_1 = require("../base");
32
+ /**
33
+ * DirectoryAdministrationApi - axios parameter creator
34
+ */
35
+ const DirectoryAdministrationApiAxiosParamCreator = function (configuration) {
36
+ return {
37
+ /**
38
+ *
39
+ * @summary Ids of the users hidden from the directory
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ adminListDirectoryHidden: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
44
+ const localVarPath = `/api/v1/admin/users/directory-hidden`;
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
52
+ const localVarHeaderParameter = {};
53
+ const localVarQueryParameter = {};
54
+ // authentication keycloak_auth required
55
+ // http bearer authentication required
56
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
57
+ localVarHeaderParameter['Accept'] = '*/*';
58
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
59
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
60
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
61
+ return {
62
+ url: (0, common_1.toPathString)(localVarUrlObj),
63
+ options: localVarRequestOptions,
64
+ };
65
+ }),
66
+ /**
67
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
68
+ * @summary Hide a user from the directory, or show them again
69
+ * @param {string} userId
70
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ adminSetDirectoryHidden: (userId_1, directoryHiddenRequest_1, ...args_1) => __awaiter(this, [userId_1, directoryHiddenRequest_1, ...args_1], void 0, function* (userId, directoryHiddenRequest, options = {}) {
75
+ // verify required parameter 'userId' is not null or undefined
76
+ (0, common_1.assertParamExists)('adminSetDirectoryHidden', 'userId', userId);
77
+ // verify required parameter 'directoryHiddenRequest' is not null or undefined
78
+ (0, common_1.assertParamExists)('adminSetDirectoryHidden', 'directoryHiddenRequest', directoryHiddenRequest);
79
+ const localVarPath = `/api/v1/admin/users/{userId}/directory-hidden`
80
+ .replace('{userId}', encodeURIComponent(String(userId)));
81
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
82
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
83
+ let baseOptions;
84
+ if (configuration) {
85
+ baseOptions = configuration.baseOptions;
86
+ }
87
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
88
+ const localVarHeaderParameter = {};
89
+ const localVarQueryParameter = {};
90
+ // authentication keycloak_auth required
91
+ // http bearer authentication required
92
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
93
+ localVarHeaderParameter['Content-Type'] = 'application/json';
94
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
95
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
96
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
97
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(directoryHiddenRequest, localVarRequestOptions, configuration);
98
+ return {
99
+ url: (0, common_1.toPathString)(localVarUrlObj),
100
+ options: localVarRequestOptions,
101
+ };
102
+ }),
103
+ };
104
+ };
105
+ exports.DirectoryAdministrationApiAxiosParamCreator = DirectoryAdministrationApiAxiosParamCreator;
106
+ /**
107
+ * DirectoryAdministrationApi - functional programming interface
108
+ */
109
+ const DirectoryAdministrationApiFp = function (configuration) {
110
+ const localVarAxiosParamCreator = (0, exports.DirectoryAdministrationApiAxiosParamCreator)(configuration);
111
+ return {
112
+ /**
113
+ *
114
+ * @summary Ids of the users hidden from the directory
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ adminListDirectoryHidden(options) {
119
+ return __awaiter(this, void 0, void 0, function* () {
120
+ var _a, _b, _c;
121
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminListDirectoryHidden(options);
122
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
123
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DirectoryAdministrationApi.adminListDirectoryHidden']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
124
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
125
+ });
126
+ },
127
+ /**
128
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
129
+ * @summary Hide a user from the directory, or show them again
130
+ * @param {string} userId
131
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ adminSetDirectoryHidden(userId, directoryHiddenRequest, options) {
136
+ return __awaiter(this, void 0, void 0, function* () {
137
+ var _a, _b, _c;
138
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminSetDirectoryHidden(userId, directoryHiddenRequest, options);
139
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
140
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DirectoryAdministrationApi.adminSetDirectoryHidden']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
141
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
142
+ });
143
+ },
144
+ };
145
+ };
146
+ exports.DirectoryAdministrationApiFp = DirectoryAdministrationApiFp;
147
+ /**
148
+ * DirectoryAdministrationApi - factory interface
149
+ */
150
+ const DirectoryAdministrationApiFactory = function (configuration, basePath, axios) {
151
+ const localVarFp = (0, exports.DirectoryAdministrationApiFp)(configuration);
152
+ return {
153
+ /**
154
+ *
155
+ * @summary Ids of the users hidden from the directory
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ adminListDirectoryHidden(options) {
160
+ return localVarFp.adminListDirectoryHidden(options).then((request) => request(axios, basePath));
161
+ },
162
+ /**
163
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
164
+ * @summary Hide a user from the directory, or show them again
165
+ * @param {string} userId
166
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ */
170
+ adminSetDirectoryHidden(userId, directoryHiddenRequest, options) {
171
+ return localVarFp.adminSetDirectoryHidden(userId, directoryHiddenRequest, options).then((request) => request(axios, basePath));
172
+ },
173
+ };
174
+ };
175
+ exports.DirectoryAdministrationApiFactory = DirectoryAdministrationApiFactory;
176
+ /**
177
+ * DirectoryAdministrationApi - object-oriented interface
178
+ */
179
+ class DirectoryAdministrationApi extends base_1.BaseAPI {
180
+ /**
181
+ *
182
+ * @summary Ids of the users hidden from the directory
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ adminListDirectoryHidden(options) {
187
+ return (0, exports.DirectoryAdministrationApiFp)(this.configuration).adminListDirectoryHidden(options).then((request) => request(this.axios, this.basePath));
188
+ }
189
+ /**
190
+ * Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
191
+ * @summary Hide a user from the directory, or show them again
192
+ * @param {string} userId
193
+ * @param {DirectoryHiddenRequest} directoryHiddenRequest
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ adminSetDirectoryHidden(userId, directoryHiddenRequest, options) {
198
+ return (0, exports.DirectoryAdministrationApiFp)(this.configuration).adminSetDirectoryHidden(userId, directoryHiddenRequest, options).then((request) => request(this.axios, this.basePath));
199
+ }
200
+ }
201
+ exports.DirectoryAdministrationApi = DirectoryAdministrationApi;
@@ -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
  */