@openfilz-sdk/typescript-ee 1.5.3 → 1.6.1

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 (152) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  4. package/README.md +8 -2
  5. package/api/collaboration-audit-controller-api.ts +2 -2
  6. package/api/collaboration-controller-api.ts +9 -9
  7. package/api/comments-api.ts +2 -2
  8. package/api/delegated-browse-grants-admin-api.ts +3 -3
  9. package/api/delegated-browse-grants-end-user-api.ts +5 -5
  10. package/api/digital-signature-api.ts +3 -3
  11. package/api/document-controller-api.ts +10 -10
  12. package/api/document-version-controller-api.ts +288 -0
  13. package/api/favorites-api.ts +4 -4
  14. package/api/file-controller-api.ts +1 -1
  15. package/api/folder-controller-api.ts +1 -1
  16. package/api/notifications-api.ts +1 -1
  17. package/api/scan-agent-api.ts +1 -1
  18. package/api/scanner-proxy-api.ts +4 -4
  19. package/api/tus-controller-api.ts +6 -6
  20. package/api.ts +1 -0
  21. package/configuration.ts +2 -2
  22. package/dist/api/collaboration-audit-controller-api.js +2 -2
  23. package/dist/api/collaboration-controller-api.js +9 -9
  24. package/dist/api/comments-api.js +2 -2
  25. package/dist/api/delegated-browse-grants-admin-api.js +3 -3
  26. package/dist/api/delegated-browse-grants-end-user-api.js +5 -5
  27. package/dist/api/digital-signature-api.js +3 -3
  28. package/dist/api/document-controller-api.js +10 -10
  29. package/dist/api/document-version-controller-api.d.ts +140 -0
  30. package/dist/api/document-version-controller-api.js +284 -0
  31. package/dist/api/favorites-api.js +4 -4
  32. package/dist/api/file-controller-api.js +1 -1
  33. package/dist/api/folder-controller-api.js +1 -1
  34. package/dist/api/notifications-api.js +1 -1
  35. package/dist/api/scan-agent-api.js +1 -1
  36. package/dist/api/scanner-proxy-api.js +4 -4
  37. package/dist/api/tus-controller-api.js +6 -6
  38. package/dist/api.d.ts +1 -0
  39. package/dist/api.js +1 -0
  40. package/dist/configuration.js +2 -2
  41. package/dist/esm/api/collaboration-audit-controller-api.js +2 -2
  42. package/dist/esm/api/collaboration-controller-api.js +9 -9
  43. package/dist/esm/api/comments-api.js +2 -2
  44. package/dist/esm/api/delegated-browse-grants-admin-api.js +3 -3
  45. package/dist/esm/api/delegated-browse-grants-end-user-api.js +5 -5
  46. package/dist/esm/api/digital-signature-api.js +3 -3
  47. package/dist/esm/api/document-controller-api.js +10 -10
  48. package/dist/esm/api/document-version-controller-api.d.ts +140 -0
  49. package/dist/esm/api/document-version-controller-api.js +277 -0
  50. package/dist/esm/api/favorites-api.js +4 -4
  51. package/dist/esm/api/file-controller-api.js +1 -1
  52. package/dist/esm/api/folder-controller-api.js +1 -1
  53. package/dist/esm/api/notifications-api.js +1 -1
  54. package/dist/esm/api/scan-agent-api.js +1 -1
  55. package/dist/esm/api/scanner-proxy-api.js +4 -4
  56. package/dist/esm/api/tus-controller-api.js +6 -6
  57. package/dist/esm/api.d.ts +1 -0
  58. package/dist/esm/api.js +1 -0
  59. package/dist/esm/configuration.js +2 -2
  60. package/dist/esm/models/audit-verification-result.js +1 -1
  61. package/dist/esm/models/create-blank-document-request.js +1 -1
  62. package/dist/esm/models/create-delegated-grant-request.js +1 -1
  63. package/dist/esm/models/delegated-grant-dto.js +2 -2
  64. package/dist/esm/models/document-info.js +1 -1
  65. package/dist/esm/models/document-version-info.d.ts +32 -0
  66. package/dist/esm/models/document-version-info.js +14 -0
  67. package/dist/esm/models/enriched-audit-log-details.d.ts +3 -0
  68. package/dist/esm/models/enriched-audit-log.d.ts +1 -0
  69. package/dist/esm/models/enriched-audit-log.js +3 -2
  70. package/dist/esm/models/folder-element-info.js +1 -1
  71. package/dist/esm/models/index.d.ts +3 -0
  72. package/dist/esm/models/index.js +3 -0
  73. package/dist/esm/models/notification-dto.js +1 -1
  74. package/dist/esm/models/public-signature-view.js +2 -2
  75. package/dist/esm/models/restore-version-audit.d.ts +17 -0
  76. package/dist/esm/models/restore-version-audit.js +14 -0
  77. package/dist/esm/models/restore-version-response.d.ts +32 -0
  78. package/dist/esm/models/restore-version-response.js +14 -0
  79. package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
  80. package/dist/esm/models/search-by-audit-log-request.js +3 -2
  81. package/dist/esm/models/search-by-metadata-request.js +1 -1
  82. package/dist/esm/models/share-request.js +1 -1
  83. package/dist/esm/models/share-result-error.js +1 -1
  84. package/dist/esm/models/signature-envelope-dto.js +1 -1
  85. package/dist/esm/models/signature-recipient-dto.js +1 -1
  86. package/dist/esm/models/sort-input.js +1 -1
  87. package/dist/esm/models/team-member-info.js +1 -1
  88. package/dist/esm/models/update-user-request.js +1 -1
  89. package/dist/esm/models/user-registration-request.js +1 -1
  90. package/dist/models/audit-verification-result.js +1 -1
  91. package/dist/models/create-blank-document-request.js +1 -1
  92. package/dist/models/create-delegated-grant-request.js +1 -1
  93. package/dist/models/delegated-grant-dto.js +2 -2
  94. package/dist/models/document-info.js +1 -1
  95. package/dist/models/document-version-info.d.ts +32 -0
  96. package/dist/models/document-version-info.js +15 -0
  97. package/dist/models/enriched-audit-log-details.d.ts +3 -0
  98. package/dist/models/enriched-audit-log.d.ts +1 -0
  99. package/dist/models/enriched-audit-log.js +3 -2
  100. package/dist/models/folder-element-info.js +1 -1
  101. package/dist/models/index.d.ts +3 -0
  102. package/dist/models/index.js +3 -0
  103. package/dist/models/notification-dto.js +1 -1
  104. package/dist/models/public-signature-view.js +2 -2
  105. package/dist/models/restore-version-audit.d.ts +17 -0
  106. package/dist/models/restore-version-audit.js +15 -0
  107. package/dist/models/restore-version-response.d.ts +32 -0
  108. package/dist/models/restore-version-response.js +15 -0
  109. package/dist/models/search-by-audit-log-request.d.ts +1 -0
  110. package/dist/models/search-by-audit-log-request.js +3 -2
  111. package/dist/models/search-by-metadata-request.js +1 -1
  112. package/dist/models/share-request.js +1 -1
  113. package/dist/models/share-result-error.js +1 -1
  114. package/dist/models/signature-envelope-dto.js +1 -1
  115. package/dist/models/signature-recipient-dto.js +1 -1
  116. package/dist/models/sort-input.js +1 -1
  117. package/dist/models/team-member-info.js +1 -1
  118. package/dist/models/update-user-request.js +1 -1
  119. package/dist/models/user-registration-request.js +1 -1
  120. package/docs/CopyAudit.md +2 -0
  121. package/docs/DocumentVersionControllerApi.md +169 -0
  122. package/docs/DocumentVersionInfo.md +27 -0
  123. package/docs/EnrichedAuditLogDetails.md +6 -0
  124. package/docs/ReplaceAudit.md +2 -0
  125. package/docs/RestoreVersionAudit.md +27 -0
  126. package/docs/RestoreVersionResponse.md +27 -0
  127. package/docs/UploadAudit.md +2 -0
  128. package/models/audit-verification-result.ts +1 -1
  129. package/models/create-blank-document-request.ts +1 -1
  130. package/models/create-delegated-grant-request.ts +1 -1
  131. package/models/delegated-grant-dto.ts +2 -2
  132. package/models/document-info.ts +1 -1
  133. package/models/document-version-info.ts +38 -0
  134. package/models/enriched-audit-log-details.ts +4 -1
  135. package/models/enriched-audit-log.ts +3 -2
  136. package/models/folder-element-info.ts +1 -1
  137. package/models/index.ts +3 -0
  138. package/models/notification-dto.ts +1 -1
  139. package/models/public-signature-view.ts +2 -2
  140. package/models/restore-version-audit.ts +26 -0
  141. package/models/restore-version-response.ts +38 -0
  142. package/models/search-by-audit-log-request.ts +3 -2
  143. package/models/search-by-metadata-request.ts +1 -1
  144. package/models/share-request.ts +1 -1
  145. package/models/share-result-error.ts +1 -1
  146. package/models/signature-envelope-dto.ts +1 -1
  147. package/models/signature-recipient-dto.ts +1 -1
  148. package/models/sort-input.ts +1 -1
  149. package/models/team-member-info.ts +1 -1
  150. package/models/update-user-request.ts +1 -1
  151. package/models/user-registration-request.ts +1 -1
  152. package/package.json +2 -2
package/docs/CopyAudit.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **sourceFileId** | **string** | | [optional] [default to undefined]
10
10
  **targetFolderId** | **string** | | [optional] [default to undefined]
11
11
  **sourceFolderId** | **string** | | [optional] [default to undefined]
12
+ **versionId** | **string** | Storage version identifier of the copied file\'s initial version (only when versioning is enabled) | [optional] [default to undefined]
12
13
 
13
14
  ## Example
14
15
 
@@ -19,6 +20,7 @@ const instance: CopyAudit = {
19
20
  sourceFileId,
20
21
  targetFolderId,
21
22
  sourceFolderId,
23
+ versionId,
22
24
  };
23
25
  ```
24
26
 
@@ -0,0 +1,169 @@
1
+ # DocumentVersionControllerApi
2
+
3
+ All URIs are relative to *http://localhost:8081*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**downloadVersion**](#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version|
8
+ |[**listVersions**](#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions|
9
+ |[**restoreVersion**](#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version|
10
+
11
+ # **downloadVersion**
12
+ > File downloadVersion()
13
+
14
+ Downloads the content of a specific stored version of a file document.
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ DocumentVersionControllerApi,
21
+ Configuration
22
+ } from '@openfilz-sdk/typescript-ee';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new DocumentVersionControllerApi(configuration);
26
+
27
+ let documentId: string; // (default to undefined)
28
+ let versionId: string; // (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.downloadVersion(
31
+ documentId,
32
+ versionId
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **documentId** | [**string**] | | defaults to undefined|
41
+ | **versionId** | [**string**] | | defaults to undefined|
42
+
43
+
44
+ ### Return type
45
+
46
+ **File**
47
+
48
+ ### Authorization
49
+
50
+ [keycloak_auth](../README.md#keycloak_auth)
51
+
52
+ ### HTTP request headers
53
+
54
+ - **Content-Type**: Not defined
55
+ - **Accept**: */*
56
+
57
+
58
+ ### HTTP response details
59
+ | Status code | Description | Response headers |
60
+ |-------------|-------------|------------------|
61
+ |**200** | OK | - |
62
+
63
+ [[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)
64
+
65
+ # **listVersions**
66
+ > Array<DocumentVersionInfo> listVersions()
67
+
68
+ Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
69
+
70
+ ### Example
71
+
72
+ ```typescript
73
+ import {
74
+ DocumentVersionControllerApi,
75
+ Configuration
76
+ } from '@openfilz-sdk/typescript-ee';
77
+
78
+ const configuration = new Configuration();
79
+ const apiInstance = new DocumentVersionControllerApi(configuration);
80
+
81
+ let documentId: string; // (default to undefined)
82
+
83
+ const { status, data } = await apiInstance.listVersions(
84
+ documentId
85
+ );
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ |Name | Type | Description | Notes|
91
+ |------------- | ------------- | ------------- | -------------|
92
+ | **documentId** | [**string**] | | defaults to undefined|
93
+
94
+
95
+ ### Return type
96
+
97
+ **Array<DocumentVersionInfo>**
98
+
99
+ ### Authorization
100
+
101
+ [keycloak_auth](../README.md#keycloak_auth)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: Not defined
106
+ - **Accept**: */*
107
+
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
+ # **restoreVersion**
117
+ > RestoreVersionResponse restoreVersion()
118
+
119
+ Restores the selected version as the new latest version. History-preserving: a new version is created on top, no version is deleted, and a RESTORE_DOCUMENT_VERSION audit entry is logged. Restoring the current latest version is rejected (HTTP 400).
120
+
121
+ ### Example
122
+
123
+ ```typescript
124
+ import {
125
+ DocumentVersionControllerApi,
126
+ Configuration
127
+ } from '@openfilz-sdk/typescript-ee';
128
+
129
+ const configuration = new Configuration();
130
+ const apiInstance = new DocumentVersionControllerApi(configuration);
131
+
132
+ let documentId: string; // (default to undefined)
133
+ let versionId: string; // (default to undefined)
134
+
135
+ const { status, data } = await apiInstance.restoreVersion(
136
+ documentId,
137
+ versionId
138
+ );
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ |Name | Type | Description | Notes|
144
+ |------------- | ------------- | ------------- | -------------|
145
+ | **documentId** | [**string**] | | defaults to undefined|
146
+ | **versionId** | [**string**] | | defaults to undefined|
147
+
148
+
149
+ ### Return type
150
+
151
+ **RestoreVersionResponse**
152
+
153
+ ### Authorization
154
+
155
+ [keycloak_auth](../README.md#keycloak_auth)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: */*
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ |**200** | OK | - |
167
+
168
+ [[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)
169
+
@@ -0,0 +1,27 @@
1
+ # DocumentVersionInfo
2
+
3
+ Information about a single stored version of a file document
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **versionId** | **string** | Storage version identifier (MinIO/S3 versionId) | [optional] [default to undefined]
10
+ **lastModified** | **string** | Date the version was created | [optional] [default to undefined]
11
+ **size** | **number** | Size of the version in bytes | [optional] [default to undefined]
12
+ **latest** | **boolean** | True if this version is the current (latest) one | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { DocumentVersionInfo } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: DocumentVersionInfo = {
20
+ versionId,
21
+ lastModified,
22
+ size,
23
+ latest,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -9,12 +9,15 @@ Name | Type | Description | Notes
9
9
  **sourceFileId** | **string** | | [optional] [default to undefined]
10
10
  **targetFolderId** | **string** | | [optional] [default to undefined]
11
11
  **sourceFolderId** | **string** | | [optional] [default to undefined]
12
+ **versionId** | **string** | Storage version identifier created by this upload (only when versioning is enabled) | [optional] [default to undefined]
12
13
  **request** | [**CreateFolderRequest**](CreateFolderRequest.md) | | [optional] [default to undefined]
13
14
  **deletedParentFolderId** | **string** | | [optional] [default to undefined]
14
15
  **deletedMetadataKeys** | **Array&lt;string&gt;** | List of deleted metadata keys | [optional] [default to undefined]
15
16
  **name** | **string** | New name of the document | [optional] [default to undefined]
16
17
  **filename** | **string** | | [optional] [default to undefined]
17
18
  **metadata** | **{ [key: string]: any; }** | | [optional] [default to undefined]
19
+ **restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
20
+ **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
18
21
  **updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
19
22
  **parentFolderId** | **string** | | [optional] [default to undefined]
20
23
 
@@ -28,12 +31,15 @@ const instance: EnrichedAuditLogDetails = {
28
31
  sourceFileId,
29
32
  targetFolderId,
30
33
  sourceFolderId,
34
+ versionId,
31
35
  request,
32
36
  deletedParentFolderId,
33
37
  deletedMetadataKeys,
34
38
  name,
35
39
  filename,
36
40
  metadata,
41
+ restoredFromVersionId,
42
+ restoredFromDate,
37
43
  updatedMetadata,
38
44
  parentFolderId,
39
45
  };
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **filename** | **string** | New file replacing the existing one | [optional] [default to undefined]
10
10
  **metadata** | **{ [key: string]: any; }** | New metadata replacing the existing ones | [optional] [default to undefined]
11
+ **versionId** | **string** | Storage version identifier created by this replace (only when versioning is enabled) | [optional] [default to undefined]
11
12
 
12
13
  ## Example
13
14
 
@@ -17,6 +18,7 @@ import { ReplaceAudit } from '@openfilz-sdk/typescript-ee';
17
18
  const instance: ReplaceAudit = {
18
19
  filename,
19
20
  metadata,
21
+ versionId,
20
22
  };
21
23
  ```
22
24
 
@@ -0,0 +1,27 @@
1
+ # RestoreVersionAudit
2
+
3
+ type=restoreVersion
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **filename** | **string** | Name of the file whose version was restored | [optional] [default to undefined]
10
+ **restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
11
+ **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
12
+ **versionId** | **string** | Identifier of the new latest version created by the restore | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { RestoreVersionAudit } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: RestoreVersionAudit = {
20
+ filename,
21
+ restoredFromVersionId,
22
+ restoredFromDate,
23
+ versionId,
24
+ };
25
+ ```
26
+
27
+ [[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,27 @@
1
+ # RestoreVersionResponse
2
+
3
+ Result of restoring a previous version of a file document
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **documentId** | **string** | Document identifier | [optional] [default to undefined]
10
+ **restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
11
+ **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
12
+ **newVersionId** | **string** | Identifier of the new latest version created by the restore | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { RestoreVersionResponse } from '@openfilz-sdk/typescript-ee';
18
+
19
+ const instance: RestoreVersionResponse = {
20
+ documentId,
21
+ restoredFromVersionId,
22
+ restoredFromDate,
23
+ newVersionId,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **filename** | **string** | | [optional] [default to undefined]
10
10
  **parentFolderId** | **string** | | [optional] [default to undefined]
11
11
  **metadata** | **{ [key: string]: any; }** | | [optional] [default to undefined]
12
+ **versionId** | **string** | Storage version identifier created by this upload (only when versioning is enabled) | [optional] [default to undefined]
12
13
 
13
14
  ## Example
14
15
 
@@ -19,6 +20,7 @@ const instance: UploadAudit = {
19
20
  filename,
20
21
  parentFolderId,
21
22
  metadata,
23
+ versionId,
22
24
  };
23
25
  ```
24
26
 
@@ -31,7 +31,7 @@ export interface AuditVerificationResult {
31
31
  export const AuditVerificationResultStatusEnum = {
32
32
  Valid: 'VALID',
33
33
  Broken: 'BROKEN',
34
- Empty: 'EMPTY'
34
+ Empty: 'EMPTY',
35
35
  } as const;
36
36
 
37
37
  export type AuditVerificationResultStatusEnum = typeof AuditVerificationResultStatusEnum[keyof typeof AuditVerificationResultStatusEnum];
@@ -30,7 +30,7 @@ export const CreateBlankDocumentRequestDocumentTypeEnum = {
30
30
  Word: 'WORD',
31
31
  Excel: 'EXCEL',
32
32
  Powerpoint: 'POWERPOINT',
33
- Text: 'TEXT'
33
+ Text: 'TEXT',
34
34
  } as const;
35
35
 
36
36
  export type CreateBlankDocumentRequestDocumentTypeEnum = typeof CreateBlankDocumentRequestDocumentTypeEnum[keyof typeof CreateBlankDocumentRequestDocumentTypeEnum];
@@ -22,7 +22,7 @@ export interface CreateDelegatedGrantRequest {
22
22
  }
23
23
 
24
24
  export const CreateDelegatedGrantRequestPurposeEnum = {
25
- WebhookSubscription: 'WEBHOOK_SUBSCRIPTION'
25
+ WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
26
26
  } as const;
27
27
 
28
28
  export type CreateDelegatedGrantRequestPurposeEnum = typeof CreateDelegatedGrantRequestPurposeEnum[keyof typeof CreateDelegatedGrantRequestPurposeEnum];
@@ -35,7 +35,7 @@ export interface DelegatedGrantDTO {
35
35
  }
36
36
 
37
37
  export const DelegatedGrantDTOPurposeEnum = {
38
- WebhookSubscription: 'WEBHOOK_SUBSCRIPTION'
38
+ WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
39
39
  } as const;
40
40
 
41
41
  export type DelegatedGrantDTOPurposeEnum = typeof DelegatedGrantDTOPurposeEnum[keyof typeof DelegatedGrantDTOPurposeEnum];
@@ -45,7 +45,7 @@ export const DelegatedGrantDTOStatusEnum = {
45
45
  Declined: 'DECLINED',
46
46
  Revoked: 'REVOKED',
47
47
  Expired: 'EXPIRED',
48
- Consumed: 'CONSUMED'
48
+ Consumed: 'CONSUMED',
49
49
  } as const;
50
50
 
51
51
  export type DelegatedGrantDTOStatusEnum = typeof DelegatedGrantDTOStatusEnum[keyof typeof DelegatedGrantDTOStatusEnum];
@@ -43,7 +43,7 @@ export interface DocumentInfo {
43
43
 
44
44
  export const DocumentInfoTypeEnum = {
45
45
  File: 'FILE',
46
- Folder: 'FOLDER'
46
+ Folder: 'FOLDER',
47
47
  } as const;
48
48
 
49
49
  export type DocumentInfoTypeEnum = typeof DocumentInfoTypeEnum[keyof typeof DocumentInfoTypeEnum];
@@ -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
+ /**
18
+ * Information about a single stored version of a file document
19
+ */
20
+ export interface DocumentVersionInfo {
21
+ /**
22
+ * Storage version identifier (MinIO/S3 versionId)
23
+ */
24
+ 'versionId'?: string;
25
+ /**
26
+ * Date the version was created
27
+ */
28
+ 'lastModified'?: string;
29
+ /**
30
+ * Size of the version in bytes
31
+ */
32
+ 'size'?: number;
33
+ /**
34
+ * True if this version is the current (latest) one
35
+ */
36
+ 'latest'?: boolean;
37
+ }
38
+
@@ -39,6 +39,9 @@ import type { RenameAudit } from './rename-audit';
39
39
  import type { ReplaceAudit } from './replace-audit';
40
40
  // May contain unused imports in some cases
41
41
  // @ts-ignore
42
+ import type { RestoreVersionAudit } from './restore-version-audit';
43
+ // May contain unused imports in some cases
44
+ // @ts-ignore
42
45
  import type { UpdateMetadataAudit } from './update-metadata-audit';
43
46
  // May contain unused imports in some cases
44
47
  // @ts-ignore
@@ -47,6 +50,6 @@ import type { UploadAudit } from './upload-audit';
47
50
  /**
48
51
  * @type EnrichedAuditLogDetails
49
52
  */
50
- export type EnrichedAuditLogDetails = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
53
+ export type EnrichedAuditLogDetails = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'restoreVersion' } & RestoreVersionAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
51
54
 
52
55
 
@@ -47,6 +47,7 @@ export const EnrichedAuditLogActionEnum = {
47
47
  MoveFolder: 'MOVE_FOLDER',
48
48
  UploadDocument: 'UPLOAD_DOCUMENT',
49
49
  ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
50
+ RestoreDocumentVersion: 'RESTORE_DOCUMENT_VERSION',
50
51
  ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
51
52
  UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
52
53
  DownloadDocument: 'DOWNLOAD_DOCUMENT',
@@ -79,13 +80,13 @@ export const EnrichedAuditLogActionEnum = {
79
80
  SignatureEnvelopeCompleted: 'SIGNATURE_ENVELOPE_COMPLETED',
80
81
  SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
81
82
  SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
82
- SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED'
83
+ SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED',
83
84
  } as const;
84
85
 
85
86
  export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];
86
87
  export const EnrichedAuditLogResourceTypeEnum = {
87
88
  File: 'FILE',
88
- Folder: 'FOLDER'
89
+ Folder: 'FOLDER',
89
90
  } as const;
90
91
 
91
92
  export type EnrichedAuditLogResourceTypeEnum = typeof EnrichedAuditLogResourceTypeEnum[keyof typeof EnrichedAuditLogResourceTypeEnum];
@@ -31,7 +31,7 @@ export interface FolderElementInfo {
31
31
 
32
32
  export const FolderElementInfoTypeEnum = {
33
33
  File: 'FILE',
34
- Folder: 'FOLDER'
34
+ Folder: 'FOLDER',
35
35
  } as const;
36
36
 
37
37
  export type FolderElementInfoTypeEnum = typeof FolderElementInfoTypeEnum[keyof typeof FolderElementInfoTypeEnum];
package/models/index.ts CHANGED
@@ -26,6 +26,7 @@ export * from './delete-request';
26
26
  export * from './delete-share-request';
27
27
  export * from './document-info';
28
28
  export * from './document-position';
29
+ export * from './document-version-info';
29
30
  export * from './element-info';
30
31
  export * from './enriched-audit-log';
31
32
  export * from './enriched-audit-log-details';
@@ -42,6 +43,8 @@ export * from './public-signature-view';
42
43
  export * from './rename-audit';
43
44
  export * from './rename-request';
44
45
  export * from './replace-audit';
46
+ export * from './restore-version-audit';
47
+ export * from './restore-version-response';
45
48
  export * from './scan-job-status-dto';
46
49
  export * from './scan-request-dto';
47
50
  export * from './scanner-info-dto';
@@ -36,7 +36,7 @@ export const NotificationDTOTypeEnum = {
36
36
  DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED',
37
37
  SignatureRequest: 'SIGNATURE_REQUEST',
38
38
  SignatureCompleted: 'SIGNATURE_COMPLETED',
39
- SignatureDeclined: 'SIGNATURE_DECLINED'
39
+ SignatureDeclined: 'SIGNATURE_DECLINED',
40
40
  } as const;
41
41
 
42
42
  export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];
@@ -38,7 +38,7 @@ export const PublicSignatureViewEnvelopeStatusEnum = {
38
38
  Completed: 'COMPLETED',
39
39
  Declined: 'DECLINED',
40
40
  Cancelled: 'CANCELLED',
41
- Expired: 'EXPIRED'
41
+ Expired: 'EXPIRED',
42
42
  } as const;
43
43
 
44
44
  export type PublicSignatureViewEnvelopeStatusEnum = typeof PublicSignatureViewEnvelopeStatusEnum[keyof typeof PublicSignatureViewEnvelopeStatusEnum];
@@ -46,7 +46,7 @@ export const PublicSignatureViewRecipientStatusEnum = {
46
46
  Pending: 'PENDING',
47
47
  Viewed: 'VIEWED',
48
48
  Signed: 'SIGNED',
49
- Declined: 'DECLINED'
49
+ Declined: 'DECLINED',
50
50
  } as const;
51
51
 
52
52
  export type PublicSignatureViewRecipientStatusEnum = typeof PublicSignatureViewRecipientStatusEnum[keyof typeof PublicSignatureViewRecipientStatusEnum];
@@ -0,0 +1,26 @@
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 { AuditLogDetails } from './audit-log-details';
19
+
20
+ /**
21
+ * @type RestoreVersionAudit
22
+ * type=restoreVersion
23
+ */
24
+ export type RestoreVersionAudit = AuditLogDetails;
25
+
26
+
@@ -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
+ /**
18
+ * Result of restoring a previous version of a file document
19
+ */
20
+ export interface RestoreVersionResponse {
21
+ /**
22
+ * Document identifier
23
+ */
24
+ 'documentId'?: string;
25
+ /**
26
+ * Version identifier that was restored
27
+ */
28
+ 'restoredFromVersionId'?: string;
29
+ /**
30
+ * Creation date of the restored version
31
+ */
32
+ 'restoredFromDate'?: string;
33
+ /**
34
+ * Identifier of the new latest version created by the restore
35
+ */
36
+ 'newVersionId'?: string;
37
+ }
38
+
@@ -42,7 +42,7 @@ export interface SearchByAuditLogRequest {
42
42
 
43
43
  export const SearchByAuditLogRequestTypeEnum = {
44
44
  File: 'FILE',
45
- Folder: 'FOLDER'
45
+ Folder: 'FOLDER',
46
46
  } as const;
47
47
 
48
48
  export type SearchByAuditLogRequestTypeEnum = typeof SearchByAuditLogRequestTypeEnum[keyof typeof SearchByAuditLogRequestTypeEnum];
@@ -60,6 +60,7 @@ export const SearchByAuditLogRequestActionEnum = {
60
60
  MoveFolder: 'MOVE_FOLDER',
61
61
  UploadDocument: 'UPLOAD_DOCUMENT',
62
62
  ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
63
+ RestoreDocumentVersion: 'RESTORE_DOCUMENT_VERSION',
63
64
  ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
64
65
  UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
65
66
  DownloadDocument: 'DOWNLOAD_DOCUMENT',
@@ -92,7 +93,7 @@ export const SearchByAuditLogRequestActionEnum = {
92
93
  SignatureEnvelopeCompleted: 'SIGNATURE_ENVELOPE_COMPLETED',
93
94
  SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
94
95
  SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
95
- SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED'
96
+ SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED',
96
97
  } as const;
97
98
 
98
99
  export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];
@@ -42,7 +42,7 @@ export interface SearchByMetadataRequest {
42
42
 
43
43
  export const SearchByMetadataRequestTypeEnum = {
44
44
  File: 'FILE',
45
- Folder: 'FOLDER'
45
+ Folder: 'FOLDER',
46
46
  } as const;
47
47
 
48
48
  export type SearchByMetadataRequestTypeEnum = typeof SearchByMetadataRequestTypeEnum[keyof typeof SearchByMetadataRequestTypeEnum];
@@ -36,7 +36,7 @@ export interface ShareRequest {
36
36
  export const ShareRequestShareModeEnum = {
37
37
  Reader: 'READER',
38
38
  Commenter: 'COMMENTER',
39
- Editor: 'EDITOR'
39
+ Editor: 'EDITOR',
40
40
  } as const;
41
41
 
42
42
  export type ShareRequestShareModeEnum = typeof ShareRequestShareModeEnum[keyof typeof ShareRequestShareModeEnum];
@@ -27,7 +27,7 @@ export const ShareResultErrorCodeEnum = {
27
27
  ShareErrAlreadyExists: 'SHARE_ERR_ALREADY_EXISTS',
28
28
  ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
29
29
  ShareErrOwner: 'SHARE_ERR_OWNER',
30
- ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED'
30
+ ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
31
31
  } as const;
32
32
 
33
33
  export type ShareResultErrorCodeEnum = typeof ShareResultErrorCodeEnum[keyof typeof ShareResultErrorCodeEnum];
@@ -37,7 +37,7 @@ export const SignatureEnvelopeDTOStatusEnum = {
37
37
  Completed: 'COMPLETED',
38
38
  Declined: 'DECLINED',
39
39
  Cancelled: 'CANCELLED',
40
- Expired: 'EXPIRED'
40
+ Expired: 'EXPIRED',
41
41
  } as const;
42
42
 
43
43
  export type SignatureEnvelopeDTOStatusEnum = typeof SignatureEnvelopeDTOStatusEnum[keyof typeof SignatureEnvelopeDTOStatusEnum];