@openfilz-sdk/typescript 1.2.3 → 1.2.4

package/dist/models/restore-version-audit.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/restore-version-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Result of restoring a previous version of a file document
+ */
+export interface RestoreVersionResponse {
+    /**
+     * Document identifier
+     */
+    'documentId'?: string;
+    /**
+     * Version identifier that was restored
+     */
+    'restoredFromVersionId'?: string;
+    /**
+     * Creation date of the restored version
+     */
+    'restoredFromDate'?: string;
+    /**
+     * Identifier of the new latest version created by the restore
+     */
+    'newVersionId'?: string;
+}

package/dist/models/restore-version-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/search-by-audit-log-request.d.ts

@@ -55,6 +55,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly MoveFolder: "MOVE_FOLDER";
     readonly UploadDocument: "UPLOAD_DOCUMENT";
     readonly ReplaceDocumentContent: "REPLACE_DOCUMENT_CONTENT";
+    readonly RestoreDocumentVersion: "RESTORE_DOCUMENT_VERSION";
     readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
     readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
     readonly DownloadDocument: "DOWNLOAD_DOCUMENT";

package/dist/models/search-by-audit-log-request.js

@@ -32,6 +32,7 @@ exports.SearchByAuditLogRequestActionEnum = {
     MoveFolder: 'MOVE_FOLDER',
     UploadDocument: 'UPLOAD_DOCUMENT',
     ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
+    RestoreDocumentVersion: 'RESTORE_DOCUMENT_VERSION',
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',

package/docs/AuditLogDetailsOneOf.md

@@ -9,12 +9,15 @@ Name | Type | Description | Notes
 **sourceFileId** | **string** |  | [optional] [default to undefined]
 **targetFolderId** | **string** |  | [optional] [default to undefined]
 **sourceFolderId** | **string** |  | [optional] [default to undefined]
+**versionId** | **string** | Storage version identifier created by this upload (only when versioning is enabled) | [optional] [default to undefined]
 **request** | [**CreateFolderRequest**](CreateFolderRequest.md) |  | [optional] [default to undefined]
 **deletedParentFolderId** | **string** |  | [optional] [default to undefined]
 **deletedMetadataKeys** | **Array<string>** | List of deleted metadata keys | [optional] [default to undefined]
 **name** | **string** | New name of the document | [optional] [default to undefined]
 **filename** | **string** |  | [optional] [default to undefined]
 **metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
+**restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
 **updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
 **parentFolderId** | **string** |  | [optional] [default to undefined]
 
@@ -28,12 +31,15 @@ const instance: AuditLogDetailsOneOf = {
     sourceFileId,
     targetFolderId,
     sourceFolderId,
+    versionId,
     request,
     deletedParentFolderId,
     deletedMetadataKeys,
     name,
     filename,
     metadata,
+    restoredFromVersionId,
+    restoredFromDate,
     updatedMetadata,
     parentFolderId,
 };

package/docs/CopyAudit.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **sourceFileId** | **string** |  | [optional] [default to undefined]
 **targetFolderId** | **string** |  | [optional] [default to undefined]
 **sourceFolderId** | **string** |  | [optional] [default to undefined]
+**versionId** | **string** | Storage version identifier of the copied file\'s initial version (only when versioning is enabled) | [optional] [default to undefined]
 
 ## Example
 
@@ -19,6 +20,7 @@ const instance: CopyAudit = {
     sourceFileId,
     targetFolderId,
     sourceFolderId,
+    versionId,
 };
 ```
 

package/docs/DocumentVersionControllerApi.md

@@ -0,0 +1,169 @@
+# DocumentVersionControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**downloadVersion**](#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version|
+|[**listVersions**](#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions|
+|[**restoreVersion**](#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version|
+
+# **downloadVersion**
+> File downloadVersion()
+
+Downloads the content of a specific stored version of a file document.
+
+### Example
+
+```typescript
+import {
+    DocumentVersionControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentVersionControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+let versionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.downloadVersion(
+    documentId,
+    versionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+| **versionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **listVersions**
+> Array<DocumentVersionInfo> listVersions()
+
+Lists all stored versions of a file document, newest first. Requires storage versioning to be enabled (otherwise HTTP 409).
+
+### Example
+
+```typescript
+import {
+    DocumentVersionControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentVersionControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.listVersions(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<DocumentVersionInfo>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **restoreVersion**
+> RestoreVersionResponse restoreVersion()
+
+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).
+
+### Example
+
+```typescript
+import {
+    DocumentVersionControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentVersionControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+let versionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.restoreVersion(
+    documentId,
+    versionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+| **versionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RestoreVersionResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/DocumentVersionInfo.md

@@ -0,0 +1,27 @@
+# DocumentVersionInfo
+
+Information about a single stored version of a file document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**versionId** | **string** | Storage version identifier (MinIO/S3 versionId) | [optional] [default to undefined]
+**lastModified** | **string** | Date the version was created | [optional] [default to undefined]
+**size** | **number** | Size of the version in bytes | [optional] [default to undefined]
+**latest** | **boolean** | True if this version is the current (latest) one | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentVersionInfo } from '@openfilz-sdk/typescript';
+
+const instance: DocumentVersionInfo = {
+    versionId,
+    lastModified,
+    size,
+    latest,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReplaceAudit.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **filename** | **string** | New file replacing the existing one | [optional] [default to undefined]
 **metadata** | **{ [key: string]: any; }** | New metadata replacing the existing ones | [optional] [default to undefined]
+**versionId** | **string** | Storage version identifier created by this replace (only when versioning is enabled) | [optional] [default to undefined]
 
 ## Example
 
@@ -17,6 +18,7 @@ import { ReplaceAudit } from '@openfilz-sdk/typescript';
 const instance: ReplaceAudit = {
     filename,
     metadata,
+    versionId,
 };
 ```
 

package/docs/RestoreVersionAudit.md

@@ -0,0 +1,27 @@
+# RestoreVersionAudit
+
+type=restoreVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **string** | Name of the file whose version was restored | [optional] [default to undefined]
+**restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
+**restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
+**versionId** | **string** | Identifier of the new latest version created by the restore | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreVersionAudit } from '@openfilz-sdk/typescript';
+
+const instance: RestoreVersionAudit = {
+    filename,
+    restoredFromVersionId,
+    restoredFromDate,
+    versionId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RestoreVersionResponse.md

@@ -0,0 +1,27 @@
+# RestoreVersionResponse
+
+Result of restoring a previous version of a file document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** | Document identifier | [optional] [default to undefined]
+**restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
+**restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
+**newVersionId** | **string** | Identifier of the new latest version created by the restore | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreVersionResponse } from '@openfilz-sdk/typescript';
+
+const instance: RestoreVersionResponse = {
+    documentId,
+    restoredFromVersionId,
+    restoredFromDate,
+    newVersionId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UploadAudit.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **filename** | **string** |  | [optional] [default to undefined]
 **parentFolderId** | **string** |  | [optional] [default to undefined]
 **metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**versionId** | **string** | Storage version identifier created by this upload (only when versioning is enabled) | [optional] [default to undefined]
 
 ## Example
 
@@ -19,6 +20,7 @@ const instance: UploadAudit = {
     filename,
     parentFolderId,
     metadata,
+    versionId,
 };
 ```
 

package/models/audit-log-details-one-of.ts

@@ -57,6 +57,9 @@ import type { RenameAudit } from './rename-audit';
 import type { ReplaceAudit } from './replace-audit';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { RestoreVersionAudit } from './restore-version-audit';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { UpdateMetadataAudit } from './update-metadata-audit';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -65,6 +68,6 @@ import type { UploadAudit } from './upload-audit';
 /**
  * @type AuditLogDetailsOneOf
  */
-export type AuditLogDetailsOneOf = { 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;
+export type AuditLogDetailsOneOf = { 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;
 
 

package/models/audit-log.ts

@@ -45,6 +45,7 @@ export const AuditLogActionEnum = {
     MoveFolder: 'MOVE_FOLDER',
     UploadDocument: 'UPLOAD_DOCUMENT',
     ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
+    RestoreDocumentVersion: 'RESTORE_DOCUMENT_VERSION',
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',

package/models/document-version-info.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Information about a single stored version of a file document
+ */
+export interface DocumentVersionInfo {
+    /**
+     * Storage version identifier (MinIO/S3 versionId)
+     */
+    'versionId'?: string;
+    /**
+     * Date the version was created
+     */
+    'lastModified'?: string;
+    /**
+     * Size of the version in bytes
+     */
+    'size'?: number;
+    /**
+     * True if this version is the current (latest) one
+     */
+    'latest'?: boolean;
+}
+

package/models/index.ts

@@ -17,6 +17,7 @@ export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './document-info';
 export * from './document-position';
+export * from './document-version-info';
 export * from './element-info';
 export * from './file-type-stats';
 export * from './filter-input';
@@ -27,6 +28,8 @@ export * from './move-request';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './replace-audit';
+export * from './restore-version-audit';
+export * from './restore-version-response';
 export * from './search-by-audit-log-request';
 export * from './search-by-metadata-request';
 export * from './search-metadata-request';

package/models/restore-version-audit.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditLogDetails } from './audit-log-details';
+
+/**
+ * @type RestoreVersionAudit
+ * type=restoreVersion
+ */
+export type RestoreVersionAudit = AuditLogDetails;
+
+

package/models/restore-version-response.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Result of restoring a previous version of a file document
+ */
+export interface RestoreVersionResponse {
+    /**
+     * Document identifier
+     */
+    'documentId'?: string;
+    /**
+     * Version identifier that was restored
+     */
+    'restoredFromVersionId'?: string;
+    /**
+     * Creation date of the restored version
+     */
+    'restoredFromDate'?: string;
+    /**
+     * Identifier of the new latest version created by the restore
+     */
+    'newVersionId'?: string;
+}
+

package/models/search-by-audit-log-request.ts

@@ -60,6 +60,7 @@ export const SearchByAuditLogRequestActionEnum = {
     MoveFolder: 'MOVE_FOLDER',
     UploadDocument: 'UPLOAD_DOCUMENT',
     ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
+    RestoreDocumentVersion: 'RESTORE_DOCUMENT_VERSION',
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "OpenAPI client for @openfilz-sdk/typescript",
   "author": "OpenAPI-Generator Contributors",
   "repository": {