@openfilz-sdk/typescript-ee 1.14.6 → 1.14.8

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 (98) hide show
  1. package/.openapi-generator/FILES +14 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +13 -2
  4. package/api/access-requests-api.ts +203 -0
  5. package/api/collaboration-controller-api.ts +79 -4
  6. package/api/comments-api.ts +152 -0
  7. package/api.ts +1 -0
  8. package/dist/api/access-requests-api.d.ts +100 -0
  9. package/dist/api/access-requests-api.js +202 -0
  10. package/dist/api/collaboration-controller-api.d.ts +37 -4
  11. package/dist/api/collaboration-controller-api.js +74 -4
  12. package/dist/api/comments-api.d.ts +67 -0
  13. package/dist/api/comments-api.js +140 -0
  14. package/dist/api.d.ts +1 -0
  15. package/dist/api.js +1 -0
  16. package/dist/esm/api/access-requests-api.d.ts +100 -0
  17. package/dist/esm/api/access-requests-api.js +195 -0
  18. package/dist/esm/api/collaboration-controller-api.d.ts +37 -4
  19. package/dist/esm/api/collaboration-controller-api.js +74 -4
  20. package/dist/esm/api/comments-api.d.ts +67 -0
  21. package/dist/esm/api/comments-api.js +140 -0
  22. package/dist/esm/api.d.ts +1 -0
  23. package/dist/esm/api.js +1 -0
  24. package/dist/esm/models/access-request-input.d.ts +31 -0
  25. package/dist/esm/models/access-request-input.js +18 -0
  26. package/dist/esm/models/access-request-status.d.ts +36 -0
  27. package/dist/esm/models/access-request-status.js +24 -0
  28. package/dist/esm/models/enriched-audit-log.d.ts +1 -0
  29. package/dist/esm/models/enriched-audit-log.js +1 -0
  30. package/dist/esm/models/index.d.ts +6 -0
  31. package/dist/esm/models/index.js +6 -0
  32. package/dist/esm/models/mention-access-item.d.ts +29 -0
  33. package/dist/esm/models/mention-access-item.js +21 -0
  34. package/dist/esm/models/mention-access-preview.d.ts +15 -0
  35. package/dist/esm/models/mention-access-preview.js +14 -0
  36. package/dist/esm/models/mention-access-request.d.ts +21 -0
  37. package/dist/esm/models/mention-access-request.js +14 -0
  38. package/dist/esm/models/notification-dto.d.ts +3 -0
  39. package/dist/esm/models/notification-dto.js +3 -0
  40. package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
  41. package/dist/esm/models/search-by-audit-log-request.js +1 -0
  42. package/dist/esm/models/share-expiry-request.d.ts +25 -0
  43. package/dist/esm/models/share-expiry-request.js +14 -0
  44. package/dist/esm/models/share-request.d.ts +4 -0
  45. package/dist/esm/models/share-result-error.d.ts +3 -0
  46. package/dist/esm/models/share-result-error.js +3 -0
  47. package/dist/esm/models/violation.d.ts +3 -0
  48. package/dist/esm/models/violation.js +3 -0
  49. package/dist/models/access-request-input.d.ts +31 -0
  50. package/dist/models/access-request-input.js +21 -0
  51. package/dist/models/access-request-status.d.ts +36 -0
  52. package/dist/models/access-request-status.js +27 -0
  53. package/dist/models/enriched-audit-log.d.ts +1 -0
  54. package/dist/models/enriched-audit-log.js +1 -0
  55. package/dist/models/index.d.ts +6 -0
  56. package/dist/models/index.js +6 -0
  57. package/dist/models/mention-access-item.d.ts +29 -0
  58. package/dist/models/mention-access-item.js +24 -0
  59. package/dist/models/mention-access-preview.d.ts +15 -0
  60. package/dist/models/mention-access-preview.js +15 -0
  61. package/dist/models/mention-access-request.d.ts +21 -0
  62. package/dist/models/mention-access-request.js +15 -0
  63. package/dist/models/notification-dto.d.ts +3 -0
  64. package/dist/models/notification-dto.js +3 -0
  65. package/dist/models/search-by-audit-log-request.d.ts +1 -0
  66. package/dist/models/search-by-audit-log-request.js +1 -0
  67. package/dist/models/share-expiry-request.d.ts +25 -0
  68. package/dist/models/share-expiry-request.js +15 -0
  69. package/dist/models/share-request.d.ts +4 -0
  70. package/dist/models/share-result-error.d.ts +3 -0
  71. package/dist/models/share-result-error.js +3 -0
  72. package/dist/models/violation.d.ts +3 -0
  73. package/dist/models/violation.js +3 -0
  74. package/docs/AccessRequestInput.md +24 -0
  75. package/docs/AccessRequestStatus.md +26 -0
  76. package/docs/AccessRequestsApi.md +112 -0
  77. package/docs/CollaborationControllerApi.md +57 -1
  78. package/docs/CommentsApi.md +106 -0
  79. package/docs/MentionAccessItem.md +32 -0
  80. package/docs/MentionAccessPreview.md +20 -0
  81. package/docs/MentionAccessRequest.md +22 -0
  82. package/docs/ShareExpiryRequest.md +24 -0
  83. package/docs/ShareRequest.md +2 -0
  84. package/graphql/share.graphqls +43 -2
  85. package/models/access-request-input.ts +40 -0
  86. package/models/access-request-status.ts +46 -0
  87. package/models/enriched-audit-log.ts +1 -0
  88. package/models/index.ts +6 -0
  89. package/models/mention-access-item.ts +38 -0
  90. package/models/mention-access-preview.ts +23 -0
  91. package/models/mention-access-request.ts +27 -0
  92. package/models/notification-dto.ts +3 -0
  93. package/models/search-by-audit-log-request.ts +1 -0
  94. package/models/share-expiry-request.ts +31 -0
  95. package/models/share-request.ts +4 -0
  96. package/models/share-result-error.ts +3 -0
  97. package/models/violation.ts +3 -0
  98. package/package.json +1 -1
@@ -16,6 +16,7 @@ All URIs are relative to *http://localhost:8081*
16
16
  |[**getUserStatus**](#getuserstatus) | **GET** /api/v1/users/me/status | Check user status|
17
17
  |[**rejectShareRequest**](#rejectsharerequest) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request|
18
18
  |[**removeTeamMembers**](#removeteammembers) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members|
19
+ |[**updateShareExpiry**](#updateshareexpiry) | **PUT** /api/v1/users/share/expiry | Set, change or remove the end date of share(s)|
19
20
  |[**updateSharedDocuments**](#updateshareddocuments) | **PUT** /api/v1/users/share | Update Share for document(s)|
20
21
  |[**updateTeam**](#updateteam) | **PUT** /api/v1/users/teams/{teamId} | Update a team|
21
22
  |[**updateUser**](#updateuser) | **PUT** /api/v1/users/{userId} | Update a user|
@@ -128,7 +129,7 @@ void (empty response body)
128
129
  # **createSharedDocuments**
129
130
  > ShareResultResponse createSharedDocuments(shareRequest)
130
131
 
131
- Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
132
+ Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
132
133
 
133
134
  ### Example
134
135
 
@@ -175,6 +176,7 @@ const { status, data } = await apiInstance.createSharedDocuments(
175
176
  |-------------|-------------|------------------|
176
177
  |**200** | All shares created successfully | - |
177
178
  |**207** | Partial success: some shares created, some sent as requests, some failed | - |
179
+ |**400** | expiresAt is not in the future | - |
178
180
 
179
181
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
180
182
 
@@ -637,6 +639,60 @@ void (empty response body)
637
639
 
638
640
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
639
641
 
642
+ # **updateShareExpiry**
643
+ > ShareResultResponse updateShareExpiry(shareExpiryRequest)
644
+
645
+ Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
646
+
647
+ ### Example
648
+
649
+ ```typescript
650
+ import {
651
+ CollaborationControllerApi,
652
+ Configuration,
653
+ ShareExpiryRequest
654
+ } from '@openfilz-sdk/typescript-ee';
655
+
656
+ const configuration = new Configuration();
657
+ const apiInstance = new CollaborationControllerApi(configuration);
658
+
659
+ let shareExpiryRequest: ShareExpiryRequest; //
660
+
661
+ const { status, data } = await apiInstance.updateShareExpiry(
662
+ shareExpiryRequest
663
+ );
664
+ ```
665
+
666
+ ### Parameters
667
+
668
+ |Name | Type | Description | Notes|
669
+ |------------- | ------------- | ------------- | -------------|
670
+ | **shareExpiryRequest** | **ShareExpiryRequest**| | |
671
+
672
+
673
+ ### Return type
674
+
675
+ **ShareResultResponse**
676
+
677
+ ### Authorization
678
+
679
+ [keycloak_auth](../README.md#keycloak_auth)
680
+
681
+ ### HTTP request headers
682
+
683
+ - **Content-Type**: application/json
684
+ - **Accept**: */*
685
+
686
+
687
+ ### HTTP response details
688
+ | Status code | Description | Response headers |
689
+ |-------------|-------------|------------------|
690
+ |**200** | All end dates changed | - |
691
+ |**207** | Partial success: some items failed | - |
692
+ |**400** | expiresAt is not in the future | - |
693
+
694
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
695
+
640
696
  # **updateSharedDocuments**
641
697
  > ShareResultResponse updateSharedDocuments(shareRequest)
642
698
 
@@ -6,6 +6,8 @@ All URIs are relative to *http://localhost:8081*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createComment**](#createcomment) | **POST** /api/v1/documents/comments | Create a comment|
8
8
  |[**deleteComment**](#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment|
9
+ |[**grantMentionAccess**](#grantmentionaccess) | **POST** /api/v1/documents/comments/mention-access/grant | Give mentioned users comment access|
10
+ |[**previewMentionAccess**](#previewmentionaccess) | **POST** /api/v1/documents/comments/mention-access | Preview comment access for mentioned users|
9
11
  |[**updateComment**](#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment|
10
12
 
11
13
  # **createComment**
@@ -104,6 +106,110 @@ void (empty response body)
104
106
  - **Accept**: Not defined
105
107
 
106
108
 
109
+ ### HTTP response details
110
+ | Status code | Description | Response headers |
111
+ |-------------|-------------|------------------|
112
+ |**200** | OK | - |
113
+
114
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
115
+
116
+ # **grantMentionAccess**
117
+ > ShareResultResponse grantMentionAccess(mentionAccessRequest)
118
+
119
+ Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
120
+
121
+ ### Example
122
+
123
+ ```typescript
124
+ import {
125
+ CommentsApi,
126
+ Configuration,
127
+ MentionAccessRequest
128
+ } from '@openfilz-sdk/typescript-ee';
129
+
130
+ const configuration = new Configuration();
131
+ const apiInstance = new CommentsApi(configuration);
132
+
133
+ let mentionAccessRequest: MentionAccessRequest; //
134
+
135
+ const { status, data } = await apiInstance.grantMentionAccess(
136
+ mentionAccessRequest
137
+ );
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ |Name | Type | Description | Notes|
143
+ |------------- | ------------- | ------------- | -------------|
144
+ | **mentionAccessRequest** | **MentionAccessRequest**| | |
145
+
146
+
147
+ ### Return type
148
+
149
+ **ShareResultResponse**
150
+
151
+ ### Authorization
152
+
153
+ [keycloak_auth](../README.md#keycloak_auth)
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: application/json
158
+ - **Accept**: application/json
159
+
160
+
161
+ ### HTTP response details
162
+ | Status code | Description | Response headers |
163
+ |-------------|-------------|------------------|
164
+ |**200** | OK | - |
165
+
166
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
167
+
168
+ # **previewMentionAccess**
169
+ > MentionAccessPreview previewMentionAccess(mentionAccessRequest)
170
+
171
+ Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
172
+
173
+ ### Example
174
+
175
+ ```typescript
176
+ import {
177
+ CommentsApi,
178
+ Configuration,
179
+ MentionAccessRequest
180
+ } from '@openfilz-sdk/typescript-ee';
181
+
182
+ const configuration = new Configuration();
183
+ const apiInstance = new CommentsApi(configuration);
184
+
185
+ let mentionAccessRequest: MentionAccessRequest; //
186
+
187
+ const { status, data } = await apiInstance.previewMentionAccess(
188
+ mentionAccessRequest
189
+ );
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ |Name | Type | Description | Notes|
195
+ |------------- | ------------- | ------------- | -------------|
196
+ | **mentionAccessRequest** | **MentionAccessRequest**| | |
197
+
198
+
199
+ ### Return type
200
+
201
+ **MentionAccessPreview**
202
+
203
+ ### Authorization
204
+
205
+ [keycloak_auth](../README.md#keycloak_auth)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
107
213
  ### HTTP response details
108
214
  | Status code | Description | Response headers |
109
215
  |-------------|-------------|------------------|
@@ -0,0 +1,32 @@
1
+ # MentionAccessItem
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **docId** | **string** | | [optional] [default to undefined]
9
+ **docName** | **string** | | [optional] [default to undefined]
10
+ **userId** | **string** | | [optional] [default to undefined]
11
+ **userName** | **string** | | [optional] [default to undefined]
12
+ **userEmail** | **string** | | [optional] [default to undefined]
13
+ **canRead** | **boolean** | | [optional] [default to undefined]
14
+ **action** | **string** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { MentionAccessItem } from '@openfilz-sdk/typescript-ee';
20
+
21
+ const instance: MentionAccessItem = {
22
+ docId,
23
+ docName,
24
+ userId,
25
+ userName,
26
+ userEmail,
27
+ canRead,
28
+ action,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # MentionAccessPreview
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array<MentionAccessItem>**](MentionAccessItem.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { MentionAccessPreview } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: MentionAccessPreview = {
16
+ items,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # MentionAccessRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **docIds** | **Set<string>** | Document IDs the comment is saved on (at most 200) | [default to undefined]
9
+ **mentionedUserIds** | **Set<string>** | User IDs mentioned in the comment (at most 100) | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { MentionAccessRequest } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: MentionAccessRequest = {
17
+ docIds,
18
+ mentionedUserIds,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # ShareExpiryRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentIds** | **Set<string>** | Shared documents | [default to undefined]
9
+ **userIds** | **Set<string>** | Recipients (users or teams) | [default to undefined]
10
+ **expiresAt** | **string** | New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400). | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ShareExpiryRequest } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: ShareExpiryRequest = {
18
+ documentIds,
19
+ userIds,
20
+ expiresAt,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **userIds** | **Set<string>** | User IDs to share with | [default to undefined]
11
11
  **message** | **string** | Optional message to include in the share notification | [optional] [default to undefined]
12
12
  **notify** | **boolean** | false = create the shares silently: no invitation e-mail and no bell notification to the recipients (bulk imports — a migration re-creating a source system\'s permissions must not mail thousands of invitations). Absent or true = notify. Share requests addressed to a document\'s owner are always notified. | [optional] [default to undefined]
13
+ **expiresAt** | **string** | Optional end of access (ISO-8601 instant): on that date the recipients lose access and the owner is told. Absent = no end. A date in the past is refused (400). On a document the caller does not own, it travels with the share request and applies once the owner accepts. | [optional] [default to undefined]
13
14
 
14
15
  ## Example
15
16
 
@@ -22,6 +23,7 @@ const instance: ShareRequest = {
22
23
  userIds,
23
24
  message,
24
25
  notify,
26
+ expiresAt,
25
27
  };
26
28
  ```
27
29
 
@@ -1,13 +1,28 @@
1
1
  extend type Query {
2
2
  listOwned(request: ListFolderRequest!): [FolderElementInfo]
3
3
  countOwned(request: ListFolderRequest): Long
4
- listSharedWithMe(request: ListFolderRequest!): [FolderElementInfo]
5
- countSharedWithMe(request: ListFolderRequest): Long
4
+ "Root shares reaching the caller (directly or through a team), or the content of a shared folder (request id)"
5
+ listSharedWithMe(request: ListFolderRequest!,
6
+ """
7
+ Keep the items reaching the caller through one of these grantees: the caller's own id (direct shares)
8
+ and/or ids of teams the caller belongs to. Absent or empty = every share. Any other id is refused.
9
+ Applies to the root listing (no request id).
10
+ """
11
+ sharedThrough: [UUID!]): [FolderElementInfo]
12
+ countSharedWithMe(request: ListFolderRequest,
13
+ """
14
+ Keep the items reaching the caller through one of these grantees: the caller's own id (direct shares)
15
+ and/or ids of teams the caller belongs to. Absent or empty = every share. Any other id is refused.
16
+ Applies to the root listing (no request id).
17
+ """
18
+ sharedThrough: [UUID!]): Long
6
19
  listSharedByMe(request: ListFolderRequest!, sharedWithUserId: UUID): [FolderElementInfo]
7
20
  countSharedByMe(request: ListFolderRequest, sharedWithUserId: UUID): Long
8
21
  listDocShares(docId: UUID!): [SharedWith]
9
22
  "Lists the teams the connected user belongs to"
10
23
  listMyTeams: [TeamInfo!]!
24
+ "The connected user's own id: the grantee id of their direct shares (listSharedWithMe sharedThrough)"
25
+ myUserId: UUID!
11
26
  """
12
27
  Lists all users in the connected user's organization.
13
28
  Access restricted to LICENSED users only.
@@ -46,6 +61,11 @@ extend type DocumentInfo {
46
61
  }
47
62
 
48
63
  extend type FolderElementInfo {
64
+ """
65
+ End of access: on a document the caller owns, the earliest end date among its shares; on a document shared
66
+ with the caller, the end of their own share (direct or through a team). Null = no end.
67
+ """
68
+ shareExpiresAt : DateTime
49
69
  "Whether this document is shared with the current user in editor mode"
50
70
  sharedEdit : Boolean
51
71
  "Whether this document is shared with the current user in commenter mode"
@@ -54,6 +74,12 @@ extend type FolderElementInfo {
54
74
  rootShare : Boolean
55
75
  "The team ID through which this document is shared with the current user, null if shared directly"
56
76
  sharedTeamId : UUID
77
+ """
78
+ Every grantee this item reaches the caller through: the caller's own id (direct share) first, then the ids of
79
+ the caller's teams holding a share on it. Null when no share reaches the caller (e.g. an item they own).
80
+ Resolved per page from the rows' ids: select `id` with it.
81
+ """
82
+ sharedThrough : [UUID!]
57
83
  }
58
84
 
59
85
  type SharedWith {
@@ -63,6 +89,10 @@ type SharedWith {
63
89
  status: UserStatusEnum
64
90
  rootOwner: Boolean
65
91
  type: UserTypeEnum
92
+ "The share was granted on this document itself, not inherited from a folder: only these carry an end date"
93
+ root: Boolean
94
+ "End of access, null = no end (set on root shares only)"
95
+ expiresAt: DateTime
66
96
  }
67
97
 
68
98
  enum ShareMode {
@@ -150,6 +180,17 @@ type ShareRequestInfo {
150
180
  sharedUserEmail: String
151
181
  shareMode: ShareMode!
152
182
  createdAt: DateTime!
183
+ "ACCESS = the requester asks for access for themself (requester = recipient)"
184
+ requestType: ShareRequestType!
185
+ "The requester's note to the owner (ACCESS requests)"
186
+ message: String
187
+ }
188
+
189
+ """
190
+ What a share request asks for
191
+ """
192
+ enum ShareRequestType {
193
+ CREATE, UPDATE, DELETE, ACCESS
153
194
  }
154
195
 
155
196
  """
@@ -0,0 +1,40 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface AccessRequestInput {
18
+ /**
19
+ * The document (file or folder) the caller asks access to
20
+ */
21
+ 'documentId': string;
22
+ /**
23
+ * The access asked for; READER when absent
24
+ */
25
+ 'shareMode'?: AccessRequestInputShareModeEnum;
26
+ /**
27
+ * Optional note to the owner
28
+ */
29
+ 'message'?: string;
30
+ }
31
+
32
+ export const AccessRequestInputShareModeEnum = {
33
+ Reader: 'READER',
34
+ Commenter: 'COMMENTER',
35
+ Editor: 'EDITOR',
36
+ } as const;
37
+
38
+ export type AccessRequestInputShareModeEnum = typeof AccessRequestInputShareModeEnum[keyof typeof AccessRequestInputShareModeEnum];
39
+
40
+
@@ -0,0 +1,46 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface AccessRequestStatus {
18
+ 'documentId'?: string;
19
+ 'state'?: AccessRequestStatusStateEnum;
20
+ /**
21
+ * PENDING: the access asked for
22
+ */
23
+ 'requestedMode'?: AccessRequestStatusRequestedModeEnum;
24
+ /**
25
+ * PENDING: when the owner was last asked
26
+ */
27
+ 'requestedAt'?: string;
28
+ }
29
+
30
+ export const AccessRequestStatusStateEnum = {
31
+ HasAccess: 'HAS_ACCESS',
32
+ NoAccess: 'NO_ACCESS',
33
+ Pending: 'PENDING',
34
+ OwnerCannotShare: 'OWNER_CANNOT_SHARE',
35
+ } as const;
36
+
37
+ export type AccessRequestStatusStateEnum = typeof AccessRequestStatusStateEnum[keyof typeof AccessRequestStatusStateEnum];
38
+ export const AccessRequestStatusRequestedModeEnum = {
39
+ Reader: 'READER',
40
+ Commenter: 'COMMENTER',
41
+ Editor: 'EDITOR',
42
+ } as const;
43
+
44
+ export type AccessRequestStatusRequestedModeEnum = typeof AccessRequestStatusRequestedModeEnum[keyof typeof AccessRequestStatusRequestedModeEnum];
45
+
46
+
@@ -77,6 +77,7 @@ export const EnrichedAuditLogActionEnum = {
77
77
  ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
78
78
  ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
79
79
  ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
80
+ ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
80
81
  ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
81
82
  TeamCreated: 'TEAM_CREATED',
82
83
  TeamUpdated: 'TEAM_UPDATED',
package/models/index.ts CHANGED
@@ -1,3 +1,5 @@
1
+ export * from './access-request-input';
2
+ export * from './access-request-status';
1
3
  export * from './add-team-owner-request';
2
4
  export * from './ai-analytics-view';
3
5
  export * from './ai-chat-conversation';
@@ -109,6 +111,9 @@ export * from './list-ai-models-request';
109
111
  export * from './mcp-agent-token-config';
110
112
  export * from './mcp-agent-token-info';
111
113
  export * from './mcp-agent-token-response';
114
+ export * from './mention-access-item';
115
+ export * from './mention-access-preview';
116
+ export * from './mention-access-request';
112
117
  export * from './merge-request';
113
118
  export * from './merge-source';
114
119
  export * from './metadata-key-suggestion';
@@ -173,6 +178,7 @@ export * from './search-by-metadata-request';
173
178
  export * from './search-metadata-request';
174
179
  export * from './setting-dto';
175
180
  export * from './settings';
181
+ export * from './share-expiry-request';
176
182
  export * from './share-inheritance';
177
183
  export * from './share-inheritance-request';
178
184
  export * from './share-request';
@@ -0,0 +1,38 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface MentionAccessItem {
18
+ 'docId'?: string;
19
+ 'docName'?: string;
20
+ 'userId'?: string;
21
+ 'userName'?: string;
22
+ 'userEmail'?: string;
23
+ 'canRead'?: boolean;
24
+ 'action'?: MentionAccessItemActionEnum;
25
+ }
26
+
27
+ export const MentionAccessItemActionEnum = {
28
+ Share: 'SHARE',
29
+ Upgrade: 'UPGRADE',
30
+ RequestShare: 'REQUEST_SHARE',
31
+ RequestUpgrade: 'REQUEST_UPGRADE',
32
+ NotLicensed: 'NOT_LICENSED',
33
+ NotAllowed: 'NOT_ALLOWED',
34
+ } as const;
35
+
36
+ export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];
37
+
38
+
@@ -0,0 +1,23 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { MentionAccessItem } from './mention-access-item';
19
+
20
+ export interface MentionAccessPreview {
21
+ 'items'?: Array<MentionAccessItem>;
22
+ }
23
+
@@ -0,0 +1,27 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface MentionAccessRequest {
18
+ /**
19
+ * Document IDs the comment is saved on (at most 200)
20
+ */
21
+ 'docIds': Set<string>;
22
+ /**
23
+ * User IDs mentioned in the comment (at most 100)
24
+ */
25
+ 'mentionedUserIds': Set<string>;
26
+ }
27
+
@@ -51,6 +51,9 @@ export const NotificationDTOTypeEnum = {
51
51
  TeamInvitationDeclined: 'TEAM_INVITATION_DECLINED',
52
52
  TeamMemberAdded: 'TEAM_MEMBER_ADDED',
53
53
  TeamMemberRemoved: 'TEAM_MEMBER_REMOVED',
54
+ AccessRequestDeclined: 'ACCESS_REQUEST_DECLINED',
55
+ ShareExpiring: 'SHARE_EXPIRING',
56
+ ShareExpired: 'SHARE_EXPIRED',
54
57
  } as const;
55
58
 
56
59
  export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];
@@ -90,6 +90,7 @@ export const SearchByAuditLogRequestActionEnum = {
90
90
  ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
91
91
  ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
92
92
  ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
93
+ ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
93
94
  ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
94
95
  TeamCreated: 'TEAM_CREATED',
95
96
  TeamUpdated: 'TEAM_UPDATED',
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface ShareExpiryRequest {
18
+ /**
19
+ * Shared documents
20
+ */
21
+ 'documentIds': Set<string>;
22
+ /**
23
+ * Recipients (users or teams)
24
+ */
25
+ 'userIds': Set<string>;
26
+ /**
27
+ * New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400).
28
+ */
29
+ 'expiresAt'?: string;
30
+ }
31
+