@vonage/client-sdk 1.3.0-rc.1 → 1.3.0-rc.2

package/dist/kotlin/JsUnions.d.ts

@@ -2,9 +2,9 @@ import { vonage } from './clientsdk-clientcore_js';
 /**
  * The EmbeddedInfo type
  *
- * @property kind the kind property of the EmbeddedInfo
- * @property memberId the memberId property of the EmbeddedInfo
- * @property user the user property of the EmbeddedInfo
+ * @property kind The kind property of EmbeddedInfo
+ * @property memberId The memberId property of EmbeddedInfo
+ * @property user The user property of EmbeddedInfo
  * @interface
  */
 export type EmbeddedInfo = {
@@ -13,47 +13,55 @@ export type EmbeddedInfo = {
 /**
  * The System type
  *
- * @property KIND the KIND property of the System
+ * @property kind The kind property of System
  * @interface
  */
 export type System = {
     kind: 'system';
 } & typeof vonage.SystemJS;
 /**
- * A From is a union of EmbeddedInfo, System
- * @interface
+ * A From is a discriminated union of {@link EmbeddedInfo}, {@link System}
  */
 export type From = EmbeddedInfo | System;
 /**
  * The EphemeralConversationEvent type
  *
- * @property kind the kind property of the EphemeralConversationEvent
- * @property timestamp the timestamp property of the EphemeralConversationEvent
- * @property conversationId the conversationId property of the EphemeralConversationEvent
- * @property from the from property of the EphemeralConversationEvent
- * @property body the body property of the EphemeralConversationEvent
+ * @property kind The kind property of EphemeralConversationEvent
+ * @property timestamp The timestamp property of EphemeralConversationEvent
+ * @property conversationId The conversationId property of EphemeralConversationEvent
+ * @property from The {@link From} property of EphemeralConversationEvent
+ * @property body The body property of EphemeralConversationEvent
  * @interface
+ * @group Chat
  */
 export type EphemeralConversationEvent = {
     kind: 'ephemeral';
     from: From;
 } & vonage.EphemeralConversationEventJS;
 /**
- * A NonPersistentConversationEvent is a union of EphemeralConversationEvent
- * @interface
+ * A NonPersistentConversationEvent is a {@link EphemeralConversationEvent}
+ * @group Chat
  */
 export type NonPersistentConversationEvent = EphemeralConversationEvent;
+import { MessageAudioEventBody } from '../utils/ConversationEventBodies';
+import { MessageFileEventBody } from '../utils/ConversationEventBodies';
+import { MessageImageEventBody } from '../utils/ConversationEventBodies';
+import { MessageLocationEventBody } from '../utils/ConversationEventBodies';
+import { MessageTemplateEventBody } from '../utils/ConversationEventBodies';
+import { MessageVCardEventBody } from '../utils/ConversationEventBodies';
+import { MessageVideoEventBody } from '../utils/ConversationEventBodies';
 /**
  * The CustomConversationEvent type
  *
- * @property kind the kind property of the CustomConversationEvent
- * @property id the id property of the CustomConversationEvent
- * @property timestamp the timestamp property of the CustomConversationEvent
- * @property conversationId the conversationId property of the CustomConversationEvent
- * @property from the from property of the CustomConversationEvent
- * @property eventType the eventType property of the CustomConversationEvent
- * @property body the body property of the CustomConversationEvent
+ * @property kind The kind property of CustomConversationEvent
+ * @property id The id property of CustomConversationEvent
+ * @property timestamp The timestamp property of CustomConversationEvent
+ * @property conversationId The conversationId property of CustomConversationEvent
+ * @property from The {@link From} property of CustomConversationEvent
+ * @property eventType The eventType property of CustomConversationEvent
+ * @property body The body property of CustomConversationEvent
  * @interface
+ * @group Chat
  */
 export type CustomConversationEvent = {
     kind: 'custom';
@@ -62,13 +70,14 @@ export type CustomConversationEvent = {
 /**
  * The EventDeleteConversationEvent type
  *
- * @property kind the kind property of the EventDeleteConversationEvent
- * @property id the id property of the EventDeleteConversationEvent
- * @property timestamp the timestamp property of the EventDeleteConversationEvent
- * @property conversationId the conversationId property of the EventDeleteConversationEvent
- * @property from the from property of the EventDeleteConversationEvent
- * @property body the body property of the EventDeleteConversationEvent
+ * @property kind The kind property of EventDeleteConversationEvent
+ * @property id The id property of EventDeleteConversationEvent
+ * @property timestamp The timestamp property of EventDeleteConversationEvent
+ * @property conversationId The conversationId property of EventDeleteConversationEvent
+ * @property from The {@link From} property of EventDeleteConversationEvent
+ * @property body The body property of EventDeleteConversationEvent
  * @interface
+ * @group Chat
  */
 export type EventDeleteConversationEvent = {
     kind: 'event:delete';
@@ -77,13 +86,14 @@ export type EventDeleteConversationEvent = {
 /**
  * The MemberInvitedEvent type
  *
- * @property kind the kind property of the MemberInvitedEvent
+ * @property kind The kind property of MemberInvitedEvent
  * @property id The event id
  * @property timestamp The event timestamp
  * @property conversationId The conversation id
  * @property from The event sender
  * @property body The invited member
  * @interface
+ * @group Chat
  */
 export type MemberInvitedEvent = {
     kind: 'member:invited';
@@ -92,13 +102,14 @@ export type MemberInvitedEvent = {
 /**
  * The MemberJoinedEvent type
  *
- * @property kind the kind property of the MemberJoinedEvent
- * @property id the id property of the MemberJoinedEvent
- * @property timestamp the timestamp property of the MemberJoinedEvent
- * @property conversationId the conversationId property of the MemberJoinedEvent
- * @property from the from property of the MemberJoinedEvent
- * @property body the body property of the MemberJoinedEvent
+ * @property kind The kind property of MemberJoinedEvent
+ * @property id The id property of MemberJoinedEvent
+ * @property timestamp The timestamp property of MemberJoinedEvent
+ * @property conversationId The conversationId property of MemberJoinedEvent
+ * @property from The {@link From} property of MemberJoinedEvent
+ * @property body The body property of MemberJoinedEvent
  * @interface
+ * @group Chat
  */
 export type MemberJoinedEvent = {
     kind: 'member:joined';
@@ -107,13 +118,14 @@ export type MemberJoinedEvent = {
 /**
  * The MemberLeftEvent type
  *
- * @property kind the kind property of the MemberLeftEvent
- * @property id the id property of the MemberLeftEvent
- * @property timestamp the timestamp property of the MemberLeftEvent
- * @property conversationId the conversationId property of the MemberLeftEvent
- * @property from the from property of the MemberLeftEvent
- * @property body the body property of the MemberLeftEvent
+ * @property kind The kind property of MemberLeftEvent
+ * @property id The id property of MemberLeftEvent
+ * @property timestamp The timestamp property of MemberLeftEvent
+ * @property conversationId The conversationId property of MemberLeftEvent
+ * @property from The {@link From} property of MemberLeftEvent
+ * @property body The body property of MemberLeftEvent
  * @interface
+ * @group Chat
  */
 export type MemberLeftEvent = {
     kind: 'member:left';
@@ -122,28 +134,31 @@ export type MemberLeftEvent = {
 /**
  * The MessageAudioEvent type
  *
- * @property kind the kind property of the MessageAudioEvent
- * @property id the id property of the MessageAudioEvent
- * @property timestamp the timestamp property of the MessageAudioEvent
- * @property conversationId the conversationId property of the MessageAudioEvent
- * @property from the from property of the MessageAudioEvent
- * @property body the body property of the MessageAudioEvent
+ * @property kind The kind property of MessageAudioEvent
+ * @property id The id property of MessageAudioEvent
+ * @property timestamp The timestamp property of MessageAudioEvent
+ * @property conversationId The conversationId property of MessageAudioEvent
+ * @property from The {@link From} property of MessageAudioEvent
+ * @property body The body property of MessageAudioEvent
  * @interface
+ * @group Chat
  */
 export type MessageAudioEvent = {
     kind: 'message:audio';
     from: From;
+    body: MessageAudioEventBody;
 } & vonage.MessageAudioEventJS;
 /**
  * The MessageCustomEvent type
  *
- * @property kind the kind property of the MessageCustomEvent
- * @property id the id property of the MessageCustomEvent
- * @property timestamp the timestamp property of the MessageCustomEvent
- * @property conversationId the conversationId property of the MessageCustomEvent
- * @property from the from property of the MessageCustomEvent
- * @property body the body property of the MessageCustomEvent
+ * @property kind The kind property of MessageCustomEvent
+ * @property id The id property of MessageCustomEvent
+ * @property timestamp The timestamp property of MessageCustomEvent
+ * @property conversationId The conversationId property of MessageCustomEvent
+ * @property from The {@link From} property of MessageCustomEvent
+ * @property body The body property of MessageCustomEvent
  * @interface
+ * @group Chat
  */
 export type MessageCustomEvent = {
     kind: 'message:custom';
@@ -152,73 +167,82 @@ export type MessageCustomEvent = {
 /**
  * The MessageFileEvent type
  *
- * @property kind the kind property of the MessageFileEvent
- * @property id the id property of the MessageFileEvent
- * @property timestamp the timestamp property of the MessageFileEvent
- * @property conversationId the conversationId property of the MessageFileEvent
- * @property from the from property of the MessageFileEvent
- * @property body the body property of the MessageFileEvent
+ * @property kind The kind property of MessageFileEvent
+ * @property id The id property of MessageFileEvent
+ * @property timestamp The timestamp property of MessageFileEvent
+ * @property conversationId The conversationId property of MessageFileEvent
+ * @property from The {@link From} property of MessageFileEvent
+ * @property body The body property of MessageFileEvent
  * @interface
+ * @group Chat
  */
 export type MessageFileEvent = {
     kind: 'message:file';
     from: From;
+    body: MessageFileEventBody;
 } & vonage.MessageFileEventJS;
 /**
  * The MessageImageEvent type
  *
- * @property kind the kind property of the MessageImageEvent
- * @property id the id property of the MessageImageEvent
- * @property timestamp the timestamp property of the MessageImageEvent
- * @property conversationId the conversationId property of the MessageImageEvent
- * @property from the from property of the MessageImageEvent
- * @property body the body property of the MessageImageEvent
+ * @property kind The kind property of MessageImageEvent
+ * @property id The id property of MessageImageEvent
+ * @property timestamp The timestamp property of MessageImageEvent
+ * @property conversationId The conversationId property of MessageImageEvent
+ * @property from The {@link From} property of MessageImageEvent
+ * @property body The body property of MessageImageEvent
  * @interface
+ * @group Chat
  */
 export type MessageImageEvent = {
     kind: 'message:image';
     from: From;
+    body: MessageImageEventBody;
 } & vonage.MessageImageEventJS;
 /**
  * The MessageLocationEvent type
  *
- * @property kind the kind property of the MessageLocationEvent
- * @property id the id property of the MessageLocationEvent
- * @property timestamp the timestamp property of the MessageLocationEvent
- * @property conversationId the conversationId property of the MessageLocationEvent
- * @property from the from property of the MessageLocationEvent
- * @property body the body property of the MessageLocationEvent
+ * @property kind The kind property of MessageLocationEvent
+ * @property id The id property of MessageLocationEvent
+ * @property timestamp The timestamp property of MessageLocationEvent
+ * @property conversationId The conversationId property of MessageLocationEvent
+ * @property from The {@link From} property of MessageLocationEvent
+ * @property body The body property of MessageLocationEvent
  * @interface
+ * @group Chat
  */
 export type MessageLocationEvent = {
     kind: 'message:location';
     from: From;
+    body: MessageLocationEventBody;
 } & vonage.MessageLocationEventJS;
 /**
  * The MessageTemplateEvent type
  *
- * @property kind the kind property of the MessageTemplateEvent
- * @property id the id property of the MessageTemplateEvent
- * @property timestamp the timestamp property of the MessageTemplateEvent
- * @property conversationId the conversationId property of the MessageTemplateEvent
- * @property from the from property of the MessageTemplateEvent
- * @property body the body property of the MessageTemplateEvent
+ * @property kind The kind property of MessageTemplateEvent
+ * @property id The id property of MessageTemplateEvent
+ * @property timestamp The timestamp property of MessageTemplateEvent
+ * @property conversationId The conversationId property of MessageTemplateEvent
+ * @property from The {@link From} property of MessageTemplateEvent
+ * @property body The body property of MessageTemplateEvent
  * @interface
+ * @group Chat
  */
 export type MessageTemplateEvent = {
     kind: 'message:template';
     from: From;
+    body: MessageTemplateEventBody;
 } & vonage.MessageTemplateEventJS;
 /**
  * The MessageTextEvent type
  *
- * @property kind the kind property of the MessageTextEvent
- * @property id the id property of the MessageTextEvent
- * @property timestamp the timestamp property of the MessageTextEvent
- * @property conversationId the conversationId property of the MessageTextEvent
- * @property from the from property of the MessageTextEvent
- * @property body the body property of the MessageTextEvent
+ * @property kind The kind property of MessageTextEvent
+ * @property id The id property of MessageTextEvent
+ * @property timestamp The timestamp property of MessageTextEvent
+ * @property conversationId The conversationId property of MessageTextEvent
+ * @property from The {@link From} property of MessageTextEvent
+ * @property body The body property of MessageTextEvent
  * @interface
+ * @group Chat
  */
 export type MessageTextEvent = {
     kind: 'message:text';
@@ -227,50 +251,52 @@ export type MessageTextEvent = {
 /**
  * The MessageVCardEvent type
  *
- * @property kind the kind property of the MessageVCardEvent
- * @property id the id property of the MessageVCardEvent
- * @property timestamp the timestamp property of the MessageVCardEvent
- * @property conversationId the conversationId property of the MessageVCardEvent
- * @property from the from property of the MessageVCardEvent
- * @property body the body property of the MessageVCardEvent
+ * @property kind The kind property of MessageVCardEvent
+ * @property id The id property of MessageVCardEvent
+ * @property timestamp The timestamp property of MessageVCardEvent
+ * @property conversationId The conversationId property of MessageVCardEvent
+ * @property from The {@link From} property of MessageVCardEvent
+ * @property body The body property of MessageVCardEvent
  * @interface
+ * @group Chat
  */
 export type MessageVCardEvent = {
     kind: 'message:vcard';
     from: From;
+    body: MessageVCardEventBody;
 } & vonage.MessageVCardEventJS;
 /**
  * The MessageVideoEvent type
  *
- * @property kind the kind property of the MessageVideoEvent
- * @property id the id property of the MessageVideoEvent
- * @property timestamp the timestamp property of the MessageVideoEvent
- * @property conversationId the conversationId property of the MessageVideoEvent
- * @property from the from property of the MessageVideoEvent
- * @property body the body property of the MessageVideoEvent
+ * @property kind The kind property of MessageVideoEvent
+ * @property id The id property of MessageVideoEvent
+ * @property timestamp The timestamp property of MessageVideoEvent
+ * @property conversationId The conversationId property of MessageVideoEvent
+ * @property from The {@link From} property of MessageVideoEvent
+ * @property body The body property of MessageVideoEvent
  * @interface
+ * @group Chat
  */
 export type MessageVideoEvent = {
     kind: 'message:video';
     from: From;
+    body: MessageVideoEventBody;
 } & vonage.MessageVideoEventJS;
 /**
- * A PersistentConversationEvent is a union of CustomConversationEvent, EventDeleteConversationEvent, MemberInvitedEvent, MemberJoinedEvent, MemberLeftEvent, MessageAudioEvent, MessageCustomEvent, MessageFileEvent, MessageImageEvent, MessageLocationEvent, MessageTemplateEvent, MessageTextEvent, MessageVCardEvent, MessageVideoEvent
- * @interface
+ * A PersistentConversationEvent is a discriminated union of {@link CustomConversationEvent}, {@link EventDeleteConversationEvent}, {@link MemberInvitedEvent}, {@link MemberJoinedEvent}, {@link MemberLeftEvent}, {@link MessageAudioEvent}, {@link MessageCustomEvent}, {@link MessageFileEvent}, {@link MessageImageEvent}, {@link MessageLocationEvent}, {@link MessageTemplateEvent}, {@link MessageTextEvent}, {@link MessageVCardEvent}, {@link MessageVideoEvent}
+ * @group Chat
  */
 export type PersistentConversationEvent = CustomConversationEvent | EventDeleteConversationEvent | MemberInvitedEvent | MemberJoinedEvent | MemberLeftEvent | MessageAudioEvent | MessageCustomEvent | MessageFileEvent | MessageImageEvent | MessageLocationEvent | MessageTemplateEvent | MessageTextEvent | MessageVCardEvent | MessageVideoEvent;
 /**
- * A ConversationEvent is a union of NonPersistentConversationEventJS, PersistentConversationEventJS
- * @interface
+ * A ConversationEvent is a union of {@link NonPersistentConversationEvent}, {@link PersistentConversationEvent}
+ * @group Chat
  */
 export type ConversationEvent = NonPersistentConversationEvent | PersistentConversationEvent;
 /**
- * A ConversationState is a union of  'ACTIVE', 'INACTIVE', 'DELETED'
- * @interface
+ * A ConversationState is a union of 'ACTIVE', 'INACTIVE', 'DELETED'
  */
 export type ConversationState = 'ACTIVE' | 'INACTIVE' | 'DELETED';
 /**
- * A MemberState is a union of  'INVITED', 'JOINED', 'LEFT', 'UNKNOWN'
- * @interface
+ * A MemberState is a union of 'INVITED', 'JOINED', 'LEFT', 'UNKNOWN'
  */
 export type MemberState = 'INVITED' | 'JOINED' | 'LEFT' | 'UNKNOWN';

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

@@ -91,26 +91,12 @@ export declare namespace vonage {
         equals(other: Nullable<any>): boolean;
     } & vonage.FromJS;
     interface ConversationEventJS {
-        readonly kind: string;
-        readonly timestamp: string;
-        readonly conversationId: string;
-        readonly from: vonage.FromJS;
     }
     interface NonPersistentConversationEventJS extends vonage.ConversationEventJS {
-        readonly kind: string;
-        readonly timestamp: string;
-        readonly conversationId: string;
-        readonly from: vonage.FromJS;
     }
     interface PersistentConversationEventJS extends vonage.ConversationEventJS {
-        readonly id: number;
-        readonly kind: string;
-        readonly timestamp: string;
-        readonly conversationId: string;
-        readonly from: vonage.FromJS;
     }
     interface MemberEventJS {
-        readonly body: vonage.MemberEventBodyJS;
     }
     class MemberEventBodyJS {
         private constructor();
@@ -145,7 +131,6 @@ export declare namespace vonage {
         get body(): vonage.MemberEventBodyJS;
     }
     interface JSONBodyEventJS {
-        readonly body: string;
     }
     class CustomConversationEventJS implements vonage.PersistentConversationEventJS, vonage.JSONBodyEventJS {
         private constructor();
@@ -193,10 +178,8 @@ export declare namespace vonage {
 }
 export declare namespace vonage {
     interface MessageEventJS {
-        readonly body: vonage.MessageEventBodyJS;
     }
     interface MessageEventBodyJS {
-        readonly deleted: Nullable<string>;
     }
     class MessageTextEventJS implements vonage.MessageEventJS, vonage.PersistentConversationEventJS {
         private constructor();
@@ -205,10 +188,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageTextEventJS.Body;
+        get body(): vonage.MessageTextEventJS.MessageTextEventBody;
     }
     namespace MessageTextEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageTextEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get text(): string;
             get deleted(): Nullable<string>;
@@ -221,10 +204,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageCustomEventJS.Body;
+        get body(): vonage.MessageCustomEventJS.MessageCustomEventBody;
     }
     namespace MessageCustomEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageCustomEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get customData(): string;
             get deleted(): Nullable<string>;
@@ -237,10 +220,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageAudioEventJS.Body;
+        get body(): vonage.MessageAudioEventJS.MessageAudioEventBody;
     }
     namespace MessageAudioEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageAudioEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get audioUrl(): string;
             get deleted(): Nullable<string>;
@@ -253,10 +236,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageVideoEventJS.Body;
+        get body(): vonage.MessageVideoEventJS.MessageVideoEventBody;
     }
     namespace MessageVideoEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageVideoEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get videoUrl(): string;
             get deleted(): Nullable<string>;
@@ -269,10 +252,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageImageEventJS.Body;
+        get body(): vonage.MessageImageEventJS.MessageImageEventBody;
     }
     namespace MessageImageEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageImageEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get imageUrl(): string;
             get deleted(): Nullable<string>;
@@ -285,10 +268,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageFileEventJS.Body;
+        get body(): vonage.MessageFileEventJS.MessageFileEventBody;
     }
     namespace MessageFileEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageFileEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get fileUrl(): string;
             get deleted(): Nullable<string>;
@@ -301,10 +284,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageVCardEventJS.Body;
+        get body(): vonage.MessageVCardEventJS.MessageVCardEventBody;
     }
     namespace MessageVCardEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageVCardEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get vcardUrl(): string;
             get deleted(): Nullable<string>;
@@ -317,10 +300,10 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageLocationEventJS.Body;
+        get body(): vonage.MessageLocationEventJS.MessageLocationEventBody;
     }
     namespace MessageLocationEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageLocationEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get location(): vonage.MessageLocationEventJS.Location;
             get deleted(): Nullable<string>;
@@ -340,16 +323,16 @@ export declare namespace vonage {
         get timestamp(): string;
         get conversationId(): string;
         get from(): vonage.FromJS;
-        get body(): vonage.MessageTemplateEventJS.Body;
+        get body(): vonage.MessageTemplateEventJS.MessageTemplateEventBody;
     }
     namespace MessageTemplateEventJS {
-        class Body implements vonage.MessageEventBodyJS {
+        class MessageTemplateEventBody implements vonage.MessageEventBodyJS {
             private constructor();
             get body(): any/* com.vonage.clientcore.core.api.models.MessageTemplateEvent.Body */;
             get template(): vonage.MessageTemplateEventJS.TemplateObject;
             get whatsapp(): vonage.MessageTemplateEventJS.WhatsappObject;
             get deleted(): Nullable<string>;
-            copy(body?: any/* com.vonage.clientcore.core.api.models.MessageTemplateEvent.Body */): vonage.MessageTemplateEventJS.Body;
+            copy(body?: any/* com.vonage.clientcore.core.api.models.MessageTemplateEvent.Body */): vonage.MessageTemplateEventJS.MessageTemplateEventBody;
             toString(): string;
             hashCode(): number;
             equals(other: Nullable<any>): boolean;

package/dist/utils/ClientConfig.d.ts

@@ -1,11 +1,56 @@
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import vonage from '../utils/vonage';
 import { LoggingLevel, VonageLogger, VonageLoggerJS } from './logging';
+/**
+ * The datacenter region for the Client.
+ *
+ * It can be set either via {@link ClientInitConfigObject} or {@link ClientConfigObject}.
+ */
 export type ConfigRegion = vonage.CoreClientConfigRegionJS | typeof vonage.CoreClientConfigRegionJS.prototype.name;
 export declare const ConfigRegion: typeof vonage.CoreClientConfigRegionJS;
+/**
+ * An convenience union for {@link ConfigObjectJS} allowing to pass strings for enum properties.
+ */
+/**
+ * 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.
+ *
+ * @property region The Vonage datacenter to use
+ * @property apiUrl The API URL of your chosen datacenter, if set overrides default from region
+ * @property websocketUrl The WebSocket URL of your chosen datacenter, if set overrides default from region
+ * @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]]
+ */
 export type ClientConfigObject = ConfigObjectJS | ({
     region?: ConfigRegion;
 } & Omit<ConfigObjectJS, 'region'>);
+/**
+ * Represents the configuration object used to initialize the client.
+ *
+ * The `ClientInitConfig` class provides a convenient way to configure the client by specifying various properties.
+ * These properties include all the ones in {@link ClientConfigObject} plus {@link loggingLevel}, {@link customLoggers} and {@link disableInternalLogger}.
+ *
+ * @property loggingLevel The Logging Level to use
+ * @property customLoggers A List of custom loggers
+ * @property disableInternalLogger Whether to enable the SDK internal logger
+ * @property region The Vonage datacenter to use
+ * @property apiUrl The API URL of your chosen datacenter, if set overrides default from region
+ * @property websocketUrl The WebSocket URL of your chosen datacenter, if set overrides default from region
+ * @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]]
+ */
 export type ClientInitConfigObject = InitConfigObjectJS | ({
     region?: ConfigRegion;
     loggingLevel?: LoggingLevel;
@@ -24,15 +69,6 @@ export interface InitConfigObjectJS extends ConfigObjectJS {
     customLoggers?: Nullable<VonageLoggerJS[]>;
     disableInternalLogger?: Nullable<boolean>;
 }
-/**
- * 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:snippet_setClientConfig.txt]]
- */
 export declare class ClientConfig extends vonage.CoreClientConfigJS {
     /**
      * Constructs a new instance of the class.