@vonage/client-sdk 1.6.0 → 1.6.1-alpha.1

package/dist/utils/RequestParameterModels.d.ts

@@ -5,7 +5,6 @@ import { Option } from './Option';
 /**
  * Parameters object for {@link VonageClient.createConversation}
  *
- * @beta
  * @property name The name to initialize the conversation with
  * @property displayName The displayName to initialize the conversation with
  * @property imageUrl The name to imageUrl the conversation with
@@ -23,7 +22,6 @@ export type CreateConversationParameters = Omit<vonage.CreateConversationParamet
 /**
  * Parameters object for {@link VonageClient.getConversations}
  *
- * @beta
  * @property order The order in which conversations are presented, default is {@link PresentingOrder.ASC}.
  * @property pageSize The maximum number of conversations to retrieve per request, default is 10.
  * @property cursor The cursor indicating the starting point for pagination, default is the first page.
@@ -40,7 +38,6 @@ export type GetConversationsParameters = Omit<vonage.GetConversationsParametersJ
 /**
  * Parameters object for {@link VonageClient.getConversationEvents}
  *
- * @beta
  * @property order The order in which conversation events are presented, default is {@link PresentingOrder.ASC}.
  * @property pageSize The maximum number of conversation events to retrieve per request, default is 10.
  * @property cursor The cursor indicating the starting point for pagination, default is the first page.
@@ -58,7 +55,6 @@ export type GetConversationEventsParameters = Omit<vonage.GetConversationEventsP
 /**
  * Parameters object for {@link VonageClient.getConversationMembers}
  *
- * @beta
  * @property order The order in which conversation members are presented, default is {@link PresentingOrder.ASC}.
  * @property pageSize The maximum number of conversation members to retrieve per request, default is 10.
  * @property cursor The cursor indicating the starting point for pagination, default is the first page.
@@ -72,7 +68,6 @@ export type GetConversationMembersParameters = Omit<vonage.GetConversationMember
 /**
  * Parameters object for {@link VonageClient.getCallLegs}
  *
- * @beta
  * @property order The order in which call legs are presented, default is {@link PresentingOrder.ASC}.
  * @property pageSize The maximum number of legs to retrieve per request, default is 10.
  * @property cursor The cursor indicating the starting point for pagination, default is the first page.
@@ -90,7 +85,6 @@ export type GetCallLegsParameters = Omit<vonage.GetCallLegsParametersJS, 'pageSi
  * When set to {@link Option.Some} the property will be updated.
  * When set to {@link Option.None} the property will remain unchanged.
  *
- * @beta
  * @property name The name of the conversation.
  * @property displayName A display name for the conversation.
  * @property imageUrl The URL of an image associated with the conversation.
@@ -111,13 +105,11 @@ export interface UpdateConversationParameters {
 /**
  * The order in which paginated objects are presented.
  *
- * @beta
  * @group Chat
  */
 export type PresentingOrder = Lowercase<typeof vonage.PresentingOrderJS.prototype.name> | vonage.PresentingOrderJS;
 /**
  * The order in which paginated objects are presented.
- * @beta
  * @group Chat
  * @enum
  * @property ASC Ascending order
@@ -129,13 +121,11 @@ export declare const PresentingOrder: {
 /**
  * The sorting strategy used for paginated objects.
  *
- * @beta
  * @group Chat
  */
 export type OrderBy = Lowercase<typeof vonage.OrderByJS.prototype.name> | vonage.OrderByJS;
 /**
  * The sorting strategy used for paginated objects.
- * @beta
  * @group Chat
  * @enum
  */

package/dist/vonageClientSDK.js

@@ -33198,9 +33198,6 @@
     		  setMetadataFor(Companion_133, 'Companion', objectMeta);
     		  setMetadataFor($serializer_153, '$serializer', objectMeta, VOID, [GeneratedSerializer]);
     		  setMetadataFor(SessionTerminatedEvent, 'SessionTerminatedEvent', classMeta, VOID, [SocketEvent], VOID, VOID, {0: $serializer_getInstance_153});
-    		  function onConversationEvent(event) {
-    		  }
-    		  setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
     		  function onRTCHangup(conversationId, legId, hangup) {
     		  }
     		  function onRTCTransfer(conversationId, legId) {
@@ -33208,6 +33205,9 @@
     		  function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
     		  }
     		  setMetadataFor(RTCEventListener, 'RTCEventListener', interfaceMeta);
+    		  function onConversationEvent(event) {
+    		  }
+    		  setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
     		  function onAudioSay() {
     		  }
     		  function onAudioMuteUpdate(conversationId, legId, isMuted) {
@@ -33217,7 +33217,7 @@
     		  function onAudioDTMFUpdate(conversationId, legId, digits) {
     		  }
     		  setMetadataFor(AudioEventListener, 'AudioEventListener', interfaceMeta);
-    		  setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
+    		  setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
     		  setMetadataFor(ChatAPIImpl, 'ChatAPIImpl', classMeta, VOID, [ChatAPI]);
     		  setMetadataFor(LoggingLevel, 'LoggingLevel', classMeta, Enum);
     		  setMetadataFor(ClientConfigRegion, 'ClientConfigRegion', classMeta, Enum);
@@ -33351,7 +33351,7 @@
     		  setMetadataFor(HangupReason, 'HangupReason', classMeta, Enum);
     		  setMetadataFor(LegStatus, 'LegStatus', classMeta, Enum);
     		  setMetadataFor(CallDisconnectReason, 'CallDisconnectReason', classMeta, Enum);
-    		  setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
+    		  setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
     		  setMetadataFor(VoiceAPIImpl, 'VoiceAPIImpl', classMeta);
     		  setMetadataFor(CallEvent, 'CallEvent', interfaceMeta);
     		  setMetadataFor(SetupOutboundCall, 'SetupOutboundCall', classMeta, VOID, [CallEvent]);
@@ -33567,7 +33567,7 @@
     		  setMetadataFor(Failed, 'Failed', classMeta, StateTransition);
     		  //endregion
     		  function BuildKonfig() {
-    		    this.g1d_1 = '1.6.0';
+    		    this.g1d_1 = '1.6.1-alpha.1';
     		  }
     		  var BuildKonfig_instance;
     		  function CoreClientWithMedia() {
@@ -74238,6 +74238,9 @@
     	  function getPeerConnection(id) {
     	    return this.media.getPeerConnection(id);
     	  }
+    	  function getAudioElement() {
+    	    return this.media.getAudioElement();
+    	  }
     	  function serverCall(context) {
     	    var tmp0_safe_receiver = get_jsonNullable(context);
     	    var tmp1_elvis_lhs = tmp0_safe_receiver == null ? null : toMap_0(tmp0_safe_receiver);
@@ -80985,6 +80988,7 @@
     	  protoOf(CombinedClientJS).getConversation = getConversation;
     	  protoOf(CombinedClientJS).getUser = getUser;
     	  protoOf(CombinedClientJS).getPeerConnection = getPeerConnection;
+    	  protoOf(CombinedClientJS).getAudioElement = getAudioElement;
     	  protoOf(CombinedClientJS).serverCall = serverCall;
     	  protoOf(CombinedClientJS).reconnectCall = reconnectCall;
     	  protoOf(CombinedClientJS).getLeg = getLeg;
@@ -85783,6 +85787,9 @@
                 }
             });
         }
+        getAudioElement() {
+            return this.audio;
+        }
         getPeerConnection(id) {
             const pc = this.pcs.get(id);
             return pc;
@@ -89945,7 +89952,6 @@
 
     /**
      * The order in which paginated objects are presented.
-     * @beta
      * @group Chat
      * @enum
      * @property ASC Ascending order
@@ -89957,7 +89963,6 @@
     };
     /**
      * The sorting strategy used for paginated objects.
-     * @beta
      * @group Chat
      * @enum
      */
@@ -90231,6 +90236,16 @@
         getPeerConnection(id) {
             return super.getPeerConnection(id);
         }
+        /**
+         * Get the HTML Audio Element for the SDK.
+         * It can be used to route output to other devices.
+         *
+         * @experimental
+         * @group Voice
+         */
+        getAudioElement() {
+            return super.getAudioElement();
+        }
         /**
          * Get the Leg for a call
          *
@@ -90252,7 +90267,6 @@
          * [[include: snippet_GetCallLegs.txt]]
          *
          * @group Voice
-         * @beta
          * @param id - the Call's id
          * @param parameters - A {@link GetCallLegsParameters} object containing the parameters for the request.
          * @returns a `LegsPage` containing the legs
@@ -90476,7 +90490,6 @@
          * [[include: snippet_LeaveConversation.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @returns void
          */
@@ -90495,7 +90508,6 @@
          * [[include: snippet_JoinConversation.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @returns the `memberId` of the member
          */
@@ -90514,7 +90526,6 @@
          * [[include: snippet_DeleteConversation.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @returns void
          */
@@ -90533,7 +90544,6 @@
          * [[include: snippet_InviteToConversation.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param name - the name of the user to invite
          * @returns the `memberId` of the member
@@ -90553,7 +90563,6 @@
          * [[include: snippet_SendTextMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param text - the Body of the message
          * @returns the `timestamp` of the message
@@ -90573,7 +90582,6 @@
          * [[include: snippet_SendCustomMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param customData - the body of the message
          * @returns the `timestamp` of the message
@@ -90596,7 +90604,6 @@
          * [[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
@@ -90616,7 +90623,6 @@
          * [[include: snippet_SendVideoMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param videoUrl - the url of the video resource.
          * @returns the `timestamp` of the message
@@ -90636,7 +90642,6 @@
          * [[include: snippet_SendFileMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param fileUrl - the url of the file resource.
          * @returns the `timestamp` of the message
@@ -90656,7 +90661,6 @@
          * [[include: snippet_SendAudioMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param audioUrl - the url of the audio resource.
          * @returns the `timestamp` of the message
@@ -90676,7 +90680,6 @@
          * [[include: snippet_SendVcardMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param vCardUrl - the url of the vCardUrl resource.
          * @returns the `timestamp` of the message
@@ -90696,7 +90699,6 @@
          * [[include: snippet_SendLocationMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param location - the description of the location.
          * @returns the `timestamp` of the message
@@ -90716,7 +90718,6 @@
          * [[include: snippet_SendTemplateMessage.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param whatsappObject - the description(locale and policies of business account) of the location.
          * @param templateObject - the description(name and paramters) of the template.
@@ -90737,7 +90738,6 @@
          * [[include: snippet_SendEphemeralEvent.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param customData - the body of the event
          * @returns the `timestamp` of the message
@@ -90760,7 +90760,6 @@
          * [[include: snippet_SendCustomEvent.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the Conversation's id
          * @param evenType - the type of the custom event. Type must start with `custom:<...>`
          * @param customData - the body of the event
@@ -90784,7 +90783,6 @@
          * [[include:snippet_DeleteEvent.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the id for the Event to be deleted
          * @param conversationId - the id for the conversation, the event belongs to.
          * @returns void
@@ -90804,7 +90802,6 @@
          * [[include: snippet_SendMessageSeenEvent.txt]]
          *
          * @group Chat
-         * @beta
          * @param id - the event id
          * @param conversationId - the conversation id
          * @returns the `timestamp` of the message