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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/README.md +9 -6
  2. package/api_docs/ts/assets/navigation.js +1 -1
  3. package/api_docs/ts/assets/search.js +1 -1
  4. package/api_docs/ts/classes/ClientConfig.html +17 -13
  5. package/api_docs/ts/classes/ClientInitConfig.html +18 -14
  6. package/api_docs/ts/classes/VonageClient.html +199 -198
  7. package/api_docs/ts/functions/setDefaultLoggingLevel.html +16 -12
  8. package/api_docs/ts/functions/setVonageClientLoggingLevel.html +16 -12
  9. package/api_docs/ts/index.html +16 -12
  10. package/api_docs/ts/interfaces/ConversationEvent.html +16 -12
  11. package/api_docs/ts/interfaces/ConversationState.html +15 -11
  12. package/api_docs/ts/interfaces/CustomConversationEvent.html +15 -11
  13. package/api_docs/ts/interfaces/EmbeddedInfo.html +15 -11
  14. package/api_docs/ts/interfaces/EphemeralConversationEvent.html +15 -11
  15. package/api_docs/ts/interfaces/{EventsPage.html → EventDeleteConversationEvent.html} +100 -38
  16. package/api_docs/ts/interfaces/From.html +15 -11
  17. package/api_docs/ts/interfaces/MemberInvitedEvent.html +15 -11
  18. package/api_docs/ts/interfaces/MemberJoinedEvent.html +15 -11
  19. package/api_docs/ts/interfaces/MemberLeftEvent.html +15 -11
  20. package/api_docs/ts/interfaces/MemberState.html +15 -11
  21. package/api_docs/ts/interfaces/MessageAudioEvent.html +15 -11
  22. package/api_docs/ts/interfaces/MessageCustomEvent.html +15 -11
  23. package/api_docs/ts/interfaces/MessageFileEvent.html +15 -11
  24. package/api_docs/ts/interfaces/MessageImageEvent.html +15 -11
  25. package/api_docs/ts/interfaces/MessageLocationEvent.html +15 -11
  26. package/api_docs/ts/interfaces/MessageTemplateEvent.html +15 -11
  27. package/api_docs/ts/interfaces/MessageTextEvent.html +15 -11
  28. package/api_docs/ts/interfaces/MessageVCardEvent.html +15 -11
  29. package/api_docs/ts/interfaces/MessageVideoEvent.html +15 -11
  30. package/api_docs/ts/interfaces/NonPersistentConversationEvent.html +15 -11
  31. package/api_docs/ts/interfaces/PersistentConversationEvent.html +17 -13
  32. package/api_docs/ts/interfaces/System.html +16 -33
  33. package/api_docs/ts/modules.html +19 -65
  34. package/api_docs/ts/types/CustomData.html +16 -12
  35. package/dist/client/VonageClient.d.ts +53 -17
  36. package/dist/client/index.cjs +19490 -18957
  37. package/dist/client/index.mjs +19490 -18957
  38. package/dist/kotlin/JsUnions.d.ts +17 -2
  39. package/dist/kotlin/clientsdk-clientcore_js.d.ts +49 -77
  40. package/dist/utils/ConversationModels.d.ts +4 -1
  41. package/dist/utils/RequestParameterModels.d.ts +17 -0
  42. package/dist/utils/index.d.ts +1 -0
  43. package/dist/vonageClientSDK.js +19066 -18543
  44. package/dist/vonageClientSDK.min.js +1 -1
  45. package/dist/vonageClientSDK.min.mjs +1 -1
  46. package/dist/vonageClientSDK.mjs +19066 -18543
  47. package/package.json +3 -2
  48. package/scripts/replaceAllDoNotUseOrImplement.js +25 -0
  49. package/typedoc.json +40 -0
  50. package/api_docs/ts/functions/convertInitConfig.html +0 -70
  51. package/api_docs/ts/functions/createVonageLogger.html +0 -91
  52. package/api_docs/ts/types/CallDisconnectReason.html +0 -61
  53. package/api_docs/ts/types/CallSayParams.html +0 -66
  54. package/api_docs/ts/types/CancelReason.html +0 -61
  55. package/api_docs/ts/types/ChannelType.html +0 -61
  56. package/api_docs/ts/types/ClientConfigObject.html +0 -61
  57. package/api_docs/ts/types/ClientInitConfigObject.html +0 -61
  58. package/api_docs/ts/types/ConfigRegion.html +0 -61
  59. package/api_docs/ts/types/Conversation.html +0 -68
  60. package/api_docs/ts/types/ConversationsPage.html +0 -66
  61. package/api_docs/ts/types/CreateConversationParameters.html +0 -68
  62. package/api_docs/ts/types/HangupReason.html +0 -61
  63. package/api_docs/ts/types/Json.html +0 -66
  64. package/api_docs/ts/types/JsonValue.html +0 -61
  65. package/api_docs/ts/types/Leg.html +0 -61
  66. package/api_docs/ts/types/LegStatus.html +0 -61
  67. package/api_docs/ts/types/LoggingLevel.html +0 -61
  68. package/api_docs/ts/types/Member.html +0 -66
  69. package/api_docs/ts/types/MembersPage.html +0 -66
  70. package/api_docs/ts/types/OrderBy.html +0 -61
  71. package/api_docs/ts/types/PresentingOrder.html +0 -61
  72. package/api_docs/ts/types/RTCQuality.html +0 -61
  73. package/api_docs/ts/types/RtcStats.html +0 -61
  74. package/api_docs/ts/types/SessionErrorReason.html +0 -61
  75. package/api_docs/ts/types/Topic.html +0 -61
  76. package/api_docs/ts/types/Topics.html +0 -61
  77. package/api_docs/ts/types/User.html +0 -61
  78. package/api_docs/ts/types/VonageError.html +0 -61
  79. package/api_docs/ts/types/VonageErrorType.html +0 -61
  80. package/api_docs/ts/types/VonageLogger.html +0 -61
  81. package/api_docs/ts/variables/CSErrorCodes.html +0 -82
  82. package/api_docs/ts/variables/CallDisconnectReason-1.html +0 -61
  83. package/api_docs/ts/variables/CancelReason-1.html +0 -61
  84. package/api_docs/ts/variables/ChannelType-1.html +0 -61
  85. package/api_docs/ts/variables/ConfigRegion-1.html +0 -61
  86. package/api_docs/ts/variables/HangupReason-1.html +0 -61
  87. package/api_docs/ts/variables/LegStatus-1.html +0 -61
  88. package/api_docs/ts/variables/LoggingLevel-1.html +0 -61
  89. package/api_docs/ts/variables/OrderBy-1.html +0 -61
  90. package/api_docs/ts/variables/PresentingOrder-1.html +0 -61
  91. package/api_docs/ts/variables/SessionErrorCodes.html +0 -96
  92. package/api_docs/ts/variables/SessionErrorReason-1.html +0 -61
  93. package/api_docs/ts/variables/Topic-1.html +0 -61
  94. package/api_docs/ts/variables/Topics-1.html +0 -61
  95. package/api_docs/ts/variables/VonageError-1.html +0 -61
  96. package/api_docs/ts/variables/VonageErrorType-1.html +0 -61
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VonageClient | @vonage/client-sdk - v1.3.0-alpha.2</title><meta name="description" content="Documentation for @vonage/client-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VonageClient | @vonage/client-sdk - v0.0.0</title><meta name="description" content="Documentation for @vonage/client-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vonage/client-sdk - v1.3.0-alpha.2</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vonage/client-sdk - v0.0.0</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -31,19 +31,16 @@
31
31
  <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
32
32
  <div class="tsd-accordion-details">
33
33
  <section class="tsd-index-section">
34
- <h3 class="tsd-index-heading">Constructors</h3>
35
- <div class="tsd-index-list"><a href="VonageClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
34
+ <h3 class="tsd-index-heading">Properties</h3>
35
+ <div class="tsd-index-list"><a href="VonageClient.html#__doNotUseOrImplementIt" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span></a>
36
36
  </div></section>
37
37
  <section class="tsd-index-section">
38
38
  <h3 class="tsd-index-heading">Methods</h3>
39
39
  <div class="tsd-index-list"><a href="VonageClient.html#clearCallbacks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a>
40
40
  <a href="VonageClient.html#createSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Session</span></a>
41
- <a href="VonageClient.html#deleteSession" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Session</span></a>
42
41
  <a href="VonageClient.html#getConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a>
43
- <a href="VonageClient.html#getUser" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User</span></a>
44
42
  <a href="VonageClient.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
45
43
  <a href="VonageClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
46
- <a href="VonageClient.html#refreshSession" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>refresh<wbr/>Session</span></a>
47
44
  <a href="VonageClient.html#setConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Config</span></a>
48
45
  </div></section>
49
46
  <section class="tsd-index-section">
@@ -80,19 +77,26 @@
80
77
  <a href="VonageClient.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
81
78
  </div></section></div></details></section></section>
82
79
  <section class="tsd-panel-group tsd-member-group">
83
- <h2>Constructors</h2>
84
- <section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
85
- <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
86
- <ul class="tsd-signatures">
87
- <li class="tsd-signature tsd-anchor-link" id="constructor.new_VonageClient"><span class="tsd-kind-constructor-signature">new <wbr/>Vonage<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VonageClient.html" class="tsd-signature-type tsd-kind-class">VonageClient</a><a href="#constructor.new_VonageClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
88
- <li class="tsd-description">
89
- <div class="tsd-parameters">
90
- <h4 class="tsd-parameters-title">Parameters</h4>
91
- <ul class="tsd-parameter-list">
92
- <li>
93
- <h5><span class="tsd-kind-parameter">config</span>: <a href="../types/ClientInitConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientInitConfigObject</a><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
94
- <h4 class="tsd-returns-title">Returns <a href="VonageClient.html" class="tsd-signature-type tsd-kind-class">VonageClient</a></h4><aside class="tsd-sources">
95
- <p>Overrides vonage.CombinedClientJS.constructor</p></aside></li></ul></section></section>
80
+ <h2>Properties</h2>
81
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="__doNotUseOrImplementIt" class="tsd-anchor"></a>
82
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><a href="#__doNotUseOrImplementIt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
83
+ <div class="tsd-signature"><span class="tsd-kind-property">__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">vonage.IChatClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IChatClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">vonage.ICoreClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.ICoreClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">vonage.IVoiceClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IVoiceClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
84
+ <div class="tsd-type-declaration">
85
+ <h4>Type declaration</h4>
86
+ <ul class="tsd-parameters">
87
+ <li class="tsd-parameter">
88
+ <h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.IChat<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IChatClientJS</a></h5></li></ul></div>
89
+ <div class="tsd-type-declaration">
90
+ <h4>Type declaration</h4>
91
+ <ul class="tsd-parameters">
92
+ <li class="tsd-parameter">
93
+ <h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.ICore<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.ICoreClientJS</a></h5></li></ul></div>
94
+ <div class="tsd-type-declaration">
95
+ <h4>Type declaration</h4>
96
+ <ul class="tsd-parameters">
97
+ <li class="tsd-parameter">
98
+ <h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.IVoice<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IVoiceClientJS</a></h5></li></ul></div><aside class="tsd-sources">
99
+ <p>Inherited from vonage.CombinedClientJS.__doNotUseOrImplementIt</p></aside></section></section>
96
100
  <section class="tsd-panel-group tsd-member-group">
97
101
  <h2>Methods</h2>
98
102
  <section class="tsd-panel tsd-member"><a id="clearCallbacks" class="tsd-anchor"></a>
@@ -118,7 +122,7 @@
118
122
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
119
123
 
120
124
  <div class="tsd-comment tsd-typography">
121
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">clearCallbacks</span><span class="hl-1">(</span><span class="hl-2">&#39;sessionError&#39;</span><span class="hl-1">);</span>
125
+ <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_ClearCallbacks</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
122
126
  </code><button>Copy</button></pre>
123
127
 
124
128
  <h4>Remarks</h4><p>This is useful for cleaning up callbacks when you no longer need them.</p>
@@ -147,21 +151,14 @@ to resume an existing session.</p>
147
151
  <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>sessionId</code> of the session</p>
148
152
 
149
153
  <div class="tsd-comment tsd-typography">
150
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">token</span><span class="hl-1"> = </span><span class="hl-2">&#39;token&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">sessionId</span><span class="hl-1">: </span><span class="hl-14">string</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">createSession</span><span class="hl-1">(</span><span class="hl-4">token</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">({ </span><span class="hl-4">sessionId</span><span class="hl-1"> });</span><br/><span class="hl-1">} </span><span class="hl-3">catch</span><span class="hl-1"> (</span><span class="hl-4">e</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">({ </span><span class="hl-4">e</span><span class="hl-1"> });</span><br/><span class="hl-1">}</span>
154
+ <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_SessionCreate</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
151
155
  </code><button>Copy</button></pre>
152
156
  </div><aside class="tsd-sources">
153
157
  <p>Overrides vonage.CombinedClientJS.createSession</p></aside></li></ul></section>
154
- <section class="tsd-panel tsd-member tsd-is-inherited"><a id="deleteSession" class="tsd-anchor"></a>
155
- <h3 class="tsd-anchor-link"><span>delete<wbr/>Session</span><a href="#deleteSession" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
156
- <ul class="tsd-signatures tsd-is-inherited">
157
- <li class="tsd-signature tsd-anchor-link" id="deleteSession.deleteSession-1"><span class="tsd-kind-call-signature">delete<wbr/>Session</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteSession.deleteSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
158
- <li class="tsd-description">
159
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
160
- <p>Inherited from vonage.CombinedClientJS.deleteSession</p></aside></li></ul></section>
161
158
  <section class="tsd-panel tsd-member"><a id="getConversation" class="tsd-anchor"></a>
162
159
  <h3 class="tsd-anchor-link"><span>get<wbr/>Conversation</span><a href="#getConversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
163
160
  <ul class="tsd-signatures">
164
- <li class="tsd-signature tsd-anchor-link" id="getConversation.getConversation-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</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><a href="../types/Conversation.html" class="tsd-signature-type tsd-kind-type-alias">Conversation</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
161
+ <li class="tsd-signature tsd-anchor-link" id="getConversation.getConversation-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationIdOrName</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 ">Conversation</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
165
162
  <li class="tsd-description">
166
163
  <div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
167
164
  </div>
@@ -169,26 +166,17 @@ to resume an existing session.</p>
169
166
  <h4 class="tsd-parameters-title">Parameters</h4>
170
167
  <ul class="tsd-parameter-list">
171
168
  <li>
172
- <h5><span class="tsd-kind-parameter">cid</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
173
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Conversation.html" class="tsd-signature-type tsd-kind-type-alias">Conversation</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Conversation</code></p>
169
+ <h5><span class="tsd-kind-parameter">conversationIdOrName</span>: <span class="tsd-signature-type">string</span></h5>
170
+ <div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id or conversation name</p>
171
+ </div>
172
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
173
+ <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 ">Conversation</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Conversation</code></p>
174
174
 
175
175
  <div class="tsd-comment tsd-typography">
176
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">conversation</span><span class="hl-1">: </span><span class="hl-14">Conversation</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">getConversation</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;test-conv-id&#39;</span><br/><span class="hl-1"> );</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">({ </span><span class="hl-4">conversation</span><span class="hl-1"> });</span><br/><span class="hl-1">} </span><span class="hl-3">catch</span><span class="hl-1"> (</span><span class="hl-4">e</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">({ </span><span class="hl-4">e</span><span class="hl-1"> });</span><br/><span class="hl-1">}</span>
176
+ <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_GetConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
177
177
  </code><button>Copy</button></pre>
178
178
  </div><aside class="tsd-sources">
179
179
  <p>Overrides vonage.CombinedClientJS.getConversation</p></aside></li></ul></section>
180
- <section class="tsd-panel tsd-member tsd-is-inherited"><a id="getUser" class="tsd-anchor"></a>
181
- <h3 class="tsd-anchor-link"><span>get<wbr/>User</span><a href="#getUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
182
- <ul class="tsd-signatures tsd-is-inherited">
183
- <li class="tsd-signature tsd-anchor-link" id="getUser.getUser-1"><span class="tsd-kind-call-signature">get<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userIdOrName</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 ">UserJS</span><span class="tsd-signature-symbol">&gt;</span><a href="#getUser.getUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
184
- <li class="tsd-description">
185
- <div class="tsd-parameters">
186
- <h4 class="tsd-parameters-title">Parameters</h4>
187
- <ul class="tsd-parameter-list">
188
- <li>
189
- <h5><span class="tsd-kind-parameter">userIdOrName</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
190
- <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 ">UserJS</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
191
- <p>Inherited from vonage.CombinedClientJS.getUser</p></aside></li></ul></section>
192
180
  <section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a>
193
181
  <h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
194
182
  <ul class="tsd-signatures">
@@ -217,7 +205,7 @@ to resume an existing session.</p>
217
205
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the callback was unregistered, false otherwise</p>
218
206
 
219
207
  <div class="tsd-comment tsd-typography">
220
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">off</span><span class="hl-1">(</span><span class="hl-2">&#39;reconnecting&#39;</span><span class="hl-1">, </span><span class="hl-4">reeconnectingListener</span><span class="hl-1">);</span><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">off</span><span class="hl-1">(</span><span class="hl-2">&#39;reconnection&#39;</span><span class="hl-1">, </span><span class="hl-4">reeconnectionListener</span><span class="hl-1">);</span><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">off</span><span class="hl-1">(</span><span class="hl-2">&#39;sessionError&#39;</span><span class="hl-1">, </span><span class="hl-4">sessionErrorListener</span><span class="hl-1">);</span>
208
+ <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_UnregisterListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
221
209
  </code><button>Copy</button></pre>
222
210
 
223
211
  <h4>Remarks</h4><p>We recommend deregistering callbacks when you no longer need them.</p>
@@ -252,24 +240,12 @@ to resume an existing session.</p>
252
240
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">symbol</span></h4><p>a symbol that can be used to unregister the callback</p>
253
241
 
254
242
  <div class="tsd-comment tsd-typography">
255
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-0">eventHandler</span><span class="hl-1"> = (</span><span class="hl-4">event</span><span class="hl-1">: </span><span class="hl-14">ConversationEvent</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;member:invited&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Member invited: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">memberId</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;member:joined&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Member joined: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">memberId</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;member:left&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Member left: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">memberId</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;ephemeral&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Ephemeral event: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;custom&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Custom event: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:text&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Text message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">text</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:custom&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Custom message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">customData</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:image&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Image message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">imageUrl</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:video&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Video message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">videoUrl</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:audio&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Audio message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">audioUrl</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:file&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`File message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">fileUrl</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:vcard&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Vcard message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">vcardUrl</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:location&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Location message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">location</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">event</span><span class="hl-1">.</span><span class="hl-4">kind</span><span class="hl-1"> == </span><span class="hl-2">&#39;message:template&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`Template message: </span><span class="hl-5">${</span><span class="hl-4">event</span><span class="hl-10">.</span><span class="hl-4">body</span><span class="hl-10">.</span><span class="hl-4">template</span><span class="hl-5">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-3">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">exhaustiveCheck</span><span class="hl-1">(</span><span class="hl-4">event</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">listener</span><span class="hl-1"> = </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">&#39;conversationEvent&#39;</span><span class="hl-1">, </span><span class="hl-4">eventHandler</span><span class="hl-1">);</span><br/><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">off</span><span class="hl-1">(</span><span class="hl-2">&#39;conversationEvent&#39;</span><span class="hl-1">, </span><span class="hl-4">listener</span><span class="hl-1">);</span>
243
+ <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_OnConversationEventListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
256
244
  </code><button>Copy</button></pre>
257
245
 
258
246
  <h4>Remarks</h4><p>Besure to store the symbol returned by this method so you can unregister the callback later.
259
247
  We recommend deregistering callbacks when you no longer need them. See <a href="VonageClient.html#off" class="tsd-kind-method">off</a>.</p>
260
248
  </div></li></ul></section>
261
- <section class="tsd-panel tsd-member tsd-is-inherited"><a id="refreshSession" class="tsd-anchor"></a>
262
- <h3 class="tsd-anchor-link"><span>refresh<wbr/>Session</span><a href="#refreshSession" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
263
- <ul class="tsd-signatures tsd-is-inherited">
264
- <li class="tsd-signature tsd-anchor-link" id="refreshSession.refreshSession-1"><span class="tsd-kind-call-signature">refresh<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#refreshSession.refreshSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
265
- <li class="tsd-description">
266
- <div class="tsd-parameters">
267
- <h4 class="tsd-parameters-title">Parameters</h4>
268
- <ul class="tsd-parameter-list">
269
- <li>
270
- <h5><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
271
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
272
- <p>Inherited from vonage.CombinedClientJS.refreshSession</p></aside></li></ul></section>
273
249
  <section class="tsd-panel tsd-member"><a id="setConfig" class="tsd-anchor"></a>
274
250
  <h3 class="tsd-anchor-link"><span>set<wbr/>Config</span><a href="#setConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
275
251
  <ul class="tsd-signatures">
@@ -281,14 +257,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
281
257
  <h4 class="tsd-parameters-title">Parameters</h4>
282
258
  <ul class="tsd-parameter-list">
283
259
  <li>
284
- <h5><span class="tsd-kind-parameter">config</span>: <a href="../types/ClientConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientConfigObject</a></h5>
260
+ <h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type ">ClientConfigObject</span></h5>
285
261
  <div class="tsd-comment tsd-typography"><p>A configuration object</p>
286
262
  </div>
287
263
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
288
264
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
289
265
 
290
266
  <div class="tsd-comment tsd-typography">
291
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">config</span><span class="hl-1">: </span><span class="hl-14">ClientConfig</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">ClientConfig</span><span class="hl-1">(</span><span class="hl-4">ConfigRegion</span><span class="hl-1">.</span><span class="hl-6">EU</span><span class="hl-1">);</span><br/><span class="hl-4">config</span><span class="hl-1">.</span><span class="hl-4">apiUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;https://api.example.com&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">config</span><span class="hl-1">.</span><span class="hl-4">websocketUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;https://ws.example.com&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">setConfig</span><span class="hl-1">(</span><span class="hl-4">config</span><span class="hl-1">);</span><br/><span class="hl-7">// or</span><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">setConfig</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">apiUrl:</span><span class="hl-1"> </span><span class="hl-2">&#39;https://api.example.com&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">websocketUrl:</span><span class="hl-1"> </span><span class="hl-2">&#39;https://ws.example.com&#39;</span><br/><span class="hl-1">});</span><br/><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">setConfig</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">region:</span><span class="hl-1"> </span><span class="hl-2">&#39;EU&#39;</span><br/><span class="hl-1">});</span>
267
+ <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_SetClientConfig</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
292
268
  </code><button>Copy</button></pre>
293
269
  </div><aside class="tsd-sources">
294
270
  <p>Overrides vonage.CombinedClientJS.setConfig</p></aside></li></ul></section></section>
@@ -305,16 +281,39 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
305
281
  <h4 class="tsd-parameters-title">Parameters</h4>
306
282
  <ul class="tsd-parameter-list">
307
283
  <li>
308
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/CreateConversationParameters.html" class="tsd-signature-type tsd-kind-type-alias">CreateConversationParameters</a><span class="tsd-signature-symbol">&gt;</span></h5>
309
- <div class="tsd-comment tsd-typography"><p>A [CreateConversationParameters] object containing the parameters for the creation request.</p>
284
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">CreateConversationParameters</span><span class="tsd-signature-symbol">&gt;</span></h5>
285
+ <div class="tsd-comment tsd-typography"><p>A CreateConversationParameters object containing the parameters for the creation request.</p>
310
286
  </div>
311
287
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
312
288
  <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>cid</code> of the conversation</p>
313
289
 
314
290
  <div class="tsd-comment tsd-typography">
315
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">conversationId</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">createConversation</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">&#39;name&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">displayName:</span><span class="hl-1"> </span><span class="hl-2">&#39;displayName&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">imageUrl:</span><span class="hl-1"> </span><span class="hl-2">&#39;imageUrl&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">ttl:</span><span class="hl-1"> </span><span class="hl-13">10</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">customSortKey:</span><span class="hl-1"> </span><span class="hl-2">&#39;customSortKey&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">customData:</span><span class="hl-1"> { </span><span class="hl-4">key:</span><span class="hl-1"> </span><span class="hl-2">&#39;value&#39;</span><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
291
+ <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_CreateConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
316
292
  </code><button>Copy</button></pre>
317
293
  </div><aside class="tsd-sources">
294
+ <p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li>
295
+ <li class="tsd-signature tsd-anchor-link" id="createConversation.createConversation-2"><span class="tsd-kind-call-signature">create<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">displayName</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="#createConversation.createConversation-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
296
+ <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
297
+ <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
298
+ </div>
299
+ <div class="tsd-parameters">
300
+ <h4 class="tsd-parameters-title">Parameters</h4>
301
+ <ul class="tsd-parameter-list">
302
+ <li>
303
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
304
+ <div class="tsd-comment tsd-typography"><p>the name of the conversation</p>
305
+ </div>
306
+ <div class="tsd-comment tsd-typography"></div></li>
307
+ <li>
308
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">displayName</span>: <span class="tsd-signature-type">string</span></h5>
309
+ <div class="tsd-comment tsd-typography"><p>the display name of the conversation</p>
310
+ </div>
311
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
312
+ <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>cid</code> of the conversation</p>
313
+
314
+ <div class="tsd-comment tsd-typography">
315
+ <h4>Deprecated</h4><p>Use <a href="VonageClient.html#createConversation" class="tsd-kind-method">(parameters)</a> instead.</p>
316
+ </div><aside class="tsd-sources">
318
317
  <p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li></ul></section>
319
318
  <section class="tsd-panel tsd-member"><a id="deleteConversation" class="tsd-anchor"></a>
320
319
  <h3 class="tsd-anchor-link"><span>delete<wbr/>Conversation</span><a href="#deleteConversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
@@ -334,7 +333,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
334
333
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
335
334
 
336
335
  <div class="tsd-comment tsd-typography">
337
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">deleteConversation</span><span class="hl-1">(</span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">);</span>
336
+ <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_DeleteConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
338
337
  </code><button>Copy</button></pre>
339
338
  </div><aside class="tsd-sources">
340
339
  <p>Overrides vonage.CombinedClientJS.deleteConversation</p></aside></li></ul></section>
@@ -361,14 +360,38 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
361
360
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
362
361
 
363
362
  <div class="tsd-comment tsd-typography">
364
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">deleteEvent</span><span class="hl-1">(</span><span class="hl-13">123</span><span class="hl-1">, </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">);</span>
363
+ <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_DeleteEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
365
364
  </code><button>Copy</button></pre>
366
365
  </div><aside class="tsd-sources">
367
366
  <p>Overrides vonage.CombinedClientJS.deleteEvent</p></aside></li></ul></section>
368
367
  <section class="tsd-panel tsd-member"><a id="getConversationEvents" class="tsd-anchor"></a>
369
368
  <h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Events</span><a href="#getConversationEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
370
369
  <ul class="tsd-signatures">
371
- <li class="tsd-signature tsd-anchor-link" id="getConversationEvents.getConversationEvents-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">eventFilter</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeDeletedEvents</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 ">EventPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationEvents.getConversationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
370
+ <li class="tsd-signature tsd-anchor-link" id="getConversationEvents.getConversationEvents-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</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 ">EventsPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationEvents.getConversationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
371
+ <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
372
+ <div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Events</p>
373
+ </div>
374
+ <div class="tsd-parameters">
375
+ <h4 class="tsd-parameters-title">Parameters</h4>
376
+ <ul class="tsd-parameter-list">
377
+ <li>
378
+ <h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
379
+ <div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
380
+ </div>
381
+ <div class="tsd-comment tsd-typography"></div></li>
382
+ <li>
383
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GetConversationEventsParameters</span><span class="tsd-signature-symbol">&gt;</span></h5>
384
+ <div class="tsd-comment tsd-typography"><p>A GetConversationEventsParameters object containing the parameters for the request.</p>
385
+ </div>
386
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
387
+ <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 ">EventsPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a EventsPage containing the events</p>
388
+
389
+ <div class="tsd-comment tsd-typography">
390
+ <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_GetConversationEvents</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
391
+ </code><button>Copy</button></pre>
392
+ </div><aside class="tsd-sources">
393
+ <p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li>
394
+ <li class="tsd-signature tsd-anchor-link" id="getConversationEvents.getConversationEvents-2"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">eventFilter</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeDeletedEvents</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">startId</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 ">EventsPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationEvents.getConversationEvents-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
372
395
  <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
373
396
  <div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Events</p>
374
397
  </div>
@@ -401,21 +424,25 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
401
424
  </div>
402
425
  <div class="tsd-comment tsd-typography"></div></li>
403
426
  <li>
404
- <h5><span class="tsd-kind-parameter">includeDeletedEvents</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
427
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">includeDeletedEvents</span>: <span class="tsd-signature-type">boolean</span></h5>
405
428
  <div class="tsd-comment tsd-typography"><p>A boolean, which when sent as true, will include <code>deletedEvents</code> in the list, default is false</p>
406
429
  </div>
430
+ <div class="tsd-comment tsd-typography"></div></li>
431
+ <li>
432
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">startId</span>: <span class="tsd-signature-type">number</span></h5>
433
+ <div class="tsd-comment tsd-typography"><p>A number, the starting id of the events to be returned (default: null)</p>
434
+ </div>
407
435
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
408
- <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 ">EventPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>EventsPage</code> containing the events</p>
436
+ <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 ">EventsPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a EventsPage containing the events</p>
409
437
 
410
438
  <div class="tsd-comment tsd-typography">
411
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">events</span><span class="hl-1">, </span><span class="hl-6">nextCursor</span><span class="hl-1">, </span><span class="hl-6">previousCursor</span><span class="hl-1"> } =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">getConversationEvents</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">PresentingOrder</span><span class="hl-1">.</span><span class="hl-6">ASC</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-13">10</span><span class="hl-1">, </span><span class="hl-7">// page size</span><br/><span class="hl-1"> </span><span class="hl-5">undefined</span><span class="hl-1">, </span><span class="hl-7">// cursor</span><br/><span class="hl-1"> [</span><span class="hl-2">&#39;message&#39;</span><span class="hl-1">], </span><span class="hl-7">// event filter query</span><br/><span class="hl-1"> </span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-7">// includeDeletedEvents</span><br/><span class="hl-1"> );</span>
412
- </code><button>Copy</button></pre>
439
+ <h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversationEvents" class="tsd-kind-method">(id, parameters)</a> instead.</p>
413
440
  </div><aside class="tsd-sources">
414
441
  <p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li></ul></section>
415
442
  <section class="tsd-panel tsd-member"><a id="getConversationMember" class="tsd-anchor"></a>
416
443
  <h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Member</span><a href="#getConversationMember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
417
444
  <ul class="tsd-signatures">
418
- <li class="tsd-signature tsd-anchor-link" id="getConversationMember.getConversationMember-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</span>, <span class="tsd-kind-parameter">mid</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><a href="../types/Member.html" class="tsd-signature-type tsd-kind-type-alias">Member</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMember.getConversationMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
445
+ <li class="tsd-signature tsd-anchor-link" id="getConversationMember.getConversationMember-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</span>, <span class="tsd-kind-parameter">mid</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 ">Member</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMember.getConversationMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
419
446
  <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
420
447
  <div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
421
448
  </div>
@@ -432,17 +459,41 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
432
459
  <div class="tsd-comment tsd-typography"><p>the Member&#39;s id</p>
433
460
  </div>
434
461
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
435
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Member.html" class="tsd-signature-type tsd-kind-type-alias">Member</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Member</code></p>
462
+ <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 ">Member</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Member</code></p>
436
463
 
437
464
  <div class="tsd-comment tsd-typography">
438
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">id</span><span class="hl-1">, </span><span class="hl-6">state</span><span class="hl-1"> } = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">getConversationMember</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;MEMBER_ID&#39;</span><br/><span class="hl-1">);</span>
465
+ <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_GetConversationMember</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
439
466
  </code><button>Copy</button></pre>
440
467
  </div><aside class="tsd-sources">
441
468
  <p>Overrides vonage.CombinedClientJS.getConversationMember</p></aside></li></ul></section>
442
469
  <section class="tsd-panel tsd-member"><a id="getConversationMembers" class="tsd-anchor"></a>
443
470
  <h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Members</span><a href="#getConversationMembers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
444
471
  <ul class="tsd-signatures">
445
- <li class="tsd-signature tsd-anchor-link" id="getConversationMembers.getConversationMembers-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</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><a href="../types/MembersPage.html" class="tsd-signature-type tsd-kind-type-alias">MembersPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMembers.getConversationMembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
472
+ <li class="tsd-signature tsd-anchor-link" id="getConversationMembers.getConversationMembers-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</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 ">MembersPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMembers.getConversationMembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
473
+ <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
474
+ <div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Members</p>
475
+ </div>
476
+ <div class="tsd-parameters">
477
+ <h4 class="tsd-parameters-title">Parameters</h4>
478
+ <ul class="tsd-parameter-list">
479
+ <li>
480
+ <h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
481
+ <div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
482
+ </div>
483
+ <div class="tsd-comment tsd-typography"></div></li>
484
+ <li>
485
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GetConversationMembersParameters</span><span class="tsd-signature-symbol">&gt;</span></h5>
486
+ <div class="tsd-comment tsd-typography"><p>A GetConversationMembersParameters object containing the parameters for the request.</p>
487
+ </div>
488
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
489
+ <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 ">MembersPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>MembersPage</code> containing the members</p>
490
+
491
+ <div class="tsd-comment tsd-typography">
492
+ <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_GetConversationMembers</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
493
+ </code><button>Copy</button></pre>
494
+ </div><aside class="tsd-sources">
495
+ <p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li>
496
+ <li class="tsd-signature tsd-anchor-link" id="getConversationMembers.getConversationMembers-2"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</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 ">MembersPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMembers.getConversationMembers-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
446
497
  <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
447
498
  <div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Members</p>
448
499
  </div>
@@ -469,17 +520,35 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
469
520
  <div class="tsd-comment tsd-typography"><p>the cursor to use for pagination (default: null)</p>
470
521
  </div>
471
522
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
472
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/MembersPage.html" class="tsd-signature-type tsd-kind-type-alias">MembersPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>MembersPage</code> containing the members</p>
523
+ <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 ">MembersPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>MembersPage</code> containing the members</p>
473
524
 
474
525
  <div class="tsd-comment tsd-typography">
475
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">members</span><span class="hl-1">, </span><span class="hl-6">nextCursor</span><span class="hl-1">, </span><span class="hl-6">previousCursor</span><span class="hl-1"> } =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">getConversationMembers</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">PresentingOrder</span><span class="hl-1">.</span><span class="hl-6">ASC</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-13">10</span><span class="hl-1">, </span><span class="hl-7">// page size</span><br/><span class="hl-1"> </span><span class="hl-5">undefined</span><span class="hl-1"> </span><span class="hl-7">// cursor</span><br/><span class="hl-1"> );</span>
476
- </code><button>Copy</button></pre>
526
+ <h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversationMembers" class="tsd-kind-method">(id, parameters)</a> instead.</p>
477
527
  </div><aside class="tsd-sources">
478
528
  <p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li></ul></section>
479
529
  <section class="tsd-panel tsd-member"><a id="getConversations" class="tsd-anchor"></a>
480
530
  <h3 class="tsd-anchor-link"><span>get<wbr/>Conversations</span><a href="#getConversations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
481
531
  <ul class="tsd-signatures">
482
- <li class="tsd-signature tsd-anchor-link" id="getConversations.getConversations-1"><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeCustomData</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">orderBy</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><a href="../types/ConversationsPage.html" class="tsd-signature-type tsd-kind-type-alias">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversations.getConversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
532
+ <li class="tsd-signature tsd-anchor-link" id="getConversations.getConversations-1"><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parameters</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 ">ConversationsPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversations.getConversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
533
+ <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
534
+ <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
535
+ </div>
536
+ <div class="tsd-parameters">
537
+ <h4 class="tsd-parameters-title">Parameters</h4>
538
+ <ul class="tsd-parameter-list">
539
+ <li>
540
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GetConversationsParameters</span><span class="tsd-signature-symbol">&gt;</span></h5>
541
+ <div class="tsd-comment tsd-typography"><p>A GetConversationsParameters object containing the parameters for the request.</p>
542
+ </div>
543
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
544
+ <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 ">ConversationsPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
545
+
546
+ <div class="tsd-comment tsd-typography">
547
+ <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_GetConversations</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
548
+ </code><button>Copy</button></pre>
549
+ </div><aside class="tsd-sources">
550
+ <p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li>
551
+ <li class="tsd-signature tsd-anchor-link" id="getConversations.getConversations-2"><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeCustomData</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">orderBy</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 ">ConversationsPage</span><span class="tsd-signature-symbol">&gt;</span><a href="#getConversations.getConversations-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
483
552
  <li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code>
484
553
  <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
485
554
  </div>
@@ -502,14 +571,19 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
502
571
  </div>
503
572
  <div class="tsd-comment tsd-typography"></div></li>
504
573
  <li>
505
- <h5><span class="tsd-kind-parameter">includeCustomData</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li>
574
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">includeCustomData</span>: <span class="tsd-signature-type">boolean</span></h5>
575
+ <div class="tsd-comment tsd-typography"><p>include custom data (default: false)</p>
576
+ </div>
577
+ <div class="tsd-comment tsd-typography"></div></li>
506
578
  <li>
507
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">orderBy</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">OrderByJS</span></h5></li></ul></div>
508
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ConversationsPage.html" class="tsd-signature-type tsd-kind-type-alias">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
579
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">orderBy</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">OrderByJS</span></h5>
580
+ <div class="tsd-comment tsd-typography"><p>order by strategy (default: null)</p>
581
+ </div>
582
+ <div class="tsd-comment tsd-typography"></div></li></ul></div>
583
+ <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 ">ConversationsPage</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
509
584
 
510
585
  <div class="tsd-comment tsd-typography">
511
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">conversations</span><span class="hl-1">, </span><span class="hl-6">nextCursor</span><span class="hl-1">, </span><span class="hl-6">previousCursor</span><span class="hl-1"> } =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">getConversations</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">PresentingOrder</span><span class="hl-1">.</span><span class="hl-6">ASC</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-13">10</span><span class="hl-1">, </span><span class="hl-7">// page size</span><br/><span class="hl-1"> </span><span class="hl-5">undefined</span><span class="hl-1">, </span><span class="hl-7">// cursor</span><br/><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-7">// include custom data</span><br/><span class="hl-1"> );</span>
512
- </code><button>Copy</button></pre>
586
+ <h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversations" class="tsd-kind-method">(parameters)</a> instead.</p>
513
587
  </div><aside class="tsd-sources">
514
588
  <p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li></ul></section>
515
589
  <section class="tsd-panel tsd-member"><a id="inviteToConversation" class="tsd-anchor"></a>
@@ -535,7 +609,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
535
609
  <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>memberId</code> of the member</p>
536
610
 
537
611
  <div class="tsd-comment tsd-typography">
538
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">conversationId</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">inviteToConversation</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;USERNAME&#39;</span><br/><span class="hl-1">);</span>
612
+ <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_InviteToConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
539
613
  </code><button>Copy</button></pre>
540
614
  </div><aside class="tsd-sources">
541
615
  <p>Overrides vonage.CombinedClientJS.inviteToConversation</p></aside></li></ul></section>
@@ -557,7 +631,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
557
631
  <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>memberId</code> of the member</p>
558
632
 
559
633
  <div class="tsd-comment tsd-typography">
560
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">conversationId</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">joinConversation</span><span class="hl-1">(</span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">);</span>
634
+ <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_JoinConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
561
635
  </code><button>Copy</button></pre>
562
636
  </div><aside class="tsd-sources">
563
637
  <p>Overrides vonage.CombinedClientJS.joinConversation</p></aside></li></ul></section>
@@ -579,7 +653,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
579
653
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
580
654
 
581
655
  <div class="tsd-comment tsd-typography">
582
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">leaveConversation</span><span class="hl-1">(</span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">);</span>
656
+ <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_LeaveConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
583
657
  </code><button>Copy</button></pre>
584
658
  </div><aside class="tsd-sources">
585
659
  <p>Overrides vonage.CombinedClientJS.leaveConversation</p></aside></li></ul></section>
@@ -606,7 +680,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
606
680
  <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>
607
681
 
608
682
  <div class="tsd-comment tsd-typography">
609
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">memberId</span><span class="hl-1"> = </span><span class="hl-2">&#39;MEMBER_ID&#39;</span><span class="hl-1">;</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">readMessageEvent</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">type:</span><span class="hl-1"> </span><span class="hl-2">`</span><span class="hl-5">${</span><span class="hl-4">memberId</span><span class="hl-5">}</span><span class="hl-2">:readUpdate`</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">eventId:</span><span class="hl-1"> </span><span class="hl-2">&#39;EVENT_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">timestamp:</span><span class="hl-1"> </span><span class="hl-2">&#39;TIMESTAMP&#39;</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">timestamp</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">sendEphemeralEvent</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">JSON</span><span class="hl-1">.</span><span class="hl-0">stringify</span><span class="hl-1">(</span><span class="hl-4">readMessageEvent</span><span class="hl-1">) </span><span class="hl-7">// custom data</span><br/><span class="hl-1">);</span>
683
+ <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_SendEphemeralEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
610
684
  </code><button>Copy</button></pre>
611
685
  </div><aside class="tsd-sources">
612
686
  <p>Overrides vonage.CombinedClientJS.sendEphemeralEvent</p></aside></li></ul></section>
@@ -633,7 +707,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
633
707
  <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>
634
708
 
635
709
  <div class="tsd-comment tsd-typography">
636
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">attachmentPayload</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">attachment:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">payload:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">buttons:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">payload:</span><span class="hl-1"> </span><span class="hl-2">&#39;{&quot;&lt;cid&gt;&quot;: &quot;$&quot;,&quot;action&quot;: &quot;connect&quot;,&quot;mid&quot;: &quot;&lt;mid&gt;&quot;}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">title:</span><span class="hl-1"> </span><span class="hl-2">&#39;Connect to an agent&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;postback&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-4">template_type:</span><span class="hl-1"> </span><span class="hl-2">&#39;button&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">text:</span><span class="hl-1"> </span><span class="hl-2">&quot;Hi, My name is Chatbot, Welcome to my chatbot&#39;s corner. How can We help you&quot;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-4">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;template&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">timestamp</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">sendMessageCustomEvent</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">JSON</span><span class="hl-1">.</span><span class="hl-0">stringify</span><span class="hl-1">(</span><span class="hl-4">attachmentPayload</span><span class="hl-1">)</span><br/><span class="hl-1">);</span>
710
+ <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_SendCustomMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
637
711
  </code><button>Copy</button></pre>
638
712
  </div><aside class="tsd-sources">
639
713
  <p>Overrides vonage.CombinedClientJS.sendMessageCustomEvent</p></aside></li></ul></section>
@@ -660,7 +734,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
660
734
  <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>
661
735
 
662
736
  <div class="tsd-comment tsd-typography">
663
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">timestamp</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">sendMessageImageEvent</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">imageUrl</span><br/><span class="hl-1">);</span>
737
+ <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_SendImageMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
664
738
  </code><button>Copy</button></pre>
665
739
  </div><aside class="tsd-sources">
666
740
  <p>Overrides vonage.CombinedClientJS.sendMessageImageEvent</p></aside></li></ul></section>
@@ -687,7 +761,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
687
761
  <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>
688
762
 
689
763
  <div class="tsd-comment tsd-typography">
690
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">timestamp</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">sendMessageTextEvent</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;CONVERSATION_ID&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;Hello World!&#39;</span><br/><span class="hl-1">);</span>
764
+ <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>
691
765
  </code><button>Copy</button></pre>
692
766
  </div><aside class="tsd-sources">
693
767
  <p>Overrides vonage.CombinedClientJS.sendMessageTextEvent</p></aside></li></ul></section></section>
@@ -696,16 +770,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
696
770
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="answer" class="tsd-anchor"></a>
697
771
  <h3 class="tsd-anchor-link"><span>answer</span><a href="#answer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
698
772
  <ul class="tsd-signatures tsd-is-inherited">
699
- <li class="tsd-signature tsd-anchor-link" id="answer.answer-1"><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#answer.answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
700
- <li class="tsd-description">
701
- <div class="tsd-parameters">
702
- <h4 class="tsd-parameters-title">Parameters</h4>
703
- <ul class="tsd-parameter-list">
704
- <li>
705
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
706
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
707
- <p>Inherited from vonage.CombinedClientJS.answer</p></aside></li>
708
- <li class="tsd-signature tsd-anchor-link" id="answer.answer-2"><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#answer.answer-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
773
+ <li class="tsd-signature tsd-anchor-link" id="answer.answer-1"><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#answer.answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
709
774
  <li class="tsd-description">
710
775
  <div class="tsd-comment tsd-typography"><p>Answer a call</p>
711
776
  </div>
@@ -720,23 +785,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
720
785
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
721
786
 
722
787
  <div class="tsd-comment tsd-typography">
723
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">answer</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
788
+ <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_AnswerCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
724
789
  </code><button>Copy</button></pre>
725
790
  </div><aside class="tsd-sources">
726
791
  <p>Inherited from vonage.CombinedClientJS.answer</p></aside></li></ul></section>
727
792
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="disableEarmuff" class="tsd-anchor"></a>
728
793
  <h3 class="tsd-anchor-link"><span>disable<wbr/>Earmuff</span><a href="#disableEarmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
729
794
  <ul class="tsd-signatures tsd-is-inherited">
730
- <li class="tsd-signature tsd-anchor-link" id="disableEarmuff.disableEarmuff-1"><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEarmuff.disableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
731
- <li class="tsd-description">
732
- <div class="tsd-parameters">
733
- <h4 class="tsd-parameters-title">Parameters</h4>
734
- <ul class="tsd-parameter-list">
735
- <li>
736
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
737
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
738
- <p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></li>
739
- <li class="tsd-signature tsd-anchor-link" id="disableEarmuff.disableEarmuff-2"><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEarmuff.disableEarmuff-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
795
+ <li class="tsd-signature tsd-anchor-link" id="disableEarmuff.disableEarmuff-1"><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEarmuff.disableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
740
796
  <li class="tsd-description">
741
797
  <div class="tsd-comment tsd-typography"><p>Unearmuff your leg of a call</p>
742
798
  </div>
@@ -751,23 +807,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
751
807
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
752
808
 
753
809
  <div class="tsd-comment tsd-typography">
754
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">disableEarmuff</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
810
+ <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_DisableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
755
811
  </code><button>Copy</button></pre>
756
812
  </div><aside class="tsd-sources">
757
813
  <p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></li></ul></section>
758
814
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableEarmuff" class="tsd-anchor"></a>
759
815
  <h3 class="tsd-anchor-link"><span>enable<wbr/>Earmuff</span><a href="#enableEarmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
760
816
  <ul class="tsd-signatures tsd-is-inherited">
761
- <li class="tsd-signature tsd-anchor-link" id="enableEarmuff.enableEarmuff-1"><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEarmuff.enableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
762
- <li class="tsd-description">
763
- <div class="tsd-parameters">
764
- <h4 class="tsd-parameters-title">Parameters</h4>
765
- <ul class="tsd-parameter-list">
766
- <li>
767
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
768
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
769
- <p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li>
770
- <li class="tsd-signature tsd-anchor-link" id="enableEarmuff.enableEarmuff-2"><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEarmuff.enableEarmuff-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
817
+ <li class="tsd-signature tsd-anchor-link" id="enableEarmuff.enableEarmuff-1"><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEarmuff.enableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
771
818
  <li class="tsd-description">
772
819
  <div class="tsd-comment tsd-typography"><p>Earmuff your leg of a call</p>
773
820
  </div>
@@ -782,7 +829,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
782
829
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
783
830
 
784
831
  <div class="tsd-comment tsd-typography">
785
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">enableEarmuff</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
832
+ <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_EnableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
786
833
  </code><button>Copy</button></pre>
787
834
  </div><aside class="tsd-sources">
788
835
  <p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li></ul></section>
@@ -850,23 +897,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
850
897
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
851
898
 
852
899
  <div class="tsd-comment tsd-typography">
853
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">hangup</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
900
+ <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_Hangup</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
854
901
  </code><button>Copy</button></pre>
855
902
  </div><aside class="tsd-sources">
856
903
  <p>Overrides vonage.CombinedClientJS.hangup</p></aside></li></ul></section>
857
904
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a>
858
905
  <h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
859
906
  <ul class="tsd-signatures tsd-is-inherited">
860
- <li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
861
- <li class="tsd-description">
862
- <div class="tsd-parameters">
863
- <h4 class="tsd-parameters-title">Parameters</h4>
864
- <ul class="tsd-parameter-list">
865
- <li>
866
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
867
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
868
- <p>Inherited from vonage.CombinedClientJS.mute</p></aside></li>
869
- <li class="tsd-signature tsd-anchor-link" id="mute.mute-2"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#mute.mute-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
907
+ <li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
870
908
  <li class="tsd-description">
871
909
  <div class="tsd-comment tsd-typography"><p>Mute your leg of a call</p>
872
910
  </div>
@@ -881,23 +919,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
881
919
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
882
920
 
883
921
  <div class="tsd-comment tsd-typography">
884
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">mute</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
922
+ <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_Mute</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
885
923
  </code><button>Copy</button></pre>
886
924
  </div><aside class="tsd-sources">
887
925
  <p>Inherited from vonage.CombinedClientJS.mute</p></aside></li></ul></section>
888
926
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="reconnectCall" class="tsd-anchor"></a>
889
927
  <h3 class="tsd-anchor-link"><span>reconnect<wbr/>Call</span><a href="#reconnectCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
890
928
  <ul class="tsd-signatures tsd-is-inherited">
891
- <li class="tsd-signature tsd-anchor-link" id="reconnectCall.reconnectCall-1"><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">legId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectCall.reconnectCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
892
- <li class="tsd-description">
893
- <div class="tsd-parameters">
894
- <h4 class="tsd-parameters-title">Parameters</h4>
895
- <ul class="tsd-parameter-list">
896
- <li>
897
- <h5><span class="tsd-kind-parameter">legId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
898
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
899
- <p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></li>
900
- <li class="tsd-signature tsd-anchor-link" id="reconnectCall.reconnectCall-2"><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectCall.reconnectCall-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
929
+ <li class="tsd-signature tsd-anchor-link" id="reconnectCall.reconnectCall-1"><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectCall.reconnectCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
901
930
  <li class="tsd-description">
902
931
  <div class="tsd-comment tsd-typography"><p>Reconnect a call</p>
903
932
  </div>
@@ -912,23 +941,14 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
912
941
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
913
942
 
914
943
  <div class="tsd-comment tsd-typography">
915
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">reconnectCall</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
944
+ <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_ReconnectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
916
945
  </code><button>Copy</button></pre>
917
946
  </div><aside class="tsd-sources">
918
947
  <p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></li></ul></section>
919
948
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="reject" class="tsd-anchor"></a>
920
949
  <h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
921
950
  <ul class="tsd-signatures tsd-is-inherited">
922
- <li class="tsd-signature tsd-anchor-link" id="reject.reject-1"><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#reject.reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
923
- <li class="tsd-description">
924
- <div class="tsd-parameters">
925
- <h4 class="tsd-parameters-title">Parameters</h4>
926
- <ul class="tsd-parameter-list">
927
- <li>
928
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
929
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
930
- <p>Inherited from vonage.CombinedClientJS.reject</p></aside></li>
931
- <li class="tsd-signature tsd-anchor-link" id="reject.reject-2"><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reject.reject-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
951
+ <li class="tsd-signature tsd-anchor-link" id="reject.reject-1"><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reject.reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
932
952
  <li class="tsd-description">
933
953
  <div class="tsd-comment tsd-typography"><p>Reject a call</p>
934
954
  </div>
@@ -943,7 +963,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
943
963
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
944
964
 
945
965
  <div class="tsd-comment tsd-typography">
946
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">reject</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">);</span>
966
+ <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_RejectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
947
967
  </code><button>Copy</button></pre>
948
968
  </div><aside class="tsd-sources">
949
969
  <p>Inherited from vonage.CombinedClientJS.reject</p></aside></li></ul></section>
@@ -984,32 +1004,21 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
984
1004
  </div>
985
1005
  <div class="tsd-comment tsd-typography"></div></li>
986
1006
  <li>
987
- <h5><span class="tsd-kind-parameter">params</span>: <a href="../types/CallSayParams.html" class="tsd-signature-type tsd-kind-type-alias">CallSayParams</a></h5>
1007
+ <h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">CallSayParams</span></h5>
988
1008
  <div class="tsd-comment tsd-typography"><p>the <code>CallSayParams</code> to send</p>
989
1009
  </div>
990
1010
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
991
1011
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
992
1012
 
993
1013
  <div class="tsd-comment tsd-typography">
994
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">say</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">, </span><span class="hl-2">&#39;Hello World&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">ssmlExample</span><span class="hl-1"> =</span><br/><span class="hl-1"> </span><span class="hl-2">&#39;&lt;speak&gt;Hello World &lt;break strength=&quot;weak&quot;/&gt; I am using &lt;say-as interpret-as=&quot;character&quot;&gt;SSML&lt;/say-as&gt; &lt;break strength=&quot;weak&quot; /&gt; how cool is that? &lt;/speak&gt;&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">say</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">text:</span><span class="hl-1"> </span><span class="hl-4">ssmlExample</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">voiceName:</span><span class="hl-1"> </span><span class="hl-2">&#39;Kimberly&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">ssml:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">level:</span><span class="hl-1"> </span><span class="hl-13">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">loop:</span><span class="hl-1"> </span><span class="hl-13">2</span><br/><span class="hl-1">});</span>
1014
+ <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_Say</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
995
1015
  </code><button>Copy</button></pre>
996
1016
  </div><aside class="tsd-sources">
997
1017
  <p>Overrides vonage.CombinedClientJS.say</p></aside></li></ul></section>
998
1018
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="sendDTMF" class="tsd-anchor"></a>
999
1019
  <h3 class="tsd-anchor-link"><span>sendDTMF</span><a href="#sendDTMF" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1000
1020
  <ul class="tsd-signatures tsd-is-inherited">
1001
- <li class="tsd-signature tsd-anchor-link" id="sendDTMF.sendDTMF-1"><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendDTMF.sendDTMF-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1002
- <li class="tsd-description">
1003
- <div class="tsd-parameters">
1004
- <h4 class="tsd-parameters-title">Parameters</h4>
1005
- <ul class="tsd-parameter-list">
1006
- <li>
1007
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li>
1008
- <li>
1009
- <h5><span class="tsd-kind-parameter">digits</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
1010
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1011
- <p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></li>
1012
- <li class="tsd-signature tsd-anchor-link" id="sendDTMF.sendDTMF-2"><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendDTMF.sendDTMF-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1021
+ <li class="tsd-signature tsd-anchor-link" id="sendDTMF.sendDTMF-1"><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendDTMF.sendDTMF-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1013
1022
  <li class="tsd-description">
1014
1023
  <div class="tsd-comment tsd-typography"><p>Send a string of digits to a call via DTMF</p>
1015
1024
  </div>
@@ -1029,7 +1038,7 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
1029
1038
  <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1030
1039
 
1031
1040
  <div class="tsd-comment tsd-typography">
1032
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-2">&#39;callId&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">sendDTMF</span><span class="hl-1">(</span><span class="hl-4">callId</span><span class="hl-1">, </span><span class="hl-2">&#39;1234&#39;</span><span class="hl-1">);</span>
1041
+ <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_Dtmf</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
1033
1042
  </code><button>Copy</button></pre>
1034
1043
  </div><aside class="tsd-sources">
1035
1044
  <p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></li></ul></section>
@@ -1045,30 +1054,21 @@ This is used to initiate a call using the Voice API and NCCO.</p>
1045
1054
  <h4 class="tsd-parameters-title">Parameters</h4>
1046
1055
  <ul class="tsd-parameter-list">
1047
1056
  <li>
1048
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <a href="../types/Json.html" class="tsd-signature-type tsd-kind-type-alias">Json</a></h5>
1057
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type ">Json</span></h5>
1049
1058
  <div class="tsd-comment tsd-typography"><p>the context to send to the server passed as Custom data to the voice answer webhook</p>
1050
1059
  </div>
1051
1060
  <div class="tsd-comment tsd-typography"></div></li></ul></div>
1052
1061
  <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>callId</code> of the call</p>
1053
1062
 
1054
1063
  <div class="tsd-comment tsd-typography">
1055
- <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">context</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">callee:</span><span class="hl-1"> </span><span class="hl-2">&#39;user1&#39;</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">callId</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-0">serverCall</span><span class="hl-1">(</span><span class="hl-4">context</span><span class="hl-1">);</span>
1064
+ <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_OutboundCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
1056
1065
  </code><button>Copy</button></pre>
1057
1066
  </div><aside class="tsd-sources">
1058
1067
  <p>Overrides vonage.CombinedClientJS.serverCall</p></aside></li></ul></section>
1059
1068
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a>
1060
1069
  <h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1061
1070
  <ul class="tsd-signatures tsd-is-inherited">
1062
- <li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1063
- <li class="tsd-description">
1064
- <div class="tsd-parameters">
1065
- <h4 class="tsd-parameters-title">Parameters</h4>
1066
- <ul class="tsd-parameter-list">
1067
- <li>
1068
- <h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
1069
- <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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1070
- <p>Inherited from vonage.CombinedClientJS.unmute</p></aside></li>
1071
- <li class="tsd-signature tsd-anchor-link" id="unmute.unmute-2"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmute.unmute-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1071
+ <li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1072
1072
  <li class="tsd-description">
1073
1073
  <div class="tsd-comment tsd-typography"><p>Unmute your leg of a call</p>
1074
1074
  </div>
@@ -1096,22 +1096,21 @@ This is used to initiate a call using the Voice API and NCCO.</p>
1096
1096
  <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
1097
1097
  <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
1098
1098
  <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
1099
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
1099
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li>
1100
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Alpha</span></label></li>
1101
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Beta</span></label></li></ul></form></div>
1100
1102
  <div class="tsd-theme-toggle">
1101
1103
  <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
1102
1104
  <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
1103
1105
  <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
1104
1106
  <div class="tsd-accordion-details">
1105
1107
  <ul>
1106
- <li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
1108
+ <li><a href="#__doNotUseOrImplementIt" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span></a></li>
1107
1109
  <li><a href="#clearCallbacks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a></li>
1108
1110
  <li><a href="#createSession" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Session</span></a></li>
1109
- <li><a href="#deleteSession" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Session</span></a></li>
1110
1111
  <li><a href="#getConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a></li>
1111
- <li><a href="#getUser" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User</span></a></li>
1112
1112
  <li><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
1113
1113
  <li><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
1114
- <li><a href="#refreshSession" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>refresh<wbr/>Session</span></a></li>
1115
1114
  <li><a href="#setConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Config</span></a></li>
1116
1115
  <li><a href="#createConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a></li>
1117
1116
  <li><a href="#deleteConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a></li>
@@ -1141,17 +1140,23 @@ This is used to initiate a call using the Voice API and NCCO.</p>
1141
1140
  <li><a href="#serverCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>server<wbr/>Call</span></a></li>
1142
1141
  <li><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a></li></ul></div></details></div>
1143
1142
  <div class="site-menu">
1144
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@vonage/client-sdk - v1.3.0-alpha.2</span></a>
1143
+ <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@vonage/client-sdk - v0.0.0</span></a>
1145
1144
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
1145
+ <details class="tsd-index-accordion" data-key="Classes"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Classes</span></summary>
1146
+ <div class="tsd-accordion-details">
1147
+ <ul class="tsd-nested-navigation">
1146
1148
  <li><a href="ClientConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientConfig</a></li>
1147
1149
  <li><a href="ClientInitConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientInitConfig</a></li>
1148
- <li><a href="VonageClient.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>VonageClient</a></li>
1150
+ <li><a href="VonageClient.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>VonageClient</a></li></ul></div></details>
1151
+ <details class="tsd-index-accordion" data-key="Interfaces"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Interfaces</span></summary>
1152
+ <div class="tsd-accordion-details">
1153
+ <ul class="tsd-nested-navigation">
1149
1154
  <li><a href="../interfaces/ConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationEvent</a></li>
1150
1155
  <li><a href="../interfaces/ConversationState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationState</a></li>
1151
1156
  <li><a href="../interfaces/CustomConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>CustomConversationEvent</a></li>
1152
1157
  <li><a href="../interfaces/EmbeddedInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EmbeddedInfo</a></li>
1153
1158
  <li><a href="../interfaces/EphemeralConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EphemeralConversationEvent</a></li>
1154
- <li><a href="../interfaces/EventsPage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventsPage</a></li>
1159
+ <li><a href="../interfaces/EventDeleteConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventDeleteConversationEvent</a></li>
1155
1160
  <li><a href="../interfaces/From.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>From</a></li>
1156
1161
  <li><a href="../interfaces/MemberInvitedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberInvitedEvent</a></li>
1157
1162
  <li><a href="../interfaces/MemberJoinedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberJoinedEvent</a></li>
@@ -1161,10 +1166,6 @@ This is used to initiate a call using the Voice API and NCCO.</p>
1161
1166
  <li><a href="../interfaces/MessageCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageCustomEvent</a></li>
1162
1167
  <li><a href="../interfaces/MessageFileEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageFileEvent</a></li>
1163
1168
  <li><a href="../interfaces/MessageImageEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageImageEvent</a></li>
1164
- <li><a href="../interfaces/MessageLocationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageLocationEvent</a></li>
1165
- <li><a href="../interfaces/MessageTemplateEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageTemplateEvent</a></li>
1166
- <li><a href="../interfaces/MessageTextEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageTextEvent</a></li>
1169
+ <li><a href="../interfaces/MessageLocationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageLocationEvent</a></li></ul></div></details>
1167
1170
  <li>Loading...</li></ul></nav></div></div></div>
1168
- <div class="tsd-generator">
1169
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
1170
1171
  <div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>