seven_api 0.5.0 → 0.6.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.
- checksums.yaml +4 -4
- data/.idea/ruby-client.iml +16 -4
- data/README.md +2 -2
- data/doc/{Sms77 → SevenApi}/Client.html +222 -222
- data/doc/{Sms77 → SevenApi}/Contacts/Action.html +130 -130
- data/doc/{Sms77 → SevenApi}/Contacts.html +125 -125
- data/doc/{Sms77 → SevenApi}/Endpoint.html +186 -186
- data/doc/{Sms77 → SevenApi}/Hooks/Action.html +130 -130
- data/doc/{Sms77 → SevenApi}/Hooks/EventType.html +145 -145
- data/doc/{Sms77 → SevenApi}/Hooks/RequestMethod.html +130 -130
- data/doc/{Sms77 → SevenApi}/Hooks/Validator.html +582 -582
- data/doc/{Sms77 → SevenApi}/Hooks.html +125 -125
- data/doc/{Sms77 → SevenApi}/Journal/Type.html +135 -135
- data/doc/{Sms77 → SevenApi}/Journal/Validator.html +380 -380
- data/doc/{Sms77 → SevenApi}/Journal.html +125 -125
- data/doc/{Sms77 → SevenApi}/Lookup/Type.html +135 -135
- data/doc/{Sms77 → SevenApi}/Lookup.html +125 -125
- data/doc/{Sms77 → SevenApi}/Resource.html +857 -857
- data/doc/{Sms77 → SevenApi}/Resources/Analytics.html +260 -260
- data/doc/{Sms77 → SevenApi}/Resources/Balance.html +243 -243
- data/doc/{Sms77 → SevenApi}/Resources/Contacts.html +445 -445
- data/doc/{Sms77 → SevenApi}/Resources/Hooks.html +453 -453
- data/doc/{Sms77 → SevenApi}/Resources/Journal.html +258 -258
- data/doc/{Sms77 → SevenApi}/Resources/Lookup.html +535 -535
- data/doc/{Sms77 → SevenApi}/Resources/Pricing.html +260 -260
- data/doc/{Sms77 → SevenApi}/Resources/Sms.html +258 -258
- data/doc/{Sms77 → SevenApi}/Resources/Status.html +258 -258
- data/doc/{Sms77 → SevenApi}/Resources/Subaccounts.html +645 -645
- data/doc/{Sms77 → SevenApi}/Resources/ValidateForVoice.html +258 -258
- data/doc/{Sms77 → SevenApi}/Resources/Voice.html +258 -258
- data/doc/SevenApi/Resources.html +128 -0
- data/doc/{Sms77 → SevenApi}/Sms/Type.html +125 -125
- data/doc/{Sms77 → SevenApi}/Sms.html +125 -125
- data/doc/{Sms77 → SevenApi}/Subaccounts/Action.html +140 -140
- data/doc/SevenApi/Subaccounts/Validator.html +490 -0
- data/doc/{Sms77 → SevenApi}/Subaccounts.html +125 -125
- data/doc/{Sms77 → SevenApi}/Util.html +993 -993
- data/doc/{Sms77.html → SevenApi.html} +145 -145
- data/doc/_index.html +443 -443
- data/doc/class_list.html +51 -51
- data/doc/css/full_list.css +58 -58
- data/doc/css/style.css +497 -497
- data/doc/file.README.html +110 -111
- data/doc/file_list.html +56 -56
- data/doc/frames.html +17 -17
- data/doc/index.html +110 -111
- data/doc/js/app.js +314 -314
- data/doc/js/full_list.js +216 -216
- data/doc/js/jquery.js +3 -3
- data/doc/method_list.html +563 -563
- data/doc/top-level-namespace.html +109 -109
- data/lib/seven_api/client.rb +2 -0
- data/lib/seven_api/contacts.rb +0 -5
- data/lib/seven_api/endpoint.rb +5 -0
- data/lib/seven_api/hooks.rb +1 -0
- data/lib/seven_api/lookup.rb +1 -0
- data/lib/seven_api/numbers.rb +9 -0
- data/lib/seven_api/paginated.rb +10 -0
- data/lib/seven_api/rcs.rb +9 -0
- data/lib/seven_api/resource.rb +8 -3
- data/lib/seven_api/resources/analytics.rb +38 -5
- data/lib/seven_api/resources/balance.rb +2 -2
- data/lib/seven_api/resources/contacts.rb +36 -18
- data/lib/seven_api/resources/groups.rb +57 -0
- data/lib/seven_api/resources/hooks.rb +1 -1
- data/lib/seven_api/resources/journal.rb +1 -1
- data/lib/seven_api/resources/lookup.rb +36 -20
- data/lib/seven_api/resources/numbers.rb +70 -0
- data/lib/seven_api/resources/pricing.rb +1 -1
- data/lib/seven_api/resources/rcs.rb +39 -0
- data/lib/seven_api/resources/sms.rb +1 -1
- data/lib/seven_api/resources/status.rb +1 -1
- data/lib/seven_api/resources/subaccounts.rb +5 -5
- data/lib/seven_api/resources/validate_for_voice.rb +1 -1
- data/lib/seven_api/resources/voice.rb +1 -1
- data/lib/seven_api/version.rb +1 -1
- data/seven_api.gemspec +5 -5
- data/spec/seven_api/analytics_spec.rb +49 -0
- data/spec/seven_api/balance_spec.rb +8 -2
- data/spec/seven_api/contacts_spec.rb +52 -81
- data/spec/seven_api/groups_spec.rb +74 -0
- data/spec/seven_api/lookup_spec.rb +51 -33
- data/spec/seven_api/numbers_spec.rb +135 -0
- data/spec/seven_api/rcs_spec.rb +99 -0
- data/spec/seven_api/sms_spec.rb +2 -2
- data/spec/seven_api/voice_spec.rb +2 -2
- data/spec/spec_helper.rb +8 -17
- metadata +64 -50
- data/doc/Sms77/Resources.html +0 -128
- data/doc/Sms77/Subaccounts/Validator.html +0 -490
@@ -1,472 +1,472 @@
|
|
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:
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
16
|
-
|
17
|
-
<script type="text/javascript">
|
18
|
-
pathId = "
|
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 (R)</a> »
|
40
|
-
<span class='title'><span class='object_link'><a href="../
|
41
|
-
»
|
42
|
-
<span class="title">Resource</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:
|
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">
|
78
|
-
|
79
|
-
</ul>
|
80
|
-
<a href="#" class="inheritanceTree">show all</a>
|
81
|
-
|
82
|
-
</dd>
|
83
|
-
</dl>
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
<dl>
|
96
|
-
<dt>Defined in:</dt>
|
97
|
-
<dd>lib/
|
98
|
-
</dl>
|
99
|
-
|
100
|
-
</div>
|
101
|
-
|
102
|
-
<div id="subclasses">
|
103
|
-
<h2>Direct Known Subclasses</h2>
|
104
|
-
<p class="children"><span class='object_link'><a href="Resources/Analytics.html" title="
|
105
|
-
</div>
|
106
|
-
|
107
|
-
|
108
|
-
<h2>
|
109
|
-
Constant Summary
|
110
|
-
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
111
|
-
</h2>
|
112
|
-
|
113
|
-
<dl class="constants">
|
114
|
-
|
115
|
-
<dt id="BASE_PATH-constant" class="">BASE_PATH =
|
116
|
-
|
117
|
-
</dt>
|
118
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api/</span><span class='tstring_end'>'</span></span></pre></dd>
|
119
|
-
|
120
|
-
</dl>
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
127
|
-
<ul class="summary">
|
128
|
-
|
129
|
-
<li class="public ">
|
130
|
-
<span class="summary_signature">
|
131
|
-
|
132
|
-
<a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> ⇒ Object </a>
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
</span>
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
<span class="note title readonly">readonly</span>
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
<span class="summary_desc"><div class='inline'>
|
152
|
-
<p>Returns the value of attribute api_key.</p>
|
153
|
-
</div></span>
|
154
|
-
|
155
|
-
</li>
|
156
|
-
|
157
|
-
|
158
|
-
<li class="public ">
|
159
|
-
<span class="summary_signature">
|
160
|
-
|
161
|
-
<a href="#builder-instance_method" title="#builder (instance method)">#<strong>builder</strong> ⇒ Object </a>
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
</span>
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
<span class="note title readonly">readonly</span>
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
<span class="summary_desc"><div class='inline'>
|
181
|
-
<p>Returns the value of attribute builder.</p>
|
182
|
-
</div></span>
|
183
|
-
|
184
|
-
</li>
|
185
|
-
|
186
|
-
|
187
|
-
<li class="public ">
|
188
|
-
<span class="summary_signature">
|
189
|
-
|
190
|
-
<a href="#conn-instance_method" title="#conn (instance method)">#<strong>conn</strong> ⇒ Object </a>
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
</span>
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
<span class="note title readonly">readonly</span>
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
<span class="summary_desc"><div class='inline'>
|
210
|
-
<p>Returns the value of attribute conn.</p>
|
211
|
-
</div></span>
|
212
|
-
|
213
|
-
</li>
|
214
|
-
|
215
|
-
|
216
|
-
<li class="public ">
|
217
|
-
<span class="summary_signature">
|
218
|
-
|
219
|
-
<a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> ⇒ Object </a>
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
</span>
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
<span class="note title readonly">readonly</span>
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
<span class="summary_desc"><div class='inline'>
|
239
|
-
<p>Returns the value of attribute endpoint.</p>
|
240
|
-
</div></span>
|
241
|
-
|
242
|
-
</li>
|
243
|
-
|
244
|
-
|
245
|
-
<li class="public ">
|
246
|
-
<span class="summary_signature">
|
247
|
-
|
248
|
-
<a href="#http_methods-instance_method" title="#http_methods (instance method)">#<strong>http_methods</strong> ⇒ Object </a>
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
</span>
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
<span class="note title readonly">readonly</span>
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
<span class="summary_desc"><div class='inline'>
|
268
|
-
<p>Returns the value of attribute http_methods.</p>
|
269
|
-
</div></span>
|
270
|
-
|
271
|
-
</li>
|
272
|
-
|
273
|
-
|
274
|
-
<li class="public ">
|
275
|
-
<span class="summary_signature">
|
276
|
-
|
277
|
-
<a href="#request_methods-instance_method" title="#request_methods (instance method)">#<strong>request_methods</strong> ⇒ Object </a>
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
</span>
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
<span class="note title readonly">readonly</span>
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
<span class="summary_desc"><div class='inline'>
|
297
|
-
<p>Returns the value of attribute request_methods.</p>
|
298
|
-
</div></span>
|
299
|
-
|
300
|
-
</li>
|
301
|
-
|
302
|
-
|
303
|
-
<li class="public ">
|
304
|
-
<span class="summary_signature">
|
305
|
-
|
306
|
-
<a href="#sent_with-instance_method" title="#sent_with (instance method)">#<strong>sent_with</strong> ⇒ Object </a>
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
</span>
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
<span class="note title readonly">readonly</span>
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
<span class="summary_desc"><div class='inline'>
|
326
|
-
<p>Returns the value of attribute sent_with.</p>
|
327
|
-
</div></span>
|
328
|
-
|
329
|
-
</li>
|
330
|
-
|
331
|
-
|
332
|
-
</ul>
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
<h2>
|
339
|
-
Class Method Summary
|
340
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
341
|
-
</h2>
|
342
|
-
|
343
|
-
<ul class="summary">
|
344
|
-
|
345
|
-
<li class="public ">
|
346
|
-
<span class="summary_signature">
|
347
|
-
|
348
|
-
<a href="#get_endpoint-class_method" title="get_endpoint (class method)">.<strong>get_endpoint</strong> ⇒ Object </a>
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
</span>
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
363
|
-
|
364
|
-
</li>
|
365
|
-
|
366
|
-
|
367
|
-
<li class="public ">
|
368
|
-
<span class="summary_signature">
|
369
|
-
|
370
|
-
<a href="#get_http_methods-class_method" title="get_http_methods (class method)">.<strong>get_http_methods</strong> ⇒ Object </a>
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
</span>
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
385
|
-
|
386
|
-
</li>
|
387
|
-
|
388
|
-
|
389
|
-
</ul>
|
390
|
-
|
391
|
-
<h2>
|
392
|
-
Instance Method Summary
|
393
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
394
|
-
</h2>
|
395
|
-
|
396
|
-
<ul class="summary">
|
397
|
-
|
398
|
-
<li class="public ">
|
399
|
-
<span class="summary_signature">
|
400
|
-
|
401
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key, sent_with = 'ruby') ⇒ Resource </a>
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
</span>
|
406
|
-
|
407
|
-
|
408
|
-
<span class="note title constructor">constructor</span>
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
<span class="summary_desc"><div class='inline'>
|
418
|
-
<p>A new instance of Resource.</p>
|
419
|
-
</div></span>
|
420
|
-
|
421
|
-
</li>
|
422
|
-
|
423
|
-
|
424
|
-
</ul>
|
425
|
-
|
426
|
-
|
427
|
-
<div id="constructor_details" class="method_details_list">
|
428
|
-
<h2>Constructor Details</h2>
|
429
|
-
|
430
|
-
<div class="method_details first">
|
431
|
-
<h3 class="signature first" id="initialize-instance_method">
|
432
|
-
|
433
|
-
#<strong>initialize</strong>(api_key, sent_with = 'ruby') ⇒ <tt><span class='object_link'><a href="" title="
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
</h3><div class="docstring">
|
440
|
-
<div class="discussion">
|
441
|
-
|
442
|
-
<p>Returns a new instance of Resource.</p>
|
443
|
-
|
444
|
-
|
445
|
-
</div>
|
446
|
-
</div>
|
447
|
-
<div class="tags">
|
448
|
-
|
449
|
-
|
450
|
-
</div><table class="source_code">
|
451
|
-
<tr>
|
452
|
-
<td>
|
453
|
-
<pre class="lines">
|
454
|
-
|
455
|
-
|
456
|
-
15
|
457
|
-
16
|
458
|
-
17
|
459
|
-
18
|
460
|
-
19
|
461
|
-
20
|
462
|
-
21
|
463
|
-
22
|
464
|
-
23
|
465
|
-
24</pre>
|
466
|
-
</td>
|
467
|
-
<td>
|
468
|
-
<pre class="code"><span class="info file"># File 'lib/
|
469
|
-
|
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: SevenApi::Resource
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.34
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "SevenApi::Resource";
|
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 (R)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../SevenApi.html" title="SevenApi (module)">SevenApi</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Resource</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: SevenApi::Resource
|
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">SevenApi::Resource</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dt>Defined in:</dt>
|
97
|
+
<dd>lib/seven_api/resource.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<div id="subclasses">
|
103
|
+
<h2>Direct Known Subclasses</h2>
|
104
|
+
<p class="children"><span class='object_link'><a href="Resources/Analytics.html" title="SevenApi::Resources::Analytics (class)">SevenApi::Resources::Analytics</a></span>, <span class='object_link'><a href="Resources/Balance.html" title="SevenApi::Resources::Balance (class)">SevenApi::Resources::Balance</a></span>, <span class='object_link'><a href="Resources/Contacts.html" title="SevenApi::Resources::Contacts (class)">SevenApi::Resources::Contacts</a></span>, <span class='object_link'><a href="Resources/Hooks.html" title="SevenApi::Resources::Hooks (class)">SevenApi::Resources::Hooks</a></span>, <span class='object_link'><a href="Resources/Journal.html" title="SevenApi::Resources::Journal (class)">SevenApi::Resources::Journal</a></span>, <span class='object_link'><a href="Resources/Lookup.html" title="SevenApi::Resources::Lookup (class)">SevenApi::Resources::Lookup</a></span>, <span class='object_link'><a href="Resources/Pricing.html" title="SevenApi::Resources::Pricing (class)">SevenApi::Resources::Pricing</a></span>, <span class='object_link'><a href="Resources/Sms.html" title="SevenApi::Resources::Sms (class)">SevenApi::Resources::Sms</a></span>, <span class='object_link'><a href="Resources/Status.html" title="SevenApi::Resources::Status (class)">SevenApi::Resources::Status</a></span>, <span class='object_link'><a href="Resources/Subaccounts.html" title="SevenApi::Resources::Subaccounts (class)">SevenApi::Resources::Subaccounts</a></span>, <span class='object_link'><a href="Resources/ValidateForVoice.html" title="SevenApi::Resources::ValidateForVoice (class)">SevenApi::Resources::ValidateForVoice</a></span>, <span class='object_link'><a href="Resources/Voice.html" title="SevenApi::Resources::Voice (class)">SevenApi::Resources::Voice</a></span></p>
|
105
|
+
</div>
|
106
|
+
|
107
|
+
|
108
|
+
<h2>
|
109
|
+
Constant Summary
|
110
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
111
|
+
</h2>
|
112
|
+
|
113
|
+
<dl class="constants">
|
114
|
+
|
115
|
+
<dt id="BASE_PATH-constant" class="">BASE_PATH =
|
116
|
+
|
117
|
+
</dt>
|
118
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api/</span><span class='tstring_end'>'</span></span></pre></dd>
|
119
|
+
|
120
|
+
</dl>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
127
|
+
<ul class="summary">
|
128
|
+
|
129
|
+
<li class="public ">
|
130
|
+
<span class="summary_signature">
|
131
|
+
|
132
|
+
<a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> ⇒ Object </a>
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
</span>
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<span class="note title readonly">readonly</span>
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
<span class="summary_desc"><div class='inline'>
|
152
|
+
<p>Returns the value of attribute api_key.</p>
|
153
|
+
</div></span>
|
154
|
+
|
155
|
+
</li>
|
156
|
+
|
157
|
+
|
158
|
+
<li class="public ">
|
159
|
+
<span class="summary_signature">
|
160
|
+
|
161
|
+
<a href="#builder-instance_method" title="#builder (instance method)">#<strong>builder</strong> ⇒ Object </a>
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
</span>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
<span class="note title readonly">readonly</span>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<span class="summary_desc"><div class='inline'>
|
181
|
+
<p>Returns the value of attribute builder.</p>
|
182
|
+
</div></span>
|
183
|
+
|
184
|
+
</li>
|
185
|
+
|
186
|
+
|
187
|
+
<li class="public ">
|
188
|
+
<span class="summary_signature">
|
189
|
+
|
190
|
+
<a href="#conn-instance_method" title="#conn (instance method)">#<strong>conn</strong> ⇒ Object </a>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
</span>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
<span class="note title readonly">readonly</span>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
<span class="summary_desc"><div class='inline'>
|
210
|
+
<p>Returns the value of attribute conn.</p>
|
211
|
+
</div></span>
|
212
|
+
|
213
|
+
</li>
|
214
|
+
|
215
|
+
|
216
|
+
<li class="public ">
|
217
|
+
<span class="summary_signature">
|
218
|
+
|
219
|
+
<a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> ⇒ Object </a>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
</span>
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<span class="note title readonly">readonly</span>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
<span class="summary_desc"><div class='inline'>
|
239
|
+
<p>Returns the value of attribute endpoint.</p>
|
240
|
+
</div></span>
|
241
|
+
|
242
|
+
</li>
|
243
|
+
|
244
|
+
|
245
|
+
<li class="public ">
|
246
|
+
<span class="summary_signature">
|
247
|
+
|
248
|
+
<a href="#http_methods-instance_method" title="#http_methods (instance method)">#<strong>http_methods</strong> ⇒ Object </a>
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
</span>
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
<span class="note title readonly">readonly</span>
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
<span class="summary_desc"><div class='inline'>
|
268
|
+
<p>Returns the value of attribute http_methods.</p>
|
269
|
+
</div></span>
|
270
|
+
|
271
|
+
</li>
|
272
|
+
|
273
|
+
|
274
|
+
<li class="public ">
|
275
|
+
<span class="summary_signature">
|
276
|
+
|
277
|
+
<a href="#request_methods-instance_method" title="#request_methods (instance method)">#<strong>request_methods</strong> ⇒ Object </a>
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
</span>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
<span class="note title readonly">readonly</span>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
297
|
+
<p>Returns the value of attribute request_methods.</p>
|
298
|
+
</div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
306
|
+
<a href="#sent_with-instance_method" title="#sent_with (instance method)">#<strong>sent_with</strong> ⇒ Object </a>
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</span>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
<span class="note title readonly">readonly</span>
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
<span class="summary_desc"><div class='inline'>
|
326
|
+
<p>Returns the value of attribute sent_with.</p>
|
327
|
+
</div></span>
|
328
|
+
|
329
|
+
</li>
|
330
|
+
|
331
|
+
|
332
|
+
</ul>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
<h2>
|
339
|
+
Class Method Summary
|
340
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
341
|
+
</h2>
|
342
|
+
|
343
|
+
<ul class="summary">
|
344
|
+
|
345
|
+
<li class="public ">
|
346
|
+
<span class="summary_signature">
|
347
|
+
|
348
|
+
<a href="#get_endpoint-class_method" title="get_endpoint (class method)">.<strong>get_endpoint</strong> ⇒ Object </a>
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
</span>
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
363
|
+
|
364
|
+
</li>
|
365
|
+
|
366
|
+
|
367
|
+
<li class="public ">
|
368
|
+
<span class="summary_signature">
|
369
|
+
|
370
|
+
<a href="#get_http_methods-class_method" title="get_http_methods (class method)">.<strong>get_http_methods</strong> ⇒ Object </a>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
</span>
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
385
|
+
|
386
|
+
</li>
|
387
|
+
|
388
|
+
|
389
|
+
</ul>
|
390
|
+
|
391
|
+
<h2>
|
392
|
+
Instance Method Summary
|
393
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
394
|
+
</h2>
|
395
|
+
|
396
|
+
<ul class="summary">
|
397
|
+
|
398
|
+
<li class="public ">
|
399
|
+
<span class="summary_signature">
|
400
|
+
|
401
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key, sent_with = 'ruby') ⇒ Resource </a>
|
402
|
+
|
403
|
+
|
404
|
+
|
405
|
+
</span>
|
406
|
+
|
407
|
+
|
408
|
+
<span class="note title constructor">constructor</span>
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
<span class="summary_desc"><div class='inline'>
|
418
|
+
<p>A new instance of Resource.</p>
|
419
|
+
</div></span>
|
420
|
+
|
421
|
+
</li>
|
422
|
+
|
423
|
+
|
424
|
+
</ul>
|
425
|
+
|
426
|
+
|
427
|
+
<div id="constructor_details" class="method_details_list">
|
428
|
+
<h2>Constructor Details</h2>
|
429
|
+
|
430
|
+
<div class="method_details first">
|
431
|
+
<h3 class="signature first" id="initialize-instance_method">
|
432
|
+
|
433
|
+
#<strong>initialize</strong>(api_key, sent_with = 'ruby') ⇒ <tt><span class='object_link'><a href="" title="SevenApi::Resource (class)">Resource</a></span></tt>
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
</h3><div class="docstring">
|
440
|
+
<div class="discussion">
|
441
|
+
|
442
|
+
<p>Returns a new instance of Resource.</p>
|
443
|
+
|
444
|
+
|
445
|
+
</div>
|
446
|
+
</div>
|
447
|
+
<div class="tags">
|
448
|
+
|
449
|
+
|
450
|
+
</div><table class="source_code">
|
451
|
+
<tr>
|
452
|
+
<td>
|
453
|
+
<pre class="lines">
|
454
|
+
|
455
|
+
|
456
|
+
15
|
457
|
+
16
|
458
|
+
17
|
459
|
+
18
|
460
|
+
19
|
461
|
+
20
|
462
|
+
21
|
463
|
+
22
|
464
|
+
23
|
465
|
+
24</pre>
|
466
|
+
</td>
|
467
|
+
<td>
|
468
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 15</span>
|
469
|
+
|
470
470
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_sent_with'>sent_with</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ruby</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
471
471
|
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>missing api_key in config</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
472
472
|
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>missing sent_with in config</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_sent_with'>sent_with</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
@@ -475,396 +475,396 @@
|
|
475
475
|
<span class='ivar'>@sent_with</span> <span class='op'>=</span> <span class='id identifier rubyid_sent_with'>sent_with</span>
|
476
476
|
<span class='ivar'>@endpoint</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get_endpoint'>get_endpoint</span>
|
477
477
|
<span class='ivar'>@http_methods</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get_http_methods'>get_http_methods</span>
|
478
|
-
<span class='ivar'>@conn</span> <span class='op'>=</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://gateway.
|
479
|
-
<span class='kw'>end</span></pre>
|
480
|
-
</td>
|
481
|
-
</tr>
|
482
|
-
</table>
|
483
|
-
</div>
|
484
|
-
|
485
|
-
</div>
|
486
|
-
|
487
|
-
<div id="instance_attr_details" class="attr_details">
|
488
|
-
<h2>Instance Attribute Details</h2>
|
489
|
-
|
490
|
-
|
491
|
-
<span id=""></span>
|
492
|
-
<div class="method_details first">
|
493
|
-
<h3 class="signature first" id="api_key-instance_method">
|
494
|
-
|
495
|
-
#<strong>api_key</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
</h3><div class="docstring">
|
502
|
-
<div class="discussion">
|
503
|
-
|
504
|
-
<p>Returns the value of attribute api_key.</p>
|
505
|
-
|
506
|
-
|
507
|
-
</div>
|
508
|
-
</div>
|
509
|
-
<div class="tags">
|
510
|
-
|
511
|
-
|
512
|
-
</div><table class="source_code">
|
513
|
-
<tr>
|
514
|
-
<td>
|
515
|
-
<pre class="lines">
|
516
|
-
|
517
|
-
|
518
|
-
11
|
519
|
-
12
|
520
|
-
13</pre>
|
521
|
-
</td>
|
522
|
-
<td>
|
523
|
-
<pre class="code"><span class="info file"># File 'lib/
|
524
|
-
|
525
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
526
|
-
<span class='ivar'>@api_key</span>
|
527
|
-
<span class='kw'>end</span></pre>
|
528
|
-
</td>
|
529
|
-
</tr>
|
530
|
-
</table>
|
531
|
-
</div>
|
532
|
-
|
533
|
-
|
534
|
-
<span id=""></span>
|
535
|
-
<div class="method_details ">
|
536
|
-
<h3 class="signature " id="builder-instance_method">
|
537
|
-
|
538
|
-
#<strong>builder</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
</h3><div class="docstring">
|
545
|
-
<div class="discussion">
|
546
|
-
|
547
|
-
<p>Returns the value of attribute builder.</p>
|
548
|
-
|
549
|
-
|
550
|
-
</div>
|
551
|
-
</div>
|
552
|
-
<div class="tags">
|
553
|
-
|
554
|
-
|
555
|
-
</div><table class="source_code">
|
556
|
-
<tr>
|
557
|
-
<td>
|
558
|
-
<pre class="lines">
|
559
|
-
|
560
|
-
|
561
|
-
11
|
562
|
-
12
|
563
|
-
13</pre>
|
564
|
-
</td>
|
565
|
-
<td>
|
566
|
-
<pre class="code"><span class="info file"># File 'lib/
|
567
|
-
|
568
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_builder'>builder</span>
|
569
|
-
<span class='ivar'>@builder</span>
|
570
|
-
<span class='kw'>end</span></pre>
|
571
|
-
</td>
|
572
|
-
</tr>
|
573
|
-
</table>
|
574
|
-
</div>
|
575
|
-
|
576
|
-
|
577
|
-
<span id=""></span>
|
578
|
-
<div class="method_details ">
|
579
|
-
<h3 class="signature " id="conn-instance_method">
|
580
|
-
|
581
|
-
#<strong>conn</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
</h3><div class="docstring">
|
588
|
-
<div class="discussion">
|
589
|
-
|
590
|
-
<p>Returns the value of attribute conn.</p>
|
591
|
-
|
592
|
-
|
593
|
-
</div>
|
594
|
-
</div>
|
595
|
-
<div class="tags">
|
596
|
-
|
597
|
-
|
598
|
-
</div><table class="source_code">
|
599
|
-
<tr>
|
600
|
-
<td>
|
601
|
-
<pre class="lines">
|
602
|
-
|
603
|
-
|
604
|
-
11
|
605
|
-
12
|
606
|
-
13</pre>
|
607
|
-
</td>
|
608
|
-
<td>
|
609
|
-
<pre class="code"><span class="info file"># File 'lib/
|
610
|
-
|
611
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_conn'>conn</span>
|
612
|
-
<span class='ivar'>@conn</span>
|
613
|
-
<span class='kw'>end</span></pre>
|
614
|
-
</td>
|
615
|
-
</tr>
|
616
|
-
</table>
|
617
|
-
</div>
|
618
|
-
|
619
|
-
|
620
|
-
<span id=""></span>
|
621
|
-
<div class="method_details ">
|
622
|
-
<h3 class="signature " id="endpoint-instance_method">
|
623
|
-
|
624
|
-
#<strong>endpoint</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
</h3><div class="docstring">
|
631
|
-
<div class="discussion">
|
632
|
-
|
633
|
-
<p>Returns the value of attribute endpoint.</p>
|
634
|
-
|
635
|
-
|
636
|
-
</div>
|
637
|
-
</div>
|
638
|
-
<div class="tags">
|
639
|
-
|
640
|
-
|
641
|
-
</div><table class="source_code">
|
642
|
-
<tr>
|
643
|
-
<td>
|
644
|
-
<pre class="lines">
|
645
|
-
|
646
|
-
|
647
|
-
11
|
648
|
-
12
|
649
|
-
13</pre>
|
650
|
-
</td>
|
651
|
-
<td>
|
652
|
-
<pre class="code"><span class="info file"># File 'lib/
|
653
|
-
|
654
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
|
655
|
-
<span class='ivar'>@endpoint</span>
|
656
|
-
<span class='kw'>end</span></pre>
|
657
|
-
</td>
|
658
|
-
</tr>
|
659
|
-
</table>
|
660
|
-
</div>
|
661
|
-
|
662
|
-
|
663
|
-
<span id=""></span>
|
664
|
-
<div class="method_details ">
|
665
|
-
<h3 class="signature " id="http_methods-instance_method">
|
666
|
-
|
667
|
-
#<strong>http_methods</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
</h3><div class="docstring">
|
674
|
-
<div class="discussion">
|
675
|
-
|
676
|
-
<p>Returns the value of attribute http_methods.</p>
|
677
|
-
|
678
|
-
|
679
|
-
</div>
|
680
|
-
</div>
|
681
|
-
<div class="tags">
|
682
|
-
|
683
|
-
|
684
|
-
</div><table class="source_code">
|
685
|
-
<tr>
|
686
|
-
<td>
|
687
|
-
<pre class="lines">
|
688
|
-
|
689
|
-
|
690
|
-
11
|
691
|
-
12
|
692
|
-
13</pre>
|
693
|
-
</td>
|
694
|
-
<td>
|
695
|
-
<pre class="code"><span class="info file"># File 'lib/
|
696
|
-
|
697
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_http_methods'>http_methods</span>
|
698
|
-
<span class='ivar'>@http_methods</span>
|
699
|
-
<span class='kw'>end</span></pre>
|
700
|
-
</td>
|
701
|
-
</tr>
|
702
|
-
</table>
|
703
|
-
</div>
|
704
|
-
|
705
|
-
|
706
|
-
<span id=""></span>
|
707
|
-
<div class="method_details ">
|
708
|
-
<h3 class="signature " id="request_methods-instance_method">
|
709
|
-
|
710
|
-
#<strong>request_methods</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
</h3><div class="docstring">
|
717
|
-
<div class="discussion">
|
718
|
-
|
719
|
-
<p>Returns the value of attribute request_methods.</p>
|
720
|
-
|
721
|
-
|
722
|
-
</div>
|
723
|
-
</div>
|
724
|
-
<div class="tags">
|
725
|
-
|
726
|
-
|
727
|
-
</div><table class="source_code">
|
728
|
-
<tr>
|
729
|
-
<td>
|
730
|
-
<pre class="lines">
|
731
|
-
|
732
|
-
|
733
|
-
11
|
734
|
-
12
|
735
|
-
13</pre>
|
736
|
-
</td>
|
737
|
-
<td>
|
738
|
-
<pre class="code"><span class="info file"># File 'lib/
|
739
|
-
|
740
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_request_methods'>request_methods</span>
|
741
|
-
<span class='ivar'>@request_methods</span>
|
742
|
-
<span class='kw'>end</span></pre>
|
743
|
-
</td>
|
744
|
-
</tr>
|
745
|
-
</table>
|
746
|
-
</div>
|
747
|
-
|
748
|
-
|
749
|
-
<span id=""></span>
|
750
|
-
<div class="method_details ">
|
751
|
-
<h3 class="signature " id="sent_with-instance_method">
|
752
|
-
|
753
|
-
#<strong>sent_with</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
</h3><div class="docstring">
|
760
|
-
<div class="discussion">
|
761
|
-
|
762
|
-
<p>Returns the value of attribute sent_with.</p>
|
763
|
-
|
764
|
-
|
765
|
-
</div>
|
766
|
-
</div>
|
767
|
-
<div class="tags">
|
768
|
-
|
769
|
-
|
770
|
-
</div><table class="source_code">
|
771
|
-
<tr>
|
772
|
-
<td>
|
773
|
-
<pre class="lines">
|
774
|
-
|
775
|
-
|
776
|
-
11
|
777
|
-
12
|
778
|
-
13</pre>
|
779
|
-
</td>
|
780
|
-
<td>
|
781
|
-
<pre class="code"><span class="info file"># File 'lib/
|
782
|
-
|
783
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_sent_with'>sent_with</span>
|
784
|
-
<span class='ivar'>@sent_with</span>
|
785
|
-
<span class='kw'>end</span></pre>
|
786
|
-
</td>
|
787
|
-
</tr>
|
788
|
-
</table>
|
789
|
-
</div>
|
790
|
-
|
791
|
-
</div>
|
792
|
-
|
793
|
-
|
794
|
-
<div id="class_method_details" class="method_details_list">
|
795
|
-
<h2>Class Method Details</h2>
|
796
|
-
|
797
|
-
|
798
|
-
<div class="method_details first">
|
799
|
-
<h3 class="signature first" id="get_endpoint-class_method">
|
800
|
-
|
801
|
-
.<strong>get_endpoint</strong> ⇒ <tt>Object</tt>
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
</h3><table class="source_code">
|
808
|
-
<tr>
|
809
|
-
<td>
|
810
|
-
<pre class="lines">
|
811
|
-
|
812
|
-
|
813
|
-
89
|
814
|
-
90
|
815
|
-
91</pre>
|
816
|
-
</td>
|
817
|
-
<td>
|
818
|
-
<pre class="code"><span class="info file"># File 'lib/
|
819
|
-
|
478
|
+
<span class='ivar'>@conn</span> <span class='op'>=</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://gateway.seven.io</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#BASE_PATH-constant" title="SevenApi::Resource::BASE_PATH (constant)">BASE_PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
479
|
+
<span class='kw'>end</span></pre>
|
480
|
+
</td>
|
481
|
+
</tr>
|
482
|
+
</table>
|
483
|
+
</div>
|
484
|
+
|
485
|
+
</div>
|
486
|
+
|
487
|
+
<div id="instance_attr_details" class="attr_details">
|
488
|
+
<h2>Instance Attribute Details</h2>
|
489
|
+
|
490
|
+
|
491
|
+
<span id=""></span>
|
492
|
+
<div class="method_details first">
|
493
|
+
<h3 class="signature first" id="api_key-instance_method">
|
494
|
+
|
495
|
+
#<strong>api_key</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
</h3><div class="docstring">
|
502
|
+
<div class="discussion">
|
503
|
+
|
504
|
+
<p>Returns the value of attribute api_key.</p>
|
505
|
+
|
506
|
+
|
507
|
+
</div>
|
508
|
+
</div>
|
509
|
+
<div class="tags">
|
510
|
+
|
511
|
+
|
512
|
+
</div><table class="source_code">
|
513
|
+
<tr>
|
514
|
+
<td>
|
515
|
+
<pre class="lines">
|
516
|
+
|
517
|
+
|
518
|
+
11
|
519
|
+
12
|
520
|
+
13</pre>
|
521
|
+
</td>
|
522
|
+
<td>
|
523
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
524
|
+
|
525
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
526
|
+
<span class='ivar'>@api_key</span>
|
527
|
+
<span class='kw'>end</span></pre>
|
528
|
+
</td>
|
529
|
+
</tr>
|
530
|
+
</table>
|
531
|
+
</div>
|
532
|
+
|
533
|
+
|
534
|
+
<span id=""></span>
|
535
|
+
<div class="method_details ">
|
536
|
+
<h3 class="signature " id="builder-instance_method">
|
537
|
+
|
538
|
+
#<strong>builder</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
</h3><div class="docstring">
|
545
|
+
<div class="discussion">
|
546
|
+
|
547
|
+
<p>Returns the value of attribute builder.</p>
|
548
|
+
|
549
|
+
|
550
|
+
</div>
|
551
|
+
</div>
|
552
|
+
<div class="tags">
|
553
|
+
|
554
|
+
|
555
|
+
</div><table class="source_code">
|
556
|
+
<tr>
|
557
|
+
<td>
|
558
|
+
<pre class="lines">
|
559
|
+
|
560
|
+
|
561
|
+
11
|
562
|
+
12
|
563
|
+
13</pre>
|
564
|
+
</td>
|
565
|
+
<td>
|
566
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
567
|
+
|
568
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_builder'>builder</span>
|
569
|
+
<span class='ivar'>@builder</span>
|
570
|
+
<span class='kw'>end</span></pre>
|
571
|
+
</td>
|
572
|
+
</tr>
|
573
|
+
</table>
|
574
|
+
</div>
|
575
|
+
|
576
|
+
|
577
|
+
<span id=""></span>
|
578
|
+
<div class="method_details ">
|
579
|
+
<h3 class="signature " id="conn-instance_method">
|
580
|
+
|
581
|
+
#<strong>conn</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
</h3><div class="docstring">
|
588
|
+
<div class="discussion">
|
589
|
+
|
590
|
+
<p>Returns the value of attribute conn.</p>
|
591
|
+
|
592
|
+
|
593
|
+
</div>
|
594
|
+
</div>
|
595
|
+
<div class="tags">
|
596
|
+
|
597
|
+
|
598
|
+
</div><table class="source_code">
|
599
|
+
<tr>
|
600
|
+
<td>
|
601
|
+
<pre class="lines">
|
602
|
+
|
603
|
+
|
604
|
+
11
|
605
|
+
12
|
606
|
+
13</pre>
|
607
|
+
</td>
|
608
|
+
<td>
|
609
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
610
|
+
|
611
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_conn'>conn</span>
|
612
|
+
<span class='ivar'>@conn</span>
|
613
|
+
<span class='kw'>end</span></pre>
|
614
|
+
</td>
|
615
|
+
</tr>
|
616
|
+
</table>
|
617
|
+
</div>
|
618
|
+
|
619
|
+
|
620
|
+
<span id=""></span>
|
621
|
+
<div class="method_details ">
|
622
|
+
<h3 class="signature " id="endpoint-instance_method">
|
623
|
+
|
624
|
+
#<strong>endpoint</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
</h3><div class="docstring">
|
631
|
+
<div class="discussion">
|
632
|
+
|
633
|
+
<p>Returns the value of attribute endpoint.</p>
|
634
|
+
|
635
|
+
|
636
|
+
</div>
|
637
|
+
</div>
|
638
|
+
<div class="tags">
|
639
|
+
|
640
|
+
|
641
|
+
</div><table class="source_code">
|
642
|
+
<tr>
|
643
|
+
<td>
|
644
|
+
<pre class="lines">
|
645
|
+
|
646
|
+
|
647
|
+
11
|
648
|
+
12
|
649
|
+
13</pre>
|
650
|
+
</td>
|
651
|
+
<td>
|
652
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
653
|
+
|
654
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
|
655
|
+
<span class='ivar'>@endpoint</span>
|
656
|
+
<span class='kw'>end</span></pre>
|
657
|
+
</td>
|
658
|
+
</tr>
|
659
|
+
</table>
|
660
|
+
</div>
|
661
|
+
|
662
|
+
|
663
|
+
<span id=""></span>
|
664
|
+
<div class="method_details ">
|
665
|
+
<h3 class="signature " id="http_methods-instance_method">
|
666
|
+
|
667
|
+
#<strong>http_methods</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
|
673
|
+
</h3><div class="docstring">
|
674
|
+
<div class="discussion">
|
675
|
+
|
676
|
+
<p>Returns the value of attribute http_methods.</p>
|
677
|
+
|
678
|
+
|
679
|
+
</div>
|
680
|
+
</div>
|
681
|
+
<div class="tags">
|
682
|
+
|
683
|
+
|
684
|
+
</div><table class="source_code">
|
685
|
+
<tr>
|
686
|
+
<td>
|
687
|
+
<pre class="lines">
|
688
|
+
|
689
|
+
|
690
|
+
11
|
691
|
+
12
|
692
|
+
13</pre>
|
693
|
+
</td>
|
694
|
+
<td>
|
695
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
696
|
+
|
697
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_http_methods'>http_methods</span>
|
698
|
+
<span class='ivar'>@http_methods</span>
|
699
|
+
<span class='kw'>end</span></pre>
|
700
|
+
</td>
|
701
|
+
</tr>
|
702
|
+
</table>
|
703
|
+
</div>
|
704
|
+
|
705
|
+
|
706
|
+
<span id=""></span>
|
707
|
+
<div class="method_details ">
|
708
|
+
<h3 class="signature " id="request_methods-instance_method">
|
709
|
+
|
710
|
+
#<strong>request_methods</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
711
|
+
|
712
|
+
|
713
|
+
|
714
|
+
|
715
|
+
|
716
|
+
</h3><div class="docstring">
|
717
|
+
<div class="discussion">
|
718
|
+
|
719
|
+
<p>Returns the value of attribute request_methods.</p>
|
720
|
+
|
721
|
+
|
722
|
+
</div>
|
723
|
+
</div>
|
724
|
+
<div class="tags">
|
725
|
+
|
726
|
+
|
727
|
+
</div><table class="source_code">
|
728
|
+
<tr>
|
729
|
+
<td>
|
730
|
+
<pre class="lines">
|
731
|
+
|
732
|
+
|
733
|
+
11
|
734
|
+
12
|
735
|
+
13</pre>
|
736
|
+
</td>
|
737
|
+
<td>
|
738
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
739
|
+
|
740
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_methods'>request_methods</span>
|
741
|
+
<span class='ivar'>@request_methods</span>
|
742
|
+
<span class='kw'>end</span></pre>
|
743
|
+
</td>
|
744
|
+
</tr>
|
745
|
+
</table>
|
746
|
+
</div>
|
747
|
+
|
748
|
+
|
749
|
+
<span id=""></span>
|
750
|
+
<div class="method_details ">
|
751
|
+
<h3 class="signature " id="sent_with-instance_method">
|
752
|
+
|
753
|
+
#<strong>sent_with</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
</h3><div class="docstring">
|
760
|
+
<div class="discussion">
|
761
|
+
|
762
|
+
<p>Returns the value of attribute sent_with.</p>
|
763
|
+
|
764
|
+
|
765
|
+
</div>
|
766
|
+
</div>
|
767
|
+
<div class="tags">
|
768
|
+
|
769
|
+
|
770
|
+
</div><table class="source_code">
|
771
|
+
<tr>
|
772
|
+
<td>
|
773
|
+
<pre class="lines">
|
774
|
+
|
775
|
+
|
776
|
+
11
|
777
|
+
12
|
778
|
+
13</pre>
|
779
|
+
</td>
|
780
|
+
<td>
|
781
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 11</span>
|
782
|
+
|
783
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sent_with'>sent_with</span>
|
784
|
+
<span class='ivar'>@sent_with</span>
|
785
|
+
<span class='kw'>end</span></pre>
|
786
|
+
</td>
|
787
|
+
</tr>
|
788
|
+
</table>
|
789
|
+
</div>
|
790
|
+
|
791
|
+
</div>
|
792
|
+
|
793
|
+
|
794
|
+
<div id="class_method_details" class="method_details_list">
|
795
|
+
<h2>Class Method Details</h2>
|
796
|
+
|
797
|
+
|
798
|
+
<div class="method_details first">
|
799
|
+
<h3 class="signature first" id="get_endpoint-class_method">
|
800
|
+
|
801
|
+
.<strong>get_endpoint</strong> ⇒ <tt>Object</tt>
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
</h3><table class="source_code">
|
808
|
+
<tr>
|
809
|
+
<td>
|
810
|
+
<pre class="lines">
|
811
|
+
|
812
|
+
|
813
|
+
89
|
814
|
+
90
|
815
|
+
91</pre>
|
816
|
+
</td>
|
817
|
+
<td>
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 89</span>
|
819
|
+
|
820
820
|
<span class='kw'>def</span> <span class='id identifier rubyid_get_endpoint'>get_endpoint</span>
|
821
821
|
<span class='ivar'>@endpoint</span>
|
822
|
-
<span class='kw'>end</span></pre>
|
823
|
-
</td>
|
824
|
-
</tr>
|
825
|
-
</table>
|
826
|
-
</div>
|
827
|
-
|
828
|
-
<div class="method_details ">
|
829
|
-
<h3 class="signature " id="get_http_methods-class_method">
|
830
|
-
|
831
|
-
.<strong>get_http_methods</strong> ⇒ <tt>Object</tt>
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
</h3><table class="source_code">
|
838
|
-
<tr>
|
839
|
-
<td>
|
840
|
-
<pre class="lines">
|
841
|
-
|
842
|
-
|
843
|
-
85
|
844
|
-
86
|
845
|
-
87</pre>
|
846
|
-
</td>
|
847
|
-
<td>
|
848
|
-
<pre class="code"><span class="info file"># File 'lib/
|
849
|
-
|
822
|
+
<span class='kw'>end</span></pre>
|
823
|
+
</td>
|
824
|
+
</tr>
|
825
|
+
</table>
|
826
|
+
</div>
|
827
|
+
|
828
|
+
<div class="method_details ">
|
829
|
+
<h3 class="signature " id="get_http_methods-class_method">
|
830
|
+
|
831
|
+
.<strong>get_http_methods</strong> ⇒ <tt>Object</tt>
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
|
836
|
+
|
837
|
+
</h3><table class="source_code">
|
838
|
+
<tr>
|
839
|
+
<td>
|
840
|
+
<pre class="lines">
|
841
|
+
|
842
|
+
|
843
|
+
85
|
844
|
+
86
|
845
|
+
87</pre>
|
846
|
+
</td>
|
847
|
+
<td>
|
848
|
+
<pre class="code"><span class="info file"># File 'lib/seven_api/resource.rb', line 85</span>
|
849
|
+
|
850
850
|
<span class='kw'>def</span> <span class='id identifier rubyid_get_http_methods'>get_http_methods</span>
|
851
851
|
<span class='ivar'>@http_methods</span>
|
852
|
-
<span class='kw'>end</span></pre>
|
853
|
-
</td>
|
854
|
-
</tr>
|
855
|
-
</table>
|
856
|
-
</div>
|
857
|
-
|
858
|
-
</div>
|
859
|
-
|
860
|
-
</div>
|
861
|
-
|
862
|
-
<div id="footer">
|
863
|
-
Generated on
|
864
|
-
<a href="
|
865
|
-
0.9.
|
866
|
-
</div>
|
867
|
-
|
868
|
-
</div>
|
869
|
-
</body>
|
852
|
+
<span class='kw'>end</span></pre>
|
853
|
+
</td>
|
854
|
+
</tr>
|
855
|
+
</table>
|
856
|
+
</div>
|
857
|
+
|
858
|
+
</div>
|
859
|
+
|
860
|
+
</div>
|
861
|
+
|
862
|
+
<div id="footer">
|
863
|
+
Generated on Fri Aug 25 14:18:46 2023 by
|
864
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
865
|
+
0.9.34 (ruby-3.2.2).
|
866
|
+
</div>
|
867
|
+
|
868
|
+
</div>
|
869
|
+
</body>
|
870
870
|
</html>
|