moxiworks_platform 0.13.15 → 0.13.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -1
  3. data/Gemfile +2 -0
  4. data/lib/moxiworks_platform/action_log.rb +31 -2
  5. data/lib/moxiworks_platform/company.rb +0 -3
  6. data/lib/moxiworks_platform/contact.rb +5 -6
  7. data/lib/moxiworks_platform/listing.rb +11 -1
  8. data/lib/moxiworks_platform/version.rb +1 -1
  9. data/publish_docs.sh +7 -2
  10. metadata +2 -28
  11. data/MoxiworksPlatform/ActionLog.html +0 -1155
  12. data/MoxiworksPlatform/Agent.html +0 -3668
  13. data/MoxiworksPlatform/Brand.html +0 -2897
  14. data/MoxiworksPlatform/BuyerTransaction.html +0 -4703
  15. data/MoxiworksPlatform/Company.html +0 -678
  16. data/MoxiworksPlatform/Config.html +0 -323
  17. data/MoxiworksPlatform/Contact.html +0 -7540
  18. data/MoxiworksPlatform/Credentials.html +0 -1078
  19. data/MoxiworksPlatform/EmailCampaign.html +0 -1076
  20. data/MoxiworksPlatform/Event.html +0 -2987
  21. data/MoxiworksPlatform/Exception.html +0 -117
  22. data/MoxiworksPlatform/Exception/ArgumentError.html +0 -146
  23. data/MoxiworksPlatform/Exception/AuthorizationError.html +0 -134
  24. data/MoxiworksPlatform/Exception/PlatformError.html +0 -141
  25. data/MoxiworksPlatform/Exception/RemoteRequestFailure.html +0 -134
  26. data/MoxiworksPlatform/Gallery.html +0 -877
  27. data/MoxiworksPlatform/Group.html +0 -941
  28. data/MoxiworksPlatform/Listing.html +0 -6242
  29. data/MoxiworksPlatform/Office.html +0 -2144
  30. data/MoxiworksPlatform/PresentationLog.html +0 -1715
  31. data/MoxiworksPlatform/Resource.html +0 -1906
  32. data/MoxiworksPlatform/SellerTransaction.html +0 -4222
  33. data/MoxiworksPlatform/Session.html +0 -209
  34. data/MoxiworksPlatform/SoldListing.html +0 -5606
  35. data/MoxiworksPlatform/Task.html +0 -2351
  36. data/MoxiworksPlatform/Team.html +0 -2147
@@ -1,3668 +0,0 @@
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: MoxiworksPlatform::Agent
8
-
9
- &mdash; Documentation by YARD 0.9.5
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "MoxiworksPlatform::Agent";
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"></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 (A)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span>
41
- &raquo;
42
- <span class="title">Agent</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
- <iframe id="search_frame" src="../class_list.html"></iframe>
63
-
64
- <div id="content"><h1>Class: MoxiworksPlatform::Agent
65
-
66
-
67
-
68
- </h1>
69
- <div class="box_info">
70
-
71
- <dl>
72
- <dt>Inherits:</dt>
73
- <dd>
74
- <span class="inheritName"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></span>
75
-
76
- <ul class="fullTree">
77
- <li>Object</li>
78
-
79
- <li class="next"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></li>
80
-
81
- <li class="next">MoxiworksPlatform::Agent</li>
82
-
83
- </ul>
84
- <a href="#" class="inheritanceTree">show all</a>
85
-
86
- </dd>
87
- </dl>
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
- <dl>
100
- <dt>Defined in:</dt>
101
- <dd>lib/moxiworks_platform/agent.rb</dd>
102
- </dl>
103
-
104
- </div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
-
109
- <h1 id="label-Moxi+Works+Platform+Agent">Moxi Works Platform Agent</h1>
110
-
111
-
112
- </div>
113
- </div>
114
- <div class="tags">
115
-
116
-
117
- </div>
118
-
119
-
120
-
121
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
- <ul class="summary">
123
-
124
- <li class="public ">
125
- <span class="summary_signature">
126
-
127
- <a href="#address_city-instance_method" title="#address_city (instance method)">#<strong>address_city</strong> &#x21d2; String </a>
128
-
129
-
130
-
131
- </span>
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
- <span class="summary_desc"><div class='inline'>
145
- <p>The agent&#39;s address, city.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#address_state-instance_method" title="#address_state (instance method)">#<strong>address_state</strong> &#x21d2; String </a>
155
-
156
-
157
-
158
- </span>
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>The agent&#39;s address, state.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#address_street-instance_method" title="#address_street (instance method)">#<strong>address_street</strong> &#x21d2; String </a>
182
-
183
-
184
-
185
- </span>
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
- <span class="summary_desc"><div class='inline'>
199
- <p>The agent&#39;s address, street and number.</p>
200
- </div></span>
201
-
202
- </li>
203
-
204
-
205
- <li class="public ">
206
- <span class="summary_signature">
207
-
208
- <a href="#address_zip-instance_method" title="#address_zip (instance method)">#<strong>address_zip</strong> &#x21d2; String </a>
209
-
210
-
211
-
212
- </span>
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
- <span class="summary_desc"><div class='inline'>
226
- <p>The agent&#39;s address, zip code.</p>
227
- </div></span>
228
-
229
- </li>
230
-
231
-
232
- <li class="public ">
233
- <span class="summary_signature">
234
-
235
- <a href="#client_agent_id-instance_method" title="#client_agent_id (instance method)">#<strong>client_agent_id</strong> &#x21d2; String </a>
236
-
237
-
238
-
239
- </span>
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
- <span class="summary_desc"><div class='inline'>
253
- <p>The UUID of the office which the Agent is associated.</p>
254
- </div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#client_company_id-instance_method" title="#client_company_id (instance method)">#<strong>client_company_id</strong> &#x21d2; String </a>
263
-
264
-
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
- <span class="summary_desc"><div class='inline'>
280
- <p>The UUID of the office which the Agent is associated.</p>
281
- </div></span>
282
-
283
- </li>
284
-
285
-
286
- <li class="public ">
287
- <span class="summary_signature">
288
-
289
- <a href="#client_office_id-instance_method" title="#client_office_id (instance method)">#<strong>client_office_id</strong> &#x21d2; String </a>
290
-
291
-
292
-
293
- </span>
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
- <span class="summary_desc"><div class='inline'>
307
- <p>The internal of the office which the Agent is associated used by the
308
- company.</p>
309
- </div></span>
310
-
311
- </li>
312
-
313
-
314
- <li class="public ">
315
- <span class="summary_signature">
316
-
317
- <a href="#facebook-instance_method" title="#facebook (instance method)">#<strong>facebook</strong> &#x21d2; String </a>
318
-
319
-
320
-
321
- </span>
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
- <span class="summary_desc"><div class='inline'>
335
- <p>The agent&#39;s facebook page.</p>
336
- </div></span>
337
-
338
- </li>
339
-
340
-
341
- <li class="public ">
342
- <span class="summary_signature">
343
-
344
- <a href="#fax_phone_number-instance_method" title="#fax_phone_number (instance method)">#<strong>fax_phone_number</strong> &#x21d2; String </a>
345
-
346
-
347
-
348
- </span>
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
- <span class="summary_desc"><div class='inline'>
362
- <p>The agent&#39;s fax phone number.</p>
363
- </div></span>
364
-
365
- </li>
366
-
367
-
368
- <li class="public ">
369
- <span class="summary_signature">
370
-
371
- <a href="#first_name-instance_method" title="#first_name (instance method)">#<strong>first_name</strong> &#x21d2; String </a>
372
-
373
-
374
-
375
- </span>
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
- <span class="summary_desc"><div class='inline'>
389
- <p>The agent&#39;s first name.</p>
390
- </div></span>
391
-
392
- </li>
393
-
394
-
395
- <li class="public ">
396
- <span class="summary_signature">
397
-
398
- <a href="#google_plus-instance_method" title="#google_plus (instance method)">#<strong>google_plus</strong> &#x21d2; String </a>
399
-
400
-
401
-
402
- </span>
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
- <span class="summary_desc"><div class='inline'>
416
- <p>The agent&#39;s google plus acount.</p>
417
- </div></span>
418
-
419
- </li>
420
-
421
-
422
- <li class="public ">
423
- <span class="summary_signature">
424
-
425
- <a href="#has_engage_access-instance_method" title="#has_engage_access (instance method)">#<strong>has_engage_access</strong> &#x21d2; String </a>
426
-
427
-
428
-
429
- </span>
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
- <span class="summary_desc"><div class='inline'>
443
- <p>Whether the agent has access to MoxiWorks Engage.</p>
444
- </div></span>
445
-
446
- </li>
447
-
448
-
449
- <li class="public ">
450
- <span class="summary_signature">
451
-
452
- <a href="#home_page-instance_method" title="#home_page (instance method)">#<strong>home_page</strong> &#x21d2; String </a>
453
-
454
-
455
-
456
- </span>
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
- <span class="summary_desc"><div class='inline'>
470
- <p>The agent&#39;s home page url.</p>
471
- </div></span>
472
-
473
- </li>
474
-
475
-
476
- <li class="public ">
477
- <span class="summary_signature">
478
-
479
- <a href="#last_name-instance_method" title="#last_name (instance method)">#<strong>last_name</strong> &#x21d2; String </a>
480
-
481
-
482
-
483
- </span>
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
- <span class="summary_desc"><div class='inline'>
497
- <p>The agent&#39;s last name.</p>
498
- </div></span>
499
-
500
- </li>
501
-
502
-
503
- <li class="public ">
504
- <span class="summary_signature">
505
-
506
- <a href="#main_phone_number-instance_method" title="#main_phone_number (instance method)">#<strong>main_phone_number</strong> &#x21d2; String </a>
507
-
508
-
509
-
510
- </span>
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
- <span class="summary_desc"><div class='inline'>
524
- <p>The agent&#39;s main phone number.</p>
525
- </div></span>
526
-
527
- </li>
528
-
529
-
530
- <li class="public ">
531
- <span class="summary_signature">
532
-
533
- <a href="#mobile_phone_number-instance_method" title="#mobile_phone_number (instance method)">#<strong>mobile_phone_number</strong> &#x21d2; String </a>
534
-
535
-
536
-
537
- </span>
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
- <span class="summary_desc"><div class='inline'>
551
- <p>The agent&#39;s fax phone number.</p>
552
- </div></span>
553
-
554
- </li>
555
-
556
-
557
- <li class="public ">
558
- <span class="summary_signature">
559
-
560
- <a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong> &#x21d2; String </a>
561
-
562
-
563
-
564
- </span>
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
- <span class="summary_desc"><div class='inline'>
578
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
579
- contact is or is to be associated with.</p>
580
- </div></span>
581
-
582
- </li>
583
-
584
-
585
- <li class="public ">
586
- <span class="summary_signature">
587
-
588
- <a href="#moxi_works_office_id-instance_method" title="#moxi_works_office_id (instance method)">#<strong>moxi_works_office_id</strong> &#x21d2; String </a>
589
-
590
-
591
-
592
- </span>
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
- <span class="summary_desc"><div class='inline'>
606
- <p>The UUID of the office which the Agent is associated.</p>
607
- </div></span>
608
-
609
- </li>
610
-
611
-
612
- <li class="public ">
613
- <span class="summary_signature">
614
-
615
- <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
616
-
617
-
618
-
619
- </span>
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
- <span class="summary_desc"><div class='inline'>
633
- <p>The agent&#39;s full name.</p>
634
- </div></span>
635
-
636
- </li>
637
-
638
-
639
- <li class="public ">
640
- <span class="summary_signature">
641
-
642
- <a href="#office_address_city-instance_method" title="#office_address_city (instance method)">#<strong>office_address_city</strong> &#x21d2; String </a>
643
-
644
-
645
-
646
- </span>
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
- <span class="summary_desc"><div class='inline'>
660
- <p>The agent&#39;s office address, city.</p>
661
- </div></span>
662
-
663
- </li>
664
-
665
-
666
- <li class="public ">
667
- <span class="summary_signature">
668
-
669
- <a href="#office_address_state-instance_method" title="#office_address_state (instance method)">#<strong>office_address_state</strong> &#x21d2; String </a>
670
-
671
-
672
-
673
- </span>
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
-
684
-
685
-
686
- <span class="summary_desc"><div class='inline'>
687
- <p>The agent&#39;s office address, state.</p>
688
- </div></span>
689
-
690
- </li>
691
-
692
-
693
- <li class="public ">
694
- <span class="summary_signature">
695
-
696
- <a href="#office_address_street-instance_method" title="#office_address_street (instance method)">#<strong>office_address_street</strong> &#x21d2; String </a>
697
-
698
-
699
-
700
- </span>
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
- <span class="summary_desc"><div class='inline'>
714
- <p>The agent&#39;s office address, street and number.</p>
715
- </div></span>
716
-
717
- </li>
718
-
719
-
720
- <li class="public ">
721
- <span class="summary_signature">
722
-
723
- <a href="#office_address_street2-instance_method" title="#office_address_street2 (instance method)">#<strong>office_address_street2</strong> &#x21d2; String </a>
724
-
725
-
726
-
727
- </span>
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
- <span class="summary_desc"><div class='inline'>
741
- <p>The agent&#39;s office address, suite or office number.</p>
742
- </div></span>
743
-
744
- </li>
745
-
746
-
747
- <li class="public ">
748
- <span class="summary_signature">
749
-
750
- <a href="#office_address_zip-instance_method" title="#office_address_zip (instance method)">#<strong>office_address_zip</strong> &#x21d2; String </a>
751
-
752
-
753
-
754
- </span>
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
- <span class="summary_desc"><div class='inline'>
768
- <p>The agent&#39;s office address, zip code.</p>
769
- </div></span>
770
-
771
- </li>
772
-
773
-
774
- <li class="public ">
775
- <span class="summary_signature">
776
-
777
- <a href="#office_phone_number-instance_method" title="#office_phone_number (instance method)">#<strong>office_phone_number</strong> &#x21d2; String </a>
778
-
779
-
780
-
781
- </span>
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
- <span class="summary_desc"><div class='inline'>
795
- <p>The agent&#39;s office_phone number.</p>
796
- </div></span>
797
-
798
- </li>
799
-
800
-
801
- <li class="public ">
802
- <span class="summary_signature">
803
-
804
- <a href="#primary_email_address-instance_method" title="#primary_email_address (instance method)">#<strong>primary_email_address</strong> &#x21d2; String </a>
805
-
806
-
807
-
808
- </span>
809
-
810
-
811
-
812
-
813
-
814
-
815
-
816
-
817
-
818
-
819
-
820
-
821
- <span class="summary_desc"><div class='inline'>
822
- <p>The agent&#39;s primary email address.</p>
823
- </div></span>
824
-
825
- </li>
826
-
827
-
828
- <li class="public ">
829
- <span class="summary_signature">
830
-
831
- <a href="#profile_image_url-instance_method" title="#profile_image_url (instance method)">#<strong>profile_image_url</strong> &#x21d2; String </a>
832
-
833
-
834
-
835
- </span>
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
- <span class="summary_desc"><div class='inline'>
849
- <p>Url to a full size image of the agent.</p>
850
- </div></span>
851
-
852
- </li>
853
-
854
-
855
- <li class="public ">
856
- <span class="summary_signature">
857
-
858
- <a href="#profile_thumb_url-instance_method" title="#profile_thumb_url (instance method)">#<strong>profile_thumb_url</strong> &#x21d2; String </a>
859
-
860
-
861
-
862
- </span>
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
- <span class="summary_desc"><div class='inline'>
876
- <p>Url to a thumb size image of the agent.</p>
877
- </div></span>
878
-
879
- </li>
880
-
881
-
882
- <li class="public ">
883
- <span class="summary_signature">
884
-
885
- <a href="#secondary_email_address-instance_method" title="#secondary_email_address (instance method)">#<strong>secondary_email_address</strong> &#x21d2; String </a>
886
-
887
-
888
-
889
- </span>
890
-
891
-
892
-
893
-
894
-
895
-
896
-
897
-
898
-
899
-
900
-
901
-
902
- <span class="summary_desc"><div class='inline'>
903
- <p>The agent&#39;s secondary email address.</p>
904
- </div></span>
905
-
906
- </li>
907
-
908
-
909
- <li class="public ">
910
- <span class="summary_signature">
911
-
912
- <a href="#string+the+id+of+the+agent+used+by+the+company+of+the+agent-instance_method" title="#string the id of the agent used by the company of the agent (instance method)">#<strong>string the id of the agent used by the company of the agent</strong>(theidoftheagentusedbythecompanyoftheagent) &#x21d2; Object </a>
913
-
914
-
915
-
916
- </span>
917
-
918
-
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
- <span class="summary_desc"><div class='inline'></div></span>
930
-
931
- </li>
932
-
933
-
934
- <li class="public ">
935
- <span class="summary_signature">
936
-
937
- <a href="#string+the+id+of+the+company+used+by+the+company+of+the+agent-instance_method" title="#string the id of the company used by the company of the agent (instance method)">#<strong>string the id of the company used by the company of the agent</strong>(theidofthecompanyusedbythecompanyoftheagent) &#x21d2; Object </a>
938
-
939
-
940
-
941
- </span>
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
- <span class="summary_desc"><div class='inline'></div></span>
955
-
956
- </li>
957
-
958
-
959
- <li class="public ">
960
- <span class="summary_signature">
961
-
962
- <a href="#string+the+id+office+used+by+the+company+of+the+agent-instance_method" title="#string the id office used by the company of the agent (instance method)">#<strong>string the id office used by the company of the agent</strong>(theidofficeusedbythecompanyoftheagent) &#x21d2; Object </a>
963
-
964
-
965
-
966
- </span>
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
- <span class="summary_desc"><div class='inline'></div></span>
980
-
981
- </li>
982
-
983
-
984
- <li class="public ">
985
- <span class="summary_signature">
986
-
987
- <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; String </a>
988
-
989
-
990
-
991
- </span>
992
-
993
-
994
-
995
-
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
- <span class="summary_desc"><div class='inline'>
1005
- <p>Any business related titles associated with the agent.</p>
1006
- </div></span>
1007
-
1008
- </li>
1009
-
1010
-
1011
- <li class="public ">
1012
- <span class="summary_signature">
1013
-
1014
- <a href="#twitter-instance_method" title="#twitter (instance method)">#<strong>twitter</strong> &#x21d2; String </a>
1015
-
1016
-
1017
-
1018
- </span>
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
-
1027
-
1028
-
1029
-
1030
-
1031
- <span class="summary_desc"><div class='inline'>
1032
- <p>The agent&#39;s twitter handle.</p>
1033
- </div></span>
1034
-
1035
- </li>
1036
-
1037
-
1038
- <li class="public ">
1039
- <span class="summary_signature">
1040
-
1041
- <a href="#uuid-instance_method" title="#uuid (instance method)">#<strong>uuid</strong> &#x21d2; String </a>
1042
-
1043
-
1044
-
1045
- </span>
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
- <span class="summary_desc"><div class='inline'>
1059
- <p>identifier in determining associations between Agent objects and Listing
1060
- objects.</p>
1061
- </div></span>
1062
-
1063
- </li>
1064
-
1065
-
1066
- </ul>
1067
-
1068
-
1069
-
1070
-
1071
-
1072
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
1073
- <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
1074
-
1075
-
1076
-
1077
- <h2>
1078
- Class Method Summary
1079
- <small><a href="#" class="summary_toggle">collapse</a></small>
1080
- </h2>
1081
-
1082
- <ul class="summary">
1083
-
1084
- <li class="public ">
1085
- <span class="summary_signature">
1086
-
1087
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Agent </a>
1088
-
1089
-
1090
-
1091
- </span>
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
- <span class="summary_desc"><div class='inline'>
1102
- <p>Find an Agent on the Moxi Works Platform.</p>
1103
- </div></span>
1104
-
1105
- </li>
1106
-
1107
-
1108
- <li class="public ">
1109
- <span class="summary_signature">
1110
-
1111
- <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Hash </a>
1112
-
1113
-
1114
-
1115
- </span>
1116
-
1117
-
1118
-
1119
-
1120
-
1121
-
1122
-
1123
-
1124
-
1125
- <span class="summary_desc"><div class='inline'>
1126
- <p>Search For Agents in Moxi Works Platform.</p>
1127
- </div></span>
1128
-
1129
- </li>
1130
-
1131
-
1132
- <li class="public ">
1133
- <span class="summary_signature">
1134
-
1135
- <a href="#send_request-class_method" title="send_request (class method)">.<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; Object </a>
1136
-
1137
-
1138
-
1139
- </span>
1140
-
1141
-
1142
-
1143
-
1144
-
1145
-
1146
-
1147
-
1148
-
1149
- <span class="summary_desc"><div class='inline'></div></span>
1150
-
1151
- </li>
1152
-
1153
-
1154
- </ul>
1155
-
1156
-
1157
-
1158
-
1159
-
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
1167
- <p class="inherited"><span class='object_link'><a href="Resource.html#accept_header-class_method" title="MoxiworksPlatform::Resource.accept_header (method)">accept_header</a></span>, <span class='object_link'><a href="Resource.html#attr_accessor-class_method" title="MoxiworksPlatform::Resource.attr_accessor (method)">attr_accessor</a></span>, <span class='object_link'><a href="Resource.html#attributes-class_method" title="MoxiworksPlatform::Resource.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Resource.html#attributes-instance_method" title="MoxiworksPlatform::Resource#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Resource.html#auth_header-class_method" title="MoxiworksPlatform::Resource.auth_header (method)">auth_header</a></span>, <span class='object_link'><a href="Resource.html#check_for_error_in_response-class_method" title="MoxiworksPlatform::Resource.check_for_error_in_response (method)">check_for_error_in_response</a></span>, <span class='object_link'><a href="Resource.html#content_type_header-class_method" title="MoxiworksPlatform::Resource.content_type_header (method)">content_type_header</a></span>, <span class='object_link'><a href="Resource.html#float_attrs-instance_method" title="MoxiworksPlatform::Resource#float_attrs (method)">#float_attrs</a></span>, <span class='object_link'><a href="Resource.html#headers-class_method" title="MoxiworksPlatform::Resource.headers (method)">headers</a></span>, <span class='object_link'><a href="Resource.html#init_attrs_from_hash-instance_method" title="MoxiworksPlatform::Resource#init_attrs_from_hash (method)">#init_attrs_from_hash</a></span>, <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Resource.html#int_attrs-instance_method" title="MoxiworksPlatform::Resource#int_attrs (method)">#int_attrs</a></span>, <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Resource.html#numeric_attrs-instance_method" title="MoxiworksPlatform::Resource#numeric_attrs (method)">#numeric_attrs</a></span>, <span class='object_link'><a href="Resource.html#numeric_value_for-instance_method" title="MoxiworksPlatform::Resource#numeric_value_for (method)">#numeric_value_for</a></span>, <span class='object_link'><a href="Resource.html#to_hash-instance_method" title="MoxiworksPlatform::Resource#to_hash (method)">#to_hash</a></span>, <span class='object_link'><a href="Resource.html#underscore-class_method" title="MoxiworksPlatform::Resource.underscore (method)">underscore</a></span>, <span class='object_link'><a href="Resource.html#underscore_array-class_method" title="MoxiworksPlatform::Resource.underscore_array (method)">underscore_array</a></span>, <span class='object_link'><a href="Resource.html#underscore_attribute_names-class_method" title="MoxiworksPlatform::Resource.underscore_attribute_names (method)">underscore_attribute_names</a></span>, <span class='object_link'><a href="Resource.html#underscore_hash-class_method" title="MoxiworksPlatform::Resource.underscore_hash (method)">underscore_hash</a></span>, <span class='object_link'><a href="Resource.html#user_agent_header-class_method" title="MoxiworksPlatform::Resource.user_agent_header (method)">user_agent_header</a></span></p>
1168
- <div id="constructor_details" class="method_details_list">
1169
- <h2>Constructor Details</h2>
1170
-
1171
- <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">MoxiworksPlatform::Resource</a></span></p>
1172
-
1173
- </div>
1174
- <div id="method_missing_details" class="method_details_list">
1175
- <h2>Dynamic Method Handling</h2>
1176
- <p class="notice super">
1177
- This class handles dynamic methods through the <tt>method_missing</tt> method
1178
-
1179
- in the class <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">MoxiworksPlatform::Resource</a></span>
1180
-
1181
- </p>
1182
-
1183
- </div>
1184
-
1185
- <div id="instance_attr_details" class="attr_details">
1186
- <h2>Instance Attribute Details</h2>
1187
-
1188
-
1189
- <span id="address_city=-instance_method"></span>
1190
- <div class="method_details first">
1191
- <h3 class="signature first" id="address_city-instance_method">
1192
-
1193
- #<strong>address_city</strong> &#x21d2; <tt>String</tt>
1194
-
1195
-
1196
-
1197
-
1198
-
1199
- </h3><div class="docstring">
1200
- <div class="discussion">
1201
-
1202
- <p>Returns the agent&#39;s address, city</p>
1203
-
1204
-
1205
- </div>
1206
- </div>
1207
- <div class="tags">
1208
-
1209
- <p class="tag_title">Returns:</p>
1210
- <ul class="return">
1211
-
1212
- <li>
1213
-
1214
-
1215
- <span class='type'>(<tt>String</tt>)</span>
1216
-
1217
-
1218
-
1219
- &mdash;
1220
- <div class='inline'>
1221
- <p>the agent&#39;s address, city</p>
1222
- </div>
1223
-
1224
- </li>
1225
-
1226
- </ul>
1227
-
1228
- </div><table class="source_code">
1229
- <tr>
1230
- <td>
1231
- <pre class="lines">
1232
-
1233
-
1234
- 42
1235
- 43
1236
- 44</pre>
1237
- </td>
1238
- <td>
1239
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 42</span>
1240
-
1241
- <span class='kw'>def</span> <span class='id identifier rubyid_address_city'>address_city</span>
1242
- <span class='ivar'>@address_city</span>
1243
- <span class='kw'>end</span></pre>
1244
- </td>
1245
- </tr>
1246
- </table>
1247
- </div>
1248
-
1249
-
1250
- <span id="address_state=-instance_method"></span>
1251
- <div class="method_details ">
1252
- <h3 class="signature " id="address_state-instance_method">
1253
-
1254
- #<strong>address_state</strong> &#x21d2; <tt>String</tt>
1255
-
1256
-
1257
-
1258
-
1259
-
1260
- </h3><div class="docstring">
1261
- <div class="discussion">
1262
-
1263
- <p>Returns the agent&#39;s address, state</p>
1264
-
1265
-
1266
- </div>
1267
- </div>
1268
- <div class="tags">
1269
-
1270
- <p class="tag_title">Returns:</p>
1271
- <ul class="return">
1272
-
1273
- <li>
1274
-
1275
-
1276
- <span class='type'>(<tt>String</tt>)</span>
1277
-
1278
-
1279
-
1280
- &mdash;
1281
- <div class='inline'>
1282
- <p>the agent&#39;s address, state</p>
1283
- </div>
1284
-
1285
- </li>
1286
-
1287
- </ul>
1288
-
1289
- </div><table class="source_code">
1290
- <tr>
1291
- <td>
1292
- <pre class="lines">
1293
-
1294
-
1295
- 47
1296
- 48
1297
- 49</pre>
1298
- </td>
1299
- <td>
1300
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 47</span>
1301
-
1302
- <span class='kw'>def</span> <span class='id identifier rubyid_address_state'>address_state</span>
1303
- <span class='ivar'>@address_state</span>
1304
- <span class='kw'>end</span></pre>
1305
- </td>
1306
- </tr>
1307
- </table>
1308
- </div>
1309
-
1310
-
1311
- <span id="address_street=-instance_method"></span>
1312
- <div class="method_details ">
1313
- <h3 class="signature " id="address_street-instance_method">
1314
-
1315
- #<strong>address_street</strong> &#x21d2; <tt>String</tt>
1316
-
1317
-
1318
-
1319
-
1320
-
1321
- </h3><div class="docstring">
1322
- <div class="discussion">
1323
-
1324
- <p>Returns the agent&#39;s address, street and number</p>
1325
-
1326
-
1327
- </div>
1328
- </div>
1329
- <div class="tags">
1330
-
1331
- <p class="tag_title">Returns:</p>
1332
- <ul class="return">
1333
-
1334
- <li>
1335
-
1336
-
1337
- <span class='type'>(<tt>String</tt>)</span>
1338
-
1339
-
1340
-
1341
- &mdash;
1342
- <div class='inline'>
1343
- <p>the agent&#39;s address, street and number</p>
1344
- </div>
1345
-
1346
- </li>
1347
-
1348
- </ul>
1349
-
1350
- </div><table class="source_code">
1351
- <tr>
1352
- <td>
1353
- <pre class="lines">
1354
-
1355
-
1356
- 37
1357
- 38
1358
- 39</pre>
1359
- </td>
1360
- <td>
1361
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 37</span>
1362
-
1363
- <span class='kw'>def</span> <span class='id identifier rubyid_address_street'>address_street</span>
1364
- <span class='ivar'>@address_street</span>
1365
- <span class='kw'>end</span></pre>
1366
- </td>
1367
- </tr>
1368
- </table>
1369
- </div>
1370
-
1371
-
1372
- <span id="address_zip=-instance_method"></span>
1373
- <div class="method_details ">
1374
- <h3 class="signature " id="address_zip-instance_method">
1375
-
1376
- #<strong>address_zip</strong> &#x21d2; <tt>String</tt>
1377
-
1378
-
1379
-
1380
-
1381
-
1382
- </h3><div class="docstring">
1383
- <div class="discussion">
1384
-
1385
- <p>Returns the agent&#39;s address, zip code</p>
1386
-
1387
-
1388
- </div>
1389
- </div>
1390
- <div class="tags">
1391
-
1392
- <p class="tag_title">Returns:</p>
1393
- <ul class="return">
1394
-
1395
- <li>
1396
-
1397
-
1398
- <span class='type'>(<tt>String</tt>)</span>
1399
-
1400
-
1401
-
1402
- &mdash;
1403
- <div class='inline'>
1404
- <p>the agent&#39;s address, zip code</p>
1405
- </div>
1406
-
1407
- </li>
1408
-
1409
- </ul>
1410
-
1411
- </div><table class="source_code">
1412
- <tr>
1413
- <td>
1414
- <pre class="lines">
1415
-
1416
-
1417
- 52
1418
- 53
1419
- 54</pre>
1420
- </td>
1421
- <td>
1422
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 52</span>
1423
-
1424
- <span class='kw'>def</span> <span class='id identifier rubyid_address_zip'>address_zip</span>
1425
- <span class='ivar'>@address_zip</span>
1426
- <span class='kw'>end</span></pre>
1427
- </td>
1428
- </tr>
1429
- </table>
1430
- </div>
1431
-
1432
-
1433
- <span id="client_agent_id=-instance_method"></span>
1434
- <div class="method_details ">
1435
- <h3 class="signature " id="client_agent_id-instance_method">
1436
-
1437
- #<strong>client_agent_id</strong> &#x21d2; <tt>String</tt>
1438
-
1439
-
1440
-
1441
-
1442
-
1443
- </h3><div class="docstring">
1444
- <div class="discussion">
1445
-
1446
- <p>Returns the UUID of the office which the Agent is associated</p>
1447
-
1448
-
1449
- </div>
1450
- </div>
1451
- <div class="tags">
1452
-
1453
- <p class="tag_title">Returns:</p>
1454
- <ul class="return">
1455
-
1456
- <li>
1457
-
1458
-
1459
- <span class='type'>(<tt>String</tt>)</span>
1460
-
1461
-
1462
-
1463
- &mdash;
1464
- <div class='inline'>
1465
- <p>the UUID of the office which the Agent is associated</p>
1466
- </div>
1467
-
1468
- </li>
1469
-
1470
- </ul>
1471
-
1472
- </div><table class="source_code">
1473
- <tr>
1474
- <td>
1475
- <pre class="lines">
1476
-
1477
-
1478
- 22
1479
- 23
1480
- 24</pre>
1481
- </td>
1482
- <td>
1483
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 22</span>
1484
-
1485
- <span class='kw'>def</span> <span class='id identifier rubyid_client_agent_id'>client_agent_id</span>
1486
- <span class='ivar'>@client_agent_id</span>
1487
- <span class='kw'>end</span></pre>
1488
- </td>
1489
- </tr>
1490
- </table>
1491
- </div>
1492
-
1493
-
1494
- <span id="client_company_id=-instance_method"></span>
1495
- <div class="method_details ">
1496
- <h3 class="signature " id="client_company_id-instance_method">
1497
-
1498
- #<strong>client_company_id</strong> &#x21d2; <tt>String</tt>
1499
-
1500
-
1501
-
1502
-
1503
-
1504
- </h3><div class="docstring">
1505
- <div class="discussion">
1506
-
1507
- <p>Returns the UUID of the office which the Agent is associated</p>
1508
-
1509
-
1510
- </div>
1511
- </div>
1512
- <div class="tags">
1513
-
1514
- <p class="tag_title">Returns:</p>
1515
- <ul class="return">
1516
-
1517
- <li>
1518
-
1519
-
1520
- <span class='type'>(<tt>String</tt>)</span>
1521
-
1522
-
1523
-
1524
- &mdash;
1525
- <div class='inline'>
1526
- <p>the UUID of the office which the Agent is associated</p>
1527
- </div>
1528
-
1529
- </li>
1530
-
1531
- </ul>
1532
-
1533
- </div><table class="source_code">
1534
- <tr>
1535
- <td>
1536
- <pre class="lines">
1537
-
1538
-
1539
- 32
1540
- 33
1541
- 34</pre>
1542
- </td>
1543
- <td>
1544
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 32</span>
1545
-
1546
- <span class='kw'>def</span> <span class='id identifier rubyid_client_company_id'>client_company_id</span>
1547
- <span class='ivar'>@client_company_id</span>
1548
- <span class='kw'>end</span></pre>
1549
- </td>
1550
- </tr>
1551
- </table>
1552
- </div>
1553
-
1554
-
1555
- <span id="client_office_id=-instance_method"></span>
1556
- <div class="method_details ">
1557
- <h3 class="signature " id="client_office_id-instance_method">
1558
-
1559
- #<strong>client_office_id</strong> &#x21d2; <tt>String</tt>
1560
-
1561
-
1562
-
1563
-
1564
-
1565
- </h3><div class="docstring">
1566
- <div class="discussion">
1567
-
1568
- <p>Returns the internal of the office which the Agent is associated used by
1569
- the company</p>
1570
-
1571
-
1572
- </div>
1573
- </div>
1574
- <div class="tags">
1575
-
1576
- <p class="tag_title">Returns:</p>
1577
- <ul class="return">
1578
-
1579
- <li>
1580
-
1581
-
1582
- <span class='type'>(<tt>String</tt>)</span>
1583
-
1584
-
1585
-
1586
- &mdash;
1587
- <div class='inline'>
1588
- <p>the internal of the office which the Agent is associated used by the
1589
- company</p>
1590
- </div>
1591
-
1592
- </li>
1593
-
1594
- </ul>
1595
-
1596
- </div><table class="source_code">
1597
- <tr>
1598
- <td>
1599
- <pre class="lines">
1600
-
1601
-
1602
- 27
1603
- 28
1604
- 29</pre>
1605
- </td>
1606
- <td>
1607
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 27</span>
1608
-
1609
- <span class='kw'>def</span> <span class='id identifier rubyid_client_office_id'>client_office_id</span>
1610
- <span class='ivar'>@client_office_id</span>
1611
- <span class='kw'>end</span></pre>
1612
- </td>
1613
- </tr>
1614
- </table>
1615
- </div>
1616
-
1617
-
1618
- <span id="facebook=-instance_method"></span>
1619
- <div class="method_details ">
1620
- <h3 class="signature " id="facebook-instance_method">
1621
-
1622
- #<strong>facebook</strong> &#x21d2; <tt>String</tt>
1623
-
1624
-
1625
-
1626
-
1627
-
1628
- </h3><div class="docstring">
1629
- <div class="discussion">
1630
-
1631
- <p>Returns the agent&#39;s facebook page</p>
1632
-
1633
-
1634
- </div>
1635
- </div>
1636
- <div class="tags">
1637
-
1638
- <p class="tag_title">Returns:</p>
1639
- <ul class="return">
1640
-
1641
- <li>
1642
-
1643
-
1644
- <span class='type'>(<tt>String</tt>)</span>
1645
-
1646
-
1647
-
1648
- &mdash;
1649
- <div class='inline'>
1650
- <p>the agent&#39;s facebook page</p>
1651
- </div>
1652
-
1653
- </li>
1654
-
1655
- </ul>
1656
-
1657
- </div><table class="source_code">
1658
- <tr>
1659
- <td>
1660
- <pre class="lines">
1661
-
1662
-
1663
- 137
1664
- 138
1665
- 139</pre>
1666
- </td>
1667
- <td>
1668
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 137</span>
1669
-
1670
- <span class='kw'>def</span> <span class='id identifier rubyid_facebook'>facebook</span>
1671
- <span class='ivar'>@facebook</span>
1672
- <span class='kw'>end</span></pre>
1673
- </td>
1674
- </tr>
1675
- </table>
1676
- </div>
1677
-
1678
-
1679
- <span id="fax_phone_number=-instance_method"></span>
1680
- <div class="method_details ">
1681
- <h3 class="signature " id="fax_phone_number-instance_method">
1682
-
1683
- #<strong>fax_phone_number</strong> &#x21d2; <tt>String</tt>
1684
-
1685
-
1686
-
1687
-
1688
-
1689
- </h3><div class="docstring">
1690
- <div class="discussion">
1691
-
1692
- <p>Returns the agent&#39;s fax phone number</p>
1693
-
1694
-
1695
- </div>
1696
- </div>
1697
- <div class="tags">
1698
-
1699
- <p class="tag_title">Returns:</p>
1700
- <ul class="return">
1701
-
1702
- <li>
1703
-
1704
-
1705
- <span class='type'>(<tt>String</tt>)</span>
1706
-
1707
-
1708
-
1709
- &mdash;
1710
- <div class='inline'>
1711
- <p>the agent&#39;s fax phone number</p>
1712
- </div>
1713
-
1714
- </li>
1715
-
1716
- </ul>
1717
-
1718
- </div><table class="source_code">
1719
- <tr>
1720
- <td>
1721
- <pre class="lines">
1722
-
1723
-
1724
- 102
1725
- 103
1726
- 104</pre>
1727
- </td>
1728
- <td>
1729
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 102</span>
1730
-
1731
- <span class='kw'>def</span> <span class='id identifier rubyid_fax_phone_number'>fax_phone_number</span>
1732
- <span class='ivar'>@fax_phone_number</span>
1733
- <span class='kw'>end</span></pre>
1734
- </td>
1735
- </tr>
1736
- </table>
1737
- </div>
1738
-
1739
-
1740
- <span id="first_name=-instance_method"></span>
1741
- <div class="method_details ">
1742
- <h3 class="signature " id="first_name-instance_method">
1743
-
1744
- #<strong>first_name</strong> &#x21d2; <tt>String</tt>
1745
-
1746
-
1747
-
1748
-
1749
-
1750
- </h3><div class="docstring">
1751
- <div class="discussion">
1752
-
1753
- <p>Returns the agent&#39;s first name</p>
1754
-
1755
-
1756
- </div>
1757
- </div>
1758
- <div class="tags">
1759
-
1760
- <p class="tag_title">Returns:</p>
1761
- <ul class="return">
1762
-
1763
- <li>
1764
-
1765
-
1766
- <span class='type'>(<tt>String</tt>)</span>
1767
-
1768
-
1769
-
1770
- &mdash;
1771
- <div class='inline'>
1772
- <p>the agent&#39;s first name</p>
1773
- </div>
1774
-
1775
- </li>
1776
-
1777
- </ul>
1778
-
1779
- </div><table class="source_code">
1780
- <tr>
1781
- <td>
1782
- <pre class="lines">
1783
-
1784
-
1785
- 82
1786
- 83
1787
- 84</pre>
1788
- </td>
1789
- <td>
1790
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 82</span>
1791
-
1792
- <span class='kw'>def</span> <span class='id identifier rubyid_first_name'>first_name</span>
1793
- <span class='ivar'>@first_name</span>
1794
- <span class='kw'>end</span></pre>
1795
- </td>
1796
- </tr>
1797
- </table>
1798
- </div>
1799
-
1800
-
1801
- <span id="google_plus=-instance_method"></span>
1802
- <div class="method_details ">
1803
- <h3 class="signature " id="google_plus-instance_method">
1804
-
1805
- #<strong>google_plus</strong> &#x21d2; <tt>String</tt>
1806
-
1807
-
1808
-
1809
-
1810
-
1811
- </h3><div class="docstring">
1812
- <div class="discussion">
1813
-
1814
- <p>Returns the agent&#39;s google plus acount</p>
1815
-
1816
-
1817
- </div>
1818
- </div>
1819
- <div class="tags">
1820
-
1821
- <p class="tag_title">Returns:</p>
1822
- <ul class="return">
1823
-
1824
- <li>
1825
-
1826
-
1827
- <span class='type'>(<tt>String</tt>)</span>
1828
-
1829
-
1830
-
1831
- &mdash;
1832
- <div class='inline'>
1833
- <p>the agent&#39;s google plus acount</p>
1834
- </div>
1835
-
1836
- </li>
1837
-
1838
- </ul>
1839
-
1840
- </div><table class="source_code">
1841
- <tr>
1842
- <td>
1843
- <pre class="lines">
1844
-
1845
-
1846
- 132
1847
- 133
1848
- 134</pre>
1849
- </td>
1850
- <td>
1851
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 132</span>
1852
-
1853
- <span class='kw'>def</span> <span class='id identifier rubyid_google_plus'>google_plus</span>
1854
- <span class='ivar'>@google_plus</span>
1855
- <span class='kw'>end</span></pre>
1856
- </td>
1857
- </tr>
1858
- </table>
1859
- </div>
1860
-
1861
-
1862
- <span id="has_engage_access=-instance_method"></span>
1863
- <div class="method_details ">
1864
- <h3 class="signature " id="has_engage_access-instance_method">
1865
-
1866
- #<strong>has_engage_access</strong> &#x21d2; <tt>String</tt>
1867
-
1868
-
1869
-
1870
-
1871
-
1872
- </h3><div class="docstring">
1873
- <div class="discussion">
1874
-
1875
- <p>Returns whether the agent has access to MoxiWorks Engage</p>
1876
-
1877
-
1878
- </div>
1879
- </div>
1880
- <div class="tags">
1881
-
1882
- <p class="tag_title">Returns:</p>
1883
- <ul class="return">
1884
-
1885
- <li>
1886
-
1887
-
1888
- <span class='type'>(<tt>String</tt>)</span>
1889
-
1890
-
1891
-
1892
- &mdash;
1893
- <div class='inline'>
1894
- <p>whether the agent has access to MoxiWorks Engage</p>
1895
- </div>
1896
-
1897
- </li>
1898
-
1899
- </ul>
1900
-
1901
- </div><table class="source_code">
1902
- <tr>
1903
- <td>
1904
- <pre class="lines">
1905
-
1906
-
1907
- 169
1908
- 170
1909
- 171</pre>
1910
- </td>
1911
- <td>
1912
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 169</span>
1913
-
1914
- <span class='kw'>def</span> <span class='id identifier rubyid_has_engage_access'>has_engage_access</span>
1915
- <span class='ivar'>@has_engage_access</span>
1916
- <span class='kw'>end</span></pre>
1917
- </td>
1918
- </tr>
1919
- </table>
1920
- </div>
1921
-
1922
-
1923
- <span id="home_page=-instance_method"></span>
1924
- <div class="method_details ">
1925
- <h3 class="signature " id="home_page-instance_method">
1926
-
1927
- #<strong>home_page</strong> &#x21d2; <tt>String</tt>
1928
-
1929
-
1930
-
1931
-
1932
-
1933
- </h3><div class="docstring">
1934
- <div class="discussion">
1935
-
1936
- <p>Returns the agent&#39;s home page url</p>
1937
-
1938
-
1939
- </div>
1940
- </div>
1941
- <div class="tags">
1942
-
1943
- <p class="tag_title">Returns:</p>
1944
- <ul class="return">
1945
-
1946
- <li>
1947
-
1948
-
1949
- <span class='type'>(<tt>String</tt>)</span>
1950
-
1951
-
1952
-
1953
- &mdash;
1954
- <div class='inline'>
1955
- <p>the agent&#39;s home page url</p>
1956
- </div>
1957
-
1958
- </li>
1959
-
1960
- </ul>
1961
-
1962
- </div><table class="source_code">
1963
- <tr>
1964
- <td>
1965
- <pre class="lines">
1966
-
1967
-
1968
- 142
1969
- 143
1970
- 144</pre>
1971
- </td>
1972
- <td>
1973
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 142</span>
1974
-
1975
- <span class='kw'>def</span> <span class='id identifier rubyid_home_page'>home_page</span>
1976
- <span class='ivar'>@home_page</span>
1977
- <span class='kw'>end</span></pre>
1978
- </td>
1979
- </tr>
1980
- </table>
1981
- </div>
1982
-
1983
-
1984
- <span id="last_name=-instance_method"></span>
1985
- <div class="method_details ">
1986
- <h3 class="signature " id="last_name-instance_method">
1987
-
1988
- #<strong>last_name</strong> &#x21d2; <tt>String</tt>
1989
-
1990
-
1991
-
1992
-
1993
-
1994
- </h3><div class="docstring">
1995
- <div class="discussion">
1996
-
1997
- <p>Returns the agent&#39;s last name</p>
1998
-
1999
-
2000
- </div>
2001
- </div>
2002
- <div class="tags">
2003
-
2004
- <p class="tag_title">Returns:</p>
2005
- <ul class="return">
2006
-
2007
- <li>
2008
-
2009
-
2010
- <span class='type'>(<tt>String</tt>)</span>
2011
-
2012
-
2013
-
2014
- &mdash;
2015
- <div class='inline'>
2016
- <p>the agent&#39;s last name</p>
2017
- </div>
2018
-
2019
- </li>
2020
-
2021
- </ul>
2022
-
2023
- </div><table class="source_code">
2024
- <tr>
2025
- <td>
2026
- <pre class="lines">
2027
-
2028
-
2029
- 87
2030
- 88
2031
- 89</pre>
2032
- </td>
2033
- <td>
2034
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 87</span>
2035
-
2036
- <span class='kw'>def</span> <span class='id identifier rubyid_last_name'>last_name</span>
2037
- <span class='ivar'>@last_name</span>
2038
- <span class='kw'>end</span></pre>
2039
- </td>
2040
- </tr>
2041
- </table>
2042
- </div>
2043
-
2044
-
2045
- <span id="main_phone_number=-instance_method"></span>
2046
- <div class="method_details ">
2047
- <h3 class="signature " id="main_phone_number-instance_method">
2048
-
2049
- #<strong>main_phone_number</strong> &#x21d2; <tt>String</tt>
2050
-
2051
-
2052
-
2053
-
2054
-
2055
- </h3><div class="docstring">
2056
- <div class="discussion">
2057
-
2058
- <p>Returns the agent&#39;s main phone number</p>
2059
-
2060
-
2061
- </div>
2062
- </div>
2063
- <div class="tags">
2064
-
2065
- <p class="tag_title">Returns:</p>
2066
- <ul class="return">
2067
-
2068
- <li>
2069
-
2070
-
2071
- <span class='type'>(<tt>String</tt>)</span>
2072
-
2073
-
2074
-
2075
- &mdash;
2076
- <div class='inline'>
2077
- <p>the agent&#39;s main phone number</p>
2078
- </div>
2079
-
2080
- </li>
2081
-
2082
- </ul>
2083
-
2084
- </div><table class="source_code">
2085
- <tr>
2086
- <td>
2087
- <pre class="lines">
2088
-
2089
-
2090
- 107
2091
- 108
2092
- 109</pre>
2093
- </td>
2094
- <td>
2095
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 107</span>
2096
-
2097
- <span class='kw'>def</span> <span class='id identifier rubyid_main_phone_number'>main_phone_number</span>
2098
- <span class='ivar'>@main_phone_number</span>
2099
- <span class='kw'>end</span></pre>
2100
- </td>
2101
- </tr>
2102
- </table>
2103
- </div>
2104
-
2105
-
2106
- <span id="mobile_phone_number=-instance_method"></span>
2107
- <div class="method_details ">
2108
- <h3 class="signature " id="mobile_phone_number-instance_method">
2109
-
2110
- #<strong>mobile_phone_number</strong> &#x21d2; <tt>String</tt>
2111
-
2112
-
2113
-
2114
-
2115
-
2116
- </h3><div class="docstring">
2117
- <div class="discussion">
2118
-
2119
- <p>Returns the agent&#39;s fax phone number</p>
2120
-
2121
-
2122
- </div>
2123
- </div>
2124
- <div class="tags">
2125
-
2126
- <p class="tag_title">Returns:</p>
2127
- <ul class="return">
2128
-
2129
- <li>
2130
-
2131
-
2132
- <span class='type'>(<tt>String</tt>)</span>
2133
-
2134
-
2135
-
2136
- &mdash;
2137
- <div class='inline'>
2138
- <p>the agent&#39;s fax phone number</p>
2139
- </div>
2140
-
2141
- </li>
2142
-
2143
- </ul>
2144
-
2145
- </div><table class="source_code">
2146
- <tr>
2147
- <td>
2148
- <pre class="lines">
2149
-
2150
-
2151
- 97
2152
- 98
2153
- 99</pre>
2154
- </td>
2155
- <td>
2156
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 97</span>
2157
-
2158
- <span class='kw'>def</span> <span class='id identifier rubyid_mobile_phone_number'>mobile_phone_number</span>
2159
- <span class='ivar'>@mobile_phone_number</span>
2160
- <span class='kw'>end</span></pre>
2161
- </td>
2162
- </tr>
2163
- </table>
2164
- </div>
2165
-
2166
-
2167
- <span id="moxi_works_agent_id=-instance_method"></span>
2168
- <div class="method_details ">
2169
- <h3 class="signature " id="moxi_works_agent_id-instance_method">
2170
-
2171
- #<strong>moxi_works_agent_id</strong> &#x21d2; <tt>String</tt>
2172
-
2173
-
2174
-
2175
-
2176
-
2177
- </h3><div class="docstring">
2178
- <div class="discussion">
2179
-
2180
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
2181
- contact is or is to be associated with.</p>
2182
-
2183
- <p>this must be set for any Moxi Works Platform transaction</p>
2184
-
2185
-
2186
- </div>
2187
- </div>
2188
- <div class="tags">
2189
-
2190
- <p class="tag_title">Returns:</p>
2191
- <ul class="return">
2192
-
2193
- <li>
2194
-
2195
-
2196
- <span class='type'>(<tt>String</tt>)</span>
2197
-
2198
-
2199
-
2200
- &mdash;
2201
- <div class='inline'>
2202
- <p>the Moxi Works Platform ID of the agent</p>
2203
- </div>
2204
-
2205
- </li>
2206
-
2207
- </ul>
2208
-
2209
- </div><table class="source_code">
2210
- <tr>
2211
- <td>
2212
- <pre class="lines">
2213
-
2214
-
2215
- 12
2216
- 13
2217
- 14</pre>
2218
- </td>
2219
- <td>
2220
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 12</span>
2221
-
2222
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
2223
- <span class='ivar'>@moxi_works_agent_id</span>
2224
- <span class='kw'>end</span></pre>
2225
- </td>
2226
- </tr>
2227
- </table>
2228
- </div>
2229
-
2230
-
2231
- <span id="moxi_works_office_id=-instance_method"></span>
2232
- <div class="method_details ">
2233
- <h3 class="signature " id="moxi_works_office_id-instance_method">
2234
-
2235
- #<strong>moxi_works_office_id</strong> &#x21d2; <tt>String</tt>
2236
-
2237
-
2238
-
2239
-
2240
-
2241
- </h3><div class="docstring">
2242
- <div class="discussion">
2243
-
2244
- <p>Returns the UUID of the office which the Agent is associated</p>
2245
-
2246
-
2247
- </div>
2248
- </div>
2249
- <div class="tags">
2250
-
2251
- <p class="tag_title">Returns:</p>
2252
- <ul class="return">
2253
-
2254
- <li>
2255
-
2256
-
2257
- <span class='type'>(<tt>String</tt>)</span>
2258
-
2259
-
2260
-
2261
- &mdash;
2262
- <div class='inline'>
2263
- <p>the UUID of the office which the Agent is associated</p>
2264
- </div>
2265
-
2266
- </li>
2267
-
2268
- </ul>
2269
-
2270
- </div><table class="source_code">
2271
- <tr>
2272
- <td>
2273
- <pre class="lines">
2274
-
2275
-
2276
- 17
2277
- 18
2278
- 19</pre>
2279
- </td>
2280
- <td>
2281
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 17</span>
2282
-
2283
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_office_id'>moxi_works_office_id</span>
2284
- <span class='ivar'>@moxi_works_office_id</span>
2285
- <span class='kw'>end</span></pre>
2286
- </td>
2287
- </tr>
2288
- </table>
2289
- </div>
2290
-
2291
-
2292
- <span id="name=-instance_method"></span>
2293
- <div class="method_details ">
2294
- <h3 class="signature " id="name-instance_method">
2295
-
2296
- #<strong>name</strong> &#x21d2; <tt>String</tt>
2297
-
2298
-
2299
-
2300
-
2301
-
2302
- </h3><div class="docstring">
2303
- <div class="discussion">
2304
-
2305
- <p>Returns the agent&#39;s full name</p>
2306
-
2307
-
2308
- </div>
2309
- </div>
2310
- <div class="tags">
2311
-
2312
- <p class="tag_title">Returns:</p>
2313
- <ul class="return">
2314
-
2315
- <li>
2316
-
2317
-
2318
- <span class='type'>(<tt>String</tt>)</span>
2319
-
2320
-
2321
-
2322
- &mdash;
2323
- <div class='inline'>
2324
- <p>the agent&#39;s full name</p>
2325
- </div>
2326
-
2327
- </li>
2328
-
2329
- </ul>
2330
-
2331
- </div><table class="source_code">
2332
- <tr>
2333
- <td>
2334
- <pre class="lines">
2335
-
2336
-
2337
- 92
2338
- 93
2339
- 94</pre>
2340
- </td>
2341
- <td>
2342
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 92</span>
2343
-
2344
- <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
2345
- <span class='ivar'>@name</span>
2346
- <span class='kw'>end</span></pre>
2347
- </td>
2348
- </tr>
2349
- </table>
2350
- </div>
2351
-
2352
-
2353
- <span id="office_address_city=-instance_method"></span>
2354
- <div class="method_details ">
2355
- <h3 class="signature " id="office_address_city-instance_method">
2356
-
2357
- #<strong>office_address_city</strong> &#x21d2; <tt>String</tt>
2358
-
2359
-
2360
-
2361
-
2362
-
2363
- </h3><div class="docstring">
2364
- <div class="discussion">
2365
-
2366
- <p>Returns the agent&#39;s office address, city</p>
2367
-
2368
-
2369
- </div>
2370
- </div>
2371
- <div class="tags">
2372
-
2373
- <p class="tag_title">Returns:</p>
2374
- <ul class="return">
2375
-
2376
- <li>
2377
-
2378
-
2379
- <span class='type'>(<tt>String</tt>)</span>
2380
-
2381
-
2382
-
2383
- &mdash;
2384
- <div class='inline'>
2385
- <p>the agent&#39;s office address, city</p>
2386
- </div>
2387
-
2388
- </li>
2389
-
2390
- </ul>
2391
-
2392
- </div><table class="source_code">
2393
- <tr>
2394
- <td>
2395
- <pre class="lines">
2396
-
2397
-
2398
- 67
2399
- 68
2400
- 69</pre>
2401
- </td>
2402
- <td>
2403
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 67</span>
2404
-
2405
- <span class='kw'>def</span> <span class='id identifier rubyid_office_address_city'>office_address_city</span>
2406
- <span class='ivar'>@office_address_city</span>
2407
- <span class='kw'>end</span></pre>
2408
- </td>
2409
- </tr>
2410
- </table>
2411
- </div>
2412
-
2413
-
2414
- <span id="office_address_state=-instance_method"></span>
2415
- <div class="method_details ">
2416
- <h3 class="signature " id="office_address_state-instance_method">
2417
-
2418
- #<strong>office_address_state</strong> &#x21d2; <tt>String</tt>
2419
-
2420
-
2421
-
2422
-
2423
-
2424
- </h3><div class="docstring">
2425
- <div class="discussion">
2426
-
2427
- <p>Returns the agent&#39;s office address, state</p>
2428
-
2429
-
2430
- </div>
2431
- </div>
2432
- <div class="tags">
2433
-
2434
- <p class="tag_title">Returns:</p>
2435
- <ul class="return">
2436
-
2437
- <li>
2438
-
2439
-
2440
- <span class='type'>(<tt>String</tt>)</span>
2441
-
2442
-
2443
-
2444
- &mdash;
2445
- <div class='inline'>
2446
- <p>the agent&#39;s office address, state</p>
2447
- </div>
2448
-
2449
- </li>
2450
-
2451
- </ul>
2452
-
2453
- </div><table class="source_code">
2454
- <tr>
2455
- <td>
2456
- <pre class="lines">
2457
-
2458
-
2459
- 72
2460
- 73
2461
- 74</pre>
2462
- </td>
2463
- <td>
2464
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 72</span>
2465
-
2466
- <span class='kw'>def</span> <span class='id identifier rubyid_office_address_state'>office_address_state</span>
2467
- <span class='ivar'>@office_address_state</span>
2468
- <span class='kw'>end</span></pre>
2469
- </td>
2470
- </tr>
2471
- </table>
2472
- </div>
2473
-
2474
-
2475
- <span id="office_address_street=-instance_method"></span>
2476
- <div class="method_details ">
2477
- <h3 class="signature " id="office_address_street-instance_method">
2478
-
2479
- #<strong>office_address_street</strong> &#x21d2; <tt>String</tt>
2480
-
2481
-
2482
-
2483
-
2484
-
2485
- </h3><div class="docstring">
2486
- <div class="discussion">
2487
-
2488
- <p>Returns the agent&#39;s office address, street and number</p>
2489
-
2490
-
2491
- </div>
2492
- </div>
2493
- <div class="tags">
2494
-
2495
- <p class="tag_title">Returns:</p>
2496
- <ul class="return">
2497
-
2498
- <li>
2499
-
2500
-
2501
- <span class='type'>(<tt>String</tt>)</span>
2502
-
2503
-
2504
-
2505
- &mdash;
2506
- <div class='inline'>
2507
- <p>the agent&#39;s office address, street and number</p>
2508
- </div>
2509
-
2510
- </li>
2511
-
2512
- </ul>
2513
-
2514
- </div><table class="source_code">
2515
- <tr>
2516
- <td>
2517
- <pre class="lines">
2518
-
2519
-
2520
- 57
2521
- 58
2522
- 59</pre>
2523
- </td>
2524
- <td>
2525
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 57</span>
2526
-
2527
- <span class='kw'>def</span> <span class='id identifier rubyid_office_address_street'>office_address_street</span>
2528
- <span class='ivar'>@office_address_street</span>
2529
- <span class='kw'>end</span></pre>
2530
- </td>
2531
- </tr>
2532
- </table>
2533
- </div>
2534
-
2535
-
2536
- <span id="office_address_street2=-instance_method"></span>
2537
- <div class="method_details ">
2538
- <h3 class="signature " id="office_address_street2-instance_method">
2539
-
2540
- #<strong>office_address_street2</strong> &#x21d2; <tt>String</tt>
2541
-
2542
-
2543
-
2544
-
2545
-
2546
- </h3><div class="docstring">
2547
- <div class="discussion">
2548
-
2549
- <p>Returns the agent&#39;s office address, suite or office number</p>
2550
-
2551
-
2552
- </div>
2553
- </div>
2554
- <div class="tags">
2555
-
2556
- <p class="tag_title">Returns:</p>
2557
- <ul class="return">
2558
-
2559
- <li>
2560
-
2561
-
2562
- <span class='type'>(<tt>String</tt>)</span>
2563
-
2564
-
2565
-
2566
- &mdash;
2567
- <div class='inline'>
2568
- <p>the agent&#39;s office address, suite or office number</p>
2569
- </div>
2570
-
2571
- </li>
2572
-
2573
- </ul>
2574
-
2575
- </div><table class="source_code">
2576
- <tr>
2577
- <td>
2578
- <pre class="lines">
2579
-
2580
-
2581
- 62
2582
- 63
2583
- 64</pre>
2584
- </td>
2585
- <td>
2586
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 62</span>
2587
-
2588
- <span class='kw'>def</span> <span class='id identifier rubyid_office_address_street2'>office_address_street2</span>
2589
- <span class='ivar'>@office_address_street2</span>
2590
- <span class='kw'>end</span></pre>
2591
- </td>
2592
- </tr>
2593
- </table>
2594
- </div>
2595
-
2596
-
2597
- <span id="office_address_zip=-instance_method"></span>
2598
- <div class="method_details ">
2599
- <h3 class="signature " id="office_address_zip-instance_method">
2600
-
2601
- #<strong>office_address_zip</strong> &#x21d2; <tt>String</tt>
2602
-
2603
-
2604
-
2605
-
2606
-
2607
- </h3><div class="docstring">
2608
- <div class="discussion">
2609
-
2610
- <p>Returns the agent&#39;s office address, zip code</p>
2611
-
2612
-
2613
- </div>
2614
- </div>
2615
- <div class="tags">
2616
-
2617
- <p class="tag_title">Returns:</p>
2618
- <ul class="return">
2619
-
2620
- <li>
2621
-
2622
-
2623
- <span class='type'>(<tt>String</tt>)</span>
2624
-
2625
-
2626
-
2627
- &mdash;
2628
- <div class='inline'>
2629
- <p>the agent&#39;s office address, zip code</p>
2630
- </div>
2631
-
2632
- </li>
2633
-
2634
- </ul>
2635
-
2636
- </div><table class="source_code">
2637
- <tr>
2638
- <td>
2639
- <pre class="lines">
2640
-
2641
-
2642
- 77
2643
- 78
2644
- 79</pre>
2645
- </td>
2646
- <td>
2647
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 77</span>
2648
-
2649
- <span class='kw'>def</span> <span class='id identifier rubyid_office_address_zip'>office_address_zip</span>
2650
- <span class='ivar'>@office_address_zip</span>
2651
- <span class='kw'>end</span></pre>
2652
- </td>
2653
- </tr>
2654
- </table>
2655
- </div>
2656
-
2657
-
2658
- <span id="office_phone_number=-instance_method"></span>
2659
- <div class="method_details ">
2660
- <h3 class="signature " id="office_phone_number-instance_method">
2661
-
2662
- #<strong>office_phone_number</strong> &#x21d2; <tt>String</tt>
2663
-
2664
-
2665
-
2666
-
2667
-
2668
- </h3><div class="docstring">
2669
- <div class="discussion">
2670
-
2671
- <p>Returns the agent&#39;s office_phone number</p>
2672
-
2673
-
2674
- </div>
2675
- </div>
2676
- <div class="tags">
2677
-
2678
- <p class="tag_title">Returns:</p>
2679
- <ul class="return">
2680
-
2681
- <li>
2682
-
2683
-
2684
- <span class='type'>(<tt>String</tt>)</span>
2685
-
2686
-
2687
-
2688
- &mdash;
2689
- <div class='inline'>
2690
- <p>the agent&#39;s office_phone number</p>
2691
- </div>
2692
-
2693
- </li>
2694
-
2695
- </ul>
2696
-
2697
- </div><table class="source_code">
2698
- <tr>
2699
- <td>
2700
- <pre class="lines">
2701
-
2702
-
2703
- 112
2704
- 113
2705
- 114</pre>
2706
- </td>
2707
- <td>
2708
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 112</span>
2709
-
2710
- <span class='kw'>def</span> <span class='id identifier rubyid_office_phone_number'>office_phone_number</span>
2711
- <span class='ivar'>@office_phone_number</span>
2712
- <span class='kw'>end</span></pre>
2713
- </td>
2714
- </tr>
2715
- </table>
2716
- </div>
2717
-
2718
-
2719
- <span id="primary_email_address=-instance_method"></span>
2720
- <div class="method_details ">
2721
- <h3 class="signature " id="primary_email_address-instance_method">
2722
-
2723
- #<strong>primary_email_address</strong> &#x21d2; <tt>String</tt>
2724
-
2725
-
2726
-
2727
-
2728
-
2729
- </h3><div class="docstring">
2730
- <div class="discussion">
2731
-
2732
- <p>Returns the agent&#39;s primary email address</p>
2733
-
2734
-
2735
- </div>
2736
- </div>
2737
- <div class="tags">
2738
-
2739
- <p class="tag_title">Returns:</p>
2740
- <ul class="return">
2741
-
2742
- <li>
2743
-
2744
-
2745
- <span class='type'>(<tt>String</tt>)</span>
2746
-
2747
-
2748
-
2749
- &mdash;
2750
- <div class='inline'>
2751
- <p>the agent&#39;s primary email address</p>
2752
- </div>
2753
-
2754
- </li>
2755
-
2756
- </ul>
2757
-
2758
- </div><table class="source_code">
2759
- <tr>
2760
- <td>
2761
- <pre class="lines">
2762
-
2763
-
2764
- 117
2765
- 118
2766
- 119</pre>
2767
- </td>
2768
- <td>
2769
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 117</span>
2770
-
2771
- <span class='kw'>def</span> <span class='id identifier rubyid_primary_email_address'>primary_email_address</span>
2772
- <span class='ivar'>@primary_email_address</span>
2773
- <span class='kw'>end</span></pre>
2774
- </td>
2775
- </tr>
2776
- </table>
2777
- </div>
2778
-
2779
-
2780
- <span id="profile_image_url=-instance_method"></span>
2781
- <div class="method_details ">
2782
- <h3 class="signature " id="profile_image_url-instance_method">
2783
-
2784
- #<strong>profile_image_url</strong> &#x21d2; <tt>String</tt>
2785
-
2786
-
2787
-
2788
-
2789
-
2790
- </h3><div class="docstring">
2791
- <div class="discussion">
2792
-
2793
- <p>Returns url to a full size image of the agent</p>
2794
-
2795
-
2796
- </div>
2797
- </div>
2798
- <div class="tags">
2799
-
2800
- <p class="tag_title">Returns:</p>
2801
- <ul class="return">
2802
-
2803
- <li>
2804
-
2805
-
2806
- <span class='type'>(<tt>String</tt>)</span>
2807
-
2808
-
2809
-
2810
- &mdash;
2811
- <div class='inline'>
2812
- <p>url to a full size image of the agent</p>
2813
- </div>
2814
-
2815
- </li>
2816
-
2817
- </ul>
2818
-
2819
- </div><table class="source_code">
2820
- <tr>
2821
- <td>
2822
- <pre class="lines">
2823
-
2824
-
2825
- 147
2826
- 148
2827
- 149</pre>
2828
- </td>
2829
- <td>
2830
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 147</span>
2831
-
2832
- <span class='kw'>def</span> <span class='id identifier rubyid_profile_image_url'>profile_image_url</span>
2833
- <span class='ivar'>@profile_image_url</span>
2834
- <span class='kw'>end</span></pre>
2835
- </td>
2836
- </tr>
2837
- </table>
2838
- </div>
2839
-
2840
-
2841
- <span id="profile_thumb_url=-instance_method"></span>
2842
- <div class="method_details ">
2843
- <h3 class="signature " id="profile_thumb_url-instance_method">
2844
-
2845
- #<strong>profile_thumb_url</strong> &#x21d2; <tt>String</tt>
2846
-
2847
-
2848
-
2849
-
2850
-
2851
- </h3><div class="docstring">
2852
- <div class="discussion">
2853
-
2854
- <p>Returns url to a thumb size image of the agent</p>
2855
-
2856
-
2857
- </div>
2858
- </div>
2859
- <div class="tags">
2860
-
2861
- <p class="tag_title">Returns:</p>
2862
- <ul class="return">
2863
-
2864
- <li>
2865
-
2866
-
2867
- <span class='type'>(<tt>String</tt>)</span>
2868
-
2869
-
2870
-
2871
- &mdash;
2872
- <div class='inline'>
2873
- <p>url to a thumb size image of the agent</p>
2874
- </div>
2875
-
2876
- </li>
2877
-
2878
- </ul>
2879
-
2880
- </div><table class="source_code">
2881
- <tr>
2882
- <td>
2883
- <pre class="lines">
2884
-
2885
-
2886
- 152
2887
- 153
2888
- 154</pre>
2889
- </td>
2890
- <td>
2891
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 152</span>
2892
-
2893
- <span class='kw'>def</span> <span class='id identifier rubyid_profile_thumb_url'>profile_thumb_url</span>
2894
- <span class='ivar'>@profile_thumb_url</span>
2895
- <span class='kw'>end</span></pre>
2896
- </td>
2897
- </tr>
2898
- </table>
2899
- </div>
2900
-
2901
-
2902
- <span id="secondary_email_address=-instance_method"></span>
2903
- <div class="method_details ">
2904
- <h3 class="signature " id="secondary_email_address-instance_method">
2905
-
2906
- #<strong>secondary_email_address</strong> &#x21d2; <tt>String</tt>
2907
-
2908
-
2909
-
2910
-
2911
-
2912
- </h3><div class="docstring">
2913
- <div class="discussion">
2914
-
2915
- <p>Returns the agent&#39;s secondary email address</p>
2916
-
2917
-
2918
- </div>
2919
- </div>
2920
- <div class="tags">
2921
-
2922
- <p class="tag_title">Returns:</p>
2923
- <ul class="return">
2924
-
2925
- <li>
2926
-
2927
-
2928
- <span class='type'>(<tt>String</tt>)</span>
2929
-
2930
-
2931
-
2932
- &mdash;
2933
- <div class='inline'>
2934
- <p>the agent&#39;s secondary email address</p>
2935
- </div>
2936
-
2937
- </li>
2938
-
2939
- </ul>
2940
-
2941
- </div><table class="source_code">
2942
- <tr>
2943
- <td>
2944
- <pre class="lines">
2945
-
2946
-
2947
- 122
2948
- 123
2949
- 124</pre>
2950
- </td>
2951
- <td>
2952
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 122</span>
2953
-
2954
- <span class='kw'>def</span> <span class='id identifier rubyid_secondary_email_address'>secondary_email_address</span>
2955
- <span class='ivar'>@secondary_email_address</span>
2956
- <span class='kw'>end</span></pre>
2957
- </td>
2958
- </tr>
2959
- </table>
2960
- </div>
2961
-
2962
-
2963
- <span id="string the id of the agent used by the company of the agent=-instance_method"></span>
2964
- <div class="method_details ">
2965
- <h3 class="signature " id="string the id of the agent used by the company of the agent-instance_method">
2966
-
2967
- #<strong>string the id of the agent used by the company of the agent</strong>(theidoftheagentusedbythecompanyoftheagent) &#x21d2; <tt>Object</tt>
2968
-
2969
-
2970
-
2971
-
2972
-
2973
- </h3><table class="source_code">
2974
- <tr>
2975
- <td>
2976
- <pre class="lines">
2977
-
2978
-
2979
- </pre>
2980
- </td>
2981
- <td>
2982
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 19</span>
2983
-
2984
- </pre>
2985
- </td>
2986
- </tr>
2987
- </table>
2988
- </div>
2989
-
2990
-
2991
- <span id="string the id of the company used by the company of the agent=-instance_method"></span>
2992
- <div class="method_details ">
2993
- <h3 class="signature " id="string the id of the company used by the company of the agent-instance_method">
2994
-
2995
- #<strong>string the id of the company used by the company of the agent</strong>(theidofthecompanyusedbythecompanyoftheagent) &#x21d2; <tt>Object</tt>
2996
-
2997
-
2998
-
2999
-
3000
-
3001
- </h3><table class="source_code">
3002
- <tr>
3003
- <td>
3004
- <pre class="lines">
3005
-
3006
-
3007
- </pre>
3008
- </td>
3009
- <td>
3010
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 29</span>
3011
-
3012
- </pre>
3013
- </td>
3014
- </tr>
3015
- </table>
3016
- </div>
3017
-
3018
-
3019
- <span id="string the id office used by the company of the agent=-instance_method"></span>
3020
- <div class="method_details ">
3021
- <h3 class="signature " id="string the id office used by the company of the agent-instance_method">
3022
-
3023
- #<strong>string the id office used by the company of the agent</strong>(theidofficeusedbythecompanyoftheagent) &#x21d2; <tt>Object</tt>
3024
-
3025
-
3026
-
3027
-
3028
-
3029
- </h3><table class="source_code">
3030
- <tr>
3031
- <td>
3032
- <pre class="lines">
3033
-
3034
-
3035
- </pre>
3036
- </td>
3037
- <td>
3038
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 24</span>
3039
-
3040
- </pre>
3041
- </td>
3042
- </tr>
3043
- </table>
3044
- </div>
3045
-
3046
-
3047
- <span id="title=-instance_method"></span>
3048
- <div class="method_details ">
3049
- <h3 class="signature " id="title-instance_method">
3050
-
3051
- #<strong>title</strong> &#x21d2; <tt>String</tt>
3052
-
3053
-
3054
-
3055
-
3056
-
3057
- </h3><div class="docstring">
3058
- <div class="discussion">
3059
-
3060
- <p>Returns any business related titles associated with the agent</p>
3061
-
3062
-
3063
- </div>
3064
- </div>
3065
- <div class="tags">
3066
-
3067
- <p class="tag_title">Returns:</p>
3068
- <ul class="return">
3069
-
3070
- <li>
3071
-
3072
-
3073
- <span class='type'>(<tt>String</tt>)</span>
3074
-
3075
-
3076
-
3077
- &mdash;
3078
- <div class='inline'>
3079
- <p>any business related titles associated with the agent</p>
3080
- </div>
3081
-
3082
- </li>
3083
-
3084
- </ul>
3085
-
3086
- </div><table class="source_code">
3087
- <tr>
3088
- <td>
3089
- <pre class="lines">
3090
-
3091
-
3092
- 157
3093
- 158
3094
- 159</pre>
3095
- </td>
3096
- <td>
3097
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 157</span>
3098
-
3099
- <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
3100
- <span class='ivar'>@title</span>
3101
- <span class='kw'>end</span></pre>
3102
- </td>
3103
- </tr>
3104
- </table>
3105
- </div>
3106
-
3107
-
3108
- <span id="twitter=-instance_method"></span>
3109
- <div class="method_details ">
3110
- <h3 class="signature " id="twitter-instance_method">
3111
-
3112
- #<strong>twitter</strong> &#x21d2; <tt>String</tt>
3113
-
3114
-
3115
-
3116
-
3117
-
3118
- </h3><div class="docstring">
3119
- <div class="discussion">
3120
-
3121
- <p>Returns the agent&#39;s twitter handle</p>
3122
-
3123
-
3124
- </div>
3125
- </div>
3126
- <div class="tags">
3127
-
3128
- <p class="tag_title">Returns:</p>
3129
- <ul class="return">
3130
-
3131
- <li>
3132
-
3133
-
3134
- <span class='type'>(<tt>String</tt>)</span>
3135
-
3136
-
3137
-
3138
- &mdash;
3139
- <div class='inline'>
3140
- <p>the agent&#39;s twitter handle</p>
3141
- </div>
3142
-
3143
- </li>
3144
-
3145
- </ul>
3146
-
3147
- </div><table class="source_code">
3148
- <tr>
3149
- <td>
3150
- <pre class="lines">
3151
-
3152
-
3153
- 127
3154
- 128
3155
- 129</pre>
3156
- </td>
3157
- <td>
3158
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 127</span>
3159
-
3160
- <span class='kw'>def</span> <span class='id identifier rubyid_twitter'>twitter</span>
3161
- <span class='ivar'>@twitter</span>
3162
- <span class='kw'>end</span></pre>
3163
- </td>
3164
- </tr>
3165
- </table>
3166
- </div>
3167
-
3168
-
3169
- <span id="uuid=-instance_method"></span>
3170
- <div class="method_details ">
3171
- <h3 class="signature " id="uuid-instance_method">
3172
-
3173
- #<strong>uuid</strong> &#x21d2; <tt>String</tt>
3174
-
3175
-
3176
-
3177
-
3178
-
3179
- </h3><div class="docstring">
3180
- <div class="discussion">
3181
-
3182
- <p>identifier in determining associations between Agent objects and Listing
3183
- objects.</p>
3184
-
3185
-
3186
- </div>
3187
- </div>
3188
- <div class="tags">
3189
-
3190
- <p class="tag_title">Returns:</p>
3191
- <ul class="return">
3192
-
3193
- <li>
3194
-
3195
-
3196
- <span class='type'>(<tt>String</tt>)</span>
3197
-
3198
-
3199
-
3200
- &mdash;
3201
- <div class='inline'>
3202
- <p>UUID of the agent. Can be used as a unique</p>
3203
- </div>
3204
-
3205
- </li>
3206
-
3207
- </ul>
3208
-
3209
- </div><table class="source_code">
3210
- <tr>
3211
- <td>
3212
- <pre class="lines">
3213
-
3214
-
3215
- 164
3216
- 165
3217
- 166</pre>
3218
- </td>
3219
- <td>
3220
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 164</span>
3221
-
3222
- <span class='kw'>def</span> <span class='id identifier rubyid_uuid'>uuid</span>
3223
- <span class='ivar'>@uuid</span>
3224
- <span class='kw'>end</span></pre>
3225
- </td>
3226
- </tr>
3227
- </table>
3228
- </div>
3229
-
3230
- </div>
3231
-
3232
-
3233
- <div id="class_method_details" class="method_details_list">
3234
- <h2>Class Method Details</h2>
3235
-
3236
-
3237
- <div class="method_details first">
3238
- <h3 class="signature first" id="find-class_method">
3239
-
3240
- .<strong>find</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Agent (class)">MoxiworksPlatform::Agent</a></span></tt>
3241
-
3242
-
3243
-
3244
-
3245
-
3246
- </h3><div class="docstring">
3247
- <div class="discussion">
3248
-
3249
- <p>Find an Agent on the Moxi Works Platform</p>
3250
-
3251
-
3252
- </div>
3253
- </div>
3254
- <div class="tags">
3255
- <p class="tag_title">Parameters:</p>
3256
- <ul class="param">
3257
-
3258
- <li>
3259
-
3260
- <span class='name'>opts</span>
3261
-
3262
-
3263
- <span class='type'>(<tt>Hash</tt>)</span>
3264
-
3265
-
3266
- <em class="default">(defaults to: <tt>{}</tt>)</em>
3267
-
3268
-
3269
- &mdash;
3270
- <div class='inline'>
3271
- <p>named parameter Hash</p>
3272
- </div>
3273
-
3274
- </li>
3275
-
3276
- </ul>
3277
-
3278
-
3279
-
3280
-
3281
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
3282
- <ul class="option">
3283
-
3284
- <li>
3285
- <span class="name">:moxi_works_agent_id</span>
3286
- <span class="type">(<tt>String</tt>)</span>
3287
- <span class="default">
3288
-
3289
- </span>
3290
-
3291
- &mdash; <div class='inline'>
3292
- <p><strong>REQUIRED</strong> – either :moxi_works_agent_id or :agent_uuid is
3293
- required – The Moxi Works Agent ID for the agent</p>
3294
- </div>
3295
-
3296
- </li>
3297
-
3298
- <li>
3299
- <span class="name">:agent_uuid</span>
3300
- <span class="type">(<tt>String</tt>)</span>
3301
- <span class="default">
3302
-
3303
- </span>
3304
-
3305
- &mdash; <div class='inline'>
3306
- <p><strong>REQUIRED</strong> – either :moxi_works_agent_id or :agent_uuid is
3307
- required – The Moxi Works Agent ID for the agent</p>
3308
- </div>
3309
-
3310
- </li>
3311
-
3312
- </ul>
3313
-
3314
-
3315
- <p class="tag_title">Returns:</p>
3316
- <ul class="return">
3317
-
3318
- <li>
3319
-
3320
-
3321
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Agent (class)">MoxiworksPlatform::Agent</a></span></tt>)</span>
3322
-
3323
-
3324
-
3325
- </li>
3326
-
3327
- </ul>
3328
- <p class="tag_title">Raises:</p>
3329
- <ul class="raise">
3330
-
3331
- <li>
3332
-
3333
-
3334
- <span class='type'></span>
3335
-
3336
-
3337
-
3338
-
3339
- <div class='inline'>
3340
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
3341
- aren&#39;t included</p>
3342
- </div>
3343
-
3344
- </li>
3345
-
3346
- </ul>
3347
-
3348
- </div><table class="source_code">
3349
- <tr>
3350
- <td>
3351
- <pre class="lines">
3352
-
3353
-
3354
- 182
3355
- 183
3356
- 184
3357
- 185
3358
- 186
3359
- 187
3360
- 188
3361
- 189</pre>
3362
- </td>
3363
- <td>
3364
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 182</span>
3365
-
3366
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
3367
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
3368
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span> <span class='op'>||=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
3369
- <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#agent_uuid or moxi_works_agent_id required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
3370
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3371
- <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_identifier'>agent_identifier</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
3372
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
3373
- <span class='kw'>end</span></pre>
3374
- </td>
3375
- </tr>
3376
- </table>
3377
- </div>
3378
-
3379
- <div class="method_details ">
3380
- <h3 class="signature " id="search-class_method">
3381
-
3382
- .<strong>search</strong>(opts = {}) &#x21d2; <tt>Hash</tt>
3383
-
3384
-
3385
-
3386
-
3387
-
3388
- </h3><div class="docstring">
3389
- <div class="discussion">
3390
-
3391
- <p>Search For Agents in Moxi Works Platform</p>
3392
-
3393
-
3394
- </div>
3395
- </div>
3396
- <div class="tags">
3397
-
3398
- <div class="examples">
3399
- <p class="tag_title">Examples:</p>
3400
-
3401
-
3402
- <pre class="example code"><code><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Agent</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
3403
- <span class='label'>moxi_works_company_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>the_company</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
3404
- <span class='label'>updated_since:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>-</span> <span class='int'>1296000</span><span class='comma'>,</span>
3405
- <span class='label'>page_number:</span> <span class='int'>2</span>
3406
- <span class='rparen'>)</span></code></pre>
3407
-
3408
- </div>
3409
- <p class="tag_title">Parameters:</p>
3410
- <ul class="param">
3411
-
3412
- <li>
3413
-
3414
- <span class='name'>opts</span>
3415
-
3416
-
3417
- <span class='type'>(<tt>Hash</tt>)</span>
3418
-
3419
-
3420
- <em class="default">(defaults to: <tt>{}</tt>)</em>
3421
-
3422
-
3423
- &mdash;
3424
- <div class='inline'>
3425
- <p>named parameter Hash</p>
3426
- </div>
3427
-
3428
- </li>
3429
-
3430
- </ul>
3431
-
3432
-
3433
-
3434
-
3435
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
3436
- <ul class="option">
3437
-
3438
- <li>
3439
- <span class="name">:moxi_works_company_id</span>
3440
- <span class="type">(<tt>String</tt>)</span>
3441
- <span class="default">
3442
-
3443
- </span>
3444
-
3445
- &mdash; <div class='inline'>
3446
- <p><strong>REQUIRED</strong> The Moxi Works Company ID For the search (use
3447
- Company.search to determine available moxi_works_company_id)</p>
3448
- </div>
3449
-
3450
- </li>
3451
-
3452
- <li>
3453
- <span class="name">:updated_since</span>
3454
- <span class="type">(<tt>Integer</tt>)</span>
3455
- <span class="default">
3456
-
3457
- </span>
3458
-
3459
- &mdash; <div class='inline'>
3460
- <p><strong>REQUIRED</strong> Unix timestamp; Only Agents updated after this
3461
- date will be returned</p>
3462
-
3463
- <p>optional Search parameters</p>
3464
- </div>
3465
-
3466
- </li>
3467
-
3468
- <li>
3469
- <span class="name">:page_number</span>
3470
- <span class="type">(<tt>Integer</tt>)</span>
3471
- <span class="default">
3472
-
3473
- </span>
3474
-
3475
- &mdash; <div class='inline'>
3476
- <p>the page of results to return</p>
3477
- </div>
3478
-
3479
- </li>
3480
-
3481
- </ul>
3482
-
3483
-
3484
- <p class="tag_title">Returns:</p>
3485
- <ul class="return">
3486
-
3487
- <li>
3488
-
3489
-
3490
- <span class='type'>(<tt>Hash</tt>)</span>
3491
-
3492
-
3493
-
3494
- &mdash;
3495
- <div class='inline'>
3496
- <p>with the format:
3497
- <pre class="code ruby"><code class="ruby">page_number: [Integer],
3498
- total_pages: [Integer],
3499
- agents: [Array] containing MoxiworkPlatform::Agent objects</code></pre>
3500
-
3501
- <p></p>
3502
- </div>
3503
-
3504
- </li>
3505
-
3506
- </ul>
3507
- <p class="tag_title">Raises:</p>
3508
- <ul class="raise">
3509
-
3510
- <li>
3511
-
3512
-
3513
- <span class='type'></span>
3514
-
3515
-
3516
-
3517
-
3518
- <div class='inline'>
3519
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
3520
- aren&#39;t included</p>
3521
- </div>
3522
-
3523
- </li>
3524
-
3525
- </ul>
3526
-
3527
- </div><table class="source_code">
3528
- <tr>
3529
- <td>
3530
- <pre class="lines">
3531
-
3532
-
3533
- 231
3534
- 232
3535
- 233
3536
- 234
3537
- 235
3538
- 236
3539
- 237
3540
- 238
3541
- 239
3542
- 240
3543
- 241
3544
- 242
3545
- 243
3546
- 244
3547
- 245
3548
- 246
3549
- 247
3550
- 248
3551
- 249
3552
- 250
3553
- 251
3554
- 252
3555
- 253</pre>
3556
- </td>
3557
- <td>
3558
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 231</span>
3559
-
3560
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
3561
- <span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/agents</span><span class='tstring_end'>&quot;</span></span>
3562
- <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_company_id</span><span class='comma'>,</span> <span class='symbol'>:updated_since</span><span class='rbracket'>]</span>
3563
- <span class='id identifier rubyid_required_opts'>required_opts</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_opt'>opt</span><span class='op'>|</span>
3564
- <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'> required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
3565
- <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</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>
3566
- <span class='kw'>end</span>
3567
- <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiResponseArray</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
3568
- <span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>page_number</span><span class='label_end'>&#39;:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>total_pages</span><span class='label_end'>&#39;:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>agents</span><span class='label_end'>&#39;:</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
3569
- <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span>
3570
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
3571
- <span class='label'>payload:</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_response'>response</span><span class='op'>|</span>
3572
- <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_response'>response</span> <span class='kw'>if</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span>
3573
- <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span>
3574
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_for_error_in_response'>check_for_error_in_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3575
- <span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
3576
- <span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>agents</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</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>
3577
- <span class='id identifier rubyid_results'>results</span> <span class='op'>&lt;&lt;</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Agent</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
3578
- <span class='kw'>end</span>
3579
- <span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>agents</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span>
3580
- <span class='kw'>end</span>
3581
- <span class='id identifier rubyid_json'>json</span>
3582
- <span class='kw'>end</span></pre>
3583
- </td>
3584
- </tr>
3585
- </table>
3586
- </div>
3587
-
3588
- <div class="method_details ">
3589
- <h3 class="signature " id="send_request-class_method">
3590
-
3591
- .<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; <tt>Object</tt>
3592
-
3593
-
3594
-
3595
-
3596
-
3597
- </h3><div class="docstring">
3598
- <div class="discussion">
3599
-
3600
-
3601
- </div>
3602
- </div>
3603
- <div class="tags">
3604
-
3605
- <p class="tag_title">Raises:</p>
3606
- <ul class="raise">
3607
-
3608
- <li>
3609
-
3610
-
3611
- <span class='type'>(<tt><span class='object_link'><a href="Exception/ArgumentError.html" title="MoxiworksPlatform::Exception::ArgumentError (class)">::MoxiworksPlatform::Exception::ArgumentError</a></span></tt>)</span>
3612
-
3613
-
3614
-
3615
- </li>
3616
-
3617
- </ul>
3618
-
3619
- </div><table class="source_code">
3620
- <tr>
3621
- <td>
3622
- <pre class="lines">
3623
-
3624
-
3625
- 191
3626
- 192
3627
- 193
3628
- 194
3629
- 195
3630
- 196
3631
- 197
3632
- 198
3633
- 199
3634
- 200
3635
- 201</pre>
3636
- </td>
3637
- <td>
3638
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/agent.rb', line 191</span>
3639
-
3640
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
3641
- <span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/agents</span><span class='tstring_end'>&quot;</span></span>
3642
- <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_company_id</span><span class='rbracket'>]</span>
3643
- <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span>
3644
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>arguments must be passed as named parameters</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
3645
- <span class='id identifier rubyid_required_opts'>required_opts</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_opt'>opt</span><span class='op'>|</span>
3646
- <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'> required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
3647
- <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</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>
3648
- <span class='kw'>end</span>
3649
- <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
3650
- <span class='kw'>end</span></pre>
3651
- </td>
3652
- </tr>
3653
- </table>
3654
- </div>
3655
-
3656
- </div>
3657
-
3658
- </div>
3659
-
3660
- <div id="footer">
3661
- Generated on Fri Apr 20 10:00:16 2018 by
3662
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3663
- 0.9.5 (ruby-2.2.4).
3664
- </div>
3665
-
3666
- </div>
3667
- </body>
3668
- </html>