Update documentation

kayagoban · Aug 21, 2014 · 19669d9 · 19669d9
1 parent 591a4f2
commit 19669d9
Show file tree

Hide file tree

Showing 30 changed files with 98 additions and 95 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 echochamber
 ===========
 
-Ruby Gem to consume Adobe's EchoSign e-signature service
+Ruby Gem to consume Adobe's EchoSign e-signature service - REST service v2
 
 
 ## Installation
@@ -83,4 +83,3 @@ user_id = client.create_user(user)
 tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
 ```
 
-
diff --git a/doc/Echochamber.html b/doc/Echochamber.html
@@ -80,7 +80,7 @@
 
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/echochamber/user.rb<span class="defines">,<br />
-  lib/echochamber/client.rb,<br /> lib/echochamber/widget.rb,<br /> lib/echochamber/version.rb,<br /> lib/echochamber/reminder.rb,<br /> lib/echochamber/agreement.rb,<br /> lib/echochamber/credentials.rb,<br /> lib/echochamber/validatable.rb,<br /> lib/echochamber/widget/client.rb,<br /> lib/echochamber/agreement/client.rb,<br /> lib/echochamber/agreement/fileinfo.rb,<br /> lib/echochamber/agreement/recipient.rb,<br /> lib/echochamber/widget/widget_status.rb,<br /> lib/echochamber/agreement/phone_info.rb,<br /> lib/echochamber/agreement/url_file_info.rb,<br /> lib/echochamber/library_documents/client.rb,<br /> lib/echochamber/widget/counter_signer_info.rb,<br /> lib/echochamber/widget/widget_vaulting_info.rb,<br /> lib/echochamber/widget/widget_personalization.rb,<br /> lib/echochamber/widget/widget_security_option.rb,<br /> lib/echochamber/widget/widget_completion_info.rb,<br /> lib/echochamber/agreement/recipient_security_option.rb,<br /> lib/echochamber/widget/widget_signer_security_option.rb</span>
+  lib/echochamber/client.rb,<br /> lib/echochamber/widget.rb,<br /> lib/echochamber/version.rb,<br /> lib/echochamber/reminder.rb,<br /> lib/echochamber/agreement.rb,<br /> lib/echochamber/validatable.rb,<br /> lib/echochamber/credentials.rb,<br /> lib/echochamber/widget/client.rb,<br /> lib/echochamber/agreement/client.rb,<br /> lib/echochamber/agreement/fileinfo.rb,<br /> lib/echochamber/agreement/recipient.rb,<br /> lib/echochamber/agreement/phone_info.rb,<br /> lib/echochamber/widget/widget_status.rb,<br /> lib/echochamber/agreement/url_file_info.rb,<br /> lib/echochamber/library_documents/client.rb,<br /> lib/echochamber/widget/counter_signer_info.rb,<br /> lib/echochamber/widget/widget_vaulting_info.rb,<br /> lib/echochamber/widget/widget_security_option.rb,<br /> lib/echochamber/widget/widget_personalization.rb,<br /> lib/echochamber/widget/widget_completion_info.rb,<br /> lib/echochamber/agreement/recipient_security_option.rb,<br /> lib/echochamber/widget/widget_signer_security_option.rb</span>
 </dd>
 
 </dl>
@@ -122,7 +122,7 @@ <h2>Constant Summary</h2>
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:00 2014 by
+  Generated on Thu Aug 21 04:34:33 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Agreement.html b/doc/Echochamber/Agreement.html
@@ -520,7 +520,7 @@ <h3 class="signature " id="user_id-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Client.html b/doc/Echochamber/Client.html
@@ -4152,7 +4152,7 @@ <h3 class="signature " id="update_widget_status-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/CounterSignerInfo.html b/doc/Echochamber/CounterSignerInfo.html
@@ -256,7 +256,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Credentials.html b/doc/Echochamber/Credentials.html
@@ -321,7 +321,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Fileinfo.html b/doc/Echochamber/Fileinfo.html
@@ -294,7 +294,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/ParameterError.html b/doc/Echochamber/ParameterError.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/PhoneInfo.html b/doc/Echochamber/PhoneInfo.html
@@ -270,7 +270,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Recipient.html b/doc/Echochamber/Recipient.html
@@ -300,7 +300,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/RecipientSecurityOption.html b/doc/Echochamber/RecipientSecurityOption.html
@@ -285,7 +285,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Reminder.html b/doc/Echochamber/Reminder.html
@@ -268,7 +268,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Request.html b/doc/Echochamber/Request.html
@@ -4158,7 +4158,7 @@ <h3 class="signature " id="update_widget_status-class_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:00 2014 by
+  Generated on Thu Aug 21 04:34:33 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Request/Failure.html b/doc/Echochamber/Request/Failure.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/RequiredParameterError.html b/doc/Echochamber/RequiredParameterError.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/UrlFileInfo.html b/doc/Echochamber/UrlFileInfo.html
@@ -286,7 +286,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/User.html b/doc/Echochamber/User.html
@@ -411,7 +411,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Validatable.html b/doc/Echochamber/Validatable.html
@@ -346,7 +346,7 @@ <h3 class="signature " id="validate_field-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:00 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/Widget.html b/doc/Echochamber/Widget.html
@@ -645,7 +645,7 @@ <h3 class="signature " id="user_id-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:01 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetCompletionInfo.html b/doc/Echochamber/WidgetCompletionInfo.html
@@ -300,7 +300,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetPersonalization.html b/doc/Echochamber/WidgetPersonalization.html
@@ -317,7 +317,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetSecurityOption.html b/doc/Echochamber/WidgetSecurityOption.html
@@ -350,7 +350,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetSignerSecurityOption.html b/doc/Echochamber/WidgetSignerSecurityOption.html
@@ -287,7 +287,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetStatus.html b/doc/Echochamber/WidgetStatus.html
@@ -305,7 +305,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/Echochamber/WidgetVaultingInfo.html b/doc/Echochamber/WidgetVaultingInfo.html
@@ -256,7 +256,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:02 2014 by
+  Generated on Thu Aug 21 04:34:34 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>

diff --git a/doc/_index.html b/doc/_index.html
@@ -329,7 +329,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 05:31:00 2014 by
+  Generated on Thu Aug 21 04:34:33 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.0.0).
 </div>