@vonage/client-sdk 2.1.2 → 2.1.3-snapshot.141.0

package/api_docs/ts/classes/VonageClient.html

@@ -199,9 +199,10 @@ We recommend unregistering callbacks when you no longer need them. See <a href="
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
 <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendTemplateMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
 </code><button>Copy</button></pre>
-</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTemplateEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTextEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span><a href="#sendMessageTextEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendMessageTextEvent.sendMessageTextEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Text<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageTextEvent.sendMessageTextEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
+</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTemplateEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTextEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span><a href="#sendMessageTextEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sendMessageTextEvent.sendMessageTextEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Text<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span>, <span class="tsd-kind-parameter">raw</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageTextEvent.sendMessageTextEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Body of the message</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">raw</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><p>whether to send the text as raw or not (default: false, not recommended)</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
 <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendTextMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
 </code><button>Copy</button></pre>

package/dist/client/VonageClient.d.ts

@@ -401,9 +401,10 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @group Chat
      * @param id - the Conversation's id
      * @param text - the Body of the message
+     * @param raw - whether to send the text as raw or not (default: false, not recommended)
      * @returns the `timestamp` of the message
      */
-    sendMessageTextEvent(id: string, text: string): Promise<string>;
+    sendMessageTextEvent(id: string, text: string, raw?: boolean): Promise<string>;
     /**
      * Send a custom message to a Conversation
      *