echochamber 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cf659753a718f8e0d1592fa4ea2280532c0c797
+  data.tar.gz: 39083288b4fba685d320218d4cde7fc7ffadaa0b
+SHA512:
+  metadata.gz: a44b50187653066e2a57fe185c6b320416e5a6486eeaa33bd1e18e739056681513a02aebdbc0f38811691c0ec5c80761906f969fcbfb65c82ffee94f1a8d5c34
+  data.tar.gz: c72c1d6103bd3e1e8fbe23c5476dfa6673611801f074b9e85aeeae3a43f70d310f49a4d4416396e4112c24e1f1f8a01e02f853e7687d853c92ee3e021a3642e2

data/.gitignore

@@ -0,0 +1,4 @@
+*swp
+.yardoc
+.yardoc/*
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format d
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    echochamber (1.0.0)
+      faraday
+      json
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    highline (1.6.21)
+    hitch (1.0.2)
+      highline (>= 1.6.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.3.3)
+    multipart-post (2.0.0)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    safe_yaml (1.0.1)
+    slop (3.6.0)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+    vcr (2.8.0)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  echochamber!
+  factory_girl
+  hitch
+  pry
+  rake
+  rspec
+  vcr
+  webmock
+  yard

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Cath Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 C. Thomas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+echochamber
+===========
+
+Ruby Gem to consume Adobe's EchoSign e-signature service - REST service v2
+
+
+## Installation
+
+```
+gem install echochamber
+```
+
+## Documentation
+
+The bulk of the API is on the [Echochamber::Client class](http://rdoc.info/github/kayagoban/echochamber/frames/Echochamber/Client)
+
+You can read Echochamber's full [API Documentation](http://rdoc.info/github/kayagoban/echochamber/frames)
+
+It also wouldn't hurt to read Adobe's [Echosign API documentation](https://secure.echosign.com/public/docs/restapi/v2)
+
+## Usage
+
+#### Initializing a client
+
+```
+require 'echochamber'
+
+credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
+
+client = Echochamber::Client.new(credentials)
+```
+
+#### Setting up a new agreement from a URL 
+
+```
+url_file_params = {
+      url:      'http://somedomain.com/contract.pdf',
+      mimeType: 'application/pdf',
+      name:     'contract.pdf'
+}
+
+file_info_params = {
+     documentURL: Echochamber::UrlFileInfo.new(url_file_params) 
+}
+
+recipient_params = {
+     role: 'SIGNER', email: 'superguy@whatsit.com'
+}
+
+agreement_info_params = {
+     fileInfos:       [ Echochamber::Fileinfo.new(file_info_params) ],
+     recipients:      [ Echochamber::Recipient.new(recipient_params)],
+     signatureFlow:   "SENDER_SIGNS_LAST",
+     signatureType:   "ESIGN",
+     name:            "Rumplestiltskin Contract"
+}
+
+agreement = Echochamber::Agreement.new(sender_id, sender_email, agreement_info) 
+
+agreement_id = client.create_agreement(agreement)
+```
+
+#### Cancelling a pending agreement
+```
+result = client.cancel_agreement(agreement_id, true, 'Because...blah blah.')
+```
+
+#### Creating a user
+```
+user_params = {
+      firstName:  'JohnQ',
+      lastName:   'Public',
+      email:      'publius@comcast.net',
+      password:   'kN12oK9p!3',
+      title:      'Hedge Wizard'
+}
+
+user = Echochamber::User.new(user_params)
+
+user_id = client.create_user(user)
+```
+
+#### Sending a transient document for later referral
+```
+tran_doc_id = client.create_transient_document(file_name, mime_type, File.new('myfile.pdf'))
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+    task.rspec_opts = ['--color', '--format', 'documentation', '--fail-fast']
+end
+
+task :default => :spec

data/doc/Echochamber.html

@@ -0,0 +1,131 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Echochamber
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Echochamber.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (E)</a> &raquo;
+    
+    
+    <span class="title">Echochamber</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Echochamber
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <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/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>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Echochamber/Request.html" title="Echochamber::Request (module)">Request</a></span>, <span class='object_link'><a href="Echochamber/Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Echochamber/Agreement.html" title="Echochamber::Agreement (class)">Agreement</a></span>, <span class='object_link'><a href="Echochamber/Client.html" title="Echochamber::Client (class)">Client</a></span>, <span class='object_link'><a href="Echochamber/CounterSignerInfo.html" title="Echochamber::CounterSignerInfo (class)">CounterSignerInfo</a></span>, <span class='object_link'><a href="Echochamber/Credentials.html" title="Echochamber::Credentials (class)">Credentials</a></span>, <span class='object_link'><a href="Echochamber/Fileinfo.html" title="Echochamber::Fileinfo (class)">Fileinfo</a></span>, <span class='object_link'><a href="Echochamber/ParameterError.html" title="Echochamber::ParameterError (class)">ParameterError</a></span>, <span class='object_link'><a href="Echochamber/PhoneInfo.html" title="Echochamber::PhoneInfo (class)">PhoneInfo</a></span>, <span class='object_link'><a href="Echochamber/Recipient.html" title="Echochamber::Recipient (class)">Recipient</a></span>, <span class='object_link'><a href="Echochamber/RecipientSecurityOption.html" title="Echochamber::RecipientSecurityOption (class)">RecipientSecurityOption</a></span>, <span class='object_link'><a href="Echochamber/Reminder.html" title="Echochamber::Reminder (class)">Reminder</a></span>, <span class='object_link'><a href="Echochamber/RequiredParameterError.html" title="Echochamber::RequiredParameterError (class)">RequiredParameterError</a></span>, <span class='object_link'><a href="Echochamber/UrlFileInfo.html" title="Echochamber::UrlFileInfo (class)">UrlFileInfo</a></span>, <span class='object_link'><a href="Echochamber/User.html" title="Echochamber::User (class)">User</a></span>, <span class='object_link'><a href="Echochamber/Widget.html" title="Echochamber::Widget (class)">Widget</a></span>, <span class='object_link'><a href="Echochamber/WidgetCompletionInfo.html" title="Echochamber::WidgetCompletionInfo (class)">WidgetCompletionInfo</a></span>, <span class='object_link'><a href="Echochamber/WidgetPersonalization.html" title="Echochamber::WidgetPersonalization (class)">WidgetPersonalization</a></span>, <span class='object_link'><a href="Echochamber/WidgetSecurityOption.html" title="Echochamber::WidgetSecurityOption (class)">WidgetSecurityOption</a></span>, <span class='object_link'><a href="Echochamber/WidgetSignerSecurityOption.html" title="Echochamber::WidgetSignerSecurityOption (class)">WidgetSignerSecurityOption</a></span>, <span class='object_link'><a href="Echochamber/WidgetStatus.html" title="Echochamber::WidgetStatus (class)">WidgetStatus</a></span>, <span class='object_link'><a href="Echochamber/WidgetVaultingInfo.html" title="Echochamber::WidgetVaultingInfo (class)">WidgetVaultingInfo</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Aug 21 05:14: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>
+
+  </body>
+</html>

data/doc/Echochamber/Agreement.html

@@ -0,0 +1,529 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Echochamber::Agreement
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Echochamber/Agreement.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
+     &raquo; 
+    <span class="title">Agreement</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Echochamber::Agreement
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Hash</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Hash</li>
+          
+            <li class="next">Echochamber::Agreement</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></dd>
+      
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/echochamber/agreement.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#user_email-instance_method" title="#user_email (instance method)">- (Object) <strong>user_email</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute user_email.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#user_id-instance_method" title="#user_id (instance method)">- (Object) <strong>user_id</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute user_id.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Echochamber::Agreement) <strong>initialize</strong>(user_id = nil, user_email = nil, params) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Creates an agreement object for submission.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echochamber::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echochamber::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echochamber::Validatable#validate_field (method)">#validate_field</a></span></p>
+
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="Echochamber::Agreement (class)">Echochamber::Agreement</a></span></tt>) <strong>initialize</strong>(user_id = nil, user_email = nil, params) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Creates an agreement object for submission</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>user_id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>ID of the user whom this agreement is made for</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>user_email</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Email of the user whom this agreement is made for</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>params</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>SYMBOL-referenced Hash containing:</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:fileInfos</span>
+          <span class="type">(<tt>Array</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>A list of one or more files (or references to files) that will be sent out
+for signature. If more than one file is provided, they will be combined
+into one PDF before being sent out. Note: Only one of the four parameters
+in every FileInfo object must be specified.  Populate the array with
+instances of <span class='object_link'><a href="Fileinfo.html" title="Echochamber::Fileinfo (class)">Echochamber::Fileinfo</a></span> (REQUIRED)</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:recipients</span>
+          <span class="type">(<tt>Array</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>A list of one or more recipients. For regular (non-MegaSign) documents,
+there is no limit on the number of electronic signatures in a single
+document. Written signatures are limited to four per document. This limit
+includes the sender if the sender&#39;s signature is also required. 
+Populate the array with instances of <span class='object_link'><a href="Recipient.html" title="Echochamber::Recipient (class)">Echochamber::Recipient</a></span> (REQUIRED)</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:signatureFlow</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>[&#39;SENDER_SIGNATURE_NOT_REQUIRED&#39; or &#39;SENDER_SIGNS_LAST&#39; or
+&#39;SENDER_SIGNS_FIRST&#39; or &#39;SEQUENTIAL&#39; or
+&#39;PARALLEL&#39;]: Selects the workflow you would like to use - whether
+the sender needs to sign before the recipient, after the recipient, or not
+at all. The possible values for this variable are
+SENDER_SIGNATURE_NOT_REQUIRED, SENDER_SIGNS_LAST, SENDER_SIGNS_FIRST,
+SEQUENTIAL or PARALLEL.  (REQUIRED)</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:signatureType</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>[&#39;ESIGN&#39; or &#39;WRITTEN&#39;]: Specifies the type of signature you
+would like to request - written or eSignature. The possible values are
+ESIGN or WRITTEN  (REQUIRED)</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:name</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>The name of the agreement that will be used to identify it, in emails and
+on the website. (REQUIRED)</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+23
+24
+25
+26
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echochamber/agreement.rb', line 23</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='ivar'>@user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
+  <span class='ivar'>@user_email</span> <span class='op'>=</span> <span class='id identifier rubyid_user_email'>user_email</span>
+  <span class='comment'>#TODO (cthomas) barf if user_id or user_email are blank
+</span>  <span class='id identifier rubyid_require_keys'>require_keys</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:signatureType</span><span class='comma'>,</span> <span class='symbol'>:recipients</span><span class='comma'>,</span> <span class='symbol'>:signatureFlow</span><span class='comma'>,</span> <span class='symbol'>:fileInfos</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>documentCreationInfo:</span> <span class='id identifier rubyid_params'>params</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="user_email=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="user_email-instance_method">
+  
+    - (<tt>Object</tt>) <strong>user_email</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute user_email</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echochamber/agreement.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_user_email'>user_email</span>
+  <span class='ivar'>@user_email</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id="user_id=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="user_id-instance_method">
+  
+    - (<tt>Object</tt>) <strong>user_id</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute user_id</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echochamber/agreement.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
+  <span class='ivar'>@user_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Aug 21 05:14: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>
+
+  </body>
+</html>