@vonage/client-sdk 1.2.1 → 1.3.0-alpha.1

package/dist/client/VonageClient.d.ts

@@ -1,5 +1,6 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject } from '../utils';
+import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject, Json, CustomData } from '../utils';
+import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnions';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
@@ -37,14 +38,11 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
 };
 export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
 export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
-type JSONValue = string | number | boolean | {
-    [x: string]: JSONValue;
-} | JSONValue[];
-/**
- * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
- * @param level - The logging level to set.
- */
-export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
+export type RtcStats = vonage.RTCStatsJS;
+export type CreateConversationParameters = Omit<vonage.CreateConversationParametersJS, 'ttl' | 'customData'> & {
+    ttl?: Nullable<number>;
+    customData?: Nullable<CustomData>;
+};
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
  *
@@ -72,7 +70,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 +97,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 +152,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 +174,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
@@ -242,11 +240,11 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      *
      * @group Chat
      * @beta
-     * @param name - the name of the conversation
-     * @param displayName - the display name of the conversation
+     * @param parameters - A [CreateConversationParameters] object containing the parameters for the creation request.
+     *
      * @returns the `cid` of the conversation
      */
-    createConversation(name?: string, displayName?: string): Promise<string>;
+    createConversation(parameters?: Nullable<CreateConversationParameters>): Promise<string>;
     /**
      * Get a Conversation
      *
@@ -331,7 +329,20 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param customData - the body of the message
      * @returns the `timestamp` of the message
      */
-    sendMessageCustomEvent(id: string, customData: JSONValue): Promise<string>;
+    sendMessageCustomEvent(id: string, customData: CustomData): 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
      *
@@ -341,15 +352,15 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @group Chat
      * @beta
      * @param id - the Conversation's id
-     * @param customBody - the body of the event
+     * @param customData - the body of the event
      * @returns the `timestamp` of the message
      */
-    sendEphemeralEvent(id: string, customBody: JSONValue): Promise<string>;
+    sendEphemeralEvent(id: string, customData: CustomData): Promise<string>;
     /**
      * Delete an Event in a Conversation
      *
      * @example
-     * [[include:delete_event.txt]]
+     * [[include:snippet_DeleteEvent.txt]]
      *
      * @group Chat
      * @beta