@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
@@ -3,6 +3,7 @@
3
3
  .openapi-generator-ignore
4
4
  README.md
5
5
  api.ts
6
+ api/access-requests-api.ts
6
7
  api/ai-analytics-admin-controller-api.ts
7
8
  api/ai-archiving-admin-controller-api.ts
8
9
  api/ai-cloud-usage-admin-controller-api.ts
@@ -73,6 +74,9 @@ docs/AIMaintenanceApi.md
73
74
  docs/AISettingsApi.md
74
75
  docs/AITaxonomyApi.md
75
76
  docs/AITeamInboxesApi.md
77
+ docs/AccessRequestInput.md
78
+ docs/AccessRequestStatus.md
79
+ docs/AccessRequestsApi.md
76
80
  docs/AddTeamOwnerRequest.md
77
81
  docs/AiAnalyticsAdminControllerApi.md
78
82
  docs/AiAnalyticsView.md
@@ -211,6 +215,9 @@ docs/McpAgentTokenInfo.md
211
215
  docs/McpAgentTokenResponse.md
212
216
  docs/McpDiscoveryControllerApi.md
213
217
  docs/McpTokenAdminControllerApi.md
218
+ docs/MentionAccessItem.md
219
+ docs/MentionAccessPreview.md
220
+ docs/MentionAccessRequest.md
214
221
  docs/MergeRequest.md
215
222
  docs/MergeSource.md
216
223
  docs/MetadataKeyControllerApi.md
@@ -286,6 +293,7 @@ docs/SearchMetadataRequest.md
286
293
  docs/SettingDto.md
287
294
  docs/Settings.md
288
295
  docs/SettingsApi.md
296
+ docs/ShareExpiryRequest.md
289
297
  docs/ShareInheritance.md
290
298
  docs/ShareInheritanceRequest.md
291
299
  docs/ShareRequest.md
@@ -386,6 +394,8 @@ docs/WorkflowValidationResult.md
386
394
  docs/WorkflowsApi.md
387
395
  git_push.sh
388
396
  index.ts
397
+ models/access-request-input.ts
398
+ models/access-request-status.ts
389
399
  models/add-team-owner-request.ts
390
400
  models/ai-analytics-view.ts
391
401
  models/ai-chat-conversation.ts
@@ -498,6 +508,9 @@ models/list-ai-models-request.ts
498
508
  models/mcp-agent-token-config.ts
499
509
  models/mcp-agent-token-info.ts
500
510
  models/mcp-agent-token-response.ts
511
+ models/mention-access-item.ts
512
+ models/mention-access-preview.ts
513
+ models/mention-access-request.ts
501
514
  models/merge-request.ts
502
515
  models/merge-source.ts
503
516
  models/metadata-key-suggestion.ts
@@ -562,6 +575,7 @@ models/search-by-metadata-request.ts
562
575
  models/search-metadata-request.ts
563
576
  models/setting-dto.ts
564
577
  models/settings.ts
578
+ models/share-expiry-request.ts
565
579
  models/share-inheritance-request.ts
566
580
  models/share-inheritance.ts
567
581
  models/share-request.ts
@@ -1 +1 @@
1
- f934993d994e1399aefd36e15e29a9546e6005d5afa7c057ce2d970dbababce0
1
+ 0f1dd9555c4a1b901e8dc298db0616c09c78ad4c3fa765d9ccdd1cdb0a335937
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.14.6
1
+ ## @openfilz-sdk/typescript-ee@1.14.8
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript-ee@1.14.6 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.14.8 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -91,6 +91,8 @@ Class | Method | HTTP request | Description
91
91
  *AITeamInboxesApi* | [**list3**](docs/AITeamInboxesApi.md#list3) | **GET** /api/v1/admin/ai/team-inboxes | List the team inboxes
92
92
  *AITeamInboxesApi* | [**run**](docs/AITeamInboxesApi.md#run) | **POST** /api/v1/admin/ai/team-inboxes/{id}/run | File the inbox now
93
93
  *AITeamInboxesApi* | [**update3**](docs/AITeamInboxesApi.md#update3) | **PUT** /api/v1/admin/ai/team-inboxes/{id} | Replace a team inbox
94
+ *AccessRequestsApi* | [**myAccessToDocument**](docs/AccessRequestsApi.md#myaccesstodocument) | **GET** /api/v1/users/me/access-requests/{documentId} | Can I open this document, or ask for it?
95
+ *AccessRequestsApi* | [**requestAccess**](docs/AccessRequestsApi.md#requestaccess) | **POST** /api/v1/users/me/access-requests | Ask the owner for access
94
96
  *AiAnalyticsAdminControllerApi* | [**analytics**](docs/AiAnalyticsAdminControllerApi.md#analytics) | **GET** /api/v1/admin/ai/analytics | Tenant-wide AI insights and smart-filing analytics (admin only)
95
97
  *AiArchivingAdminControllerApi* | [**create4**](docs/AiArchivingAdminControllerApi.md#create4) | **POST** /api/v1/admin/ai/archiving/schedules | Create an archiving schedule
96
98
  *AiArchivingAdminControllerApi* | [**delete3**](docs/AiArchivingAdminControllerApi.md#delete3) | **DELETE** /api/v1/admin/ai/archiving/schedules/{id} | Delete an archiving schedule
@@ -121,11 +123,14 @@ Class | Method | HTTP request | Description
121
123
  *CollaborationControllerApi* | [**getUserStatus**](docs/CollaborationControllerApi.md#getuserstatus) | **GET** /api/v1/users/me/status | Check user status
122
124
  *CollaborationControllerApi* | [**rejectShareRequest**](docs/CollaborationControllerApi.md#rejectsharerequest) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request
123
125
  *CollaborationControllerApi* | [**removeTeamMembers**](docs/CollaborationControllerApi.md#removeteammembers) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members
126
+ *CollaborationControllerApi* | [**updateShareExpiry**](docs/CollaborationControllerApi.md#updateshareexpiry) | **PUT** /api/v1/users/share/expiry | Set, change or remove the end date of share(s)
124
127
  *CollaborationControllerApi* | [**updateSharedDocuments**](docs/CollaborationControllerApi.md#updateshareddocuments) | **PUT** /api/v1/users/share | Update Share for document(s)
125
128
  *CollaborationControllerApi* | [**updateTeam**](docs/CollaborationControllerApi.md#updateteam) | **PUT** /api/v1/users/teams/{teamId} | Update a team
126
129
  *CollaborationControllerApi* | [**updateUser**](docs/CollaborationControllerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update a user
127
130
  *CommentsApi* | [**createComment**](docs/CommentsApi.md#createcomment) | **POST** /api/v1/documents/comments | Create a comment
128
131
  *CommentsApi* | [**deleteComment**](docs/CommentsApi.md#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment
132
+ *CommentsApi* | [**grantMentionAccess**](docs/CommentsApi.md#grantmentionaccess) | **POST** /api/v1/documents/comments/mention-access/grant | Give mentioned users comment access
133
+ *CommentsApi* | [**previewMentionAccess**](docs/CommentsApi.md#previewmentionaccess) | **POST** /api/v1/documents/comments/mention-access | Preview comment access for mentioned users
129
134
  *CommentsApi* | [**updateComment**](docs/CommentsApi.md#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment
130
135
  *DashboardApi* | [**getDashboardStatistics**](docs/DashboardApi.md#getdashboardstatistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics
131
136
  *DelegatedBrowseGrantsAdminApi* | [**browseFolders**](docs/DelegatedBrowseGrantsAdminApi.md#browsefolders) | **GET** /api/v1/admin/delegated/folders | Browse folders on behalf of the grantor
@@ -368,6 +373,8 @@ Class | Method | HTTP request | Description
368
373
 
369
374
  ### Documentation For Models
370
375
 
376
+ - [AccessRequestInput](docs/AccessRequestInput.md)
377
+ - [AccessRequestStatus](docs/AccessRequestStatus.md)
371
378
  - [AddTeamOwnerRequest](docs/AddTeamOwnerRequest.md)
372
379
  - [AiAnalyticsView](docs/AiAnalyticsView.md)
373
380
  - [AiChatConversation](docs/AiChatConversation.md)
@@ -479,6 +486,9 @@ Class | Method | HTTP request | Description
479
486
  - [McpAgentTokenConfig](docs/McpAgentTokenConfig.md)
480
487
  - [McpAgentTokenInfo](docs/McpAgentTokenInfo.md)
481
488
  - [McpAgentTokenResponse](docs/McpAgentTokenResponse.md)
489
+ - [MentionAccessItem](docs/MentionAccessItem.md)
490
+ - [MentionAccessPreview](docs/MentionAccessPreview.md)
491
+ - [MentionAccessRequest](docs/MentionAccessRequest.md)
482
492
  - [MergeRequest](docs/MergeRequest.md)
483
493
  - [MergeSource](docs/MergeSource.md)
484
494
  - [MetadataKeySuggestion](docs/MetadataKeySuggestion.md)
@@ -543,6 +553,7 @@ Class | Method | HTTP request | Description
543
553
  - [SearchMetadataRequest](docs/SearchMetadataRequest.md)
544
554
  - [SettingDto](docs/SettingDto.md)
545
555
  - [Settings](docs/Settings.md)
556
+ - [ShareExpiryRequest](docs/ShareExpiryRequest.md)
546
557
  - [ShareInheritance](docs/ShareInheritance.md)
547
558
  - [ShareInheritanceRequest](docs/ShareInheritanceRequest.md)
548
559
  - [ShareRequest](docs/ShareRequest.md)
@@ -0,0 +1,203 @@
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
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { AccessRequestInput } from '../models';
26
+ // @ts-ignore
27
+ import type { AccessRequestStatus } from '../models';
28
+ /**
29
+ * AccessRequestsApi - axios parameter creator
30
+ */
31
+ export const AccessRequestsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
35
+ * @summary Can I open this document, or ask for it?
36
+ * @param {string} documentId
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ myAccessToDocument: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
+ // verify required parameter 'documentId' is not null or undefined
42
+ assertParamExists('myAccessToDocument', 'documentId', documentId)
43
+ const localVarPath = `/api/v1/users/me/access-requests/{documentId}`
44
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication keycloak_auth required
57
+ // http bearer authentication required
58
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = '*/*';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
71
+ /**
72
+ * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
73
+ * @summary Ask the owner for access
74
+ * @param {AccessRequestInput} accessRequestInput
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ requestAccess: async (accessRequestInput: AccessRequestInput, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
79
+ // verify required parameter 'accessRequestInput' is not null or undefined
80
+ assertParamExists('requestAccess', 'accessRequestInput', accessRequestInput)
81
+ const localVarPath = `/api/v1/users/me/access-requests`;
82
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
83
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
84
+ let baseOptions;
85
+ if (configuration) {
86
+ baseOptions = configuration.baseOptions;
87
+ }
88
+
89
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
90
+ const localVarHeaderParameter = {} as any;
91
+ const localVarQueryParameter = {} as any;
92
+
93
+ // authentication keycloak_auth required
94
+ // http bearer authentication required
95
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
96
+
97
+ localVarHeaderParameter['Content-Type'] = 'application/json';
98
+ localVarHeaderParameter['Accept'] = '*/*';
99
+
100
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
101
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
102
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
103
+ localVarRequestOptions.data = serializeDataIfNeeded(accessRequestInput, localVarRequestOptions, configuration)
104
+
105
+ return {
106
+ url: toPathString(localVarUrlObj),
107
+ options: localVarRequestOptions,
108
+ };
109
+ },
110
+ }
111
+ };
112
+
113
+ /**
114
+ * AccessRequestsApi - functional programming interface
115
+ */
116
+ export const AccessRequestsApiFp = function(configuration?: Configuration) {
117
+ const localVarAxiosParamCreator = AccessRequestsApiAxiosParamCreator(configuration)
118
+ return {
119
+ /**
120
+ * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
121
+ * @summary Can I open this document, or ask for it?
122
+ * @param {string} documentId
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ async myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>> {
127
+ const localVarAxiosArgs = await localVarAxiosParamCreator.myAccessToDocument(documentId, options);
128
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
129
+ const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.myAccessToDocument']?.[localVarOperationServerIndex]?.url;
130
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
131
+ },
132
+ /**
133
+ * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
134
+ * @summary Ask the owner for access
135
+ * @param {AccessRequestInput} accessRequestInput
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ async requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>> {
140
+ const localVarAxiosArgs = await localVarAxiosParamCreator.requestAccess(accessRequestInput, options);
141
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
142
+ const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.requestAccess']?.[localVarOperationServerIndex]?.url;
143
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
144
+ },
145
+ }
146
+ };
147
+
148
+ /**
149
+ * AccessRequestsApi - factory interface
150
+ */
151
+ export const AccessRequestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
152
+ const localVarFp = AccessRequestsApiFp(configuration)
153
+ return {
154
+ /**
155
+ * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
156
+ * @summary Can I open this document, or ask for it?
157
+ * @param {string} documentId
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus> {
162
+ return localVarFp.myAccessToDocument(documentId, options).then((request) => request(axios, basePath));
163
+ },
164
+ /**
165
+ * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
166
+ * @summary Ask the owner for access
167
+ * @param {AccessRequestInput} accessRequestInput
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus> {
172
+ return localVarFp.requestAccess(accessRequestInput, options).then((request) => request(axios, basePath));
173
+ },
174
+ };
175
+ };
176
+
177
+ /**
178
+ * AccessRequestsApi - object-oriented interface
179
+ */
180
+ export class AccessRequestsApi extends BaseAPI {
181
+ /**
182
+ * HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
183
+ * @summary Can I open this document, or ask for it?
184
+ * @param {string} documentId
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ public myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig) {
189
+ return AccessRequestsApiFp(this.configuration).myAccessToDocument(documentId, options).then((request) => request(this.axios, this.basePath));
190
+ }
191
+
192
+ /**
193
+ * Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
194
+ * @summary Ask the owner for access
195
+ * @param {AccessRequestInput} accessRequestInput
196
+ * @param {*} [options] Override http request option.
197
+ * @throws {RequiredError}
198
+ */
199
+ public requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig) {
200
+ return AccessRequestsApiFp(this.configuration).requestAccess(accessRequestInput, options).then((request) => request(this.axios, this.basePath));
201
+ }
202
+ }
203
+
@@ -26,6 +26,8 @@ import type { CreateTeamRequest } from '../models';
26
26
  // @ts-ignore
27
27
  import type { DeleteShareRequest } from '../models';
28
28
  // @ts-ignore
29
+ import type { ShareExpiryRequest } from '../models';
30
+ // @ts-ignore
29
31
  import type { ShareRequest } from '../models';
30
32
  // @ts-ignore
31
33
  import type { ShareResultResponse } from '../models';
@@ -123,7 +125,7 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
123
125
  };
124
126
  },
125
127
  /**
126
- * 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
128
+ * 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.
127
129
  * @summary Create Share for document(s)
128
130
  * @param {ShareRequest} shareRequest
129
131
  * @param {*} [options] Override http request option.
@@ -502,6 +504,45 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
502
504
  options: localVarRequestOptions,
503
505
  };
504
506
  },
507
+ /**
508
+ * 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
509
+ * @summary Set, change or remove the end date of share(s)
510
+ * @param {ShareExpiryRequest} shareExpiryRequest
511
+ * @param {*} [options] Override http request option.
512
+ * @throws {RequiredError}
513
+ */
514
+ updateShareExpiry: async (shareExpiryRequest: ShareExpiryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
515
+ // verify required parameter 'shareExpiryRequest' is not null or undefined
516
+ assertParamExists('updateShareExpiry', 'shareExpiryRequest', shareExpiryRequest)
517
+ const localVarPath = `/api/v1/users/share/expiry`;
518
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
519
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
520
+ let baseOptions;
521
+ if (configuration) {
522
+ baseOptions = configuration.baseOptions;
523
+ }
524
+
525
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
526
+ const localVarHeaderParameter = {} as any;
527
+ const localVarQueryParameter = {} as any;
528
+
529
+ // authentication keycloak_auth required
530
+ // http bearer authentication required
531
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
532
+
533
+ localVarHeaderParameter['Content-Type'] = 'application/json';
534
+ localVarHeaderParameter['Accept'] = '*/*';
535
+
536
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
537
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
538
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
539
+ localVarRequestOptions.data = serializeDataIfNeeded(shareExpiryRequest, localVarRequestOptions, configuration)
540
+
541
+ return {
542
+ url: toPathString(localVarUrlObj),
543
+ options: localVarRequestOptions,
544
+ };
545
+ },
505
546
  /**
506
547
  * Updates existing 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_NOT_ALREADY_SHARED: No existing share found for this document and user
507
548
  * @summary Update Share for document(s)
@@ -662,7 +703,7 @@ export const CollaborationControllerApiFp = function(configuration?: Configurati
662
703
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
663
704
  },
664
705
  /**
665
- * 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
706
+ * 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.
666
707
  * @summary Create Share for document(s)
667
708
  * @param {ShareRequest} shareRequest
668
709
  * @param {*} [options] Override http request option.
@@ -791,6 +832,19 @@ export const CollaborationControllerApiFp = function(configuration?: Configurati
791
832
  const localVarOperationServerBasePath = operationServerMap['CollaborationControllerApi.removeTeamMembers']?.[localVarOperationServerIndex]?.url;
792
833
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
793
834
  },
835
+ /**
836
+ * 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
837
+ * @summary Set, change or remove the end date of share(s)
838
+ * @param {ShareExpiryRequest} shareExpiryRequest
839
+ * @param {*} [options] Override http request option.
840
+ * @throws {RequiredError}
841
+ */
842
+ async updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>> {
843
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateShareExpiry(shareExpiryRequest, options);
844
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
845
+ const localVarOperationServerBasePath = operationServerMap['CollaborationControllerApi.updateShareExpiry']?.[localVarOperationServerIndex]?.url;
846
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
847
+ },
794
848
  /**
795
849
  * Updates existing 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_NOT_ALREADY_SHARED: No existing share found for this document and user
796
850
  * @summary Update Share for document(s)
@@ -863,7 +917,7 @@ export const CollaborationControllerApiFactory = function (configuration?: Confi
863
917
  return localVarFp.addTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
864
918
  },
865
919
  /**
866
- * 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
920
+ * 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.
867
921
  * @summary Create Share for document(s)
868
922
  * @param {ShareRequest} shareRequest
869
923
  * @param {*} [options] Override http request option.
@@ -962,6 +1016,16 @@ export const CollaborationControllerApiFactory = function (configuration?: Confi
962
1016
  removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
963
1017
  return localVarFp.removeTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
964
1018
  },
1019
+ /**
1020
+ * 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
1021
+ * @summary Set, change or remove the end date of share(s)
1022
+ * @param {ShareExpiryRequest} shareExpiryRequest
1023
+ * @param {*} [options] Override http request option.
1024
+ * @throws {RequiredError}
1025
+ */
1026
+ updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse> {
1027
+ return localVarFp.updateShareExpiry(shareExpiryRequest, options).then((request) => request(axios, basePath));
1028
+ },
965
1029
  /**
966
1030
  * Updates existing 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_NOT_ALREADY_SHARED: No existing share found for this document and user
967
1031
  * @summary Update Share for document(s)
@@ -1025,7 +1089,7 @@ export class CollaborationControllerApi extends BaseAPI {
1025
1089
  }
1026
1090
 
1027
1091
  /**
1028
- * 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
1092
+ * 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.
1029
1093
  * @summary Create Share for document(s)
1030
1094
  * @param {ShareRequest} shareRequest
1031
1095
  * @param {*} [options] Override http request option.
@@ -1134,6 +1198,17 @@ export class CollaborationControllerApi extends BaseAPI {
1134
1198
  return CollaborationControllerApiFp(this.configuration).removeTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
1135
1199
  }
1136
1200
 
1201
+ /**
1202
+ * 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
1203
+ * @summary Set, change or remove the end date of share(s)
1204
+ * @param {ShareExpiryRequest} shareExpiryRequest
1205
+ * @param {*} [options] Override http request option.
1206
+ * @throws {RequiredError}
1207
+ */
1208
+ public updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig) {
1209
+ return CollaborationControllerApiFp(this.configuration).updateShareExpiry(shareExpiryRequest, options).then((request) => request(this.axios, this.basePath));
1210
+ }
1211
+
1137
1212
  /**
1138
1213
  * Updates existing 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_NOT_ALREADY_SHARED: No existing share found for this document and user
1139
1214
  * @summary Update Share for document(s)