cpaas-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd743f490632a5245f1c0cd2baf7187cf8623f38ded092fe0f020470445e419
-  data.tar.gz: 4b9bfcd28a1bf3c555686f79eea6e6c10fd276a2192f4dbf28cffc3ee9d87fd4
+  metadata.gz: 965127ceeaf94c8385981dbd7d753f142c1b7b5368dc2e78711a168dbab479d3
+  data.tar.gz: 0e3a404bf31367bde1b2b86784d0ea626fde09402ec07e2260f0183ace07f66b
 SHA512:
-  metadata.gz: 202495f68be89189d7336ce9d1a282aa35832a7699d621935d366e08d4ce720d72afcd002ee59bf0f7c5fba4e8f0e70a655fba247781c4f9b4a06b365f1e9a19
-  data.tar.gz: 9f69c5ce0195a0dc4e88eeb2e41770d897a390bf3328218f28ae676216b4ddfa4601afbbbc223b3111ed5e145961b8ffcea78c8b44afd81e4d85d4baa729b625
+  metadata.gz: b0efa0dee87f22cc9c3ff5c5e9f7ae5058c165d60f6bac3250f426f7a7607f57eef4f60248acbdfb1836a8600ae7d11782e96bd1bca92d7d36f79f87827274d1
+  data.tar.gz: 1fa7be4903c92cfe531b1c25aa42e5256bd8434200ed3300a157a1cf819f45a11387a3e6668cb762bc0e45370bdcadf955c17703dc3d57f87d1cdf0b20021c33

data/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 + This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 + The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) recommendations.
 
+## 1.2.0 - 2020-05-12
+
+### Added
+- Added client authentication with CPaaS account credentials.
+
 ## 1.1.0 - 2019-12-10
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
-# cpaas-ruby
+# Kandy CPaaS Ruby SDK
 
-## Installation
+## Install
 
 Add this line to your application's Gemfile:
 
@@ -16,10 +16,13 @@ Or install it yourself as:
 
     $ gem install cpaas-sdk
 
-## Reference
+## Documentation
 
 The information about tutorials and documents can be found in the links below
 
-* `Documents`: [docs](https://kandy-io.github.io/kandy-cpaas-ruby-sdk/docs)
+* `Documents`: [API Docs](https://kandy-io.github.io/kandy-cpaas-ruby-sdk/docs)
 
-* `Tutorials`:  [Get Started](https://Kandy-IO.github.io/kandy-cpaas-ruby-sdk/tutorials/?KANDY=Kandy&KANDYFQDN=https://oauth-cpaas.att.com#/GetStarted)
+* `Tutorials`:  [User Guide](https://Kandy-IO.github.io/kandy-cpaas-ruby-sdk/tutorials/?KANDY=Kandy&KANDYFQDN=oauth-cpaas.att.com#/GetStarted)
+
+## Compatibility
+- Ruby 2.0.0 or higher

data/cpaas-sdk.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 3.6.2'
   spec.add_development_dependency 'yard', '~> 0.9.20'

data/developer-notes.md

@@ -0,0 +1,9 @@
+# Developer Notes
+
+## Documentation
+YARD is used for documentation.
+
+To generate, run the following command
+```bash
+yardoc --no-private --readme docs/_index.md --output-dir docs
+```

data/docs/Cpaas.html

@@ -78,8 +78,8 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/cpaas.rb<span class="defines">,<br />
-  lib/cpaas/api.rb,<br /> lib/cpaas/config.rb,<br /> lib/cpaas/version.rb,<br /> lib/cpaas/resources/twofactor.rb,<br /> lib/cpaas/resources/conversation.rb,<br /> lib/cpaas/resources/notification.rb,<br /> lib/cpaas/resources/notification_channel.rb</span>
+    <dd>lib/cpaas-sdk.rb<span class="defines">,<br />
+  lib/cpaas-sdk/api.rb,<br /> lib/cpaas-sdk/config.rb,<br /> lib/cpaas-sdk/version.rb,<br /> lib/cpaas-sdk/resources/twofactor.rb,<br /> lib/cpaas-sdk/resources/conversation.rb,<br /> lib/cpaas-sdk/resources/notification.rb,<br /> lib/cpaas-sdk/resources/notification_channel.rb</span>
 </dd>
   </dl>
   
@@ -107,7 +107,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
       
     </dl>
   
@@ -249,7 +249,7 @@
 10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk.rb', line 8</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_api'>api</span>
   <span class='ivar'>@api</span>
@@ -292,7 +292,7 @@
 10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk.rb', line 8</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
   <span class='ivar'>@config</span>
@@ -332,11 +332,20 @@
     <p class="tag_title">Examples:</p>
     
       
-      <pre class="example code"><code>Cpaas.configure do |config|
-  config.client_id: &#39;&lt;private project key&gt;&#39;,
-  config.client_secret: &#39;&lt;private project secret&gt;&#39;,
-  config.base_url: &#39;&lt;base url&gt;&#39;
-end</code></pre>
+      <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;private project key&gt;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_secret'>client_secret</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;private project secret&gt;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://$KANDYFQDN$</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
+
+<span class='comment'># or
+</span>
+<span class='const'><span class='object_link'><a href="" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;account client ID&gt;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_email'>email</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;account email&gt;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;account password&gt;</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://$KANDYFQDN$</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span></code></pre>
     
   </div>
 <p class="tag_title">Parameters:</p>
@@ -353,7 +362,25 @@ end</code></pre>
       
         &mdash;
         <div class='inline'>
-<p>Private project secret</p>
+<p>Private project key / Account client ID. If Private project key is used
+then client_secret is mandatory. If account client ID is used then email
+and password are mandatory.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>base_url</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>URL of the server to be used.</p>
 </div>
       
     </li>
@@ -369,14 +396,14 @@ end</code></pre>
       
         &mdash;
         <div class='inline'>
-<p>Private project secret</p>
+<p>+optional Private project secret</p>
 </div>
       
     </li>
   
     <li>
       
-        <span class='name'>base_url</span>
+        <span class='name'>email</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -385,7 +412,23 @@ end</code></pre>
       
         &mdash;
         <div class='inline'>
-<p>JSON URL of the server to be used.</p>
+<p>+optional Account login email</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>password</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>+optional Account login password</p>
 </div>
       
     </li>
@@ -412,18 +455,22 @@ end</code></pre>
       <pre class="lines">
 
 
-25
-26
-27
-28
-29</pre>
+36
+37
+38
+39
+40
+41
+42</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk.rb', line 36</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
   <span class='kw'>yield</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cpaas (module)">Cpaas</a></span></span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
 
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span>
+
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api'>api</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Cpaas (module)">Cpaas</a></span></span><span class='op'>::</span><span class='const'>Api</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -436,7 +483,7 @@ end</code></pre>
 </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>

data/docs/Cpaas/Conversation.html

@@ -94,7 +94,7 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/cpaas/resources/conversation.rb</dd>
+    <dd>lib/cpaas-sdk/resources/conversation.rb</dd>
   </dl>
   
 </div>
@@ -398,7 +398,7 @@
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -427,6 +427,10 @@ let CPaaS uses the default assigned DID number, this field can either has
             
           </span>
           
+            &mdash; <div class='inline'>
+<p>Indicates which DID number(s) used as destination for this SMS.</p>
+</div>
+          
         </li>
       
         <li>
@@ -437,7 +441,7 @@ let CPaaS uses the default assigned DID number, this field can either has
           </span>
           
             &mdash; <div class='inline'>
-<p>text message</p>
+<p>SMS text message</p>
 </div>
           
         </li>
@@ -482,7 +486,7 @@ let CPaaS uses the default assigned DID number, this field can either has
 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>
@@ -565,7 +569,7 @@ let CPaaS uses the default assigned DID number, this field can either has
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -635,7 +639,7 @@ passsed then the conversation thread is deleted with all messages.</p>
 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>
@@ -699,7 +703,7 @@ passsed then the conversation thread is deleted with all messages.</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -898,7 +902,7 @@ gathered from the previous query results.</p>
 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>
@@ -976,7 +980,7 @@ gathered from the previous query results.</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -1092,7 +1096,7 @@ that are sent/received after provided Epoch time</p>
 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>
@@ -1161,7 +1165,7 @@ that are sent/received after provided Epoch time</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -1227,7 +1231,7 @@ conversation thread is deleted with all messages.</p>
 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>
@@ -1287,7 +1291,7 @@ conversation thread is deleted with all messages.</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -1333,7 +1337,7 @@ Conversation.types for more options</p>
 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>
@@ -1408,7 +1412,7 @@ Conversation.types for more options</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -1442,7 +1446,7 @@ Conversation.types for more options</p>
 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>
@@ -1513,7 +1517,7 @@ Conversation.types for more options</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>Type of conversation. Possible values - &#39;sms&#39;. Check
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
 Conversation.types for more options</p>
 </div>
           
@@ -1527,9 +1531,9 @@ Conversation.types for more options</p>
           </span>
           
             &mdash; <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>
@@ -1591,7 +1595,7 @@ formatted DID number within this parameter.</p>
 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>
@@ -1669,6 +1673,20 @@ formatted DID number within this parameter.</p>
     <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>
+          
+            &mdash; <div class='inline'>
+<p>Type of conversation. Possible value(s) - &#39;sms&#39;. Check
+Conversation.types for more options</p>
+</div>
+          
+        </li>
+      
         <li>
           <span class="name">:subscription_id</span>
           <span class="type">(<tt>String</tt>)</span>
@@ -1692,7 +1710,6 @@ formatted DID number within this parameter.</p>
       <pre class="lines">
 
 
-241
 242
 243
 244
@@ -1704,10 +1721,11 @@ formatted DID number within this parameter.</p>
 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>
@@ -1732,7 +1750,7 @@ formatted DID number within this parameter.</p>
 </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>