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

package/dist/utils/ConversationModels.d.ts

@@ -1,170 +1,170 @@
-import vonage from '../utils/vonage';
-import { ConversationChannelType, ConversationState, MemberState, PersistentConversationEvent } from '../kotlin/JsUnions';
-import { toEnum, unionOfValues } from './Enums';
-import { Leg } from '../client';
-/**
- * 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
- *
- * @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 legs
- *
- * @property legs The legs in the page
- * @property previousCursor The cursor to fetch the previous page
- * @property nextCursor The cursor to fetch the next page
- * @interface
- * @group Voice
- */
-export type LegsPage = vonage.LegsPageJS & {
-    legs: Leg[];
-};
-/**
- * Represents a page of conversation events
- *
- * @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 = Omit<vonage.MemberJS, 'state' | 'channel'> & {
-    state?: MemberState;
-    channel?: MemberChannel;
-};
-/**
- * Represents a {@link Member} timestamps
- *
- * @interface
- */
-export type MemberTimestamp = vonage.MemberTimestampJS;
-/**
- * Represents a page of conversation members
- *
- * @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}
- *
- * @enum
- */
-export declare const MemberChannelType: toEnum<ConversationChannelType>;
-export type MemberChannelType = unionOfValues<typeof MemberChannelType>;
-/**
- * Represents a Member Channel
- *
- * @property type The {@link MemberChannelType}
- * @property from The from {@link Channel}
- * @property to The to {@link Channel}
- * @interface
- */
-export type MemberChannel = Omit<vonage.MemberChannelJS, 'type'> & {
-    type: MemberChannelType;
-};
-/**
- * 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;
+import vonage from '../utils/vonage';
+import { ConversationChannelType, ConversationState, MemberState, PersistentConversationEvent } from '../kotlin/JsUnions';
+import { toEnum, unionOfValues } from './Enums';
+import { Leg } from '../client';
+/**
+ * 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
+ *
+ * @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 legs
+ *
+ * @property legs The legs in the page
+ * @property previousCursor The cursor to fetch the previous page
+ * @property nextCursor The cursor to fetch the next page
+ * @interface
+ * @group Voice
+ */
+export type LegsPage = vonage.LegsPageJS & {
+    legs: Leg[];
+};
+/**
+ * Represents a page of conversation events
+ *
+ * @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 = Omit<vonage.MemberJS, 'state' | 'channel'> & {
+    state?: MemberState;
+    channel?: MemberChannel;
+};
+/**
+ * Represents a {@link Member} timestamps
+ *
+ * @interface
+ */
+export type MemberTimestamp = vonage.MemberTimestampJS;
+/**
+ * Represents a page of conversation members
+ *
+ * @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}
+ *
+ * @enum
+ */
+export declare const MemberChannelType: toEnum<ConversationChannelType>;
+export type MemberChannelType = unionOfValues<typeof MemberChannelType>;
+/**
+ * Represents a Member Channel
+ *
+ * @property type The {@link MemberChannelType}
+ * @property from The from {@link Channel}
+ * @property to The to {@link Channel}
+ * @interface
+ */
+export type MemberChannel = Omit<vonage.MemberChannelJS, 'type'> & {
+    type: MemberChannelType;
+};
+/**
+ * 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/Enums.d.ts

@@ -1,56 +1,56 @@
-import { HangupReasonJS, LegStatusJS, CallDisconnectReasonJS, CancelReasonJS, VoiceChannelTypeJS, SessionErrorReasonJS, VonageErrorTypeJS, CSErrorCodesJS, SessionErrorCodesJS } from '../kotlin/JsUnions';
-export type CamelCase<S extends string, Sep extends string = '-' | '_' | ' ' | '.'> = S extends `${infer F}${Sep}${infer R}` ? `${Lowercase<F>}${CamelCase<Capitalize<R>, Sep>}` : Lowercase<S>;
-export type PascalCase<S extends string, Sep extends string = '-' | '_' | ' ' | '.'> = S extends `${infer F}${Sep}${infer R}` ? `${Capitalize<Lowercase<F>>}${PascalCase<Capitalize<R>, Sep>}` : S extends Uppercase<S> ? Capitalize<Lowercase<S>> : Capitalize<S>;
-export type toEnum<T extends string> = {
-    [key in T as PascalCase<key>]: key;
-};
-export type unionOfValues<T> = T[keyof T];
-/**
- * Hangup reasons for a call
- * @enum
- */
-export declare const HangupReason: toEnum<HangupReasonJS>;
-export type HangupReason = unionOfValues<typeof HangupReason>;
-/**
- * Leg status for a call
- * @enum
- */
-export declare const LegStatus: toEnum<LegStatusJS>;
-export type LegStatus = unionOfValues<typeof LegStatus>;
-/**
- * Call disconnect reasons
- * @enum
- */
-export declare const CallDisconnectReason: toEnum<CallDisconnectReasonJS>;
-export type CallDisconnectReason = unionOfValues<typeof CallDisconnectReason>;
-/**
- * Call Invite cancel reasons
- * @enum
- */
-export declare const CancelReason: toEnum<CancelReasonJS>;
-export type CancelReason = unionOfValues<typeof CancelReason>;
-/**
- * Voice Channel Types
- * @enum
- */
-export declare const VoiceChannelType: toEnum<VoiceChannelTypeJS>;
-export type VoiceChannelType = unionOfValues<typeof VoiceChannelType>;
-/**
- * Session Error Reasons
- * @enum
- */
-export declare const SessionErrorReason: toEnum<SessionErrorReasonJS>;
-export type SessionErrorReason = unionOfValues<typeof SessionErrorReason>;
-/**
- * Vonage Error Types
- * @enum
- */
-export declare const VonageErrorType: toEnum<VonageErrorTypeJS>;
-/**
- * Vonage Error Values
- */
-export type VonageErrorType = unionOfValues<typeof VonageErrorType>;
-export declare const CSErrorCodes: toEnum<CSErrorCodesJS>;
-export type CSErrorCodes = unionOfValues<typeof CSErrorCodes>;
-export declare const SessionErrorCodes: toEnum<SessionErrorCodesJS>;
-export type SessionErrorCodes = unionOfValues<typeof SessionErrorCodes>;
+import { HangupReasonJS, LegStatusJS, CallDisconnectReasonJS, CancelReasonJS, VoiceChannelTypeJS, SessionErrorReasonJS, VonageErrorTypeJS, CSErrorCodesJS, SessionErrorCodesJS } from '../kotlin/JsUnions';
+export type CamelCase<S extends string, Sep extends string = '-' | '_' | ' ' | '.'> = S extends `${infer F}${Sep}${infer R}` ? `${Lowercase<F>}${CamelCase<Capitalize<R>, Sep>}` : Lowercase<S>;
+export type PascalCase<S extends string, Sep extends string = '-' | '_' | ' ' | '.'> = S extends `${infer F}${Sep}${infer R}` ? `${Capitalize<Lowercase<F>>}${PascalCase<Capitalize<R>, Sep>}` : S extends Uppercase<S> ? Capitalize<Lowercase<S>> : Capitalize<S>;
+export type toEnum<T extends string> = {
+    [key in T as PascalCase<key>]: key;
+};
+export type unionOfValues<T> = T[keyof T];
+/**
+ * Hangup reasons for a call
+ * @enum
+ */
+export declare const HangupReason: toEnum<HangupReasonJS>;
+export type HangupReason = unionOfValues<typeof HangupReason>;
+/**
+ * Leg status for a call
+ * @enum
+ */
+export declare const LegStatus: toEnum<LegStatusJS>;
+export type LegStatus = unionOfValues<typeof LegStatus>;
+/**
+ * Call disconnect reasons
+ * @enum
+ */
+export declare const CallDisconnectReason: toEnum<CallDisconnectReasonJS>;
+export type CallDisconnectReason = unionOfValues<typeof CallDisconnectReason>;
+/**
+ * Call Invite cancel reasons
+ * @enum
+ */
+export declare const CancelReason: toEnum<CancelReasonJS>;
+export type CancelReason = unionOfValues<typeof CancelReason>;
+/**
+ * Voice Channel Types
+ * @enum
+ */
+export declare const VoiceChannelType: toEnum<VoiceChannelTypeJS>;
+export type VoiceChannelType = unionOfValues<typeof VoiceChannelType>;
+/**
+ * Session Error Reasons
+ * @enum
+ */
+export declare const SessionErrorReason: toEnum<SessionErrorReasonJS>;
+export type SessionErrorReason = unionOfValues<typeof SessionErrorReason>;
+/**
+ * Vonage Error Types
+ * @enum
+ */
+export declare const VonageErrorType: toEnum<VonageErrorTypeJS>;
+/**
+ * Vonage Error Values
+ */
+export type VonageErrorType = unionOfValues<typeof VonageErrorType>;
+export declare const CSErrorCodes: toEnum<CSErrorCodesJS>;
+export type CSErrorCodes = unionOfValues<typeof CSErrorCodes>;
+export declare const SessionErrorCodes: toEnum<SessionErrorCodesJS>;
+export type SessionErrorCodes = unionOfValues<typeof SessionErrorCodes>;

package/dist/utils/ErrorModels.d.ts

@@ -1,23 +1,23 @@
-import { type VonageErrorType } from './Enums';
-import vonage from '../utils/vonage';
-type VonageErrorJS = {
-    [key in keyof Omit<vonage.VonageErrorJS, 'type'>]: vonage.VonageErrorJS[key];
-};
-/**
- * Vonage Error
- *
- * @interface
- */
-export type VonageError = {
-    /**
-     * Type of the error
-     */
-    type: VonageErrorType;
-} & VonageErrorJS;
-/**
- * Vonage Error
- *
- * @implements {@link VonageError}
- */
-export declare const VonageError: typeof vonage.VonageErrorJS;
-export {};
+import { type VonageErrorType } from './Enums';
+import vonage from '../utils/vonage';
+type VonageErrorJS = {
+    [key in keyof Omit<vonage.VonageErrorJS, 'type'>]: vonage.VonageErrorJS[key];
+};
+/**
+ * Vonage Error
+ *
+ * @interface
+ */
+export type VonageError = {
+    /**
+     * Type of the error
+     */
+    type: VonageErrorType;
+} & VonageErrorJS;
+/**
+ * Vonage Error
+ *
+ * @implements {@link VonageError}
+ */
+export declare const VonageError: typeof vonage.VonageErrorJS;
+export {};

package/dist/utils/JsonUtils.d.ts

@@ -1,15 +1,15 @@
-/**
- * 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[];
-/**
- * Represents custom data, which can be a JSON object or a JSON-formatted string.
- * There is a 2MB limit on the size of the custom data object.
- */
-export type CustomData = Json | string;
+/**
+ * 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[];
+/**
+ * Represents custom data, which can be a JSON object or a JSON-formatted string.
+ * There is a 2MB limit on the size of the custom data object.
+ */
+export type CustomData = Json | string;

package/dist/utils/Option.d.ts

@@ -1,19 +1,19 @@
-import vonage from './vonage';
-/**
- * Represents an Either monad for optional properties.
- *
- * 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>;
+import vonage from './vonage';
+/**
+ * Represents an Either monad for optional properties.
+ *
+ * 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) => 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>;