@vonage/client-sdk 1.3.0-alpha.0 → 1.3.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  import vonage from '../utils/vonage';
2
- import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject } from '../utils';
2
+ import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject, Json, CustomData } from '../utils';
3
+ import { Nullable } from '../kotlin/clientsdk-clientcore_js';
3
4
  import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnions';
4
5
  /**
5
6
  * The Vonage Client SDK for JS/TS provides a simple interface
@@ -38,14 +39,10 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
38
39
  export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
39
40
  export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
40
41
  export type RtcStats = vonage.RTCStatsJS;
41
- type JSONValue = string | number | boolean | {
42
- [x: string]: JSONValue;
43
- } | JSONValue[];
44
- /**
45
- * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
46
- * @param level - The logging level to set.
47
- */
48
- export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
42
+ export type CreateConversationParameters = Omit<vonage.CreateConversationParametersJS, 'ttl' | 'customData'> & {
43
+ ttl?: Nullable<number>;
44
+ customData?: Nullable<CustomData>;
45
+ };
49
46
  /**
50
47
  * VonageClient is the main entry point for the Vonage Client SDK.
51
48
  *
@@ -243,11 +240,11 @@ export declare class VonageClient extends vonage.CombinedClientJS {
243
240
  *
244
241
  * @group Chat
245
242
  * @beta
246
- * @param name - the name of the conversation
247
- * @param displayName - the display name of the conversation
243
+ * @param parameters - A [CreateConversationParameters] object containing the parameters for the creation request.
244
+ *
248
245
  * @returns the `cid` of the conversation
249
246
  */
250
- createConversation(name?: string, displayName?: string): Promise<string>;
247
+ createConversation(parameters?: Nullable<CreateConversationParameters>): Promise<string>;
251
248
  /**
252
249
  * Get a Conversation
253
250
  *
@@ -332,7 +329,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
332
329
  * @param customData - the body of the message
333
330
  * @returns the `timestamp` of the message
334
331
  */
335
- sendMessageCustomEvent(id: string, customData: JSONValue): Promise<string>;
332
+ sendMessageCustomEvent(id: string, customData: CustomData): Promise<string>;
336
333
  /**
337
334
  * Send a Image message to a Conversation.
338
335
  *
@@ -355,10 +352,10 @@ export declare class VonageClient extends vonage.CombinedClientJS {
355
352
  * @group Chat
356
353
  * @beta
357
354
  * @param id - the Conversation's id
358
- * @param customBody - the body of the event
355
+ * @param customData - the body of the event
359
356
  * @returns the `timestamp` of the message
360
357
  */
361
- sendEphemeralEvent(id: string, customBody: JSONValue): Promise<string>;
358
+ sendEphemeralEvent(id: string, customData: CustomData): Promise<string>;
362
359
  /**
363
360
  * Delete an Event in a Conversation
364
361
  *