@openfilz-sdk/typescript 1.1.5-SNAPSHOT → 1.1.6

package/dist/models/upload-audit.d.ts

@@ -9,36 +9,9 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { AuditLogDetails } from './audit-log-details';
 /**
+ * @type UploadAudit
  * type=upload
- * @export
- * @interface UploadAudit
  */
-export interface UploadAudit {
-    /**
-     *
-     * @type {string}
-     * @memberof UploadAudit
-     */
-    'type': string;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadAudit
-     */
-    'filename'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadAudit
-     */
-    'parentFolderId'?: string;
-    /**
-     *
-     * @type {{ [key: string]: any; }}
-     * @memberof UploadAudit
-     */
-    'metadata'?: {
-        [key: string]: any;
-    };
-}
+export type UploadAudit = AuditLogDetails;

package/dist/models/upload-response.d.ts

@@ -9,46 +9,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface UploadResponse
- */
 export interface UploadResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof UploadResponse
-     */
     'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadResponse
-     */
     'name'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadResponse
-     */
     'contentType'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof UploadResponse
-     */
     'size'?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadResponse
-     */
     'errorType'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UploadResponse
-     */
     'errorMessage'?: string;
 }

package/docs/AncestorInfo.md

@@ -0,0 +1,24 @@
+# AncestorInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AncestorInfo } from '@openfilz-sdk/typescript';
+
+const instance: AncestorInfo = {
+    id,
+    name,
+    type,
+};
+```
+
+[[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/AuditControllerApi.md

@@ -0,0 +1,160 @@
+# AuditControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource|
+|[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails|
+|[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|
+
+# **getAuditTrail**
+> Array<AuditLog> getAuditTrail()
+
+Retrieves the audit trail for a given resource.
+
+### Example
+
+```typescript
+import {
+    AuditControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AuditControllerApi(configuration);
+
+let id: string; //ID of the resource to get the audit trail for (default to undefined)
+let sort: 'ASC' | 'DESC'; //Sort order for the audit trail. Can be \'ASC\' or \'DESC\'. Default is \'DESC\' (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAuditTrail(
+    id,
+    sort
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID of the resource to get the audit trail for | defaults to undefined|
+| **sort** | [**&#39;ASC&#39; | &#39;DESC&#39;**]**Array<&#39;ASC&#39; &#124; &#39;DESC&#39;>** | Sort order for the audit trail. Can be \&#39;ASC\&#39; or \&#39;DESC\&#39;. Default is \&#39;DESC\&#39; | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<AuditLog>**
+
+### 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)
+
+# **searchAuditTrail**
+> Array<AuditLog> searchAuditTrail(searchByAuditLogRequest)
+
+Retrieves the audit trail according to the search parameters
+
+### Example
+
+```typescript
+import {
+    AuditControllerApi,
+    Configuration,
+    SearchByAuditLogRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AuditControllerApi(configuration);
+
+let searchByAuditLogRequest: SearchByAuditLogRequest; //
+
+const { status, data } = await apiInstance.searchAuditTrail(
+    searchByAuditLogRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchByAuditLogRequest** | **SearchByAuditLogRequest**|  | |
+
+
+### Return type
+
+**Array<AuditLog>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **verifyChain**
+> AuditVerificationResult verifyChain()
+
+Verifies the cryptographic hash chain of the audit log to detect any tampering.
+
+### Example
+
+```typescript
+import {
+    AuditControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AuditControllerApi(configuration);
+
+const { status, data } = await apiInstance.verifyChain();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuditVerificationResult**
+
+### 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/AuditLog.md

@@ -0,0 +1,35 @@
+# AuditLog
+
+Audit information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**timestamp** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**resourceType** | **string** |  | [optional] [default to undefined]
+**details** | [**AuditLogDetailsOneOf**](AuditLogDetailsOneOf.md) |  | [optional] [default to undefined]
+**previousHash** | **string** |  | [optional] [default to undefined]
+**hash** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditLog } from '@openfilz-sdk/typescript';
+
+const instance: AuditLog = {
+    id,
+    timestamp,
+    username,
+    action,
+    resourceType,
+    details,
+    previousHash,
+    hash,
+};
+```
+
+[[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/AuditLogDetails.md

@@ -0,0 +1,20 @@
+# AuditLogDetails
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AuditLogDetails } from '@openfilz-sdk/typescript';
+
+const instance: AuditLogDetails = {
+    type,
+};
+```
+
+[[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/AuditLogDetailsOneOf.md

@@ -0,0 +1,42 @@
+# AuditLogDetailsOneOf
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**sourceFileId** | **string** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+**sourceFolderId** | **string** |  | [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]
+**updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
+**parentFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditLogDetailsOneOf } from '@openfilz-sdk/typescript';
+
+const instance: AuditLogDetailsOneOf = {
+    type,
+    sourceFileId,
+    targetFolderId,
+    sourceFolderId,
+    request,
+    deletedParentFolderId,
+    deletedMetadataKeys,
+    name,
+    filename,
+    metadata,
+    updatedMetadata,
+    parentFolderId,
+};
+```
+
+[[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/AuditVerificationResult.md

@@ -0,0 +1,29 @@
+# AuditVerificationResult
+
+Result of audit chain integrity verification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to undefined]
+**totalEntries** | **number** |  | [optional] [default to undefined]
+**verifiedEntries** | **number** |  | [optional] [default to undefined]
+**verifiedAt** | **string** |  | [optional] [default to undefined]
+**brokenLink** | [**BrokenLink**](BrokenLink.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditVerificationResult } from '@openfilz-sdk/typescript';
+
+const instance: AuditVerificationResult = {
+    status,
+    totalEntries,
+    verifiedEntries,
+    verifiedAt,
+    brokenLink,
+};
+```
+
+[[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/BrokenLink.md

@@ -0,0 +1,24 @@
+# BrokenLink
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entryId** | **number** |  | [optional] [default to undefined]
+**expectedHash** | **string** |  | [optional] [default to undefined]
+**actualHash** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BrokenLink } from '@openfilz-sdk/typescript';
+
+const instance: BrokenLink = {
+    entryId,
+    expectedHash,
+    actualHash,
+};
+```
+
+[[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/CopyAudit.md

@@ -0,0 +1,25 @@
+# CopyAudit
+
+type=copy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceFileId** | **string** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+**sourceFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CopyAudit } from '@openfilz-sdk/typescript';
+
+const instance: CopyAudit = {
+    sourceFileId,
+    targetFolderId,
+    sourceFolderId,
+};
+```
+
+[[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/CopyRequest.md

@@ -0,0 +1,24 @@
+# CopyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** | List of document IDs (files or folders) to copy. | [optional] [default to undefined]
+**targetFolderId** | **string** | ID of the target folder. | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** | when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CopyRequest } from '@openfilz-sdk/typescript';
+
+const instance: CopyRequest = {
+    documentIds,
+    targetFolderId,
+    allowDuplicateFileNames,
+};
+```
+
+[[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/CopyResponse.md

@@ -0,0 +1,22 @@
+# CopyResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**originalId** | **string** | Original file ID | [optional] [default to undefined]
+**copyId** | **string** | Copied file ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CopyResponse } from '@openfilz-sdk/typescript';
+
+const instance: CopyResponse = {
+    originalId,
+    copyId,
+};
+```
+
+[[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/CreateBlankDocumentRequest.md

@@ -0,0 +1,24 @@
+# CreateBlankDocumentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**documentType** | **string** | Type of blank document to create: WORD, EXCEL, POWERPOINT, or TEXT | [default to undefined]
+**parentFolderId** | **string** | ID of the parent folder. If null, created at root. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBlankDocumentRequest } from '@openfilz-sdk/typescript';
+
+const instance: CreateBlankDocumentRequest = {
+    name,
+    documentType,
+    parentFolderId,
+};
+```
+
+[[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/CreateFolderAudit.md

@@ -0,0 +1,23 @@
+# CreateFolderAudit
+
+type=createFolder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request** | [**CreateFolderRequest**](CreateFolderRequest.md) |  | [optional] [default to undefined]
+**sourceFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateFolderAudit } from '@openfilz-sdk/typescript';
+
+const instance: CreateFolderAudit = {
+    request,
+    sourceFolderId,
+};
+```
+
+[[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/CreateFolderRequest.md

@@ -0,0 +1,22 @@
+# CreateFolderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**parentId** | **string** | ID of the parent folder. If null, created at root. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateFolderRequest } from '@openfilz-sdk/typescript';
+
+const instance: CreateFolderRequest = {
+    name,
+    parentId,
+};
+```
+
+[[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/DashboardApi.md

@@ -0,0 +1,52 @@
+# DashboardApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getDashboardStatistics**](#getdashboardstatistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics|
+
+# **getDashboardStatistics**
+> DashboardStatisticsResponse getDashboardStatistics()
+
+Retrieve aggregated dashboard metrics including file counts, storage usage, and file type distribution
+
+### Example
+
+```typescript
+import {
+    DashboardApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DashboardApi(configuration);
+
+const { status, data } = await apiInstance.getDashboardStatistics();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**DashboardStatisticsResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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/DashboardStatisticsResponse.md

@@ -0,0 +1,26 @@
+# DashboardStatisticsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalFiles** | **number** |  | [optional] [default to undefined]
+**totalFolders** | **number** |  | [optional] [default to undefined]
+**storage** | [**StorageBreakdown**](StorageBreakdown.md) |  | [optional] [default to undefined]
+**fileTypeCounts** | [**Array<FileTypeStats>**](FileTypeStats.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DashboardStatisticsResponse } from '@openfilz-sdk/typescript';
+
+const instance: DashboardStatisticsResponse = {
+    totalFiles,
+    totalFolders,
+    storage,
+    fileTypeCounts,
+};
+```
+
+[[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/DeleteAudit.md

@@ -0,0 +1,21 @@
+# DeleteAudit
+
+type=delete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deletedParentFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteAudit } from '@openfilz-sdk/typescript';
+
+const instance: DeleteAudit = {
+    deletedParentFolderId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)