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

package/dist/coreExtend.d.ts

@@ -4,37 +4,85 @@ declare module './kotlin/clientsdk-clientcore_js' {
         interface CombinedClientJS {
             /**
              * Mute your leg of a call
+             *
+             * @example
+             * [[include:call_mute.txt]]
+             *
              * @param callId - Call ID
              * @returns void
+             * @group Voice
              */
             mute(callId: string): Promise<void>;
             /**
              * Unmute your leg of a call
              * @param callId - Call ID
              * @returns void
+             * @group Voice
              */
             unmute(callId: string): Promise<void>;
             /**
              * Earmuff your leg of a call
+             *
+             * @example
+             * [[include:earmuff_event.txt]]
+             *
              * @param callId - Call ID
              * @returns void
+             * @group Voice
              */
             enableEarmuff(callId: string): Promise<void>;
             /**
              * Unearmuff your leg of a call
              * @param callId - Call ID
              * @returns void
+             * @group Voice
              */
             disableEarmuff(callId: string): Promise<void>;
-        }
-        interface CoreClientJS {
             /**
-             * Get the peer connection for a call
+             * Send a string of digits to a call via DTMF
+             *
+             * @example
+             * [[include:send_dtmf_digits.txt]]
+             *
+             * @param callId - Call ID
+             * @param digits - DTMF digits
+             * @returns void
+             * @group Voice
+             */
+            sendDTMF(callId: string, digits: string): Promise<void>;
+            /**
+             * Answer a call
+             *
+             * @example
+             * [[include:answer_call.txt]]
+             *
+             * @param callId - Call ID
+             * @returns void
+             * @group Voice
+             */
+            answerCall(callId: string): Promise<void>;
+            /**
+             * Reject a call
              *
-             * @internal
-             * @param id - Call ID
+             * @example
+             * [[include:reject_call.txt]]
+             *
+             * @param callId - Call ID
+             * @returns void
+             * @group Voice
+             */
+            rejectCall(callId: string): Promise<void>;
+            /**
+             * Reconnect a call
+             *
+             * @example
+             * [[include:reconnect_call.txt]]
+             *
+             * @param callId - Call ID
+             * @returns void
+             * @group Voice
              */
-            getPeerConnection(id: string): RTCPeerConnection;
+            reconnectCall(callId: string): Promise<void>;
         }
     }
 }

package/dist/utils/ClientConfig.d.ts

@@ -1,5 +1,22 @@
 import vonage from '../utils/vonage';
 export declare const ConfigRegion: typeof 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]]
+ */
 export declare class ClientConfig extends 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?: vonage.CoreClientConfigRegionJS);
 }

package/dist/vonageClientSDK.js

@@ -75485,7 +75485,24 @@
     }
 
     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);
         }
@@ -75529,6 +75546,36 @@
      * 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());
             /**
@@ -75536,6 +75583,10 @@
              * @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(), {
@@ -75564,6 +75615,9 @@
         /**
          * 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
@@ -75581,6 +75635,9 @@
         /**
          * 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
@@ -75596,16 +75653,15 @@
         /**
          * 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);
@@ -75619,6 +75675,9 @@
          * 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
@@ -75631,10 +75690,33 @@
                 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
          */
@@ -75649,9 +75731,10 @@
         /**
          * 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
@@ -75684,6 +75767,11 @@
         /**
          * 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)
@@ -75700,6 +75788,11 @@
         /**
          * 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)
@@ -75716,6 +75809,12 @@
         }
         /**
          * 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)
@@ -75732,6 +75831,12 @@
         }
         /**
          * 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
@@ -75746,6 +75851,10 @@
         }
         /**
          * Get a Conversation
+         *
+         * @example
+         * [[include:get_conversation.txt]]
+         *
          * @param id - the Conversation's id
          * @returns the `Conversation`
          */
@@ -75759,6 +75868,12 @@
         }
         /**
          * Leave a Conversation
+         *
+         * @example
+         * [[include:leave_conversation.txt]]
+         *
+         * @group Chat
+         * @beta
          * @param id - the Conversation's id
          * @returns void
          */
@@ -75772,6 +75887,12 @@
         }
         /**
          * Join a Conversation
+         *
+         * @example
+         * [[include:join_conversation.txt]]
+         *
+         * @group Chat
+         * @beta
          * @param id - the Conversation's id
          * @returns the `memberId` of the member
          */
@@ -75785,6 +75906,12 @@
         }
         /**
          * Delete a Conversation
+         *
+         * @example
+         * [[include:delete_conversation.txt]]
+         *
+         * @group Chat
+         * @beta
          * @param id - the Conversation's id
          * @returns void
          */
@@ -75798,6 +75925,12 @@
         }
         /**
          * 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
@@ -75812,6 +75945,12 @@
         }
         /**
          * 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
@@ -75826,6 +75965,12 @@
         }
         /**
          * 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
@@ -75843,6 +75988,12 @@
         }
         /**
          * 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`