@openfilz-sdk/typescript-ee 1.7.5 → 1.8.1

package/docs/AISettingsApi.md

@@ -0,0 +1,256 @@
+# 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|
+|[**listModels**](#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models|
+|[**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)
+
+# **listModels**
+> AiModelsResponse listModels(listAiModelsRequest)
+
+Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration,
+    ListAiModelsRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+let listAiModelsRequest: ListAiModelsRequest; //
+
+const { status, data } = await apiInstance.listModels(
+    listAiModelsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listAiModelsRequest** | **ListAiModelsRequest**|  | |
+
+
+### Return type
+
+**AiModelsResponse**
+
+### 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)
+
+# **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/AiModelsResponse.md

@@ -0,0 +1,26 @@
+# AiModelsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** | Provider the list belongs to | [optional] [default to undefined]
+**models** | **Array<string>** | Model ids, best default first | [optional] [default to undefined]
+**source** | **string** | LIVE or FALLBACK | [optional] [default to undefined]
+**message** | **string** | Why the provider list is unavailable, when source is FALLBACK | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiModelsResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiModelsResponse = {
+    provider,
+    models,
+    source,
+    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)

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)

package/docs/ListAiModelsRequest.md

@@ -0,0 +1,24 @@
+# ListAiModelsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** | Chat LLM provider | [default to undefined]
+**baseUrl** | **string** | Base URL — required for OPENAI_COMPATIBLE, ignored otherwise | [optional] [default to undefined]
+**apiKey** | **string** | API key (write-only). Omit to use the stored key. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListAiModelsRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ListAiModelsRequest = {
+    provider,
+    baseUrl,
+    apiKey,
+};
+```
+
+[[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/SaveAiSettingsRequest.md

@@ -0,0 +1,26 @@
+# SaveAiSettingsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** | Chat LLM provider | [default to undefined]
+**model** | **string** | Model id, e.g. claude-opus-5, gpt-4o, gemini-2.5-flash | [optional] [default to undefined]
+**baseUrl** | **string** | Base URL — required for OPENAI_COMPATIBLE, ignored otherwise | [optional] [default to undefined]
+**apiKey** | **string** | API key (write-only). Omit to keep the stored key. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SaveAiSettingsRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: SaveAiSettingsRequest = {
+    provider,
+    model,
+    baseUrl,
+    apiKey,
+};
+```
+
+[[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

@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **language** | **string** |  | [optional] [default to undefined]
 **theme** | **string** |  | [optional] [default to undefined]
 **thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
+**aiActive** | **boolean** |  | [optional] [default to undefined]
+**aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -24,6 +26,8 @@ const instance: Settings = {
     language,
     theme,
     thumbnailsActive,
+    aiActive,
+    aiUserSettingsEnabled,
 };
 ```
 

package/models/ai-chat-conversation.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+
+export interface AiChatConversation {
+    'id'?: string;
+    'title'?: string;
+    'createdBy'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+}
+

package/models/ai-chat-request.ts

@@ -0,0 +1,21 @@
+/* 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.
+ */
+
+
+
+export interface AiChatRequest {
+    'message': string;
+    'conversationId'?: string;
+}
+

package/models/ai-chat-response.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+
+export interface AiChatResponse {
+    'conversationId'?: string;
+    'content'?: string;
+    'type'?: AiChatResponseTypeEnum;
+    'modifiedFolderIds'?: Array<string>;
+}
+
+export const AiChatResponseTypeEnum = {
+    Message: 'MESSAGE',
+    Done: 'DONE',
+    Error: 'ERROR',
+} as const;
+
+export type AiChatResponseTypeEnum = typeof AiChatResponseTypeEnum[keyof typeof AiChatResponseTypeEnum];
+
+

package/models/ai-connection-test-result.ts

@@ -0,0 +1,22 @@
+/* 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.
+ */
+
+
+
+export interface AiConnectionTestResult {
+    'ok'?: boolean;
+    'message'?: string;
+    'latencyMs'?: number;
+}
+

package/models/ai-models-response.ts

@@ -0,0 +1,51 @@
+/* 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.
+ */
+
+
+
+export interface AiModelsResponse {
+    /**
+     * Provider the list belongs to
+     */
+    'provider'?: AiModelsResponseProviderEnum;
+    /**
+     * Model ids, best default first
+     */
+    'models'?: Array<string>;
+    /**
+     * LIVE or FALLBACK
+     */
+    'source'?: AiModelsResponseSourceEnum;
+    /**
+     * Why the provider list is unavailable, when source is FALLBACK
+     */
+    'message'?: string;
+}
+
+export const AiModelsResponseProviderEnum = {
+    Openai: 'OPENAI',
+    Anthropic: 'ANTHROPIC',
+    Google: 'GOOGLE',
+    OpenaiCompatible: 'OPENAI_COMPATIBLE',
+} as const;
+
+export type AiModelsResponseProviderEnum = typeof AiModelsResponseProviderEnum[keyof typeof AiModelsResponseProviderEnum];
+export const AiModelsResponseSourceEnum = {
+    Live: 'LIVE',
+    Fallback: 'FALLBACK',
+} as const;
+
+export type AiModelsResponseSourceEnum = typeof AiModelsResponseSourceEnum[keyof typeof AiModelsResponseSourceEnum];
+
+

package/models/ai-settings-response.ts

@@ -0,0 +1,27 @@
+/* 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.
+ */
+
+
+
+export interface AiSettingsResponse {
+    'enabled'?: boolean;
+    'provider'?: string;
+    'model'?: string;
+    'baseUrl'?: string;
+    'hasApiKey'?: boolean;
+    'keySuffix'?: string;
+    'defaultProvider'?: string;
+    'defaultModel'?: string;
+}
+