@openfilz-sdk/typescript-ee 1.3.5

package/docs/ScannerProxyApi.md

@@ -0,0 +1,263 @@
+# ScannerProxyApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getIngestionStatus**](#getingestionstatus) | **GET** /api/v1/scan/status | Get ingestion status|
+|[**getScanJobStatus**](#getscanjobstatus) | **GET** /api/v1/scan/scanners/{id}/scan/{jobId}/status | Get scan job status|
+|[**getScannerCapabilities**](#getscannercapabilities) | **GET** /api/v1/scan/scanners/{id}/capabilities | Get scanner capabilities|
+|[**listScanners**](#listscanners) | **GET** /api/v1/scan/scanners | List scanners|
+|[**triggerScan**](#triggerscan) | **POST** /api/v1/scan/scanners/{id}/scan | Trigger scan|
+
+# **getIngestionStatus**
+> IngestionStatusDto getIngestionStatus()
+
+Returns ingestion service status including eSCL feature flag
+
+### Example
+
+```typescript
+import {
+    ScannerProxyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScannerProxyApi(configuration);
+
+const { status, data } = await apiInstance.getIngestionStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**IngestionStatusDto**
+
+### 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)
+
+# **getScanJobStatus**
+> ScanJobStatusDto getScanJobStatus()
+
+Get the status of a specific scan job
+
+### Example
+
+```typescript
+import {
+    ScannerProxyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScannerProxyApi(configuration);
+
+let id: string; // (default to undefined)
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getScanJobStatus(
+    id,
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ScanJobStatusDto**
+
+### 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)
+
+# **getScannerCapabilities**
+> ScannerInfoDto getScannerCapabilities()
+
+Get detailed capabilities for a specific scanner
+
+### Example
+
+```typescript
+import {
+    ScannerProxyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScannerProxyApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getScannerCapabilities(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ScannerInfoDto**
+
+### 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)
+
+# **listScanners**
+> Array<ScannerInfoDto> listScanners()
+
+List all discovered eSCL scanners on the network
+
+### Example
+
+```typescript
+import {
+    ScannerProxyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScannerProxyApi(configuration);
+
+const { status, data } = await apiInstance.listScanners();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ScannerInfoDto>**
+
+### 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)
+
+# **triggerScan**
+> ScanJobStatusDto triggerScan()
+
+Trigger a scan on a specific scanner
+
+### Example
+
+```typescript
+import {
+    ScannerProxyApi,
+    Configuration,
+    ScanRequestDto
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScannerProxyApi(configuration);
+
+let id: string; // (default to undefined)
+let authorization: string; // (optional) (default to undefined)
+let scanRequestDto: ScanRequestDto; // (optional)
+
+const { status, data } = await apiInstance.triggerScan(
+    id,
+    authorization,
+    scanRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **scanRequestDto** | **ScanRequestDto**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ScanJobStatusDto**
+
+### 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/SearchAdministrationApi.md

@@ -0,0 +1,187 @@
+# SearchAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createIndex**](#createindex) | **POST** /api/v1/admin/search | Create search index|
+|[**deleteIndex**](#deleteindex) | **DELETE** /api/v1/admin/search | Delete search index|
+|[**getStatus**](#getstatus) | **GET** /api/v1/admin/search/status | Get reindexation status|
+|[**reindexAll**](#reindexall) | **POST** /api/v1/admin/search/reindex | Reindex all documents|
+
+# **createIndex**
+> object createIndex()
+
+Creates or recreates the OpenSearch index with proper mappings and analyzer settings.
+
+### Example
+
+```typescript
+import {
+    SearchAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SearchAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.createIndex();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**object**
+
+### 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)
+
+# **deleteIndex**
+> object deleteIndex()
+
+Deletes the OpenSearch index. Requires full-text search to be enabled.
+
+### Example
+
+```typescript
+import {
+    SearchAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SearchAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.deleteIndex();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**object**
+
+### 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)
+
+# **getStatus**
+> object getStatus()
+
+Returns the current status of the reindexation process.
+
+### Example
+
+```typescript
+import {
+    SearchAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SearchAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.getStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**object**
+
+### 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)
+
+# **reindexAll**
+> object reindexAll()
+
+Triggers a full reindexation of all documents. Runs asynchronously in the background.
+
+### Example
+
+```typescript
+import {
+    SearchAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SearchAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.reindexAll();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**object**
+
+### 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/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-ee';
+
+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-ee';
+
+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-ee';
+
+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,30 @@
+# 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]
+**thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Settings } from '@openfilz-sdk/typescript-ee';
+
+const instance: Settings = {
+    emptyBinInterval,
+    fileQuotaMB,
+    userQuotaMB,
+    language,
+    theme,
+    thumbnailsActive,
+};
+```
+
+[[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/SettingsApi.md

@@ -0,0 +1,105 @@
+# SettingsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getSettings**](#getsettings) | **GET** /api/v1/settings | Get user\'s settings|
+|[**saveSettings**](#savesettings) | **PUT** /api/v1/settings | Save user preferences|
+
+# **getSettings**
+> Settings getSettings()
+
+Retrieve user\'s settings : global settings and user\'s preferences
+
+### Example
+
+```typescript
+import {
+    SettingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SettingsApi(configuration);
+
+const { status, data } = await apiInstance.getSettings();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Settings**
+
+### 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)
+
+# **saveSettings**
+> Settings saveSettings(userPreferencesRequest)
+
+Save user\'s language and theme preferences
+
+### Example
+
+```typescript
+import {
+    SettingsApi,
+    Configuration,
+    UserPreferencesRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SettingsApi(configuration);
+
+let userPreferencesRequest: UserPreferencesRequest; //
+
+const { status, data } = await apiInstance.saveSettings(
+    userPreferencesRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userPreferencesRequest** | **UserPreferencesRequest**|  | |
+
+
+### Return type
+
+**Settings**
+
+### 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/ShareRequest.md

@@ -0,0 +1,26 @@
+# ShareRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shareMode** | **string** | How to share documents with users | [default to undefined]
+**documentIds** | **Set<string>** | Document IDs to share | [default to undefined]
+**userIds** | **Set<string>** | User IDs to share with | [default to undefined]
+**message** | **string** | Optional message to include in the share notification | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShareRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ShareRequest = {
+    shareMode,
+    documentIds,
+    userIds,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)