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

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;
@@ -16,23 +61,14 @@ export interface ConfigObjectJS {
     apiUrl?: Nullable<string>;
     websocketUrl?: Nullable<string>;
     websocketPath?: Nullable<string>;
-    autoMediaReoffer?: Nullable<boolean>;
     rtcStatsTelemetry?: Nullable<boolean>;
+    autoReconnectMedia?: Nullable<boolean>;
 }
 export interface InitConfigObjectJS extends ConfigObjectJS {
     loggingLevel?: Nullable<vonage.LoggingLevelJS>;
     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.
@@ -52,7 +88,8 @@ export declare class ClientInitConfig implements InitConfigObjectJS {
     apiUrl?: Nullable<string>;
     websocketUrl?: Nullable<string>;
     websocketPath?: Nullable<string>;
-    autoMediaReoffer?: Nullable<boolean>;
+    rtcStatsTelemetry?: Nullable<boolean>;
+    autoReconnectMedia?: Nullable<boolean>;
     /**
      * Constructs a new instance of the class.
      */

package/dist/utils/ConversationEventBodies.d.ts

@@ -0,0 +1,134 @@
+import vonage from '../utils/vonage';
+/**
+ * The {@link MessageAudioEvent} Body type
+ *
+ * @beta
+ * @property audio The audio URL
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageAudioEventBody = vonage.MessageAudioEventJS.MessageAudioEventBody;
+/**
+ * The {@link MessageCustomEvent} Body type
+ *
+ * @beta
+ * @property custom The message custom data
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageCustomEventBody = vonage.MessageCustomEventJS.MessageCustomEventBody;
+/**
+ * The {@link MessageFileEvent} Body type
+ *
+ * @beta
+ * @property fileUrl The file URL
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageFileEventBody = vonage.MessageFileEventJS.MessageFileEventBody;
+/**
+ * The {@link MessageImageEvent} Body type
+ *
+ * @beta
+ * @property imageUrl The image URL
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageImageEventBody = vonage.MessageImageEventJS.MessageImageEventBody;
+/**
+ * The {@link MessageLocationEvent} Body type
+ *
+ * @beta
+ * @property location The {@link Location} object
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageLocationEventBody = vonage.MessageLocationEventJS.MessageLocationEventBody;
+/**
+ * The {@link MessageTemplateEvent} Body type
+ *
+ * @beta
+ * @property template The {@link Template} object
+ * @property whatsapp The {@link Whatsapp} object
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageTemplateEventBody = vonage.MessageTemplateEventJS.MessageTemplateEventBody;
+/**
+ * The {@link MessageVCardEvent} Body type
+ *
+ * @beta
+ * @property vcardUrl The VCard URL
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageVCardEventBody = vonage.MessageVCardEventJS.MessageVCardEventBody;
+/**
+ * The {@link MessageVideoEvent} Body type
+ *
+ * @beta
+ * @property videoUrl The Video URL
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageVideoEventBody = vonage.MessageVideoEventJS.MessageVideoEventBody;
+/**
+ * The {@link MessageTextEvent} Body type
+ *
+ * @beta
+ * @property text The message text
+ * @property deleted The message deletion timestamp
+ * @interface
+ * @group Chat
+ */
+export type MessageTextEventBody = vonage.MessageTextEventJS.MessageTextEventBody;
+/**
+ * The {@link MemberInvitedEvent}, {@link MemberJoinedEvent} and {@link MemberLeftEvent} Body type
+ *
+ * @beta
+ * @property memberId The member id
+ * @property user The {@link User} associated to the member
+ * @interface
+ * @group Chat
+ */
+export type MemberEventBody = vonage.MemberEventBodyJS;
+/**
+ * The Location object for a {@link MessageLocationEventBody}
+ *
+ * @beta
+ * @group Chat
+ */
+export interface Location {
+    name?: string | null;
+    address?: string | null;
+    latitude: string;
+    longitude: string;
+}
+/**
+ * The Template object for a {@link MessageTemplateEventBody}
+ *
+ * @beta
+ * @group Chat
+ */
+export interface Template {
+    name: string;
+    parameters?: string[] | null;
+}
+/**
+ * The Whatsapp object for a {@link MessageTemplateEventBody}
+ *
+ * @beta
+ * @group Chat
+ */
+export interface Whatsapp {
+    policy: string;
+    locale: string;
+}

package/dist/utils/ConversationModels.d.ts

@@ -1,39 +1,154 @@
 import vonage from '../utils/vonage';
 import { ConversationState, MemberState, PersistentConversationEvent } from '../kotlin/JsUnions';
+/**
+ * Represents a conversation
+ *
+ * @property id The conversation id
+ * @property name The conversation name
+ * @property timestamp The conversation timestamp
+ * @property memberId The user member id in the conversation
+ * @property memberState The user member state in the conversation
+ * @property displayName The conversation display name
+ * @property imageUrl The conversation image url
+ * @property state The conversation state
+ * @property properties The conversation properties
+ * @interface
+ */
 export type Conversation = vonage.ConversationJS & {
     memberState?: MemberState;
     state?: ConversationState;
 };
+/**
+ * Represents a {@link Conversation} timestamps
+ *
+ * @interface
+ */
+export type ConversationTimestamp = vonage.ConversationTimestampJS;
+/**
+ * Represents the properties for a {@link Conversation}
+ *
+ * @property ttl The time-to-live (TTL) for the conversation in seconds.
+ * @property customSortKey A string according to which Conversations will be ordered
+ * @property customData The Conversation custom data
+ * @interface
+ */
+export type ConversationProperties = vonage.ConversationJS.Properties;
+/**
+ * Represents a page of conversations
+ *
+ * @beta
+ * @property conversations The conversations in the page
+ * @property previousCursor The cursor to fetch the previous page
+ * @property nextCursor The cursor to fetch the next page
+ * @interface
+ * @group Chat
+ */
 export type ConversationsPage = vonage.ConversationsPageJS & {
     conversations: Conversation[];
 };
+/**
+ * Represents a page of conversation events
+ *
+ * @beta
+ * @property events The events in the page
+ * @property previousCursor The cursor to fetch the previous page
+ * @property nextCursor The cursor to fetch the next page
+ * @interface
+ * @group Chat
+ */
 export type EventsPage = vonage.EventsPageJS & {
     events: PersistentConversationEvent[];
 };
+/**
+ * Represents the membership of a user in a conversation
+ *
+ * @property id The member id
+ * @property state The member state
+ * @property user The user associated to the member
+ * @property channel The member channel
+ * @property timestamp The member timestamp
+ * @interface
+ */
 export type Member = vonage.MemberJS & {
     state?: MemberState;
 };
+/**
+ * Represents a {@link Member} timestamps
+ *
+ * @interface
+ */
+export type MemberTimestamp = vonage.MemberTimestampJS;
+/**
+ * Represents a page of conversation members
+ *
+ * @beta
+ * @property members The members in the page
+ * @property previousCursor The cursor to fetch the previous page
+ * @property nextCursor The cursor to fetch the next page
+ * @interface
+ * @group Chat
+ */
 export type MembersPage = vonage.MembersPageJS & {
     members: Member[];
 };
+/**
+ * Represents an SDK user
+ *
+ * @property id The user id
+ * @property name The user name
+ * @property displayName The user display name
+ * @property channels The user channels
+ * @property timestamp The user timestamp
+ * @property imageUrl The user image url
+ * @property customData The user custom data
+ * @interface
+ */
 export type User = vonage.UserJS;
+/**
+ * Represents an {@link User} timestamps
+ *
+ * @interface
+ */
+export type UserTimestamp = vonage.UserTimestampJS;
+/**
+ * The type of a {@link MemberChannel}
+ */
 export type ChannelType = vonage.ChannelTypeJS;
 export declare const ChannelType: typeof vonage.ChannelTypeJS;
-export type PresentingOrder = vonage.PresentingOrderJS;
-export declare const PresentingOrder: typeof vonage.PresentingOrderJS;
-export type OrderBy = vonage.OrderByJS;
-export declare const OrderBy: typeof vonage.OrderByJS;
-export interface Location {
-    name?: string | null;
-    address?: string | null;
-    latitude: string;
-    longitude: string;
-}
-export interface Template {
-    name: string;
-    parameters?: string[] | null;
-}
-export interface Whatsapp {
-    policy: string;
-    locale: string;
-}
+/**
+ * Represents a Member Channel
+ *
+ * @property type The {@link ChannelType}
+ * @property from The from {@link Channel}
+ * @property to The to {@link Channel}
+ * @interface
+ */
+export type MemberChannel = vonage.MemberChannelJS;
+/**
+ * Represents a Channel.
+ * It will hold either an id or a number, depending on the Channel,
+ * but never both of them.
+ *
+ * @property id The Channel id
+ * @property number The Channel number
+ * @interface
+ */
+export type Channel = vonage.ChannelJS;
+/**
+ * Represents all the Channels of a certain {@link User}.
+ * For each type of Channel, it will hold an array of {@link Channel}
+ *
+ * @property app
+ * @property phone
+ * @property pstn
+ * @property sip
+ * @property vbc
+ * @property websocket
+ * @property sms
+ * @property mms
+ * @property whatsapp
+ * @property viber
+ * @property messenger
+ * @interface
+ */
+export type UserChannels = vonage.UserChannelsJS;

package/dist/utils/JsonUtils.d.ts

@@ -1,4 +1,10 @@
+/**
+ * A valid Json property value
+ */
 export type JsonValue = object | null | boolean | string | number;
+/**
+ * A Json Object or an array of Json object
+ */
 export type Json = {
     [property: string]: Json | JsonValue;
 } | Json[];

package/dist/utils/Option.d.ts

@@ -1,6 +1,20 @@
 import vonage from './vonage';
+/**
+ * Represents an Either monad for optional properties.
+ *
+ * @beta
+ * It can be also set via the helper functions {@link some} and {@link none}.
+ */
 export type Option<T> = vonage.utils.OptionJS<T>;
 export declare const Option: typeof vonage.utils.OptionJS;
 export declare const mapOption: <T>(value?: T | undefined) => Option<T | null>;
+/**
+ * @param value The wrapped value
+ * @returns An {@link Option.Some}
+ */
 export declare const some: <T>(value: T) => Option<T>;
+/**
+ *
+ * @returns An {@link Option.None}
+ */
 export declare const none: <T>() => Option<T>;

package/dist/utils/RequestParameterModels.d.ts

@@ -2,20 +2,86 @@ import vonage from './vonage';
 import { CustomData } from './JsonUtils';
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 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
+ * @property ttl The time-to-live (in seconds) to initialize the conversation with
+ * @property customSortKey The customSortKey to initialize the conversation with.
+ * When {@link GetConversationsParameters.orderBy} is set to {@link OrderBy.CUSTOM_SORT_KEY}, conversations will be sorted according to the value of this property.
+ * @property customData Custom data associated with the conversation
+ * @interface
+ * @group Chat
+ */
 export type CreateConversationParameters = Omit<vonage.CreateConversationParametersJS, 'ttl' | 'customData'> & {
     ttl?: Nullable<number>;
     customData?: Nullable<CustomData>;
 };
+/**
+ * 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.
+ * @property includeCustomData Indicates whether to include custom data in the results, default is false.
+ * @property orderBy The strategy for ordering the conversations, default is {@link OrderBy.CREATED}.
+ * @interface
+ * @group Chat
+ */
 export type GetConversationsParameters = Omit<vonage.GetConversationsParametersJS, 'pageSize'> & {
     pageSize?: Nullable<number>;
 };
+/**
+ * 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.
+ * @property eventFilter A list of strings containing the types of events to be fetched and should have maximum 5 elements, default includes all events.
+ * @property includeDeletedEvents Indicates whether to include deleted events in the list, default is false.
+ * @property startId Specify the starting id of the events to be returned, default includes all events.
+ * @interface
+ * @group Chat
+ */
 export type GetConversationEventsParameters = Omit<vonage.GetConversationEventsParametersJS, 'pageSize' | 'startId'> & {
     pageSize?: Nullable<number>;
     startId?: Nullable<number>;
 };
+/**
+ * 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.
+ * @interface
+ * @group Chat
+ */
 export type GetConversationMembersParameters = Omit<vonage.GetConversationMembersParametersJS, 'pageSize'> & {
     pageSize?: Nullable<number>;
 };
+/**
+ * Parameters object for {@link VonageClient.updateConversation}.
+ *
+ * Every property is an {@link Option} monad.
+ * 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.
+ * @property ttl The time-to-live (TTL) for the conversation in seconds.
+ * @property customSortKey A custom sort key for the conversation.
+ * @property customData Custom data associated with the conversation.
+ * @interface
+ * @group Chat
+ */
 export interface UpdateConversationParameters {
     name?: string | Option<string>;
     displayName?: string | null | Option<string | null | undefined>;
@@ -24,3 +90,19 @@ export interface UpdateConversationParameters {
     customSortKey?: string | null | Option<string | null | undefined>;
     customData?: CustomData | null | Option<CustomData | null | undefined>;
 }
+/**
+ * The order in which paginated objects are presented.
+ *
+ * @beta
+ * @group Chat
+ */
+export type PresentingOrder = vonage.PresentingOrderJS;
+export declare const PresentingOrder: typeof vonage.PresentingOrderJS;
+/**
+ * The sorting strategy used for paginated objects.
+ *
+ * @beta
+ * @group Chat
+ */
+export type OrderBy = vonage.OrderByJS;
+export declare const OrderBy: typeof vonage.OrderByJS;

package/dist/utils/index.d.ts

@@ -6,3 +6,4 @@ export * from '../kotlin/JsUnions';
 export * from './ErrorModels';
 export * from './RequestParameterModels';
 export * from './Option';
+export * from './ConversationEventBodies';

package/dist/utils/logging.d.ts

@@ -1,22 +1,46 @@
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import vonage from '../utils/vonage';
+/**
+ * A group of Topics that a {@link VonageLogger} can subscribe to
+ */
 export type Topics = vonage.Topics | typeof Topics.prototype.name;
+/**
+ * A group of Topics that a {@link VonageLogger} can subscribe to
+ */
 export declare const Topics: typeof vonage.Topics;
 export type Topic = vonage.TopicJS;
 export declare const Topic: typeof vonage.TopicJS;
 export type LoggingLevelName = typeof vonage.LoggingLevelJS.prototype.name;
+/**
+ * The Client Logging Level.
+ *
+ * It can be set for the internal logger via {@link ClientInitConfigObject.loggingLevel}
+ * as well as for a custom logger via {@link VonageLogger.minLogLevel}.
+ */
 export type LoggingLevel = vonage.LoggingLevelJS | LoggingLevelName;
 export declare const LoggingLevel: typeof vonage.LoggingLevelJS;
 /**
- * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @deprecated Use {@link ClientInitConfigObject.loggingLevel} instead.
  * @param level - The logging level to set.
  */
 export declare const setDefaultLoggingLevel: (level: LoggingLevel) => void;
 /**
- * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @deprecated Use {@link ClientInitConfigObject.loggingLevel} instead.
  * @param level - The logging level to set.
  */
 export declare const setVonageClientLoggingLevel: (level: LoggingLevel) => void;
+/**
+ * An interface representing a client logger to be set via {@link ClientInitConfigObject.customLoggers}
+ *
+ * @property name The name of the logger.
+ * @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]]
+ */
 export type VonageLogger = VonageLoggerJS | ({
     minLogLevel?: LoggingLevel;
     topics?: Topics[];