aceroute 0.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,949 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Aceroute::Customer
8
+
9
+ &mdash; 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/Customer.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (C)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Aceroute.html" title="Aceroute (module)">Aceroute</a></span></span>
36
+ &raquo;
37
+ <span class="title">Customer</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Aceroute::Customer
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="Aceroute::Base (class)">Base</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="Base.html" title="Aceroute::Base (class)">Base</a></span></li>
82
+
83
+ <li class="next">Aceroute::Customer</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/aceroute/customer.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#cid-instance_method" title="#cid (instance method)">- (Object) <strong>cid</strong> </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Returns the value of attribute cid.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#email-instance_method" title="#email (instance method)">- (Object) <strong>email</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Returns the value of attribute email.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>Returns the value of attribute id.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#locations-instance_method" title="#locations (instance method)">- (Object) <strong>locations</strong> </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Returns the value of attribute locations.</p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>Returns the value of attribute name.</p>
241
+ </div></span>
242
+
243
+ </li>
244
+
245
+
246
+ </ul>
247
+
248
+
249
+
250
+
251
+
252
+ <h2>
253
+ Class Method Summary
254
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
255
+ </h2>
256
+
257
+ <ul class="summary">
258
+
259
+ <li class="public ">
260
+ <span class="summary_signature">
261
+
262
+ <a href="#delete-class_method" title="delete (class method)">+ (Object) <strong>delete</strong>(id) </a>
263
+
264
+
265
+
266
+ </span>
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>Deletes Aceroute::Customer of given id from Aceroute.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ </ul>
284
+
285
+ <h2>
286
+ Instance Method Summary
287
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
288
+ </h2>
289
+
290
+ <ul class="summary">
291
+
292
+ <li class="public ">
293
+ <span class="summary_signature">
294
+
295
+ <a href="#create%21-instance_method" title="#create! (instance method)">- (Aceroute::Customer) <strong>create!</strong> </a>
296
+
297
+
298
+
299
+ </span>
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+ <span class="summary_desc"><div class='inline'>
310
+ <p>Persists Customer object to Aceroute API.</p>
311
+ </div></span>
312
+
313
+ </li>
314
+
315
+
316
+ <li class="public ">
317
+ <span class="summary_signature">
318
+
319
+ <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Object) <strong>destroy!</strong>(id = nil) </a>
320
+
321
+
322
+
323
+ </span>
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+ <span class="summary_desc"><div class='inline'>
334
+ <p>Deletes this Aceroute::Customer object (self) from Aceroute;.</p>
335
+ </div></span>
336
+
337
+ </li>
338
+
339
+
340
+ <li class="public ">
341
+ <span class="summary_signature">
342
+
343
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Aceroute::Customer) <strong>initialize</strong>(name, email, location = {}, cid = nil) </a>
344
+
345
+
346
+
347
+ </span>
348
+
349
+
350
+ <span class="note title constructor">constructor</span>
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+ <span class="summary_desc"><div class='inline'>
360
+ <p>Creates a new Aceroute::Customer object.</p>
361
+ </div></span>
362
+
363
+ </li>
364
+
365
+
366
+ </ul>
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <div id="constructor_details" class="method_details_list">
376
+ <h2>Constructor Details</h2>
377
+
378
+ <div class="method_details first">
379
+ <h3 class="signature first" id="initialize-instance_method">
380
+
381
+ - (<tt><span class='object_link'><a href="" title="Aceroute::Customer (class)">Aceroute::Customer</a></span></tt>) <strong>initialize</strong>(name, email, location = {}, cid = nil)
382
+
383
+
384
+
385
+
386
+
387
+ </h3><div class="docstring">
388
+ <div class="discussion">
389
+
390
+ <p>Creates a new Aceroute::Customer object. Note this does not persist the
391
+ Customer to Aceroute, that can be done by calling the create! method on the
392
+ new object.</p>
393
+
394
+
395
+ </div>
396
+ </div>
397
+ <div class="tags">
398
+ <p class="tag_title">Parameters:</p>
399
+ <ul class="param">
400
+
401
+ <li>
402
+
403
+ <span class='name'>name</span>
404
+
405
+
406
+ <span class='type'>(<tt>String</tt>)</span>
407
+
408
+
409
+
410
+ &mdash;
411
+ <div class='inline'>
412
+ <p>customer name</p>
413
+ </div>
414
+
415
+ </li>
416
+
417
+ <li>
418
+
419
+ <span class='name'>email</span>
420
+
421
+
422
+ <span class='type'>(<tt>String</tt>)</span>
423
+
424
+
425
+
426
+ &mdash;
427
+ <div class='inline'>
428
+ <p>customer email</p>
429
+ </div>
430
+
431
+ </li>
432
+
433
+ <li>
434
+
435
+ <span class='name'>location</span>
436
+
437
+
438
+ <span class='type'>(<tt>Hash</tt>)</span>
439
+
440
+
441
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
442
+
443
+
444
+ &mdash;
445
+ <div class='inline'>
446
+ <p>customer Location, optional</p>
447
+ </div>
448
+
449
+ </li>
450
+
451
+ <li>
452
+
453
+ <span class='name'>cid</span>
454
+
455
+
456
+ <span class='type'>(<tt>Integer</tt>)</span>
457
+
458
+
459
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
460
+
461
+
462
+ &mdash;
463
+ <div class='inline'>
464
+ <p>Aceroute customer id, optional; useful for instantiating Customer objects
465
+ from Aceroute API response</p>
466
+ </div>
467
+
468
+ </li>
469
+
470
+ </ul>
471
+
472
+
473
+ </div><table class="source_code">
474
+ <tr>
475
+ <td>
476
+ <pre class="lines">
477
+
478
+
479
+ 16
480
+ 17
481
+ 18
482
+ 19
483
+ 20
484
+ 21
485
+ 22
486
+ 23
487
+ 24
488
+ 25
489
+ 26
490
+ 27</pre>
491
+ </td>
492
+ <td>
493
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 16</span>
494
+
495
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_location'>location</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
496
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
497
+ <span class='comment'>#create getters/setters for each param
498
+ </span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_email'>email</span> <span class='op'>=</span> <span class='id identifier rubyid_email'>email</span>
499
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
500
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span>
501
+
502
+ <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
503
+ <span class='id identifier rubyid_locations'>locations</span> <span class='op'>&lt;&lt;</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='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:address1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:address2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span><span class='comma'>,</span>
504
+ <span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_location'>location</span><span class='lbracket'>[</span><span class='symbol'>:phone</span><span class='rbracket'>]</span><span class='rparen'>)</span>
505
+ <span class='kw'>end</span>
506
+ <span class='kw'>end</span></pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+ </div>
513
+
514
+ <div id="instance_attr_details" class="attr_details">
515
+ <h2>Instance Attribute Details</h2>
516
+
517
+
518
+ <span id="cid=-instance_method"></span>
519
+ <div class="method_details first">
520
+ <h3 class="signature first" id="cid-instance_method">
521
+
522
+ - (<tt>Object</tt>) <strong>cid</strong>
523
+
524
+
525
+
526
+
527
+
528
+ </h3><div class="docstring">
529
+ <div class="discussion">
530
+
531
+ <p>Returns the value of attribute cid</p>
532
+
533
+
534
+ </div>
535
+ </div>
536
+ <div class="tags">
537
+
538
+
539
+ </div><table class="source_code">
540
+ <tr>
541
+ <td>
542
+ <pre class="lines">
543
+
544
+
545
+ 6
546
+ 7
547
+ 8</pre>
548
+ </td>
549
+ <td>
550
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 6</span>
551
+
552
+ <span class='kw'>def</span> <span class='id identifier rubyid_cid'>cid</span>
553
+ <span class='ivar'>@cid</span>
554
+ <span class='kw'>end</span></pre>
555
+ </td>
556
+ </tr>
557
+ </table>
558
+ </div>
559
+
560
+
561
+ <span id="email=-instance_method"></span>
562
+ <div class="method_details ">
563
+ <h3 class="signature " id="email-instance_method">
564
+
565
+ - (<tt>Object</tt>) <strong>email</strong>
566
+
567
+
568
+
569
+
570
+
571
+ </h3><div class="docstring">
572
+ <div class="discussion">
573
+
574
+ <p>Returns the value of attribute email</p>
575
+
576
+
577
+ </div>
578
+ </div>
579
+ <div class="tags">
580
+
581
+
582
+ </div><table class="source_code">
583
+ <tr>
584
+ <td>
585
+ <pre class="lines">
586
+
587
+
588
+ 4
589
+ 5
590
+ 6</pre>
591
+ </td>
592
+ <td>
593
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 4</span>
594
+
595
+ <span class='kw'>def</span> <span class='id identifier rubyid_email'>email</span>
596
+ <span class='ivar'>@email</span>
597
+ <span class='kw'>end</span></pre>
598
+ </td>
599
+ </tr>
600
+ </table>
601
+ </div>
602
+
603
+
604
+ <span id="id=-instance_method"></span>
605
+ <div class="method_details ">
606
+ <h3 class="signature " id="id-instance_method">
607
+
608
+ - (<tt>Object</tt>) <strong>id</strong>
609
+
610
+
611
+
612
+
613
+
614
+ </h3><div class="docstring">
615
+ <div class="discussion">
616
+
617
+ <p>Returns the value of attribute id</p>
618
+
619
+
620
+ </div>
621
+ </div>
622
+ <div class="tags">
623
+
624
+
625
+ </div><table class="source_code">
626
+ <tr>
627
+ <td>
628
+ <pre class="lines">
629
+
630
+
631
+ 6
632
+ 7
633
+ 8</pre>
634
+ </td>
635
+ <td>
636
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 6</span>
637
+
638
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
639
+ <span class='ivar'>@id</span>
640
+ <span class='kw'>end</span></pre>
641
+ </td>
642
+ </tr>
643
+ </table>
644
+ </div>
645
+
646
+
647
+ <span id="locations=-instance_method"></span>
648
+ <div class="method_details ">
649
+ <h3 class="signature " id="locations-instance_method">
650
+
651
+ - (<tt>Object</tt>) <strong>locations</strong>
652
+
653
+
654
+
655
+
656
+
657
+ </h3><div class="docstring">
658
+ <div class="discussion">
659
+
660
+ <p>Returns the value of attribute locations</p>
661
+
662
+
663
+ </div>
664
+ </div>
665
+ <div class="tags">
666
+
667
+
668
+ </div><table class="source_code">
669
+ <tr>
670
+ <td>
671
+ <pre class="lines">
672
+
673
+
674
+ 3
675
+ 4
676
+ 5</pre>
677
+ </td>
678
+ <td>
679
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 3</span>
680
+
681
+ <span class='kw'>def</span> <span class='id identifier rubyid_locations'>locations</span>
682
+ <span class='ivar'>@locations</span>
683
+ <span class='kw'>end</span></pre>
684
+ </td>
685
+ </tr>
686
+ </table>
687
+ </div>
688
+
689
+
690
+ <span id="name=-instance_method"></span>
691
+ <div class="method_details ">
692
+ <h3 class="signature " id="name-instance_method">
693
+
694
+ - (<tt>Object</tt>) <strong>name</strong>
695
+
696
+
697
+
698
+
699
+
700
+ </h3><div class="docstring">
701
+ <div class="discussion">
702
+
703
+ <p>Returns the value of attribute name</p>
704
+
705
+
706
+ </div>
707
+ </div>
708
+ <div class="tags">
709
+
710
+
711
+ </div><table class="source_code">
712
+ <tr>
713
+ <td>
714
+ <pre class="lines">
715
+
716
+
717
+ 5
718
+ 6
719
+ 7</pre>
720
+ </td>
721
+ <td>
722
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 5</span>
723
+
724
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
725
+ <span class='ivar'>@name</span>
726
+ <span class='kw'>end</span></pre>
727
+ </td>
728
+ </tr>
729
+ </table>
730
+ </div>
731
+
732
+ </div>
733
+
734
+
735
+ <div id="class_method_details" class="method_details_list">
736
+ <h2>Class Method Details</h2>
737
+
738
+
739
+ <div class="method_details first">
740
+ <h3 class="signature first" id="delete-class_method">
741
+
742
+ + (<tt>Object</tt>) <strong>delete</strong>(id)
743
+
744
+
745
+
746
+
747
+
748
+ </h3><div class="docstring">
749
+ <div class="discussion">
750
+
751
+ <p>Deletes Aceroute::Customer of given id from Aceroute</p>
752
+
753
+
754
+ </div>
755
+ </div>
756
+ <div class="tags">
757
+ <p class="tag_title">Parameters:</p>
758
+ <ul class="param">
759
+
760
+ <li>
761
+
762
+ <span class='name'>id</span>
763
+
764
+
765
+ <span class='type'>(<tt>Integer</tt>)</span>
766
+
767
+
768
+
769
+ </li>
770
+
771
+ </ul>
772
+
773
+
774
+ </div><table class="source_code">
775
+ <tr>
776
+ <td>
777
+ <pre class="lines">
778
+
779
+
780
+ 62
781
+ 63
782
+ 64
783
+ 65
784
+ 66</pre>
785
+ </td>
786
+ <td>
787
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 62</span>
788
+
789
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
790
+ <span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;data&gt;&lt;del&gt;&lt;id&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/id&gt;&lt;/del&gt;&lt;/data&gt;</span><span class='tstring_end'>&quot;</span></span>
791
+ <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>customer.delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
792
+ <span class='id identifier rubyid_ret'>ret</span><span class='period'>.</span><span class='id identifier rubyid_success'>success</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>true</span><span class='tstring_end'>&quot;</span></span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
793
+ <span class='kw'>end</span></pre>
794
+ </td>
795
+ </tr>
796
+ </table>
797
+ </div>
798
+
799
+ </div>
800
+
801
+ <div id="instance_method_details" class="method_details_list">
802
+ <h2>Instance Method Details</h2>
803
+
804
+
805
+ <div class="method_details first">
806
+ <h3 class="signature first" id="create!-instance_method">
807
+
808
+ - (<tt><span class='object_link'><a href="" title="Aceroute::Customer (class)">Aceroute::Customer</a></span></tt>) <strong>create!</strong>
809
+
810
+
811
+
812
+
813
+
814
+ </h3><div class="docstring">
815
+ <div class="discussion">
816
+
817
+ <p>Persists Customer object to Aceroute API.</p>
818
+
819
+
820
+ </div>
821
+ </div>
822
+ <div class="tags">
823
+
824
+ <p class="tag_title">Returns:</p>
825
+ <ul class="return">
826
+
827
+ <li>
828
+
829
+
830
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Aceroute::Customer (class)">Aceroute::Customer</a></span></tt>)</span>
831
+
832
+
833
+
834
+ </li>
835
+
836
+ </ul>
837
+
838
+ </div><table class="source_code">
839
+ <tr>
840
+ <td>
841
+ <pre class="lines">
842
+
843
+
844
+ 32
845
+ 33
846
+ 34
847
+ 35
848
+ 36
849
+ 37
850
+ 38
851
+ 39
852
+ 40
853
+ 41
854
+ 42
855
+ 43
856
+ 44
857
+ 45
858
+ 46
859
+ 47
860
+ 48
861
+ 49
862
+ 50
863
+ 51
864
+ 52
865
+ 53</pre>
866
+ </td>
867
+ <td>
868
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 32</span>
869
+
870
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span>
871
+ <span class='id identifier rubyid_recs'>recs</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;data&gt;
872
+ &lt;cst&gt;
873
+ &lt;nm&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/nm&gt;
874
+ &lt;locnm&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/locnm&gt;
875
+ &lt;adr&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_address1'>address1</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/adr&gt;
876
+ &lt;adr2&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_address2'>address2</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/adr2&gt;
877
+ &lt;cntnm&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/cntnm&gt;
878
+ &lt;tel&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_phone'>phone</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/tel&gt;
879
+ &lt;eml&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_email'>email</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/eml&gt;
880
+ &lt;/cst&gt;
881
+ &lt;/data&gt;</span><span class='tstring_end'>&quot;</span></span>
882
+
883
+ <span class='comment'>#puts recs
884
+ </span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>Aceroute</span><span class='op'>::</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>customer.create</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_recs'>recs</span><span class='rparen'>)</span>
885
+ <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>
886
+ <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>
887
+ <span class='id identifier rubyid_update_attrs'>update_attrs</span><span class='lparen'>(</span><span class='id identifier rubyid_customer'>customer</span><span class='rparen'>)</span>
888
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_customer'>customer</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span>
889
+ <span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_update_attrs'>update_attrs</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
890
+ <span class='kw'>return</span> <span class='kw'>self</span>
891
+ <span class='kw'>end</span></pre>
892
+ </td>
893
+ </tr>
894
+ </table>
895
+ </div>
896
+
897
+ <div class="method_details ">
898
+ <h3 class="signature " id="destroy!-instance_method">
899
+
900
+ - (<tt>Object</tt>) <strong>destroy!</strong>(id = nil)
901
+
902
+
903
+
904
+
905
+
906
+ </h3><div class="docstring">
907
+ <div class="discussion">
908
+
909
+ <p>Deletes this Aceroute::Customer object (self) from Aceroute;</p>
910
+
911
+
912
+ </div>
913
+ </div>
914
+ <div class="tags">
915
+
916
+
917
+ </div><table class="source_code">
918
+ <tr>
919
+ <td>
920
+ <pre class="lines">
921
+
922
+
923
+ 56
924
+ 57
925
+ 58</pre>
926
+ </td>
927
+ <td>
928
+ <pre class="code"><span class="info file"># File 'lib/aceroute/customer.rb', line 56</span>
929
+
930
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy!'>destroy!</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
931
+ <span class='const'>Customer</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span> <span class='op'>?</span> <span class='id identifier rubyid_id'>id</span> <span class='op'>:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
932
+ <span class='kw'>end</span></pre>
933
+ </td>
934
+ </tr>
935
+ </table>
936
+ </div>
937
+
938
+ </div>
939
+
940
+ </div>
941
+
942
+ <div id="footer">
943
+ Generated on Sun Dec 4 11:17:52 2016 by
944
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
945
+ 0.8.7.6 (ruby-2.3.1).
946
+ </div>
947
+
948
+ </body>
949
+ </html>