@vonage/client-sdk 1.2.1 → 1.3.0-snapshot.42.0

package/dist/client/VonageClient.d.ts

@@ -37,6 +37,7 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
 };
 export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
 export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
+export type RtcStats = vonage.RTCStatsJS;
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
 } | JSONValue[];
@@ -72,7 +73,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Register a callback for an event.
      *
      * @example
-     * [[include: snippet_RegisterListener.txt]]
+     * [[include: snippet_OnConversationEventListener.txt]]
      *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
@@ -99,7 +100,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Clear all callbacks for an event.
      *
      * @example
-     * [[include: snippet_Clear_Callbacks.txt]]
+     * [[include: snippet_ClearCallbacks.txt]]
      *
      * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
@@ -154,7 +155,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Hangup a call.
      *
      * @example
-     * [[include: snippet_CallHangup.txt]]
+     * [[include: snippet_Hangup.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to hangup
@@ -176,7 +177,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Sends a TTS message to the Call
      *
      * @example
-     * [[include: snippet_CallSay.txt]]
+     * [[include: snippet_Say.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to send the message to
@@ -332,6 +333,19 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendMessageCustomEvent(id: string, customData: JSONValue): Promise<string>;
+    /**
+     * Send a Image message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendImageMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param imageUrl - the url of the image resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageImageEvent(id: string, imageUrl: URL): Promise<string>;
     /**
      * Send an ephemeral event to a Conversation
      *
@@ -349,7 +363,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Delete an Event in a Conversation
      *
      * @example
-     * [[include:delete_event.txt]]
+     * [[include:snippet_DeleteEvent.txt]]
      *
      * @group Chat
      * @beta