@openfilz-sdk/typescript-ee 1.3.5

package/docs/NotificationsApi.md

@@ -0,0 +1,239 @@
+# NotificationsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getNotifications**](#getnotifications) | **GET** /api/v1/notifications | Get all notifications|
+|[**getUnreadCount**](#getunreadcount) | **GET** /api/v1/notifications/unread/count | Get unread notification count|
+|[**markAllAsRead**](#markallasread) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read|
+|[**markAsRead**](#markasread) | **PUT** /api/v1/notifications/{id}/read | Mark notification as read|
+|[**streamNotifications**](#streamnotifications) | **GET** /api/v1/notifications/stream | Subscribe to notification stream|
+
+# **getNotifications**
+> Array<NotificationDTO> getNotifications()
+
+Retrieve all notifications for the authenticated user
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+const { status, data } = await apiInstance.getNotifications();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<NotificationDTO>**
+
+### 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)
+
+# **getUnreadCount**
+> number getUnreadCount()
+
+Get the count of unread notifications for the authenticated user
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+const { status, data } = await apiInstance.getUnreadCount();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**number**
+
+### 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)
+
+# **markAllAsRead**
+> markAllAsRead()
+
+Mark all notifications for the authenticated user as read
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+const { status, data } = await apiInstance.markAllAsRead();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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)
+
+# **markAsRead**
+> markAsRead()
+
+Mark a specific notification as read
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.markAsRead(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**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)
+
+# **streamNotifications**
+> Array<any> streamNotifications()
+
+Server-Sent Events stream for real-time notifications
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+const { status, data } = await apiInstance.streamNotifications();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<any>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/event-stream
+
+
+### 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/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-ee';
+
+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-ee';
+
+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-ee';
+
+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/ScanAgentApi.md

@@ -0,0 +1,110 @@
+# ScanAgentApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**download**](#download) | **GET** /api/v1/agent/download/{platform} | Download agent binary|
+|[**getVersion**](#getversion) | **GET** /api/v1/agent/version | Get agent version|
+
+# **download**
+> File download()
+
+Downloads the scan agent for the specified platform. Use format=zip (default) for the portable ZIP archive, or format=installer for the native installer (.deb/.exe/.dmg). Supports ETag-based caching to avoid redundant downloads.
+
+### Example
+
+```typescript
+import {
+    ScanAgentApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScanAgentApi(configuration);
+
+let platform: string; // (default to undefined)
+let format: string; // (optional) (default to 'zip')
+let ifNoneMatch: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.download(
+    platform,
+    format,
+    ifNoneMatch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **platform** | [**string**] |  | defaults to undefined|
+| **format** | [**string**] |  | (optional) defaults to 'zip'|
+| **ifNoneMatch** | [**string**] |  | (optional) 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)
+
+# **getVersion**
+> { [key: string]: any; } getVersion()
+
+Returns the expected agent version, available platforms, and download formats (zip, installer)
+
+### Example
+
+```typescript
+import {
+    ScanAgentApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ScanAgentApi(configuration);
+
+const { status, data } = await apiInstance.getVersion();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### 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/ScanJobStatusDto.md

@@ -0,0 +1,32 @@
+# ScanJobStatusDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**scannerId** | **string** |  | [optional] [default to undefined]
+**state** | **string** |  | [optional] [default to undefined]
+**documentId** | **string** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScanJobStatusDto } from '@openfilz-sdk/typescript-ee';
+
+const instance: ScanJobStatusDto = {
+    jobId,
+    scannerId,
+    state,
+    documentId,
+    error,
+    startedAt,
+    completedAt,
+};
+```
+
+[[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/ScanRequestDto.md

@@ -0,0 +1,28 @@
+# ScanRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resolution** | **number** |  | [optional] [default to undefined]
+**colorMode** | **string** |  | [optional] [default to undefined]
+**format** | **string** |  | [optional] [default to undefined]
+**targetFolderPath** | **string** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScanRequestDto } from '@openfilz-sdk/typescript-ee';
+
+const instance: ScanRequestDto = {
+    resolution,
+    colorMode,
+    format,
+    targetFolderPath,
+    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/ScannerInfoDto.md

@@ -0,0 +1,36 @@
+# ScannerInfoDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**manufacturer** | **string** |  | [optional] [default to undefined]
+**baseUrl** | **string** |  | [optional] [default to undefined]
+**available** | **boolean** |  | [optional] [default to undefined]
+**supportedFormats** | **Array<string>** |  | [optional] [default to undefined]
+**supportedResolutions** | **Array<number>** |  | [optional] [default to undefined]
+**supportedColorModes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScannerInfoDto } from '@openfilz-sdk/typescript-ee';
+
+const instance: ScannerInfoDto = {
+    id,
+    name,
+    model,
+    manufacturer,
+    baseUrl,
+    available,
+    supportedFormats,
+    supportedResolutions,
+    supportedColorModes,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)