@vonage/client-sdk 1.5.1 → 1.5.2-beta.1

package/dist/coreExtend.d.ts

@@ -1,5 +1,6 @@
 import './kotlin/clientsdk-clientcore_js';
 import { Json as InternalJson } from './utils/JsonUtils';
+import { Member } from './utils';
 declare module './kotlin/clientsdk-clientcore_js' {
     type Json = InternalJson;
     namespace vonage {
@@ -89,6 +90,19 @@ declare module './kotlin/clientsdk-clientcore_js' {
              * @group Voice
              */
             reconnectCall(callId: string): Promise<void>;
+            /**
+             * Get a Member of a Conversation
+             *
+             * @example
+             * [[include: snippet_GetConversationMember.txt]]
+             *
+             * @group Chat
+             * @beta
+             * @param cid - the Conversation's id
+             * @param mid - the Member's id
+             * @returns the `Member`
+             */
+            getConversationMember(cid: string, mid: string): Promise<Member>;
         }
     }
 }

package/dist/kotlin/JsUnions.d.ts

@@ -388,6 +388,10 @@ export type MessageVideoEvent = Omit<vonage.MessageVideoEventJS, 'kind' | 'from'
  * @group Chat
  */
 export type PersistentConversationEvent = CustomConversationEvent | EventDeleteConversationEvent | MemberInvitedEvent | MemberJoinedEvent | MemberLeftEvent | MessageAudioEvent | MessageCustomEvent | MessageDeliveredEvent | MessageFileEvent | MessageImageEvent | MessageLocationEvent | MessageRejectedEvent | MessageSeenEvent | MessageSubmittedEvent | MessageTemplateEvent | MessageTextEvent | MessageUndeliverableEvent | MessageVCardEvent | MessageVideoEvent;
+/**
+ * A VoiceChannelTypeJS is a union of 'app', 'phone', 'sip', 'websocket'
+ */
+export type VoiceChannelTypeJS = 'app' | 'phone' | 'sip' | 'websocket';
 /**
  * A ConversationEvent is a union of {@link NonPersistentConversationEvent}, {@link PersistentConversationEvent}
  * @group Chat
@@ -401,3 +405,23 @@ export type ConversationState = 'ACTIVE' | 'INACTIVE' | 'DELETED';
  * A MemberState is a union of 'INVITED', 'JOINED', 'LEFT', 'UNKNOWN'
  */
 export type MemberState = 'INVITED' | 'JOINED' | 'LEFT' | 'UNKNOWN';
+/**
+ * A ConversationChannelType is a union of 'APP', 'PHONE', 'PSTN', 'sip', 'VBC', 'WEBSOCKET', 'SMS', 'MMS', 'WHATSAPP', 'VIBER', 'MESSENGER'
+ */
+export type ConversationChannelType = 'APP' | 'PHONE' | 'PSTN' | 'sip' | 'VBC' | 'WEBSOCKET' | 'SMS' | 'MMS' | 'WHATSAPP' | 'VIBER' | 'MESSENGER';
+/**
+ * A LegStatusJS is a union of 'RINGING', 'ANSWERED', 'COMPLETED'
+ */
+export type LegStatusJS = 'RINGING' | 'ANSWERED' | 'COMPLETED';
+/**
+ * A CallDisconnectReasonJS is a 'networkChange'
+ */
+export type CallDisconnectReasonJS = 'networkChange';
+/**
+ * A HangupReasonJS is a union of 'REMOTE_HANGUP', 'REMOTE_REJECT', 'REMOTE_NO_ANSWER_TIMEOUT', 'LOCAL_HANGUP', 'MEDIA_TIMEOUT'
+ */
+export type HangupReasonJS = 'REMOTE_HANGUP' | 'REMOTE_REJECT' | 'REMOTE_NO_ANSWER_TIMEOUT' | 'LOCAL_HANGUP' | 'MEDIA_TIMEOUT';
+/**
+ * A CancelReasonJS is a union of 'RemoteCancel', 'AnsweredElsewhere', 'RejectedElsewhere', 'RemoteTimeout'
+ */
+export type CancelReasonJS = 'RemoteCancel' | 'AnsweredElsewhere' | 'RejectedElsewhere' | 'RemoteTimeout';

package/dist/kotlin/clientsdk-clientcore_js.d.ts

@@ -2,16 +2,16 @@ type Nullable<T> = T | null | undefined
 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;
+        callInviteCancel(callId: string, reason: string): void;
         callTransfer(callId: string, conversationId: string): void;
         mute(callId: string, legId: string, isMuted: boolean): void;
         earmuff(callId: string, legId: string, earmuffStatus: boolean): void;
         dtmf(callId: string, legId: string, digits: string): void;
-        callHangup(callId: string, callQuality: vonage.RTCQualityJS, reason: vonage.HangupReasonJS): void;
-        legStatusUpdate(callId: string, legId: string, status: vonage.LegStatusJS): void;
+        callHangup(callId: string, callQuality: vonage.RTCQualityJS, reason: string): void;
+        legStatusUpdate(callId: string, legId: string, status: string): void;
         callMediaReconnecting(callId: string): void;
         callMediaReconnection(callId: string): void;
-        callMediaDisconnect(callId: string, reason: vonage.CallDisconnectReasonJS): void;
+        callMediaDisconnect(callId: string, reason: string): void;
         rtcStatsUpdate(rtcStats: vonage.RTCStatsJS, legId: string): void;
         callMediaError(callId: string, error: vonage.VonageErrorJS): void;
         reconnecting(): void;
@@ -21,6 +21,15 @@ export declare namespace vonage {
     }
 }
 export declare namespace vonage {
+    const VoiceChannelTypeObject: {
+        get app(): string;
+        get phone(): string;
+        get sip(): string;
+        get websocket(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
     class CombinedClientJS implements vonage.IChatClientJS, vonage.IVoiceClientJS {
         constructor(config: vonage.InitConfigObjectJS, http: vonage.HttpClientJS, socket: vonage.SocketClientJS, media: vonage.MediaClientJS);
         get media(): vonage.MediaClientJS;
@@ -584,7 +593,7 @@ export declare namespace vonage {
     }
     class MemberChannelJS {
         private constructor();
-        get type(): vonage.ChannelTypeJS;
+        get type(): string;
         get from(): Nullable<vonage.ChannelJS>;
         get to(): Nullable<vonage.ChannelJS>;
     }
@@ -627,57 +636,22 @@ export declare namespace vonage {
         get previousCursor(): Nullable<string>;
         get nextCursor(): Nullable<string>;
     }
-    abstract class ChannelTypeJS {
-        private constructor();
-        static get APP(): vonage.ChannelTypeJS & {
-            get name(): "APP";
-            get ordinal(): 0;
-        };
-        static get PHONE(): vonage.ChannelTypeJS & {
-            get name(): "PHONE";
-            get ordinal(): 1;
-        };
-        static get PSTN(): vonage.ChannelTypeJS & {
-            get name(): "PSTN";
-            get ordinal(): 2;
-        };
-        static get sip(): vonage.ChannelTypeJS & {
-            get name(): "sip";
-            get ordinal(): 3;
-        };
-        static get VBC(): vonage.ChannelTypeJS & {
-            get name(): "VBC";
-            get ordinal(): 4;
-        };
-        static get WEBSOCKET(): vonage.ChannelTypeJS & {
-            get name(): "WEBSOCKET";
-            get ordinal(): 5;
-        };
-        static get SMS(): vonage.ChannelTypeJS & {
-            get name(): "SMS";
-            get ordinal(): 6;
-        };
-        static get MMS(): vonage.ChannelTypeJS & {
-            get name(): "MMS";
-            get ordinal(): 7;
-        };
-        static get WHATSAPP(): vonage.ChannelTypeJS & {
-            get name(): "WHATSAPP";
-            get ordinal(): 8;
-        };
-        static get VIBER(): vonage.ChannelTypeJS & {
-            get name(): "VIBER";
-            get ordinal(): 9;
-        };
-        static get MESSENGER(): vonage.ChannelTypeJS & {
-            get name(): "MESSENGER";
-            get ordinal(): 10;
-        };
-        static values(): Array<vonage.ChannelTypeJS>;
-        static valueOf(value: string): vonage.ChannelTypeJS;
-        get name(): "APP" | "PHONE" | "PSTN" | "sip" | "VBC" | "WEBSOCKET" | "SMS" | "MMS" | "WHATSAPP" | "VIBER" | "MESSENGER";
-        get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-    }
+    const ChannelTypeObj: {
+        get APP(): string;
+        get PHONE(): string;
+        get PSTN(): string;
+        get SIP(): string;
+        get VBC(): string;
+        get WEBSOCKET(): string;
+        get SMS(): string;
+        get MMS(): string;
+        get WHATSAPP(): string;
+        get VIBER(): string;
+        get MESSENGER(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
 }
 export declare namespace vonage {
     const CSErrorCodesJS: {
@@ -1014,16 +988,16 @@ export declare 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;
+        callInviteCancel(callId: string, reason: string): void;
         callTransfer(callId: string, conversationId: string): void;
         mute(callId: string, legId: string, isMuted: boolean): void;
         earmuff(callId: string, legId: string, earmuffStatus: boolean): void;
         dtmf(callId: string, legId: string, digits: string): void;
-        callHangup(callId: string, callQuality: vonage.RTCQualityJS, reason: vonage.HangupReasonJS): void;
-        legStatusUpdate(callId: string, legId: string, status: vonage.LegStatusJS): void;
+        callHangup(callId: string, callQuality: vonage.RTCQualityJS, reason: string): void;
+        legStatusUpdate(callId: string, legId: string, status: string): void;
         callMediaReconnecting(callId: string): void;
         callMediaReconnection(callId: string): void;
-        callMediaDisconnect(callId: string, reason: vonage.CallDisconnectReasonJS): void;
+        callMediaDisconnect(callId: string, reason: string): void;
         rtcStatsUpdate(rtcStats: vonage.RTCStatsJS, legId: string): void;
         callMediaError(callId: string, error: vonage.VonageErrorJS): void;
         reconnecting(): void;
@@ -1040,63 +1014,30 @@ export declare namespace vonage {
     }
 }
 export declare namespace vonage {
-    abstract class LegStatusJS {
-        private constructor();
-        static get RINGING(): vonage.LegStatusJS & {
-            get name(): "RINGING";
-            get ordinal(): 0;
-        };
-        static get ANSWERED(): vonage.LegStatusJS & {
-            get name(): "ANSWERED";
-            get ordinal(): 1;
-        };
-        static get COMPLETED(): vonage.LegStatusJS & {
-            get name(): "COMPLETED";
-            get ordinal(): 2;
-        };
-        static values(): Array<vonage.LegStatusJS>;
-        static valueOf(value: string): vonage.LegStatusJS;
-        get name(): "RINGING" | "ANSWERED" | "COMPLETED";
-        get ordinal(): 0 | 1 | 2;
-    }
-    abstract class CallDisconnectReasonJS {
-        private constructor();
-        static get networkChange(): vonage.CallDisconnectReasonJS & {
-            get name(): "networkChange";
-            get ordinal(): 0;
-        };
-        static values(): Array<vonage.CallDisconnectReasonJS>;
-        static valueOf(value: string): vonage.CallDisconnectReasonJS;
-        get name(): "networkChange";
-        get ordinal(): 0;
-    }
-    abstract class HangupReasonJS {
-        private constructor();
-        static get REMOTE_HANGUP(): vonage.HangupReasonJS & {
-            get name(): "REMOTE_HANGUP";
-            get ordinal(): 0;
-        };
-        static get REMOTE_REJECT(): vonage.HangupReasonJS & {
-            get name(): "REMOTE_REJECT";
-            get ordinal(): 1;
-        };
-        static get REMOTE_NO_ANSWER_TIMEOUT(): vonage.HangupReasonJS & {
-            get name(): "REMOTE_NO_ANSWER_TIMEOUT";
-            get ordinal(): 2;
-        };
-        static get LOCAL_HANGUP(): vonage.HangupReasonJS & {
-            get name(): "LOCAL_HANGUP";
-            get ordinal(): 3;
-        };
-        static get MEDIA_TIMEOUT(): vonage.HangupReasonJS & {
-            get name(): "MEDIA_TIMEOUT";
-            get ordinal(): 4;
-        };
-        static values(): Array<vonage.HangupReasonJS>;
-        static valueOf(value: string): vonage.HangupReasonJS;
-        get name(): "REMOTE_HANGUP" | "REMOTE_REJECT" | "REMOTE_NO_ANSWER_TIMEOUT" | "LOCAL_HANGUP" | "MEDIA_TIMEOUT";
-        get ordinal(): 0 | 1 | 2 | 3 | 4;
-    }
+    const LegStatusJSObject: {
+        get RINGING(): string;
+        get ANSWERED(): string;
+        get COMPLETED(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
+    const CallDisconnectReasonJSObject: {
+        get NetworkChange(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
+    const HangupReasonJSObject: {
+        get REMOTE_HANGUP(): string;
+        get REMOTE_REJECT(): string;
+        get REMOTE_NO_ANSWER_TIMEOUT(): string;
+        get LOCAL_HANGUP(): string;
+        get MEDIA_TIMEOUT(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
     interface IVoiceClientJS extends vonage.ICoreClientJS {
         readonly media: vonage.MediaClientJS;
         readonly core: any/* com.vonage.clientcore.core.CoreClientWithMedia */;
@@ -1194,30 +1135,15 @@ export declare namespace vonage {
     const REASON_CLIENT_DISCONNECTED: string;
     const REASON_CLIENT_NETWORK_ERROR: string;
     const REASON_PING_TIMEOUT: string;
-    abstract class CancelReasonJS {
-        private constructor();
-        get reason(): string;
-        static get RemoteCancel(): vonage.CancelReasonJS & {
-            get name(): "RemoteCancel";
-            get ordinal(): 0;
-        };
-        static get AnsweredElsewhere(): vonage.CancelReasonJS & {
-            get name(): "AnsweredElsewhere";
-            get ordinal(): 1;
-        };
-        static get RejectedElsewhere(): vonage.CancelReasonJS & {
-            get name(): "RejectedElsewhere";
-            get ordinal(): 2;
-        };
-        static get RemoteTimeout(): vonage.CancelReasonJS & {
-            get name(): "RemoteTimeout";
-            get ordinal(): 3;
-        };
-        static values(): Array<vonage.CancelReasonJS>;
-        static valueOf(value: string): vonage.CancelReasonJS;
-        get name(): "RemoteCancel" | "AnsweredElsewhere" | "RejectedElsewhere" | "RemoteTimeout";
-        get ordinal(): 0 | 1 | 2 | 3;
-    }
+    const CancelReasonJSObject: {
+        get RemoteCancel(): string;
+        get AnsweredElsewhere(): string;
+        get RejectedElsewhere(): string;
+        get RemoteTimeout(): string;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
+    };
     class RTCQualityJS {
         private constructor();
         get mos_score(): number;

package/dist/utils/ClientConfig.d.ts

@@ -23,7 +23,6 @@ export declare const ConfigRegion: typeof vonage.CoreClientConfigRegionJS;
  * @property websocketPath The Path component appended to the Websocket URL
  * @property rtcStatsTelemetry Allow users to enable RTCStats
  * @property autoReconnectMedia Allow the sdk to automatically reconnect media when network interface changes
- * @interface
  *
  * @example
  * [[include:snippet_SetClientConfig.txt]]
@@ -46,7 +45,6 @@ export type ClientConfigObject = ConfigObjectJS | ({
  * @property websocketPath The Path component appended to the Websocket URL
  * @property rtcStatsTelemetry Allow users to enable RTCStats
  * @property autoReconnectMedia Allow the sdk to automatically reconnect media when network interface changes
- * @interface
  *
  * @example
  * [[include:snippet_Logging.txt]]

package/dist/utils/ConversationModels.d.ts

@@ -1,5 +1,5 @@
 import vonage from '../utils/vonage';
-import { ConversationState, MemberState, PersistentConversationEvent } from '../kotlin/JsUnions';
+import { ConversationChannelType, ConversationState, MemberState, PersistentConversationEvent } from '../kotlin/JsUnions';
 import { Leg } from '../client';
 /**
  * Represents a conversation
@@ -83,8 +83,9 @@ export type EventsPage = vonage.EventsPageJS & {
  * @property timestamp The member timestamp
  * @interface
  */
-export type Member = vonage.MemberJS & {
+export type Member = Omit<vonage.MemberJS, 'state' | 'channel'> & {
     state?: MemberState;
+    channel?: MemberChannel;
 };
 /**
  * Represents a {@link Member} timestamps
@@ -126,9 +127,23 @@ export type User = vonage.UserJS;
 export type UserTimestamp = vonage.UserTimestampJS;
 /**
  * The type of a {@link MemberChannel}
+ *
+ * @enum
  */
-export type ChannelType = vonage.ChannelTypeJS;
-export declare const ChannelType: typeof vonage.ChannelTypeJS;
+export declare const ChannelType: {
+    readonly APP: "APP";
+    readonly PHONE: "PHONE";
+    readonly PSTN: "PSTN";
+    readonly sip: "sip";
+    readonly VBC: "VBC";
+    readonly WEBSOCKET: "WEBSOCKET";
+    readonly SMS: "SMS";
+    readonly MMS: "MMS";
+    readonly WHATSAPP: "WHATSAPP";
+    readonly VIBER: "VIBER";
+    readonly MESSENGER: "MESSENGER";
+};
+export type ChannelType = ConversationChannelType;
 /**
  * Represents a Member Channel
  *
@@ -137,7 +152,9 @@ export declare const ChannelType: typeof vonage.ChannelTypeJS;
  * @property to The to {@link Channel}
  * @interface
  */
-export type MemberChannel = vonage.MemberChannelJS;
+export type MemberChannel = Omit<vonage.MemberChannelJS, 'type'> & {
+    type: ChannelType;
+};
 /**
  * Represents a Channel.
  * It will hold either an id or a number, depending on the Channel,

package/dist/utils/Enums.d.ts

@@ -0,0 +1,53 @@
+import { HangupReasonJS, LegStatusJS, CallDisconnectReasonJS, CancelReasonJS, VoiceChannelTypeJS } from '../kotlin/JsUnions';
+/**
+ * Hangup reasons for a call
+ * @enum
+ */
+export declare const HangupReason: {
+    readonly REMOTE_HANGUP: "REMOTE_HANGUP";
+    readonly REMOTE_REJECT: "REMOTE_REJECT";
+    readonly REMOTE_NO_ANSWER_TIMEOUT: "REMOTE_NO_ANSWER_TIMEOUT";
+    readonly LOCAL_HANGUP: "LOCAL_HANGUP";
+    readonly MEDIA_TIMEOUT: "MEDIA_TIMEOUT";
+};
+export type HangupReason = HangupReasonJS;
+/**
+ * Leg status for a call
+ * @enum
+ */
+export declare const LegStatus: {
+    readonly RINGING: "RINGING";
+    readonly ANSWERED: "ANSWERED";
+    readonly COMPLETED: "COMPLETED";
+};
+export type LegStatus = LegStatusJS;
+/**
+ * Call disconnect reasons
+ * @enum
+ */
+export declare const CallDisconnectReason: {
+    readonly networkChange: "networkChange";
+};
+export type CallDisconnectReason = CallDisconnectReasonJS;
+/**
+ * Call Invite cancel reasons
+ * @enum
+ */
+export declare const CancelReason: {
+    readonly RemoteCancel: "RemoteCancel";
+    readonly RejectedElsewhere: "RejectedElsewhere";
+    readonly RemoteTimeout: "RemoteTimeout";
+    readonly AnsweredElsewhere: "AnsweredElsewhere";
+};
+export type CancelReason = CancelReasonJS;
+/**
+ * Voice Channel Types
+ * @enum
+ */
+export declare const VoiceChannelType: {
+    readonly app: "app";
+    readonly phone: "phone";
+    readonly sip: "sip";
+    readonly websocket: "websocket";
+};
+export type VoiceChannelType = VoiceChannelTypeJS;

package/dist/utils/index.d.ts

@@ -2,8 +2,9 @@ export { ClientConfig, ClientInitConfig, ClientConfigObject, ClientInitConfigObj
 export { type Topic, type VonageLogger, LoggingLevel, Topics, createVonageLogger, setDefaultLoggingLevel, setVonageClientLoggingLevel } from './logging';
 export * from './JsonUtils';
 export * from './ConversationModels';
-export * from '../kotlin/JsUnions';
 export * from './ErrorModels';
 export * from './RequestParameterModels';
 export * from './Option';
 export * from './ConversationEventBodies';
+export * from './Enums';
+export { ConversationEvent, EphemeralConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnions';

package/dist/utils/logging.d.ts

@@ -16,9 +16,18 @@ export type LoggingLevelName = typeof vonage.LoggingLevelJS.prototype.name;
  *
  * It can be set for the internal logger via {@link ClientInitConfigObject.loggingLevel}
  * as well as for a custom logger via {@link VonageLogger.minLogLevel}.
+ *
+ * @enum
  */
+export declare const LoggingLevel: {
+    readonly Verbose: "Verbose";
+    readonly Debug: "Debug";
+    readonly Info: "Info";
+    readonly Warn: "Warn";
+    readonly Error: "Error";
+    readonly Assert: "Assert";
+};
 export type LoggingLevel = vonage.LoggingLevelJS | LoggingLevelName;
-export declare const LoggingLevel: typeof vonage.LoggingLevelJS;
 /**
  * @deprecated Use {@link ClientInitConfigObject.loggingLevel} instead.
  * @param level - The logging level to set.
@@ -36,7 +45,6 @@ export declare const setVonageClientLoggingLevel: (level: LoggingLevel) => void;
  * @property minLogLevel The minimum log level of the logger.
  * @property topics The topics that the logger is subscribed to.
  * @property onLog The callback to be invoked when a log is emitted.
- * @interface
  *
  * @example
  * [[include: snippet_Logging.txt]]