@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250627.1 → 1.20250808.1

package/api/vbassist-api.ts

@@ -22,7 +22,9 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
-import type { ChatMessage } from '../models';
+import type { ChatFeedbackRequest } from '../models';
+// @ts-ignore
+import type { ChatRequest } from '../models';
 // @ts-ignore
 import type { StringVBAResponse } from '../models';
 /**
@@ -32,14 +34,17 @@ import type { StringVBAResponse } from '../models';
 export const VBAssistApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * An interactive client for VBAssist
-         * @summary Talk with VBAssist
-         * @param {ChatMessage} [chatMessage] 
+         * Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.
+         * @summary Submits user feedback about a previous chat interaction with the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatFeedbackRequest} [chatFeedbackRequest] The feedback details including rating, comments, and conversation identifiers.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        chatRequest: async (chatMessage?: ChatMessage, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/chat`;
+        chatFeedback: async (vbasoftwareDatabase: string, chatFeedbackRequest?: ChatFeedbackRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('chatFeedback', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/chat/feedback`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -62,10 +67,60 @@ export const VBAssistApiAxiosParamCreator = function (configuration?: Configurat
     
             localVarHeaderParameter['Content-Type'] = 'application/json';
 
+            if (vbasoftwareDatabase != null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(chatMessage, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(chatFeedbackRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.
+         * @summary Processes a chat message from a user and returns a response from the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatRequest} [chatRequest] The request object containing the user\&#39;s message and optional conversation tracking information.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        chatRequest: async (vbasoftwareDatabase: string, chatRequest?: ChatRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('chatRequest', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            const localVarPath = `/chat/inquiry`;
+            // 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 apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            if (vbasoftwareDatabase != null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(chatRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -83,14 +138,29 @@ export const VBAssistApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = VBAssistApiAxiosParamCreator(configuration)
     return {
         /**
-         * An interactive client for VBAssist
-         * @summary Talk with VBAssist
-         * @param {ChatMessage} [chatMessage] 
+         * Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.
+         * @summary Submits user feedback about a previous chat interaction with the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatFeedbackRequest} [chatFeedbackRequest] The feedback details including rating, comments, and conversation identifiers.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async chatFeedback(vbasoftwareDatabase: string, chatFeedbackRequest?: ChatFeedbackRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.chatFeedback(vbasoftwareDatabase, chatFeedbackRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VBAssistApi.chatFeedback']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.
+         * @summary Processes a chat message from a user and returns a response from the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatRequest} [chatRequest] The request object containing the user\&#39;s message and optional conversation tracking information.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async chatRequest(chatMessage?: ChatMessage, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.chatRequest(chatMessage, options);
+        async chatRequest(vbasoftwareDatabase: string, chatRequest?: ChatRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.chatRequest(vbasoftwareDatabase, chatRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['VBAssistApi.chatRequest']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -106,14 +176,26 @@ export const VBAssistApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = VBAssistApiFp(configuration)
     return {
         /**
-         * An interactive client for VBAssist
-         * @summary Talk with VBAssist
-         * @param {ChatMessage} [chatMessage] 
+         * Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.
+         * @summary Submits user feedback about a previous chat interaction with the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatFeedbackRequest} [chatFeedbackRequest] The feedback details including rating, comments, and conversation identifiers.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        chatRequest(chatMessage?: ChatMessage, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse> {
-            return localVarFp.chatRequest(chatMessage, options).then((request) => request(axios, basePath));
+        chatFeedback(vbasoftwareDatabase: string, chatFeedbackRequest?: ChatFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse> {
+            return localVarFp.chatFeedback(vbasoftwareDatabase, chatFeedbackRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.
+         * @summary Processes a chat message from a user and returns a response from the VBAssist AI.
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {ChatRequest} [chatRequest] The request object containing the user\&#39;s message and optional conversation tracking information.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        chatRequest(vbasoftwareDatabase: string, chatRequest?: ChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse> {
+            return localVarFp.chatRequest(vbasoftwareDatabase, chatRequest, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -125,14 +207,26 @@ export const VBAssistApiFactory = function (configuration?: Configuration, baseP
  */
 export interface VBAssistApiInterface {
     /**
-     * An interactive client for VBAssist
-     * @summary Talk with VBAssist
-     * @param {ChatMessage} [chatMessage] 
+     * Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.
+     * @summary Submits user feedback about a previous chat interaction with the VBAssist AI.
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {ChatFeedbackRequest} [chatFeedbackRequest] The feedback details including rating, comments, and conversation identifiers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAssistApiInterface
+     */
+    chatFeedback(vbasoftwareDatabase: string, chatFeedbackRequest?: ChatFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
+    /**
+     * Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.
+     * @summary Processes a chat message from a user and returns a response from the VBAssist AI.
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {ChatRequest} [chatRequest] The request object containing the user\&#39;s message and optional conversation tracking information.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VBAssistApiInterface
      */
-    chatRequest(chatMessage?: ChatMessage, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+    chatRequest(vbasoftwareDatabase: string, chatRequest?: ChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<StringVBAResponse>;
 
 }
 
@@ -144,15 +238,29 @@ export interface VBAssistApiInterface {
  */
 export class VBAssistApi extends BaseAPI implements VBAssistApiInterface {
     /**
-     * An interactive client for VBAssist
-     * @summary Talk with VBAssist
-     * @param {ChatMessage} [chatMessage] 
+     * Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.
+     * @summary Submits user feedback about a previous chat interaction with the VBAssist AI.
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {ChatFeedbackRequest} [chatFeedbackRequest] The feedback details including rating, comments, and conversation identifiers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VBAssistApi
+     */
+    public chatFeedback(vbasoftwareDatabase: string, chatFeedbackRequest?: ChatFeedbackRequest, options?: RawAxiosRequestConfig) {
+        return VBAssistApiFp(this.configuration).chatFeedback(vbasoftwareDatabase, chatFeedbackRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.
+     * @summary Processes a chat message from a user and returns a response from the VBAssist AI.
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {ChatRequest} [chatRequest] The request object containing the user\&#39;s message and optional conversation tracking information.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VBAssistApi
      */
-    public chatRequest(chatMessage?: ChatMessage, options?: RawAxiosRequestConfig) {
-        return VBAssistApiFp(this.configuration).chatRequest(chatMessage, options).then((request) => request(this.axios, this.basePath));
+    public chatRequest(vbasoftwareDatabase: string, chatRequest?: ChatRequest, options?: RawAxiosRequestConfig) {
+        return VBAssistApiFp(this.configuration).chatRequest(vbasoftwareDatabase, chatRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }