@aiqa/sdk 1.0.0-develop.2 → 1.0.0-develop.3

package/dist/browser/browser.d.ts

@@ -0,0 +1,112 @@
+import { Socket } from 'socket.io-client';
+
+type Application = {
+    application_id: string;
+    client_name: string;
+    client_phone_number: string;
+    agent_id: string;
+    agent_first_name: string;
+    agent_last_name: string;
+};
+declare enum Methods {
+    AUTHENTICATE = "AUTHENTICATE",
+    GET_FACTS = "GET_FACTS",
+    START_RECORDING = "START_RECORDING",
+    STOP_RECORDING = "STOP_RECORDING",
+    IS_RECORDING = "IS_RECORDING",
+    ADD_FACT = "ADD_FACT",
+    SET_CONVERSATION_PRODUCT = "SET_CONVERSATION_PRODUCT"
+}
+type SetConversationProductResult = {
+    success: boolean;
+    product: string;
+};
+type SdkEvent = Methods | "connect" | "disconnect" | "close" | "error" | "reconnect_attempt" | "reconnect_error" | "reconnect_failed" | "authenticated" | "app_version";
+declare enum FactAnswerFormatType {
+    string = "STRING",
+    number = "NUMBER",
+    integer = "INT",
+    float = "FLOAT",
+    bool = "BOOL",
+    list = "LIST",
+    strict = "STRICT",
+    single_choice = "SINGLE_CHOICE",
+    multiple_choices = "MULTIPLE_CHOICES"
+}
+type ApplicationFactAnswerChoice = {
+    key: string;
+    text: string;
+};
+type ApplicationFactAnswerFormat = {
+    type: FactAnswerFormatType;
+    choices?: ApplicationFactAnswerChoice[];
+};
+type ApplicationFactInput = {
+    id: string;
+    question: string;
+    expected_answer: any;
+    answer_format: ApplicationFactAnswerFormat;
+    category_id?: string;
+    category_name?: string;
+    language?: string;
+    critical?: boolean;
+    is_skipped?: boolean;
+};
+type QuestionStatus = "searching" | "asked" | "not_asked";
+type VerificationStatus = "processing" | "matched" | "unmatched";
+type ApplicationFact = ApplicationFactInput & {
+    ai_answer?: any;
+    question_status: QuestionStatus;
+    verification_status: VerificationStatus;
+};
+interface AddFactResult {
+    agent_answer?: string;
+    ai_answer?: string;
+    is_valid_answer: boolean;
+    question_asked?: boolean;
+}
+type SdkError = {
+    code: "INVALID_CONFIG" | "CONNECTION_ERROR" | "TIMEOUT" | "SERVER_ERROR" | "UNEXPECTED_RESPONSE";
+    message: string;
+    details?: any;
+};
+declare abstract class IAiqaSdk {
+    abstract connect(): void;
+    abstract disconnect(): void;
+    abstract on(eventName: string, callback: (...args: any[]) => any): void;
+    abstract off(eventName: string): void;
+    abstract getApplication(): Promise<Application>;
+    abstract addFact(fact: ApplicationFactInput): Promise<AddFactResult>;
+    abstract getFacts(): Promise<ApplicationFact[]>;
+    abstract setConversationProduct(product: string): Promise<SetConversationProductResult>;
+}
+
+declare class AiQaSdk implements IAiqaSdk {
+    socket: Socket | null;
+    url: string;
+    applicationId: string;
+    applicationSecretKey: string;
+    cachedApplication?: Application;
+    internalListeners: Map<SdkEvent, Set<(...args: any[]) => void>>;
+    internalEvents: Set<SdkEvent>;
+    constructor(applicationId: string, applicationSecret: string, url?: string);
+    on(name: SdkEvent, callback: (...args: any[]) => any): void;
+    off(name: SdkEvent, callback?: (...args: any[]) => any): void;
+    connect(): void;
+    disconnect(): void;
+    sendMessage(method: Methods, data?: any): Promise<any>;
+    getApplication(): Promise<Application>;
+    getFacts(): Promise<ApplicationFact[]>;
+    addFact(fact: ApplicationFactInput): Promise<AddFactResult>;
+    setConversationProduct(product: string): Promise<SetConversationProductResult>;
+    authenticate(): Promise<void>;
+    startRecording(): Promise<boolean>;
+    stopRecording(): Promise<boolean>;
+    isRecordingNow(): Promise<boolean>;
+    private compareVersions;
+    private emitInternal;
+    private createRequestId;
+    private isManagerEvent;
+}
+
+export { type AddFactResult, AiQaSdk, type Application, type ApplicationFact, type ApplicationFactAnswerChoice, type ApplicationFactAnswerFormat, type ApplicationFactInput, FactAnswerFormatType, IAiqaSdk, Methods, type QuestionStatus, type SdkError, type SdkEvent, type SetConversationProductResult, type VerificationStatus };