index.html in cpaas-sdk-1.2.0

- old
+ new
@@ -64,28 +64,43 @@
 
 <p>Instantiate the instance with client_id &amp; client_secret.</p>
 
 <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>
 
 <pre class="code ruby"><code class="ruby"><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;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'>&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>
 
     </div>
\ No newline at end of file