@eka-care/ekascribe-ts-sdk 3.0.23 → 3.0.24

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { CallbackMap } from 'med-scribe-alliance-ts-sdk';
-import { CallbackName as CallbackName_2 } from 'med-scribe-alliance-ts-sdk';
 import { CreateSessionRequest } from 'med-scribe-alliance-ts-sdk';
 import { CreateSessionResponse } from 'med-scribe-alliance-ts-sdk';
 import { createWorkerBlobUrl } from 'med-scribe-alliance-ts-sdk';
@@ -13,6 +12,7 @@ import { PatchSessionRequest } from 'med-scribe-alliance-ts-sdk';
 import { PatchSessionResponse } from 'med-scribe-alliance-ts-sdk';
 import { PollOptions } from 'med-scribe-alliance-ts-sdk';
 import { ProcessTemplateResponse } from 'med-scribe-alliance-ts-sdk';
+import { RecordingOptions } from 'med-scribe-alliance-ts-sdk';
 import { ResolvedConfig } from 'med-scribe-alliance-ts-sdk';
 import { ScribeClient } from 'med-scribe-alliance-ts-sdk';
 import { SDKResult } from 'med-scribe-alliance-ts-sdk';
@@ -84,6 +84,13 @@ declare class DocumentManager {
     publishDocument({ session_id, document_id, }: TPostV1DocumentRequest): Promise<TPostV1DocumentResponse>;
 }
 
+/** Consumer-facing callback map: overrides onTokenRequired to expect a token return */
+export declare interface EkaCallbackMap extends Omit<CallbackMap, 'onTokenRequired'> {
+    onTokenRequired: () => Promise<string> | string;
+}
+
+export declare type EkaCallbackName = keyof EkaCallbackMap;
+
 declare type EkaHosts = {
     voiceV1: string;
     voiceV2: string;
@@ -110,7 +117,13 @@ declare class EkaScribe {
     static getInstance(config: EkaScribeConfig): EkaScribe;
     /** @deprecated Backward compatible */
     initTransaction(request: TPostTransactionInitRequest): Promise<TStartRecordingResponse>;
+    /** @deprecated Backward compatible */
     startRecording(microphoneID?: string): Promise<TStartRecordingResponse>;
+    /**
+     * Creates a session and starts recording in one step.
+     * This is the recommended method for new integrations.
+     */
+    startRecordingV2(options: RecordingOptions): Promise<TStartRecordingResponse>;
     startRecordingForExistingSession(request: TStartRecordingForExistingSessionRequest): Promise<TStartRecordingResponse>;
     pauseRecording(): TPauseRecordingResponse;
     resumeRecording(): TPauseRecordingResponse;
@@ -155,8 +168,8 @@ declare class EkaScribe {
         dlp?: boolean;
         onPartialResultCb?: TPartialResultCallback;
     }): Promise<TPollingResponse>;
-    registerCallback<K extends CallbackName_2>(name: K, handler: CallbackMap[K]): void;
-    removeCallback<K extends CallbackName_2>(name: K, handler: CallbackMap[K]): void;
+    registerCallback<K extends EkaCallbackName>(name: K, handler: EkaCallbackMap[K]): void;
+    removeCallback<K extends EkaCallbackName>(name: K, handler: EkaCallbackMap[K]): void;
     /** @future Rename to setAccessToken(token: string) once existing clients migrate */
     updateAuthTokens({ access_token }: {
         access_token: string;
@@ -235,6 +248,8 @@ export declare enum PROCESSING_STATUS {
 
 export { ProcessTemplateResponse }
 
+export { RecordingOptions }
+
 export { ResolvedConfig }
 
 export declare enum RESULT_STATUS {
@@ -263,6 +278,7 @@ declare class SessionUtils {
     getSuggestedMedications(txnId: string): Promise<TSuggestedMedicationResponse>;
     addSessionContext({ txn_id, context, }: TPatchSessionContextRequest): Promise<TPatchSessionContextResponse>;
     removeSessionContext({ txn_id, context, }: TPatchSessionContextRequest): Promise<TPatchSessionContextResponse>;
+    /** @deprecated Backward compatible */
     updateResultSummary({ txnId, data, }: TPatchVoiceApiV3StatusRequest): Promise<TPatchVoiceApiV3StatusResponse>;
     getConfig(): Promise<TGetConfigV2Response>;
     getConfigMyTemplates(): Promise<TGetConfigV2Response>;