@openfilz-sdk/typescript-ee 1.7.4 → 1.8.0

package/dist/models/ai-settings-response.d.ts

@@ -0,0 +1,21 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface AiSettingsResponse {
+    'enabled'?: boolean;
+    'provider'?: string;
+    'model'?: string;
+    'baseUrl'?: string;
+    'hasApiKey'?: boolean;
+    'keySuffix'?: string;
+    'defaultProvider'?: string;
+    'defaultModel'?: string;
+}

package/dist/models/ai-settings-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/index.d.ts

@@ -1,3 +1,8 @@
+export * from './ai-chat-conversation';
+export * from './ai-chat-request';
+export * from './ai-chat-response';
+export * from './ai-connection-test-result';
+export * from './ai-settings-response';
 export * from './ancestor-info';
 export * from './apply-signature-request';
 export * from './audit-log-details';
@@ -45,6 +50,7 @@ export * from './rename-request';
 export * from './replace-audit';
 export * from './restore-version-audit';
 export * from './restore-version-response';
+export * from './save-ai-settings-request';
 export * from './scan-job-status-dto';
 export * from './scan-request-dto';
 export * from './scanner-info-dto';

package/dist/models/index.js

@@ -14,6 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ai-chat-conversation"), exports);
+__exportStar(require("./ai-chat-request"), exports);
+__exportStar(require("./ai-chat-response"), exports);
+__exportStar(require("./ai-connection-test-result"), exports);
+__exportStar(require("./ai-settings-response"), exports);
 __exportStar(require("./ancestor-info"), exports);
 __exportStar(require("./apply-signature-request"), exports);
 __exportStar(require("./audit-log-details"), exports);
@@ -61,6 +66,7 @@ __exportStar(require("./rename-request"), exports);
 __exportStar(require("./replace-audit"), exports);
 __exportStar(require("./restore-version-audit"), exports);
 __exportStar(require("./restore-version-response"), exports);
+__exportStar(require("./save-ai-settings-request"), exports);
 __exportStar(require("./scan-job-status-dto"), exports);
 __exportStar(require("./scan-request-dto"), exports);
 __exportStar(require("./scanner-info-dto"), exports);

package/dist/models/save-ai-settings-request.d.ts

@@ -0,0 +1,36 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface SaveAiSettingsRequest {
+    /**
+     * Chat LLM provider
+     */
+    'provider': SaveAiSettingsRequestProviderEnum;
+    /**
+     * Model id, e.g. claude-opus-5, gpt-4o, gemini-2.5-flash
+     */
+    'model'?: string;
+    /**
+     * Base URL — required for OPENAI_COMPATIBLE, ignored otherwise
+     */
+    'baseUrl'?: string;
+    /**
+     * API key (write-only). Omit to keep the stored key.
+     */
+    'apiKey'?: string;
+}
+export declare const SaveAiSettingsRequestProviderEnum: {
+    readonly Openai: "OPENAI";
+    readonly Anthropic: "ANTHROPIC";
+    readonly Google: "GOOGLE";
+    readonly OpenaiCompatible: "OPENAI_COMPATIBLE";
+};
+export type SaveAiSettingsRequestProviderEnum = typeof SaveAiSettingsRequestProviderEnum[keyof typeof SaveAiSettingsRequestProviderEnum];

package/dist/models/save-ai-settings-request.js

@@ -0,0 +1,22 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaveAiSettingsRequestProviderEnum = void 0;
+exports.SaveAiSettingsRequestProviderEnum = {
+    Openai: 'OPENAI',
+    Anthropic: 'ANTHROPIC',
+    Google: 'GOOGLE',
+    OpenaiCompatible: 'OPENAI_COMPATIBLE',
+};

package/dist/models/settings.d.ts

@@ -16,4 +16,6 @@ export interface Settings {
     'language'?: string;
     'theme'?: string;
     'thumbnailsActive'?: boolean;
+    'aiActive'?: boolean;
+    'aiUserSettingsEnabled'?: boolean;
 }

package/docs/AIChatApi.md

@@ -0,0 +1,209 @@
+# AIChatApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**chat**](#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant|
+|[**deleteConversation**](#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation|
+|[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
+|[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
+
+# **chat**
+> Array<AiChatResponse> chat(aiChatRequest)
+
+Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
+
+### Example
+
+```typescript
+import {
+    AIChatApi,
+    Configuration,
+    AiChatRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIChatApi(configuration);
+
+let aiChatRequest: AiChatRequest; //
+
+const { status, data } = await apiInstance.chat(
+    aiChatRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aiChatRequest** | **AiChatRequest**|  | |
+
+
+### Return type
+
+**Array<AiChatResponse>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteConversation**
+> deleteConversation()
+
+Delete a conversation and all its messages
+
+### Example
+
+```typescript
+import {
+    AIChatApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIChatApi(configuration);
+
+let conversationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteConversation(
+    conversationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **conversationId** | [**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)
+
+# **getConversationHistory**
+> Array<AiChatResponse> getConversationHistory()
+
+Get all messages in a conversation
+
+### Example
+
+```typescript
+import {
+    AIChatApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIChatApi(configuration);
+
+let conversationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getConversationHistory(
+    conversationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **conversationId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<AiChatResponse>**
+
+### 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)
+
+# **listConversations**
+> Array<AiChatConversation> listConversations()
+
+Get all AI chat conversations for the current user
+
+### Example
+
+```typescript
+import {
+    AIChatApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIChatApi(configuration);
+
+const { status, data } = await apiInstance.listConversations();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AiChatConversation>**
+
+### 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/AISettingsApi.md

@@ -0,0 +1,203 @@
+# AISettingsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteSettings**](#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings|
+|[**getSettings1**](#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings|
+|[**saveSettings1**](#savesettings1) | **PUT** /api/v1/settings/ai | Save my AI settings|
+|[**testConnection**](#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection|
+
+# **deleteSettings**
+> deleteSettings()
+
+Remove my chat-LLM override and go back to the server default model.
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+const { status, data } = await apiInstance.deleteSettings();
+```
+
+### 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)
+
+# **getSettings1**
+> AiSettingsResponse getSettings1()
+
+Current user\'s chat-LLM override. The API key is never returned — only hasApiKey and its last characters.
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+const { status, data } = await apiInstance.getSettings1();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiSettingsResponse**
+
+### 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)
+
+# **saveSettings1**
+> AiSettingsResponse saveSettings1(saveAiSettingsRequest)
+
+Set the chat LLM to use for my conversations. Omit apiKey to keep the previously stored key.
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration,
+    SaveAiSettingsRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+let saveAiSettingsRequest: SaveAiSettingsRequest; //
+
+const { status, data } = await apiInstance.saveSettings1(
+    saveAiSettingsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveAiSettingsRequest** | **SaveAiSettingsRequest**|  | |
+
+
+### Return type
+
+**AiSettingsResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **testConnection**
+> AiConnectionTestResult testConnection(saveAiSettingsRequest)
+
+Send a minimal completion request with the submitted settings (falls back to the stored key when apiKey is omitted).
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration,
+    SaveAiSettingsRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+let saveAiSettingsRequest: SaveAiSettingsRequest; //
+
+const { status, data } = await apiInstance.testConnection(
+    saveAiSettingsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveAiSettingsRequest** | **SaveAiSettingsRequest**|  | |
+
+
+### Return type
+
+**AiConnectionTestResult**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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/AiChatConversation.md

@@ -0,0 +1,28 @@
+# AiChatConversation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiChatConversation } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiChatConversation = {
+    id,
+    title,
+    createdBy,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/AiChatRequest.md

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

@@ -0,0 +1,26 @@
+# AiChatResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversationId** | **string** |  | [optional] [default to undefined]
+**content** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**modifiedFolderIds** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiChatResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiChatResponse = {
+    conversationId,
+    content,
+    type,
+    modifiedFolderIds,
+};
+```
+
+[[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/AiConnectionTestResult.md

@@ -0,0 +1,24 @@
+# AiConnectionTestResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ok** | **boolean** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**latencyMs** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiConnectionTestResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiConnectionTestResult = {
+    ok,
+    message,
+    latencyMs,
+};
+```
+
+[[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/AiSettingsResponse.md

@@ -0,0 +1,34 @@
+# AiSettingsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**provider** | **string** |  | [optional] [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**baseUrl** | **string** |  | [optional] [default to undefined]
+**hasApiKey** | **boolean** |  | [optional] [default to undefined]
+**keySuffix** | **string** |  | [optional] [default to undefined]
+**defaultProvider** | **string** |  | [optional] [default to undefined]
+**defaultModel** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiSettingsResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiSettingsResponse = {
+    enabled,
+    provider,
+    model,
+    baseUrl,
+    hasApiKey,
+    keySuffix,
+    defaultProvider,
+    defaultModel,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)