@vonage/client-sdk 1.3.0-alpha.2 → 1.3.0-alpha.4

package/dist/client/VonageClient.d.ts

@@ -1,7 +1,7 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject, Json, CustomData } from '../utils';
+import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder, ClientInitConfigObject, ClientConfigObject, Json, CustomData, Location, Template, Whatsapp, CreateConversationParameters, GetConversationsParameters, OrderBy, GetConversationEventsParameters, GetConversationMembersParameters } from '../utils';
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
-import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnions';
+import { ConversationEvent } from '../kotlin/JsUnions';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
  * For the Vonage Voice and Messaging APIs.
@@ -14,15 +14,9 @@ import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnio
  * @packageDocumentation
  */
 export * from '../utils';
-export interface EventsPage extends vonage.EventsPageJS {
-    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;
@@ -39,10 +33,6 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
 export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
 export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
 export type RtcStats = vonage.RTCStatsJS;
-export type CreateConversationParameters = Omit<vonage.CreateConversationParametersJS, 'ttl' | 'customData'> & {
-    ttl?: Nullable<number>;
-    customData?: Nullable<CustomData>;
-};
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
  *
@@ -190,9 +180,21 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      *
      * @group Chat
      * @beta
+     * @param parameters - A {@link GetConversationsParameters} object containing the parameters for the request.
+     * @returns a `ConversationsPage` containing the conversations
+     */
+    getConversations(parameters?: Nullable<GetConversationsParameters>): Promise<ConversationsPage>;
+    /**
+     * Get a list of Conversations for the user.
+     *
+     * @deprecated Use {@link getConversations(parameters)} instead.
+     * @group Chat
+     * @beta
      * @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)
+     * @param includeCustomData - include custom data (default: false)
+     * @param orderBy - order by strategy (default: null)
      * @returns a `ConversationsPage` containing the conversations
      */
     getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null, includeCustomData?: boolean, orderBy?: OrderBy | null): Promise<ConversationsPage>;
@@ -205,18 +207,30 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @group Chat
      * @beta
      * @param id - the Conversation's id
+     * @param parameters - A {@link GetConversationEventsParameters} object containing the parameters for the request.
+     * @returns a {@link EventsPage} containing the events
+     */
+    getConversationEvents(id: string, parameters?: Nullable<GetConversationEventsParameters>): Promise<EventsPage>;
+    /**
+     * Get a Conversation's Events
+     *
+     * @deprecated Use {@link getConversationEvents(id, parameters)} instead.
+     * @group Chat
+     * @beta
+     * @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)
      * @param eventFilter - the event types to filter by (default: null)
      * @param includeDeletedEvents - A boolean, which when sent as true, will include `deletedEvents` in the list, default is false
-     * @returns a `EventsPage` containing the events
+     * @param startId - A number, the starting id of the events to be returned (default: null)
+     * @returns a {@link 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, includeDeletedEvents?: boolean): Promise<EventPage>;
+    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null, includeDeletedEvents?: boolean, startId?: number): Promise<EventsPage>;
     /**
      * Get a Conversation's Members
      *
@@ -226,6 +240,17 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @group Chat
      * @beta
      * @param id - the Conversation's id
+     * @param parameters - A {@link GetConversationMembersParameters} object containing the parameters for the request.
+     * @returns a `MembersPage` containing the members
+     */
+    getConversationMembers(id: string, parameters?: Nullable<GetConversationMembersParameters>): Promise<MembersPage>;
+    /**
+     * Get a Conversation's Members
+     *
+     * @deprecated Use {@link getConversationMembers(id, parameters)} instead.
+     * @group Chat
+     * @beta
+     * @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)
@@ -240,21 +265,32 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      *
      * @group Chat
      * @beta
-     * @param parameters - A [CreateConversationParameters] object containing the parameters for the creation request.
+     * @param parameters - A {@link CreateConversationParameters} object containing the parameters for the creation request.
      *
      * @returns the `cid` of the conversation
      */
     createConversation(parameters?: Nullable<CreateConversationParameters>): Promise<string>;
+    /**
+     * Create a conversation
+     *
+     * @deprecated Use {@link createConversation(parameters)} instead.
+     * @group Chat
+     * @beta
+     * @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
      *
      * @example
      * [[include: snippet_GetConversation.txt]]
      *
-     * @param id - the Conversation's id
+     * @param conversationIdOrName - the Conversation's id or conversation name
      * @returns the `Conversation`
      */
-    getConversation(cid: string): Promise<Conversation>;
+    getConversation(conversationIdOrName: string): Promise<Conversation>;
     /**
      * Leave a Conversation
      *
@@ -343,6 +379,85 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendMessageImageEvent(id: string, imageUrl: URL): Promise<string>;
+    /**
+     * Send a Vidoe message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendVideoMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param videoUrl - the url of the video resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageVideoEvent(id: string, videoUrl: URL): Promise<string>;
+    /**
+     * Send a file message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendFileMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param fileUrl - the url of the file resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageFileEvent(id: string, fileUrl: URL): Promise<string>;
+    /**
+     * Send a audio message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendAudioMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param audioUrl - the url of the audio resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageAudioEvent(id: string, audioUrl: URL): Promise<string>;
+    /**
+     * Send a vcard message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendVCardMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param vCardUrl - the url of the vCardUrl resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageVCardEvent(id: string, vCardUrl: URL): Promise<string>;
+    /**
+     * Send a Location message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendLocationMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param location - the description of the location.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageLocationEvent(id: string, location: Location): Promise<string>;
+    /**
+     * Send a template message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendMessageTemplateEvent.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param whatsappObject - the description(locale and policies of business account) of the location.
+     * @param templateObject - the description(name and paramters) of the template.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageTemplateEvent(id: string, templateObject: Template, whatsappObject: Whatsapp): Promise<string>;
     /**
      * Send an ephemeral event to a Conversation
      *
@@ -356,6 +471,20 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendEphemeralEvent(id: string, customData: CustomData): Promise<string>;
+    /**
+     * Send a Custom event to a Conversation
+     *
+     * @example
+     * [[include: snippet_SendCustomEvent.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param type - the type of the custom event. Type must start with `custom:<...>`
+     * @param customData - the body of the event
+     * @returns the `timestamp` of the message
+     */
+    sendCustomEvent(id: string, eventType: string, customData: CustomData): Promise<string>;
     /**
      * Delete an Event in a Conversation
      *