@eka-care/ekascribe-ts-sdk 2.1.15 → 2.1.17

package/dist/index.d.ts

@@ -1,4 +1,11 @@
-declare enum CALLBACK_TYPE {
+export declare enum API_STATUS {
+    NOT_INITIALIZED = "na",
+    INIT = "init",
+    STOP = "stop",
+    COMMIT = "commit"
+}
+
+export declare enum CALLBACK_TYPE {
     AWS_CONFIGURE_STATUS = "aws_configure_status",
     FILE_UPLOAD_STATUS = "file_upload_status",
     TRANSACTION_STATUS = "transaction_status",
@@ -8,12 +15,20 @@ declare enum CALLBACK_TYPE {
     STORAGE_STATUS = "storage_status"
 }
 
-declare enum COMPATIBILITY_TEST_STATUS {
+export declare enum COMPATIBILITY_TEST_STATUS {
     SUCCESS = "success",
     ERROR = "error",
     WARNING = "warning"
 }
 
+export declare enum COMPATIBILITY_TEST_TYPE {
+    INTERNET_CONNECTIVITY = "INTERNET_CONNECTIVITY",
+    SYSTEM_INFO = "SYSTEM_INFO",
+    MICROPHONE = "MICROPHONE",
+    SHARED_WORKER = "SHARED_WORKER",
+    NETWORK_API = "NETWORK_API"
+}
+
 declare class EkaScribe {
     private static instance;
     private vadInstance;
@@ -104,7 +119,7 @@ declare class EkaScribe {
     getDoctorClinics(request: TGetDoctorClinicsRequest): Promise<TGetDoctorClinicsResponse>;
 }
 
-declare enum ERROR_CODE {
+export declare enum ERROR_CODE {
     MICROPHONE = "microphone",
     TXN_INIT_FAILED = "txn_init_failed",
     TXN_LIMIT_EXCEEDED = "txn_limit_exceeded",
@@ -133,6 +148,20 @@ export declare const getEkaScribeInstance: ({ access_token, env, clientId, flavo
     flavour?: string;
 }) => EkaScribe;
 
+export declare enum PROCESSING_STATUS {
+    SUCCESS = "success",
+    IN_PROGRESS = "in-progress",
+    FAILED = "failed",
+    CANCELLED = "cancelled"
+}
+
+export declare enum RESULT_STATUS {
+    SUCCESS = "success",
+    FAILURE = "failure",
+    PARTIAL_COMPLETE = "partial_complete",
+    IN_PROGRESS = "in-progress"
+}
+
 declare type TAudioChunksInfo = {
     fileName: string;
     timestamp: {
@@ -159,18 +188,18 @@ declare type TClinicInfo = {
     name: string;
 };
 
-declare type TCompatibilityCallback = (result: TCompatibilityTestResult) => void;
+export declare type TCompatibilityCallback = (result: TCompatibilityTestResult) => void;
 
-declare type TCompatibilityTestResult = {
+export declare type TCompatibilityTestResult = {
     test_type: string;
     status: COMPATIBILITY_TEST_STATUS;
     message: string;
-    data?: any;
+    data?: Record<string, unknown>;
     timestamp: string;
     error?: string;
 };
 
-declare type TCompatibilityTestSummary = {
+export declare type TCompatibilityTestSummary = {
     allPassed: boolean;
     results: TCompatibilityTestResult[];
     totalTests: number;
@@ -179,7 +208,7 @@ declare type TCompatibilityTestSummary = {
     warningTests: number;
 };
 
-declare type TConfigSettings = {
+export declare type TConfigSettings = {
     model_training_consent: {
         value: boolean;
         editable: boolean;
@@ -207,7 +236,21 @@ declare type TDoctorHeaderFooterInfo = {
     show_signature: boolean | null;
 };
 
-declare type TEndRecordingResponse = {
+export declare enum TEMPLATE_ID {
+    EKA_EMR_TEMPLATE = "eka_emr_template",
+    CLINICAL_NOTE_TEMPLATE = "clinical_notes_template",
+    TRANSCRIPT_TEMPLATE = "transcript_template",
+    EKA_EMR_TO_FHIR_TEMPLATE = "eka_emr_to_fhir_template",
+    NIC_TEMPLATE = "nic_template"
+}
+
+export declare enum TEMPLATE_TYPE {
+    JSON = "json",
+    TRANSCRIPT = "transcript",
+    MARKDOWN = "markdown"
+}
+
+export declare type TEndRecordingResponse = {
     error_code?: ERROR_CODE;
     status_code: number;
     message: string;
@@ -215,7 +258,7 @@ declare type TEndRecordingResponse = {
     total_audio_files?: string[];
 };
 
-declare type TEventCallback = (args: {
+export declare type TEventCallback = (args: {
     callback_type: CALLBACK_TYPE;
     status: 'success' | 'error' | 'progress' | 'info';
     message: string;
@@ -229,7 +272,7 @@ declare type TEventCallback = (args: {
     metadata?: Record<string, unknown>;
 }) => void;
 
-declare type TEventCallbackData = {
+export declare type TEventCallbackData = {
     success?: number;
     total?: number;
     is_uploaded?: boolean;
@@ -247,13 +290,13 @@ declare type TFullAudioUploadResponse = {
     message: string;
 };
 
-declare type TGetConfigItem = {
+export declare type TGetConfigItem = {
     id: string;
     name: string;
     desc?: string;
 };
 
-declare type TGetConfigV2Response = {
+export declare type TGetConfigV2Response = {
     data?: {
         supported_languages: TGetConfigItem[];
         supported_output_formats: TGetConfigItem[];
@@ -298,22 +341,22 @@ declare type TGetConfigV2Response = {
     code: number;
 };
 
-declare type TGetDoctorClinicsRequest = {
+export declare type TGetDoctorClinicsRequest = {
     doctor_id: string;
 };
 
-declare type TGetDoctorClinicsResponse = {
+export declare type TGetDoctorClinicsResponse = {
     data: TClinicInfo[] | null;
     code: number;
     message?: string;
 };
 
-declare type TGetDoctorHeaderFooterRequest = {
+export declare type TGetDoctorHeaderFooterRequest = {
     doctor_oid: string;
     clinic_id?: string;
 };
 
-declare type TGetDoctorHeaderFooterResponse = {
+export declare type TGetDoctorHeaderFooterResponse = {
     data: TDoctorHeaderFooterInfo;
     code: number;
     message?: string;
@@ -342,13 +385,13 @@ declare type TGetStatusApiResponse = {
     };
 };
 
-declare type TGetStatusResponse = {
+export declare type TGetStatusResponse = {
     response?: TGetStatusApiResponse | null;
     status_code: number;
     message?: string;
 };
 
-declare type TGetTransactionHistoryResponse = {
+export declare type TGetTransactionHistoryResponse = {
     data?: TSessionHistoryData[];
     status?: string;
     status_code: number;
@@ -356,7 +399,7 @@ declare type TGetTransactionHistoryResponse = {
     retrieved_count?: number;
 };
 
-declare interface TGetV1TemplateSectionsResponse {
+export declare interface TGetV1TemplateSectionsResponse {
     items: TSection[];
     code: number;
     error?: {
@@ -365,7 +408,7 @@ declare interface TGetV1TemplateSectionsResponse {
     };
 }
 
-declare interface TGetV1TemplatesResponse {
+export declare interface TGetV1TemplatesResponse {
     items: TTemplate[];
     code: number;
     error?: {
@@ -392,7 +435,7 @@ declare type TOutputSummary = {
     warnings?: TTemplateMessage[];
 };
 
-declare type TPartialResultCallback = (data: {
+export declare type TPartialResultCallback = (data: {
     txn_id: string;
     response: TGetStatusApiResponse | null;
     status_code: number;
@@ -408,13 +451,13 @@ declare type TPatchTransactionError = {
     };
 };
 
-declare type TPatchTransactionRequest = {
+export declare type TPatchTransactionRequest = {
     sessionId: string;
     processing_status: string;
     processing_error?: TPatchTransactionError;
 };
 
-declare type TPatchVoiceApiV2ConfigRequest = {
+export declare type TPatchVoiceApiV2ConfigRequest = {
     request_type: string;
     data: {
         auto_download?: boolean;
@@ -431,12 +474,21 @@ declare type TPatchVoiceApiV2ConfigRequest = {
         consult_language?: string[];
         contact_number?: string;
         onboarding_step?: string;
-        sys_info?: any;
+        sys_info?: TSystemInfo;
     };
     query_params?: string;
 };
 
-declare type TPatchVoiceApiV3StatusRequest = {
+export declare interface TPatchVoiceApiV2ConfigResponse extends TPatchVoiceApiV2ConfigRequest {
+    msg: string;
+    code: number;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+
+export declare type TPatchVoiceApiV3StatusRequest = {
     txnId: string;
     data: {
         'template-id': string;
@@ -444,7 +496,7 @@ declare type TPatchVoiceApiV3StatusRequest = {
     }[];
 };
 
-declare type TPatchVoiceApiV3StatusResponse = {
+export declare type TPatchVoiceApiV3StatusResponse = {
     status: string;
     message: string;
     txn_id: string;
@@ -457,7 +509,7 @@ declare type TPatchVoiceApiV3StatusResponse = {
     };
 };
 
-declare type TPatientDetails = {
+export declare type TPatientDetails = {
     username: string;
     oid?: string;
     age: number;
@@ -466,7 +518,7 @@ declare type TPatientDetails = {
     email?: string;
 };
 
-declare type TPauseRecordingResponse = {
+export declare type TPauseRecordingResponse = {
     status_code: number;
     message: string;
     error_code?: ERROR_CODE;
@@ -480,6 +532,19 @@ declare type TPollingResponse = {
     errorCode?: string;
 };
 
+export declare type TPostCogResponse = {
+    credentials?: {
+        AccessKeyId: string;
+        SecretKey: string;
+        SessionToken: string;
+        Expiration: string;
+    };
+    message?: string;
+    token?: string;
+    identity_id?: string;
+    is_session_expired?: boolean;
+};
+
 declare type TPostCookV1MediaAiCreateTemplateResponse = {
     title: string;
     desc: string;
@@ -488,7 +553,7 @@ declare type TPostCookV1MediaAiCreateTemplateResponse = {
     message: string;
 };
 
-declare type TPostTransactionInitRequest = {
+export declare type TPostTransactionInitRequest = {
     mode: string;
     s3Url?: string;
     txn_id: string;
@@ -510,10 +575,10 @@ declare type TPostTransactionInitRequest = {
     flavour?: string;
     batch_s3_url?: string;
     audio_file_names?: string[];
-    additional_data?: any;
+    additional_data?: Record<string, unknown>;
 };
 
-declare type TPostTransactionResponse = {
+export declare type TPostTransactionResponse = {
     status: string;
     message: string;
     txn_id: string;
@@ -529,14 +594,14 @@ declare type TPostTransactionResponse = {
     };
 };
 
-declare type TPostV1ConvertToTemplateRequest = {
+export declare type TPostV1ConvertToTemplateRequest = {
     txn_id: string;
-    template_id: string;
+    template_id?: string;
     transcript?: string;
     target_language?: string;
 };
 
-declare type TPostV1ConvertToTemplateResponse = {
+export declare type TPostV1ConvertToTemplateResponse = {
     status: 'success' | 'failed';
     message: string;
     txn_id: string;
@@ -551,14 +616,14 @@ declare type TPostV1ConvertToTemplateResponse = {
     };
 };
 
-declare interface TPostV1TemplateRequest {
+export declare interface TPostV1TemplateRequest {
     title: string;
     desc?: string;
     section_ids: string[];
     template_id?: string;
 }
 
-declare interface TPostV1TemplateResponse {
+export declare interface TPostV1TemplateResponse {
     code: number;
     msg: string;
     template_id?: string;
@@ -569,7 +634,7 @@ declare interface TPostV1TemplateResponse {
     };
 }
 
-declare interface TPostV1TemplateSectionRequest {
+export declare interface TPostV1TemplateSectionRequest {
     title: string;
     desc?: string;
     format?: 'P' | 'B';
@@ -577,7 +642,7 @@ declare interface TPostV1TemplateSectionRequest {
     section_id?: string;
 }
 
-declare interface TPostV1TemplateSectionResponse {
+export declare interface TPostV1TemplateSectionResponse {
     msg: string;
     section_id: string;
     code: number;
@@ -588,7 +653,7 @@ declare interface TPostV1TemplateSectionResponse {
     };
 }
 
-declare interface TPostV1UploadAudioFilesRequest extends TPostTransactionInitRequest {
+export declare interface TPostV1UploadAudioFilesRequest extends TPostTransactionInitRequest {
     action: string;
     audioFiles: File[] | Blob[];
     audioFileNames: string[];
@@ -610,7 +675,7 @@ declare type TSearchSessionsRequest = {
     searchCriteria: TSearchCriteria;
 };
 
-declare interface TSection {
+export declare interface TSection {
     id: string;
     title: string;
     desc: string;
@@ -620,7 +685,7 @@ declare interface TSection {
     parent_section_id?: string;
 }
 
-declare type TSelectedPreferences = {
+export declare type TSelectedPreferences = {
     languages?: TGetConfigItem[];
     output_formats?: TGetConfigItem[];
     consultation_mode?: string;
@@ -629,7 +694,7 @@ declare type TSelectedPreferences = {
     model_type?: string;
 };
 
-declare type TSessionHistoryData = {
+export declare type TSessionHistoryData = {
     created_at: string;
     b_id: string;
     user_status: string;
@@ -641,7 +706,21 @@ declare type TSessionHistoryData = {
     patient_details?: TPatientDetails;
 };
 
-declare type TStartRecordingResponse = {
+export declare type TSessionStatus = {
+    [key: string]: {
+        api?: {
+            status: API_STATUS;
+            error?: string;
+            response?: string;
+            code: number;
+        };
+        vad?: {
+            status: VAD_STATUS;
+        };
+    };
+};
+
+export declare type TStartRecordingResponse = {
     error_code?: ERROR_CODE;
     status_code: number;
     message: string;
@@ -651,7 +730,7 @@ declare type TStartRecordingResponse = {
     uuid?: string;
 };
 
-declare type TSystemInfo = {
+export declare type TSystemInfo = {
     platform: string;
     language: string;
     hardware_concurrency?: number;
@@ -660,7 +739,7 @@ declare type TSystemInfo = {
     network_info?: TNetworkInfo;
 };
 
-declare interface TTemplate {
+export declare interface TTemplate {
     id: string;
     title: string;
     desc: string;
@@ -677,7 +756,7 @@ declare type TTemplateMessage = {
 
 declare type TTemplateStatus = 'success' | 'partial_success' | 'failure';
 
-declare type TVadFrameProcessedCallback = (args: {
+export declare type TVadFrameProcessedCallback = (args: {
     probabilities: {
         notSpeech: number;
         isSpeech: number;
@@ -686,11 +765,18 @@ declare type TVadFrameProcessedCallback = (args: {
     duration: number;
 }) => void;
 
-declare type TVadFramesCallback = (args: {
+export declare type TVadFramesCallback = (args: {
     error_code?: ERROR_CODE;
     status_code: number;
     message?: string;
     request?: string;
 }) => void;
 
+export declare enum VAD_STATUS {
+    START = "start",
+    PAUSE = "pause",
+    RESUME = "resume",
+    STOP = "stop"
+}
+
 export { }