@vonage/client-sdk 1.3.0-alpha.3 → 1.3.0-alpha.5

package/dist/client/VonageClient.d.ts

@@ -1,5 +1,5 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder, ClientInitConfigObject, ClientConfigObject, Json, CustomData, CreateConversationParameters, GetConversationsParameters, OrderBy, GetConversationEventsParameters, GetConversationMembersParameters } from '../utils';
+import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder, ClientInitConfigObject, ClientConfigObject, Json, CustomData, Location, Template, Whatsapp, CreateConversationParameters, GetConversationsParameters, OrderBy, GetConversationEventsParameters, GetConversationMembersParameters, UpdateConversationParameters, ResetConversationParameters } from '../utils';
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import { ConversationEvent } from '../kotlin/JsUnions';
 /**
@@ -291,6 +291,33 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `Conversation`
      */
     getConversation(conversationIdOrName: string): Promise<Conversation>;
+    /**
+     * Reset a complete conversation object identified by its unique conversation ID.
+     *
+     * This method resets the conversation to its default, except for the provided parameters.
+     *
+     * @example
+     * [[include: snippet_replaceConversation.txt]]
+     *
+     * @param conversationId - the Conversation's id.
+     * @param parameters - The properties of the conversation. If specified, these will replace existing values,
+     *        otherwise they will be reset to defaults or set to null.
+     * @returns `conversation`, this object will contain the updated conversation properties if the update is successful.
+     */
+    resetConversation(conversationId: string, parameters?: Nullable<ResetConversationParameters>): Promise<Conversation>;
+    /**
+     * Updates a conversation object identified by its unique conversation ID.
+     *
+     * This method overrides the conversation properties to the provided parameters and rest remains as it is.
+     *
+     * @example
+     * [[include: snippet_updateConversation.txt]]
+     *
+     * @param conversationId - the Conversation's id.
+     * @param parameters - The properties of the conversation. These will replace existing values to the provided ones, rest will remain as they are.
+     * @returns `conversation`, this object will contain the updated conversation properties if the update is successful.
+     */
+    updateConversation(conversationId: string, parameters: UpdateConversationParameters): Promise<Conversation>;
     /**
      * Leave a Conversation
      *
@@ -379,6 +406,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
      *
@@ -392,6 +498,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
      *