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

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/kotlin/clientsdk-clientcore_js.d.ts

@@ -1,7 +1,5 @@
 type Nullable<T> = T | null | undefined
-declare const __doNotImplementIt: unique symbol
-type __doNotImplementIt = typeof __doNotImplementIt
-export namespace vonage {
+export declare namespace vonage {
     interface CombinedEvents extends vonage.VoiceEvents, vonage.ChatEvents {
         callInvite(callId: string, from: string, channelType: string): void;
         callInviteCancel(callId: string, reason: vonage.CancelReasonJS): void;
@@ -17,7 +15,7 @@ export namespace vonage {
         conversationEvent(event: vonage.ConversationEventJS): void;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     class CombinedClientJS implements vonage.IChatClientJS, vonage.IVoiceClientJS {
         constructor(http: vonage.HttpClientJS, socket: vonage.SocketClientJS, media: vonage.MediaClientJS);
         get media(): vonage.MediaClientJS;
@@ -54,10 +52,10 @@ export namespace vonage {
         enableEarmuff(callId: string): Promise<any>;
         disableEarmuff(callId: string): Promise<any>;
         sendDTMF(callId: string, digits: string): Promise<any>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.IChatClientJS["__doNotUseOrImplementIt"] & vonage.IVoiceClientJS["__doNotUseOrImplementIt"];
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     class EventsPageJS {
         private constructor();
         get events(): Array<vonage.ConversationEventJS>;
@@ -69,7 +67,9 @@ export namespace vonage {
         readonly timestamp: string;
         readonly conversationId: string;
         readonly from: Nullable<string>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.ConversationEventJS": unique symbol;
+        };
     }
     class MemberInvitedEventJS implements vonage.ConversationEventJS {
         private constructor();
@@ -78,7 +78,7 @@ export namespace vonage {
         get conversationId(): string;
         get from(): string;
         get body(): vonage.MemberInvitedEventJS.Body;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.ConversationEventJS["__doNotUseOrImplementIt"];
     }
     namespace MemberInvitedEventJS {
         class Body {
@@ -94,7 +94,7 @@ export namespace vonage {
         get conversationId(): string;
         get from(): string;
         get body(): vonage.MemberJoinedEventJS.Body;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.ConversationEventJS["__doNotUseOrImplementIt"];
     }
     namespace MemberJoinedEventJS {
         class Body {
@@ -109,7 +109,7 @@ export namespace vonage {
         get conversationId(): string;
         get from(): string;
         get body(): vonage.MemberLeftEventJS.Body;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.ConversationEventJS["__doNotUseOrImplementIt"];
     }
     namespace MemberLeftEventJS {
         class Body {
@@ -124,21 +124,25 @@ export namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): Nullable<string>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.ConversationEventJS["__doNotUseOrImplementIt"];
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface MessageEventJS extends vonage.ConversationEventJS {
         readonly id: number;
         readonly body: vonage.MessageEventBodyJS;
         readonly timestamp: string;
         readonly conversationId: string;
         readonly from: Nullable<string>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.MessageEventJS": unique symbol;
+        } & vonage.ConversationEventJS["__doNotUseOrImplementIt"];
     }
     interface MessageEventBodyJS {
         readonly sender: vonage.UserJS;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.MessageEventBodyJS": unique symbol;
+        };
     }
     class TextMessageEventJS implements vonage.MessageEventJS {
         private constructor();
@@ -147,14 +151,14 @@ export namespace vonage {
         get conversationId(): string;
         get from(): string;
         get body(): vonage.TextMessageEventJS.Body;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.MessageEventJS["__doNotUseOrImplementIt"];
     }
     namespace TextMessageEventJS {
         class Body implements vonage.MessageEventBodyJS {
             private constructor();
             get sender(): vonage.UserJS;
             get text(): string;
-            readonly __doNotUseIt: __doNotImplementIt;
+            readonly __doNotUseOrImplementIt: vonage.MessageEventBodyJS["__doNotUseOrImplementIt"];
         }
     }
     class CustomMessageEventJS implements vonage.MessageEventJS {
@@ -164,18 +168,18 @@ export namespace vonage {
         get conversationId(): string;
         get from(): string;
         get body(): vonage.CustomMessageEventJS.Body;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: vonage.MessageEventJS["__doNotUseOrImplementIt"];
     }
     namespace CustomMessageEventJS {
         class Body implements vonage.MessageEventBodyJS {
             private constructor();
             get sender(): vonage.UserJS;
             get customData(): string;
-            readonly __doNotUseIt: __doNotImplementIt;
+            readonly __doNotUseOrImplementIt: vonage.MessageEventBodyJS["__doNotUseOrImplementIt"];
         }
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     abstract class PresentingOrderJS {
         private constructor();
         get corePresentingOrder(): any/* com.vonage.clientcore.core.api.models.PresentingOrder */;
@@ -389,7 +393,7 @@ export namespace vonage {
         get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     const CSErrorCodesJS: {
         get CONVERSATION_DUPLICATE_NAME(): string;
         get MEMBER_ALREADY_JOINED(): string;
@@ -420,7 +424,7 @@ export namespace vonage {
         get TRANSPORT_CLOSED_DISCONNECT(): string;
     };
 }
-export namespace vonage {
+export declare namespace vonage {
     class VonageErrorJS extends Error {
         private constructor();
         get type(): vonage.VonageErrorTypeJS;
@@ -455,7 +459,7 @@ export namespace vonage {
         get ordinal(): 0 | 1 | 2 | 3 | 4;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface ChatEvents extends vonage.CoreClientEvents {
         conversationEvent(event: vonage.ConversationEventJS): void;
         reconnecting(): void;
@@ -463,7 +467,7 @@ export namespace vonage {
         sessionError(reason: vonage.SessionErrorReasonJS): void;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface IChatClientJS extends vonage.ICoreClientJS {
         readonly core: any/* com.vonage.clientcore.core.CoreClient */;
         createConversation(name: Nullable<string>, displayName: Nullable<string>): Promise<string>;
@@ -483,17 +487,19 @@ export namespace vonage {
         refreshSession(token: string): Promise<any>;
         getConversation(conversationId: string): Promise<vonage.ConversationJS>;
         getUser(userIdOrName: string): Promise<vonage.UserJS>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.IChatClientJS": unique symbol;
+        } & vonage.ICoreClientJS["__doNotUseOrImplementIt"];
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface CoreClientEvents {
         reconnecting(): void;
         reconnection(): void;
         sessionError(reason: vonage.SessionErrorReasonJS): void;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     abstract class CoreClientConfigRegionJS {
         private constructor();
         get coreRegion(): any/* com.vonage.clientcore.core.api.ClientConfigRegion */;
@@ -590,10 +596,12 @@ export namespace vonage {
         refreshSession(token: string): Promise<any>;
         getConversation(conversationId: string): Promise<vonage.ConversationJS>;
         getUser(userIdOrName: string): Promise<vonage.UserJS>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.ICoreClientJS": unique symbol;
+        };
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface VoiceEvents extends vonage.CoreClientEvents {
         callInvite(callId: string, from: string, channelType: string): void;
         callInviteCancel(callId: string, reason: vonage.CancelReasonJS): void;
@@ -609,14 +617,14 @@ export namespace vonage {
     }
     interface CallSayParams {
         readonly text: string;
-        readonly level: Nullable<number>;
-        readonly loop: Nullable<number>;
-        readonly queue: Nullable<boolean>;
-        readonly voiceName: Nullable<string>;
-        readonly ssml: Nullable<boolean>;
+        readonly level?: Nullable<number>;
+        readonly loop?: Nullable<number>;
+        readonly queue?: Nullable<boolean>;
+        readonly voiceName?: Nullable<string>;
+        readonly ssml?: Nullable<boolean>;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     abstract class LegStatusJS {
         private constructor();
         static get RINGING(): vonage.LegStatusJS & {
@@ -691,26 +699,26 @@ export namespace vonage {
         refreshSession(token: string): Promise<any>;
         getConversation(conversationId: string): Promise<vonage.ConversationJS>;
         getUser(userIdOrName: string): Promise<vonage.UserJS>;
-        readonly __doNotUseIt: __doNotImplementIt;
+        readonly __doNotUseOrImplementIt: {
+            readonly "vonage.IVoiceClientJS": unique symbol;
+        } & vonage.ICoreClientJS["__doNotUseOrImplementIt"];
     }
     class VoiceInviteFromInfoJS {
         constructor(id: Nullable<string>, type: string);
         get id(): Nullable<string>;
         get type(): string;
-        component1(): Nullable<string>;
-        component2(): string;
         copy(id?: Nullable<string>, type?: string): vonage.VoiceInviteFromInfoJS;
         toString(): string;
         hashCode(): number;
         equals(other: Nullable<any>): boolean;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     interface HttpClientJS {
         request(verb: string, url: string, headers: Json, body: Nullable<string>, callback: (p0: Nullable<vonage.HttpClientErrorJS>, p1: Nullable<vonage.HttpClientResponseJS>) => void): void;
     }
     interface SocketClientJS {
-        delegate: Nullable<vonage.SocketClientDelegateJS>;
+        delegate?: Nullable<vonage.SocketClientDelegateJS>;
         emit(type: string, msg: Nullable<Json>, callback: (p0: Nullable<Error>, p1: Nullable<string>) => void): void;
         connect(host: string, path: string, reconnectionAttempts: any/* kotlin.Number */, reconnectionDelay: any/* kotlin.Number */, randomizationFactor: any/* kotlin.Number */, query: string): void;
         disconnect(): void;
@@ -722,7 +730,7 @@ export namespace vonage {
         didReceiveNewSocketConnectionStatusEvent(type: string, reason: Nullable<string>, timestamp: any/* kotlin.Number */, retryNumber: Nullable<number>): void;
     }
     interface MediaClientJS {
-        delegate: Nullable<vonage.MediaClientDelegateJS>;
+        delegate?: Nullable<vonage.MediaClientDelegateJS>;
         enableMediaOutbound(closure: (p0: any, p1: Nullable<string>, p2: (p0: string) => void) => void): void;
         enableMediaInbound(closure: (p0: any, p1: Nullable<string>) => void, offerSDP: string, rtcId: string): void;
         processAnswer(id: string, sdp: string): void;
@@ -737,12 +745,10 @@ export namespace vonage {
         onConnectionChange(id: string, status: string): void;
     }
 }
-export namespace vonage {
+export declare namespace vonage {
     class HttpClientErrorJS extends Error {
         constructor(message?: Nullable<string>, cause?: Nullable<Error>);
         get coreError(): any/* com.vonage.clientcore.core.middlewares.http.HTTPClientError */;
-        component1(): Nullable<string>;
-        component2(): Nullable<Error>;
         copy(message?: Nullable<string>, cause?: Nullable<Error>): vonage.HttpClientErrorJS;
         toString(): string;
         hashCode(): number;
@@ -752,8 +758,6 @@ export namespace vonage {
         constructor(statusCode: number, body?: Nullable<string>);
         get statusCode(): number;
         get body(): Nullable<string>;
-        component1(): number;
-        component2(): Nullable<string>;
         copy(statusCode?: number, body?: Nullable<string>): vonage.HttpClientResponseJS;
         toString(): string;
         hashCode(): number;
@@ -807,28 +811,18 @@ export namespace vonage {
         equals(other: Nullable<any>): boolean;
     }
     class RTCStatsJS {
-        constructor(audioRecvPackets: any/* Nullable<kotlin.Number> */, audioRecvPacketsLost: any/* Nullable<kotlin.Number> */, audioRecvBytes: any/* Nullable<kotlin.Number> */, audioRecvJitter: any/* Nullable<kotlin.Number> */, audioSentPackets: any/* Nullable<kotlin.Number> */, audioSentBytes: any/* Nullable<kotlin.Number> */, audioSentPacketsLost: any/* Nullable<kotlin.Number> */, audioRtt: any/* Nullable<kotlin.Number> */, audioSentJitter: any/* Nullable<kotlin.Number> */, legId: string);
-        get audioRecvPackets(): any/* Nullable<kotlin.Number> */;
-        get audioRecvPacketsLost(): any/* Nullable<kotlin.Number> */;
-        get audioRecvBytes(): any/* Nullable<kotlin.Number> */;
-        get audioRecvJitter(): any/* Nullable<kotlin.Number> */;
-        get audioSentPackets(): any/* Nullable<kotlin.Number> */;
-        get audioSentBytes(): any/* Nullable<kotlin.Number> */;
-        get audioSentPacketsLost(): any/* Nullable<kotlin.Number> */;
-        get audioRtt(): any/* Nullable<kotlin.Number> */;
-        get audioSentJitter(): any/* Nullable<kotlin.Number> */;
+        constructor(audioRecvPackets: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvPacketsLost: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvBytes: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvJitter: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPackets: Nullable<any>/* Nullable<kotlin.Number> */, audioSentBytes: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPacketsLost: Nullable<any>/* Nullable<kotlin.Number> */, audioRtt: Nullable<any>/* Nullable<kotlin.Number> */, audioSentJitter: Nullable<any>/* Nullable<kotlin.Number> */, legId: string);
+        get audioRecvPackets(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioRecvPacketsLost(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioRecvBytes(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioRecvJitter(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioSentPackets(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioSentBytes(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioSentPacketsLost(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioRtt(): Nullable<any>/* Nullable<kotlin.Number> */;
+        get audioSentJitter(): Nullable<any>/* Nullable<kotlin.Number> */;
         get legId(): string;
-        component1(): any/* Nullable<kotlin.Number> */;
-        component2(): any/* Nullable<kotlin.Number> */;
-        component3(): any/* Nullable<kotlin.Number> */;
-        component4(): any/* Nullable<kotlin.Number> */;
-        component5(): any/* Nullable<kotlin.Number> */;
-        component6(): any/* Nullable<kotlin.Number> */;
-        component7(): any/* Nullable<kotlin.Number> */;
-        component8(): any/* Nullable<kotlin.Number> */;
-        component9(): any/* Nullable<kotlin.Number> */;
-        component10(): string;
-        copy(audioRecvPackets?: any/* Nullable<kotlin.Number> */, audioRecvPacketsLost?: any/* Nullable<kotlin.Number> */, audioRecvBytes?: any/* Nullable<kotlin.Number> */, audioRecvJitter?: any/* Nullable<kotlin.Number> */, audioSentPackets?: any/* Nullable<kotlin.Number> */, audioSentBytes?: any/* Nullable<kotlin.Number> */, audioSentPacketsLost?: any/* Nullable<kotlin.Number> */, audioRtt?: any/* Nullable<kotlin.Number> */, audioSentJitter?: any/* Nullable<kotlin.Number> */, legId?: string): vonage.RTCStatsJS;
+        copy(audioRecvPackets?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvPacketsLost?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvBytes?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvJitter?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPackets?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentBytes?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPacketsLost?: Nullable<any>/* Nullable<kotlin.Number> */, audioRtt?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentJitter?: Nullable<any>/* Nullable<kotlin.Number> */, legId?: string): vonage.RTCStatsJS;
         toString(): string;
         hashCode(): number;
         equals(other: Nullable<any>): boolean;

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);
 }