@vonage/client-sdk 1.1.0-alpha.3 → 1.1.0-alpha.7

package/dist/client/VonageClient.d.ts

@@ -1,9 +1,16 @@
 import vonage from '../utils/vonage';
-export * from '../utils';
 /**
- * Minimal Interface built on top of KMP export
- * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
+ * The Vonage Client SDK for JS/TS provides a simple interface
+ * For the Vonage Voice and Messaging APIs.
+ *
+ * @remarks
+ * Built on top of the Kotlin Multiplatform SDK, it provides a
+ * more JS-like API, and platform specific implementations for
+ * the underlying network and media layers.
+ *
+ * @packageDocumentation
  */
+export * from '../utils';
 export type VonageEvent = vonage.CombinedEvents;
 export type RTCQuality = vonage.RTCQualityJS;
 export type CancelReason = vonage.CancelReasonJS;
@@ -14,11 +21,199 @@ export type SessionErrorReason = vonage.SessionErrorReasonJS;
 export declare const SessionErrorReason: typeof vonage.SessionErrorReasonJS;
 export type LegStatus = vonage.LegStatusJS;
 export declare const LegStatus: typeof vonage.LegStatusJS;
+export type CallSayParams = Partial<vonage.CallSayParams> & {
+    text: string;
+};
+type JSONValue = string | number | boolean | {
+    [x: string]: JSONValue;
+} | JSONValue[];
+import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder } from '../utils';
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
+/**
+ * VonageClient is the main entry point for the Vonage Client SDK.
+ *
+ * @privateRemarks
+ * This class is a wrapper around the KMP `CombinedClientJS` class.
+ * It provides a more JS-like API, and also provides a proxy object
+ * to allow for registering callbacks via `on()`.
+ *
+ * Minimal Interface built on top of KMP export
+ * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
+ */
 export declare class VonageClient extends vonage.CombinedClientJS {
+    /**
+     * Proxy object to allow for registering callbacks via `on()`
+     * @internal
+     */
     private callbacks;
     constructor();
-    on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): void;
-    hangup(callId: string, reasonText?: string, reasonCode?: string): Promise<any>;
+    /**
+     * Register a callback for an event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @param callback - the callback to register for the event
+     * @returns a symbol that can be used to unregister the callback
+     * @remarks
+     * Besure to store the symbol returned by this method so you can unregister the callback later.
+     * We recommend deregistering callbacks when you no longer need them. See {@link off}.
+     */
+    on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): symbol;
+    /**
+     * Unregister a callback for an event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @param callbackSymbol - the callback symbol to unregister
+     * @returns true if the callback was unregistered, false otherwise
+     * @remarks
+     * We recommend deregistering callbacks when you no longer need them.
+     */
+    off<T extends keyof VonageEvent>(event: T, callbackSymbol: symbol): boolean;
+    /**
+     * Clear all callbacks for an event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @returns void
+     *
+     * @remarks
+     * This is useful for cleaning up callbacks when you no longer need them.
+     *
+     * @example
+     * ```ts
+     *    client.clearCallbacks('legStatusUpdate');
+     * ```
+     */
+    clearCallbacks<T extends keyof VonageEvent>(event: T): void;
+    /**
+     * Create a session with a token and optional sessionId
+     * If no sessionId is provided, a new one will be generated
+     * and returned. If a sessionId is provided, it will be used
+     * to resume an existing session.
+     *
+     * @param token
+     * @param sessionId - optional sessionId to use
+     * @returns the `sessionId` of the session
+     */
+    createSession(token: string, sessionId?: string | null): Promise<string>;
+    /**
+     * Make a server call to the Vonage API.
+     * This is used to initiate a call using the Voice API and NCCO.
+     *
+     * @param context - the context to send to the server passed as Custom data to the voice answer webhook
+     * @returns the `callId` of the call
+     */
+    serverCall(context?: Json): Promise<string>;
+    /**
+     * Hangup a call.
+     *
+     * @remarks
+     * this is a convenience method that calls `hangupWithReason` with
+     *
+     * @param callId - the `callId` of the call to hangup
+     * @param reasonText - optional reason text to send to the other party
+     * @param reasonCode - optional reason code to send to the other party
+     * @returns void
+     */
+    hangup(callId: string, reasonText?: string, reasonCode?: string): Promise<void>;
+    /**
+     * Sends a TTS message to the Call
+     * @param callId - the `callId` of the call to send the message to
+     * @param text - the text to send
+     * @returns void
+     */
+    say(callId: string, text: string): Promise<void>;
+    /**
+     * Sends a TTS message to the Call
+     * @param callId - the `callId` of the call to send the message to
+     * @param params - the `CallSayParams` to send
+     * @returns void
+     */
+    say(callId: string, params: CallSayParams): Promise<void>;
+    /**
+     * Get a list of Conversations for the user.
+     *
+     * @param order - the order to return the conversations in (default: 'asc')
+     * @param pageSize - the number of conversations to return per page (default: 100)
+     * @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>;
+    /**
+     * Get a Conversation's Events
+     *
+     * @param id - the Conversation's id
+     * @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)
+     * @returns a `EventsPage` containing the events
+     */
+    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<EventsPage>;
+    /**
+     * Get a Conversation's Members
+     * @param id - the Conversation's id
+     * @param order - the order to return the members in (default: 'asc')
+     * @param pageSize - the number of members to return per page (default: 100)
+     * @param cursor - the cursor to use for pagination (default: null)
+     * @returns a `MembersPage` containing the members
+     */
+    getConversationMembers(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<MembersPage>;
+    /**
+     * Create a conversation
+     * @param name - the name of the conversation
+     * @param displayName - the display name of the conversation
+     * @returns the `cid` of the conversation
+     */
+    createConversation(name?: string, displayName?: string): Promise<string>;
+    /**
+     * Get a Conversation
+     * @param id - the Conversation's id
+     * @returns the `Conversation`
+     */
+    getConversation(cid: string): Promise<Conversation>;
+    /**
+     * Leave a Conversation
+     * @param id - the Conversation's id
+     * @returns void
+     */
+    leaveConversation(id: string): Promise<void>;
+    /**
+     * Join a Conversation
+     * @param id - the Conversation's id
+     * @returns the `memberId` of the member
+     */
+    joinConversation(id: string): Promise<string>;
+    /**
+     * Delete a Conversation
+     * @param id - the Conversation's id
+     * @returns void
+     */
+    deleteConversation(id: string): Promise<void>;
+    /**
+     * Invite a user to a Conversation by user's `name`
+     * @param id - the Conversation's id
+     * @param name - the namne of the user to invite
+     * @returns the `memberId` of the member
+     */
+    inviteToConversation(id: string, name: string): Promise<string>;
+    /**
+     * Send a text message to a Conversation
+     * @param id - the Conversation's id
+     * @param text - the Body of the message
+     * @returns the `timestamp` of the message
+     */
+    sendTextMessage(id: string, text: string): Promise<string>;
+    /**
+     * Send a custom message to a Conversation
+     * @param id - the Conversation's id
+     * @param customData - the body of the message
+     * @returns the `timestamp` of the message
+     */
+    sendCustomMessage(id: string, customData: JSONValue): Promise<string>;
+    /**
+     * Get a Member of a Conversation
+     * @param cid - the Conversation's id
+     * @param mid - the Member's id
+     * @returns the `Member`
+     */
+    getConversationMember(cid: string, mid: string): Promise<Member>;
 }
 export default VonageClient;