echochamber 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +4 -0
  3. data/.rspec +2 -0
  4. data/Gemfile +3 -0
  5. data/Gemfile.lock +79 -0
  6. data/LICENSE +21 -0
  7. data/LICENSE.txt +22 -0
  8. data/README.md +87 -0
  9. data/Rakefile +12 -0
  10. data/doc/Echochamber.html +131 -0
  11. data/doc/Echochamber/Agreement.html +529 -0
  12. data/doc/Echochamber/Agreement/UrlFileInfo.html +263 -0
  13. data/doc/Echochamber/Client.html +4161 -0
  14. data/doc/Echochamber/CounterSignerInfo.html +265 -0
  15. data/doc/Echochamber/Credentials.html +330 -0
  16. data/doc/Echochamber/Credentials/CredentialsError.html +123 -0
  17. data/doc/Echochamber/Fileinfo.html +303 -0
  18. data/doc/Echochamber/InvalidParameterError.html +123 -0
  19. data/doc/Echochamber/ParameterError.html +123 -0
  20. data/doc/Echochamber/PhoneInfo.html +279 -0
  21. data/doc/Echochamber/Recipient.html +309 -0
  22. data/doc/Echochamber/RecipientSecurityOption.html +294 -0
  23. data/doc/Echochamber/Reminder.html +277 -0
  24. data/doc/Echochamber/Request.html +4167 -0
  25. data/doc/Echochamber/Request/Failure.html +123 -0
  26. data/doc/Echochamber/RequiredParameterError.html +123 -0
  27. data/doc/Echochamber/UrlFileInfo.html +295 -0
  28. data/doc/Echochamber/User.html +420 -0
  29. data/doc/Echochamber/Validatable.html +355 -0
  30. data/doc/Echochamber/Validator.html +180 -0
  31. data/doc/Echochamber/Widget.html +654 -0
  32. data/doc/Echochamber/WidgetCompletionInfo.html +309 -0
  33. data/doc/Echochamber/WidgetPersonalization.html +326 -0
  34. data/doc/Echochamber/WidgetSecurityOption.html +359 -0
  35. data/doc/Echochamber/WidgetSignerSecurityOption.html +296 -0
  36. data/doc/Echochamber/WidgetStatus.html +314 -0
  37. data/doc/Echochamber/WidgetVaultingInfo.html +265 -0
  38. data/doc/_index.html +338 -0
  39. data/doc/class_list.html +54 -0
  40. data/doc/css/common.css +1 -0
  41. data/doc/css/full_list.css +57 -0
  42. data/doc/css/style.css +339 -0
  43. data/doc/file.README.html +157 -0
  44. data/doc/file_list.html +56 -0
  45. data/doc/frames.html +26 -0
  46. data/doc/index.html +157 -0
  47. data/doc/js/app.js +219 -0
  48. data/doc/js/full_list.js +178 -0
  49. data/doc/js/jquery.js +4 -0
  50. data/doc/method_list.html +581 -0
  51. data/doc/top-level-namespace.html +112 -0
  52. data/echochamber.gemspec +35 -0
  53. data/features/support/env.rb +8 -0
  54. data/fixtures/agreement.pdf +0 -0
  55. data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +1465 -0
  56. data/fixtures/vcr_cassettes/agreement_document_file.yml +1465 -0
  57. data/fixtures/vcr_cassettes/agreement_documents.yml +42 -0
  58. data/fixtures/vcr_cassettes/agreement_form_data.yml +44 -0
  59. data/fixtures/vcr_cassettes/agreement_info.yml +50 -0
  60. data/fixtures/vcr_cassettes/agreement_signing_urls.yml +42 -0
  61. data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1643 -0
  62. data/fixtures/vcr_cassettes/cancel_agreement.yml +46 -0
  63. data/fixtures/vcr_cassettes/create_agreement.yml +50 -0
  64. data/fixtures/vcr_cassettes/create_reminder.yml +47 -0
  65. data/fixtures/vcr_cassettes/create_transient_document.yml +716 -0
  66. data/fixtures/vcr_cassettes/create_user.yml +50 -0
  67. data/fixtures/vcr_cassettes/create_widget.yml +48 -0
  68. data/fixtures/vcr_cassettes/get_agreements.yml +46 -0
  69. data/fixtures/vcr_cassettes/get_library_document.yml +45 -0
  70. data/fixtures/vcr_cassettes/get_library_document_data.yml +1191 -0
  71. data/fixtures/vcr_cassettes/get_library_document_file.yml +42 -0
  72. data/fixtures/vcr_cassettes/get_library_documents.yml +47 -0
  73. data/fixtures/vcr_cassettes/get_token.yml +44 -0
  74. data/fixtures/vcr_cassettes/get_user.yml +46 -0
  75. data/fixtures/vcr_cassettes/get_users.yml +43 -0
  76. data/fixtures/vcr_cassettes/get_widget.yml +49 -0
  77. data/fixtures/vcr_cassettes/get_widget_document_file.yml +2682 -0
  78. data/fixtures/vcr_cassettes/get_widget_documents.yml +44 -0
  79. data/fixtures/vcr_cassettes/get_widgets.yml +50 -0
  80. data/fixtures/vcr_cassettes/library_combined_document.yml +2197 -0
  81. data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1570 -0
  82. data/fixtures/vcr_cassettes/personalize_widget.yml +47 -0
  83. data/fixtures/vcr_cassettes/update_widget_status.yml +46 -0
  84. data/lib/echochamber.rb +10 -0
  85. data/lib/echochamber/agreement.rb +32 -0
  86. data/lib/echochamber/agreement/client.rb +118 -0
  87. data/lib/echochamber/agreement/fileinfo.rb +20 -0
  88. data/lib/echochamber/agreement/phone_info.rb +19 -0
  89. data/lib/echochamber/agreement/recipient.rb +23 -0
  90. data/lib/echochamber/agreement/recipient_security_option.rb +20 -0
  91. data/lib/echochamber/agreement/request.rb +142 -0
  92. data/lib/echochamber/agreement/url_file_info.rb +18 -0
  93. data/lib/echochamber/client.rb +82 -0
  94. data/lib/echochamber/credentials.rb +33 -0
  95. data/lib/echochamber/library_documents/client.rb +83 -0
  96. data/lib/echochamber/library_documents/request.rb +78 -0
  97. data/lib/echochamber/reminder.rb +17 -0
  98. data/lib/echochamber/request.rb +141 -0
  99. data/lib/echochamber/user.rb +29 -0
  100. data/lib/echochamber/validatable.rb +54 -0
  101. data/lib/echochamber/version.rb +3 -0
  102. data/lib/echochamber/widget.rb +42 -0
  103. data/lib/echochamber/widget/client.rb +127 -0
  104. data/lib/echochamber/widget/counter_signer_info.rb +19 -0
  105. data/lib/echochamber/widget/request.rb +135 -0
  106. data/lib/echochamber/widget/widget_completion_info.rb +19 -0
  107. data/lib/echochamber/widget/widget_personalization.rb +21 -0
  108. data/lib/echochamber/widget/widget_security_option.rb +22 -0
  109. data/lib/echochamber/widget/widget_signer_security_option.rb +18 -0
  110. data/lib/echochamber/widget/widget_status.rb +20 -0
  111. data/lib/echochamber/widget/widget_vaulting_info.rb +16 -0
  112. data/spec/lib/agreement/client_spec.rb +157 -0
  113. data/spec/lib/client_spec.rb +78 -0
  114. data/spec/lib/library_documents/client_spec.rb +71 -0
  115. data/spec/lib/request_spec.rb +18 -0
  116. data/spec/lib/shared_client.rb +22 -0
  117. data/spec/lib/user_spec.rb +6 -0
  118. data/spec/lib/validatable_spec.rb +110 -0
  119. data/spec/lib/version_spec.rb +7 -0
  120. data/spec/lib/widget/client_spec.rb +154 -0
  121. data/spec/spec_helper.rb +21 -0
  122. metadata +344 -0
data/doc/Echochamber/Agreement/UrlFileInfo.html ADDED
@@ -0,0 +1,263 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Echochamber::Agreement::UrlFileInfo
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!Echochamber/Agreement/UrlFileInfo.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (U)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Agreement.html" title="Echochamber::Agreement (module)">Agreement</a></span></span>
36
+ &raquo;
37
+ <span class="title">UrlFileInfo</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Echochamber::Agreement::UrlFileInfo
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/echochamber/agreement/url_file_info.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <h2>
96
+ Instance Method Summary
97
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
98
+ </h2>
99
+
100
+ <ul class="summary">
101
+
102
+ <li class="public ">
103
+ <span class="summary_signature">
104
+
105
+ <a href="#build-instance_method" title="#build (instance method)">- (Object) <strong>build</strong>(params) </a>
106
+
107
+
108
+
109
+ </span>
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <span class="summary_desc"><div class='inline'>
120
+ <p>Validates UrlFileInfo parameters.</p>
121
+ </div></span>
122
+
123
+ </li>
124
+
125
+
126
+ </ul>
127
+
128
+
129
+
130
+
131
+ <div id="instance_method_details" class="method_details_list">
132
+ <h2>Instance Method Details</h2>
133
+
134
+
135
+ <div class="method_details first">
136
+ <h3 class="signature first" id="build-instance_method">
137
+
138
+ - (<tt>Object</tt>) <strong>build</strong>(params)
139
+
140
+
141
+
142
+
143
+
144
+ </h3><div class="docstring">
145
+ <div class="discussion">
146
+
147
+ <p>Validates UrlFileInfo parameters</p>
148
+
149
+
150
+ </div>
151
+ </div>
152
+ <div class="tags">
153
+ <p class="tag_title">Parameters:</p>
154
+ <ul class="param">
155
+
156
+ <li>
157
+
158
+ <span class='name'>params</span>
159
+
160
+
161
+ <span class='type'>(<tt>Hash</tt>)</span>
162
+
163
+
164
+
165
+ &mdash;
166
+ <div class='inline'>
167
+ <p>SYMBOL-referenced Hash</p>
168
+ </div>
169
+
170
+ </li>
171
+
172
+ <li>
173
+
174
+ <span class='name'>url</span>
175
+
176
+
177
+ <span class='type'>(<tt>Hash</tt>)</span>
178
+
179
+
180
+
181
+ &mdash;
182
+ <div class='inline'>
183
+ <p>a customizable set of options</p>
184
+ </div>
185
+
186
+ </li>
187
+
188
+ <li>
189
+
190
+ <span class='name'>mimeType</span>
191
+
192
+
193
+ <span class='type'>(<tt>Hash</tt>)</span>
194
+
195
+
196
+
197
+ &mdash;
198
+ <div class='inline'>
199
+ <p>a customizable set of options</p>
200
+ </div>
201
+
202
+ </li>
203
+
204
+ <li>
205
+
206
+ <span class='name'>name</span>
207
+
208
+
209
+ <span class='type'>(<tt>Hash</tt>)</span>
210
+
211
+
212
+
213
+ &mdash;
214
+ <div class='inline'>
215
+ <p>a customizable set of options</p>
216
+ </div>
217
+
218
+ </li>
219
+
220
+ </ul>
221
+
222
+
223
+
224
+
225
+
226
+
227
+ </div><table class="source_code">
228
+ <tr>
229
+ <td>
230
+ <pre class="lines">
231
+
232
+
233
+ 11
234
+ 12
235
+ 13
236
+ 14
237
+ 15</pre>
238
+ </td>
239
+ <td>
240
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/url_file_info.rb', line 11</span>
241
+
242
+ <span class='kw'>def</span> <span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
243
+
244
+ <span class='comment'># TODO validation goes here!
245
+ </span> <span class='id identifier rubyid_params'>params</span>
246
+ <span class='kw'>end</span></pre>
247
+ </td>
248
+ </tr>
249
+ </table>
250
+ </div>
251
+
252
+ </div>
253
+
254
+ </div>
255
+
256
+ <div id="footer">
257
+ Generated on Mon Aug 18 02:34:23 2014 by
258
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
259
+ 0.8.7.4 (ruby-2.0.0).
260
+ </div>
261
+
262
+ </body>
263
+ </html>
data/doc/Echochamber/Client.html ADDED
@@ -0,0 +1,4161 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Echochamber::Client
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Echochamber/Client.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (C)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
36
+ &raquo;
37
+ <span class="title">Client</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Echochamber::Client
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Echochamber::Client</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/echochamber/client.rb<span class="defines">,<br />
98
+ lib/echochamber/widget/client.rb,<br /> lib/echochamber/agreement/client.rb,<br /> lib/echochamber/library_documents/client.rb</span>
99
+ </dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#token-instance_method" title="#token (instance method)">- (Object) <strong>token</strong> </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+ <span class="note title readonly">readonly</span>
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <span class="summary_desc"><div class='inline'>
134
+ <p>Returns the value of attribute token.</p>
135
+ </div></span>
136
+
137
+ </li>
138
+
139
+
140
+ </ul>
141
+
142
+
143
+
144
+
145
+
146
+ <h2>
147
+ Instance Method Summary
148
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
149
+ </h2>
150
+
151
+ <ul class="summary">
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#agreement_combined_pdf-instance_method" title="#agreement_combined_pdf (instance method)">- (String) <strong>agreement_combined_pdf</strong>(agreement_id, file_path = nil, versionId = nil, participantEmail = nil, attachSupportingDocuments = true, auditReport = false) </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+ <span class="summary_desc"><div class='inline'>
171
+ <p>Gets a single combined PDF document for the documents associated with an
172
+ agreement.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#agreement_document_file-instance_method" title="#agreement_document_file (instance method)">- (String) <strong>agreement_document_file</strong>(agreement_id, document_id, file_path = nil) </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Retrieve a document file from an agreement.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#agreement_documents-instance_method" title="#agreement_documents (instance method)">- (Array) <strong>agreement_documents</strong>(agreement_id, recipient_email, format, version_id = nil) </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>All documents relating to an agreement.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#agreement_form_data-instance_method" title="#agreement_form_data (instance method)">- (String) <strong>agreement_form_data</strong>(agreement_id, file_path = nil) </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ <span class="summary_desc"><div class='inline'>
244
+ <p>Retrieves library document audit trail file.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#agreement_info-instance_method" title="#agreement_info (instance method)">- (Hash) <strong>agreement_info</strong>(agreement_id) </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Gets detailed info on an agreement.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#agreement_signing_urls-instance_method" title="#agreement_signing_urls (instance method)">- (Hash) <strong>agreement_signing_urls</strong>(agreement_id) </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'>
292
+ <p>Retrieves the URL for the eSign page for the current signer(s) of an
293
+ agreement.</p>
294
+ </div></span>
295
+
296
+ </li>
297
+
298
+
299
+ <li class="public ">
300
+ <span class="summary_signature">
301
+
302
+ <a href="#audit_trail_pdf-instance_method" title="#audit_trail_pdf (instance method)">- (String) <strong>audit_trail_pdf</strong>(agreement_id, file_path = nil) </a>
303
+
304
+
305
+
306
+ </span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Retrieve a PDF audit file for an agreement.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ <li class="public ">
324
+ <span class="summary_signature">
325
+
326
+ <a href="#cancel_agreement-instance_method" title="#cancel_agreement (instance method)">- (String) <strong>cancel_agreement</strong>(agreement_id, notify_signer = false, comment = nil) </a>
327
+
328
+
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ <span class="summary_desc"><div class='inline'>
341
+ <p>Cancel agreement.</p>
342
+ </div></span>
343
+
344
+ </li>
345
+
346
+
347
+ <li class="public ">
348
+ <span class="summary_signature">
349
+
350
+ <a href="#create_agreement-instance_method" title="#create_agreement (instance method)">- (String) <strong>create_agreement</strong>(agreement) </a>
351
+
352
+
353
+
354
+ </span>
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <span class="summary_desc"><div class='inline'>
365
+ <p>Creates an agreement.</p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ <li class="public ">
372
+ <span class="summary_signature">
373
+
374
+ <a href="#create_reminder-instance_method" title="#create_reminder (instance method)">- (String) <strong>create_reminder</strong>(reminder) </a>
375
+
376
+
377
+
378
+ </span>
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <span class="summary_desc"><div class='inline'>
389
+ <p>Creates a reminder.</p>
390
+ </div></span>
391
+
392
+ </li>
393
+
394
+
395
+ <li class="public ">
396
+ <span class="summary_signature">
397
+
398
+ <a href="#create_transient_document-instance_method" title="#create_transient_document (instance method)">- (String) <strong>create_transient_document</strong>(file_name, mime_type, file_handle) </a>
399
+
400
+
401
+
402
+ </span>
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+ <span class="summary_desc"><div class='inline'>
413
+ <p>Creates a transient document for later referral.</p>
414
+ </div></span>
415
+
416
+ </li>
417
+
418
+
419
+ <li class="public ">
420
+ <span class="summary_signature">
421
+
422
+ <a href="#create_user-instance_method" title="#create_user (instance method)">- (String) <strong>create_user</strong>(user) </a>
423
+
424
+
425
+
426
+ </span>
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+ <span class="summary_desc"><div class='inline'>
437
+ <p>Creates a user for the current application.</p>
438
+ </div></span>
439
+
440
+ </li>
441
+
442
+
443
+ <li class="public ">
444
+ <span class="summary_signature">
445
+
446
+ <a href="#create_widget-instance_method" title="#create_widget (instance method)">- (Hash) <strong>create_widget</strong>(widget) </a>
447
+
448
+
449
+
450
+ </span>
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+ <span class="summary_desc"><div class='inline'>
461
+ <p>Creates a widget and returns the Javascript snippet and URL to access the
462
+ widget and widgetID in response to the client.</p>
463
+ </div></span>
464
+
465
+ </li>
466
+
467
+
468
+ <li class="public ">
469
+ <span class="summary_signature">
470
+
471
+ <a href="#get_agreements-instance_method" title="#get_agreements (instance method)">- (String) <strong>get_agreements</strong> </a>
472
+
473
+
474
+
475
+ </span>
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+ <span class="summary_desc"><div class='inline'>
486
+ <p>Gets list of agreements.</p>
487
+ </div></span>
488
+
489
+ </li>
490
+
491
+
492
+ <li class="public ">
493
+ <span class="summary_signature">
494
+
495
+ <a href="#get_library_document-instance_method" title="#get_library_document (instance method)">- (Hash) <strong>get_library_document</strong>(library_document_id) </a>
496
+
497
+
498
+
499
+ </span>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+ <span class="summary_desc"><div class='inline'>
510
+ <p>Retrieves library document metadata.</p>
511
+ </div></span>
512
+
513
+ </li>
514
+
515
+
516
+ <li class="public ">
517
+ <span class="summary_signature">
518
+
519
+ <a href="#get_library_document_file-instance_method" title="#get_library_document_file (instance method)">- (String) <strong>get_library_document_file</strong>(library_document_id, file_id, file_path = nil) </a>
520
+
521
+
522
+
523
+ </span>
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+ <span class="summary_desc"><div class='inline'>
534
+ <p>Retrieves library document file data.</p>
535
+ </div></span>
536
+
537
+ </li>
538
+
539
+
540
+ <li class="public ">
541
+ <span class="summary_signature">
542
+
543
+ <a href="#get_library_document_files-instance_method" title="#get_library_document_files (instance method)">- (Hash) <strong>get_library_document_files</strong>(library_document_id) </a>
544
+
545
+
546
+
547
+ </span>
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+ <span class="summary_desc"><div class='inline'>
558
+ <p>Retrieves library document files metadata.</p>
559
+ </div></span>
560
+
561
+ </li>
562
+
563
+
564
+ <li class="public ">
565
+ <span class="summary_signature">
566
+
567
+ <a href="#get_library_documents-instance_method" title="#get_library_documents (instance method)">- (Hash) <strong>get_library_documents</strong>(user_id = nil, user_email = nil) </a>
568
+
569
+
570
+
571
+ </span>
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+ <span class="summary_desc"><div class='inline'>
582
+ <p>Retrieves library documents metadata for a user.</p>
583
+ </div></span>
584
+
585
+ </li>
586
+
587
+
588
+ <li class="public ">
589
+ <span class="summary_signature">
590
+
591
+ <a href="#get_user-instance_method" title="#get_user (instance method)">- (Hash) <strong>get_user</strong>(user_id) </a>
592
+
593
+
594
+
595
+ </span>
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+ <span class="summary_desc"><div class='inline'>
606
+ <p>Gets all the users in an account that the caller has permissions to access.</p>
607
+ </div></span>
608
+
609
+ </li>
610
+
611
+
612
+ <li class="public ">
613
+ <span class="summary_signature">
614
+
615
+ <a href="#get_users-instance_method" title="#get_users (instance method)">- (Hash) <strong>get_users</strong>(user_email) </a>
616
+
617
+
618
+
619
+ </span>
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+ <span class="summary_desc"><div class='inline'>
630
+ <p>Gets all the users in an account that the caller has permissions to access.</p>
631
+ </div></span>
632
+
633
+ </li>
634
+
635
+
636
+ <li class="public ">
637
+ <span class="summary_signature">
638
+
639
+ <a href="#get_widget-instance_method" title="#get_widget (instance method)">- (Hash) <strong>get_widget</strong>(widget_id) </a>
640
+
641
+
642
+
643
+ </span>
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+ <span class="summary_desc"><div class='inline'>
654
+ <p>Retrieves the details of a widget.</p>
655
+ </div></span>
656
+
657
+ </li>
658
+
659
+
660
+ <li class="public ">
661
+ <span class="summary_signature">
662
+
663
+ <a href="#get_widget_audit_trail-instance_method" title="#get_widget_audit_trail (instance method)">- (String) <strong>get_widget_audit_trail</strong>(widget_id, file_path = nil) </a>
664
+
665
+
666
+
667
+ </span>
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+ <span class="summary_desc"><div class='inline'>
678
+ <p>Retrieves the audit trail of a widget identified by widgetId.</p>
679
+ </div></span>
680
+
681
+ </li>
682
+
683
+
684
+ <li class="public ">
685
+ <span class="summary_signature">
686
+
687
+ <a href="#get_widget_combined_pdf-instance_method" title="#get_widget_combined_pdf (instance method)">- (String) <strong>get_widget_combined_pdf</strong>(widget_id, file_path = nil) </a>
688
+
689
+
690
+
691
+ </span>
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+ <span class="summary_desc"><div class='inline'>
702
+ <p>Gets a single combined PDF document for the documents associated with a
703
+ widget.</p>
704
+ </div></span>
705
+
706
+ </li>
707
+
708
+
709
+ <li class="public ">
710
+ <span class="summary_signature">
711
+
712
+ <a href="#get_widget_document_file-instance_method" title="#get_widget_document_file (instance method)">- (String) <strong>get_widget_document_file</strong>(widget_id, document_id, file_path = nil) </a>
713
+
714
+
715
+
716
+ </span>
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+ <span class="summary_desc"><div class='inline'>
727
+ <p>Retrieves the file stream of a document of a widget.</p>
728
+ </div></span>
729
+
730
+ </li>
731
+
732
+
733
+ <li class="public ">
734
+ <span class="summary_signature">
735
+
736
+ <a href="#get_widget_documents-instance_method" title="#get_widget_documents (instance method)">- (Hash) <strong>get_widget_documents</strong>(widget_id, version_id = nil, participant_email = nil) </a>
737
+
738
+
739
+
740
+ </span>
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+ <span class="summary_desc"><div class='inline'>
751
+ <p>Retrieves the IDs of the documents associated with widget.</p>
752
+ </div></span>
753
+
754
+ </li>
755
+
756
+
757
+ <li class="public ">
758
+ <span class="summary_signature">
759
+
760
+ <a href="#get_widget_form_data-instance_method" title="#get_widget_form_data (instance method)">- (String) <strong>get_widget_form_data</strong>(widget_id, file_path = nil) </a>
761
+
762
+
763
+
764
+ </span>
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+ <span class="summary_desc"><div class='inline'>
775
+ <p>Retrieves data entered by the user into interactive form fields at the time
776
+ they signed the widget.</p>
777
+ </div></span>
778
+
779
+ </li>
780
+
781
+
782
+ <li class="public ">
783
+ <span class="summary_signature">
784
+
785
+ <a href="#get_widgets-instance_method" title="#get_widgets (instance method)">- (Hash) <strong>get_widgets</strong>(user_id = nil, user_email = nil) </a>
786
+
787
+
788
+
789
+ </span>
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+ <span class="summary_desc"><div class='inline'>
800
+ <p>Retrieves widgets for a user.</p>
801
+ </div></span>
802
+
803
+ </li>
804
+
805
+
806
+ <li class="public ">
807
+ <span class="summary_signature">
808
+
809
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Echochamber::Client) <strong>initialize</strong>(credentials) </a>
810
+
811
+
812
+
813
+ </span>
814
+
815
+
816
+ <span class="note title constructor">constructor</span>
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+ <span class="summary_desc"><div class='inline'>
826
+ <p>Initializes the Client object.</p>
827
+ </div></span>
828
+
829
+ </li>
830
+
831
+
832
+ <li class="public ">
833
+ <span class="summary_signature">
834
+
835
+ <a href="#library_combined_document-instance_method" title="#library_combined_document (instance method)">- (String) <strong>library_combined_document</strong>(library_document_id, file_path = nil, auditReport = false) </a>
836
+
837
+
838
+
839
+ </span>
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <span class="summary_desc"><div class='inline'>
850
+ <p>Retrieves library combined document file.</p>
851
+ </div></span>
852
+
853
+ </li>
854
+
855
+
856
+ <li class="public ">
857
+ <span class="summary_signature">
858
+
859
+ <a href="#library_document_audit_trail-instance_method" title="#library_document_audit_trail (instance method)">- (String) <strong>library_document_audit_trail</strong>(library_document_id, file_path = nil) </a>
860
+
861
+
862
+
863
+ </span>
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+
872
+
873
+ <span class="summary_desc"><div class='inline'>
874
+ <p>Retrieves library document audit trail file.</p>
875
+ </div></span>
876
+
877
+ </li>
878
+
879
+
880
+ <li class="public ">
881
+ <span class="summary_signature">
882
+
883
+ <a href="#personalize_widget-instance_method" title="#personalize_widget (instance method)">- (Hash) <strong>personalize_widget</strong>(widget_id, personalization) </a>
884
+
885
+
886
+
887
+ </span>
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+ <span class="summary_desc"><div class='inline'>
898
+ <p>Personalize the widget to a signable document for a specific known user.</p>
899
+ </div></span>
900
+
901
+ </li>
902
+
903
+
904
+ <li class="public ">
905
+ <span class="summary_signature">
906
+
907
+ <a href="#update_widget_status-instance_method" title="#update_widget_status (instance method)">- (Hash) <strong>update_widget_status</strong>(widget_id, status) </a>
908
+
909
+
910
+
911
+ </span>
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+ <span class="summary_desc"><div class='inline'>
922
+ <p>Enables or Disables a widget.</p>
923
+ </div></span>
924
+
925
+ </li>
926
+
927
+
928
+ </ul>
929
+
930
+
931
+ <div id="constructor_details" class="method_details_list">
932
+ <h2>Constructor Details</h2>
933
+
934
+ <div class="method_details first">
935
+ <h3 class="signature first" id="initialize-instance_method">
936
+
937
+ - (<tt><span class='object_link'><a href="" title="Echochamber::Client (class)">Echochamber::Client</a></span></tt>) <strong>initialize</strong>(credentials)
938
+
939
+
940
+
941
+
942
+
943
+ </h3><div class="docstring">
944
+ <div class="discussion">
945
+
946
+ <p>Initializes the Client object</p>
947
+
948
+
949
+ </div>
950
+ </div>
951
+ <div class="tags">
952
+ <p class="tag_title">Parameters:</p>
953
+ <ul class="param">
954
+
955
+ <li>
956
+
957
+ <span class='name'>credentials</span>
958
+
959
+
960
+ <span class='type'>(<tt><span class='object_link'><a href="Credentials.html" title="Echochamber::Credentials (class)">Echochamber::Credentials</a></span></tt>)</span>
961
+
962
+
963
+
964
+ &mdash;
965
+ <div class='inline'>
966
+ <p>Initialized Echochamber::Credentials</p>
967
+ </div>
968
+
969
+ </li>
970
+
971
+ </ul>
972
+
973
+
974
+ </div><table class="source_code">
975
+ <tr>
976
+ <td>
977
+ <pre class="lines">
978
+
979
+
980
+ 15
981
+ 16
982
+ 17</pre>
983
+ </td>
984
+ <td>
985
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 15</span>
986
+
987
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span>
988
+ <span class='ivar'>@token</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span>
989
+ <span class='kw'>end</span></pre>
990
+ </td>
991
+ </tr>
992
+ </table>
993
+ </div>
994
+
995
+ </div>
996
+
997
+ <div id="instance_attr_details" class="attr_details">
998
+ <h2>Instance Attribute Details</h2>
999
+
1000
+
1001
+ <span id=""></span>
1002
+ <div class="method_details first">
1003
+ <h3 class="signature first" id="token-instance_method">
1004
+
1005
+ - (<tt>Object</tt>) <strong>token</strong> <span class="extras">(readonly)</span>
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+ </h3><div class="docstring">
1012
+ <div class="discussion">
1013
+
1014
+ <p>Returns the value of attribute token</p>
1015
+
1016
+
1017
+ </div>
1018
+ </div>
1019
+ <div class="tags">
1020
+
1021
+
1022
+ </div><table class="source_code">
1023
+ <tr>
1024
+ <td>
1025
+ <pre class="lines">
1026
+
1027
+
1028
+ 10
1029
+ 11
1030
+ 12</pre>
1031
+ </td>
1032
+ <td>
1033
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 10</span>
1034
+
1035
+ <span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
1036
+ <span class='ivar'>@token</span>
1037
+ <span class='kw'>end</span></pre>
1038
+ </td>
1039
+ </tr>
1040
+ </table>
1041
+ </div>
1042
+
1043
+ </div>
1044
+
1045
+
1046
+ <div id="instance_method_details" class="method_details_list">
1047
+ <h2>Instance Method Details</h2>
1048
+
1049
+
1050
+ <div class="method_details first">
1051
+ <h3 class="signature first" id="agreement_combined_pdf-instance_method">
1052
+
1053
+ - (<tt>String</tt>) <strong>agreement_combined_pdf</strong>(agreement_id, file_path = nil, versionId = nil, participantEmail = nil, attachSupportingDocuments = true, auditReport = false)
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+ </h3><div class="docstring">
1060
+ <div class="discussion">
1061
+
1062
+ <p>Gets a single combined PDF document for the documents associated with an
1063
+ agreement.</p>
1064
+
1065
+
1066
+ </div>
1067
+ </div>
1068
+ <div class="tags">
1069
+ <p class="tag_title">Parameters:</p>
1070
+ <ul class="param">
1071
+
1072
+ <li>
1073
+
1074
+ <span class='name'>agreement_id</span>
1075
+
1076
+
1077
+ <span class='type'>(<tt>String</tt>)</span>
1078
+
1079
+
1080
+
1081
+ &mdash;
1082
+ <div class='inline'>
1083
+ <p>(REQUIRED)</p>
1084
+ </div>
1085
+
1086
+ </li>
1087
+
1088
+ <li>
1089
+
1090
+ <span class='name'>file_path</span>
1091
+
1092
+
1093
+ <span class='type'>(<tt>String</tt>)</span>
1094
+
1095
+
1096
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1097
+
1098
+
1099
+ &mdash;
1100
+ <div class='inline'>
1101
+ <p>File path to save the document. If no file path is given, nothing is saved
1102
+ to disk.</p>
1103
+ </div>
1104
+
1105
+ </li>
1106
+
1107
+ <li>
1108
+
1109
+ <span class='name'>versionId</span>
1110
+
1111
+
1112
+ <span class='type'>(<tt>String</tt>)</span>
1113
+
1114
+
1115
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1116
+
1117
+
1118
+ &mdash;
1119
+ <div class='inline'>
1120
+ <p>The version identifier of agreement as provided by get_agreement. If not
1121
+ provided then latest version will be used</p>
1122
+ </div>
1123
+
1124
+ </li>
1125
+
1126
+ <li>
1127
+
1128
+ <span class='name'>participantEmail</span>
1129
+
1130
+
1131
+ <span class='type'>(<tt>String</tt>)</span>
1132
+
1133
+
1134
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1135
+
1136
+
1137
+ &mdash;
1138
+ <div class='inline'>
1139
+ <p>The email address of the participant to be used to retrieve documents. If
1140
+ none is given, the auth token will be used to determine the user</p>
1141
+ </div>
1142
+
1143
+ </li>
1144
+
1145
+ <li>
1146
+
1147
+ <span class='name'>attachSupportingDocuments</span>
1148
+
1149
+
1150
+ <span class='type'>(<tt>Boolean</tt>)</span>
1151
+
1152
+
1153
+ <em class="default">(defaults to: <tt>true</tt>)</em>
1154
+
1155
+
1156
+ &mdash;
1157
+ <div class='inline'>
1158
+ <p>When set to YES, attach corresponding supporting documents to the signed
1159
+ agreement PDF. Default value of this parameter is true.</p>
1160
+ </div>
1161
+
1162
+ </li>
1163
+
1164
+ <li>
1165
+
1166
+ <span class='name'>auditReport</span>
1167
+
1168
+
1169
+ <span class='type'>(<tt>Boolean</tt>)</span>
1170
+
1171
+
1172
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1173
+
1174
+
1175
+ &mdash;
1176
+ <div class='inline'>
1177
+ <p>When set to YES, attach an audit report to the signed agreement PDF.
1178
+ Default value is false</p>
1179
+ </div>
1180
+
1181
+ </li>
1182
+
1183
+ </ul>
1184
+
1185
+ <p class="tag_title">Returns:</p>
1186
+ <ul class="return">
1187
+
1188
+ <li>
1189
+
1190
+
1191
+ <span class='type'>(<tt>String</tt>)</span>
1192
+
1193
+
1194
+
1195
+ &mdash;
1196
+ <div class='inline'>
1197
+ <p>Raw bytes from document file</p>
1198
+ </div>
1199
+
1200
+ </li>
1201
+
1202
+ </ul>
1203
+
1204
+ </div><table class="source_code">
1205
+ <tr>
1206
+ <td>
1207
+ <pre class="lines">
1208
+
1209
+
1210
+ 92
1211
+ 93
1212
+ 94
1213
+ 95
1214
+ 96
1215
+ 97
1216
+ 98
1217
+ 99
1218
+ 100</pre>
1219
+ </td>
1220
+ <td>
1221
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 92</span>
1222
+
1223
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_combined_pdf'>agreement_combined_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_versionId'>versionId</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_participantEmail'>participantEmail</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_attachSupportingDocuments'>attachSupportingDocuments</span><span class='op'>=</span><span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_auditReport'>auditReport</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
1224
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_combined_pdf'>agreement_combined_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_versionId'>versionId</span><span class='comma'>,</span> <span class='id identifier rubyid_participantEmail'>participantEmail</span><span class='comma'>,</span> <span class='id identifier rubyid_attachSupportingDocuments'>attachSupportingDocuments</span><span class='comma'>,</span> <span class='id identifier rubyid_auditReport'>auditReport</span><span class='rparen'>)</span>
1225
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1226
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1227
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1228
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
1229
+ <span class='kw'>end</span>
1230
+ <span class='id identifier rubyid_response'>response</span>
1231
+ <span class='kw'>end</span></pre>
1232
+ </td>
1233
+ </tr>
1234
+ </table>
1235
+ </div>
1236
+
1237
+ <div class="method_details ">
1238
+ <h3 class="signature " id="agreement_document_file-instance_method">
1239
+
1240
+ - (<tt>String</tt>) <strong>agreement_document_file</strong>(agreement_id, document_id, file_path = nil)
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+ </h3><div class="docstring">
1247
+ <div class="discussion">
1248
+
1249
+ <p>Retrieve a document file from an agreement</p>
1250
+
1251
+
1252
+ </div>
1253
+ </div>
1254
+ <div class="tags">
1255
+ <p class="tag_title">Parameters:</p>
1256
+ <ul class="param">
1257
+
1258
+ <li>
1259
+
1260
+ <span class='name'>agreement_id</span>
1261
+
1262
+
1263
+ <span class='type'>(<tt>String</tt>)</span>
1264
+
1265
+
1266
+
1267
+ &mdash;
1268
+ <div class='inline'>
1269
+ <p>(REQUIRED)</p>
1270
+ </div>
1271
+
1272
+ </li>
1273
+
1274
+ <li>
1275
+
1276
+ <span class='name'>document_id</span>
1277
+
1278
+
1279
+ <span class='type'>(<tt>String</tt>)</span>
1280
+
1281
+
1282
+
1283
+ &mdash;
1284
+ <div class='inline'>
1285
+ <p>(REQUIRED)</p>
1286
+ </div>
1287
+
1288
+ </li>
1289
+
1290
+ <li>
1291
+
1292
+ <span class='name'>file_path</span>
1293
+
1294
+
1295
+ <span class='type'>(<tt>String</tt>)</span>
1296
+
1297
+
1298
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1299
+
1300
+
1301
+ &mdash;
1302
+ <div class='inline'>
1303
+ <p>File path to save the document. If no file path is given, nothing is saved
1304
+ to disk.</p>
1305
+ </div>
1306
+
1307
+ </li>
1308
+
1309
+ </ul>
1310
+
1311
+ <p class="tag_title">Returns:</p>
1312
+ <ul class="return">
1313
+
1314
+ <li>
1315
+
1316
+
1317
+ <span class='type'>(<tt>String</tt>)</span>
1318
+
1319
+
1320
+
1321
+ &mdash;
1322
+ <div class='inline'>
1323
+ <p>Raw bytes from document file</p>
1324
+ </div>
1325
+
1326
+ </li>
1327
+
1328
+ </ul>
1329
+
1330
+ </div><table class="source_code">
1331
+ <tr>
1332
+ <td>
1333
+ <pre class="lines">
1334
+
1335
+
1336
+ 65
1337
+ 66
1338
+ 67
1339
+ 68
1340
+ 69
1341
+ 70
1342
+ 71
1343
+ 72
1344
+ 73</pre>
1345
+ </td>
1346
+ <td>
1347
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 65</span>
1348
+
1349
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_document_file'>agreement_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_id'>document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1350
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_document_file'>agreement_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_id'>document_id</span><span class='rparen'>)</span>
1351
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1352
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1353
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1354
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
1355
+ <span class='kw'>end</span>
1356
+ <span class='id identifier rubyid_response'>response</span>
1357
+ <span class='kw'>end</span></pre>
1358
+ </td>
1359
+ </tr>
1360
+ </table>
1361
+ </div>
1362
+
1363
+ <div class="method_details ">
1364
+ <h3 class="signature " id="agreement_documents-instance_method">
1365
+
1366
+ - (<tt>Array</tt>) <strong>agreement_documents</strong>(agreement_id, recipient_email, format, version_id = nil)
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+ </h3><div class="docstring">
1373
+ <div class="discussion">
1374
+
1375
+ <p>All documents relating to an agreement</p>
1376
+
1377
+
1378
+ </div>
1379
+ </div>
1380
+ <div class="tags">
1381
+ <p class="tag_title">Parameters:</p>
1382
+ <ul class="param">
1383
+
1384
+ <li>
1385
+
1386
+ <span class='name'>agreement_id</span>
1387
+
1388
+
1389
+ <span class='type'>(<tt>String</tt>)</span>
1390
+
1391
+
1392
+
1393
+ &mdash;
1394
+ <div class='inline'>
1395
+ <p>(REQUIRED)</p>
1396
+ </div>
1397
+
1398
+ </li>
1399
+
1400
+ <li>
1401
+
1402
+ <span class='name'>recipient_email</span>
1403
+
1404
+
1405
+ <span class='type'>(<tt>String</tt>)</span>
1406
+
1407
+
1408
+
1409
+ &mdash;
1410
+ <div class='inline'>
1411
+ <p>The email address of the participant to be used to retrieve documents.
1412
+ (REQUIRED)</p>
1413
+ </div>
1414
+
1415
+ </li>
1416
+
1417
+ <li>
1418
+
1419
+ <span class='name'>format</span>
1420
+
1421
+
1422
+ <span class='type'>(<tt>String</tt>)</span>
1423
+
1424
+
1425
+
1426
+ &mdash;
1427
+ <div class='inline'>
1428
+ <p>Content format of the supported documents. It can have two possible values
1429
+ ORIGINAL or CONVERTED_PDF. (REQUIRED)</p>
1430
+ </div>
1431
+
1432
+ </li>
1433
+
1434
+ <li>
1435
+
1436
+ <span class='name'>version_id</span>
1437
+
1438
+
1439
+ <span class='type'>(<tt>String</tt>)</span>
1440
+
1441
+
1442
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1443
+
1444
+
1445
+ &mdash;
1446
+ <div class='inline'>
1447
+ <p>Version of the agreement as provided by agreement_info(). If not provided,
1448
+ the latest version of the agreement is used.</p>
1449
+ </div>
1450
+
1451
+ </li>
1452
+
1453
+ </ul>
1454
+
1455
+ <p class="tag_title">Returns:</p>
1456
+ <ul class="return">
1457
+
1458
+ <li>
1459
+
1460
+
1461
+ <span class='type'>(<tt>Array</tt>)</span>
1462
+
1463
+
1464
+
1465
+ &mdash;
1466
+ <div class='inline'>
1467
+ <p>Documents relating to agreement.</p>
1468
+ </div>
1469
+
1470
+ </li>
1471
+
1472
+ </ul>
1473
+
1474
+ </div><table class="source_code">
1475
+ <tr>
1476
+ <td>
1477
+ <pre class="lines">
1478
+
1479
+
1480
+ 55
1481
+ 56
1482
+ 57</pre>
1483
+ </td>
1484
+ <td>
1485
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 55</span>
1486
+
1487
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_documents'>agreement_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_recipient_email'>recipient_email</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_version_id'>version_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1488
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_documents'>agreement_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_recipient_email'>recipient_email</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_version_id'>version_id</span><span class='rparen'>)</span>
1489
+ <span class='kw'>end</span></pre>
1490
+ </td>
1491
+ </tr>
1492
+ </table>
1493
+ </div>
1494
+
1495
+ <div class="method_details ">
1496
+ <h3 class="signature " id="agreement_form_data-instance_method">
1497
+
1498
+ - (<tt>String</tt>) <strong>agreement_form_data</strong>(agreement_id, file_path = nil)
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+ </h3><div class="docstring">
1505
+ <div class="discussion">
1506
+
1507
+ <p>Retrieves library document audit trail file</p>
1508
+
1509
+
1510
+ </div>
1511
+ </div>
1512
+ <div class="tags">
1513
+ <p class="tag_title">Parameters:</p>
1514
+ <ul class="param">
1515
+
1516
+ <li>
1517
+
1518
+ <span class='name'>agreement_id</span>
1519
+
1520
+
1521
+ <span class='type'>(<tt>String</tt>)</span>
1522
+
1523
+
1524
+
1525
+ &mdash;
1526
+ <div class='inline'>
1527
+ <p>(REQUIRED)</p>
1528
+ </div>
1529
+
1530
+ </li>
1531
+
1532
+ <li>
1533
+
1534
+ <span class='name'>file_path</span>
1535
+
1536
+
1537
+ <span class='type'>(<tt>String</tt>)</span>
1538
+
1539
+
1540
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1541
+
1542
+
1543
+ &mdash;
1544
+ <div class='inline'>
1545
+ <p>File path where to save the CSV file. If no file path is given, nothing is
1546
+ saved to disk.</p>
1547
+ </div>
1548
+
1549
+ </li>
1550
+
1551
+ </ul>
1552
+
1553
+ <p class="tag_title">Returns:</p>
1554
+ <ul class="return">
1555
+
1556
+ <li>
1557
+
1558
+
1559
+ <span class='type'>(<tt>String</tt>)</span>
1560
+
1561
+
1562
+
1563
+ &mdash;
1564
+ <div class='inline'>
1565
+ <p>Raw bytes representing CSV file</p>
1566
+ </div>
1567
+
1568
+ </li>
1569
+
1570
+ </ul>
1571
+
1572
+ </div><table class="source_code">
1573
+ <tr>
1574
+ <td>
1575
+ <pre class="lines">
1576
+
1577
+
1578
+ 107
1579
+ 108
1580
+ 109
1581
+ 110
1582
+ 111
1583
+ 112
1584
+ 113
1585
+ 114
1586
+ 115</pre>
1587
+ </td>
1588
+ <td>
1589
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 107</span>
1590
+
1591
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_form_data'>agreement_form_data</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1592
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_form_data'>agreement_form_data</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1593
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1594
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1595
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1596
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
1597
+ <span class='kw'>end</span>
1598
+ <span class='id identifier rubyid_response'>response</span>
1599
+ <span class='kw'>end</span></pre>
1600
+ </td>
1601
+ </tr>
1602
+ </table>
1603
+ </div>
1604
+
1605
+ <div class="method_details ">
1606
+ <h3 class="signature " id="agreement_info-instance_method">
1607
+
1608
+ - (<tt>Hash</tt>) <strong>agreement_info</strong>(agreement_id)
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+ </h3><div class="docstring">
1615
+ <div class="discussion">
1616
+
1617
+ <p>Gets detailed info on an agreement</p>
1618
+
1619
+
1620
+ </div>
1621
+ </div>
1622
+ <div class="tags">
1623
+ <p class="tag_title">Parameters:</p>
1624
+ <ul class="param">
1625
+
1626
+ <li>
1627
+
1628
+ <span class='name'>agreement_id</span>
1629
+
1630
+
1631
+ <span class='type'>(<tt>String</tt>)</span>
1632
+
1633
+
1634
+
1635
+ &mdash;
1636
+ <div class='inline'>
1637
+ <p>ID of agreement to retrieve info on.</p>
1638
+ </div>
1639
+
1640
+ </li>
1641
+
1642
+ </ul>
1643
+
1644
+ <p class="tag_title">Returns:</p>
1645
+ <ul class="return">
1646
+
1647
+ <li>
1648
+
1649
+
1650
+ <span class='type'>(<tt>Hash</tt>)</span>
1651
+
1652
+
1653
+
1654
+ &mdash;
1655
+ <div class='inline'>
1656
+ <p>Detailed agreement info</p>
1657
+ </div>
1658
+
1659
+ </li>
1660
+
1661
+ </ul>
1662
+
1663
+ </div><table class="source_code">
1664
+ <tr>
1665
+ <td>
1666
+ <pre class="lines">
1667
+
1668
+
1669
+ 27
1670
+ 28
1671
+ 29</pre>
1672
+ </td>
1673
+ <td>
1674
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 27</span>
1675
+
1676
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_info'>agreement_info</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1677
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_info'>agreement_info</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1678
+ <span class='kw'>end</span></pre>
1679
+ </td>
1680
+ </tr>
1681
+ </table>
1682
+ </div>
1683
+
1684
+ <div class="method_details ">
1685
+ <h3 class="signature " id="agreement_signing_urls-instance_method">
1686
+
1687
+ - (<tt>Hash</tt>) <strong>agreement_signing_urls</strong>(agreement_id)
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+ </h3><div class="docstring">
1694
+ <div class="discussion">
1695
+
1696
+ <p>Retrieves the URL for the eSign page for the current signer(s) of an
1697
+ agreement</p>
1698
+
1699
+
1700
+ </div>
1701
+ </div>
1702
+ <div class="tags">
1703
+ <p class="tag_title">Parameters:</p>
1704
+ <ul class="param">
1705
+
1706
+ <li>
1707
+
1708
+ <span class='name'>agreement_id</span>
1709
+
1710
+
1711
+ <span class='type'>(<tt>String</tt>)</span>
1712
+
1713
+
1714
+
1715
+ &mdash;
1716
+ <div class='inline'>
1717
+ <p>(REQUIRED)</p>
1718
+ </div>
1719
+
1720
+ </li>
1721
+
1722
+ </ul>
1723
+
1724
+ <p class="tag_title">Returns:</p>
1725
+ <ul class="return">
1726
+
1727
+ <li>
1728
+
1729
+
1730
+ <span class='type'>(<tt>Hash</tt>)</span>
1731
+
1732
+
1733
+
1734
+ &mdash;
1735
+ <div class='inline'>
1736
+ <p>URL information for the eSign page of the agreement</p>
1737
+ </div>
1738
+
1739
+ </li>
1740
+
1741
+ </ul>
1742
+
1743
+ </div><table class="source_code">
1744
+ <tr>
1745
+ <td>
1746
+ <pre class="lines">
1747
+
1748
+
1749
+ 79
1750
+ 80
1751
+ 81</pre>
1752
+ </td>
1753
+ <td>
1754
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 79</span>
1755
+
1756
+ <span class='kw'>def</span> <span class='id identifier rubyid_agreement_signing_urls'>agreement_signing_urls</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1757
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_agreement_signing_urls'>agreement_signing_urls</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1758
+ <span class='kw'>end</span></pre>
1759
+ </td>
1760
+ </tr>
1761
+ </table>
1762
+ </div>
1763
+
1764
+ <div class="method_details ">
1765
+ <h3 class="signature " id="audit_trail_pdf-instance_method">
1766
+
1767
+ - (<tt>String</tt>) <strong>audit_trail_pdf</strong>(agreement_id, file_path = nil)
1768
+
1769
+
1770
+
1771
+
1772
+
1773
+ </h3><div class="docstring">
1774
+ <div class="discussion">
1775
+
1776
+ <p>Retrieve a PDF audit file for an agreement</p>
1777
+
1778
+
1779
+ </div>
1780
+ </div>
1781
+ <div class="tags">
1782
+ <p class="tag_title">Parameters:</p>
1783
+ <ul class="param">
1784
+
1785
+ <li>
1786
+
1787
+ <span class='name'>agreement_id</span>
1788
+
1789
+
1790
+ <span class='type'>(<tt>String</tt>)</span>
1791
+
1792
+
1793
+
1794
+ &mdash;
1795
+ <div class='inline'>
1796
+ <p>(REQUIRED)</p>
1797
+ </div>
1798
+
1799
+ </li>
1800
+
1801
+ <li>
1802
+
1803
+ <span class='name'>file_path</span>
1804
+
1805
+
1806
+ <span class='type'>(<tt>String</tt>)</span>
1807
+
1808
+
1809
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1810
+
1811
+
1812
+ &mdash;
1813
+ <div class='inline'>
1814
+ <p>File path to save the document. If no file path is given, nothing is saved
1815
+ to disk.</p>
1816
+ </div>
1817
+
1818
+ </li>
1819
+
1820
+ </ul>
1821
+
1822
+ <p class="tag_title">Returns:</p>
1823
+ <ul class="return">
1824
+
1825
+ <li>
1826
+
1827
+
1828
+ <span class='type'>(<tt>String</tt>)</span>
1829
+
1830
+
1831
+
1832
+ &mdash;
1833
+ <div class='inline'>
1834
+ <p>Raw bytes from document file</p>
1835
+ </div>
1836
+
1837
+ </li>
1838
+
1839
+ </ul>
1840
+
1841
+ </div><table class="source_code">
1842
+ <tr>
1843
+ <td>
1844
+ <pre class="lines">
1845
+
1846
+
1847
+ 52
1848
+ 53
1849
+ 54
1850
+ 55
1851
+ 56
1852
+ 57
1853
+ 58
1854
+ 59
1855
+ 60</pre>
1856
+ </td>
1857
+ <td>
1858
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 52</span>
1859
+
1860
+ <span class='kw'>def</span> <span class='id identifier rubyid_audit_trail_pdf'>audit_trail_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1861
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_audit_trail_pdf'>audit_trail_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='rparen'>)</span>
1862
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1863
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1864
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1865
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
1866
+ <span class='kw'>end</span>
1867
+ <span class='id identifier rubyid_response'>response</span>
1868
+ <span class='kw'>end</span></pre>
1869
+ </td>
1870
+ </tr>
1871
+ </table>
1872
+ </div>
1873
+
1874
+ <div class="method_details ">
1875
+ <h3 class="signature " id="cancel_agreement-instance_method">
1876
+
1877
+ - (<tt>String</tt>) <strong>cancel_agreement</strong>(agreement_id, notify_signer = false, comment = nil)
1878
+
1879
+
1880
+
1881
+
1882
+
1883
+ </h3><div class="docstring">
1884
+ <div class="discussion">
1885
+
1886
+ <p>Cancel agreement</p>
1887
+
1888
+
1889
+ </div>
1890
+ </div>
1891
+ <div class="tags">
1892
+ <p class="tag_title">Parameters:</p>
1893
+ <ul class="param">
1894
+
1895
+ <li>
1896
+
1897
+ <span class='name'>agreement_id</span>
1898
+
1899
+
1900
+ <span class='type'>(<tt>String</tt>)</span>
1901
+
1902
+
1903
+
1904
+ &mdash;
1905
+ <div class='inline'>
1906
+ <p>(REQUIRED)</p>
1907
+ </div>
1908
+
1909
+ </li>
1910
+
1911
+ <li>
1912
+
1913
+ <span class='name'>notify_signer</span>
1914
+
1915
+
1916
+ <span class='type'>(<tt>Boolean</tt>)</span>
1917
+
1918
+
1919
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1920
+
1921
+
1922
+ &mdash;
1923
+ <div class='inline'>
1924
+ <p>Whether to notify the signer by email of the cancellation. Default is
1925
+ false.</p>
1926
+ </div>
1927
+
1928
+ </li>
1929
+
1930
+ <li>
1931
+
1932
+ <span class='name'>comment</span>
1933
+
1934
+
1935
+ <span class='type'>(<tt>String</tt>)</span>
1936
+
1937
+
1938
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1939
+
1940
+
1941
+ &mdash;
1942
+ <div class='inline'>
1943
+ <p>Comment regarding this cancellation.</p>
1944
+ </div>
1945
+
1946
+ </li>
1947
+
1948
+ </ul>
1949
+
1950
+ <p class="tag_title">Returns:</p>
1951
+ <ul class="return">
1952
+
1953
+ <li>
1954
+
1955
+
1956
+ <span class='type'>(<tt>String</tt>)</span>
1957
+
1958
+
1959
+
1960
+ &mdash;
1961
+ <div class='inline'>
1962
+ <p>Result of the operation</p>
1963
+ </div>
1964
+
1965
+ </li>
1966
+
1967
+ </ul>
1968
+
1969
+ </div><table class="source_code">
1970
+ <tr>
1971
+ <td>
1972
+ <pre class="lines">
1973
+
1974
+
1975
+ 37
1976
+ 38
1977
+ 39
1978
+ 40
1979
+ 41
1980
+ 42
1981
+ 43
1982
+ 44
1983
+ 45
1984
+ 46</pre>
1985
+ </td>
1986
+ <td>
1987
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 37</span>
1988
+
1989
+ <span class='kw'>def</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='id identifier rubyid_notify_signer'>notify_signer</span><span class='op'>=</span><span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_comment'>comment</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1990
+ <span class='id identifier rubyid_request_body'>request_body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1991
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>value</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CANCEL</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
1992
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>notifySigner</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_notify_signer'>notify_signer</span>
1993
+ <span class='rbrace'>}</span>
1994
+ <span class='id identifier rubyid_request_body'>request_body</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>comment:</span> <span class='id identifier rubyid_comment'>comment</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1995
+
1996
+ <span class='id identifier rubyid_agreement_status_response'>agreement_status_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_update_agreement_status'>update_agreement_status</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement_id'>agreement_id</span><span class='comma'>,</span> <span class='id identifier rubyid_request_body'>request_body</span><span class='rparen'>)</span>
1997
+ <span class='id identifier rubyid_agreement_status_response'>agreement_status_response</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>result</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1998
+ <span class='kw'>end</span></pre>
1999
+ </td>
2000
+ </tr>
2001
+ </table>
2002
+ </div>
2003
+
2004
+ <div class="method_details ">
2005
+ <h3 class="signature " id="create_agreement-instance_method">
2006
+
2007
+ - (<tt>String</tt>) <strong>create_agreement</strong>(agreement)
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ </h3><div class="docstring">
2014
+ <div class="discussion">
2015
+
2016
+ <p>Creates an agreement</p>
2017
+
2018
+
2019
+ </div>
2020
+ </div>
2021
+ <div class="tags">
2022
+ <p class="tag_title">Parameters:</p>
2023
+ <ul class="param">
2024
+
2025
+ <li>
2026
+
2027
+ <span class='name'>agreement</span>
2028
+
2029
+
2030
+ <span class='type'>(<tt><span class='object_link'><a href="Agreement.html" title="Echochamber::Agreement (class)">Echochamber::Agreement</a></span></tt>)</span>
2031
+
2032
+
2033
+
2034
+ </li>
2035
+
2036
+ </ul>
2037
+
2038
+ <p class="tag_title">Returns:</p>
2039
+ <ul class="return">
2040
+
2041
+ <li>
2042
+
2043
+
2044
+ <span class='type'>(<tt>String</tt>)</span>
2045
+
2046
+
2047
+
2048
+ &mdash;
2049
+ <div class='inline'>
2050
+ <p>Agreement ID</p>
2051
+ </div>
2052
+
2053
+ </li>
2054
+
2055
+ </ul>
2056
+
2057
+ </div><table class="source_code">
2058
+ <tr>
2059
+ <td>
2060
+ <pre class="lines">
2061
+
2062
+
2063
+ 9
2064
+ 10
2065
+ 11
2066
+ 12</pre>
2067
+ </td>
2068
+ <td>
2069
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 9</span>
2070
+
2071
+ <span class='kw'>def</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>
2072
+ <span class='id identifier rubyid_agreement_response'>agreement_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</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='comma'>,</span> <span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement'>agreement</span><span class='period'>.</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_agreement'>agreement</span><span class='period'>.</span><span class='id identifier rubyid_user_email'>user_email</span><span class='rparen'>)</span>
2073
+ <span class='id identifier rubyid_agreement_response'>agreement_response</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>agreementId</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2074
+ <span class='kw'>end</span></pre>
2075
+ </td>
2076
+ </tr>
2077
+ </table>
2078
+ </div>
2079
+
2080
+ <div class="method_details ">
2081
+ <h3 class="signature " id="create_reminder-instance_method">
2082
+
2083
+ - (<tt>String</tt>) <strong>create_reminder</strong>(reminder)
2084
+
2085
+
2086
+
2087
+
2088
+
2089
+ </h3><div class="docstring">
2090
+ <div class="discussion">
2091
+
2092
+ <p>Creates a reminder</p>
2093
+
2094
+
2095
+ </div>
2096
+ </div>
2097
+ <div class="tags">
2098
+ <p class="tag_title">Parameters:</p>
2099
+ <ul class="param">
2100
+
2101
+ <li>
2102
+
2103
+ <span class='name'>reminder</span>
2104
+
2105
+
2106
+ <span class='type'>(<tt><span class='object_link'><a href="Reminder.html" title="Echochamber::Reminder (class)">Echochamber::Reminder</a></span></tt>)</span>
2107
+
2108
+
2109
+
2110
+ </li>
2111
+
2112
+ </ul>
2113
+
2114
+ <p class="tag_title">Returns:</p>
2115
+ <ul class="return">
2116
+
2117
+ <li>
2118
+
2119
+
2120
+ <span class='type'>(<tt>String</tt>)</span>
2121
+
2122
+
2123
+
2124
+ &mdash;
2125
+ <div class='inline'>
2126
+ <p>Reminder ID</p>
2127
+ </div>
2128
+
2129
+ </li>
2130
+
2131
+ </ul>
2132
+
2133
+ </div><table class="source_code">
2134
+ <tr>
2135
+ <td>
2136
+ <pre class="lines">
2137
+
2138
+
2139
+ 32
2140
+ 33
2141
+ 34</pre>
2142
+ </td>
2143
+ <td>
2144
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 32</span>
2145
+
2146
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_reminder'>create_reminder</span><span class='lparen'>(</span><span class='id identifier rubyid_reminder'>reminder</span><span class='rparen'>)</span>
2147
+ <span class='id identifier rubyid_reminder_response'>reminder_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_create_reminder'>create_reminder</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_reminder'>reminder</span><span class='rparen'>)</span>
2148
+ <span class='kw'>end</span></pre>
2149
+ </td>
2150
+ </tr>
2151
+ </table>
2152
+ </div>
2153
+
2154
+ <div class="method_details ">
2155
+ <h3 class="signature " id="create_transient_document-instance_method">
2156
+
2157
+ - (<tt>String</tt>) <strong>create_transient_document</strong>(file_name, mime_type, file_handle)
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+ </h3><div class="docstring">
2164
+ <div class="discussion">
2165
+
2166
+ <p>Creates a transient document for later referral</p>
2167
+
2168
+
2169
+ </div>
2170
+ </div>
2171
+ <div class="tags">
2172
+ <p class="tag_title">Parameters:</p>
2173
+ <ul class="param">
2174
+
2175
+ <li>
2176
+
2177
+ <span class='name'>file_name</span>
2178
+
2179
+
2180
+ <span class='type'>(<tt>String</tt>)</span>
2181
+
2182
+
2183
+
2184
+ </li>
2185
+
2186
+ <li>
2187
+
2188
+ <span class='name'>mime_type</span>
2189
+
2190
+
2191
+ <span class='type'>(<tt>String</tt>)</span>
2192
+
2193
+
2194
+
2195
+ </li>
2196
+
2197
+ <li>
2198
+
2199
+ <span class='name'>file_handle</span>
2200
+
2201
+
2202
+ <span class='type'>(<tt>File</tt>)</span>
2203
+
2204
+
2205
+
2206
+ </li>
2207
+
2208
+ </ul>
2209
+
2210
+ <p class="tag_title">Returns:</p>
2211
+ <ul class="return">
2212
+
2213
+ <li>
2214
+
2215
+
2216
+ <span class='type'>(<tt>String</tt>)</span>
2217
+
2218
+
2219
+
2220
+ &mdash;
2221
+ <div class='inline'>
2222
+ <p>Transient document ID</p>
2223
+ </div>
2224
+
2225
+ </li>
2226
+
2227
+ </ul>
2228
+
2229
+ </div><table class="source_code">
2230
+ <tr>
2231
+ <td>
2232
+ <pre class="lines">
2233
+
2234
+
2235
+ 42
2236
+ 43
2237
+ 44
2238
+ 45</pre>
2239
+ </td>
2240
+ <td>
2241
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 42</span>
2242
+
2243
+ <span class='kw'>def</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='id identifier rubyid_file_handle'>file_handle</span><span class='rparen'>)</span>
2244
+ <span class='id identifier rubyid_transient_document_response'>transient_document_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</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_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_file_name'>file_name</span><span class='comma'>,</span> <span class='id identifier rubyid_file_handle'>file_handle</span><span class='comma'>,</span> <span class='id identifier rubyid_mime_type'>mime_type</span><span class='rparen'>)</span>
2245
+ <span class='id identifier rubyid_transient_document_response'>transient_document_response</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>transientDocumentId</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2246
+ <span class='kw'>end</span></pre>
2247
+ </td>
2248
+ </tr>
2249
+ </table>
2250
+ </div>
2251
+
2252
+ <div class="method_details ">
2253
+ <h3 class="signature " id="create_user-instance_method">
2254
+
2255
+ - (<tt>String</tt>) <strong>create_user</strong>(user)
2256
+
2257
+
2258
+
2259
+
2260
+
2261
+ </h3><div class="docstring">
2262
+ <div class="discussion">
2263
+
2264
+ <p>Creates a user for the current application</p>
2265
+
2266
+
2267
+ </div>
2268
+ </div>
2269
+ <div class="tags">
2270
+ <p class="tag_title">Parameters:</p>
2271
+ <ul class="param">
2272
+
2273
+ <li>
2274
+
2275
+ <span class='name'>user</span>
2276
+
2277
+
2278
+ <span class='type'>(<tt><span class='object_link'><a href="User.html" title="Echochamber::User (class)">Echochamber::User</a></span></tt>)</span>
2279
+
2280
+
2281
+
2282
+ </li>
2283
+
2284
+ </ul>
2285
+
2286
+ <p class="tag_title">Returns:</p>
2287
+ <ul class="return">
2288
+
2289
+ <li>
2290
+
2291
+
2292
+ <span class='type'>(<tt>String</tt>)</span>
2293
+
2294
+
2295
+
2296
+ &mdash;
2297
+ <div class='inline'>
2298
+ <p>User ID of new Echosign user</p>
2299
+ </div>
2300
+
2301
+ </li>
2302
+
2303
+ </ul>
2304
+
2305
+ </div><table class="source_code">
2306
+ <tr>
2307
+ <td>
2308
+ <pre class="lines">
2309
+
2310
+
2311
+ 23
2312
+ 24
2313
+ 25
2314
+ 26</pre>
2315
+ </td>
2316
+ <td>
2317
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 23</span>
2318
+
2319
+ <span class='kw'>def</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>
2320
+ <span class='id identifier rubyid_user_response'>user_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</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='comma'>,</span> <span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
2321
+ <span class='id identifier rubyid_user_response'>user_response</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>userId</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2322
+ <span class='kw'>end</span></pre>
2323
+ </td>
2324
+ </tr>
2325
+ </table>
2326
+ </div>
2327
+
2328
+ <div class="method_details ">
2329
+ <h3 class="signature " id="create_widget-instance_method">
2330
+
2331
+ - (<tt>Hash</tt>) <strong>create_widget</strong>(widget)
2332
+
2333
+
2334
+
2335
+
2336
+
2337
+ </h3><div class="docstring">
2338
+ <div class="discussion">
2339
+
2340
+ <p>Creates a widget and returns the Javascript snippet and URL to access the
2341
+ widget and widgetID in response to the client</p>
2342
+
2343
+
2344
+ </div>
2345
+ </div>
2346
+ <div class="tags">
2347
+ <p class="tag_title">Parameters:</p>
2348
+ <ul class="param">
2349
+
2350
+ <li>
2351
+
2352
+ <span class='name'>widget</span>
2353
+
2354
+
2355
+ <span class='type'>(<tt><span class='object_link'><a href="Widget.html" title="Echochamber::Widget (class)">Echochamber::Widget</a></span></tt>)</span>
2356
+
2357
+
2358
+
2359
+ </li>
2360
+
2361
+ </ul>
2362
+
2363
+ <p class="tag_title">Returns:</p>
2364
+ <ul class="return">
2365
+
2366
+ <li>
2367
+
2368
+
2369
+ <span class='type'>(<tt>Hash</tt>)</span>
2370
+
2371
+
2372
+
2373
+ </li>
2374
+
2375
+ </ul>
2376
+
2377
+ </div><table class="source_code">
2378
+ <tr>
2379
+ <td>
2380
+ <pre class="lines">
2381
+
2382
+
2383
+ 9
2384
+ 10
2385
+ 11</pre>
2386
+ </td>
2387
+ <td>
2388
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 9</span>
2389
+
2390
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_widget'>create_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_widget'>widget</span><span class='rparen'>)</span>
2391
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_create_widget'>create_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget'>widget</span><span class='rparen'>)</span>
2392
+ <span class='kw'>end</span></pre>
2393
+ </td>
2394
+ </tr>
2395
+ </table>
2396
+ </div>
2397
+
2398
+ <div class="method_details ">
2399
+ <h3 class="signature " id="get_agreements-instance_method">
2400
+
2401
+ - (<tt>String</tt>) <strong>get_agreements</strong>
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+ </h3><div class="docstring">
2408
+ <div class="discussion">
2409
+
2410
+ <p>Gets list of agreements</p>
2411
+
2412
+
2413
+ </div>
2414
+ </div>
2415
+ <div class="tags">
2416
+ <p class="tag_title">Parameters:</p>
2417
+ <ul class="param">
2418
+
2419
+ <li>
2420
+
2421
+ <span class='name'>agreement</span>
2422
+
2423
+
2424
+ <span class='type'>(<tt><span class='object_link'><a href="Agreement.html" title="Echochamber::Agreement (class)">Echochamber::Agreement</a></span></tt>)</span>
2425
+
2426
+
2427
+
2428
+ </li>
2429
+
2430
+ </ul>
2431
+
2432
+ <p class="tag_title">Returns:</p>
2433
+ <ul class="return">
2434
+
2435
+ <li>
2436
+
2437
+
2438
+ <span class='type'>(<tt>String</tt>)</span>
2439
+
2440
+
2441
+
2442
+ &mdash;
2443
+ <div class='inline'>
2444
+ <p>Agreement ID</p>
2445
+ </div>
2446
+
2447
+ </li>
2448
+
2449
+ </ul>
2450
+
2451
+ </div><table class="source_code">
2452
+ <tr>
2453
+ <td>
2454
+ <pre class="lines">
2455
+
2456
+
2457
+ 18
2458
+ 19
2459
+ 20
2460
+ 21</pre>
2461
+ </td>
2462
+ <td>
2463
+ <pre class="code"><span class="info file"># File 'lib/echochamber/agreement/client.rb', line 18</span>
2464
+
2465
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_agreements'>get_agreements</span>
2466
+ <span class='id identifier rubyid_get_agreements_response'>get_agreements_response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_agreements'>get_agreements</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
2467
+ <span class='id identifier rubyid_get_agreements_response'>get_agreements_response</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>userAgreementList</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2468
+ <span class='kw'>end</span></pre>
2469
+ </td>
2470
+ </tr>
2471
+ </table>
2472
+ </div>
2473
+
2474
+ <div class="method_details ">
2475
+ <h3 class="signature " id="get_library_document-instance_method">
2476
+
2477
+ - (<tt>Hash</tt>) <strong>get_library_document</strong>(library_document_id)
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+ </h3><div class="docstring">
2484
+ <div class="discussion">
2485
+
2486
+ <p>Retrieves library document metadata</p>
2487
+
2488
+
2489
+ </div>
2490
+ </div>
2491
+ <div class="tags">
2492
+ <p class="tag_title">Parameters:</p>
2493
+ <ul class="param">
2494
+
2495
+ <li>
2496
+
2497
+ <span class='name'>library_document_id</span>
2498
+
2499
+
2500
+ <span class='type'>(<tt>String</tt>)</span>
2501
+
2502
+
2503
+
2504
+ &mdash;
2505
+ <div class='inline'>
2506
+ <p>(REQUIRED)</p>
2507
+ </div>
2508
+
2509
+ </li>
2510
+
2511
+ </ul>
2512
+
2513
+ <p class="tag_title">Returns:</p>
2514
+ <ul class="return">
2515
+
2516
+ <li>
2517
+
2518
+
2519
+ <span class='type'>(<tt>Hash</tt>)</span>
2520
+
2521
+
2522
+
2523
+ &mdash;
2524
+ <div class='inline'>
2525
+ <p>Library document metadata</p>
2526
+ </div>
2527
+
2528
+ </li>
2529
+
2530
+ </ul>
2531
+
2532
+ </div><table class="source_code">
2533
+ <tr>
2534
+ <td>
2535
+ <pre class="lines">
2536
+
2537
+
2538
+ 18
2539
+ 19
2540
+ 20</pre>
2541
+ </td>
2542
+ <td>
2543
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 18</span>
2544
+
2545
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_library_document'>get_library_document</span><span class='lparen'>(</span><span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='rparen'>)</span>
2546
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_library_document'>get_library_document</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='rparen'>)</span>
2547
+ <span class='kw'>end</span></pre>
2548
+ </td>
2549
+ </tr>
2550
+ </table>
2551
+ </div>
2552
+
2553
+ <div class="method_details ">
2554
+ <h3 class="signature " id="get_library_document_file-instance_method">
2555
+
2556
+ - (<tt>String</tt>) <strong>get_library_document_file</strong>(library_document_id, file_id, file_path = nil)
2557
+
2558
+
2559
+
2560
+
2561
+
2562
+ </h3><div class="docstring">
2563
+ <div class="discussion">
2564
+
2565
+ <p>Retrieves library document file data</p>
2566
+
2567
+
2568
+ </div>
2569
+ </div>
2570
+ <div class="tags">
2571
+ <p class="tag_title">Parameters:</p>
2572
+ <ul class="param">
2573
+
2574
+ <li>
2575
+
2576
+ <span class='name'>library_document_id</span>
2577
+
2578
+
2579
+ <span class='type'>(<tt>REQUIRED</tt>)</span>
2580
+
2581
+
2582
+
2583
+ </li>
2584
+
2585
+ <li>
2586
+
2587
+ <span class='name'>file_id</span>
2588
+
2589
+
2590
+ <span class='type'>(<tt>String</tt>)</span>
2591
+
2592
+
2593
+
2594
+ &mdash;
2595
+ <div class='inline'>
2596
+ <p>(REQUIRED)</p>
2597
+ </div>
2598
+
2599
+ </li>
2600
+
2601
+ <li>
2602
+
2603
+ <span class='name'>file_path</span>
2604
+
2605
+
2606
+ <span class='type'>(<tt>String</tt>)</span>
2607
+
2608
+
2609
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2610
+
2611
+
2612
+ &mdash;
2613
+ <div class='inline'>
2614
+ <p>File path for saving the document. If none is given, nothing will be saved
2615
+ to disk.</p>
2616
+ </div>
2617
+
2618
+ </li>
2619
+
2620
+ </ul>
2621
+
2622
+ <p class="tag_title">Returns:</p>
2623
+ <ul class="return">
2624
+
2625
+ <li>
2626
+
2627
+
2628
+ <span class='type'>(<tt>String</tt>)</span>
2629
+
2630
+
2631
+
2632
+ &mdash;
2633
+ <div class='inline'>
2634
+ <p>Raw library document file data</p>
2635
+ </div>
2636
+
2637
+ </li>
2638
+
2639
+ </ul>
2640
+
2641
+ </div><table class="source_code">
2642
+ <tr>
2643
+ <td>
2644
+ <pre class="lines">
2645
+
2646
+
2647
+ 36
2648
+ 37
2649
+ 38
2650
+ 39
2651
+ 40
2652
+ 41
2653
+ 42
2654
+ 43
2655
+ 44</pre>
2656
+ </td>
2657
+ <td>
2658
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 36</span>
2659
+
2660
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_library_document_file'>get_library_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
2661
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_library_document_file'>get_library_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_id'>file_id</span><span class='rparen'>)</span>
2662
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2663
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2664
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
2665
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
2666
+ <span class='kw'>end</span>
2667
+ <span class='id identifier rubyid_response'>response</span>
2668
+ <span class='kw'>end</span></pre>
2669
+ </td>
2670
+ </tr>
2671
+ </table>
2672
+ </div>
2673
+
2674
+ <div class="method_details ">
2675
+ <h3 class="signature " id="get_library_document_files-instance_method">
2676
+
2677
+ - (<tt>Hash</tt>) <strong>get_library_document_files</strong>(library_document_id)
2678
+
2679
+
2680
+
2681
+
2682
+
2683
+ </h3><div class="docstring">
2684
+ <div class="discussion">
2685
+
2686
+ <p>Retrieves library document files metadata</p>
2687
+
2688
+
2689
+ </div>
2690
+ </div>
2691
+ <div class="tags">
2692
+ <p class="tag_title">Parameters:</p>
2693
+ <ul class="param">
2694
+
2695
+ <li>
2696
+
2697
+ <span class='name'>library_document_id</span>
2698
+
2699
+
2700
+ <span class='type'>(<tt>String</tt>)</span>
2701
+
2702
+
2703
+
2704
+ &mdash;
2705
+ <div class='inline'>
2706
+ <p>(REQUIRED)</p>
2707
+ </div>
2708
+
2709
+ </li>
2710
+
2711
+ </ul>
2712
+
2713
+ <p class="tag_title">Returns:</p>
2714
+ <ul class="return">
2715
+
2716
+ <li>
2717
+
2718
+
2719
+ <span class='type'>(<tt>Hash</tt>)</span>
2720
+
2721
+
2722
+
2723
+ &mdash;
2724
+ <div class='inline'>
2725
+ <p>Library document files metadata</p>
2726
+ </div>
2727
+
2728
+ </li>
2729
+
2730
+ </ul>
2731
+
2732
+ </div><table class="source_code">
2733
+ <tr>
2734
+ <td>
2735
+ <pre class="lines">
2736
+
2737
+
2738
+ 26
2739
+ 27
2740
+ 28</pre>
2741
+ </td>
2742
+ <td>
2743
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 26</span>
2744
+
2745
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_library_document_files'>get_library_document_files</span><span class='lparen'>(</span><span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='rparen'>)</span>
2746
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_library_document_files'>get_library_document_files</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='rparen'>)</span>
2747
+ <span class='kw'>end</span></pre>
2748
+ </td>
2749
+ </tr>
2750
+ </table>
2751
+ </div>
2752
+
2753
+ <div class="method_details ">
2754
+ <h3 class="signature " id="get_library_documents-instance_method">
2755
+
2756
+ - (<tt>Hash</tt>) <strong>get_library_documents</strong>(user_id = nil, user_email = nil)
2757
+
2758
+
2759
+
2760
+
2761
+
2762
+ </h3><div class="docstring">
2763
+ <div class="discussion">
2764
+
2765
+ <p>Retrieves library documents metadata for a user.</p>
2766
+
2767
+
2768
+ </div>
2769
+ </div>
2770
+ <div class="tags">
2771
+ <p class="tag_title">Parameters:</p>
2772
+ <ul class="param">
2773
+
2774
+ <li>
2775
+
2776
+ <span class='name'>user_id</span>
2777
+
2778
+
2779
+ <span class='type'>(<tt>String</tt>)</span>
2780
+
2781
+
2782
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2783
+
2784
+
2785
+ &mdash;
2786
+ <div class='inline'>
2787
+ <p>The ID of the user whose library documents are being requested.</p>
2788
+ </div>
2789
+
2790
+ </li>
2791
+
2792
+ <li>
2793
+
2794
+ <span class='name'>user_email</span>
2795
+
2796
+
2797
+ <span class='type'>(<tt>String</tt>)</span>
2798
+
2799
+
2800
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2801
+
2802
+
2803
+ &mdash;
2804
+ <div class='inline'>
2805
+ <p>The email address of the user whose library documents are being requested.
2806
+ If both user_id and user_email are provided then user_id is given
2807
+ preference. If neither is specified then the user is inferred from the
2808
+ access token.</p>
2809
+ </div>
2810
+
2811
+ </li>
2812
+
2813
+ </ul>
2814
+
2815
+ <p class="tag_title">Returns:</p>
2816
+ <ul class="return">
2817
+
2818
+ <li>
2819
+
2820
+
2821
+ <span class='type'>(<tt>Hash</tt>)</span>
2822
+
2823
+
2824
+
2825
+ &mdash;
2826
+ <div class='inline'>
2827
+ <p>Library documents metadata</p>
2828
+ </div>
2829
+
2830
+ </li>
2831
+
2832
+ </ul>
2833
+
2834
+ </div><table class="source_code">
2835
+ <tr>
2836
+ <td>
2837
+ <pre class="lines">
2838
+
2839
+
2840
+ 10
2841
+ 11
2842
+ 12</pre>
2843
+ </td>
2844
+ <td>
2845
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 10</span>
2846
+
2847
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_library_documents'>get_library_documents</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='rparen'>)</span>
2848
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_library_documents'>get_library_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='rparen'>)</span>
2849
+ <span class='kw'>end</span></pre>
2850
+ </td>
2851
+ </tr>
2852
+ </table>
2853
+ </div>
2854
+
2855
+ <div class="method_details ">
2856
+ <h3 class="signature " id="get_user-instance_method">
2857
+
2858
+ - (<tt>Hash</tt>) <strong>get_user</strong>(user_id)
2859
+
2860
+
2861
+
2862
+
2863
+
2864
+ </h3><div class="docstring">
2865
+ <div class="discussion">
2866
+
2867
+ <p>Gets all the users in an account that the caller has permissions to access.</p>
2868
+
2869
+
2870
+ </div>
2871
+ </div>
2872
+ <div class="tags">
2873
+ <p class="tag_title">Parameters:</p>
2874
+ <ul class="param">
2875
+
2876
+ <li>
2877
+
2878
+ <span class='name'>user_id</span>
2879
+
2880
+
2881
+ <span class='type'>(<tt>String</tt>)</span>
2882
+
2883
+
2884
+
2885
+ </li>
2886
+
2887
+ </ul>
2888
+
2889
+ <p class="tag_title">Returns:</p>
2890
+ <ul class="return">
2891
+
2892
+ <li>
2893
+
2894
+
2895
+ <span class='type'>(<tt>Hash</tt>)</span>
2896
+
2897
+
2898
+
2899
+ &mdash;
2900
+ <div class='inline'>
2901
+ <p>User info hash</p>
2902
+ </div>
2903
+
2904
+ </li>
2905
+
2906
+ </ul>
2907
+
2908
+ </div><table class="source_code">
2909
+ <tr>
2910
+ <td>
2911
+ <pre class="lines">
2912
+
2913
+
2914
+ 75
2915
+ 76
2916
+ 77</pre>
2917
+ </td>
2918
+ <td>
2919
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 75</span>
2920
+
2921
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_user'>get_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
2922
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_user'>get_user</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
2923
+ <span class='kw'>end</span></pre>
2924
+ </td>
2925
+ </tr>
2926
+ </table>
2927
+ </div>
2928
+
2929
+ <div class="method_details ">
2930
+ <h3 class="signature " id="get_users-instance_method">
2931
+
2932
+ - (<tt>Hash</tt>) <strong>get_users</strong>(user_email)
2933
+
2934
+
2935
+
2936
+
2937
+
2938
+ </h3><div class="docstring">
2939
+ <div class="discussion">
2940
+
2941
+ <p>Gets all the users in an account that the caller has permissions to access.</p>
2942
+
2943
+
2944
+ </div>
2945
+ </div>
2946
+ <div class="tags">
2947
+ <p class="tag_title">Parameters:</p>
2948
+ <ul class="param">
2949
+
2950
+ <li>
2951
+
2952
+ <span class='name'>user_email</span>
2953
+
2954
+
2955
+ <span class='type'>(<tt>String</tt>)</span>
2956
+
2957
+
2958
+
2959
+ &mdash;
2960
+ <div class='inline'>
2961
+ <p>The email address of the user whose details are being requested (REQUIRED)</p>
2962
+ </div>
2963
+
2964
+ </li>
2965
+
2966
+ </ul>
2967
+
2968
+ <p class="tag_title">Returns:</p>
2969
+ <ul class="return">
2970
+
2971
+ <li>
2972
+
2973
+
2974
+ <span class='type'>(<tt>Hash</tt>)</span>
2975
+
2976
+
2977
+
2978
+ &mdash;
2979
+ <div class='inline'>
2980
+ <p>User info hash</p>
2981
+ </div>
2982
+
2983
+ </li>
2984
+
2985
+ </ul>
2986
+
2987
+ </div><table class="source_code">
2988
+ <tr>
2989
+ <td>
2990
+ <pre class="lines">
2991
+
2992
+
2993
+ 67
2994
+ 68
2995
+ 69</pre>
2996
+ </td>
2997
+ <td>
2998
+ <pre class="code"><span class="info file"># File 'lib/echochamber/client.rb', line 67</span>
2999
+
3000
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_users'>get_users</span><span class='lparen'>(</span><span class='id identifier rubyid_user_email'>user_email</span><span class='rparen'>)</span>
3001
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_users'>get_users</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='rparen'>)</span>
3002
+ <span class='kw'>end</span></pre>
3003
+ </td>
3004
+ </tr>
3005
+ </table>
3006
+ </div>
3007
+
3008
+ <div class="method_details ">
3009
+ <h3 class="signature " id="get_widget-instance_method">
3010
+
3011
+ - (<tt>Hash</tt>) <strong>get_widget</strong>(widget_id)
3012
+
3013
+
3014
+
3015
+
3016
+
3017
+ </h3><div class="docstring">
3018
+ <div class="discussion">
3019
+
3020
+ <p>Retrieves the details of a widget</p>
3021
+
3022
+
3023
+ </div>
3024
+ </div>
3025
+ <div class="tags">
3026
+ <p class="tag_title">Parameters:</p>
3027
+ <ul class="param">
3028
+
3029
+ <li>
3030
+
3031
+ <span class='name'>widget_id</span>
3032
+
3033
+
3034
+ <span class='type'></span>
3035
+
3036
+
3037
+
3038
+ </li>
3039
+
3040
+ </ul>
3041
+
3042
+ <p class="tag_title">Returns:</p>
3043
+ <ul class="return">
3044
+
3045
+ <li>
3046
+
3047
+
3048
+ <span class='type'>(<tt>Hash</tt>)</span>
3049
+
3050
+
3051
+
3052
+ &mdash;
3053
+ <div class='inline'>
3054
+ <p>Detailed widget info</p>
3055
+ </div>
3056
+
3057
+ </li>
3058
+
3059
+ </ul>
3060
+
3061
+ </div><table class="source_code">
3062
+ <tr>
3063
+ <td>
3064
+ <pre class="lines">
3065
+
3066
+
3067
+ 44
3068
+ 45
3069
+ 46</pre>
3070
+ </td>
3071
+ <td>
3072
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 44</span>
3073
+
3074
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget'>get_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='rparen'>)</span>
3075
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget'>get_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='rparen'>)</span>
3076
+ <span class='kw'>end</span></pre>
3077
+ </td>
3078
+ </tr>
3079
+ </table>
3080
+ </div>
3081
+
3082
+ <div class="method_details ">
3083
+ <h3 class="signature " id="get_widget_audit_trail-instance_method">
3084
+
3085
+ - (<tt>String</tt>) <strong>get_widget_audit_trail</strong>(widget_id, file_path = nil)
3086
+
3087
+
3088
+
3089
+
3090
+
3091
+ </h3><div class="docstring">
3092
+ <div class="discussion">
3093
+
3094
+ <div class="note notetag">
3095
+ <strong>Note:</strong>
3096
+ <div class='inline'>
3097
+ <p>SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE</p>
3098
+ </div>
3099
+ </div>
3100
+
3101
+
3102
+ <p>Retrieves the audit trail of a widget identified by widgetId</p>
3103
+
3104
+
3105
+ </div>
3106
+ </div>
3107
+ <div class="tags">
3108
+ <p class="tag_title">Parameters:</p>
3109
+ <ul class="param">
3110
+
3111
+ <li>
3112
+
3113
+ <span class='name'>widget_id</span>
3114
+
3115
+
3116
+ <span class='type'>(<tt>String</tt>)</span>
3117
+
3118
+
3119
+
3120
+ </li>
3121
+
3122
+ <li>
3123
+
3124
+ <span class='name'>file_path</span>
3125
+
3126
+
3127
+ <span class='type'>(<tt>String</tt>)</span>
3128
+
3129
+
3130
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3131
+
3132
+
3133
+ &mdash;
3134
+ <div class='inline'>
3135
+ <p>File path where to save the document. If none is given, nothing will be
3136
+ saved to file.</p>
3137
+ </div>
3138
+
3139
+ </li>
3140
+
3141
+ </ul>
3142
+
3143
+ <p class="tag_title">Returns:</p>
3144
+ <ul class="return">
3145
+
3146
+ <li>
3147
+
3148
+
3149
+ <span class='type'>(<tt>String</tt>)</span>
3150
+
3151
+
3152
+
3153
+ &mdash;
3154
+ <div class='inline'>
3155
+ <p>Raw file stream</p>
3156
+ </div>
3157
+
3158
+ </li>
3159
+
3160
+ </ul>
3161
+
3162
+ </div><table class="source_code">
3163
+ <tr>
3164
+ <td>
3165
+ <pre class="lines">
3166
+
3167
+
3168
+ 80
3169
+ 81
3170
+ 82
3171
+ 83
3172
+ 84
3173
+ 85
3174
+ 86
3175
+ 87
3176
+ 88</pre>
3177
+ </td>
3178
+ <td>
3179
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 80</span>
3180
+
3181
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget_audit_trail'>get_widget_audit_trail</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3182
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget_audit_trail'>get_widget_audit_trail</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='rparen'>)</span>
3183
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3184
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3185
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3186
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3187
+ <span class='kw'>end</span>
3188
+ <span class='id identifier rubyid_response'>response</span>
3189
+ <span class='kw'>end</span></pre>
3190
+ </td>
3191
+ </tr>
3192
+ </table>
3193
+ </div>
3194
+
3195
+ <div class="method_details ">
3196
+ <h3 class="signature " id="get_widget_combined_pdf-instance_method">
3197
+
3198
+ - (<tt>String</tt>) <strong>get_widget_combined_pdf</strong>(widget_id, file_path = nil)
3199
+
3200
+
3201
+
3202
+
3203
+
3204
+ </h3><div class="docstring">
3205
+ <div class="discussion">
3206
+
3207
+ <div class="note notetag">
3208
+ <strong>Note:</strong>
3209
+ <div class='inline'>
3210
+ <p>SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE</p>
3211
+ </div>
3212
+ </div>
3213
+
3214
+
3215
+ <p>Gets a single combined PDF document for the documents associated with a
3216
+ widget.</p>
3217
+
3218
+
3219
+ </div>
3220
+ </div>
3221
+ <div class="tags">
3222
+ <p class="tag_title">Parameters:</p>
3223
+ <ul class="param">
3224
+
3225
+ <li>
3226
+
3227
+ <span class='name'>widget_id</span>
3228
+
3229
+
3230
+ <span class='type'>(<tt>String</tt>)</span>
3231
+
3232
+
3233
+
3234
+ </li>
3235
+
3236
+ <li>
3237
+
3238
+ <span class='name'>file_path</span>
3239
+
3240
+
3241
+ <span class='type'>(<tt>String</tt>)</span>
3242
+
3243
+
3244
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3245
+
3246
+
3247
+ &mdash;
3248
+ <div class='inline'>
3249
+ <p>File path where to save the document. If none is given, nothing will be
3250
+ saved to file.</p>
3251
+ </div>
3252
+
3253
+ </li>
3254
+
3255
+ </ul>
3256
+
3257
+ <p class="tag_title">Returns:</p>
3258
+ <ul class="return">
3259
+
3260
+ <li>
3261
+
3262
+
3263
+ <span class='type'>(<tt>String</tt>)</span>
3264
+
3265
+
3266
+
3267
+ &mdash;
3268
+ <div class='inline'>
3269
+ <p>Raw file stream</p>
3270
+ </div>
3271
+
3272
+ </li>
3273
+
3274
+ </ul>
3275
+
3276
+ </div><table class="source_code">
3277
+ <tr>
3278
+ <td>
3279
+ <pre class="lines">
3280
+
3281
+
3282
+ 96
3283
+ 97
3284
+ 98
3285
+ 99
3286
+ 100
3287
+ 101
3288
+ 102
3289
+ 103
3290
+ 104</pre>
3291
+ </td>
3292
+ <td>
3293
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 96</span>
3294
+
3295
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget_combined_pdf'>get_widget_combined_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3296
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget_combined_pdf'>get_widget_combined_pdf</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='rparen'>)</span>
3297
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3298
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3299
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3300
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3301
+ <span class='kw'>end</span>
3302
+ <span class='id identifier rubyid_response'>response</span>
3303
+ <span class='kw'>end</span></pre>
3304
+ </td>
3305
+ </tr>
3306
+ </table>
3307
+ </div>
3308
+
3309
+ <div class="method_details ">
3310
+ <h3 class="signature " id="get_widget_document_file-instance_method">
3311
+
3312
+ - (<tt>String</tt>) <strong>get_widget_document_file</strong>(widget_id, document_id, file_path = nil)
3313
+
3314
+
3315
+
3316
+
3317
+
3318
+ </h3><div class="docstring">
3319
+ <div class="discussion">
3320
+
3321
+ <p>Retrieves the file stream of a document of a widget</p>
3322
+
3323
+
3324
+ </div>
3325
+ </div>
3326
+ <div class="tags">
3327
+ <p class="tag_title">Parameters:</p>
3328
+ <ul class="param">
3329
+
3330
+ <li>
3331
+
3332
+ <span class='name'>widget_id</span>
3333
+
3334
+
3335
+ <span class='type'>(<tt>String</tt>)</span>
3336
+
3337
+
3338
+
3339
+ </li>
3340
+
3341
+ <li>
3342
+
3343
+ <span class='name'>document_id</span>
3344
+
3345
+
3346
+ <span class='type'>(<tt>String</tt>)</span>
3347
+
3348
+
3349
+
3350
+ </li>
3351
+
3352
+ <li>
3353
+
3354
+ <span class='name'>file_path</span>
3355
+
3356
+
3357
+ <span class='type'>(<tt>String</tt>)</span>
3358
+
3359
+
3360
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3361
+
3362
+
3363
+ &mdash;
3364
+ <div class='inline'>
3365
+ <p>File path where to save the document. If none is given, nothing will be
3366
+ saved to file.</p>
3367
+ </div>
3368
+
3369
+ </li>
3370
+
3371
+ </ul>
3372
+
3373
+ <p class="tag_title">Returns:</p>
3374
+ <ul class="return">
3375
+
3376
+ <li>
3377
+
3378
+
3379
+ <span class='type'>(<tt>String</tt>)</span>
3380
+
3381
+
3382
+
3383
+ &mdash;
3384
+ <div class='inline'>
3385
+ <p>Raw file stream</p>
3386
+ </div>
3387
+
3388
+ </li>
3389
+
3390
+ </ul>
3391
+
3392
+ </div><table class="source_code">
3393
+ <tr>
3394
+ <td>
3395
+ <pre class="lines">
3396
+
3397
+
3398
+ 64
3399
+ 65
3400
+ 66
3401
+ 67
3402
+ 68
3403
+ 69
3404
+ 70
3405
+ 71
3406
+ 72</pre>
3407
+ </td>
3408
+ <td>
3409
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 64</span>
3410
+
3411
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget_document_file'>get_widget_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_id'>document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3412
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget_document_file'>get_widget_document_file</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_id'>document_id</span><span class='rparen'>)</span>
3413
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3414
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3415
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3416
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3417
+ <span class='kw'>end</span>
3418
+ <span class='id identifier rubyid_response'>response</span>
3419
+ <span class='kw'>end</span></pre>
3420
+ </td>
3421
+ </tr>
3422
+ </table>
3423
+ </div>
3424
+
3425
+ <div class="method_details ">
3426
+ <h3 class="signature " id="get_widget_documents-instance_method">
3427
+
3428
+ - (<tt>Hash</tt>) <strong>get_widget_documents</strong>(widget_id, version_id = nil, participant_email = nil)
3429
+
3430
+
3431
+
3432
+
3433
+
3434
+ </h3><div class="docstring">
3435
+ <div class="discussion">
3436
+
3437
+ <p>Retrieves the IDs of the documents associated with widget.</p>
3438
+
3439
+
3440
+ </div>
3441
+ </div>
3442
+ <div class="tags">
3443
+ <p class="tag_title">Parameters:</p>
3444
+ <ul class="param">
3445
+
3446
+ <li>
3447
+
3448
+ <span class='name'>widget_id</span>
3449
+
3450
+
3451
+ <span class='type'>(<tt>String</tt>)</span>
3452
+
3453
+
3454
+
3455
+ </li>
3456
+
3457
+ <li>
3458
+
3459
+ <span class='name'>version_id</span>
3460
+
3461
+
3462
+ <span class='type'>(<tt>String</tt>)</span>
3463
+
3464
+
3465
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3466
+
3467
+
3468
+ &mdash;
3469
+ <div class='inline'>
3470
+ <p>The version identifier of widget as provided by get_widget. If not provided
3471
+ then latest version will be used.</p>
3472
+ </div>
3473
+
3474
+ </li>
3475
+
3476
+ <li>
3477
+
3478
+ <span class='name'>participant_email</span>
3479
+
3480
+
3481
+ <span class='type'>(<tt>String</tt>)</span>
3482
+
3483
+
3484
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3485
+
3486
+
3487
+ &mdash;
3488
+ <div class='inline'>
3489
+ <p>The email address of the participant to be used to retrieve documents</p>
3490
+ </div>
3491
+
3492
+ </li>
3493
+
3494
+ </ul>
3495
+
3496
+ <p class="tag_title">Returns:</p>
3497
+ <ul class="return">
3498
+
3499
+ <li>
3500
+
3501
+
3502
+ <span class='type'>(<tt>Hash</tt>)</span>
3503
+
3504
+
3505
+
3506
+ &mdash;
3507
+ <div class='inline'>
3508
+ <p>Info about widget documents</p>
3509
+ </div>
3510
+
3511
+ </li>
3512
+
3513
+ </ul>
3514
+
3515
+ </div><table class="source_code">
3516
+ <tr>
3517
+ <td>
3518
+ <pre class="lines">
3519
+
3520
+
3521
+ 54
3522
+ 55
3523
+ 56</pre>
3524
+ </td>
3525
+ <td>
3526
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 54</span>
3527
+
3528
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget_documents'>get_widget_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version_id'>version_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_participant_email'>participant_email</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3529
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget_documents'>get_widget_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version_id'>version_id</span><span class='comma'>,</span> <span class='id identifier rubyid_participant_email'>participant_email</span><span class='rparen'>)</span>
3530
+ <span class='kw'>end</span></pre>
3531
+ </td>
3532
+ </tr>
3533
+ </table>
3534
+ </div>
3535
+
3536
+ <div class="method_details ">
3537
+ <h3 class="signature " id="get_widget_form_data-instance_method">
3538
+
3539
+ - (<tt>String</tt>) <strong>get_widget_form_data</strong>(widget_id, file_path = nil)
3540
+
3541
+
3542
+
3543
+
3544
+
3545
+ </h3><div class="docstring">
3546
+ <div class="discussion">
3547
+
3548
+ <div class="note notetag">
3549
+ <strong>Note:</strong>
3550
+ <div class='inline'>
3551
+ <p>SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE</p>
3552
+ </div>
3553
+ </div>
3554
+
3555
+
3556
+ <p>Retrieves data entered by the user into interactive form fields at the time
3557
+ they signed the widget</p>
3558
+
3559
+
3560
+ </div>
3561
+ </div>
3562
+ <div class="tags">
3563
+ <p class="tag_title">Parameters:</p>
3564
+ <ul class="param">
3565
+
3566
+ <li>
3567
+
3568
+ <span class='name'>widget_id</span>
3569
+
3570
+
3571
+ <span class='type'>(<tt>String</tt>)</span>
3572
+
3573
+
3574
+
3575
+ </li>
3576
+
3577
+ <li>
3578
+
3579
+ <span class='name'>file_path</span>
3580
+
3581
+
3582
+ <span class='type'>(<tt>String</tt>)</span>
3583
+
3584
+
3585
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3586
+
3587
+
3588
+ &mdash;
3589
+ <div class='inline'>
3590
+ <p>File path where to save the document. If none is given, nothing will be
3591
+ saved to file.</p>
3592
+ </div>
3593
+
3594
+ </li>
3595
+
3596
+ </ul>
3597
+
3598
+ <p class="tag_title">Returns:</p>
3599
+ <ul class="return">
3600
+
3601
+ <li>
3602
+
3603
+
3604
+ <span class='type'>(<tt>String</tt>)</span>
3605
+
3606
+
3607
+
3608
+ &mdash;
3609
+ <div class='inline'>
3610
+ <p>Raw file stream</p>
3611
+ </div>
3612
+
3613
+ </li>
3614
+
3615
+ </ul>
3616
+
3617
+ </div><table class="source_code">
3618
+ <tr>
3619
+ <td>
3620
+ <pre class="lines">
3621
+
3622
+
3623
+ 112
3624
+ 113
3625
+ 114
3626
+ 115
3627
+ 116
3628
+ 117
3629
+ 118
3630
+ 119
3631
+ 120</pre>
3632
+ </td>
3633
+ <td>
3634
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 112</span>
3635
+
3636
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widget_form_data'>get_widget_form_data</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3637
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widget_form_data'>get_widget_form_data</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='rparen'>)</span>
3638
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3639
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3640
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3641
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3642
+ <span class='kw'>end</span>
3643
+ <span class='id identifier rubyid_response'>response</span>
3644
+ <span class='kw'>end</span></pre>
3645
+ </td>
3646
+ </tr>
3647
+ </table>
3648
+ </div>
3649
+
3650
+ <div class="method_details ">
3651
+ <h3 class="signature " id="get_widgets-instance_method">
3652
+
3653
+ - (<tt>Hash</tt>) <strong>get_widgets</strong>(user_id = nil, user_email = nil)
3654
+
3655
+
3656
+
3657
+
3658
+
3659
+ </h3><div class="docstring">
3660
+ <div class="discussion">
3661
+
3662
+ <p>Retrieves widgets for a user</p>
3663
+
3664
+
3665
+ </div>
3666
+ </div>
3667
+ <div class="tags">
3668
+ <p class="tag_title">Parameters:</p>
3669
+ <ul class="param">
3670
+
3671
+ <li>
3672
+
3673
+ <span class='name'>user_id</span>
3674
+
3675
+
3676
+ <span class='type'>(<tt>String</tt>)</span>
3677
+
3678
+
3679
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3680
+
3681
+
3682
+ &mdash;
3683
+ <div class='inline'>
3684
+ <p>The ID of the user whose widgets are being requested</p>
3685
+ </div>
3686
+
3687
+ </li>
3688
+
3689
+ <li>
3690
+
3691
+ <span class='name'>user_email</span>
3692
+
3693
+
3694
+ <span class='type'>(<tt>String</tt>)</span>
3695
+
3696
+
3697
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3698
+
3699
+
3700
+ &mdash;
3701
+ <div class='inline'>
3702
+ <p>The email address of the user whose widgets are being requested. If both
3703
+ user_id and user_email are provided then user_id is given preference. If
3704
+ neither is specified then the user is inferred from the access token</p>
3705
+ </div>
3706
+
3707
+ </li>
3708
+
3709
+ </ul>
3710
+
3711
+ <p class="tag_title">Returns:</p>
3712
+ <ul class="return">
3713
+
3714
+ <li>
3715
+
3716
+
3717
+ <span class='type'>(<tt>Hash</tt>)</span>
3718
+
3719
+
3720
+
3721
+ &mdash;
3722
+ <div class='inline'>
3723
+ <p>Widgets info</p>
3724
+ </div>
3725
+
3726
+ </li>
3727
+
3728
+ </ul>
3729
+
3730
+ </div><table class="source_code">
3731
+ <tr>
3732
+ <td>
3733
+ <pre class="lines">
3734
+
3735
+
3736
+ 36
3737
+ 37
3738
+ 38</pre>
3739
+ </td>
3740
+ <td>
3741
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 36</span>
3742
+
3743
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_widgets'>get_widgets</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='rparen'>)</span>
3744
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_get_widgets'>get_widgets</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='rparen'>)</span>
3745
+ <span class='kw'>end</span></pre>
3746
+ </td>
3747
+ </tr>
3748
+ </table>
3749
+ </div>
3750
+
3751
+ <div class="method_details ">
3752
+ <h3 class="signature " id="library_combined_document-instance_method">
3753
+
3754
+ - (<tt>String</tt>) <strong>library_combined_document</strong>(library_document_id, file_path = nil, auditReport = false)
3755
+
3756
+
3757
+
3758
+
3759
+
3760
+ </h3><div class="docstring">
3761
+ <div class="discussion">
3762
+
3763
+ <p>Retrieves library combined document file</p>
3764
+
3765
+
3766
+ </div>
3767
+ </div>
3768
+ <div class="tags">
3769
+ <p class="tag_title">Parameters:</p>
3770
+ <ul class="param">
3771
+
3772
+ <li>
3773
+
3774
+ <span class='name'>library_document_id</span>
3775
+
3776
+
3777
+ <span class='type'>(<tt>REQUIRED</tt>)</span>
3778
+
3779
+
3780
+
3781
+ </li>
3782
+
3783
+ <li>
3784
+
3785
+ <span class='name'>file_path</span>
3786
+
3787
+
3788
+ <span class='type'>(<tt>String</tt>)</span>
3789
+
3790
+
3791
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3792
+
3793
+
3794
+ &mdash;
3795
+ <div class='inline'>
3796
+ <p>File path for saving the document. If none is given, nothing will be saved
3797
+ to disk.</p>
3798
+ </div>
3799
+
3800
+ </li>
3801
+
3802
+ <li>
3803
+
3804
+ <span class='name'>auditReport</span>
3805
+
3806
+
3807
+ <span class='type'>(<tt>Boolean</tt>)</span>
3808
+
3809
+
3810
+ <em class="default">(defaults to: <tt>false</tt>)</em>
3811
+
3812
+
3813
+ &mdash;
3814
+ <div class='inline'>
3815
+ <p>When set to YES attach an audit report to the library document PDF. Default
3816
+ value will be false.</p>
3817
+ </div>
3818
+
3819
+ </li>
3820
+
3821
+ </ul>
3822
+
3823
+ <p class="tag_title">Returns:</p>
3824
+ <ul class="return">
3825
+
3826
+ <li>
3827
+
3828
+
3829
+ <span class='type'>(<tt>String</tt>)</span>
3830
+
3831
+
3832
+
3833
+ &mdash;
3834
+ <div class='inline'>
3835
+ <p>Raw library combined document file data</p>
3836
+ </div>
3837
+
3838
+ </li>
3839
+
3840
+ </ul>
3841
+
3842
+ </div><table class="source_code">
3843
+ <tr>
3844
+ <td>
3845
+ <pre class="lines">
3846
+
3847
+
3848
+ 67
3849
+ 68
3850
+ 69
3851
+ 70
3852
+ 71
3853
+ 72
3854
+ 73
3855
+ 74
3856
+ 75</pre>
3857
+ </td>
3858
+ <td>
3859
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 67</span>
3860
+
3861
+ <span class='kw'>def</span> <span class='id identifier rubyid_library_combined_document'>library_combined_document</span><span class='lparen'>(</span><span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_auditReport'>auditReport</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
3862
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_library_combined_document'>library_combined_document</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_auditReport'>auditReport</span><span class='rparen'>)</span>
3863
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3864
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3865
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3866
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3867
+ <span class='kw'>end</span>
3868
+ <span class='id identifier rubyid_response'>response</span>
3869
+ <span class='kw'>end</span></pre>
3870
+ </td>
3871
+ </tr>
3872
+ </table>
3873
+ </div>
3874
+
3875
+ <div class="method_details ">
3876
+ <h3 class="signature " id="library_document_audit_trail-instance_method">
3877
+
3878
+ - (<tt>String</tt>) <strong>library_document_audit_trail</strong>(library_document_id, file_path = nil)
3879
+
3880
+
3881
+
3882
+
3883
+
3884
+ </h3><div class="docstring">
3885
+ <div class="discussion">
3886
+
3887
+ <p>Retrieves library document audit trail file</p>
3888
+
3889
+
3890
+ </div>
3891
+ </div>
3892
+ <div class="tags">
3893
+ <p class="tag_title">Parameters:</p>
3894
+ <ul class="param">
3895
+
3896
+ <li>
3897
+
3898
+ <span class='name'>library_document_id</span>
3899
+
3900
+
3901
+ <span class='type'>(<tt>REQUIRED</tt>)</span>
3902
+
3903
+
3904
+
3905
+ </li>
3906
+
3907
+ <li>
3908
+
3909
+ <span class='name'>file_path</span>
3910
+
3911
+
3912
+ <span class='type'>(<tt>String</tt>)</span>
3913
+
3914
+
3915
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3916
+
3917
+
3918
+ &mdash;
3919
+ <div class='inline'>
3920
+ <p>File path for saving the document. If none is given, nothing will be saved
3921
+ to disk.</p>
3922
+ </div>
3923
+
3924
+ </li>
3925
+
3926
+ </ul>
3927
+
3928
+ <p class="tag_title">Returns:</p>
3929
+ <ul class="return">
3930
+
3931
+ <li>
3932
+
3933
+
3934
+ <span class='type'>(<tt>String</tt>)</span>
3935
+
3936
+
3937
+
3938
+ &mdash;
3939
+ <div class='inline'>
3940
+ <p>Raw library document file data</p>
3941
+ </div>
3942
+
3943
+ </li>
3944
+
3945
+ </ul>
3946
+
3947
+ </div><table class="source_code">
3948
+ <tr>
3949
+ <td>
3950
+ <pre class="lines">
3951
+
3952
+
3953
+ 51
3954
+ 52
3955
+ 53
3956
+ 54
3957
+ 55
3958
+ 56
3959
+ 57
3960
+ 58
3961
+ 59</pre>
3962
+ </td>
3963
+ <td>
3964
+ <pre class="code"><span class="info file"># File 'lib/echochamber/library_documents/client.rb', line 51</span>
3965
+
3966
+ <span class='kw'>def</span> <span class='id identifier rubyid_library_document_audit_trail'>library_document_audit_trail</span><span class='lparen'>(</span><span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3967
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_library_document_audit_trail'>library_document_audit_trail</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_library_document_id'>library_document_id</span><span class='rparen'>)</span>
3968
+ <span class='kw'>unless</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3969
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3970
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3971
+ <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
3972
+ <span class='kw'>end</span>
3973
+ <span class='id identifier rubyid_response'>response</span>
3974
+ <span class='kw'>end</span></pre>
3975
+ </td>
3976
+ </tr>
3977
+ </table>
3978
+ </div>
3979
+
3980
+ <div class="method_details ">
3981
+ <h3 class="signature " id="personalize_widget-instance_method">
3982
+
3983
+ - (<tt>Hash</tt>) <strong>personalize_widget</strong>(widget_id, personalization)
3984
+
3985
+
3986
+
3987
+
3988
+
3989
+ </h3><div class="docstring">
3990
+ <div class="discussion">
3991
+
3992
+ <p>Personalize the widget to a signable document for a specific known user</p>
3993
+
3994
+
3995
+ </div>
3996
+ </div>
3997
+ <div class="tags">
3998
+ <p class="tag_title">Parameters:</p>
3999
+ <ul class="param">
4000
+
4001
+ <li>
4002
+
4003
+ <span class='name'>widget_id</span>
4004
+
4005
+
4006
+ <span class='type'></span>
4007
+
4008
+
4009
+
4010
+ </li>
4011
+
4012
+ <li>
4013
+
4014
+ <span class='name'>personalization</span>
4015
+
4016
+
4017
+ <span class='type'>(<tt><span class='object_link'><a href="WidgetPersonalization.html" title="Echochamber::WidgetPersonalization (class)">Echochamber::WidgetPersonalization</a></span></tt>)</span>
4018
+
4019
+
4020
+
4021
+ </li>
4022
+
4023
+ </ul>
4024
+
4025
+ <p class="tag_title">Returns:</p>
4026
+ <ul class="return">
4027
+
4028
+ <li>
4029
+
4030
+
4031
+ <span class='type'>(<tt>Hash</tt>)</span>
4032
+
4033
+
4034
+
4035
+ &mdash;
4036
+ <div class='inline'>
4037
+ <p>Operation result</p>
4038
+ </div>
4039
+
4040
+ </li>
4041
+
4042
+ </ul>
4043
+
4044
+ </div><table class="source_code">
4045
+ <tr>
4046
+ <td>
4047
+ <pre class="lines">
4048
+
4049
+
4050
+ 18
4051
+ 19
4052
+ 20</pre>
4053
+ </td>
4054
+ <td>
4055
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 18</span>
4056
+
4057
+ <span class='kw'>def</span> <span class='id identifier rubyid_personalize_widget'>personalize_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_personalization'>personalization</span><span class='rparen'>)</span>
4058
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_personalize_widget'>personalize_widget</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_personalization'>personalization</span><span class='rparen'>)</span>
4059
+ <span class='kw'>end</span></pre>
4060
+ </td>
4061
+ </tr>
4062
+ </table>
4063
+ </div>
4064
+
4065
+ <div class="method_details ">
4066
+ <h3 class="signature " id="update_widget_status-instance_method">
4067
+
4068
+ - (<tt>Hash</tt>) <strong>update_widget_status</strong>(widget_id, status)
4069
+
4070
+
4071
+
4072
+
4073
+
4074
+ </h3><div class="docstring">
4075
+ <div class="discussion">
4076
+
4077
+ <p>Enables or Disables a widget</p>
4078
+
4079
+
4080
+ </div>
4081
+ </div>
4082
+ <div class="tags">
4083
+ <p class="tag_title">Parameters:</p>
4084
+ <ul class="param">
4085
+
4086
+ <li>
4087
+
4088
+ <span class='name'>widget_id</span>
4089
+
4090
+
4091
+ <span class='type'></span>
4092
+
4093
+
4094
+
4095
+ </li>
4096
+
4097
+ <li>
4098
+
4099
+ <span class='name'>status</span>
4100
+
4101
+
4102
+ <span class='type'>(<tt><span class='object_link'><a href="WidgetStatus.html" title="Echochamber::WidgetStatus (class)">Echochamber::WidgetStatus</a></span></tt>)</span>
4103
+
4104
+
4105
+
4106
+ </li>
4107
+
4108
+ </ul>
4109
+
4110
+ <p class="tag_title">Returns:</p>
4111
+ <ul class="return">
4112
+
4113
+ <li>
4114
+
4115
+
4116
+ <span class='type'>(<tt>Hash</tt>)</span>
4117
+
4118
+
4119
+
4120
+ &mdash;
4121
+ <div class='inline'>
4122
+ <p>Widget status</p>
4123
+ </div>
4124
+
4125
+ </li>
4126
+
4127
+ </ul>
4128
+
4129
+ </div><table class="source_code">
4130
+ <tr>
4131
+ <td>
4132
+ <pre class="lines">
4133
+
4134
+
4135
+ 27
4136
+ 28
4137
+ 29</pre>
4138
+ </td>
4139
+ <td>
4140
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget/client.rb', line 27</span>
4141
+
4142
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_widget_status'>update_widget_status</span><span class='lparen'>(</span><span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
4143
+ <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_update_widget_status'>update_widget_status</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_widget_id'>widget_id</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
4144
+ <span class='kw'>end</span></pre>
4145
+ </td>
4146
+ </tr>
4147
+ </table>
4148
+ </div>
4149
+
4150
+ </div>
4151
+
4152
+ </div>
4153
+
4154
+ <div id="footer">
4155
+ Generated on Thu Aug 21 05:14:34 2014 by
4156
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
4157
+ 0.8.7.4 (ruby-2.0.0).
4158
+ </div>
4159
+
4160
+ </body>
4161
+ </html>