@vonage/client-sdk 1.2.0-alpha.8 → 1.2.0-rc.0

package/README.md

@@ -160,32 +160,26 @@ client.on(
 // await client.hangup(call);
 await client.hangup(call, 'reason-text', 'reason-code');
 
-client.on('callHangup', async (callId: string, callQuality: RTCQuality) => {
-  if (callId == call) {
-    console.log(`Call ${callId} has hanged up, callQuality:${callQuality}`);
-  }
-});
-
 client.on('callHangup', (callId, callQuality, reason) => {
   if (callId == call) {
     console.log('The call has finished');
   }
-  console.log(`this was your call mos score: `, callQuality.mos_score);
+  console.log(`This was your call MOS score: `, callQuality.mos_score);
   const reason_name = reason.name;
   if (reason_name === 'LOCAL_HANGUP') {
-    console.log('you hangup the call');
+    console.log('You hung up the call');
     return;
   } else if (reason_name === 'REMOTE_HANGUP') {
-    console.log('call was hanged up remotly');
+    console.log('Call was hung up remotely');
     return;
   } else if (reason_name === 'REMOTE_REJECT') {
-    console.log('call was rejected');
+    console.log('Call was rejected');
     return;
   } else if (reason_name === 'MEDIA_TIMEOUT') {
-    console.log('media timeout');
+    console.log('Timeout due to media failure');
     return;
   } else if (reason_name === 'REMOTE_NO_ANSWER_TIMEOUT') {
-    console.log('remote no answer timeout');
+    console.log('Timeout due to missing remote answer');
     return;
   } else {
     return exhaustiveCheck(reason_name);
@@ -200,11 +194,15 @@ try {
   let cursor: string | undefined | null = undefined;
   const pageSize = 10;
   const conversations: Conversation[] = [];
+  const includeCustomData = false;
+  const orderBy = OrderBy.CREATED;
   do {
     const response: ConversationsPage = await client.getConversations(
       PresentingOrder.ASC,
       pageSize,
-      cursor
+      cursor,
+      includeCustomData,
+      orderBy
     );
     conversations.push(...response.conversations);
     cursor = response.nextCursor;
@@ -219,7 +217,7 @@ try {
 
 ```ts
 try {
-  const timestamp = await client.sendTextMessage(
+  const timestamp = await client.sendMessageTextEvent(
     'conversationId',
     'Hello there'
   );
@@ -246,6 +244,11 @@ client.on('conversationEvent', (event) => {
     case 'message:vcard':
     case 'message:location':
     case 'message:template':
+    case 'custom':
+    case 'ephemeral':
+      break;
+    default:
+      exhaustiveCheck(event);
   }
   const sender =
     event.from.kind == 'embeddedInfo' ? event.from.user.name : 'System';

package/dist/client/VonageClient.d.ts

@@ -1,5 +1,5 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent } from '../utils';
+import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent, PersistentConversationEvent, OrderBy } from '../utils';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
  * For the Vonage Voice and Messaging APIs.
@@ -13,11 +13,14 @@ import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder,
  */
 export * from '../utils';
 export interface EventsPage extends vonage.EventsPageJS {
-    events: ConversationEvent[];
+    events: PersistentConversationEvent[];
 }
 interface VonageEvent extends vonage.CombinedEvents {
     conversationEvent: (event: ConversationEvent) => void;
 }
+type EventPage = vonage.EventsPageJS & {
+    events: PersistentConversationEvent[];
+};
 export type RTCQuality = vonage.RTCQualityJS;
 export type CancelReason = vonage.CancelReasonJS;
 export declare const CancelReason: typeof vonage.CancelReasonJS;
@@ -31,6 +34,8 @@ export declare const LegStatus: typeof vonage.LegStatusJS;
 export type CallSayParams = Partial<vonage.CallSayParams> & {
     text: string;
 };
+export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
+export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
 } | JSONValue[];
@@ -177,7 +182,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param cursor - the cursor to use for pagination (default: null)
      * @returns a `ConversationsPage` containing the conversations
      */
-    getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<ConversationsPage>;
+    getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null, includeCustomData?: boolean, orderBy?: OrderBy | null): Promise<ConversationsPage>;
     /**
      * Get a Conversation's Events
      *
@@ -190,13 +195,14 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param order - the order to return the events in (default: 'asc')
      * @param pageSize - the number of events to return per page (default: 100)
      * @param cursor - the cursor to use for pagination (default: null)
+     * @param eventFilter - the event types to filter by (default: null)
      * @returns a `EventsPage` containing the events
      *
      * @privateRemarks
      * * This is a workaround for the to ensure exhaustiveness of the `ConversationEvent` type
      * * the kotlin core does not support union types
      */
-    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null): Promise<EventsPage>;
+    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null): Promise<EventPage>;
     /**
      * Get a Conversation's Members
      *
@@ -296,7 +302,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param text - the Body of the message
      * @returns the `timestamp` of the message
      */
-    sendTextMessage(id: string, text: string): Promise<string>;
+    sendMessageTextEvent(id: string, text: string): Promise<string>;
     /**
      * Send a custom message to a Conversation
      *
@@ -309,7 +315,33 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param customData - the body of the message
      * @returns the `timestamp` of the message
      */
-    sendCustomMessage(id: string, customData: JSONValue): Promise<string>;
+    sendMessageCustomEvent(id: string, customData: JSONValue): Promise<string>;
+    /**
+     * Send an ephemeral event to a Conversation
+     *
+     * @example
+     * [[include:send_ephemeral_event.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param customBody - the body of the event
+     * @returns the `timestamp` of the message
+     */
+    sendEphemeralEvent(id: string, customBody: JSONValue): Promise<string>;
+    /**
+     * Delete an Event in a Conversation
+     *
+     * @example
+     * [[include:delete_event.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the id for the Event to be deleted
+     * @param conversationId - the id for the conversation, the event belongs to.
+     * @returns void
+     */
+    deleteEvent(id: number, conversationId: string): Promise<void>;
     /**
      * Get a Member of a Conversation
      *