@vonage/client-sdk 1.1.0-alpha.1 → 1.1.0-alpha.5

package/dist/client/VonageClient.d.ts

@@ -1,9 +1,16 @@
 import vonage from '../utils/vonage';
-export * from '../utils';
 /**
- * Minimal Interface built on top of KMP export
- * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
+ * The Vonage Client SDK for JS/TS provides a simple interface
+ * For the Vonage Voice and Messaging APIs.
+ *
+ * @remarks
+ * Built on top of the Kotlin Multiplatform SDK, it provides a
+ * more JS-like API, and platform specific implementations for
+ * the underlying network and media layers.
+ *
+ * @packageDocumentation
  */
+export * from '../utils';
 export type VonageEvent = vonage.CombinedEvents;
 export type RTCQuality = vonage.RTCQualityJS;
 export type CancelReason = vonage.CancelReasonJS;
@@ -14,11 +21,82 @@ export type SessionErrorReason = vonage.SessionErrorReasonJS;
 export declare const SessionErrorReason: typeof vonage.SessionErrorReasonJS;
 export type LegStatus = vonage.LegStatusJS;
 export declare const LegStatus: typeof vonage.LegStatusJS;
+export type CallSayParams = Partial<vonage.CallSayParams> & {
+    text: string;
+};
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
+/**
+ * VonageClient is the main entry point for the Vonage Client SDK.
+ *
+ * @privateRemarks
+ * This class is a wrapper around the KMP `CombinedClientJS` class.
+ * It provides a more JS-like API, and also provides a proxy object
+ * to allow for registering callbacks via `on()`.
+ *
+ * Minimal Interface built on top of KMP export
+ * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
+ */
 export declare class VonageClient extends vonage.CombinedClientJS {
+    /**
+     * Proxy object to allow for registering callbacks via `on()`
+     * @internal
+     */
     private callbacks;
     constructor();
+    /**
+     * Register a callback for an event.
+     *
+     * NOTE: you can only register one callback per event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @param callback - the callback to register for the event
+     * @returns void
+     */
     on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): void;
-    hangup(callId: string, reasonText?: string, reasonCode?: string): Promise<any>;
+    /**
+     * Create a session with a token and optional sessionId
+     * If no sessionId is provided, a new one will be generated
+     * and returned. If a sessionId is provided, it will be used
+     * to resume an existing session.
+     *
+     * @param token
+     * @param sessionId - optional sessionId to use
+     * @returns the `sessionId` of the session
+     */
+    createSession(token: string, sessionId?: string | null): Promise<string>;
+    /**
+     * Make a server call to the Vonage API.
+     * This is used to initiate a call using the Voice API and NCCO.
+     *
+     * @param context - the context to send to the server passed as Custom data to the voice answer webhook
+     * @returns the `callId` of the call
+     */
+    serverCall(context?: Json): Promise<string>;
+    /**
+     * Hangup a call.
+     *
+     * @remarks
+     * this is a convenience method that calls `hangupWithReason` with
+     *
+     * @param callId - the `callId` of the call to hangup
+     * @param reasonText - optional reason text to send to the other party
+     * @param reasonCode - optional reason code to send to the other party
+     * @returns void
+     */
+    hangup(callId: string, reasonText?: string, reasonCode?: string): Promise<void>;
+    /**
+     * Sends a TTS message to the Call
+     * @param callId - the `callId` of the call to send the message to
+     * @param text - the text to send
+     * @returns void
+     */
+    say(callId: string, text: string): Promise<void>;
+    /**
+     * Sends a TTS message to the Call
+     * @param callId - the `callId` of the call to send the message to
+     * @param params - the `CallSayParams` to send
+     * @returns void
+     */
+    say(callId: string, params: CallSayParams): Promise<void>;
 }
 export default VonageClient;