From 19669d97f8714262d3881bedfa948f36107ea2e8 Mon Sep 17 00:00:00 2001 From: "C. Thomas" Date: Thu, 21 Aug 2014 04:34:48 -0500 Subject: [PATCH] Update documentation --- README.md | 3 +- doc/Echochamber.html | 4 +- doc/Echochamber/Agreement.html | 2 +- doc/Echochamber/Client.html | 2 +- doc/Echochamber/CounterSignerInfo.html | 2 +- doc/Echochamber/Credentials.html | 2 +- doc/Echochamber/Fileinfo.html | 2 +- doc/Echochamber/ParameterError.html | 2 +- doc/Echochamber/PhoneInfo.html | 2 +- doc/Echochamber/Recipient.html | 2 +- doc/Echochamber/RecipientSecurityOption.html | 2 +- doc/Echochamber/Reminder.html | 2 +- doc/Echochamber/Request.html | 2 +- doc/Echochamber/Request/Failure.html | 2 +- doc/Echochamber/RequiredParameterError.html | 2 +- doc/Echochamber/UrlFileInfo.html | 2 +- doc/Echochamber/User.html | 2 +- doc/Echochamber/Validatable.html | 2 +- doc/Echochamber/Widget.html | 2 +- doc/Echochamber/WidgetCompletionInfo.html | 2 +- doc/Echochamber/WidgetPersonalization.html | 2 +- doc/Echochamber/WidgetSecurityOption.html | 2 +- .../WidgetSignerSecurityOption.html | 2 +- doc/Echochamber/WidgetStatus.html | 2 +- doc/Echochamber/WidgetVaultingInfo.html | 2 +- doc/_index.html | 2 +- doc/file.README.html | 54 ++++++++++--------- doc/index.html | 54 ++++++++++--------- doc/method_list.html | 28 +++++----- doc/top-level-namespace.html | 2 +- 30 files changed, 98 insertions(+), 95 deletions(-) diff --git a/README.md b/README.md index f4253e8..1866d8a 100644 --- 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 index 44ec5ef..9216d3a 100644 --- a/doc/Echochamber.html +++ b/doc/Echochamber.html @@ -80,7 +80,7 @@
Defined in:
lib/echochamber/user.rb,
- lib/echochamber/client.rb,
lib/echochamber/widget.rb,
lib/echochamber/version.rb,
lib/echochamber/reminder.rb,
lib/echochamber/agreement.rb,
lib/echochamber/credentials.rb,
lib/echochamber/validatable.rb,
lib/echochamber/widget/client.rb,
lib/echochamber/agreement/client.rb,
lib/echochamber/agreement/fileinfo.rb,
lib/echochamber/agreement/recipient.rb,
lib/echochamber/widget/widget_status.rb,
lib/echochamber/agreement/phone_info.rb,
lib/echochamber/agreement/url_file_info.rb,
lib/echochamber/library_documents/client.rb,
lib/echochamber/widget/counter_signer_info.rb,
lib/echochamber/widget/widget_vaulting_info.rb,
lib/echochamber/widget/widget_personalization.rb,
lib/echochamber/widget/widget_security_option.rb,
lib/echochamber/widget/widget_completion_info.rb,
lib/echochamber/agreement/recipient_security_option.rb,
lib/echochamber/widget/widget_signer_security_option.rb + lib/echochamber/client.rb,
lib/echochamber/widget.rb,
lib/echochamber/version.rb,
lib/echochamber/reminder.rb,
lib/echochamber/agreement.rb,
lib/echochamber/validatable.rb,
lib/echochamber/credentials.rb,
lib/echochamber/widget/client.rb,
lib/echochamber/agreement/client.rb,
lib/echochamber/agreement/fileinfo.rb,
lib/echochamber/agreement/recipient.rb,
lib/echochamber/agreement/phone_info.rb,
lib/echochamber/widget/widget_status.rb,
lib/echochamber/agreement/url_file_info.rb,
lib/echochamber/library_documents/client.rb,
lib/echochamber/widget/counter_signer_info.rb,
lib/echochamber/widget/widget_vaulting_info.rb,
lib/echochamber/widget/widget_security_option.rb,
lib/echochamber/widget/widget_personalization.rb,
lib/echochamber/widget/widget_completion_info.rb,
lib/echochamber/agreement/recipient_security_option.rb,
lib/echochamber/widget/widget_signer_security_option.rb
@@ -122,7 +122,7 @@

Constant Summary

diff --git a/doc/Echochamber/Agreement.html b/doc/Echochamber/Agreement.html index 515acc4..05762eb 100644 --- a/doc/Echochamber/Agreement.html +++ b/doc/Echochamber/Agreement.html @@ -520,7 +520,7 @@

diff --git a/doc/Echochamber/Client.html b/doc/Echochamber/Client.html index 7331e3d..f141f51 100644 --- a/doc/Echochamber/Client.html +++ b/doc/Echochamber/Client.html @@ -4152,7 +4152,7 @@

diff --git a/doc/Echochamber/CounterSignerInfo.html b/doc/Echochamber/CounterSignerInfo.html index 6929129..2bb0720 100644 --- a/doc/Echochamber/CounterSignerInfo.html +++ b/doc/Echochamber/CounterSignerInfo.html @@ -256,7 +256,7 @@

diff --git a/doc/Echochamber/Credentials.html b/doc/Echochamber/Credentials.html index 90bc910..ea69b82 100644 --- a/doc/Echochamber/Credentials.html +++ b/doc/Echochamber/Credentials.html @@ -321,7 +321,7 @@

diff --git a/doc/Echochamber/Fileinfo.html b/doc/Echochamber/Fileinfo.html index 048f74c..8ac3c2d 100644 --- a/doc/Echochamber/Fileinfo.html +++ b/doc/Echochamber/Fileinfo.html @@ -294,7 +294,7 @@

diff --git a/doc/Echochamber/ParameterError.html b/doc/Echochamber/ParameterError.html index ded3013..3acacce 100644 --- a/doc/Echochamber/ParameterError.html +++ b/doc/Echochamber/ParameterError.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/PhoneInfo.html b/doc/Echochamber/PhoneInfo.html index 8b6b4f8..c51beef 100644 --- a/doc/Echochamber/PhoneInfo.html +++ b/doc/Echochamber/PhoneInfo.html @@ -270,7 +270,7 @@

diff --git a/doc/Echochamber/Recipient.html b/doc/Echochamber/Recipient.html index cf2f1e9..6bbfa98 100644 --- a/doc/Echochamber/Recipient.html +++ b/doc/Echochamber/Recipient.html @@ -300,7 +300,7 @@

diff --git a/doc/Echochamber/RecipientSecurityOption.html b/doc/Echochamber/RecipientSecurityOption.html index 011288e..6b88539 100644 --- a/doc/Echochamber/RecipientSecurityOption.html +++ b/doc/Echochamber/RecipientSecurityOption.html @@ -285,7 +285,7 @@

diff --git a/doc/Echochamber/Reminder.html b/doc/Echochamber/Reminder.html index 7f98f8b..b2dd3cf 100644 --- a/doc/Echochamber/Reminder.html +++ b/doc/Echochamber/Reminder.html @@ -268,7 +268,7 @@

diff --git a/doc/Echochamber/Request.html b/doc/Echochamber/Request.html index 91d6664..fbfd67a 100644 --- a/doc/Echochamber/Request.html +++ b/doc/Echochamber/Request.html @@ -4158,7 +4158,7 @@

diff --git a/doc/Echochamber/Request/Failure.html b/doc/Echochamber/Request/Failure.html index 64bad8a..345b0c6 100644 --- a/doc/Echochamber/Request/Failure.html +++ b/doc/Echochamber/Request/Failure.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/RequiredParameterError.html b/doc/Echochamber/RequiredParameterError.html index cefc9a7..bc9befa 100644 --- a/doc/Echochamber/RequiredParameterError.html +++ b/doc/Echochamber/RequiredParameterError.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/UrlFileInfo.html b/doc/Echochamber/UrlFileInfo.html index ead130b..3ef218c 100644 --- a/doc/Echochamber/UrlFileInfo.html +++ b/doc/Echochamber/UrlFileInfo.html @@ -286,7 +286,7 @@

diff --git a/doc/Echochamber/User.html b/doc/Echochamber/User.html index a99db43..06db057 100644 --- a/doc/Echochamber/User.html +++ b/doc/Echochamber/User.html @@ -411,7 +411,7 @@

diff --git a/doc/Echochamber/Validatable.html b/doc/Echochamber/Validatable.html index 481aec5..009c074 100644 --- a/doc/Echochamber/Validatable.html +++ b/doc/Echochamber/Validatable.html @@ -346,7 +346,7 @@

diff --git a/doc/Echochamber/Widget.html b/doc/Echochamber/Widget.html index 5ea5e2d..4ae3681 100644 --- a/doc/Echochamber/Widget.html +++ b/doc/Echochamber/Widget.html @@ -645,7 +645,7 @@

diff --git a/doc/Echochamber/WidgetCompletionInfo.html b/doc/Echochamber/WidgetCompletionInfo.html index 75c28c7..229ffc7 100644 --- a/doc/Echochamber/WidgetCompletionInfo.html +++ b/doc/Echochamber/WidgetCompletionInfo.html @@ -300,7 +300,7 @@

diff --git a/doc/Echochamber/WidgetPersonalization.html b/doc/Echochamber/WidgetPersonalization.html index 395c758..15149e3 100644 --- a/doc/Echochamber/WidgetPersonalization.html +++ b/doc/Echochamber/WidgetPersonalization.html @@ -317,7 +317,7 @@

diff --git a/doc/Echochamber/WidgetSecurityOption.html b/doc/Echochamber/WidgetSecurityOption.html index 9a33b20..f9a5fe5 100644 --- a/doc/Echochamber/WidgetSecurityOption.html +++ b/doc/Echochamber/WidgetSecurityOption.html @@ -350,7 +350,7 @@

diff --git a/doc/Echochamber/WidgetSignerSecurityOption.html b/doc/Echochamber/WidgetSignerSecurityOption.html index 55052ad..085023c 100644 --- a/doc/Echochamber/WidgetSignerSecurityOption.html +++ b/doc/Echochamber/WidgetSignerSecurityOption.html @@ -287,7 +287,7 @@

diff --git a/doc/Echochamber/WidgetStatus.html b/doc/Echochamber/WidgetStatus.html index 2204e90..b1c5aaa 100644 --- a/doc/Echochamber/WidgetStatus.html +++ b/doc/Echochamber/WidgetStatus.html @@ -305,7 +305,7 @@

diff --git a/doc/Echochamber/WidgetVaultingInfo.html b/doc/Echochamber/WidgetVaultingInfo.html index a27d5ad..72fee59 100644 --- a/doc/Echochamber/WidgetVaultingInfo.html +++ b/doc/Echochamber/WidgetVaultingInfo.html @@ -256,7 +256,7 @@

diff --git a/doc/_index.html b/doc/_index.html index 3d94088..603b054 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -329,7 +329,7 @@

Namespace Listing A-Z

diff --git a/doc/file.README.html b/doc/file.README.html index 980e87b..1aea0ff 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -61,33 +61,39 @@ -

echochamber

+
+

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

+

Installation

-
gem install echochamber
-
+
gem install echochamber
-

Documentation

+

Documentation

-

The bulk of the API is on the Echochamber::Client class

+

The bulk of the API is on the Echochamber::Client +class

-

You can read Echochamber's full API Documentation

+

You can read Echochamber's full API +Documentation

-

It also wouldn't hurt to read Adobe's Echosign API documentation

+

It also wouldn't hurt to read Adobe's Echosign API +documentation

-

Usage

+

Usage

-

Initializing a client

+

Initializing a client

credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
 
-client = Echochamber::Client.new(credentials)
-
+client = Echochamber::Client.new(credentials) -

Setting up a new agreement from a URL

+

Setting up a new agreement from a URL

url_file_params = {
       url:      'http://somedomain.com/contract.pdf',
@@ -113,15 +119,13 @@ 
Setting up a new agreement from a URL

 
 agreement = Echochamber::Agreement.new(sender_id, sender_email, agreement_info) 
 
-agreement_id = client.create_agreement(agreement)
-
+agreement_id = client.create_agreement(agreement) -

Cancelling a pending agreement

+

Cancelling a pending agreement

-
result = client.cancel_agreement(agreement_id, true, 'Because...blah blah.')
-
+
result = client.cancel_agreement(agreement_id, true, 'Because...blah blah.')
-

Creating a user

+

Creating a user

user_params = {
       firstName:  'JohnQ',
@@ -133,17 +137,15 @@ 
Creating a user

 
 user = Echochamber::User.new(user_params)
 
-user_id = client.create_user(user)
-
+user_id = client.create_user(user) -

Sending a transient document for later referral

+

Sending a transient document for later referral

-
tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
-
+
tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
diff --git a/doc/index.html b/doc/index.html index 980e87b..1aea0ff 100644 --- a/doc/index.html +++ b/doc/index.html @@ -61,33 +61,39 @@ -

echochamber

+
+

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

+

Installation

-
gem install echochamber
-
+
gem install echochamber
-

Documentation

+

Documentation

-

The bulk of the API is on the Echochamber::Client class

+

The bulk of the API is on the Echochamber::Client +class

-

You can read Echochamber's full API Documentation

+

You can read Echochamber's full API +Documentation

-

It also wouldn't hurt to read Adobe's Echosign API documentation

+

It also wouldn't hurt to read Adobe's Echosign API +documentation

-

Usage

+

Usage

-

Initializing a client

+

Initializing a client

credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
 
-client = Echochamber::Client.new(credentials)
-
+client = Echochamber::Client.new(credentials) -

Setting up a new agreement from a URL

+

Setting up a new agreement from a URL

url_file_params = {
       url:      'http://somedomain.com/contract.pdf',
@@ -113,15 +119,13 @@ 
Setting up a new agreement from a URL

 
 agreement = Echochamber::Agreement.new(sender_id, sender_email, agreement_info) 
 
-agreement_id = client.create_agreement(agreement)
-
+agreement_id = client.create_agreement(agreement) -

Cancelling a pending agreement

+

Cancelling a pending agreement

-
result = client.cancel_agreement(agreement_id, true, 'Because...blah blah.')
-
+
result = client.cancel_agreement(agreement_id, true, 'Because...blah blah.')
-

Creating a user

+

Creating a user

user_params = {
       firstName:  'JohnQ',
@@ -133,17 +137,15 @@ 
Creating a user

 
 user = Echochamber::User.new(user_params)
 
-user_id = client.create_user(user)
-
+user_id = client.create_user(user) -

Sending a transient document for later referral

+

Sending a transient document for later referral

-
tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
-
+
tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
diff --git a/doc/method_list.html b/doc/method_list.html index 9b4b9e6..8c5131f 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -372,20 +372,20 @@

Method List

  • - #initialize - Echochamber::Credentials + #initialize + Echochamber::WidgetVaultingInfo
  • - #initialize - Echochamber::WidgetPersonalization + #initialize + Echochamber::WidgetSecurityOption
  • - #initialize - Echochamber::WidgetSecurityOption + #initialize + Echochamber::WidgetPersonalization
    • @@ -396,8 +396,8 @@

    Method List

  • - #initialize - Echochamber::WidgetVaultingInfo + #initialize + Echochamber::CounterSignerInfo
    • @@ -420,8 +420,8 @@

    Method List

  • - #initialize - Echochamber::CounterSignerInfo + #initialize + Echochamber::Credentials
    • @@ -450,8 +450,8 @@

    Method List

  • - #initialize - Echochamber::PhoneInfo + #initialize + Echochamber::WidgetStatus
    • @@ -468,8 +468,8 @@

    Method List

  • - #initialize - Echochamber::WidgetStatus + #initialize + Echochamber::PhoneInfo
    • diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index f0f3f9d..9c4682a 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -103,7 +103,7 @@

    Defined Under Namespace