@vonage/client-sdk 2.6.1 → 2.6.2-snapshot.20260820113314

package/dist/utils/ClientConfig.d.ts

@@ -1,104 +1,104 @@
-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
- * @property emergencyPrimaryRegion The primary region URL for emergency services
- * @property emergencySecondaryRegion The secondary region URL for emergency services
- *
- * @example
- * [[include:snippet_Config.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
- * @property emergencyPrimaryRegion The primary region URL for emergency services
- * @property emergencySecondaryRegion The secondary region URL for emergency services
- *
- * @example
- * [[include:snippet_Logging.txt]]
- */
-export type ClientInitConfigObject = InitConfigObjectJS | ({
-    region?: ConfigRegion;
-    loggingLevel?: LoggingLevel;
-    customLoggers?: VonageLogger[];
-} & Omit<InitConfigObjectJS, 'region' | 'loggingLevel' | 'customLoggers'>);
-export interface ConfigObjectJS {
-    region?: Nullable<vonage.CoreClientConfigRegionJS>;
-    apiUrl?: Nullable<string>;
-    websocketUrl?: Nullable<string>;
-    websocketPath?: Nullable<string>;
-    rtcStatsTelemetry?: Nullable<boolean>;
-    autoReconnectMedia?: Nullable<boolean>;
-    emergencyPrimaryRegion?: Nullable<string>;
-    emergencySecondaryRegion?: Nullable<string>;
-}
-export interface InitConfigObjectJS extends ConfigObjectJS {
-    loggingLevel?: Nullable<vonage.LoggingLevelJS>;
-    customLoggers?: Nullable<VonageLoggerJS[]>;
-    disableInternalLogger?: Nullable<boolean>;
-}
-export declare class ClientConfig extends vonage.CoreClientConfigJS {
-    /**
-     * Constructs a new instance of the class.
-     *
-     * @param 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?: ConfigRegion);
-}
-export declare class ClientInitConfig implements InitConfigObjectJS {
-    loggingLevel: vonage.LoggingLevelJS;
-    region: vonage.CoreClientConfigRegionJS;
-    customLoggers: VonageLoggerJS[];
-    disableInternalLogger: boolean;
-    apiUrl?: Nullable<string>;
-    websocketUrl?: Nullable<string>;
-    websocketPath?: Nullable<string>;
-    rtcStatsTelemetry?: Nullable<boolean>;
-    autoReconnectMedia?: Nullable<boolean>;
-    emergencyPrimaryRegion?: Nullable<string>;
-    emergencySecondaryRegion?: Nullable<string>;
-    /**
-     * Constructs a new instance of the class.
-     */
-    constructor(loggingLevel?: LoggingLevel, region?: ConfigRegion, customLoggers?: Array<VonageLogger | VonageLoggerJS>);
-}
-export declare const convertInitConfig: (config: ClientInitConfigObject) => InitConfigObjectJS;
+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
+ * @property emergencyPrimaryRegion The primary region URL for emergency services
+ * @property emergencySecondaryRegion The secondary region URL for emergency services
+ *
+ * @example
+ * {@includeCode ../../examples/snippets/snippet_Config.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
+ * @property emergencyPrimaryRegion The primary region URL for emergency services
+ * @property emergencySecondaryRegion The secondary region URL for emergency services
+ *
+ * @example
+ * {@includeCode ../../examples/snippets/snippet_Logging.txt}
+ */
+export type ClientInitConfigObject = InitConfigObjectJS | ({
+    region?: ConfigRegion;
+    loggingLevel?: LoggingLevel;
+    customLoggers?: VonageLogger[];
+} & Omit<InitConfigObjectJS, 'region' | 'loggingLevel' | 'customLoggers'>);
+export interface ConfigObjectJS {
+    region?: Nullable<vonage.CoreClientConfigRegionJS>;
+    apiUrl?: Nullable<string>;
+    websocketUrl?: Nullable<string>;
+    websocketPath?: Nullable<string>;
+    rtcStatsTelemetry?: Nullable<boolean>;
+    autoReconnectMedia?: Nullable<boolean>;
+    emergencyPrimaryRegion?: Nullable<string>;
+    emergencySecondaryRegion?: Nullable<string>;
+}
+export interface InitConfigObjectJS extends ConfigObjectJS {
+    loggingLevel?: Nullable<vonage.LoggingLevelJS>;
+    customLoggers?: Nullable<VonageLoggerJS[]>;
+    disableInternalLogger?: Nullable<boolean>;
+}
+export declare class ClientConfig extends vonage.CoreClientConfigJS {
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param 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?: ConfigRegion);
+}
+export declare class ClientInitConfig implements InitConfigObjectJS {
+    loggingLevel: vonage.LoggingLevelJS;
+    region: vonage.CoreClientConfigRegionJS;
+    customLoggers: VonageLoggerJS[];
+    disableInternalLogger: boolean;
+    apiUrl?: Nullable<string>;
+    websocketUrl?: Nullable<string>;
+    websocketPath?: Nullable<string>;
+    rtcStatsTelemetry?: Nullable<boolean>;
+    autoReconnectMedia?: Nullable<boolean>;
+    emergencyPrimaryRegion?: Nullable<string>;
+    emergencySecondaryRegion?: Nullable<string>;
+    /**
+     * Constructs a new instance of the class.
+     */
+    constructor(loggingLevel?: LoggingLevel, region?: ConfigRegion, customLoggers?: Array<VonageLogger | VonageLoggerJS>);
+}
+export declare const convertInitConfig: (config: ClientInitConfigObject) => InitConfigObjectJS;

package/dist/utils/ConversationEventBodies.d.ts

@@ -1,125 +1,125 @@
-import vonage from '../utils/vonage';
-export type EventState = Omit<vonage.EventStateJS, 'current'> & {
-    current: Lowercase<typeof vonage.EventStateTypeJS.prototype.name>;
-};
-/**
- * Member status is a map of member id to {@link EventState}
- */
-export type MemberStatus = Record<string, EventState>;
-/**
- * The {@link MessageAudioEvent} Body type
- *
- * @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
- *
- * @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
- * @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
- * @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
- * @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
- *
- * @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
- *
- * @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
- *
- * @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
- *
- * @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
- *
- * @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}
- *
- * @group Chat
- */
-export interface Location {
-    name?: string | null;
-    address?: string | null;
-    latitude: string;
-    longitude: string;
-}
-/**
- * The Template object for a {@link MessageTemplateEventBody}
- *
- * @group Chat
- */
-export interface Template {
-    name: string;
-    parameters?: string[] | null;
-}
-/**
- * The Whatsapp object for a {@link MessageTemplateEventBody}
- *
- * @group Chat
- */
-export interface Whatsapp {
-    policy: string;
-    locale: string;
-}
+import vonage from '../utils/vonage';
+export type EventState = Omit<vonage.EventStateJS, 'current'> & {
+    current: Lowercase<typeof vonage.EventStateTypeJS.prototype.name>;
+};
+/**
+ * Member status is a map of member id to {@link EventState}
+ */
+export type MemberStatus = Record<string, EventState>;
+/**
+ * The {@link MessageAudioEvent} Body type
+ *
+ * @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
+ *
+ * @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
+ * @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
+ * @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
+ * @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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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}
+ *
+ * @group Chat
+ */
+export interface Location {
+    name?: string | null;
+    address?: string | null;
+    latitude: string;
+    longitude: string;
+}
+/**
+ * The Template object for a {@link MessageTemplateEventBody}
+ *
+ * @group Chat
+ */
+export interface Template {
+    name: string;
+    parameters?: string[] | null;
+}
+/**
+ * The Whatsapp object for a {@link MessageTemplateEventBody}
+ *
+ * @group Chat
+ */
+export interface Whatsapp {
+    policy: string;
+    locale: string;
+}