docs/Cpaas/Conversation.html in cpaas-sdk-1.1.0 vs docs/Cpaas/Conversation.html in cpaas-sdk-1.2.0
- old
+ new
@@ -92,11 +92,11 @@
<dl>
<dt>Defined in:</dt>
- <dd>lib/cpaas/resources/conversation.rb</dd>
+ <dd>lib/cpaas-sdk/resources/conversation.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
@@ -396,11 +396,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -425,21 +425,25 @@
<span class="type">(<tt>Array[string]|String</tt>)</span>
<span class="default">
</span>
+ — <div class='inline'>
+<p>Indicates which DID number(s) used as destination for this SMS.</p>
+</div>
+
</li>
<li>
<span class="name">:message</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
-<p>text message</p>
+<p>SMS text message</p>
</div>
</li>
</ul>
@@ -480,11 +484,11 @@
43
44
45</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 18</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 18</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_message'>create_message</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_address'>address</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span> <span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span>
@@ -563,11 +567,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -633,11 +637,11 @@
103
104
105</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 97</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 97</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_message'>delete_message</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
@@ -697,11 +701,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -896,11 +900,11 @@
84
85
86</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 64</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 64</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_messages'>get_messages</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>query:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
@@ -974,11 +978,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -1090,11 +1094,11 @@
130
131
132</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 119</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 119</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_messages_in_thread'>get_messages_in_thread</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>query:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
@@ -1159,11 +1163,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -1225,11 +1229,11 @@
145
146
147</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 143</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 143</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_status'>get_status</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/status</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
@@ -1285,11 +1289,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -1331,11 +1335,11 @@
191
192
193</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 179</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 179</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_subscription'>get_subscription</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subscription_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
@@ -1406,11 +1410,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -1440,11 +1444,11 @@
168
169
170</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 155</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 155</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_subscriptions'>get_subscriptions</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
@@ -1511,11 +1515,11 @@
<span class="default">
</span>
— <div class='inline'>
-<p>Type of conversation. Possible values - 'sms'. Check
+<p>Type of conversation. Possible value(s) - 'sms'. Check
Conversation.types for more options</p>
</div>
</li>
@@ -1525,13 +1529,13 @@
<span class="default">
</span>
— <div class='inline'>
-<p>The notification channel ID that has been acquired during
-/notificationchannel API subscription, either websockets, mobile push or
-webhooks type, which the incoming notifications supposed to be sent to.</p>
+<p>HTTPS URL that is present in your application server which is accessible
+from the public web where the notifications should be sent to. Note: Should
+be a POST endpoint.</p>
</div>
</li>
<li>
@@ -1589,11 +1593,11 @@
230
231
232</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 204</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 204</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_subscribe'>subscribe</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_channel'>channel</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='op'>::</span><span class='const'>NotificationChannel</span><span class='period'>.</span><span class='id identifier rubyid_create_channel'>create_channel</span><span class='lparen'>(</span><span class='label'>webhook_url:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:webhook_url</span><span class='rbracket'>]</span><span class='rparen'>)</span>
@@ -1668,10 +1672,24 @@
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
+ <span class="name">:type</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'>
+<p>Type of conversation. Possible value(s) - 'sms'. Check
+Conversation.types for more options</p>
+</div>
+
+ </li>
+
+ <li>
<span class="name">:subscription_id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
@@ -1690,11 +1708,10 @@
<tr>
<td>
<pre class="lines">
-241
242
243
244
245
246
@@ -1702,14 +1719,15 @@
248
249
250
251
252
-253</pre>
+253
+254</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 241</span>
+ <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/conversation.rb', line 242</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_unsubscribe'>unsubscribe</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subscription_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
@@ -1730,10 +1748,10 @@
</div>
</div>
<div id="footer">
- Generated on Thu Oct 17 17:28:29 2019 by
+ Generated on Wed May 6 19:02:40 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.20 (ruby-2.5.0).
</div>
</div>
\ No newline at end of file