cpaas-sdk 1.1.0 → 1.2.0

data/docs/Cpaas/Notification.html

@@ -94,7 +94,7 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/cpaas/resources/notification.rb</dd>
+    <dd>lib/cpaas-sdk/resources/notification.rb</dd>
   </dl>
   
 </div>
@@ -185,7 +185,7 @@ notification and returns simplified version of the response.</p>
         <span class='name'>notification</span>
       
       
-        <span class='type'>(<tt>Hash</tt>)</span>
+        <span class='type'>(<tt>JSON</tt>)</span>
       
       
       
@@ -243,7 +243,7 @@ notification and returns simplified version of the response.</p>
 49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/resources/notification.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/notification.rb', line 14</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_notification'>notification</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_parsed_notification'>parsed_notification</span> <span class='op'>=</span> <span class='id identifier rubyid_convert_hash_keys'><span class='object_link'><a href="../top-level-namespace.html#convert_hash_keys-instance_method" title="#convert_hash_keys (method)">convert_hash_keys</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_notification'>notification</span><span class='rparen'>)</span>
@@ -291,7 +291,7 @@ notification and returns simplified version of the response.</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>

data/docs/Cpaas/Twofactor.html

@@ -94,7 +94,7 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/cpaas/resources/twofactor.rb</dd>
+    <dd>lib/cpaas-sdk/resources/twofactor.rb</dd>
   </dl>
   
 </div>
@@ -103,9 +103,7 @@
   <div class="discussion">
     
 <p>CPaaS provides Authentication API where a two-factor authentication (2FA)
-flow can be implemented by using that. Sections below describe two sample
-use cases, two-factor authentication via SMS and two-factor authentication
-via e-mail</p>
+flow can be implemented by using that.</p>
 
 
   </div>
@@ -299,12 +297,12 @@ previously sent code.</p>
       <pre class="lines">
 
 
-126
-127
-128</pre>
+129
+130
+131</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/resources/twofactor.rb', line 126</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/twofactor.rb', line 129</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_code'>delete_code</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='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'>&quot;</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'>/codes/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:code_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</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>
@@ -419,6 +417,21 @@ and email are supported types. Possible values: sms, email</p>
           
         </li>
       
+        <li>
+          <span class="name">:subject</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p><code>optional</code> When the method is passed as email then subject
+becomes a mandatory field to pass. The value passed becomes the subject
+line of the 2FA code email that is sent out to the destination_address.</p>
+</div>
+          
+        </li>
+      
         <li>
           <span class="name">:expiry</span>
           <span class="type">(<tt>Number</tt>)</span>
@@ -481,8 +494,6 @@ alphabetic</p>
       <pre class="lines">
 
 
-93
-94
 95
 96
 97
@@ -506,10 +517,13 @@ alphabetic</p>
 115
 116
 117
-118</pre>
+118
+119
+120
+121</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/resources/twofactor.rb', line 93</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/twofactor.rb', line 95</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resend_code'>resend_code</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='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>
@@ -524,6 +538,7 @@ alphabetic</p>
           <span class='label'>type:</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='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>numeric</span><span class='tstring_end'>&#39;</span></span>
         <span class='rbrace'>}</span><span class='comma'>,</span>
         <span class='label'>expiry:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:expiry</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>120</span><span class='comma'>,</span>
+        <span class='label'>subject:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subject</span><span class='rbracket'>]</span><span class='comma'>,</span>
         <span class='label'>message:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span>
       <span class='rbrace'>}</span>
     <span class='rbrace'>}</span>
@@ -633,6 +648,21 @@ and email are supported types. Possible values: sms, email</p>
           
         </li>
       
+        <li>
+          <span class="name">:subject</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p><code>optional</code> When the method is passed as email then subject
+becomes a mandatory field to pass. The value passed becomes the subject
+line of the 2FA code email that is sent out to the destination_address.</p>
+</div>
+          
+        </li>
+      
         <li>
           <span class="name">:expiry</span>
           <span class="type">(<tt>Number</tt>)</span>
@@ -720,10 +750,11 @@ alphabetic</p>
 43
 44
 45
-46</pre>
+46
+47</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/resources/twofactor.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/twofactor.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send_code'>send_code</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='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>
@@ -738,6 +769,7 @@ alphabetic</p>
           <span class='label'>type:</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='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>numeric</span><span class='tstring_end'>&#39;</span></span>
         <span class='rbrace'>}</span><span class='comma'>,</span>
         <span class='label'>expiry:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:expiry</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>120</span><span class='comma'>,</span>
+        <span class='label'>subject:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subject</span><span class='rbracket'>]</span><span class='comma'>,</span>
         <span class='label'>message:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span>
       <span class='rbrace'>}</span>
     <span class='rbrace'>}</span>
@@ -834,7 +866,6 @@ alphabetic</p>
       <pre class="lines">
 
 
-55
 56
 57
 58
@@ -858,10 +889,11 @@ alphabetic</p>
 76
 77
 78
-79</pre>
+79
+80</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/resources/twofactor.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/resources/twofactor.rb', line 56</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_verify_code'>verify_code</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='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
@@ -898,7 +930,7 @@ alphabetic</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>

data/docs/_index.html

@@ -136,7 +136,7 @@
 </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/_index.md

@@ -6,9 +6,11 @@ Instantiate the instance with client\_id & client\_secret.
 
 ### Parameters:
 
-* **client_id** (String) - Private project secret
+* **client_id** (String) - 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.
 * **client_secret** (String) — Private project secret
-* **base_url** (String) — JSON URL of the server to be used
+* **email** (String) — Account email address.
+* **password** (String) — Account password
+* **base_url** (String) — URL of the server to be used.
 
 ### Example:
 
@@ -18,4 +20,13 @@ Cpaas.configure do |config|
   config.client_secret = '<private project secret>'
   config.base_url = '<base url>'
 end
+
+# or
+
+Cpaas.configure do |config|
+  config.client_id = '<account client ID>'
+  config.email = '<account email>'
+  config.password = '<account password>'
+  config.base_url = '<base url>'
+end
 ```

data/docs/file._index.html

@@ -66,11 +66,17 @@
 
 <h3 id="label-Parameters-3A">Parameters:</h3>
 <ul><li>
-<p><strong>client_id</strong> (String) - Private project secret</p>
+<p><strong>client_id</strong> (String) - 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>
 </li><li>
 <p><strong>client_secret</strong> (String) — Private project secret</p>
 </li><li>
-<p><strong>base_url</strong> (String) — JSON URL of the server to be used</p>
+<p><strong>email</strong> (String) — Account email address.</p>
+</li><li>
+<p><strong>password</strong> (String) — Account password</p>
+</li><li>
+<p><strong>base_url</strong> (String) — URL of the server to be used.</p>
 </li></ul>
 
 <h3 id="label-Example-3A">Example:</h3>
@@ -80,11 +86,20 @@
   <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'>&lt;base url&gt;</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="Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Cpaas.html#configure-class_method" title="Cpaas.configure (method)">configure</a></span></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'>&lt;base url&gt;</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
 </code></pre>
 </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>

data/docs/index.html

@@ -66,11 +66,17 @@
 
 <h3 id="label-Parameters-3A">Parameters:</h3>
 <ul><li>
-<p><strong>client_id</strong> (String) - Private project secret</p>
+<p><strong>client_id</strong> (String) - 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>
 </li><li>
 <p><strong>client_secret</strong> (String) — Private project secret</p>
 </li><li>
-<p><strong>base_url</strong> (String) — JSON URL of the server to be used</p>
+<p><strong>email</strong> (String) — Account email address.</p>
+</li><li>
+<p><strong>password</strong> (String) — Account password</p>
+</li><li>
+<p><strong>base_url</strong> (String) — URL of the server to be used.</p>
 </li></ul>
 
 <h3 id="label-Example-3A">Example:</h3>
@@ -80,11 +86,20 @@
   <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'>&lt;base url&gt;</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="Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Cpaas.html#configure-class_method" title="Cpaas.configure (method)">configure</a></span></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'>&lt;base url&gt;</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
 </code></pre>
 </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>

data/docs/top-level-namespace.html

@@ -106,7 +106,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="top-level-namespace.html#compose_error_from-instance_method" title="#compose_error_from (instance method)">#<strong>compose_error_from</strong>(err_response)  &#x21d2; Object </a>
+      <a href="top-level-namespace.html#compose_error_from-instance_method" title="#compose_error_from (instance method)">#<strong>compose_error_from</strong>(response)  &#x21d2; Object </a>
     
 
     
@@ -194,7 +194,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="top-level-namespace.html#process_response-instance_method" title="#process_response (instance method)">#<strong>process_response</strong>(res)  &#x21d2; Object </a>
+      <a href="top-level-namespace.html#process_response-instance_method" title="#process_response (instance method)">#<strong>process_response</strong>(res, remove_outer_key = true)  &#x21d2; Object </a>
     
 
     
@@ -291,7 +291,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="compose_error_from-instance_method">
   
-    #<strong>compose_error_from</strong>(err_response)  &#x21d2; <tt>Object</tt> 
+    #<strong>compose_error_from</strong>(response)  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -303,8 +303,6 @@
       <pre class="lines">
 
 
-23
-24
 25
 26
 27
@@ -323,31 +321,33 @@
 40
 41
 42
-43</pre>
+43
+44
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 25</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_compose_error_from'>compose_error_from</span><span class='lparen'>(</span><span class='id identifier rubyid_err_response'>err_response</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_error_obj'>error_obj</span> <span class='op'>=</span> <span class='id identifier rubyid_deep_find'><span class='object_link'><a href="#deep_find-instance_method" title="#deep_find (method)">deep_find</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_err_response'>err_response</span><span class='comma'>,</span> <span class='symbol'>:message_id</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_compose_error_from'>compose_error_from</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_error_obj'>error_obj</span> <span class='op'>=</span> <span class='id identifier rubyid_deep_find'><span class='object_link'><a href="#deep_find-instance_method" title="#deep_find (method)">deep_find</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='symbol'>:message_id</span><span class='rparen'>)</span>
 
   <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_error_obj'>error_obj</span><span class='rparen'>)</span>
     <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_error_obj'>error_obj</span><span class='lbracket'>[</span><span class='symbol'>:text</span><span class='rbracket'>]</span>
 
     <span class='id identifier rubyid_error_obj'>error_obj</span><span class='lbracket'>[</span><span class='symbol'>:variables</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_variable'>variable</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span> <span class='op'>+</span> <span class='int'>1</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_variable'>variable</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
 
-    <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+    <span class='kw'>return</span> <span class='lbrace'>{</span>
       <span class='label'>name:</span> <span class='id identifier rubyid_error_obj'>error_obj</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='comma'>,</span>
       <span class='label'>exception_id:</span> <span class='id identifier rubyid_error_obj'>error_obj</span><span class='lbracket'>[</span><span class='symbol'>:message_id</span><span class='rbracket'>]</span><span class='comma'>,</span>
       <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span>
     <span class='rbrace'>}</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-      <span class='label'>name:</span> <span class='id identifier rubyid_err_response'>err_response</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='comma'>,</span>
-      <span class='label'>exception_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-      <span class='label'>message:</span> <span class='id identifier rubyid_err_response'>err_response</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span>
-    <span class='rbrace'>}</span>
   <span class='kw'>end</span>
+
+
+  <span class='lbrace'>{</span>
+    <span class='label'>name:</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='comma'>,</span>
+    <span class='label'>message:</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='symbol'>:error_description</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span>
+  <span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -369,8 +369,6 @@
       <pre class="lines">
 
 
-66
-67
 68
 69
 70
@@ -378,10 +376,12 @@
 72
 73
 74
-75</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 66</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 68</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_convert_hash_keys'>convert_hash_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
@@ -413,8 +413,6 @@
       <pre class="lines">
 
 
-49
-50
 51
 52
 53
@@ -428,10 +426,12 @@
 61
 62
 63
-64</pre>
+64
+65
+66</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 49</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 51</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_deep_find'>deep_find</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_parentKey'>parentKey</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='kw'>nil</span>
@@ -469,12 +469,12 @@
       <pre class="lines">
 
 
-45
-46
-47</pre>
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_id_from'>id_from</span> <span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
@@ -487,7 +487,7 @@
       <div class="method_details ">
   <h3 class="signature " id="process_response-instance_method">
   
-    #<strong>process_response</strong>(res)  &#x21d2; <tt>Object</tt> 
+    #<strong>process_response</strong>(res, remove_outer_key = true)  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -519,12 +519,14 @@
 18
 19
 20
-21</pre>
+21
+22
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 1</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 1</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_process_response'>process_response</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_process_response'>process_response</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='comma'>,</span> <span class='id identifier rubyid_remove_outer_key'>remove_outer_key</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='symbol'>:exception_id</span>
     <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span>
   <span class='kw'>elsif</span> <span class='id identifier rubyid_res'>res</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:__for_test__</span><span class='rparen'>)</span>
@@ -538,9 +540,11 @@
     <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_custom_body'>custom_body</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_res'>res</span> <span class='op'>:</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_custom_body'>custom_body</span><span class='rparen'>)</span>
   <span class='kw'>elsif</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
     <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>yield</span> <span class='id identifier rubyid_res'>res</span>
-  <span class='kw'>else</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_remove_outer_key'>remove_outer_key</span>
     <span class='id identifier rubyid_topLevelKey'>topLevelKey</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
     <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='lbracket'>[</span><span class='id identifier rubyid_topLevelKey'>topLevelKey</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_as_json'>as_json</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span>
   <span class='kw'>end</span>
 
   <span class='id identifier rubyid_response'>response</span>
@@ -565,12 +569,12 @@
       <pre class="lines">
 
 
-89
-90
-91</pre>
+91
+92
+93</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 89</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 91</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_reject'>reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>==</span> <span class='id identifier rubyid_key'>key</span> <span class='rbrace'>}</span>
@@ -595,16 +599,16 @@
       <pre class="lines">
 
 
-81
-82
 83
 84
 85
 86
-87</pre>
+87
+88
+89</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 81</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 83</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_underscore'>underscore</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>::</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span>
@@ -633,12 +637,12 @@
       <pre class="lines">
 
 
-77
-78
-79</pre>
+79
+80
+81</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/cpaas/util.rb', line 77</span>
+      <pre class="code"><span class="info file"># File 'lib/cpaas-sdk/util.rb', line 79</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_underscore_key'>underscore_key</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_underscore'><span class='object_link'><a href="#underscore-instance_method" title="#underscore (method)">underscore</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
@@ -653,7 +657,7 @@
 </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>