@vonage/client-sdk 1.2.0-alpha.11 → 1.2.0-alpha.13

package/README.md

@@ -200,13 +200,13 @@ try {
   let cursor: string | undefined | null = undefined;
   const pageSize = 10;
   const conversations: Conversation[] = [];
-  const includeCustsomData = false;
+  const includeCustomData = false;
   do {
     const response: ConversationsPage = await client.getConversations(
       PresentingOrder.ASC,
       pageSize,
       cursor,
-      includeCustsomData
+      includeCustomData
     );
     conversations.push(...response.conversations);
     cursor = response.nextCursor;
@@ -249,6 +249,10 @@ client.on('conversationEvent', (event) => {
     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 } 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;
@@ -192,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
      *
@@ -312,6 +316,19 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendCustomMessage(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>;
     /**
      * Get a Member of a Conversation
      *