@vonage/client-sdk 1.2.0-alpha.9 → 1.2.0-rc.1

package/README.md

@@ -121,140 +121,37 @@ Below are several typical scenarios where the SDK is commonly utilized.
 ### Make an Outbound Call
 
 ```ts
-const call = await client.serverCall({
-  customData: {
-    callee: 'bob',
-    type: 'app'
-  }
-});
-console.log(call);
+
 ```
 
 ### Answer/Reject an Inbound Call
 
 ```ts
-// Answer Call
-client.on(
-  'callInvite',
-  async (callId: string, from: string, channelType: string) => {
-    client.answer(callId);
-    console.log(callId, from, channelType);
-  }
-);
 
-// ----
-
-// Reject Call
-client.on(
-  'callInvite',
-  async (callId: string, from: string, channelType: string) => {
-    client.reject(callId);
-    console.log(callId, from, channelType);
-  }
-);
 ```  
 
 ### Hang-up and Collect Stats
 
 ```ts
-// 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);
-  const reason_name = reason.name;
-  if (reason_name === 'LOCAL_HANGUP') {
-    console.log('you hangup the call');
-    return;
-  } else if (reason_name === 'REMOTE_HANGUP') {
-    console.log('call was hanged up remotly');
-    return;
-  } else if (reason_name === 'REMOTE_REJECT') {
-    console.log('call was rejected');
-    return;
-  } else if (reason_name === 'MEDIA_TIMEOUT') {
-    console.log('media timeout');
-    return;
-  } else if (reason_name === 'REMOTE_NO_ANSWER_TIMEOUT') {
-    console.log('remote no answer timeout');
-    return;
-  } else {
-    return exhaustiveCheck(reason_name);
-  }
-});
 ```
 
 ### Get Conversations
 
 ```ts
-try {
-  let cursor: string | undefined | null = undefined;
-  const pageSize = 10;
-  const conversations: Conversation[] = [];
-  const includeCustsomData = false;
-  do {
-    const response: ConversationsPage = await client.getConversations(
-      PresentingOrder.ASC,
-      pageSize,
-      cursor,
-      includeCustsomData
-    );
-    conversations.push(...response.conversations);
-    cursor = response.nextCursor;
-  } while (cursor !== null);
-  console.log(`Conversations successfully fetched: ${conversations}`);
-} catch (e) {
-  console.log(`Error in fetching Conversations: ${e}`);
-}
+
 ```
 
 ### Send Text Messages
 
 ```ts
-try {
-  const timestamp = await client.sendTextMessage(
-    'conversationId',
-    'Hello there'
-  );
-  console.log(`Message successfully sent with timestamp ${timestamp}`);
-} catch (e) {
-  console.log(`Error in sending Message: ${e}`);
-}
+
 ```
 
 ### Listen for Conversation Events
 
 ```ts
-client.on('conversationEvent', (event) => {
-  switch (event.kind) {
-    case 'member:invited':
-    case 'member:joined':
-    case 'member:left':
-    case 'message:text':
-    case 'message:custom':
-    case 'message:audio':
-    case 'message:video':
-    case 'message:image':
-    case 'message:file':
-    case 'message:vcard':
-    case 'message:location':
-    case 'message:template':
-  }
-  const sender =
-    event.from.kind == 'embeddedInfo' ? event.from.user.name : 'System';
-  console.log(
-    `${sender} sent ${event.kind} event to Conversation ${event.conversationId}`
-  );
-});
+
 ```
 
 ## Documentation and examples

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, ClientInitConfigObject } 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,9 +34,15 @@ 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[];
+/**
+ * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @param level - The logging level to set.
+ */
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
@@ -47,12 +56,12 @@ export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggin
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
  */
 export declare class VonageClient extends vonage.CombinedClientJS {
-    constructor();
+    constructor(config?: ClientInitConfigObject);
     /**
      * Register a callback for an event.
      *
      * @example
-     * [[include:register_listener.txt]]
+     * [[include: snippet_RegisterListener.txt]]
      *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
@@ -66,7 +75,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Unregister a callback for an event.
      *
      * @example
-     * [[include:unregister_listener.txt]]
+     * [[include: snippet_UnregisterListener.txt]]
      *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callbackSymbol - the callback symbol to unregister
@@ -79,7 +88,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Clear all callbacks for an event.
      *
      * @example
-     * [[include: clear_callbacks.txt]]
+     * [[include: snippet_Clear_Callbacks.txt]]
      *
      * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
@@ -96,7 +105,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * to resume an existing session.
      *
      * @example
-     * [[include:create_session.txt]]
+     * [[include: snippet_SessionCreate.txt]]
      *
      * @param token
      * @param sessionId - optional sessionId to use
@@ -123,7 +132,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * This is used to initiate a call using the Voice API and NCCO.
      *
      * @example
-     * [[include:outbound_call.txt]]
+     * [[include: snippet_OutboundCall.txt]]
      *
      * @group Voice
      * @param context - the context to send to the server passed as Custom data to the voice answer webhook
@@ -134,7 +143,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Hangup a call.
      *
      * @example
-     * [[include:call_hangup.txt]]
+     * [[include: snippet_CallHangup.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to hangup
@@ -156,7 +165,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Sends a TTS message to the Call
      *
      * @example
-     * [[include:call_say.txt]]
+     * [[include: snippet_CallSay.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to send the message to
@@ -168,7 +177,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a list of Conversations for the user.
      *
      * @example
-     * [[include:get_conversations.txt]]
+     * [[include: snippet_GetConversations.txt]]
      *
      * @group Chat
      * @beta
@@ -177,12 +186,12 @@ 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, includeCustomData?: boolean): Promise<ConversationsPage>;
+    getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null, includeCustomData?: boolean, orderBy?: OrderBy | null): Promise<ConversationsPage>;
     /**
      * Get a Conversation's Events
      *
      * @example
-     * [[include:get_conversation_events.txt]]
+     * [[include: snippet_GetConversationEvents.txt]]
      *
      * @group Chat
      * @beta
@@ -190,18 +199,19 @@ 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
      *
      * @example
-     * [[include:get_conversation_members.txt]]
+     * [[include: snippet_GetConversationMembers.txt]]
      *
      * @group Chat
      * @beta
@@ -216,7 +226,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Create a conversation
      *
      * @example
-     * [[include:create_conversation.txt]]
+     * [[include: snippet_CreateConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -229,7 +239,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a Conversation
      *
      * @example
-     * [[include:get_conversation.txt]]
+     * [[include: snippet_GetConversation.txt]]
      *
      * @param id - the Conversation's id
      * @returns the `Conversation`
@@ -239,7 +249,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Leave a Conversation
      *
      * @example
-     * [[include:leave_conversation.txt]]
+     * [[include: snippet_LeaveConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -251,7 +261,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Join a Conversation
      *
      * @example
-     * [[include:join_conversation.txt]]
+     * [[include: snippet_JoinConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -263,7 +273,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Delete a Conversation
      *
      * @example
-     * [[include:delete_conversation.txt]]
+     * [[include: snippet_DeleteConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -275,7 +285,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Invite a user to a Conversation by user's `name`
      *
      * @example
-     * [[include:invite_to_conversation.txt]]
+     * [[include: snippet_InviteToConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -288,7 +298,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Send a text message to a Conversation
      *
      * @example
-     * [[include:send_text_message.txt]]
+     * [[include: snippet_SendTextMessage.txt]]
      *
      * @group Chat
      * @beta
@@ -296,12 +306,12 @@ 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
      *
      * @example
-     * [[include:send_custom_message.txt]]
+     * [[include: snippet_SendCustomMessage.txt]]
      *
      * @group Chat
      * @beta
@@ -309,12 +319,38 @@ 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: snippet_SendEphemeralEvent.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
      *
      * @example
-     * [[include:get_conversation_member.txt]]
+     * [[include: snippet_GetConversationMember.txt]]
      *
      * @group Chat
      * @beta