echosign 1.0.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -1
  3. data/.rubocop.yml +14 -0
  4. data/.rubocop_todo.yml +241 -0
  5. data/.simplecov +2 -0
  6. data/.travis.yml +9 -0
  7. data/Gemfile +3 -3
  8. data/Gemfile.lock +74 -48
  9. data/README.md +43 -8
  10. data/Rakefile +2 -2
  11. data/doc/Echosign.html +135 -0
  12. data/doc/Echosign/Agreement.html +545 -0
  13. data/doc/Echosign/Client.html +5365 -0
  14. data/doc/Echosign/CounterSignerInfo.html +267 -0
  15. data/doc/Echosign/Credentials.html +1053 -0
  16. data/doc/Echosign/Fileinfo.html +305 -0
  17. data/doc/Echosign/FormFieldLocation.html +264 -0
  18. data/doc/Echosign/MegaSign.html +533 -0
  19. data/doc/Echosign/ParameterError.html +124 -0
  20. data/doc/Echosign/PhoneInfo.html +281 -0
  21. data/doc/Echosign/Recipient.html +311 -0
  22. data/doc/Echosign/RecipientSecurityOption.html +296 -0
  23. data/doc/Echosign/Refresh.html +288 -0
  24. data/doc/Echosign/Reminder.html +279 -0
  25. data/doc/Echosign/Request.html +5289 -0
  26. data/doc/Echosign/Request/EndpointHash.html +328 -0
  27. data/doc/Echosign/Request/Failure.html +290 -0
  28. data/doc/Echosign/RequestFormField.html +244 -0
  29. data/doc/Echosign/RequiredParameterError.html +124 -0
  30. data/doc/Echosign/UrlFileInfo.html +297 -0
  31. data/doc/Echosign/User.html +422 -0
  32. data/doc/Echosign/Validatable.html +355 -0
  33. data/doc/Echosign/Widget.html +924 -0
  34. data/doc/Echosign/WidgetCompletionInfo.html +323 -0
  35. data/doc/Echosign/WidgetPersonalization.html +330 -0
  36. data/doc/Echosign/WidgetSecurityOption.html +361 -0
  37. data/doc/Echosign/WidgetSignerSecurityOption.html +298 -0
  38. data/doc/Echosign/WidgetStatus.html +316 -0
  39. data/doc/Echosign/WidgetVaultingInfo.html +267 -0
  40. data/doc/_index.html +378 -0
  41. data/doc/class_list.html +51 -0
  42. data/doc/css/common.css +1 -0
  43. data/doc/css/full_list.css +58 -0
  44. data/doc/css/style.css +496 -0
  45. data/doc/file.README.html +191 -0
  46. data/doc/file_list.html +56 -0
  47. data/doc/frames.html +17 -0
  48. data/doc/index.html +191 -0
  49. data/doc/js/app.js +292 -0
  50. data/doc/js/full_list.js +216 -0
  51. data/doc/js/jquery.js +4 -0
  52. data/doc/method_list.html +1035 -0
  53. data/doc/top-level-namespace.html +110 -0
  54. data/echosign.gemspec +18 -20
  55. data/features/support/env.rb +8 -8
  56. data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +2 -2
  57. data/fixtures/vcr_cassettes/agreement_document_file.yml +1 -1
  58. data/fixtures/vcr_cassettes/agreement_documents.yml +2 -2
  59. data/fixtures/vcr_cassettes/agreement_form_data.yml +1 -1
  60. data/fixtures/vcr_cassettes/agreement_info.yml +1 -1
  61. data/fixtures/vcr_cassettes/agreement_signing_urls.yml +1 -1
  62. data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1 -1
  63. data/fixtures/vcr_cassettes/cancel_agreement.yml +1 -1
  64. data/fixtures/vcr_cassettes/create_agreement.yml +1 -1
  65. data/fixtures/vcr_cassettes/create_reminder.yml +1 -1
  66. data/fixtures/vcr_cassettes/create_transient_document.yml +1 -1
  67. data/fixtures/vcr_cassettes/create_user.yml +1 -1
  68. data/fixtures/vcr_cassettes/create_widget.yml +1 -1
  69. data/fixtures/vcr_cassettes/get_agreements.yml +1 -1
  70. data/fixtures/vcr_cassettes/get_library_document.yml +1 -1
  71. data/fixtures/vcr_cassettes/get_library_document_data.yml +1 -1
  72. data/fixtures/vcr_cassettes/get_library_document_file.yml +1 -1
  73. data/fixtures/vcr_cassettes/get_library_documents.yml +1 -1
  74. data/fixtures/vcr_cassettes/get_token.yml +22 -20
  75. data/fixtures/vcr_cassettes/get_user.yml +1 -1
  76. data/fixtures/vcr_cassettes/get_users.yml +2 -2
  77. data/fixtures/vcr_cassettes/get_widget.yml +1 -1
  78. data/fixtures/vcr_cassettes/get_widget_document_file.yml +1 -1
  79. data/fixtures/vcr_cassettes/get_widget_documents.yml +1 -1
  80. data/fixtures/vcr_cassettes/get_widgets.yml +1 -1
  81. data/fixtures/vcr_cassettes/library_combined_document.yml +2 -2
  82. data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1 -1
  83. data/fixtures/vcr_cassettes/personalize_widget.yml +1 -1
  84. data/fixtures/vcr_cassettes/refresh_token.yml +46 -0
  85. data/fixtures/vcr_cassettes/revoke_token.yml +44 -0
  86. data/fixtures/vcr_cassettes/update_widget_status.yml +1 -1
  87. data/lib/echosign.rb +11 -11
  88. data/lib/echosign/agreement.rb +26 -10
  89. data/lib/echosign/agreement/client.rb +111 -104
  90. data/lib/echosign/agreement/fileinfo.rb +1 -3
  91. data/lib/echosign/agreement/form_field_location.rb +2 -3
  92. data/lib/echosign/agreement/phone_info.rb +5 -5
  93. data/lib/echosign/agreement/recipient.rb +9 -8
  94. data/lib/echosign/agreement/recipient_security_option.rb +5 -4
  95. data/lib/echosign/agreement/request.rb +33 -43
  96. data/lib/echosign/agreement/request_form_field.rb +2 -3
  97. data/lib/echosign/agreement/url_file_info.rb +8 -6
  98. data/lib/echosign/client.rb +33 -24
  99. data/lib/echosign/credentials.rb +95 -24
  100. data/lib/echosign/library_documents/client.rb +18 -23
  101. data/lib/echosign/library_documents/request.rb +19 -20
  102. data/lib/echosign/mega_sign.rb +20 -10
  103. data/lib/echosign/mega_sign/client.rb +109 -104
  104. data/lib/echosign/mega_sign/request.rb +32 -43
  105. data/lib/echosign/refresh.rb +6 -10
  106. data/lib/echosign/reminder.rb +2 -2
  107. data/lib/echosign/request.rb +85 -75
  108. data/lib/echosign/user.rb +13 -7
  109. data/lib/echosign/validatable.rb +6 -10
  110. data/lib/echosign/version.rb +1 -1
  111. data/lib/echosign/widget.rb +53 -27
  112. data/lib/echosign/widget/client.rb +33 -36
  113. data/lib/echosign/widget/counter_signer_info.rb +4 -5
  114. data/lib/echosign/widget/request.rb +28 -52
  115. data/lib/echosign/widget/widget_completion_info.rb +22 -12
  116. data/lib/echosign/widget/widget_personalization.rb +9 -7
  117. data/lib/echosign/widget/widget_security_option.rb +21 -11
  118. data/lib/echosign/widget/widget_signer_security_option.rb +8 -6
  119. data/lib/echosign/widget/widget_status.rb +10 -8
  120. data/lib/echosign/widget/widget_vaulting_info.rb +4 -5
  121. data/spec/lib/agreement/client_spec.rb +25 -31
  122. data/spec/lib/client_spec.rb +15 -18
  123. data/spec/lib/credentials_spec.rb +48 -0
  124. data/spec/lib/library_documents/client_spec.rb +11 -15
  125. data/spec/lib/shared_client.rb +9 -16
  126. data/spec/lib/user_spec.rb +0 -2
  127. data/spec/lib/validatable_spec.rb +12 -18
  128. data/spec/lib/version_spec.rb +1 -1
  129. data/spec/lib/widget/client_spec.rb +46 -49
  130. data/spec/spec_helper.rb +12 -5
  131. metadata +125 -60
  132. data/spec/lib/request_spec.rb +0 -18
data/doc/file.README.html ADDED
@@ -0,0 +1,191 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <p><a href="https://travis-ci.org/chamberflag/echosign"><img
62
+ src="https://travis-ci.org/chamberflag/echosign.svg?branch=master"></a></p>
63
+
64
+ <h1 id="label-echosign">echosign</h1>
65
+
66
+ <p>Ruby Gem to consume Adobe&#39;s EchoSign e-signature service - REST service
67
+ v5</p>
68
+
69
+ <h2 id="label-Installation">Installation</h2>
70
+
71
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_echosign'>echosign</span>
72
+ </code></pre>
73
+
74
+ <h2 id="label-Documentation">Documentation</h2>
75
+
76
+ <p>The bulk of the API is on the <a
77
+ href="http://rdoc.info/github/chamberflag/echosign/frames/Echosign/Client">Echosign::Client
78
+ class</a></p>
79
+
80
+ <p>You can read Echosign&#39;s full <a
81
+ href="http://rdoc.info/github/chamberflag/echosign/frames">API
82
+ Documentation</a></p>
83
+
84
+ <p>It wouldn&#39;t hurt to read Adobe&#39;s <a
85
+ href="https://secure.echosign.com/public/docs/restapi/v5">Echosign API
86
+ documentation</a></p>
87
+
88
+ <h2 id="label-Usage">Usage</h2>
89
+
90
+ <h4 id="label-Initializing+a+client+with+an+existing+refresh+token">Initializing a client with an existing refresh token</h4>
91
+
92
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
93
+
94
+ <span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Credentials.html" title="Echosign::Credentials (class)">Credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Credentials.html#initialize-instance_method" title="Echosign::Credentials#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='rparen'>)</span>
95
+ <span class='id identifier rubyid_access_token'>access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span><span class='lparen'>(</span><span class='id identifier rubyid_refresh_token'>refresh_token</span><span class='rparen'>)</span>
96
+
97
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Client.html" title="Echosign::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Client.html#initialize-instance_method" title="Echosign::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_access_token'>access_token</span><span class='rparen'>)</span>
98
+ </code></pre>
99
+
100
+ <h4 id="label-Initializing+a+client+with+an+authorization+code">Initializing a client with an authorization code</h4>
101
+
102
+ <p>Workflow before authorizing: - <code>redirect_uri</code> must be set in the
103
+ EchoSign API configuration - <code>scope</code> will typically be something
104
+ like <code>&#39;agreement_write:account agreement_send:account&#39;</code></p>
105
+
106
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
107
+
108
+ <span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Credentials.html" title="Echosign::Credentials (class)">Credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Credentials.html#initialize-instance_method" title="Echosign::Credentials#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='rparen'>)</span>
109
+ <span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span> <span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
110
+ </code></pre>
111
+
112
+ <p>Workflow after authorizing: “` require &#39;echosign&#39;</p>
113
+
114
+ <p>credentials = Echosign::Credentials.new(app_id, app_secret) token = <a
115
+ href=":code">credentials.get_token(params</a>, redirect_uri)</p>
116
+
117
+ <h1 id="label-you+should+persist+credentials.refresh_token+somewhere+to+use+in+future">you should persist credentials.refresh_token somewhere to use in future</h1>
118
+
119
+ <p>client = Echosign::Client.new(token) “`</p>
120
+
121
+ <h4 id="label-Initializing+a+client+with+a+legacy+integration+key">Initializing a client with a legacy integration key</h4>
122
+
123
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
124
+
125
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Client.html" title="Echosign::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Client.html#initialize-instance_method" title="Echosign::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_integration_key'>integration_key</span><span class='rparen'>)</span>
126
+ </code></pre>
127
+
128
+ <h4 id="label-Setting+up+a+new+agreement+from+a+URL">Setting up a new agreement from a URL</h4>
129
+
130
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_url_file_params'>url_file_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
131
+ <span class='label'>url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://somedomain.com/contract.pdf</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
132
+ <span class='label'>mimeType:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/pdf</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
133
+ <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contract.pdf</span><span class='tstring_end'>&#39;</span></span>
134
+ <span class='rbrace'>}</span>
135
+
136
+ <span class='id identifier rubyid_file_info_params'>file_info_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
137
+ <span class='label'>documentURL:</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/UrlFileInfo.html" title="Echosign::UrlFileInfo (class)">UrlFileInfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/UrlFileInfo.html#initialize-instance_method" title="Echosign::UrlFileInfo#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_url_file_params'>url_file_params</span><span class='rparen'>)</span>
138
+ <span class='rbrace'>}</span>
139
+
140
+ <span class='id identifier rubyid_recipient_params'>recipient_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
141
+ <span class='label'>role:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SIGNER</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>superguy@whatsit.com</span><span class='tstring_end'>&#39;</span></span>
142
+ <span class='rbrace'>}</span>
143
+
144
+ <span class='id identifier rubyid_agreement_info'>agreement_info</span> <span class='op'>=</span> <span class='lbrace'>{</span>
145
+ <span class='label'>fileInfos:</span> <span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Fileinfo.html" title="Echosign::Fileinfo (class)">Fileinfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Fileinfo.html#initialize-instance_method" title="Echosign::Fileinfo#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_file_info_params'>file_info_params</span><span class='rparen'>)</span> <span class='rbracket'>]</span><span class='comma'>,</span>
146
+ <span class='label'>recipientSetInfos:</span> <span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Recipient.html" title="Echosign::Recipient (class)">Recipient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Recipient.html#initialize-instance_method" title="Echosign::Recipient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_recipient_params'>recipient_params</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
147
+ <span class='label'>signatureFlow:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SENDER_SIGNS_LAST</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
148
+ <span class='label'>signatureType:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ESIGN</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
149
+ <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Rumplestiltskin Contract</span><span class='tstring_end'>&quot;</span></span>
150
+ <span class='rbrace'>}</span>
151
+
152
+ <span class='id identifier rubyid_agreement'>agreement</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Agreement.html" title="Echosign::Agreement (class)">Agreement</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Agreement.html#initialize-instance_method" title="Echosign::Agreement#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sender_id'>sender_id</span><span class='comma'>,</span> <span class='id identifier rubyid_sender_email'>sender_email</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_info'>agreement_info</span><span class='rparen'>)</span>
153
+
154
+ <span class='id identifier rubyid_agreement_id'>agreement_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_agreement'>create_agreement</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement'>agreement</span><span class='rparen'>)</span>
155
+ </code></pre>
156
+
157
+ <h4 id="label-Cancelling+a+pending+agreement">Cancelling a pending agreement</h4>
158
+
159
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_cancel_agreement'>cancel_agreement</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Because...blah blah.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
160
+ </code></pre>
161
+
162
+ <h4 id="label-Creating+a+user">Creating a user</h4>
163
+
164
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_user_params'>user_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
165
+ <span class='label'>firstName:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>JohnQ</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
166
+ <span class='label'>lastName:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Public</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
167
+ <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>publius@comcast.net</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
168
+ <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>kN12oK9p!3</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
169
+ <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hedge Wizard</span><span class='tstring_end'>&#39;</span></span>
170
+ <span class='rbrace'>}</span>
171
+
172
+ <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/User.html" title="Echosign::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/User.html#initialize-instance_method" title="Echosign::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
173
+
174
+ <span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
175
+ </code></pre>
176
+
177
+ <h4 id="label-Sending+a+transient+document+for+later+referral">Sending a transient document for later referral</h4>
178
+
179
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tran_doc_id'>tran_doc_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_transient_document'>create_transient_document</span><span class='lparen'>(</span><span class='id identifier rubyid_file_name'>file_name</span><span class='comma'>,</span> <span class='id identifier rubyid_mime_type'>mime_type</span><span class='comma'>,</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myfile.pdf</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
180
+ </code></pre>
181
+ </div></div>
182
+
183
+ <div id="footer">
184
+ Generated on Thu Oct 18 12:44:43 2018 by
185
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
+ 0.9.16 (ruby-2.6.0).
187
+ </div>
188
+
189
+ </div>
190
+ </body>
191
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.16</title>
6
+ </head>
7
+ <script type="text/javascript" charset="utf-8">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,191 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <p><a href="https://travis-ci.org/chamberflag/echosign"><img
62
+ src="https://travis-ci.org/chamberflag/echosign.svg?branch=master"></a></p>
63
+
64
+ <h1 id="label-echosign">echosign</h1>
65
+
66
+ <p>Ruby Gem to consume Adobe&#39;s EchoSign e-signature service - REST service
67
+ v5</p>
68
+
69
+ <h2 id="label-Installation">Installation</h2>
70
+
71
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_echosign'>echosign</span>
72
+ </code></pre>
73
+
74
+ <h2 id="label-Documentation">Documentation</h2>
75
+
76
+ <p>The bulk of the API is on the <a
77
+ href="http://rdoc.info/github/chamberflag/echosign/frames/Echosign/Client">Echosign::Client
78
+ class</a></p>
79
+
80
+ <p>You can read Echosign&#39;s full <a
81
+ href="http://rdoc.info/github/chamberflag/echosign/frames">API
82
+ Documentation</a></p>
83
+
84
+ <p>It wouldn&#39;t hurt to read Adobe&#39;s <a
85
+ href="https://secure.echosign.com/public/docs/restapi/v5">Echosign API
86
+ documentation</a></p>
87
+
88
+ <h2 id="label-Usage">Usage</h2>
89
+
90
+ <h4 id="label-Initializing+a+client+with+an+existing+refresh+token">Initializing a client with an existing refresh token</h4>
91
+
92
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
93
+
94
+ <span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Credentials.html" title="Echosign::Credentials (class)">Credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Credentials.html#initialize-instance_method" title="Echosign::Credentials#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='rparen'>)</span>
95
+ <span class='id identifier rubyid_access_token'>access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span><span class='lparen'>(</span><span class='id identifier rubyid_refresh_token'>refresh_token</span><span class='rparen'>)</span>
96
+
97
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Client.html" title="Echosign::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Client.html#initialize-instance_method" title="Echosign::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_access_token'>access_token</span><span class='rparen'>)</span>
98
+ </code></pre>
99
+
100
+ <h4 id="label-Initializing+a+client+with+an+authorization+code">Initializing a client with an authorization code</h4>
101
+
102
+ <p>Workflow before authorizing: - <code>redirect_uri</code> must be set in the
103
+ EchoSign API configuration - <code>scope</code> will typically be something
104
+ like <code>&#39;agreement_write:account agreement_send:account&#39;</code></p>
105
+
106
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
107
+
108
+ <span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Credentials.html" title="Echosign::Credentials (class)">Credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Credentials.html#initialize-instance_method" title="Echosign::Credentials#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='rparen'>)</span>
109
+ <span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span> <span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
110
+ </code></pre>
111
+
112
+ <p>Workflow after authorizing: “` require &#39;echosign&#39;</p>
113
+
114
+ <p>credentials = Echosign::Credentials.new(app_id, app_secret) token = <a
115
+ href=":code">credentials.get_token(params</a>, redirect_uri)</p>
116
+
117
+ <h1 id="label-you+should+persist+credentials.refresh_token+somewhere+to+use+in+future">you should persist credentials.refresh_token somewhere to use in future</h1>
118
+
119
+ <p>client = Echosign::Client.new(token) “`</p>
120
+
121
+ <h4 id="label-Initializing+a+client+with+a+legacy+integration+key">Initializing a client with a legacy integration key</h4>
122
+
123
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echosign</span><span class='tstring_end'>&#39;</span></span>
124
+
125
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Client.html" title="Echosign::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Client.html#initialize-instance_method" title="Echosign::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_integration_key'>integration_key</span><span class='rparen'>)</span>
126
+ </code></pre>
127
+
128
+ <h4 id="label-Setting+up+a+new+agreement+from+a+URL">Setting up a new agreement from a URL</h4>
129
+
130
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_url_file_params'>url_file_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
131
+ <span class='label'>url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://somedomain.com/contract.pdf</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
132
+ <span class='label'>mimeType:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/pdf</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
133
+ <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contract.pdf</span><span class='tstring_end'>&#39;</span></span>
134
+ <span class='rbrace'>}</span>
135
+
136
+ <span class='id identifier rubyid_file_info_params'>file_info_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
137
+ <span class='label'>documentURL:</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/UrlFileInfo.html" title="Echosign::UrlFileInfo (class)">UrlFileInfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/UrlFileInfo.html#initialize-instance_method" title="Echosign::UrlFileInfo#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_url_file_params'>url_file_params</span><span class='rparen'>)</span>
138
+ <span class='rbrace'>}</span>
139
+
140
+ <span class='id identifier rubyid_recipient_params'>recipient_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
141
+ <span class='label'>role:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SIGNER</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>superguy@whatsit.com</span><span class='tstring_end'>&#39;</span></span>
142
+ <span class='rbrace'>}</span>
143
+
144
+ <span class='id identifier rubyid_agreement_info'>agreement_info</span> <span class='op'>=</span> <span class='lbrace'>{</span>
145
+ <span class='label'>fileInfos:</span> <span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Fileinfo.html" title="Echosign::Fileinfo (class)">Fileinfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Fileinfo.html#initialize-instance_method" title="Echosign::Fileinfo#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_file_info_params'>file_info_params</span><span class='rparen'>)</span> <span class='rbracket'>]</span><span class='comma'>,</span>
146
+ <span class='label'>recipientSetInfos:</span> <span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Recipient.html" title="Echosign::Recipient (class)">Recipient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Recipient.html#initialize-instance_method" title="Echosign::Recipient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_recipient_params'>recipient_params</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
147
+ <span class='label'>signatureFlow:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SENDER_SIGNS_LAST</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
148
+ <span class='label'>signatureType:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ESIGN</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
149
+ <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Rumplestiltskin Contract</span><span class='tstring_end'>&quot;</span></span>
150
+ <span class='rbrace'>}</span>
151
+
152
+ <span class='id identifier rubyid_agreement'>agreement</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/Agreement.html" title="Echosign::Agreement (class)">Agreement</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/Agreement.html#initialize-instance_method" title="Echosign::Agreement#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sender_id'>sender_id</span><span class='comma'>,</span> <span class='id identifier rubyid_sender_email'>sender_email</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_info'>agreement_info</span><span class='rparen'>)</span>
153
+
154
+ <span class='id identifier rubyid_agreement_id'>agreement_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_agreement'>create_agreement</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement'>agreement</span><span class='rparen'>)</span>
155
+ </code></pre>
156
+
157
+ <h4 id="label-Cancelling+a+pending+agreement">Cancelling a pending agreement</h4>
158
+
159
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_cancel_agreement'>cancel_agreement</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Because...blah blah.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
160
+ </code></pre>
161
+
162
+ <h4 id="label-Creating+a+user">Creating a user</h4>
163
+
164
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_user_params'>user_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
165
+ <span class='label'>firstName:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>JohnQ</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
166
+ <span class='label'>lastName:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Public</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
167
+ <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>publius@comcast.net</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
168
+ <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>kN12oK9p!3</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
169
+ <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hedge Wizard</span><span class='tstring_end'>&#39;</span></span>
170
+ <span class='rbrace'>}</span>
171
+
172
+ <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Echosign.html" title="Echosign (module)">Echosign</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Echosign/User.html" title="Echosign::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Echosign/User.html#initialize-instance_method" title="Echosign::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
173
+
174
+ <span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
175
+ </code></pre>
176
+
177
+ <h4 id="label-Sending+a+transient+document+for+later+referral">Sending a transient document for later referral</h4>
178
+
179
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tran_doc_id'>tran_doc_id</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_transient_document'>create_transient_document</span><span class='lparen'>(</span><span class='id identifier rubyid_file_name'>file_name</span><span class='comma'>,</span> <span class='id identifier rubyid_mime_type'>mime_type</span><span class='comma'>,</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myfile.pdf</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
180
+ </code></pre>
181
+ </div></div>
182
+
183
+ <div id="footer">
184
+ Generated on Thu Oct 18 12:44:43 2018 by
185
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
+ 0.9.16 (ruby-2.6.0).
187
+ </div>
188
+
189
+ </div>
190
+ </body>
191
+ </html>