@openfilz-sdk/typescript 1.1.5-SNAPSHOT → 1.1.7

package/docs/DocumentInfo.md

@@ -0,0 +1,30 @@
+# DocumentInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | Type of the document | [optional] [default to undefined]
+**contentType** | **string** | Content-Type of the document (MIME type) | [optional] [default to undefined]
+**name** | **string** | Name of the document | [optional] [default to undefined]
+**parentId** | **string** | ID of the parent folder. If null, located at root. | [optional] [default to undefined]
+**metadata** | **{ [key: string]: any; }** | Metadata of the document - if requested | [optional] [default to undefined]
+**size** | **number** | Size of the document - in bytes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentInfo } from '@openfilz-sdk/typescript';
+
+const instance: DocumentInfo = {
+    type,
+    contentType,
+    name,
+    parentId,
+    metadata,
+    size,
+};
+```
+
+[[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/DocumentPosition.md

@@ -0,0 +1,26 @@
+# DocumentPosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**parentId** | **string** |  | [optional] [default to undefined]
+**position** | **number** |  | [optional] [default to undefined]
+**totalItems** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentPosition } from '@openfilz-sdk/typescript';
+
+const instance: DocumentPosition = {
+    documentId,
+    parentId,
+    position,
+    totalItems,
+};
+```
+
+[[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/DocumentSuggestionControllerApi.md

@@ -0,0 +1,65 @@
+# DocumentSuggestionControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getSuggestions**](#getsuggestions) | **GET** /api/v1/suggestions | |
+
+# **getSuggestions**
+> Array<Suggest> getSuggestions()
+
+
+### Example
+
+```typescript
+import {
+    DocumentSuggestionControllerApi,
+    Configuration,
+    SortInput
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentSuggestionControllerApi(configuration);
+
+let q: string; // (default to undefined)
+let f: Array<FilterInput>; // (optional) (default to undefined)
+let s: SortInput; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSuggestions(
+    q,
+    f,
+    s
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **q** | [**string**] |  | defaults to undefined|
+| **f** | **Array&lt;FilterInput&gt;** |  | (optional) defaults to undefined|
+| **s** | **SortInput** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<Suggest>**
+
+### 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/ElementInfo.md

@@ -0,0 +1,24 @@
+# ElementInfo
+
+
+## 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 { ElementInfo } from '@openfilz-sdk/typescript';
+
+const instance: ElementInfo = {
+    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/FavoritesApi.md

@@ -0,0 +1,215 @@
+# FavoritesApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addFavorite**](#addfavorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites|
+|[**isFavorite**](#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status|
+|[**removeFavorite**](#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites|
+|[**toggleFavorite**](#togglefavorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status|
+
+# **addFavorite**
+> addFavorite()
+
+Add a file or folder to the user\'s favorites
+
+### Example
+
+```typescript
+import {
+    FavoritesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FavoritesApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.addFavorite(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **isFavorite**
+> boolean isFavorite()
+
+Check if a document is in the user\'s favorites
+
+### Example
+
+```typescript
+import {
+    FavoritesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FavoritesApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.isFavorite(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### 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)
+
+# **removeFavorite**
+> removeFavorite()
+
+Remove a file or folder from the user\'s favorites
+
+### Example
+
+```typescript
+import {
+    FavoritesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FavoritesApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.removeFavorite(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **toggleFavorite**
+> boolean toggleFavorite()
+
+Toggle favorite status for a document (add if not favorited, remove if already favorited)
+
+### Example
+
+```typescript
+import {
+    FavoritesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FavoritesApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.toggleFavorite(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### 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/FileControllerApi.md

@@ -0,0 +1,222 @@
+# FileControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**copyFiles**](#copyfiles) | **POST** /api/v1/files/copy | Copy files|
+|[**deleteFiles**](#deletefiles) | **DELETE** /api/v1/files | Delete files|
+|[**moveFiles**](#movefiles) | **POST** /api/v1/files/move | Move files|
+|[**renameFile**](#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file|
+
+# **copyFiles**
+> Array<CopyResponse> copyFiles(copyRequest)
+
+Copies a set of files into an existing target folder.
+
+### Example
+
+```typescript
+import {
+    FileControllerApi,
+    Configuration,
+    CopyRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FileControllerApi(configuration);
+
+let copyRequest: CopyRequest; //
+
+const { status, data } = await apiInstance.copyFiles(
+    copyRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **copyRequest** | **CopyRequest**|  | |
+
+
+### Return type
+
+**Array<CopyResponse>**
+
+### 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)
+
+# **deleteFiles**
+> deleteFiles(deleteRequest)
+
+Deletes a set of files from storage and database.
+
+### Example
+
+```typescript
+import {
+    FileControllerApi,
+    Configuration,
+    DeleteRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FileControllerApi(configuration);
+
+let deleteRequest: DeleteRequest; //
+
+const { status, data } = await apiInstance.deleteFiles(
+    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)
+
+# **moveFiles**
+> moveFiles(moveRequest)
+
+Moves a set of files into an existing target folder.
+
+### Example
+
+```typescript
+import {
+    FileControllerApi,
+    Configuration,
+    MoveRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FileControllerApi(configuration);
+
+let moveRequest: MoveRequest; //
+
+const { status, data } = await apiInstance.moveFiles(
+    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)
+
+# **renameFile**
+> ElementInfo renameFile(renameRequest)
+
+Renames an existing file.
+
+### Example
+
+```typescript
+import {
+    FileControllerApi,
+    Configuration,
+    RenameRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new FileControllerApi(configuration);
+
+let fileId: string; // (default to undefined)
+let renameRequest: RenameRequest; //
+
+const { status, data } = await apiInstance.renameFile(
+    fileId,
+    renameRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **renameRequest** | **RenameRequest**|  | |
+| **fileId** | [**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/FileTypeStats.md

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

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