@openfilz-sdk/typescript-ee 1.7.5 → 1.8.1

package/.openapi-generator/FILES

@@ -3,6 +3,8 @@
 .openapi-generator-ignore
 README.md
 api.ts
+api/aichat-api.ts
+api/aisettings-api.ts
 api/collaboration-audit-controller-api.ts
 api/collaboration-controller-api.ts
 api/comments-api.ts
@@ -29,6 +31,14 @@ api/webhook-proxy-controller-api.ts
 base.ts
 common.ts
 configuration.ts
+docs/AIChatApi.md
+docs/AISettingsApi.md
+docs/AiChatConversation.md
+docs/AiChatRequest.md
+docs/AiChatResponse.md
+docs/AiConnectionTestResult.md
+docs/AiModelsResponse.md
+docs/AiSettingsResponse.md
 docs/AncestorInfo.md
 docs/ApplySignatureRequest.md
 docs/AuditLogDetails.md
@@ -80,6 +90,7 @@ docs/FolderControllerApi.md
 docs/FolderElementInfo.md
 docs/FolderResponse.md
 docs/IngestionStatusDto.md
+docs/ListAiModelsRequest.md
 docs/MintUploadTokenRequest.md
 docs/MoveAudit.md
 docs/MoveRequest.md
@@ -91,6 +102,7 @@ docs/RenameRequest.md
 docs/ReplaceAudit.md
 docs/RestoreVersionAudit.md
 docs/RestoreVersionResponse.md
+docs/SaveAiSettingsRequest.md
 docs/ScanAgentApi.md
 docs/ScanJobStatusDto.md
 docs/ScanRequestDto.md
@@ -136,6 +148,12 @@ docs/UserRegistrationRequest.md
 docs/WebhookProxyControllerApi.md
 git_push.sh
 index.ts
+models/ai-chat-conversation.ts
+models/ai-chat-request.ts
+models/ai-chat-response.ts
+models/ai-connection-test-result.ts
+models/ai-models-response.ts
+models/ai-settings-response.ts
 models/ancestor-info.ts
 models/apply-signature-request.ts
 models/audit-log-details.ts
@@ -174,6 +192,7 @@ models/folder-element-info.ts
 models/folder-response.ts
 models/index.ts
 models/ingestion-status-dto.ts
+models/list-ai-models-request.ts
 models/mint-upload-token-request.ts
 models/move-audit.ts
 models/move-request.ts
@@ -184,6 +203,7 @@ models/rename-request.ts
 models/replace-audit.ts
 models/restore-version-audit.ts
 models/restore-version-response.ts
+models/save-ai-settings-request.ts
 models/scan-job-status-dto.ts
 models/scan-request-dto.ts
 models/scanner-info-dto.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-c7b50acb04abc267eaff2ba784a7b16453d461600b68acea47ab15d9adc5c2c1
+f0f3f75483025352b66bf396930e57a333db8165ff0b818b117f058c39b8bf9a

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript-ee@1.7.5
+## @openfilz-sdk/typescript-ee@1.8.1
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript-ee@1.7.5 --save
+npm install @openfilz-sdk/typescript-ee@1.8.1 --save
 ```
 
 _unPublished (not recommended):_
@@ -51,6 +51,15 @@ All URIs are relative to *http://localhost:8081*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*AIChatApi* | [**chat**](docs/AIChatApi.md#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant
+*AIChatApi* | [**deleteConversation**](docs/AIChatApi.md#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation
+*AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
+*AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
+*AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
+*AISettingsApi* | [**getSettings1**](docs/AISettingsApi.md#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings
+*AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
+*AISettingsApi* | [**saveSettings1**](docs/AISettingsApi.md#savesettings1) | **PUT** /api/v1/settings/ai | Save my AI settings
+*AISettingsApi* | [**testConnection**](docs/AISettingsApi.md#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection
 *CollaborationAuditControllerApi* | [**getAuditTrail**](docs/CollaborationAuditControllerApi.md#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource (enriched with actor azp)
 *CollaborationAuditControllerApi* | [**searchAuditTrail**](docs/CollaborationAuditControllerApi.md#searchaudittrail) | **POST** /api/v1/audit/search | Search audit trail (enriched with actor azp)
 *CollaborationAuditControllerApi* | [**verifyChain**](docs/CollaborationAuditControllerApi.md#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity
@@ -170,6 +179,12 @@ Class | Method | HTTP request | Description
 
 ### Documentation For Models
 
+ - [AiChatConversation](docs/AiChatConversation.md)
+ - [AiChatRequest](docs/AiChatRequest.md)
+ - [AiChatResponse](docs/AiChatResponse.md)
+ - [AiConnectionTestResult](docs/AiConnectionTestResult.md)
+ - [AiModelsResponse](docs/AiModelsResponse.md)
+ - [AiSettingsResponse](docs/AiSettingsResponse.md)
  - [AncestorInfo](docs/AncestorInfo.md)
  - [ApplySignatureRequest](docs/ApplySignatureRequest.md)
  - [AuditLogDetails](docs/AuditLogDetails.md)
@@ -207,6 +222,7 @@ Class | Method | HTTP request | Description
  - [FolderElementInfo](docs/FolderElementInfo.md)
  - [FolderResponse](docs/FolderResponse.md)
  - [IngestionStatusDto](docs/IngestionStatusDto.md)
+ - [ListAiModelsRequest](docs/ListAiModelsRequest.md)
  - [MintUploadTokenRequest](docs/MintUploadTokenRequest.md)
  - [MoveAudit](docs/MoveAudit.md)
  - [MoveRequest](docs/MoveRequest.md)
@@ -217,6 +233,7 @@ Class | Method | HTTP request | Description
  - [ReplaceAudit](docs/ReplaceAudit.md)
  - [RestoreVersionAudit](docs/RestoreVersionAudit.md)
  - [RestoreVersionResponse](docs/RestoreVersionResponse.md)
+ - [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
  - [ScanJobStatusDto](docs/ScanJobStatusDto.md)
  - [ScanRequestDto](docs/ScanRequestDto.md)
  - [ScannerInfoDto](docs/ScannerInfoDto.md)

package/api/aichat-api.ts

@@ -0,0 +1,341 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { AiChatConversation } from '../models';
+// @ts-ignore
+import type { AiChatRequest } from '../models';
+// @ts-ignore
+import type { AiChatResponse } from '../models';
+/**
+ * AIChatApi - axios parameter creator
+ */
+export const AIChatApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
+         * @summary Chat with AI assistant
+         * @param {AiChatRequest} aiChatRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        chat: async (aiChatRequest: AiChatRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'aiChatRequest' is not null or undefined
+            assertParamExists('chat', 'aiChatRequest', aiChatRequest)
+            const localVarPath = `/api/v1/ai/chat`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'text/event-stream';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(aiChatRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Delete a conversation and all its messages
+         * @summary Delete conversation
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteConversation: async (conversationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'conversationId' is not null or undefined
+            assertParamExists('deleteConversation', 'conversationId', conversationId)
+            const localVarPath = `/api/v1/ai/conversations/{conversationId}`
+                .replace('{conversationId}', encodeURIComponent(String(conversationId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get all messages in a conversation
+         * @summary Get conversation history
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationHistory: async (conversationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'conversationId' is not null or undefined
+            assertParamExists('getConversationHistory', 'conversationId', conversationId)
+            const localVarPath = `/api/v1/ai/conversations/{conversationId}`
+                .replace('{conversationId}', encodeURIComponent(String(conversationId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get all AI chat conversations for the current user
+         * @summary List conversations
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConversations: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/conversations`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AIChatApi - functional programming interface
+ */
+export const AIChatApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AIChatApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
+         * @summary Chat with AI assistant
+         * @param {AiChatRequest} aiChatRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async chat(aiChatRequest: AiChatRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.chat(aiChatRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.chat']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Delete a conversation and all its messages
+         * @summary Delete conversation
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteConversation(conversationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConversation(conversationId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.deleteConversation']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get all messages in a conversation
+         * @summary Get conversation history
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getConversationHistory(conversationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getConversationHistory(conversationId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.getConversationHistory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get all AI chat conversations for the current user
+         * @summary List conversations
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listConversations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatConversation>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listConversations(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.listConversations']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AIChatApi - factory interface
+ */
+export const AIChatApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AIChatApiFp(configuration)
+    return {
+        /**
+         * Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
+         * @summary Chat with AI assistant
+         * @param {AiChatRequest} aiChatRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        chat(aiChatRequest: AiChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatResponse>> {
+            return localVarFp.chat(aiChatRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Delete a conversation and all its messages
+         * @summary Delete conversation
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteConversation(conversationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteConversation(conversationId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get all messages in a conversation
+         * @summary Get conversation history
+         * @param {string} conversationId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationHistory(conversationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatResponse>> {
+            return localVarFp.getConversationHistory(conversationId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get all AI chat conversations for the current user
+         * @summary List conversations
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>> {
+            return localVarFp.listConversations(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AIChatApi - object-oriented interface
+ */
+export class AIChatApi extends BaseAPI {
+    /**
+     * Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
+     * @summary Chat with AI assistant
+     * @param {AiChatRequest} aiChatRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public chat(aiChatRequest: AiChatRequest, options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).chat(aiChatRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Delete a conversation and all its messages
+     * @summary Delete conversation
+     * @param {string} conversationId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public deleteConversation(conversationId: string, options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).deleteConversation(conversationId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get all messages in a conversation
+     * @summary Get conversation history
+     * @param {string} conversationId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getConversationHistory(conversationId: string, options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).getConversationHistory(conversationId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get all AI chat conversations for the current user
+     * @summary List conversations
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listConversations(options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+