@smartbooks-ai/api-client 0.0.3

package/dist/esm/apis/AiApi.d.ts

@@ -0,0 +1,289 @@
+/**
+ * Smartbooks Restful API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * 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 { AiAnalysisRequest, AiFeedback, AiReportFindings, AiSettings, AiStatus, AiSupportHistoryResponse, AiSupportRequest, AiSupportResponseWithThreadId, FeedbackGetResponse, HistoryRetrievalRequest, HistoryRetrievalResponse } from '../models/index';
+import * as runtime from '../runtime';
+export interface AiApiAnalyzeFindingsForReportRequest {
+    companyCode: string;
+    aiAnalysisRequest: AiAnalysisRequest;
+}
+export interface AiApiDeleteFeedbackRequest {
+    companyCode: string;
+    feedbackId: string;
+}
+export interface AiApiGetFeedbackRequest {
+    companyCode: string;
+}
+export interface AiApiGetSettingsRequest {
+    companyCode: string;
+}
+export interface AiApiGetStatusRequest {
+    companyCode: string;
+}
+export interface AiApiGetSupportHistoryRequest {
+    companyCode: string;
+}
+export interface AiApiPatchSettingsRequest {
+    companyCode: string;
+    aiSettings: AiSettings;
+}
+export interface AiApiPostSupportRequestRequest {
+    companyCode: string;
+    aiSupportRequest: AiSupportRequest;
+}
+export interface AiApiPutFeedbackRequest {
+    companyCode: string;
+    aiFeedback: AiFeedback;
+}
+export interface AiApiRequestFindingsForReportRequest {
+    companyCode: string;
+    aiAnalysisRequest: AiAnalysisRequest;
+}
+export interface AiApiRetrieveConversationHistoryRequest {
+    companyCode: string;
+    historyRetrievalRequest: HistoryRetrievalRequest;
+}
+export interface AiApiSupportRestartRequest {
+    companyCode: string;
+    body: object;
+}
+/**
+ * AiApi - interface
+ *
+ * @export
+ * @interface AiApiInterface
+ */
+export interface AiApiInterface {
+    /**
+     *
+     * @param {string} companyCode
+     * @param {AiAnalysisRequest} aiAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    analyzeFindingsForReportRaw(requestParameters: AiApiAnalyzeFindingsForReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    analyzeFindingsForReport(companyCode: string, aiAnalysisRequest: AiAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {string} feedbackId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    deleteFeedbackRaw(requestParameters: AiApiDeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    deleteFeedback(companyCode: string, feedbackId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    getFeedbackRaw(requestParameters: AiApiGetFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedbackGetResponse>>;
+    /**
+     */
+    getFeedback(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedbackGetResponse>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    getSettingsRaw(requestParameters: AiApiGetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSettings>>;
+    /**
+     */
+    getSettings(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSettings>;
+    /**
+     * Retrieve whether AI is enabled for the company
+     * @summary Get AI status
+     * @param {string} companyCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    getStatusRaw(requestParameters: AiApiGetStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiStatus>>;
+    /**
+     * Retrieve whether AI is enabled for the company
+     * Get AI status
+     */
+    getStatus(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiStatus>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    getSupportHistoryRaw(requestParameters: AiApiGetSupportHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportHistoryResponse>>;
+    /**
+     */
+    getSupportHistory(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportHistoryResponse>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {AiSettings} aiSettings
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    patchSettingsRaw(requestParameters: AiApiPatchSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    patchSettings(companyCode: string, aiSettings: AiSettings, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {AiSupportRequest} aiSupportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    postSupportRequestRaw(requestParameters: AiApiPostSupportRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportResponseWithThreadId>>;
+    /**
+     */
+    postSupportRequest(companyCode: string, aiSupportRequest: AiSupportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportResponseWithThreadId>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {AiFeedback} aiFeedback
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    putFeedbackRaw(requestParameters: AiApiPutFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiFeedback>>;
+    /**
+     */
+    putFeedback(companyCode: string, aiFeedback: AiFeedback, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiFeedback>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {AiAnalysisRequest} aiAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    requestFindingsForReportRaw(requestParameters: AiApiRequestFindingsForReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiReportFindings>>;
+    /**
+     */
+    requestFindingsForReport(companyCode: string, aiAnalysisRequest: AiAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiReportFindings>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {HistoryRetrievalRequest} historyRetrievalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    retrieveConversationHistoryRaw(requestParameters: AiApiRetrieveConversationHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HistoryRetrievalResponse>>;
+    /**
+     */
+    retrieveConversationHistory(companyCode: string, historyRetrievalRequest: HistoryRetrievalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HistoryRetrievalResponse>;
+    /**
+     *
+     * @param {string} companyCode
+     * @param {object} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AiApiInterface
+     */
+    supportRestartRaw(requestParameters: AiApiSupportRestartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportResponseWithThreadId>>;
+    /**
+     */
+    supportRestart(companyCode: string, body: object, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportResponseWithThreadId>;
+}
+/**
+ *
+ */
+export declare class AiApi extends runtime.BaseAPI implements AiApiInterface {
+    /**
+     */
+    analyzeFindingsForReportRaw(requestParameters: AiApiAnalyzeFindingsForReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    analyzeFindingsForReport(companyCode: string, aiAnalysisRequest: AiAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    deleteFeedbackRaw(requestParameters: AiApiDeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    deleteFeedback(companyCode: string, feedbackId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    getFeedbackRaw(requestParameters: AiApiGetFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedbackGetResponse>>;
+    /**
+     */
+    getFeedback(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedbackGetResponse>;
+    /**
+     */
+    getSettingsRaw(requestParameters: AiApiGetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSettings>>;
+    /**
+     */
+    getSettings(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSettings>;
+    /**
+     * Retrieve whether AI is enabled for the company
+     * Get AI status
+     */
+    getStatusRaw(requestParameters: AiApiGetStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiStatus>>;
+    /**
+     * Retrieve whether AI is enabled for the company
+     * Get AI status
+     */
+    getStatus(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiStatus>;
+    /**
+     */
+    getSupportHistoryRaw(requestParameters: AiApiGetSupportHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportHistoryResponse>>;
+    /**
+     */
+    getSupportHistory(companyCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportHistoryResponse>;
+    /**
+     */
+    patchSettingsRaw(requestParameters: AiApiPatchSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    patchSettings(companyCode: string, aiSettings: AiSettings, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    postSupportRequestRaw(requestParameters: AiApiPostSupportRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportResponseWithThreadId>>;
+    /**
+     */
+    postSupportRequest(companyCode: string, aiSupportRequest: AiSupportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportResponseWithThreadId>;
+    /**
+     */
+    putFeedbackRaw(requestParameters: AiApiPutFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiFeedback>>;
+    /**
+     */
+    putFeedback(companyCode: string, aiFeedback: AiFeedback, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiFeedback>;
+    /**
+     */
+    requestFindingsForReportRaw(requestParameters: AiApiRequestFindingsForReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiReportFindings>>;
+    /**
+     */
+    requestFindingsForReport(companyCode: string, aiAnalysisRequest: AiAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiReportFindings>;
+    /**
+     */
+    retrieveConversationHistoryRaw(requestParameters: AiApiRetrieveConversationHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HistoryRetrievalResponse>>;
+    /**
+     */
+    retrieveConversationHistory(companyCode: string, historyRetrievalRequest: HistoryRetrievalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HistoryRetrievalResponse>;
+    /**
+     */
+    supportRestartRaw(requestParameters: AiApiSupportRestartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiSupportResponseWithThreadId>>;
+    /**
+     */
+    supportRestart(companyCode: string, body: object, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiSupportResponseWithThreadId>;
+}