@vonage/client-sdk 1.1.0-alpha.10 → 1.1.0-alpha.12

package/dist/client/index.cjs

@@ -67553,7 +67553,24 @@ class SocketClient {
 }
 
 const ConfigRegion = clientsdkClientcore_jsExports.vonage.CoreClientConfigRegionJS;
+/**
+ * Represents the configuration object for the client.
+ *
+ * The `ClientConfig` class provides a convenient way to configure the client by specifying various properties.
+ * These properties control different aspects of the client's behavior, such as API URLs, media reoffer, and WebSocket settings.
+ *
+ * @example
+ * [[include:set_client_config.txt]]
+ */
 class ClientConfig extends clientsdkClientcore_jsExports.vonage.CoreClientConfigJS {
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param {string} region The region where the API and WebSocket URLs should be configured.
+     *                        Valid values are "EU" (Europe), "US" (United States), or "AP" (Asia Pacific).
+     *                        The URLs will be automatically set based on the selected region.
+     *                        Defaults to "US" if no region is specified.
+     */
     constructor(region = ConfigRegion.US) {
         super(region);
     }
@@ -67597,6 +67614,36 @@ const setVonageClientLoggingLevel = setDefaultLoggingLevel;
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
  */
 class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS {
+    /**
+     * @internal
+     */
+    get core() {
+        return super.core;
+    }
+    /**
+     * @internal
+     */
+    get media() {
+        return super.media;
+    }
+    /**
+     * @internal
+     */
+    get emitter() {
+        return super.emitter;
+    }
+    /**
+     * @internal
+     */
+    set emitter(value) {
+        super.emitter = value;
+    }
+    /**
+     * @internal
+     */
+    hangupWithReason(callId, reasonText, reasonCode) {
+        return super.hangupWithReason(callId, reasonText, reasonCode);
+    }
     constructor() {
         super(new HttpClient(), new SocketClient(), new MediaClient());
         /**
@@ -67604,6 +67651,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
          * @internal
          */
         this.callbacks = new Map();
+        /**
+         * @internal
+         */
+        this.__doNotUseIt = super.__doNotUseIt;
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const _this = this;
         this.emitter = new Proxy(Object(), {
@@ -67632,6 +67683,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Register a callback for an event.
      *
+     * @example
+     * [[include:register_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
      * @returns a symbol that can be used to unregister the callback
@@ -67649,6 +67703,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Unregister a callback for an event.
      *
+     * @example
+     * [[include:unregister_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callbackSymbol - the callback symbol to unregister
      * @returns true if the callback was unregistered, false otherwise
@@ -67664,16 +67721,15 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Clear all callbacks for an event.
      *
-     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @example
+     * [[include: clear_callbacks.txt]]
+     *
+     * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
      *
      * @remarks
      * This is useful for cleaning up callbacks when you no longer need them.
      *
-     * @example
-     * ```ts
-     *    client.clearCallbacks('legStatusUpdate');
-     * ```
      */
     clearCallbacks(event) {
         const callbacks = this.callbacks.get(event);
@@ -67687,6 +67743,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
      * and returned. If a sessionId is provided, it will be used
      * to resume an existing session.
      *
+     * @example
+     * [[include:create_session.txt]]
+     *
      * @param token
      * @param sessionId - optional sessionId to use
      * @returns the `sessionId` of the session
@@ -67699,10 +67758,33 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
             return _super.createSession.call(this, token, sessionId || null);
         });
     }
+    /**
+     * Get the Peer Connection for a call
+     *
+     * @experimental
+     * @group Voice
+     * @param id - The Call Id
+     */
+    getPeerConnection(id) {
+        return super.getPeerConnection(id);
+    }
+    /**
+     * Get the Leg for a call
+     *
+     * @group Voice
+     * @param legId - The Leg Id
+     */
+    getLeg(legId) {
+        return super.getLeg(legId);
+    }
     /**
      * Make a server call to the Vonage API.
      * This is used to initiate a call using the Voice API and NCCO.
      *
+     * @example
+     * [[include:outbound_call.txt]]
+     *
+     * @group Voice
      * @param context - the context to send to the server passed as Custom data to the voice answer webhook
      * @returns the `callId` of the call
      */
@@ -67717,9 +67799,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Hangup a call.
      *
-     * @remarks
-     * this is a convenience method that calls `hangupWithReason` with
+     * @example
+     * [[include:call_hangup.txt]]
      *
+     * @group Voice
      * @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
@@ -67752,6 +67835,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a list of Conversations for the user.
      *
+     * @example
+     * [[include:get_conversations.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param order - the order to return the conversations in (default: 'asc')
      * @param pageSize - the number of conversations to return per page (default: 100)
      * @param cursor - the cursor to use for pagination (default: null)
@@ -67768,6 +67856,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a Conversation's Events
      *
+     * @example
+     * [[include:get_conversation_events.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the events in (default: 'asc')
      * @param pageSize - the number of events to return per page (default: 100)
@@ -67784,6 +67877,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation's Members
+     *
+     * @example
+     * [[include:get_conversation_members.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the members in (default: 'asc')
      * @param pageSize - the number of members to return per page (default: 100)
@@ -67800,6 +67899,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Create a conversation
+     *
+     * @example
+     * [[include:create_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param name - the name of the conversation
      * @param displayName - the display name of the conversation
      * @returns the `cid` of the conversation
@@ -67814,6 +67919,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation
+     *
+     * @example
+     * [[include:get_conversation.txt]]
+     *
      * @param id - the Conversation's id
      * @returns the `Conversation`
      */
@@ -67827,6 +67936,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Leave a Conversation
+     *
+     * @example
+     * [[include:leave_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -67840,6 +67955,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Join a Conversation
+     *
+     * @example
+     * [[include:join_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns the `memberId` of the member
      */
@@ -67853,6 +67974,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Delete a Conversation
+     *
+     * @example
+     * [[include:delete_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -67866,6 +67993,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Invite a user to a Conversation by user's `name`
+     *
+     * @example
+     * [[include:invite_to_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param name - the namne of the user to invite
      * @returns the `memberId` of the member
@@ -67880,6 +68013,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a text message to a Conversation
+     *
+     * @example
+     * [[include:send_text_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param text - the Body of the message
      * @returns the `timestamp` of the message
@@ -67894,6 +68033,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a custom message to a Conversation
+     *
+     * @example
+     * [[include:send_custom_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param customData - the body of the message
      * @returns the `timestamp` of the message
@@ -67911,6 +68056,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Member of a Conversation
+     *
+     * @example
+     * [[include:get_conversation_member.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param cid - the Conversation's id
      * @param mid - the Member's id
      * @returns the `Member`

package/dist/client/index.mjs

@@ -67529,7 +67529,24 @@ class SocketClient {
 }
 
 const ConfigRegion = clientsdkClientcore_jsExports.vonage.CoreClientConfigRegionJS;
+/**
+ * Represents the configuration object for the client.
+ *
+ * The `ClientConfig` class provides a convenient way to configure the client by specifying various properties.
+ * These properties control different aspects of the client's behavior, such as API URLs, media reoffer, and WebSocket settings.
+ *
+ * @example
+ * [[include:set_client_config.txt]]
+ */
 class ClientConfig extends clientsdkClientcore_jsExports.vonage.CoreClientConfigJS {
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param {string} region The region where the API and WebSocket URLs should be configured.
+     *                        Valid values are "EU" (Europe), "US" (United States), or "AP" (Asia Pacific).
+     *                        The URLs will be automatically set based on the selected region.
+     *                        Defaults to "US" if no region is specified.
+     */
     constructor(region = ConfigRegion.US) {
         super(region);
     }
@@ -67573,6 +67590,36 @@ const setVonageClientLoggingLevel = setDefaultLoggingLevel;
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
  */
 class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS {
+    /**
+     * @internal
+     */
+    get core() {
+        return super.core;
+    }
+    /**
+     * @internal
+     */
+    get media() {
+        return super.media;
+    }
+    /**
+     * @internal
+     */
+    get emitter() {
+        return super.emitter;
+    }
+    /**
+     * @internal
+     */
+    set emitter(value) {
+        super.emitter = value;
+    }
+    /**
+     * @internal
+     */
+    hangupWithReason(callId, reasonText, reasonCode) {
+        return super.hangupWithReason(callId, reasonText, reasonCode);
+    }
     constructor() {
         super(new HttpClient(), new SocketClient(), new MediaClient());
         /**
@@ -67580,6 +67627,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
          * @internal
          */
         this.callbacks = new Map();
+        /**
+         * @internal
+         */
+        this.__doNotUseIt = super.__doNotUseIt;
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const _this = this;
         this.emitter = new Proxy(Object(), {
@@ -67608,6 +67659,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Register a callback for an event.
      *
+     * @example
+     * [[include:register_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
      * @returns a symbol that can be used to unregister the callback
@@ -67625,6 +67679,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Unregister a callback for an event.
      *
+     * @example
+     * [[include:unregister_listener.txt]]
+     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callbackSymbol - the callback symbol to unregister
      * @returns true if the callback was unregistered, false otherwise
@@ -67640,16 +67697,15 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Clear all callbacks for an event.
      *
-     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @example
+     * [[include: clear_callbacks.txt]]
+     *
+     * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
      *
      * @remarks
      * This is useful for cleaning up callbacks when you no longer need them.
      *
-     * @example
-     * ```ts
-     *    client.clearCallbacks('legStatusUpdate');
-     * ```
      */
     clearCallbacks(event) {
         const callbacks = this.callbacks.get(event);
@@ -67663,6 +67719,9 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
      * and returned. If a sessionId is provided, it will be used
      * to resume an existing session.
      *
+     * @example
+     * [[include:create_session.txt]]
+     *
      * @param token
      * @param sessionId - optional sessionId to use
      * @returns the `sessionId` of the session
@@ -67675,10 +67734,33 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
             return _super.createSession.call(this, token, sessionId || null);
         });
     }
+    /**
+     * Get the Peer Connection for a call
+     *
+     * @experimental
+     * @group Voice
+     * @param id - The Call Id
+     */
+    getPeerConnection(id) {
+        return super.getPeerConnection(id);
+    }
+    /**
+     * Get the Leg for a call
+     *
+     * @group Voice
+     * @param legId - The Leg Id
+     */
+    getLeg(legId) {
+        return super.getLeg(legId);
+    }
     /**
      * Make a server call to the Vonage API.
      * This is used to initiate a call using the Voice API and NCCO.
      *
+     * @example
+     * [[include:outbound_call.txt]]
+     *
+     * @group Voice
      * @param context - the context to send to the server passed as Custom data to the voice answer webhook
      * @returns the `callId` of the call
      */
@@ -67693,9 +67775,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Hangup a call.
      *
-     * @remarks
-     * this is a convenience method that calls `hangupWithReason` with
+     * @example
+     * [[include:call_hangup.txt]]
      *
+     * @group Voice
      * @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
@@ -67728,6 +67811,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a list of Conversations for the user.
      *
+     * @example
+     * [[include:get_conversations.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param order - the order to return the conversations in (default: 'asc')
      * @param pageSize - the number of conversations to return per page (default: 100)
      * @param cursor - the cursor to use for pagination (default: null)
@@ -67744,6 +67832,11 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     /**
      * Get a Conversation's Events
      *
+     * @example
+     * [[include:get_conversation_events.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the events in (default: 'asc')
      * @param pageSize - the number of events to return per page (default: 100)
@@ -67760,6 +67853,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation's Members
+     *
+     * @example
+     * [[include:get_conversation_members.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param order - the order to return the members in (default: 'asc')
      * @param pageSize - the number of members to return per page (default: 100)
@@ -67776,6 +67875,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Create a conversation
+     *
+     * @example
+     * [[include:create_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param name - the name of the conversation
      * @param displayName - the display name of the conversation
      * @returns the `cid` of the conversation
@@ -67790,6 +67895,10 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Conversation
+     *
+     * @example
+     * [[include:get_conversation.txt]]
+     *
      * @param id - the Conversation's id
      * @returns the `Conversation`
      */
@@ -67803,6 +67912,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Leave a Conversation
+     *
+     * @example
+     * [[include:leave_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -67816,6 +67931,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Join a Conversation
+     *
+     * @example
+     * [[include:join_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns the `memberId` of the member
      */
@@ -67829,6 +67950,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Delete a Conversation
+     *
+     * @example
+     * [[include:delete_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @returns void
      */
@@ -67842,6 +67969,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Invite a user to a Conversation by user's `name`
+     *
+     * @example
+     * [[include:invite_to_conversation.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param name - the namne of the user to invite
      * @returns the `memberId` of the member
@@ -67856,6 +67989,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a text message to a Conversation
+     *
+     * @example
+     * [[include:send_text_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param text - the Body of the message
      * @returns the `timestamp` of the message
@@ -67870,6 +68009,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Send a custom message to a Conversation
+     *
+     * @example
+     * [[include:send_custom_message.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param id - the Conversation's id
      * @param customData - the body of the message
      * @returns the `timestamp` of the message
@@ -67887,6 +68032,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
     }
     /**
      * Get a Member of a Conversation
+     *
+     * @example
+     * [[include:get_conversation_member.txt]]
+     *
+     * @group Chat
+     * @beta
      * @param cid - the Conversation's id
      * @param mid - the Member's id
      * @returns the `Member`