echosign 1.0.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -1
  3. data/.rubocop.yml +14 -0
  4. data/.rubocop_todo.yml +241 -0
  5. data/.simplecov +2 -0
  6. data/.travis.yml +9 -0
  7. data/Gemfile +3 -3
  8. data/Gemfile.lock +74 -48
  9. data/README.md +43 -8
  10. data/Rakefile +2 -2
  11. data/doc/Echosign.html +135 -0
  12. data/doc/Echosign/Agreement.html +545 -0
  13. data/doc/Echosign/Client.html +5365 -0
  14. data/doc/Echosign/CounterSignerInfo.html +267 -0
  15. data/doc/Echosign/Credentials.html +1053 -0
  16. data/doc/Echosign/Fileinfo.html +305 -0
  17. data/doc/Echosign/FormFieldLocation.html +264 -0
  18. data/doc/Echosign/MegaSign.html +533 -0
  19. data/doc/Echosign/ParameterError.html +124 -0
  20. data/doc/Echosign/PhoneInfo.html +281 -0
  21. data/doc/Echosign/Recipient.html +311 -0
  22. data/doc/Echosign/RecipientSecurityOption.html +296 -0
  23. data/doc/Echosign/Refresh.html +288 -0
  24. data/doc/Echosign/Reminder.html +279 -0
  25. data/doc/Echosign/Request.html +5289 -0
  26. data/doc/Echosign/Request/EndpointHash.html +328 -0
  27. data/doc/Echosign/Request/Failure.html +290 -0
  28. data/doc/Echosign/RequestFormField.html +244 -0
  29. data/doc/Echosign/RequiredParameterError.html +124 -0
  30. data/doc/Echosign/UrlFileInfo.html +297 -0
  31. data/doc/Echosign/User.html +422 -0
  32. data/doc/Echosign/Validatable.html +355 -0
  33. data/doc/Echosign/Widget.html +924 -0
  34. data/doc/Echosign/WidgetCompletionInfo.html +323 -0
  35. data/doc/Echosign/WidgetPersonalization.html +330 -0
  36. data/doc/Echosign/WidgetSecurityOption.html +361 -0
  37. data/doc/Echosign/WidgetSignerSecurityOption.html +298 -0
  38. data/doc/Echosign/WidgetStatus.html +316 -0
  39. data/doc/Echosign/WidgetVaultingInfo.html +267 -0
  40. data/doc/_index.html +378 -0
  41. data/doc/class_list.html +51 -0
  42. data/doc/css/common.css +1 -0
  43. data/doc/css/full_list.css +58 -0
  44. data/doc/css/style.css +496 -0
  45. data/doc/file.README.html +191 -0
  46. data/doc/file_list.html +56 -0
  47. data/doc/frames.html +17 -0
  48. data/doc/index.html +191 -0
  49. data/doc/js/app.js +292 -0
  50. data/doc/js/full_list.js +216 -0
  51. data/doc/js/jquery.js +4 -0
  52. data/doc/method_list.html +1035 -0
  53. data/doc/top-level-namespace.html +110 -0
  54. data/echosign.gemspec +18 -20
  55. data/features/support/env.rb +8 -8
  56. data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +2 -2
  57. data/fixtures/vcr_cassettes/agreement_document_file.yml +1 -1
  58. data/fixtures/vcr_cassettes/agreement_documents.yml +2 -2
  59. data/fixtures/vcr_cassettes/agreement_form_data.yml +1 -1
  60. data/fixtures/vcr_cassettes/agreement_info.yml +1 -1
  61. data/fixtures/vcr_cassettes/agreement_signing_urls.yml +1 -1
  62. data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1 -1
  63. data/fixtures/vcr_cassettes/cancel_agreement.yml +1 -1
  64. data/fixtures/vcr_cassettes/create_agreement.yml +1 -1
  65. data/fixtures/vcr_cassettes/create_reminder.yml +1 -1
  66. data/fixtures/vcr_cassettes/create_transient_document.yml +1 -1
  67. data/fixtures/vcr_cassettes/create_user.yml +1 -1
  68. data/fixtures/vcr_cassettes/create_widget.yml +1 -1
  69. data/fixtures/vcr_cassettes/get_agreements.yml +1 -1
  70. data/fixtures/vcr_cassettes/get_library_document.yml +1 -1
  71. data/fixtures/vcr_cassettes/get_library_document_data.yml +1 -1
  72. data/fixtures/vcr_cassettes/get_library_document_file.yml +1 -1
  73. data/fixtures/vcr_cassettes/get_library_documents.yml +1 -1
  74. data/fixtures/vcr_cassettes/get_token.yml +22 -20
  75. data/fixtures/vcr_cassettes/get_user.yml +1 -1
  76. data/fixtures/vcr_cassettes/get_users.yml +2 -2
  77. data/fixtures/vcr_cassettes/get_widget.yml +1 -1
  78. data/fixtures/vcr_cassettes/get_widget_document_file.yml +1 -1
  79. data/fixtures/vcr_cassettes/get_widget_documents.yml +1 -1
  80. data/fixtures/vcr_cassettes/get_widgets.yml +1 -1
  81. data/fixtures/vcr_cassettes/library_combined_document.yml +2 -2
  82. data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1 -1
  83. data/fixtures/vcr_cassettes/personalize_widget.yml +1 -1
  84. data/fixtures/vcr_cassettes/refresh_token.yml +46 -0
  85. data/fixtures/vcr_cassettes/revoke_token.yml +44 -0
  86. data/fixtures/vcr_cassettes/update_widget_status.yml +1 -1
  87. data/lib/echosign.rb +11 -11
  88. data/lib/echosign/agreement.rb +26 -10
  89. data/lib/echosign/agreement/client.rb +111 -104
  90. data/lib/echosign/agreement/fileinfo.rb +1 -3
  91. data/lib/echosign/agreement/form_field_location.rb +2 -3
  92. data/lib/echosign/agreement/phone_info.rb +5 -5
  93. data/lib/echosign/agreement/recipient.rb +9 -8
  94. data/lib/echosign/agreement/recipient_security_option.rb +5 -4
  95. data/lib/echosign/agreement/request.rb +33 -43
  96. data/lib/echosign/agreement/request_form_field.rb +2 -3
  97. data/lib/echosign/agreement/url_file_info.rb +8 -6
  98. data/lib/echosign/client.rb +33 -24
  99. data/lib/echosign/credentials.rb +95 -24
  100. data/lib/echosign/library_documents/client.rb +18 -23
  101. data/lib/echosign/library_documents/request.rb +19 -20
  102. data/lib/echosign/mega_sign.rb +20 -10
  103. data/lib/echosign/mega_sign/client.rb +109 -104
  104. data/lib/echosign/mega_sign/request.rb +32 -43
  105. data/lib/echosign/refresh.rb +6 -10
  106. data/lib/echosign/reminder.rb +2 -2
  107. data/lib/echosign/request.rb +85 -75
  108. data/lib/echosign/user.rb +13 -7
  109. data/lib/echosign/validatable.rb +6 -10
  110. data/lib/echosign/version.rb +1 -1
  111. data/lib/echosign/widget.rb +53 -27
  112. data/lib/echosign/widget/client.rb +33 -36
  113. data/lib/echosign/widget/counter_signer_info.rb +4 -5
  114. data/lib/echosign/widget/request.rb +28 -52
  115. data/lib/echosign/widget/widget_completion_info.rb +22 -12
  116. data/lib/echosign/widget/widget_personalization.rb +9 -7
  117. data/lib/echosign/widget/widget_security_option.rb +21 -11
  118. data/lib/echosign/widget/widget_signer_security_option.rb +8 -6
  119. data/lib/echosign/widget/widget_status.rb +10 -8
  120. data/lib/echosign/widget/widget_vaulting_info.rb +4 -5
  121. data/spec/lib/agreement/client_spec.rb +25 -31
  122. data/spec/lib/client_spec.rb +15 -18
  123. data/spec/lib/credentials_spec.rb +48 -0
  124. data/spec/lib/library_documents/client_spec.rb +11 -15
  125. data/spec/lib/shared_client.rb +9 -16
  126. data/spec/lib/user_spec.rb +0 -2
  127. data/spec/lib/validatable_spec.rb +12 -18
  128. data/spec/lib/version_spec.rb +1 -1
  129. data/spec/lib/widget/client_spec.rb +46 -49
  130. data/spec/spec_helper.rb +12 -5
  131. metadata +125 -60
  132. data/spec/lib/request_spec.rb +0 -18
data/doc/Echosign/CounterSignerInfo.html ADDED
@@ -0,0 +1,267 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Echosign::CounterSignerInfo
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Echosign::CounterSignerInfo";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Echosign.html" title="Echosign (module)">Echosign</a></span></span>
41
+ &raquo;
42
+ <span class="title">CounterSignerInfo</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Echosign::CounterSignerInfo
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Hash</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Hash</li>
78
+
79
+ <li class="next">Echosign::CounterSignerInfo</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+ <dl>
93
+ <dt>Includes:</dt>
94
+ <dd><span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/echosign/widget/counter_signer_info.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+ <h2>
118
+ Instance Method Summary
119
+ <small><a href="#" class="summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(params) &#x21d2; CounterSignerInfo </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+ <span class="note title constructor">constructor</span>
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ <span class="summary_desc"><div class='inline'>
144
+ <p>A new instance of CounterSignerInfo.</p>
145
+ </div></span>
146
+
147
+ </li>
148
+
149
+
150
+ </ul>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></h3>
163
+ <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echosign::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echosign::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echosign::Validatable#validate_field (method)">#validate_field</a></span></p>
164
+
165
+ <div id="constructor_details" class="method_details_list">
166
+ <h2>Constructor Details</h2>
167
+
168
+ <div class="method_details first">
169
+ <h3 class="signature first" id="initialize-instance_method">
170
+
171
+ #<strong>initialize</strong>(params) &#x21d2; <tt><span class='object_link'><a href="" title="Echosign::CounterSignerInfo (class)">CounterSignerInfo</a></span></tt>
172
+
173
+
174
+
175
+
176
+
177
+ </h3><div class="docstring">
178
+ <div class="discussion">
179
+
180
+ <p>Returns a new instance of CounterSignerInfo</p>
181
+
182
+
183
+ </div>
184
+ </div>
185
+ <div class="tags">
186
+ <p class="tag_title">Parameters:</p>
187
+ <ul class="param">
188
+
189
+ <li>
190
+
191
+ <span class='name'>params</span>
192
+
193
+
194
+ <span class='type'>(<tt>Hash</tt>)</span>
195
+
196
+
197
+
198
+ &mdash;
199
+ <div class='inline'>
200
+ <p>a customizable set of options</p>
201
+ </div>
202
+
203
+ </li>
204
+
205
+ </ul>
206
+
207
+
208
+
209
+
210
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
211
+ <ul class="option">
212
+
213
+ <li>
214
+ <span class="name">:securityOptions</span>
215
+ <span class="type">(<tt>Array</tt>)</span>
216
+ <span class="default">
217
+
218
+ </span>
219
+
220
+ &mdash; <div class='inline'>
221
+ <p>Populate with instances of <span class='object_link'><a href="WidgetSignerSecurityOption.html" title="Echosign::WidgetSignerSecurityOption (class)">Echosign::WidgetSignerSecurityOption</a></span> Security options that apply to the
222
+ counter signers</p>
223
+ </div>
224
+
225
+ </li>
226
+
227
+ </ul>
228
+
229
+
230
+
231
+ </div><table class="source_code">
232
+ <tr>
233
+ <td>
234
+ <pre class="lines">
235
+
236
+
237
+ 13
238
+ 14
239
+ 15
240
+ 16</pre>
241
+ </td>
242
+ <td>
243
+ <pre class="code"><span class="info file"># File 'lib/echosign/widget/counter_signer_info.rb', line 13</span>
244
+
245
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
246
+ <span class='id identifier rubyid_require_keys'>require_keys</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:email</span><span class='comma'>,</span> <span class='symbol'>:role</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
247
+ <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
248
+ <span class='kw'>end</span></pre>
249
+ </td>
250
+ </tr>
251
+ </table>
252
+ </div>
253
+
254
+ </div>
255
+
256
+
257
+ </div>
258
+
259
+ <div id="footer">
260
+ Generated on Thu Oct 18 12:44:50 2018 by
261
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
262
+ 0.9.16 (ruby-2.6.0).
263
+ </div>
264
+
265
+ </div>
266
+ </body>
267
+ </html>
data/doc/Echosign/Credentials.html ADDED
@@ -0,0 +1,1053 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Echosign::Credentials
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Echosign::Credentials";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Echosign.html" title="Echosign (module)">Echosign</a></span></span>
41
+ &raquo;
42
+ <span class="title">Credentials</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Echosign::Credentials
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Echosign::Credentials</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+ <dl>
91
+ <dt>Includes:</dt>
92
+ <dd><span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></dd>
93
+ </dl>
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dl>
101
+ <dt>Defined in:</dt>
102
+ <dd>lib/echosign/credentials.rb</dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+
108
+
109
+ <h2>
110
+ Constant Summary
111
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
112
+ </h2>
113
+
114
+ <dl class="constants">
115
+
116
+ <dt id="OAUTH_SITE-constant" class="">OAUTH_SITE =
117
+
118
+ </dt>
119
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://secure.echosign.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
120
+
121
+ <dt id="AUTHORIZE_PATH-constant" class="">AUTHORIZE_PATH =
122
+
123
+ </dt>
124
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/public/oauth</span><span class='tstring_end'>&#39;</span></span></pre></dd>
125
+
126
+ <dt id="TOKEN_PATH-constant" class="">TOKEN_PATH =
127
+
128
+ </dt>
129
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/oauth/token</span><span class='tstring_end'>&#39;</span></span></pre></dd>
130
+
131
+ <dt id="REFRESH_PATH-constant" class="">REFRESH_PATH =
132
+
133
+ </dt>
134
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/oauth/refresh</span><span class='tstring_end'>&#39;</span></span></pre></dd>
135
+
136
+ <dt id="REVOKE_PATH-constant" class="">REVOKE_PATH =
137
+
138
+ </dt>
139
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/oauth/revoke</span><span class='tstring_end'>&#39;</span></span></pre></dd>
140
+
141
+ </dl>
142
+
143
+
144
+
145
+
146
+
147
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#access_token-instance_method" title="#access_token (instance method)">#<strong>access_token</strong> &#x21d2; Object </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+ <span class="note title readonly">readonly</span>
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ <span class="summary_desc"><div class='inline'>
173
+ <p>Returns the value of attribute access_token.</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#expires_at-instance_method" title="#expires_at (instance method)">#<strong>expires_at</strong> &#x21d2; Object </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+ <span class="note title readonly">readonly</span>
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+ <span class="summary_desc"><div class='inline'>
202
+ <p>Returns the value of attribute expires_at.</p>
203
+ </div></span>
204
+
205
+ </li>
206
+
207
+
208
+ <li class="public ">
209
+ <span class="summary_signature">
210
+
211
+ <a href="#refresh_token-instance_method" title="#refresh_token (instance method)">#<strong>refresh_token</strong> &#x21d2; Object </a>
212
+
213
+
214
+
215
+ </span>
216
+
217
+
218
+
219
+
220
+ <span class="note title readonly">readonly</span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+ <span class="summary_desc"><div class='inline'>
231
+ <p>Returns the value of attribute refresh_token.</p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ </ul>
238
+
239
+
240
+
241
+
242
+
243
+ <h2>
244
+ Instance Method Summary
245
+ <small><a href="#" class="summary_toggle">collapse</a></small>
246
+ </h2>
247
+
248
+ <ul class="summary">
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#authorize_url-instance_method" title="#authorize_url (instance method)">#<strong>authorize_url</strong>(redirect_uri, scope, state = nil) &#x21d2; Echosign::Credentials </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>Build an authorization endpoint URL for EchoSign&#39;s OAuth2 provider.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#get_token-instance_method" title="#get_token (instance method)">#<strong>get_token</strong>(code, redirect_uri) &#x21d2; String </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>Make a request to the token endpoint and return an access token.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ <li class="public ">
299
+ <span class="summary_signature">
300
+
301
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client_id, client_secret) &#x21d2; Echosign::Credentials </a>
302
+
303
+
304
+
305
+ </span>
306
+
307
+
308
+ <span class="note title constructor">constructor</span>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ <span class="summary_desc"><div class='inline'>
318
+ <p>Builds an Credentials object.</p>
319
+ </div></span>
320
+
321
+ </li>
322
+
323
+
324
+ <li class="public ">
325
+ <span class="summary_signature">
326
+
327
+ <a href="#refresh_access_token-instance_method" title="#refresh_access_token (instance method)">#<strong>refresh_access_token</strong>(current_refresh_token = nil) &#x21d2; String </a>
328
+
329
+
330
+
331
+ </span>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <span class="summary_desc"><div class='inline'>
342
+ <p>Update (refresh) an access token.</p>
343
+ </div></span>
344
+
345
+ </li>
346
+
347
+
348
+ <li class="public ">
349
+ <span class="summary_signature">
350
+
351
+ <a href="#revoke_token-instance_method" title="#revoke_token (instance method)">#<strong>revoke_token</strong>(which = :access) &#x21d2; void </a>
352
+
353
+
354
+
355
+ </span>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+ <span class="summary_desc"><div class='inline'>
366
+ <p>Revoke an access or refresh token, and any corresponding tokens.</p>
367
+ </div></span>
368
+
369
+ </li>
370
+
371
+
372
+ </ul>
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></h3>
385
+ <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echosign::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echosign::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echosign::Validatable#validate_field (method)">#validate_field</a></span></p>
386
+ <div id="constructor_details" class="method_details_list">
387
+ <h2>Constructor Details</h2>
388
+
389
+ <div class="method_details first">
390
+ <h3 class="signature first" id="initialize-instance_method">
391
+
392
+ #<strong>initialize</strong>(client_id, client_secret) &#x21d2; <tt><span class='object_link'><a href="" title="Echosign::Credentials (class)">Echosign::Credentials</a></span></tt>
393
+
394
+
395
+
396
+
397
+
398
+ </h3><div class="docstring">
399
+ <div class="discussion">
400
+
401
+ <p>Builds an Credentials object</p>
402
+
403
+
404
+ </div>
405
+ </div>
406
+ <div class="tags">
407
+ <p class="tag_title">Parameters:</p>
408
+ <ul class="param">
409
+
410
+ <li>
411
+
412
+ <span class='name'>client_id</span>
413
+
414
+
415
+ <span class='type'>(<tt>String</tt>)</span>
416
+
417
+
418
+
419
+ &mdash;
420
+ <div class='inline'>
421
+ <p>Client ID</p>
422
+ </div>
423
+
424
+ </li>
425
+
426
+ <li>
427
+
428
+ <span class='name'>client_secret</span>
429
+
430
+
431
+ <span class='type'>(<tt>String</tt>)</span>
432
+
433
+
434
+
435
+ &mdash;
436
+ <div class='inline'>
437
+ <p>Client secret</p>
438
+ </div>
439
+
440
+ </li>
441
+
442
+ </ul>
443
+
444
+
445
+ </div><table class="source_code">
446
+ <tr>
447
+ <td>
448
+ <pre class="lines">
449
+
450
+
451
+ 21
452
+ 22
453
+ 23
454
+ 24
455
+ 25
456
+ 26
457
+ 27
458
+ 28
459
+ 29</pre>
460
+ </td>
461
+ <td>
462
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 21</span>
463
+
464
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span>
465
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'>OAuth2</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
466
+ <span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span>
467
+ <span class='id identifier rubyid_client_secret'>client_secret</span><span class='comma'>,</span>
468
+ <span class='label'>site:</span> <span class='const'><span class='object_link'><a href="#OAUTH_SITE-constant" title="Echosign::Credentials::OAUTH_SITE (constant)">OAUTH_SITE</a></span></span><span class='comma'>,</span>
469
+ <span class='label'>authorize_url:</span> <span class='const'><span class='object_link'><a href="#AUTHORIZE_PATH-constant" title="Echosign::Credentials::AUTHORIZE_PATH (constant)">AUTHORIZE_PATH</a></span></span><span class='comma'>,</span>
470
+ <span class='label'>token_url:</span> <span class='const'><span class='object_link'><a href="#TOKEN_PATH-constant" title="Echosign::Credentials::TOKEN_PATH (constant)">TOKEN_PATH</a></span></span>
471
+ <span class='rparen'>)</span>
472
+ <span class='kw'>end</span></pre>
473
+ </td>
474
+ </tr>
475
+ </table>
476
+ </div>
477
+
478
+ </div>
479
+
480
+ <div id="instance_attr_details" class="attr_details">
481
+ <h2>Instance Attribute Details</h2>
482
+
483
+
484
+ <span id=""></span>
485
+ <div class="method_details first">
486
+ <h3 class="signature first" id="access_token-instance_method">
487
+
488
+ #<strong>access_token</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
489
+
490
+
491
+
492
+
493
+
494
+ </h3><div class="docstring">
495
+ <div class="discussion">
496
+
497
+ <p>Returns the value of attribute access_token</p>
498
+
499
+
500
+ </div>
501
+ </div>
502
+ <div class="tags">
503
+
504
+
505
+ </div><table class="source_code">
506
+ <tr>
507
+ <td>
508
+ <pre class="lines">
509
+
510
+
511
+ 13
512
+ 14
513
+ 15</pre>
514
+ </td>
515
+ <td>
516
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 13</span>
517
+
518
+ <span class='kw'>def</span> <span class='id identifier rubyid_access_token'>access_token</span>
519
+ <span class='ivar'>@access_token</span>
520
+ <span class='kw'>end</span></pre>
521
+ </td>
522
+ </tr>
523
+ </table>
524
+ </div>
525
+
526
+
527
+ <span id=""></span>
528
+ <div class="method_details ">
529
+ <h3 class="signature " id="expires_at-instance_method">
530
+
531
+ #<strong>expires_at</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
532
+
533
+
534
+
535
+
536
+
537
+ </h3><div class="docstring">
538
+ <div class="discussion">
539
+
540
+ <p>Returns the value of attribute expires_at</p>
541
+
542
+
543
+ </div>
544
+ </div>
545
+ <div class="tags">
546
+
547
+
548
+ </div><table class="source_code">
549
+ <tr>
550
+ <td>
551
+ <pre class="lines">
552
+
553
+
554
+ 13
555
+ 14
556
+ 15</pre>
557
+ </td>
558
+ <td>
559
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 13</span>
560
+
561
+ <span class='kw'>def</span> <span class='id identifier rubyid_expires_at'>expires_at</span>
562
+ <span class='ivar'>@expires_at</span>
563
+ <span class='kw'>end</span></pre>
564
+ </td>
565
+ </tr>
566
+ </table>
567
+ </div>
568
+
569
+
570
+ <span id=""></span>
571
+ <div class="method_details ">
572
+ <h3 class="signature " id="refresh_token-instance_method">
573
+
574
+ #<strong>refresh_token</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
575
+
576
+
577
+
578
+
579
+
580
+ </h3><div class="docstring">
581
+ <div class="discussion">
582
+
583
+ <p>Returns the value of attribute refresh_token</p>
584
+
585
+
586
+ </div>
587
+ </div>
588
+ <div class="tags">
589
+
590
+
591
+ </div><table class="source_code">
592
+ <tr>
593
+ <td>
594
+ <pre class="lines">
595
+
596
+
597
+ 13
598
+ 14
599
+ 15</pre>
600
+ </td>
601
+ <td>
602
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 13</span>
603
+
604
+ <span class='kw'>def</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
605
+ <span class='ivar'>@refresh_token</span>
606
+ <span class='kw'>end</span></pre>
607
+ </td>
608
+ </tr>
609
+ </table>
610
+ </div>
611
+
612
+ </div>
613
+
614
+
615
+ <div id="instance_method_details" class="method_details_list">
616
+ <h2>Instance Method Details</h2>
617
+
618
+
619
+ <div class="method_details first">
620
+ <h3 class="signature first" id="authorize_url-instance_method">
621
+
622
+ #<strong>authorize_url</strong>(redirect_uri, scope, state = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Echosign::Credentials (class)">Echosign::Credentials</a></span></tt>
623
+
624
+
625
+
626
+
627
+
628
+ </h3><div class="docstring">
629
+ <div class="discussion">
630
+
631
+ <p>Build an authorization endpoint URL for EchoSign&#39;s OAuth2 provider</p>
632
+
633
+ <p>The redirect_uri must be specified on the app&#39;s OAuth Configuration
634
+ page.</p>
635
+
636
+
637
+ </div>
638
+ </div>
639
+ <div class="tags">
640
+ <p class="tag_title">Parameters:</p>
641
+ <ul class="param">
642
+
643
+ <li>
644
+
645
+ <span class='name'>redirect_uri</span>
646
+
647
+
648
+ <span class='type'>(<tt>String</tt>)</span>
649
+
650
+
651
+
652
+ &mdash;
653
+ <div class='inline'>
654
+ <p>A secure URL to redirect the user afterward</p>
655
+ </div>
656
+
657
+ </li>
658
+
659
+ <li>
660
+
661
+ <span class='name'>scope</span>
662
+
663
+
664
+ <span class='type'>(<tt>String</tt>)</span>
665
+
666
+
667
+
668
+ &mdash;
669
+ <div class='inline'>
670
+ <p>Space delimited set of permissions to approve</p>
671
+ </div>
672
+
673
+ </li>
674
+
675
+ <li>
676
+
677
+ <span class='name'>state</span>
678
+
679
+
680
+ <span class='type'>(<tt>String</tt>)</span>
681
+
682
+
683
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
684
+
685
+
686
+ &mdash;
687
+ <div class='inline'>
688
+ <p>Any value; will be returned to the client afterward</p>
689
+ </div>
690
+
691
+ </li>
692
+
693
+ </ul>
694
+
695
+ <p class="tag_title">Returns:</p>
696
+ <ul class="return">
697
+
698
+ <li>
699
+
700
+
701
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Echosign::Credentials (class)">Echosign::Credentials</a></span></tt>)</span>
702
+
703
+
704
+
705
+ &mdash;
706
+ <div class='inline'>
707
+ <p>Echosign OAuth2 wrapper object</p>
708
+ </div>
709
+
710
+ </li>
711
+
712
+ </ul>
713
+
714
+ <p class="tag_title">See Also:</p>
715
+ <ul class="see">
716
+
717
+ <li><a href="https://secure.na1.echosign.com/public/static/oauthDoc.jsp#authorizationRequest" target="_parent" title="https://secure.na1.echosign.com/public/static/oauthDoc.jsp#authorizationRequest">https://secure.na1.echosign.com/public/static/oauthDoc.jsp#authorizationRequest</a></li>
718
+
719
+ </ul>
720
+
721
+ </div><table class="source_code">
722
+ <tr>
723
+ <td>
724
+ <pre class="lines">
725
+
726
+
727
+ 41
728
+ 42
729
+ 43
730
+ 44
731
+ 45
732
+ 46
733
+ 47</pre>
734
+ </td>
735
+ <td>
736
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 41</span>
737
+
738
+ <span class='kw'>def</span> <span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span> <span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_state'>state</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
739
+ <span class='kw'>return</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_auth_code'>auth_code</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span>
740
+ <span class='label'>redirect_uri:</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span>
741
+ <span class='label'>scope:</span> <span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span>
742
+ <span class='label'>state:</span> <span class='id identifier rubyid_state'>state</span>
743
+ <span class='rparen'>)</span>
744
+ <span class='kw'>end</span></pre>
745
+ </td>
746
+ </tr>
747
+ </table>
748
+ </div>
749
+
750
+ <div class="method_details ">
751
+ <h3 class="signature " id="get_token-instance_method">
752
+
753
+ #<strong>get_token</strong>(code, redirect_uri) &#x21d2; <tt>String</tt>
754
+
755
+
756
+
757
+
758
+
759
+ </h3><div class="docstring">
760
+ <div class="discussion">
761
+
762
+ <p>Make a request to the token endpoint and return an access token</p>
763
+
764
+
765
+ </div>
766
+ </div>
767
+ <div class="tags">
768
+ <p class="tag_title">Parameters:</p>
769
+ <ul class="param">
770
+
771
+ <li>
772
+
773
+ <span class='name'>code</span>
774
+
775
+
776
+ <span class='type'>(<tt>String</tt>)</span>
777
+
778
+
779
+
780
+ &mdash;
781
+ <div class='inline'>
782
+ <p>The authorization code obtained after #authorize_url</p>
783
+ </div>
784
+
785
+ </li>
786
+
787
+ <li>
788
+
789
+ <span class='name'>redirect_uri</span>
790
+
791
+
792
+ <span class='type'>(<tt>String</tt>)</span>
793
+
794
+
795
+
796
+ &mdash;
797
+ <div class='inline'>
798
+ <p>The redirect_url used during #authorize_url</p>
799
+ </div>
800
+
801
+ </li>
802
+
803
+ </ul>
804
+
805
+ <p class="tag_title">Returns:</p>
806
+ <ul class="return">
807
+
808
+ <li>
809
+
810
+
811
+ <span class='type'>(<tt>String</tt>)</span>
812
+
813
+
814
+
815
+ &mdash;
816
+ <div class='inline'>
817
+ <p>An access token that can be used in the EchoSign API</p>
818
+ </div>
819
+
820
+ </li>
821
+
822
+ </ul>
823
+
824
+ </div><table class="source_code">
825
+ <tr>
826
+ <td>
827
+ <pre class="lines">
828
+
829
+
830
+ 55
831
+ 56
832
+ 57
833
+ 58
834
+ 59
835
+ 60
836
+ 61
837
+ 62
838
+ 63
839
+ 64
840
+ 65
841
+ 66</pre>
842
+ </td>
843
+ <td>
844
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 55</span>
845
+
846
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='rparen'>)</span>
847
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:token_url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#TOKEN_PATH-constant" title="Echosign::Credentials::TOKEN_PATH (constant)">TOKEN_PATH</a></span></span>
848
+ <span class='id identifier rubyid_oauth_token'>oauth_token</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='label'>code:</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span>
849
+ <span class='label'>redirect_uri:</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span>
850
+ <span class='label'>grant_type:</span> <span class='symbol'>:authorization_code</span><span class='rparen'>)</span>
851
+
852
+ <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_token'>oauth_token</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span>
853
+ <span class='ivar'>@refresh_token</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_token'>oauth_token</span><span class='period'>.</span><span class='id identifier rubyid_refresh_token'>refresh_token</span>
854
+ <span class='ivar'>@expires_at</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_token'>oauth_token</span><span class='period'>.</span><span class='id identifier rubyid_expires_at'>expires_at</span>
855
+
856
+ <span class='kw'>return</span> <span class='ivar'>@access_token</span>
857
+ <span class='kw'>end</span></pre>
858
+ </td>
859
+ </tr>
860
+ </table>
861
+ </div>
862
+
863
+ <div class="method_details ">
864
+ <h3 class="signature " id="refresh_access_token-instance_method">
865
+
866
+ #<strong>refresh_access_token</strong>(current_refresh_token = nil) &#x21d2; <tt>String</tt>
867
+
868
+
869
+
870
+
871
+
872
+ </h3><div class="docstring">
873
+ <div class="discussion">
874
+
875
+ <p>Update (refresh) an access token</p>
876
+
877
+ <p>This method should only be called after #get_token</p>
878
+
879
+
880
+ </div>
881
+ </div>
882
+ <div class="tags">
883
+ <p class="tag_title">Parameters:</p>
884
+ <ul class="param">
885
+
886
+ <li>
887
+
888
+ <span class='name'>current_refresh_token</span>
889
+
890
+
891
+ <span class='type'>(<tt>String</tt>)</span>
892
+
893
+
894
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
895
+
896
+
897
+ &mdash;
898
+ <div class='inline'>
899
+ <p>A previously obtained refresh_token from a get_token request</p>
900
+ </div>
901
+
902
+ </li>
903
+
904
+ </ul>
905
+
906
+ <p class="tag_title">Returns:</p>
907
+ <ul class="return">
908
+
909
+ <li>
910
+
911
+
912
+ <span class='type'>(<tt>String</tt>)</span>
913
+
914
+
915
+
916
+ &mdash;
917
+ <div class='inline'>
918
+ <p>A new access token to be used in the EchoSign API</p>
919
+ </div>
920
+
921
+ </li>
922
+
923
+ </ul>
924
+
925
+ </div><table class="source_code">
926
+ <tr>
927
+ <td>
928
+ <pre class="lines">
929
+
930
+
931
+ 75
932
+ 76
933
+ 77
934
+ 78
935
+ 79
936
+ 80
937
+ 81
938
+ 82
939
+ 83
940
+ 84
941
+ 85</pre>
942
+ </td>
943
+ <td>
944
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 75</span>
945
+
946
+ <span class='kw'>def</span> <span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span><span class='lparen'>(</span><span class='id identifier rubyid_current_refresh_token'>current_refresh_token</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
947
+ <span class='ivar'>@refresh_token</span> <span class='op'>=</span> <span class='id identifier rubyid_current_refresh_token'>current_refresh_token</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_refresh_token'>current_refresh_token</span> <span class='op'>!=</span> <span class='kw'>nil</span>
948
+
949
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:token_url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#REFRESH_PATH-constant" title="Echosign::Credentials::REFRESH_PATH (constant)">REFRESH_PATH</a></span></span>
950
+ <span class='id identifier rubyid_oauth_token'>oauth_token</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='label'>grant_type:</span> <span class='symbol'>:refresh_token</span><span class='comma'>,</span> <span class='label'>refresh_token:</span> <span class='ivar'>@refresh_token</span><span class='rparen'>)</span>
951
+
952
+ <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_token'>oauth_token</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span>
953
+ <span class='ivar'>@expires_at</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_token'>oauth_token</span><span class='period'>.</span><span class='id identifier rubyid_expires_at'>expires_at</span>
954
+
955
+ <span class='kw'>return</span> <span class='ivar'>@access_token</span>
956
+ <span class='kw'>end</span></pre>
957
+ </td>
958
+ </tr>
959
+ </table>
960
+ </div>
961
+
962
+ <div class="method_details ">
963
+ <h3 class="signature " id="revoke_token-instance_method">
964
+
965
+ #<strong>revoke_token</strong>(which = :access) &#x21d2; <tt>void</tt>
966
+
967
+
968
+
969
+
970
+
971
+ </h3><div class="docstring">
972
+ <div class="discussion">
973
+ <p class="note returns_void">This method returns an undefined value.</p>
974
+ <p>Revoke an access or refresh token, and any corresponding tokens</p>
975
+
976
+
977
+ </div>
978
+ </div>
979
+ <div class="tags">
980
+ <p class="tag_title">Parameters:</p>
981
+ <ul class="param">
982
+
983
+ <li>
984
+
985
+ <span class='name'>which</span>
986
+
987
+
988
+ <span class='type'>(<tt>Symbol</tt>)</span>
989
+
990
+
991
+ <em class="default">(defaults to: <tt>:access</tt>)</em>
992
+
993
+
994
+ &mdash;
995
+ <div class='inline'>
996
+ <p>The token to revoke, either :access or :refresh</p>
997
+ </div>
998
+
999
+ </li>
1000
+
1001
+ </ul>
1002
+
1003
+
1004
+ </div><table class="source_code">
1005
+ <tr>
1006
+ <td>
1007
+ <pre class="lines">
1008
+
1009
+
1010
+ 92
1011
+ 93
1012
+ 94
1013
+ 95
1014
+ 96
1015
+ 97
1016
+ 98
1017
+ 99
1018
+ 100
1019
+ 101
1020
+ 102</pre>
1021
+ </td>
1022
+ <td>
1023
+ <pre class="code"><span class="info file"># File 'lib/echosign/credentials.rb', line 92</span>
1024
+
1025
+ <span class='kw'>def</span> <span class='id identifier rubyid_revoke_token'>revoke_token</span><span class='lparen'>(</span><span class='id identifier rubyid_which'>which</span> <span class='op'>=</span> <span class='symbol'>:access</span><span class='rparen'>)</span>
1026
+ <span class='kw'>if</span> <span class='id identifier rubyid_which'>which</span> <span class='op'>==</span> <span class='symbol'>:access</span>
1027
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#REVOKE_PATH-constant" title="Echosign::Credentials::REVOKE_PATH (constant)">REVOKE_PATH</a></span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='lbrace'>{</span> <span class='label'>token:</span> <span class='ivar'>@access_token</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
1028
+ <span class='kw'>else</span>
1029
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#REVOKE_PATH-constant" title="Echosign::Credentials::REVOKE_PATH (constant)">REVOKE_PATH</a></span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='lbrace'>{</span> <span class='label'>token:</span> <span class='ivar'>@refresh_token</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
1030
+ <span class='ivar'>@refresh_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
1031
+ <span class='kw'>end</span>
1032
+
1033
+ <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
1034
+ <span class='ivar'>@expires_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1035
+ <span class='kw'>end</span></pre>
1036
+ </td>
1037
+ </tr>
1038
+ </table>
1039
+ </div>
1040
+
1041
+ </div>
1042
+
1043
+ </div>
1044
+
1045
+ <div id="footer">
1046
+ Generated on Thu Oct 18 12:44:49 2018 by
1047
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1048
+ 0.9.16 (ruby-2.6.0).
1049
+ </div>
1050
+
1051
+ </div>
1052
+ </body>
1053
+ </html>