@openfilz-sdk/typescript 1.1.5-SNAPSHOT → 1.1.7

package/docs/FolderControllerApi.md

@@ -0,0 +1,385 @@
+# FolderControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**copyFolders**](#copyfolders) | **POST** /api/v1/folders/copy | Copy folders|
+|[**countFolderElements**](#countfolderelements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists|
+|[**createFolder**](#createfolder) | **POST** /api/v1/folders | Create a new folder|
+|[**deleteFolders**](#deletefolders) | **DELETE** /api/v1/folders | Delete folders|
+|[**listFolder**](#listfolder) | **GET** /api/v1/folders/list | List files and subfolders contained in a given folder|
+|[**moveFolders**](#movefolders) | **POST** /api/v1/folders/move | Move folders|
+|[**renameFolder**](#renamefolder) | **PUT** /api/v1/folders/{folderId}/rename | Rename a folder|
+
+# **copyFolders**
+> copyFolders(copyRequest)
+
+Copies a set of folders (and their contents) into an existing target folder.
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration,
+    CopyRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let copyRequest: CopyRequest; //
+
+const { status, data } = await apiInstance.copyFolders(
+    copyRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **copyRequest** | **CopyRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **countFolderElements**
+> number countFolderElements()
+
+Retrieves the number of elements (files and folders) contained in a given folder - return 0 if empty or not exists(no recursive count, just count the flat list of objects at the root level of a folder)
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let folderId: string; //ID of the folder or to count elements at the root level (optional) (default to undefined)
+
+const { status, data } = await apiInstance.countFolderElements(
+    folderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | [**string**] | ID of the folder or to count elements at the root level | (optional) defaults to undefined|
+
+
+### Return type
+
+**number**
+
+### 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)
+
+# **createFolder**
+> FolderResponse createFolder(createFolderRequest)
+
+Creates a new folder, optionally under a parent folder.
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration,
+    CreateFolderRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let createFolderRequest: CreateFolderRequest; //
+
+const { status, data } = await apiInstance.createFolder(
+    createFolderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createFolderRequest** | **CreateFolderRequest**|  | |
+
+
+### Return type
+
+**FolderResponse**
+
+### 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)
+
+# **deleteFolders**
+> deleteFolders(deleteRequest)
+
+Deletes a set of folders and their contents from storage and database.
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration,
+    DeleteRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let deleteRequest: DeleteRequest; //
+
+const { status, data } = await apiInstance.deleteFolders(
+    deleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deleteRequest** | **DeleteRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **listFolder**
+> Array<FolderElementInfo> listFolder()
+
+Retrieves document information of all files and subfolders contained in a given folder (no recursive list, just the flat list of objects at the root level of a folder)
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let folderId: string; //if null, empty or not provided, then lists the content of the root folder (optional) (default to undefined)
+let onlyFiles: boolean; //if true, only files are listed (optional) (default to false)
+let onlyFolders: boolean; //if true, only folders are listed (optional) (default to false)
+
+const { status, data } = await apiInstance.listFolder(
+    folderId,
+    onlyFiles,
+    onlyFolders
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | [**string**] | if null, empty or not provided, then lists the content of the root folder | (optional) defaults to undefined|
+| **onlyFiles** | [**boolean**] | if true, only files are listed | (optional) defaults to false|
+| **onlyFolders** | [**boolean**] | if true, only folders are listed | (optional) defaults to false|
+
+
+### Return type
+
+**Array<FolderElementInfo>**
+
+### 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)
+
+# **moveFolders**
+> moveFolders(moveRequest)
+
+Moves a set of folders (and their contents) into an existing target folder.
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration,
+    MoveRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let moveRequest: MoveRequest; //
+
+const { status, data } = await apiInstance.moveFolders(
+    moveRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moveRequest** | **MoveRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **renameFolder**
+> ElementInfo renameFolder(renameRequest)
+
+Renames an existing folder.
+
+### Example
+
+```typescript
+import {
+    FolderControllerApi,
+    Configuration,
+    RenameRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FolderControllerApi(configuration);
+
+let folderId: string; // (default to undefined)
+let renameRequest: RenameRequest; //
+
+const { status, data } = await apiInstance.renameFolder(
+    folderId,
+    renameRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **renameRequest** | **RenameRequest**|  | |
+| **folderId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ElementInfo**
+
+### 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)
+

package/docs/FolderElementInfo.md

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

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

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

@@ -0,0 +1,24 @@
+# MoveRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** | List of document IDs (files or folders) to move. | [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 { MoveRequest } from '@openfilz-sdk/typescript';
+
+const instance: MoveRequest = {
+    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/RenameAudit.md

@@ -0,0 +1,21 @@
+# RenameAudit
+
+type=rename
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | New name of the document | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RenameAudit } from '@openfilz-sdk/typescript';
+
+const instance: RenameAudit = {
+    name,
+};
+```
+
+[[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/RenameRequest.md

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

@@ -0,0 +1,23 @@
+# ReplaceAudit
+
+type=replace
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { ReplaceAudit } from '@openfilz-sdk/typescript';
+
+const instance: ReplaceAudit = {
+    filename,
+    metadata,
+};
+```
+
+[[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/SearchByAuditLogRequest.md

@@ -0,0 +1,29 @@
+# SearchByAuditLogRequest
+
+Documents matching all provided criteria will be returned
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** | Username who made the action | [optional] [default to undefined]
+**id** | **string** | Document ID to search for | [optional] [default to undefined]
+**type** | **string** | Type of the document to search - if not provided or null : search all types | [optional] [default to undefined]
+**action** | **string** | Action to search for - if not provided or null : search all actions | [optional] [default to undefined]
+**details** | **{ [key: string]: any; }** | Audit Metadata key-value pairs to search for | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SearchByAuditLogRequest } from '@openfilz-sdk/typescript';
+
+const instance: SearchByAuditLogRequest = {
+    username,
+    id,
+    type,
+    action,
+    details,
+};
+```
+
+[[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/SearchByMetadataRequest.md

@@ -0,0 +1,29 @@
+# SearchByMetadataRequest
+
+Documents matching all provided criteria will be returned
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Optional : Name of the file - if not provided or null : search all file names | [optional] [default to undefined]
+**type** | **string** | Optional : Type of the document to search - if not provided or null : search all types | [optional] [default to undefined]
+**parentFolderId** | **string** | Optional : UUID of the parent folder to search - if not provided or null : search in all folders | [optional] [default to undefined]
+**rootOnly** | **boolean** | Optional : if true : search only at the root level - if not provided or null : search in all folders | [optional] [default to undefined]
+**metadataCriteria** | **{ [key: string]: any; }** | Metadata key-value pairs to search for | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SearchByMetadataRequest } from '@openfilz-sdk/typescript';
+
+const instance: SearchByMetadataRequest = {
+    name,
+    type,
+    parentFolderId,
+    rootOnly,
+    metadataCriteria,
+};
+```
+
+[[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/SearchMetadataRequest.md

@@ -0,0 +1,20 @@
+# SearchMetadataRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadataKeys** | **Array<string>** | Optional list of metadata keys to retrieve. If empty or null, all metadata are returned. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SearchMetadataRequest } from '@openfilz-sdk/typescript';
+
+const instance: SearchMetadataRequest = {
+    metadataKeys,
+};
+```
+
+[[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/Settings.md

@@ -0,0 +1,28 @@
+# Settings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emptyBinInterval** | **number** |  | [optional] [default to undefined]
+**fileQuotaMB** | **number** |  | [optional] [default to undefined]
+**userQuotaMB** | **number** |  | [optional] [default to undefined]
+**language** | **string** |  | [optional] [default to undefined]
+**theme** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Settings } from '@openfilz-sdk/typescript';
+
+const instance: Settings = {
+    emptyBinInterval,
+    fileQuotaMB,
+    userQuotaMB,
+    language,
+    theme,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)