aceroute 0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.rspec +2 -0
- data/.travis.yml +3 -0
- data/Gemfile +6 -0
- data/LICENSE +22 -0
- data/LICENSE.txt +21 -0
- data/README.md +63 -0
- data/Rakefile +3 -0
- data/aceroute.gemspec +34 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/doc/.yardoc/checksums +3 -0
- data/doc/.yardoc/object_types +0 -0
- data/doc/.yardoc/objects/root.dat +0 -0
- data/doc/.yardoc/proxy_types +0 -0
- data/doc/AceRoute_API.pdf +0 -0
- data/doc/Aceroute/Base.html +135 -0
- data/doc/Aceroute/Customer.html +949 -0
- data/doc/Aceroute/Location.html +1111 -0
- data/doc/Aceroute/Order.html +1458 -0
- data/doc/Aceroute.html +1401 -0
- data/doc/Hashit.html +212 -0
- data/doc/_index.html +183 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +156 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +156 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +345 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/aceroute/base.rb +20 -0
- data/lib/aceroute/core.rb +192 -0
- data/lib/aceroute/customer.rb +69 -0
- data/lib/aceroute/hashit.rb +12 -0
- data/lib/aceroute/location.rb +62 -0
- data/lib/aceroute/order.rb +81 -0
- data/lib/aceroute/version.rb +3 -0
- data/lib/aceroute.rb +5 -0
- metadata +146 -0
data/doc/Aceroute.html
ADDED
@@ -0,0 +1,1401 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Module: Aceroute
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '';
|
20
|
+
framesUrl = "frames.html#!Aceroute.html";
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="_index.html">Index (A)</a> »
|
35
|
+
|
36
|
+
|
37
|
+
<span class="title">Aceroute</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Module: Aceroute
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
<dt class="r1">Includes:</dt>
|
79
|
+
<dd class="r1">HTTParty</dd>
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
<dt class="r2 last">Defined in:</dt>
|
86
|
+
<dd class="r2 last">lib/aceroute.rb<span class="defines">,<br />
|
87
|
+
lib/aceroute/core.rb,<br /> lib/aceroute/base.rb,<br /> lib/aceroute/order.rb,<br /> lib/aceroute/version.rb,<br /> lib/aceroute/location.rb,<br /> lib/aceroute/customer.rb</span>
|
88
|
+
</dd>
|
89
|
+
|
90
|
+
</dl>
|
91
|
+
<div class="clear"></div>
|
92
|
+
|
93
|
+
<h2>Defined Under Namespace</h2>
|
94
|
+
<p class="children">
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Aceroute/Base.html" title="Aceroute::Base (class)">Base</a></span>, <span class='object_link'><a href="Aceroute/Customer.html" title="Aceroute::Customer (class)">Customer</a></span>, <span class='object_link'><a href="Aceroute/Location.html" title="Aceroute::Location (class)">Location</a></span>, <span class='object_link'><a href="Aceroute/Order.html" title="Aceroute::Order (class)">Order</a></span>
|
100
|
+
|
101
|
+
|
102
|
+
</p>
|
103
|
+
|
104
|
+
<h2>Constant Summary</h2>
|
105
|
+
|
106
|
+
<dl class="constants">
|
107
|
+
|
108
|
+
<dt id="VERSION-constant" class="">VERSION =
|
109
|
+
|
110
|
+
</dt>
|
111
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.2</span><span class='tstring_end'>"</span></span></pre></dd>
|
112
|
+
|
113
|
+
<dt id="DEBUG-classvariable" class="">@@DEBUG =
|
114
|
+
|
115
|
+
</dt>
|
116
|
+
<dd><pre class="code"><span class='kw'>true</span></pre></dd>
|
117
|
+
|
118
|
+
<dt id="API_KEY-classvariable" class="">@@API_KEY =
|
119
|
+
|
120
|
+
</dt>
|
121
|
+
<dd><pre class="code"><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ACEROUTE_API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span></pre></dd>
|
122
|
+
|
123
|
+
<dt id="query_params-classvariable" class="">@@query_params =
|
124
|
+
|
125
|
+
</dt>
|
126
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
127
|
+
<span class='label'>token:</span> <span class='cvar'>@@API_KEY</span><span class='comma'>,</span>
|
128
|
+
<span class='label'>updsince:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0</span><span class='tstring_end'>'</span></span>
|
129
|
+
<span class='rbrace'>}</span></pre></dd>
|
130
|
+
|
131
|
+
</dl>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
138
|
+
<ul class="summary">
|
139
|
+
|
140
|
+
<li class="public ">
|
141
|
+
<span class="summary_signature">
|
142
|
+
|
143
|
+
<a href="#http_result-instance_method" title="#http_result (instance method)">- (Object) <strong>http_result</strong> </a>
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
</span>
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
<span class="summary_desc"><div class='inline'>
|
161
|
+
<p>Returns the value of attribute http_result.</p>
|
162
|
+
</div></span>
|
163
|
+
|
164
|
+
</li>
|
165
|
+
|
166
|
+
|
167
|
+
</ul>
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
<h2>
|
174
|
+
Class Method Summary
|
175
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
176
|
+
</h2>
|
177
|
+
|
178
|
+
<ul class="summary">
|
179
|
+
|
180
|
+
<li class="public ">
|
181
|
+
<span class="summary_signature">
|
182
|
+
|
183
|
+
<a href="#create_customer-class_method" title="create_customer (class method)">+ (Hash) <strong>create_customer</strong>(customer) </a>
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
</span>
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
<span class="summary_desc"><div class='inline'>
|
198
|
+
<p>Create a new customer.</p>
|
199
|
+
</div></span>
|
200
|
+
|
201
|
+
</li>
|
202
|
+
|
203
|
+
|
204
|
+
<li class="public ">
|
205
|
+
<span class="summary_signature">
|
206
|
+
|
207
|
+
<a href="#create_location-class_method" title="create_location (class method)">+ (Object) <strong>create_location</strong>(location) </a>
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
</span>
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<span class="summary_desc"><div class='inline'>
|
222
|
+
<p>Create a new location.</p>
|
223
|
+
</div></span>
|
224
|
+
|
225
|
+
</li>
|
226
|
+
|
227
|
+
|
228
|
+
<li class="public ">
|
229
|
+
<span class="summary_signature">
|
230
|
+
|
231
|
+
<a href="#create_order-class_method" title="create_order (class method)">+ (Object) <strong>create_order</strong>(order) </a>
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
</span>
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
<span class="summary_desc"><div class='inline'>
|
246
|
+
<p>Create new order.</p>
|
247
|
+
</div></span>
|
248
|
+
|
249
|
+
</li>
|
250
|
+
|
251
|
+
|
252
|
+
<li class="public ">
|
253
|
+
<span class="summary_signature">
|
254
|
+
|
255
|
+
<a href="#delete_customer-class_method" title="delete_customer (class method)">+ (Object) <strong>delete_customer</strong>(customer_id) </a>
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
</span>
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
<span class="summary_desc"><div class='inline'>
|
270
|
+
<p>Delete a customer.</p>
|
271
|
+
</div></span>
|
272
|
+
|
273
|
+
</li>
|
274
|
+
|
275
|
+
|
276
|
+
<li class="public ">
|
277
|
+
<span class="summary_signature">
|
278
|
+
|
279
|
+
<a href="#delete_location-class_method" title="delete_location (class method)">+ (Object) <strong>delete_location</strong>(location_id) </a>
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
</span>
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
<span class="summary_desc"><div class='inline'>
|
294
|
+
<p>Delete a location.</p>
|
295
|
+
</div></span>
|
296
|
+
|
297
|
+
</li>
|
298
|
+
|
299
|
+
|
300
|
+
<li class="public ">
|
301
|
+
<span class="summary_signature">
|
302
|
+
|
303
|
+
<a href="#delete_order-class_method" title="delete_order (class method)">+ (Object) <strong>delete_order</strong>(order_id) </a>
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
</span>
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
<span class="summary_desc"><div class='inline'>
|
318
|
+
<p>Delete an order.</p>
|
319
|
+
</div></span>
|
320
|
+
|
321
|
+
</li>
|
322
|
+
|
323
|
+
|
324
|
+
<li class="public ">
|
325
|
+
<span class="summary_signature">
|
326
|
+
|
327
|
+
<a href="#list_customers-class_method" title="list_customers (class method)">+ (Hash) <strong>list_customers</strong> </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>List all customers.</p>
|
343
|
+
</div></span>
|
344
|
+
|
345
|
+
</li>
|
346
|
+
|
347
|
+
|
348
|
+
<li class="public ">
|
349
|
+
<span class="summary_signature">
|
350
|
+
|
351
|
+
<a href="#list_order_types-class_method" title="list_order_types (class method)">+ (Object) <strong>list_order_types</strong> </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>List order types.</p>
|
367
|
+
</div></span>
|
368
|
+
|
369
|
+
</li>
|
370
|
+
|
371
|
+
|
372
|
+
<li class="public ">
|
373
|
+
<span class="summary_signature">
|
374
|
+
|
375
|
+
<a href="#list_orders-class_method" title="list_orders (class method)">+ (Object) <strong>list_orders</strong> </a>
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
</span>
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
<span class="summary_desc"><div class='inline'>
|
390
|
+
<p>List all orders.</p>
|
391
|
+
</div></span>
|
392
|
+
|
393
|
+
</li>
|
394
|
+
|
395
|
+
|
396
|
+
<li class="public ">
|
397
|
+
<span class="summary_signature">
|
398
|
+
|
399
|
+
<a href="#list_service_types-class_method" title="list_service_types (class method)">+ (Object) <strong>list_service_types</strong> </a>
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
</span>
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
<span class="summary_desc"><div class='inline'>
|
414
|
+
<p>List service types.</p>
|
415
|
+
</div></span>
|
416
|
+
|
417
|
+
</li>
|
418
|
+
|
419
|
+
|
420
|
+
<li class="public ">
|
421
|
+
<span class="summary_signature">
|
422
|
+
|
423
|
+
<a href="#list_workers-class_method" title="list_workers (class method)">+ (Object) <strong>list_workers</strong> </a>
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
</span>
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
<span class="summary_desc"><div class='inline'>
|
438
|
+
<p>List all workers.</p>
|
439
|
+
</div></span>
|
440
|
+
|
441
|
+
</li>
|
442
|
+
|
443
|
+
|
444
|
+
</ul>
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
<div id="instance_attr_details" class="attr_details">
|
450
|
+
<h2>Instance Attribute Details</h2>
|
451
|
+
|
452
|
+
|
453
|
+
<span id="http_result=-instance_method"></span>
|
454
|
+
<div class="method_details first">
|
455
|
+
<h3 class="signature first" id="http_result-instance_method">
|
456
|
+
|
457
|
+
- (<tt>Object</tt>) <strong>http_result</strong>
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
</h3><div class="docstring">
|
464
|
+
<div class="discussion">
|
465
|
+
|
466
|
+
<p>Returns the value of attribute http_result</p>
|
467
|
+
|
468
|
+
|
469
|
+
</div>
|
470
|
+
</div>
|
471
|
+
<div class="tags">
|
472
|
+
|
473
|
+
|
474
|
+
</div><table class="source_code">
|
475
|
+
<tr>
|
476
|
+
<td>
|
477
|
+
<pre class="lines">
|
478
|
+
|
479
|
+
|
480
|
+
13
|
481
|
+
14
|
482
|
+
15</pre>
|
483
|
+
</td>
|
484
|
+
<td>
|
485
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 13</span>
|
486
|
+
|
487
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_http_result'>http_result</span>
|
488
|
+
<span class='ivar'>@http_result</span>
|
489
|
+
<span class='kw'>end</span></pre>
|
490
|
+
</td>
|
491
|
+
</tr>
|
492
|
+
</table>
|
493
|
+
</div>
|
494
|
+
|
495
|
+
</div>
|
496
|
+
|
497
|
+
|
498
|
+
<div id="class_method_details" class="method_details_list">
|
499
|
+
<h2>Class Method Details</h2>
|
500
|
+
|
501
|
+
|
502
|
+
<div class="method_details first">
|
503
|
+
<h3 class="signature first" id="create_customer-class_method">
|
504
|
+
|
505
|
+
+ (<tt>Hash</tt>) <strong>create_customer</strong>(customer)
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
</h3><div class="docstring">
|
512
|
+
<div class="discussion">
|
513
|
+
|
514
|
+
<p>Create a new customer</p>
|
515
|
+
|
516
|
+
|
517
|
+
</div>
|
518
|
+
</div>
|
519
|
+
<div class="tags">
|
520
|
+
<p class="tag_title">Parameters:</p>
|
521
|
+
<ul class="param">
|
522
|
+
|
523
|
+
<li>
|
524
|
+
|
525
|
+
<span class='name'>customer</span>
|
526
|
+
|
527
|
+
|
528
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
—
|
533
|
+
<div class='inline'><ul><li>
|
534
|
+
<p>:name (String) the name of customer</p>
|
535
|
+
</li><li>
|
536
|
+
<p>:email (String) the email for this customer</p>
|
537
|
+
</li><li>
|
538
|
+
<p>:address [Hash]</p>
|
539
|
+
<ul><li>
|
540
|
+
<p>:description (String) the description of this address, eg 'home'</p>
|
541
|
+
</li><li>
|
542
|
+
<p>:address1 (String) line 1 of the address, eg '123 Fake Street'</p>
|
543
|
+
</li><li>
|
544
|
+
<p>:address2 (String) line 2 of the address, eg 'New York, NY 12345'</p>
|
545
|
+
</li><li>
|
546
|
+
<p>:name (String) address name</p>
|
547
|
+
</li><li>
|
548
|
+
<p>:phone (String) address phone number</p>
|
549
|
+
</li></ul>
|
550
|
+
</li></ul>
|
551
|
+
</div>
|
552
|
+
|
553
|
+
</li>
|
554
|
+
|
555
|
+
</ul>
|
556
|
+
|
557
|
+
<p class="tag_title">Returns:</p>
|
558
|
+
<ul class="return">
|
559
|
+
|
560
|
+
<li>
|
561
|
+
|
562
|
+
|
563
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
—
|
568
|
+
<div class='inline'>
|
569
|
+
<p>customer and address</p>
|
570
|
+
</div>
|
571
|
+
|
572
|
+
</li>
|
573
|
+
|
574
|
+
</ul>
|
575
|
+
|
576
|
+
</div><table class="source_code">
|
577
|
+
<tr>
|
578
|
+
<td>
|
579
|
+
<pre class="lines">
|
580
|
+
|
581
|
+
|
582
|
+
56
|
583
|
+
57
|
584
|
+
58
|
585
|
+
59
|
586
|
+
60
|
587
|
+
61
|
588
|
+
62
|
589
|
+
63
|
590
|
+
64
|
591
|
+
65
|
592
|
+
66
|
593
|
+
67
|
594
|
+
68
|
595
|
+
69
|
596
|
+
70
|
597
|
+
71
|
598
|
+
72
|
599
|
+
73</pre>
|
600
|
+
</td>
|
601
|
+
<td>
|
602
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 56</span>
|
603
|
+
|
604
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_customer'>create_customer</span><span class='lparen'>(</span><span class='id identifier rubyid_customer'>customer</span><span class='rparen'>)</span>
|
605
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data>
|
606
|
+
<cst>
|
607
|
+
<nm></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></nm>
|
608
|
+
<locnm></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></locnm>
|
609
|
+
<adr></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:address1</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></adr>
|
610
|
+
<adr2></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:address2</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></adr2>
|
611
|
+
<cntnm></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></cntnm>
|
612
|
+
<tel></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:phone</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></tel>
|
613
|
+
<eml></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer'>customer</span><span class='lbracket'>[</span><span class='symbol'>:email</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></eml>
|
614
|
+
</cst>
|
615
|
+
</data></span><span class='tstring_end'>"</span></span>
|
616
|
+
|
617
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>customer.create</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
|
618
|
+
<span class='id identifier rubyid_location'>location</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_locs'>locs</span><span class='period'>.</span><span class='id identifier rubyid_loc'>loc</span>
|
619
|
+
<span class='id identifier rubyid_customer'>customer</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_cnts'>cnts</span><span class='period'>.</span><span class='id identifier rubyid_cnt'>cnt</span>
|
620
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_customer'>customer</span><span class='comma'>,</span> <span class='id identifier rubyid_location'>location</span>
|
621
|
+
<span class='kw'>end</span></pre>
|
622
|
+
</td>
|
623
|
+
</tr>
|
624
|
+
</table>
|
625
|
+
</div>
|
626
|
+
|
627
|
+
<div class="method_details ">
|
628
|
+
<h3 class="signature " id="create_location-class_method">
|
629
|
+
|
630
|
+
+ (<tt>Object</tt>) <strong>create_location</strong>(location)
|
631
|
+
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
</h3><div class="docstring">
|
637
|
+
<div class="discussion">
|
638
|
+
|
639
|
+
<p>Create a new location</p>
|
640
|
+
|
641
|
+
|
642
|
+
</div>
|
643
|
+
</div>
|
644
|
+
<div class="tags">
|
645
|
+
<p class="tag_title">Parameters:</p>
|
646
|
+
<ul class="param">
|
647
|
+
|
648
|
+
<li>
|
649
|
+
|
650
|
+
<span class='name'>location</span>
|
651
|
+
|
652
|
+
|
653
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
—
|
658
|
+
<div class='inline'><ul><li>
|
659
|
+
<p>:id (Integer)</p>
|
660
|
+
</li><li>
|
661
|
+
<p>:description (String) the description of this address, eg 'home'</p>
|
662
|
+
</li><li>
|
663
|
+
<p>:address1 (String) line 1 of the address, eg '123 Fake Street'</p>
|
664
|
+
</li><li>
|
665
|
+
<p>:address2 (String) line 2 of the address, eg 'New York, NY 12345'</p>
|
666
|
+
</li><li>
|
667
|
+
<p>:customer</p>
|
668
|
+
<ul><li>
|
669
|
+
<p>:cid (Integer) cid from Aceroute Customer object</p>
|
670
|
+
</li></ul>
|
671
|
+
</li></ul>
|
672
|
+
</div>
|
673
|
+
|
674
|
+
</li>
|
675
|
+
|
676
|
+
</ul>
|
677
|
+
|
678
|
+
<p class="tag_title">Returns:</p>
|
679
|
+
<ul class="return">
|
680
|
+
|
681
|
+
<li>
|
682
|
+
|
683
|
+
|
684
|
+
<span class='type'></span>
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
<div class='inline'>
|
690
|
+
<p>Aceroute location object</p>
|
691
|
+
</div>
|
692
|
+
|
693
|
+
</li>
|
694
|
+
|
695
|
+
</ul>
|
696
|
+
|
697
|
+
</div><table class="source_code">
|
698
|
+
<tr>
|
699
|
+
<td>
|
700
|
+
<pre class="lines">
|
701
|
+
|
702
|
+
|
703
|
+
94
|
704
|
+
95
|
705
|
+
96
|
706
|
+
97
|
707
|
+
98
|
708
|
+
99
|
709
|
+
100
|
710
|
+
101
|
711
|
+
102
|
712
|
+
103</pre>
|
713
|
+
</td>
|
714
|
+
<td>
|
715
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 94</span>
|
716
|
+
|
717
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_location'>create_location</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
|
718
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data><loc><id></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></id>
|
719
|
+
<cid></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:customer</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:cid</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></cid>
|
720
|
+
<nm></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></nm>
|
721
|
+
<adr></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:address1</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></adr>
|
722
|
+
<adr2></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:address2</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></adr2>
|
723
|
+
</loc></data></span><span class='tstring_end'>"</span></span>
|
724
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>customer.location.save</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
|
725
|
+
<span class='id identifier rubyid_loc'>loc</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_loc'>loc</span>
|
726
|
+
<span class='kw'>end</span></pre>
|
727
|
+
</td>
|
728
|
+
</tr>
|
729
|
+
</table>
|
730
|
+
</div>
|
731
|
+
|
732
|
+
<div class="method_details ">
|
733
|
+
<h3 class="signature " id="create_order-class_method">
|
734
|
+
|
735
|
+
+ (<tt>Object</tt>) <strong>create_order</strong>(order)
|
736
|
+
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
</h3><div class="docstring">
|
742
|
+
<div class="discussion">
|
743
|
+
|
744
|
+
<p>Create new order</p>
|
745
|
+
|
746
|
+
|
747
|
+
</div>
|
748
|
+
</div>
|
749
|
+
<div class="tags">
|
750
|
+
<p class="tag_title">Parameters:</p>
|
751
|
+
<ul class="param">
|
752
|
+
|
753
|
+
<li>
|
754
|
+
|
755
|
+
<span class='name'>order</span>
|
756
|
+
|
757
|
+
|
758
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
759
|
+
|
760
|
+
|
761
|
+
|
762
|
+
—
|
763
|
+
<div class='inline'><ul><li>
|
764
|
+
<p>:cid (Integer) Aceroute customer id</p>
|
765
|
+
</li><li>
|
766
|
+
<p>:nm (String) 'name', descriptive field for this order</p>
|
767
|
+
</li><li>
|
768
|
+
<p>:dir (Integer) 'duration', in 5 minute increments</p>
|
769
|
+
</li><li>
|
770
|
+
<p>:sched (Integer) 1 = scheduled, 0 = unscheduled</p>
|
771
|
+
</li><li>
|
772
|
+
<p>:start_epoch (Integer) time in msec since epoch</p>
|
773
|
+
</li><li>
|
774
|
+
<p>:lid (Integer) optional – customer location id</p>
|
775
|
+
</li><li>
|
776
|
+
<p>:cntid (Integer) optional – customer contact id</p>
|
777
|
+
</li><li>
|
778
|
+
<p>:rid (Integer) optional – worker id, to assign this order to a specific
|
779
|
+
worker</p>
|
780
|
+
</li><li>
|
781
|
+
<p>:dtl (String) optional – order summary</p>
|
782
|
+
</li><li>
|
783
|
+
<p>po (String) optional – 'purchase order', descriptive field for use
|
784
|
+
as desired</p>
|
785
|
+
</li></ul>
|
786
|
+
</div>
|
787
|
+
|
788
|
+
</li>
|
789
|
+
|
790
|
+
</ul>
|
791
|
+
|
792
|
+
<p class="tag_title">Returns:</p>
|
793
|
+
<ul class="return">
|
794
|
+
|
795
|
+
<li>
|
796
|
+
|
797
|
+
|
798
|
+
<span class='type'></span>
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
<div class='inline'>
|
804
|
+
<p>Aceroute Order object</p>
|
805
|
+
</div>
|
806
|
+
|
807
|
+
</li>
|
808
|
+
|
809
|
+
</ul>
|
810
|
+
|
811
|
+
</div><table class="source_code">
|
812
|
+
<tr>
|
813
|
+
<td>
|
814
|
+
<pre class="lines">
|
815
|
+
|
816
|
+
|
817
|
+
155
|
818
|
+
156
|
819
|
+
157
|
820
|
+
158
|
821
|
+
159
|
822
|
+
160
|
823
|
+
161
|
824
|
+
162
|
825
|
+
163
|
826
|
+
164
|
827
|
+
165
|
828
|
+
166
|
829
|
+
167
|
830
|
+
168
|
831
|
+
169
|
832
|
+
170
|
833
|
+
171
|
834
|
+
172
|
835
|
+
173
|
836
|
+
174</pre>
|
837
|
+
</td>
|
838
|
+
<td>
|
839
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 155</span>
|
840
|
+
|
841
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_order'>create_order</span><span class='lparen'>(</span><span class='id identifier rubyid_order'>order</span><span class='rparen'>)</span>
|
842
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data>
|
843
|
+
<event>
|
844
|
+
<cid></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:cid</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></cid>
|
845
|
+
<nm></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:nm</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></nm>
|
846
|
+
<dur></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:dur</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></dur>
|
847
|
+
<schd></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:schd</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></schd>
|
848
|
+
<start_epoch></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:start_epoch</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></start_epoch>
|
849
|
+
<lid></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:lid</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></lid>
|
850
|
+
<cntid></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:cntid</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></cntid>
|
851
|
+
<rid></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:rid</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></rid>
|
852
|
+
<dtl></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:dtl</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></dtl>
|
853
|
+
<po></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:po</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'></po>
|
854
|
+
</event>
|
855
|
+
</data></span><span class='tstring_end'>"</span></span>
|
856
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_recs'>recs</span> <span class='kw'>if</span> <span class='cvar'>@@DEBUG</span>
|
857
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>order.create</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
|
858
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_data'>data</span> <span class='kw'>if</span> <span class='cvar'>@@DEBUG</span>
|
859
|
+
<span class='id identifier rubyid_order'>order</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_event'>event</span>
|
860
|
+
<span class='kw'>end</span></pre>
|
861
|
+
</td>
|
862
|
+
</tr>
|
863
|
+
</table>
|
864
|
+
</div>
|
865
|
+
|
866
|
+
<div class="method_details ">
|
867
|
+
<h3 class="signature " id="delete_customer-class_method">
|
868
|
+
|
869
|
+
+ (<tt>Object</tt>) <strong>delete_customer</strong>(customer_id)
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
</h3><div class="docstring">
|
876
|
+
<div class="discussion">
|
877
|
+
|
878
|
+
<p>Delete a customer</p>
|
879
|
+
|
880
|
+
|
881
|
+
</div>
|
882
|
+
</div>
|
883
|
+
<div class="tags">
|
884
|
+
<p class="tag_title">Parameters:</p>
|
885
|
+
<ul class="param">
|
886
|
+
|
887
|
+
<li>
|
888
|
+
|
889
|
+
<span class='name'>customer_id</span>
|
890
|
+
|
891
|
+
|
892
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
—
|
897
|
+
<div class='inline'>
|
898
|
+
<p>id of Aceroute Customer object</p>
|
899
|
+
</div>
|
900
|
+
|
901
|
+
</li>
|
902
|
+
|
903
|
+
</ul>
|
904
|
+
|
905
|
+
<p class="tag_title">Returns:</p>
|
906
|
+
<ul class="return">
|
907
|
+
|
908
|
+
<li>
|
909
|
+
|
910
|
+
|
911
|
+
<span class='type'></span>
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
|
916
|
+
<div class='inline'>
|
917
|
+
<p>success or failure hash</p>
|
918
|
+
</div>
|
919
|
+
|
920
|
+
</li>
|
921
|
+
|
922
|
+
</ul>
|
923
|
+
|
924
|
+
</div><table class="source_code">
|
925
|
+
<tr>
|
926
|
+
<td>
|
927
|
+
<pre class="lines">
|
928
|
+
|
929
|
+
|
930
|
+
79
|
931
|
+
80
|
932
|
+
81
|
933
|
+
82</pre>
|
934
|
+
</td>
|
935
|
+
<td>
|
936
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 79</span>
|
937
|
+
|
938
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_customer'>delete_customer</span><span class='lparen'>(</span><span class='id identifier rubyid_customer_id'>customer_id</span><span class='rparen'>)</span>
|
939
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data><del><id></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_customer_id'>customer_id</span><span class='embexpr_end'>}</span><span class='tstring_content'></id></del></data></span><span class='tstring_end'>"</span></span>
|
940
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>customer.delete</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
|
941
|
+
<span class='kw'>end</span></pre>
|
942
|
+
</td>
|
943
|
+
</tr>
|
944
|
+
</table>
|
945
|
+
</div>
|
946
|
+
|
947
|
+
<div class="method_details ">
|
948
|
+
<h3 class="signature " id="delete_location-class_method">
|
949
|
+
|
950
|
+
+ (<tt>Object</tt>) <strong>delete_location</strong>(location_id)
|
951
|
+
|
952
|
+
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
</h3><div class="docstring">
|
957
|
+
<div class="discussion">
|
958
|
+
|
959
|
+
<p>Delete a location</p>
|
960
|
+
|
961
|
+
|
962
|
+
</div>
|
963
|
+
</div>
|
964
|
+
<div class="tags">
|
965
|
+
<p class="tag_title">Parameters:</p>
|
966
|
+
<ul class="param">
|
967
|
+
|
968
|
+
<li>
|
969
|
+
|
970
|
+
<span class='name'>location_id</span>
|
971
|
+
|
972
|
+
|
973
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
—
|
978
|
+
<div class='inline'>
|
979
|
+
<p>id from Aceroute Location object</p>
|
980
|
+
</div>
|
981
|
+
|
982
|
+
</li>
|
983
|
+
|
984
|
+
</ul>
|
985
|
+
|
986
|
+
<p class="tag_title">Returns:</p>
|
987
|
+
<ul class="return">
|
988
|
+
|
989
|
+
<li>
|
990
|
+
|
991
|
+
|
992
|
+
<span class='type'></span>
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
<div class='inline'>
|
998
|
+
<p>nil</p>
|
999
|
+
</div>
|
1000
|
+
|
1001
|
+
</li>
|
1002
|
+
|
1003
|
+
</ul>
|
1004
|
+
|
1005
|
+
</div><table class="source_code">
|
1006
|
+
<tr>
|
1007
|
+
<td>
|
1008
|
+
<pre class="lines">
|
1009
|
+
|
1010
|
+
|
1011
|
+
109
|
1012
|
+
110
|
1013
|
+
111
|
1014
|
+
112</pre>
|
1015
|
+
</td>
|
1016
|
+
<td>
|
1017
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 109</span>
|
1018
|
+
|
1019
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_location'>delete_location</span><span class='lparen'>(</span><span class='id identifier rubyid_location_id'>location_id</span><span class='rparen'>)</span>
|
1020
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data><del><id></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_location_id'>location_id</span><span class='embexpr_end'>}</span><span class='tstring_content'></id></del></data></span><span class='tstring_end'>"</span></span>
|
1021
|
+
<span class='id identifier rubyid_types'>types</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>customer.location.delete</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_otype'>otype</span>
|
1022
|
+
<span class='kw'>end</span></pre>
|
1023
|
+
</td>
|
1024
|
+
</tr>
|
1025
|
+
</table>
|
1026
|
+
</div>
|
1027
|
+
|
1028
|
+
<div class="method_details ">
|
1029
|
+
<h3 class="signature " id="delete_order-class_method">
|
1030
|
+
|
1031
|
+
+ (<tt>Object</tt>) <strong>delete_order</strong>(order_id)
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
</h3><div class="docstring">
|
1038
|
+
<div class="discussion">
|
1039
|
+
|
1040
|
+
<p>Delete an order</p>
|
1041
|
+
|
1042
|
+
|
1043
|
+
</div>
|
1044
|
+
</div>
|
1045
|
+
<div class="tags">
|
1046
|
+
|
1047
|
+
|
1048
|
+
</div><table class="source_code">
|
1049
|
+
<tr>
|
1050
|
+
<td>
|
1051
|
+
<pre class="lines">
|
1052
|
+
|
1053
|
+
|
1054
|
+
177
|
1055
|
+
178
|
1056
|
+
179
|
1057
|
+
180</pre>
|
1058
|
+
</td>
|
1059
|
+
<td>
|
1060
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 177</span>
|
1061
|
+
|
1062
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_order'>delete_order</span><span class='lparen'>(</span><span class='id identifier rubyid_order_id'>order_id</span><span class='rparen'>)</span>
|
1063
|
+
<span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><data><del><id></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_order_id'>order_id</span><span class='embexpr_end'>}</span><span class='tstring_content'></id></del></data></span><span class='tstring_end'>"</span></span>
|
1064
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>order.delete</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
|
1065
|
+
<span class='kw'>end</span></pre>
|
1066
|
+
</td>
|
1067
|
+
</tr>
|
1068
|
+
</table>
|
1069
|
+
</div>
|
1070
|
+
|
1071
|
+
<div class="method_details ">
|
1072
|
+
<h3 class="signature " id="list_customers-class_method">
|
1073
|
+
|
1074
|
+
+ (<tt>Hash</tt>) <strong>list_customers</strong>
|
1075
|
+
|
1076
|
+
|
1077
|
+
|
1078
|
+
|
1079
|
+
|
1080
|
+
</h3><div class="docstring">
|
1081
|
+
<div class="discussion">
|
1082
|
+
|
1083
|
+
<p>List all customers</p>
|
1084
|
+
|
1085
|
+
|
1086
|
+
</div>
|
1087
|
+
</div>
|
1088
|
+
<div class="tags">
|
1089
|
+
|
1090
|
+
<p class="tag_title">Returns:</p>
|
1091
|
+
<ul class="return">
|
1092
|
+
|
1093
|
+
<li>
|
1094
|
+
|
1095
|
+
|
1096
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1097
|
+
|
1098
|
+
|
1099
|
+
|
1100
|
+
—
|
1101
|
+
<div class='inline'>
|
1102
|
+
<p>list of customer objects</p>
|
1103
|
+
</div>
|
1104
|
+
|
1105
|
+
</li>
|
1106
|
+
|
1107
|
+
</ul>
|
1108
|
+
|
1109
|
+
</div><table class="source_code">
|
1110
|
+
<tr>
|
1111
|
+
<td>
|
1112
|
+
<pre class="lines">
|
1113
|
+
|
1114
|
+
|
1115
|
+
28
|
1116
|
+
29
|
1117
|
+
30
|
1118
|
+
31
|
1119
|
+
32
|
1120
|
+
33
|
1121
|
+
34
|
1122
|
+
35
|
1123
|
+
36
|
1124
|
+
37
|
1125
|
+
38
|
1126
|
+
39
|
1127
|
+
40
|
1128
|
+
41
|
1129
|
+
42</pre>
|
1130
|
+
</td>
|
1131
|
+
<td>
|
1132
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 28</span>
|
1133
|
+
|
1134
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_customers'>list_customers</span>
|
1135
|
+
<span class='id identifier rubyid_customers'>customers</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
1136
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>customer.list</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1137
|
+
<span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_cnts'>cnts</span><span class='period'>.</span><span class='id identifier rubyid_cnt'>cnt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
|
1138
|
+
<span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='const'>Customer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>nm</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>email:</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>eml</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>cid:</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cid</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
1139
|
+
<span class='id identifier rubyid_customers'>customers</span> <span class='op'><<</span> <span class='id identifier rubyid_c'>c</span>
|
1140
|
+
<span class='comment'>#find corresponding addresses for this customer
|
1141
|
+
</span> <span class='id identifier rubyid_locations'>locations</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_locs'>locs</span><span class='period'>.</span><span class='id identifier rubyid_loc'>loc</span><span class='period'>.</span><span class='id identifier rubyid_find_all'>find_all</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>cid</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span> <span class='rbrace'>}</span>
|
1142
|
+
<span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span>
|
1143
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span> <span class='op'><<</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='const'>Location</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>address1:</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>adr</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>address2:</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>adr2</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
1144
|
+
<span class='label'>phone:</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tel</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>nm</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
1145
|
+
<span class='kw'>end</span>
|
1146
|
+
<span class='kw'>end</span>
|
1147
|
+
<span class='id identifier rubyid_customers'>customers</span>
|
1148
|
+
<span class='kw'>end</span></pre>
|
1149
|
+
</td>
|
1150
|
+
</tr>
|
1151
|
+
</table>
|
1152
|
+
</div>
|
1153
|
+
|
1154
|
+
<div class="method_details ">
|
1155
|
+
<h3 class="signature " id="list_order_types-class_method">
|
1156
|
+
|
1157
|
+
+ (<tt>Object</tt>) <strong>list_order_types</strong>
|
1158
|
+
|
1159
|
+
|
1160
|
+
|
1161
|
+
|
1162
|
+
|
1163
|
+
</h3><div class="docstring">
|
1164
|
+
<div class="discussion">
|
1165
|
+
|
1166
|
+
<p>List order types</p>
|
1167
|
+
|
1168
|
+
|
1169
|
+
</div>
|
1170
|
+
</div>
|
1171
|
+
<div class="tags">
|
1172
|
+
|
1173
|
+
<p class="tag_title">Returns:</p>
|
1174
|
+
<ul class="return">
|
1175
|
+
|
1176
|
+
<li>
|
1177
|
+
|
1178
|
+
|
1179
|
+
<span class='type'></span>
|
1180
|
+
|
1181
|
+
|
1182
|
+
|
1183
|
+
|
1184
|
+
<div class='inline'>
|
1185
|
+
<p>list of available order types for this account</p>
|
1186
|
+
</div>
|
1187
|
+
|
1188
|
+
</li>
|
1189
|
+
|
1190
|
+
</ul>
|
1191
|
+
|
1192
|
+
</div><table class="source_code">
|
1193
|
+
<tr>
|
1194
|
+
<td>
|
1195
|
+
<pre class="lines">
|
1196
|
+
|
1197
|
+
|
1198
|
+
116
|
1199
|
+
117
|
1200
|
+
118</pre>
|
1201
|
+
</td>
|
1202
|
+
<td>
|
1203
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 116</span>
|
1204
|
+
|
1205
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_order_types'>list_order_types</span>
|
1206
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>order.type.list</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1207
|
+
<span class='kw'>end</span></pre>
|
1208
|
+
</td>
|
1209
|
+
</tr>
|
1210
|
+
</table>
|
1211
|
+
</div>
|
1212
|
+
|
1213
|
+
<div class="method_details ">
|
1214
|
+
<h3 class="signature " id="list_orders-class_method">
|
1215
|
+
|
1216
|
+
+ (<tt>Object</tt>) <strong>list_orders</strong>
|
1217
|
+
|
1218
|
+
|
1219
|
+
|
1220
|
+
|
1221
|
+
|
1222
|
+
</h3><div class="docstring">
|
1223
|
+
<div class="discussion">
|
1224
|
+
|
1225
|
+
<p>List all orders</p>
|
1226
|
+
|
1227
|
+
|
1228
|
+
</div>
|
1229
|
+
</div>
|
1230
|
+
<div class="tags">
|
1231
|
+
|
1232
|
+
<p class="tag_title">Returns:</p>
|
1233
|
+
<ul class="return">
|
1234
|
+
|
1235
|
+
<li>
|
1236
|
+
|
1237
|
+
|
1238
|
+
<span class='type'></span>
|
1239
|
+
|
1240
|
+
|
1241
|
+
|
1242
|
+
|
1243
|
+
<div class='inline'>
|
1244
|
+
<p>list of all orders in this account</p>
|
1245
|
+
</div>
|
1246
|
+
|
1247
|
+
</li>
|
1248
|
+
|
1249
|
+
</ul>
|
1250
|
+
|
1251
|
+
</div><table class="source_code">
|
1252
|
+
<tr>
|
1253
|
+
<td>
|
1254
|
+
<pre class="lines">
|
1255
|
+
|
1256
|
+
|
1257
|
+
135
|
1258
|
+
136
|
1259
|
+
137</pre>
|
1260
|
+
</td>
|
1261
|
+
<td>
|
1262
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 135</span>
|
1263
|
+
|
1264
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_orders'>list_orders</span>
|
1265
|
+
<span class='id identifier rubyid_workers'>workers</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>order.list</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_event'>event</span>
|
1266
|
+
<span class='kw'>end</span></pre>
|
1267
|
+
</td>
|
1268
|
+
</tr>
|
1269
|
+
</table>
|
1270
|
+
</div>
|
1271
|
+
|
1272
|
+
<div class="method_details ">
|
1273
|
+
<h3 class="signature " id="list_service_types-class_method">
|
1274
|
+
|
1275
|
+
+ (<tt>Object</tt>) <strong>list_service_types</strong>
|
1276
|
+
|
1277
|
+
|
1278
|
+
|
1279
|
+
|
1280
|
+
|
1281
|
+
</h3><div class="docstring">
|
1282
|
+
<div class="discussion">
|
1283
|
+
|
1284
|
+
<p>List service types</p>
|
1285
|
+
|
1286
|
+
|
1287
|
+
</div>
|
1288
|
+
</div>
|
1289
|
+
<div class="tags">
|
1290
|
+
|
1291
|
+
<p class="tag_title">Returns:</p>
|
1292
|
+
<ul class="return">
|
1293
|
+
|
1294
|
+
<li>
|
1295
|
+
|
1296
|
+
|
1297
|
+
<span class='type'></span>
|
1298
|
+
|
1299
|
+
|
1300
|
+
|
1301
|
+
|
1302
|
+
<div class='inline'>
|
1303
|
+
<p>list of available service types for this account</p>
|
1304
|
+
</div>
|
1305
|
+
|
1306
|
+
</li>
|
1307
|
+
|
1308
|
+
</ul>
|
1309
|
+
|
1310
|
+
</div><table class="source_code">
|
1311
|
+
<tr>
|
1312
|
+
<td>
|
1313
|
+
<pre class="lines">
|
1314
|
+
|
1315
|
+
|
1316
|
+
122
|
1317
|
+
123
|
1318
|
+
124</pre>
|
1319
|
+
</td>
|
1320
|
+
<td>
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 122</span>
|
1322
|
+
|
1323
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_service_types'>list_service_types</span>
|
1324
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>product.type.list</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1325
|
+
<span class='kw'>end</span></pre>
|
1326
|
+
</td>
|
1327
|
+
</tr>
|
1328
|
+
</table>
|
1329
|
+
</div>
|
1330
|
+
|
1331
|
+
<div class="method_details ">
|
1332
|
+
<h3 class="signature " id="list_workers-class_method">
|
1333
|
+
|
1334
|
+
+ (<tt>Object</tt>) <strong>list_workers</strong>
|
1335
|
+
|
1336
|
+
|
1337
|
+
|
1338
|
+
|
1339
|
+
|
1340
|
+
</h3><div class="docstring">
|
1341
|
+
<div class="discussion">
|
1342
|
+
|
1343
|
+
<p>List all workers</p>
|
1344
|
+
|
1345
|
+
|
1346
|
+
</div>
|
1347
|
+
</div>
|
1348
|
+
<div class="tags">
|
1349
|
+
|
1350
|
+
<p class="tag_title">Returns:</p>
|
1351
|
+
<ul class="return">
|
1352
|
+
|
1353
|
+
<li>
|
1354
|
+
|
1355
|
+
|
1356
|
+
<span class='type'></span>
|
1357
|
+
|
1358
|
+
|
1359
|
+
|
1360
|
+
|
1361
|
+
<div class='inline'>
|
1362
|
+
<p>list of available workers for this account</p>
|
1363
|
+
</div>
|
1364
|
+
|
1365
|
+
</li>
|
1366
|
+
|
1367
|
+
</ul>
|
1368
|
+
|
1369
|
+
</div><table class="source_code">
|
1370
|
+
<tr>
|
1371
|
+
<td>
|
1372
|
+
<pre class="lines">
|
1373
|
+
|
1374
|
+
|
1375
|
+
129
|
1376
|
+
130
|
1377
|
+
131</pre>
|
1378
|
+
</td>
|
1379
|
+
<td>
|
1380
|
+
<pre class="code"><span class="info file"># File 'lib/aceroute/core.rb', line 129</span>
|
1381
|
+
|
1382
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_workers'>list_workers</span>
|
1383
|
+
<span class='id identifier rubyid_workers'>workers</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>worker.list</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_res'>res</span>
|
1384
|
+
<span class='kw'>end</span></pre>
|
1385
|
+
</td>
|
1386
|
+
</tr>
|
1387
|
+
</table>
|
1388
|
+
</div>
|
1389
|
+
|
1390
|
+
</div>
|
1391
|
+
|
1392
|
+
</div>
|
1393
|
+
|
1394
|
+
<div id="footer">
|
1395
|
+
Generated on Sun Dec 4 11:17:52 2016 by
|
1396
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1397
|
+
0.8.7.6 (ruby-2.3.1).
|
1398
|
+
</div>
|
1399
|
+
|
1400
|
+
</body>
|
1401
|
+
</html>
|