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,2144 +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::Office
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::Office";
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 (O)</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">Office</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::Office
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::Office</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/office.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+Office">Moxi Works Platform Office</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-instance_method" title="#address (instance method)">#<strong>address</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 office&#39;s address, street and number.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#address2-instance_method" title="#address2 (instance method)">#<strong>address2</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>Address cont.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#alt_phone-instance_method" title="#alt_phone (instance method)">#<strong>alt_phone</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 office&#39;s alternate phone number.</p>
200
- </div></span>
201
-
202
- </li>
203
-
204
-
205
- <li class="public ">
206
- <span class="summary_signature">
207
-
208
- <a href="#city-instance_method" title="#city (instance method)">#<strong>city</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 office&#39;s address, city.</p>
227
- </div></span>
228
-
229
- </li>
230
-
231
-
232
- <li class="public ">
233
- <span class="summary_signature">
234
-
235
- <a href="#county-instance_method" title="#county (instance method)">#<strong>county</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 office&#39;s address, county.</p>
254
- </div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#email-instance_method" title="#email (instance method)">#<strong>email</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 office&#39;s email address.</p>
281
- </div></span>
282
-
283
- </li>
284
-
285
-
286
- <li class="public ">
287
- <span class="summary_signature">
288
-
289
- <a href="#facebook-instance_method" title="#facebook (instance method)">#<strong>facebook</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 office&#39;s facebook page URL.</p>
308
- </div></span>
309
-
310
- </li>
311
-
312
-
313
- <li class="public ">
314
- <span class="summary_signature">
315
-
316
- <a href="#google_plus-instance_method" title="#google_plus (instance method)">#<strong>google_plus</strong> &#x21d2; String </a>
317
-
318
-
319
-
320
- </span>
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
- <span class="summary_desc"><div class='inline'>
334
- <p>The office&#39;s google_plus account.</p>
335
- </div></span>
336
-
337
- </li>
338
-
339
-
340
- <li class="public ">
341
- <span class="summary_signature">
342
-
343
- <a href="#image_url-instance_method" title="#image_url (instance method)">#<strong>image_url</strong> &#x21d2; String </a>
344
-
345
-
346
-
347
- </span>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
- <span class="summary_desc"><div class='inline'>
361
- <p>A URL to an image of the office.</p>
362
- </div></span>
363
-
364
- </li>
365
-
366
-
367
- <li class="public ">
368
- <span class="summary_signature">
369
-
370
- <a href="#moxi_works_office_id-instance_method" title="#moxi_works_office_id (instance method)">#<strong>moxi_works_office_id</strong> &#x21d2; String </a>
371
-
372
-
373
-
374
- </span>
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
- <span class="summary_desc"><div class='inline'>
388
- <p>The UUID of the office.</p>
389
- </div></span>
390
-
391
- </li>
392
-
393
-
394
- <li class="public ">
395
- <span class="summary_signature">
396
-
397
- <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
398
-
399
-
400
-
401
- </span>
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
- <span class="summary_desc"><div class='inline'>
415
- <p>The name of the office.</p>
416
- </div></span>
417
-
418
- </li>
419
-
420
-
421
- <li class="public ">
422
- <span class="summary_signature">
423
-
424
- <a href="#office_website-instance_method" title="#office_website (instance method)">#<strong>office_website</strong> &#x21d2; String </a>
425
-
426
-
427
-
428
- </span>
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- <span class="summary_desc"><div class='inline'>
442
- <p>Url of the office&#39;s website.</p>
443
- </div></span>
444
-
445
- </li>
446
-
447
-
448
- <li class="public ">
449
- <span class="summary_signature">
450
-
451
- <a href="#phone-instance_method" title="#phone (instance method)">#<strong>phone</strong> &#x21d2; String </a>
452
-
453
-
454
-
455
- </span>
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
- <span class="summary_desc"><div class='inline'>
469
- <p>The office&#39;s primary phone number.</p>
470
- </div></span>
471
-
472
- </li>
473
-
474
-
475
- <li class="public ">
476
- <span class="summary_signature">
477
-
478
- <a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> &#x21d2; String </a>
479
-
480
-
481
-
482
- </span>
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
- <span class="summary_desc"><div class='inline'>
496
- <p>The office&#39;s address, state.</p>
497
- </div></span>
498
-
499
- </li>
500
-
501
-
502
- <li class="public ">
503
- <span class="summary_signature">
504
-
505
- <a href="#timezone-instance_method" title="#timezone (instance method)">#<strong>timezone</strong> &#x21d2; String </a>
506
-
507
-
508
-
509
- </span>
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
- <span class="summary_desc"><div class='inline'>
523
- <p>The office&#39;s timezone.</p>
524
- </div></span>
525
-
526
- </li>
527
-
528
-
529
- <li class="public ">
530
- <span class="summary_signature">
531
-
532
- <a href="#twitter-instance_method" title="#twitter (instance method)">#<strong>twitter</strong> &#x21d2; String </a>
533
-
534
-
535
-
536
- </span>
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
- <span class="summary_desc"><div class='inline'>
550
- <p>The office&#39;s twitter handle.</p>
551
- </div></span>
552
-
553
- </li>
554
-
555
-
556
- <li class="public ">
557
- <span class="summary_signature">
558
-
559
- <a href="#zip_code-instance_method" title="#zip_code (instance method)">#<strong>zip_code</strong> &#x21d2; String </a>
560
-
561
-
562
-
563
- </span>
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
- <span class="summary_desc"><div class='inline'>
577
- <p>The office&#39;s address, zip code.</p>
578
- </div></span>
579
-
580
- </li>
581
-
582
-
583
- </ul>
584
-
585
-
586
-
587
-
588
-
589
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
590
- <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
591
-
592
-
593
-
594
- <h2>
595
- Class Method Summary
596
- <small><a href="#" class="summary_toggle">collapse</a></small>
597
- </h2>
598
-
599
- <ul class="summary">
600
-
601
- <li class="public ">
602
- <span class="summary_signature">
603
-
604
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Office </a>
605
-
606
-
607
-
608
- </span>
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
- <span class="summary_desc"><div class='inline'>
619
- <p>Find an Office on the Moxi Works Platform.</p>
620
- </div></span>
621
-
622
- </li>
623
-
624
-
625
- <li class="public ">
626
- <span class="summary_signature">
627
-
628
- <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Hash </a>
629
-
630
-
631
-
632
- </span>
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
- <span class="summary_desc"><div class='inline'>
643
- <p>Search For Offices in Moxi Works Platform.</p>
644
- </div></span>
645
-
646
- </li>
647
-
648
-
649
- <li class="public ">
650
- <span class="summary_signature">
651
-
652
- <a href="#send_request-class_method" title="send_request (class method)">.<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; Object </a>
653
-
654
-
655
-
656
- </span>
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
- <span class="summary_desc"><div class='inline'></div></span>
667
-
668
- </li>
669
-
670
-
671
- </ul>
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
684
- <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>
685
- <div id="constructor_details" class="method_details_list">
686
- <h2>Constructor Details</h2>
687
-
688
- <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>
689
-
690
- </div>
691
- <div id="method_missing_details" class="method_details_list">
692
- <h2>Dynamic Method Handling</h2>
693
- <p class="notice super">
694
- This class handles dynamic methods through the <tt>method_missing</tt> method
695
-
696
- 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>
697
-
698
- </p>
699
-
700
- </div>
701
-
702
- <div id="instance_attr_details" class="attr_details">
703
- <h2>Instance Attribute Details</h2>
704
-
705
-
706
- <span id="address=-instance_method"></span>
707
- <div class="method_details first">
708
- <h3 class="signature first" id="address-instance_method">
709
-
710
- #<strong>address</strong> &#x21d2; <tt>String</tt>
711
-
712
-
713
-
714
-
715
-
716
- </h3><div class="docstring">
717
- <div class="discussion">
718
-
719
- <p>Returns the office&#39;s address, street and number</p>
720
-
721
-
722
- </div>
723
- </div>
724
- <div class="tags">
725
-
726
- <p class="tag_title">Returns:</p>
727
- <ul class="return">
728
-
729
- <li>
730
-
731
-
732
- <span class='type'>(<tt>String</tt>)</span>
733
-
734
-
735
-
736
- &mdash;
737
- <div class='inline'>
738
- <p>the office&#39;s address, street and number</p>
739
- </div>
740
-
741
- </li>
742
-
743
- </ul>
744
-
745
- </div><table class="source_code">
746
- <tr>
747
- <td>
748
- <pre class="lines">
749
-
750
-
751
- 23
752
- 24
753
- 25</pre>
754
- </td>
755
- <td>
756
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 23</span>
757
-
758
- <span class='kw'>def</span> <span class='id identifier rubyid_address'>address</span>
759
- <span class='ivar'>@address</span>
760
- <span class='kw'>end</span></pre>
761
- </td>
762
- </tr>
763
- </table>
764
- </div>
765
-
766
-
767
- <span id="address2=-instance_method"></span>
768
- <div class="method_details ">
769
- <h3 class="signature " id="address2-instance_method">
770
-
771
- #<strong>address2</strong> &#x21d2; <tt>String</tt>
772
-
773
-
774
-
775
-
776
-
777
- </h3><div class="docstring">
778
- <div class="discussion">
779
-
780
- <p>Returns address cont. (ex. suite number)</p>
781
-
782
-
783
- </div>
784
- </div>
785
- <div class="tags">
786
-
787
- <p class="tag_title">Returns:</p>
788
- <ul class="return">
789
-
790
- <li>
791
-
792
-
793
- <span class='type'>(<tt>String</tt>)</span>
794
-
795
-
796
-
797
- &mdash;
798
- <div class='inline'>
799
- <p>address cont. (ex. suite number)</p>
800
- </div>
801
-
802
- </li>
803
-
804
- </ul>
805
-
806
- </div><table class="source_code">
807
- <tr>
808
- <td>
809
- <pre class="lines">
810
-
811
-
812
- 28
813
- 29
814
- 30</pre>
815
- </td>
816
- <td>
817
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 28</span>
818
-
819
- <span class='kw'>def</span> <span class='id identifier rubyid_address2'>address2</span>
820
- <span class='ivar'>@address2</span>
821
- <span class='kw'>end</span></pre>
822
- </td>
823
- </tr>
824
- </table>
825
- </div>
826
-
827
-
828
- <span id="alt_phone=-instance_method"></span>
829
- <div class="method_details ">
830
- <h3 class="signature " id="alt_phone-instance_method">
831
-
832
- #<strong>alt_phone</strong> &#x21d2; <tt>String</tt>
833
-
834
-
835
-
836
-
837
-
838
- </h3><div class="docstring">
839
- <div class="discussion">
840
-
841
- <p>Returns the office&#39;s alternate phone number</p>
842
-
843
-
844
- </div>
845
- </div>
846
- <div class="tags">
847
-
848
- <p class="tag_title">Returns:</p>
849
- <ul class="return">
850
-
851
- <li>
852
-
853
-
854
- <span class='type'>(<tt>String</tt>)</span>
855
-
856
-
857
-
858
- &mdash;
859
- <div class='inline'>
860
- <p>the office&#39;s alternate phone number</p>
861
- </div>
862
-
863
- </li>
864
-
865
- </ul>
866
-
867
- </div><table class="source_code">
868
- <tr>
869
- <td>
870
- <pre class="lines">
871
-
872
-
873
- 53
874
- 54
875
- 55</pre>
876
- </td>
877
- <td>
878
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 53</span>
879
-
880
- <span class='kw'>def</span> <span class='id identifier rubyid_alt_phone'>alt_phone</span>
881
- <span class='ivar'>@alt_phone</span>
882
- <span class='kw'>end</span></pre>
883
- </td>
884
- </tr>
885
- </table>
886
- </div>
887
-
888
-
889
- <span id="city=-instance_method"></span>
890
- <div class="method_details ">
891
- <h3 class="signature " id="city-instance_method">
892
-
893
- #<strong>city</strong> &#x21d2; <tt>String</tt>
894
-
895
-
896
-
897
-
898
-
899
- </h3><div class="docstring">
900
- <div class="discussion">
901
-
902
- <p>Returns the office&#39;s address, city</p>
903
-
904
-
905
- </div>
906
- </div>
907
- <div class="tags">
908
-
909
- <p class="tag_title">Returns:</p>
910
- <ul class="return">
911
-
912
- <li>
913
-
914
-
915
- <span class='type'>(<tt>String</tt>)</span>
916
-
917
-
918
-
919
- &mdash;
920
- <div class='inline'>
921
- <p>the office&#39;s address, city</p>
922
- </div>
923
-
924
- </li>
925
-
926
- </ul>
927
-
928
- </div><table class="source_code">
929
- <tr>
930
- <td>
931
- <pre class="lines">
932
-
933
-
934
- 33
935
- 34
936
- 35</pre>
937
- </td>
938
- <td>
939
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 33</span>
940
-
941
- <span class='kw'>def</span> <span class='id identifier rubyid_city'>city</span>
942
- <span class='ivar'>@city</span>
943
- <span class='kw'>end</span></pre>
944
- </td>
945
- </tr>
946
- </table>
947
- </div>
948
-
949
-
950
- <span id="county=-instance_method"></span>
951
- <div class="method_details ">
952
- <h3 class="signature " id="county-instance_method">
953
-
954
- #<strong>county</strong> &#x21d2; <tt>String</tt>
955
-
956
-
957
-
958
-
959
-
960
- </h3><div class="docstring">
961
- <div class="discussion">
962
-
963
- <p>Returns the office&#39;s address, county</p>
964
-
965
-
966
- </div>
967
- </div>
968
- <div class="tags">
969
-
970
- <p class="tag_title">Returns:</p>
971
- <ul class="return">
972
-
973
- <li>
974
-
975
-
976
- <span class='type'>(<tt>String</tt>)</span>
977
-
978
-
979
-
980
- &mdash;
981
- <div class='inline'>
982
- <p>the office&#39;s address, county</p>
983
- </div>
984
-
985
- </li>
986
-
987
- </ul>
988
-
989
- </div><table class="source_code">
990
- <tr>
991
- <td>
992
- <pre class="lines">
993
-
994
-
995
- 38
996
- 39
997
- 40</pre>
998
- </td>
999
- <td>
1000
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 38</span>
1001
-
1002
- <span class='kw'>def</span> <span class='id identifier rubyid_county'>county</span>
1003
- <span class='ivar'>@county</span>
1004
- <span class='kw'>end</span></pre>
1005
- </td>
1006
- </tr>
1007
- </table>
1008
- </div>
1009
-
1010
-
1011
- <span id="email=-instance_method"></span>
1012
- <div class="method_details ">
1013
- <h3 class="signature " id="email-instance_method">
1014
-
1015
- #<strong>email</strong> &#x21d2; <tt>String</tt>
1016
-
1017
-
1018
-
1019
-
1020
-
1021
- </h3><div class="docstring">
1022
- <div class="discussion">
1023
-
1024
- <p>Returns the office&#39;s email address</p>
1025
-
1026
-
1027
- </div>
1028
- </div>
1029
- <div class="tags">
1030
-
1031
- <p class="tag_title">Returns:</p>
1032
- <ul class="return">
1033
-
1034
- <li>
1035
-
1036
-
1037
- <span class='type'>(<tt>String</tt>)</span>
1038
-
1039
-
1040
-
1041
- &mdash;
1042
- <div class='inline'>
1043
- <p>the office&#39;s email address</p>
1044
- </div>
1045
-
1046
- </li>
1047
-
1048
- </ul>
1049
-
1050
- </div><table class="source_code">
1051
- <tr>
1052
- <td>
1053
- <pre class="lines">
1054
-
1055
-
1056
- 58
1057
- 59
1058
- 60</pre>
1059
- </td>
1060
- <td>
1061
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 58</span>
1062
-
1063
- <span class='kw'>def</span> <span class='id identifier rubyid_email'>email</span>
1064
- <span class='ivar'>@email</span>
1065
- <span class='kw'>end</span></pre>
1066
- </td>
1067
- </tr>
1068
- </table>
1069
- </div>
1070
-
1071
-
1072
- <span id="facebook=-instance_method"></span>
1073
- <div class="method_details ">
1074
- <h3 class="signature " id="facebook-instance_method">
1075
-
1076
- #<strong>facebook</strong> &#x21d2; <tt>String</tt>
1077
-
1078
-
1079
-
1080
-
1081
-
1082
- </h3><div class="docstring">
1083
- <div class="discussion">
1084
-
1085
- <p>Returns the office&#39;s facebook page URL</p>
1086
-
1087
-
1088
- </div>
1089
- </div>
1090
- <div class="tags">
1091
-
1092
- <p class="tag_title">Returns:</p>
1093
- <ul class="return">
1094
-
1095
- <li>
1096
-
1097
-
1098
- <span class='type'>(<tt>String</tt>)</span>
1099
-
1100
-
1101
-
1102
- &mdash;
1103
- <div class='inline'>
1104
- <p>the office&#39;s facebook page URL</p>
1105
- </div>
1106
-
1107
- </li>
1108
-
1109
- </ul>
1110
-
1111
- </div><table class="source_code">
1112
- <tr>
1113
- <td>
1114
- <pre class="lines">
1115
-
1116
-
1117
- 63
1118
- 64
1119
- 65</pre>
1120
- </td>
1121
- <td>
1122
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 63</span>
1123
-
1124
- <span class='kw'>def</span> <span class='id identifier rubyid_facebook'>facebook</span>
1125
- <span class='ivar'>@facebook</span>
1126
- <span class='kw'>end</span></pre>
1127
- </td>
1128
- </tr>
1129
- </table>
1130
- </div>
1131
-
1132
-
1133
- <span id="google_plus=-instance_method"></span>
1134
- <div class="method_details ">
1135
- <h3 class="signature " id="google_plus-instance_method">
1136
-
1137
- #<strong>google_plus</strong> &#x21d2; <tt>String</tt>
1138
-
1139
-
1140
-
1141
-
1142
-
1143
- </h3><div class="docstring">
1144
- <div class="discussion">
1145
-
1146
- <p>Returns the office&#39;s google_plus account</p>
1147
-
1148
-
1149
- </div>
1150
- </div>
1151
- <div class="tags">
1152
-
1153
- <p class="tag_title">Returns:</p>
1154
- <ul class="return">
1155
-
1156
- <li>
1157
-
1158
-
1159
- <span class='type'>(<tt>String</tt>)</span>
1160
-
1161
-
1162
-
1163
- &mdash;
1164
- <div class='inline'>
1165
- <p>the office&#39;s google_plus account</p>
1166
- </div>
1167
-
1168
- </li>
1169
-
1170
- </ul>
1171
-
1172
- </div><table class="source_code">
1173
- <tr>
1174
- <td>
1175
- <pre class="lines">
1176
-
1177
-
1178
- 68
1179
- 69
1180
- 70</pre>
1181
- </td>
1182
- <td>
1183
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 68</span>
1184
-
1185
- <span class='kw'>def</span> <span class='id identifier rubyid_google_plus'>google_plus</span>
1186
- <span class='ivar'>@google_plus</span>
1187
- <span class='kw'>end</span></pre>
1188
- </td>
1189
- </tr>
1190
- </table>
1191
- </div>
1192
-
1193
-
1194
- <span id="image_url=-instance_method"></span>
1195
- <div class="method_details ">
1196
- <h3 class="signature " id="image_url-instance_method">
1197
-
1198
- #<strong>image_url</strong> &#x21d2; <tt>String</tt>
1199
-
1200
-
1201
-
1202
-
1203
-
1204
- </h3><div class="docstring">
1205
- <div class="discussion">
1206
-
1207
- <p>Returns a URL to an image of the office.</p>
1208
-
1209
-
1210
- </div>
1211
- </div>
1212
- <div class="tags">
1213
-
1214
- <p class="tag_title">Returns:</p>
1215
- <ul class="return">
1216
-
1217
- <li>
1218
-
1219
-
1220
- <span class='type'>(<tt>String</tt>)</span>
1221
-
1222
-
1223
-
1224
- &mdash;
1225
- <div class='inline'>
1226
- <p>a URL to an image of the office.</p>
1227
- </div>
1228
-
1229
- </li>
1230
-
1231
- </ul>
1232
-
1233
- </div><table class="source_code">
1234
- <tr>
1235
- <td>
1236
- <pre class="lines">
1237
-
1238
-
1239
- 13
1240
- 14
1241
- 15</pre>
1242
- </td>
1243
- <td>
1244
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 13</span>
1245
-
1246
- <span class='kw'>def</span> <span class='id identifier rubyid_image_url'>image_url</span>
1247
- <span class='ivar'>@image_url</span>
1248
- <span class='kw'>end</span></pre>
1249
- </td>
1250
- </tr>
1251
- </table>
1252
- </div>
1253
-
1254
-
1255
- <span id="moxi_works_office_id=-instance_method"></span>
1256
- <div class="method_details ">
1257
- <h3 class="signature " id="moxi_works_office_id-instance_method">
1258
-
1259
- #<strong>moxi_works_office_id</strong> &#x21d2; <tt>String</tt>
1260
-
1261
-
1262
-
1263
-
1264
-
1265
- </h3><div class="docstring">
1266
- <div class="discussion">
1267
-
1268
- <p>Returns the UUID of the office</p>
1269
-
1270
-
1271
- </div>
1272
- </div>
1273
- <div class="tags">
1274
-
1275
- <p class="tag_title">Returns:</p>
1276
- <ul class="return">
1277
-
1278
- <li>
1279
-
1280
-
1281
- <span class='type'>(<tt>String</tt>)</span>
1282
-
1283
-
1284
-
1285
- &mdash;
1286
- <div class='inline'>
1287
- <p>the UUID of the office</p>
1288
- </div>
1289
-
1290
- </li>
1291
-
1292
- </ul>
1293
-
1294
- </div><table class="source_code">
1295
- <tr>
1296
- <td>
1297
- <pre class="lines">
1298
-
1299
-
1300
- 8
1301
- 9
1302
- 10</pre>
1303
- </td>
1304
- <td>
1305
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 8</span>
1306
-
1307
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_office_id'>moxi_works_office_id</span>
1308
- <span class='ivar'>@moxi_works_office_id</span>
1309
- <span class='kw'>end</span></pre>
1310
- </td>
1311
- </tr>
1312
- </table>
1313
- </div>
1314
-
1315
-
1316
- <span id="name=-instance_method"></span>
1317
- <div class="method_details ">
1318
- <h3 class="signature " id="name-instance_method">
1319
-
1320
- #<strong>name</strong> &#x21d2; <tt>String</tt>
1321
-
1322
-
1323
-
1324
-
1325
-
1326
- </h3><div class="docstring">
1327
- <div class="discussion">
1328
-
1329
- <p>Returns the name of the office</p>
1330
-
1331
-
1332
- </div>
1333
- </div>
1334
- <div class="tags">
1335
-
1336
- <p class="tag_title">Returns:</p>
1337
- <ul class="return">
1338
-
1339
- <li>
1340
-
1341
-
1342
- <span class='type'>(<tt>String</tt>)</span>
1343
-
1344
-
1345
-
1346
- &mdash;
1347
- <div class='inline'>
1348
- <p>the name of the office</p>
1349
- </div>
1350
-
1351
- </li>
1352
-
1353
- </ul>
1354
-
1355
- </div><table class="source_code">
1356
- <tr>
1357
- <td>
1358
- <pre class="lines">
1359
-
1360
-
1361
- 18
1362
- 19
1363
- 20</pre>
1364
- </td>
1365
- <td>
1366
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 18</span>
1367
-
1368
- <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
1369
- <span class='ivar'>@name</span>
1370
- <span class='kw'>end</span></pre>
1371
- </td>
1372
- </tr>
1373
- </table>
1374
- </div>
1375
-
1376
-
1377
- <span id="office_website=-instance_method"></span>
1378
- <div class="method_details ">
1379
- <h3 class="signature " id="office_website-instance_method">
1380
-
1381
- #<strong>office_website</strong> &#x21d2; <tt>String</tt>
1382
-
1383
-
1384
-
1385
-
1386
-
1387
- </h3><div class="docstring">
1388
- <div class="discussion">
1389
-
1390
- <p>Returns url of the office&#39;s website</p>
1391
-
1392
-
1393
- </div>
1394
- </div>
1395
- <div class="tags">
1396
-
1397
- <p class="tag_title">Returns:</p>
1398
- <ul class="return">
1399
-
1400
- <li>
1401
-
1402
-
1403
- <span class='type'>(<tt>String</tt>)</span>
1404
-
1405
-
1406
-
1407
- &mdash;
1408
- <div class='inline'>
1409
- <p>url of the office&#39;s website</p>
1410
- </div>
1411
-
1412
- </li>
1413
-
1414
- </ul>
1415
-
1416
- </div><table class="source_code">
1417
- <tr>
1418
- <td>
1419
- <pre class="lines">
1420
-
1421
-
1422
- 88
1423
- 89
1424
- 90</pre>
1425
- </td>
1426
- <td>
1427
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 88</span>
1428
-
1429
- <span class='kw'>def</span> <span class='id identifier rubyid_office_website'>office_website</span>
1430
- <span class='ivar'>@office_website</span>
1431
- <span class='kw'>end</span></pre>
1432
- </td>
1433
- </tr>
1434
- </table>
1435
- </div>
1436
-
1437
-
1438
- <span id="phone=-instance_method"></span>
1439
- <div class="method_details ">
1440
- <h3 class="signature " id="phone-instance_method">
1441
-
1442
- #<strong>phone</strong> &#x21d2; <tt>String</tt>
1443
-
1444
-
1445
-
1446
-
1447
-
1448
- </h3><div class="docstring">
1449
- <div class="discussion">
1450
-
1451
- <p>Returns the office&#39;s primary phone number</p>
1452
-
1453
-
1454
- </div>
1455
- </div>
1456
- <div class="tags">
1457
-
1458
- <p class="tag_title">Returns:</p>
1459
- <ul class="return">
1460
-
1461
- <li>
1462
-
1463
-
1464
- <span class='type'>(<tt>String</tt>)</span>
1465
-
1466
-
1467
-
1468
- &mdash;
1469
- <div class='inline'>
1470
- <p>the office&#39;s primary phone number</p>
1471
- </div>
1472
-
1473
- </li>
1474
-
1475
- </ul>
1476
-
1477
- </div><table class="source_code">
1478
- <tr>
1479
- <td>
1480
- <pre class="lines">
1481
-
1482
-
1483
- 73
1484
- 74
1485
- 75</pre>
1486
- </td>
1487
- <td>
1488
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 73</span>
1489
-
1490
- <span class='kw'>def</span> <span class='id identifier rubyid_phone'>phone</span>
1491
- <span class='ivar'>@phone</span>
1492
- <span class='kw'>end</span></pre>
1493
- </td>
1494
- </tr>
1495
- </table>
1496
- </div>
1497
-
1498
-
1499
- <span id="state=-instance_method"></span>
1500
- <div class="method_details ">
1501
- <h3 class="signature " id="state-instance_method">
1502
-
1503
- #<strong>state</strong> &#x21d2; <tt>String</tt>
1504
-
1505
-
1506
-
1507
-
1508
-
1509
- </h3><div class="docstring">
1510
- <div class="discussion">
1511
-
1512
- <p>Returns the office&#39;s address, state</p>
1513
-
1514
-
1515
- </div>
1516
- </div>
1517
- <div class="tags">
1518
-
1519
- <p class="tag_title">Returns:</p>
1520
- <ul class="return">
1521
-
1522
- <li>
1523
-
1524
-
1525
- <span class='type'>(<tt>String</tt>)</span>
1526
-
1527
-
1528
-
1529
- &mdash;
1530
- <div class='inline'>
1531
- <p>the office&#39;s address, state</p>
1532
- </div>
1533
-
1534
- </li>
1535
-
1536
- </ul>
1537
-
1538
- </div><table class="source_code">
1539
- <tr>
1540
- <td>
1541
- <pre class="lines">
1542
-
1543
-
1544
- 43
1545
- 44
1546
- 45</pre>
1547
- </td>
1548
- <td>
1549
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 43</span>
1550
-
1551
- <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
1552
- <span class='ivar'>@state</span>
1553
- <span class='kw'>end</span></pre>
1554
- </td>
1555
- </tr>
1556
- </table>
1557
- </div>
1558
-
1559
-
1560
- <span id="timezone=-instance_method"></span>
1561
- <div class="method_details ">
1562
- <h3 class="signature " id="timezone-instance_method">
1563
-
1564
- #<strong>timezone</strong> &#x21d2; <tt>String</tt>
1565
-
1566
-
1567
-
1568
-
1569
-
1570
- </h3><div class="docstring">
1571
- <div class="discussion">
1572
-
1573
- <p>Returns the office&#39;s timezone</p>
1574
-
1575
-
1576
- </div>
1577
- </div>
1578
- <div class="tags">
1579
-
1580
- <p class="tag_title">Returns:</p>
1581
- <ul class="return">
1582
-
1583
- <li>
1584
-
1585
-
1586
- <span class='type'>(<tt>String</tt>)</span>
1587
-
1588
-
1589
-
1590
- &mdash;
1591
- <div class='inline'>
1592
- <p>the office&#39;s timezone</p>
1593
- </div>
1594
-
1595
- </li>
1596
-
1597
- </ul>
1598
-
1599
- </div><table class="source_code">
1600
- <tr>
1601
- <td>
1602
- <pre class="lines">
1603
-
1604
-
1605
- 78
1606
- 79
1607
- 80</pre>
1608
- </td>
1609
- <td>
1610
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 78</span>
1611
-
1612
- <span class='kw'>def</span> <span class='id identifier rubyid_timezone'>timezone</span>
1613
- <span class='ivar'>@timezone</span>
1614
- <span class='kw'>end</span></pre>
1615
- </td>
1616
- </tr>
1617
- </table>
1618
- </div>
1619
-
1620
-
1621
- <span id="twitter=-instance_method"></span>
1622
- <div class="method_details ">
1623
- <h3 class="signature " id="twitter-instance_method">
1624
-
1625
- #<strong>twitter</strong> &#x21d2; <tt>String</tt>
1626
-
1627
-
1628
-
1629
-
1630
-
1631
- </h3><div class="docstring">
1632
- <div class="discussion">
1633
-
1634
- <p>Returns the office&#39;s twitter handle</p>
1635
-
1636
-
1637
- </div>
1638
- </div>
1639
- <div class="tags">
1640
-
1641
- <p class="tag_title">Returns:</p>
1642
- <ul class="return">
1643
-
1644
- <li>
1645
-
1646
-
1647
- <span class='type'>(<tt>String</tt>)</span>
1648
-
1649
-
1650
-
1651
- &mdash;
1652
- <div class='inline'>
1653
- <p>the office&#39;s twitter handle</p>
1654
- </div>
1655
-
1656
- </li>
1657
-
1658
- </ul>
1659
-
1660
- </div><table class="source_code">
1661
- <tr>
1662
- <td>
1663
- <pre class="lines">
1664
-
1665
-
1666
- 83
1667
- 84
1668
- 85</pre>
1669
- </td>
1670
- <td>
1671
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 83</span>
1672
-
1673
- <span class='kw'>def</span> <span class='id identifier rubyid_twitter'>twitter</span>
1674
- <span class='ivar'>@twitter</span>
1675
- <span class='kw'>end</span></pre>
1676
- </td>
1677
- </tr>
1678
- </table>
1679
- </div>
1680
-
1681
-
1682
- <span id="zip_code=-instance_method"></span>
1683
- <div class="method_details ">
1684
- <h3 class="signature " id="zip_code-instance_method">
1685
-
1686
- #<strong>zip_code</strong> &#x21d2; <tt>String</tt>
1687
-
1688
-
1689
-
1690
-
1691
-
1692
- </h3><div class="docstring">
1693
- <div class="discussion">
1694
-
1695
- <p>Returns the office&#39;s address, zip code</p>
1696
-
1697
-
1698
- </div>
1699
- </div>
1700
- <div class="tags">
1701
-
1702
- <p class="tag_title">Returns:</p>
1703
- <ul class="return">
1704
-
1705
- <li>
1706
-
1707
-
1708
- <span class='type'>(<tt>String</tt>)</span>
1709
-
1710
-
1711
-
1712
- &mdash;
1713
- <div class='inline'>
1714
- <p>the office&#39;s address, zip code</p>
1715
- </div>
1716
-
1717
- </li>
1718
-
1719
- </ul>
1720
-
1721
- </div><table class="source_code">
1722
- <tr>
1723
- <td>
1724
- <pre class="lines">
1725
-
1726
-
1727
- 48
1728
- 49
1729
- 50</pre>
1730
- </td>
1731
- <td>
1732
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 48</span>
1733
-
1734
- <span class='kw'>def</span> <span class='id identifier rubyid_zip_code'>zip_code</span>
1735
- <span class='ivar'>@zip_code</span>
1736
- <span class='kw'>end</span></pre>
1737
- </td>
1738
- </tr>
1739
- </table>
1740
- </div>
1741
-
1742
- </div>
1743
-
1744
-
1745
- <div id="class_method_details" class="method_details_list">
1746
- <h2>Class Method Details</h2>
1747
-
1748
-
1749
- <div class="method_details first">
1750
- <h3 class="signature first" id="find-class_method">
1751
-
1752
- .<strong>find</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Office (class)">MoxiworksPlatform::Office</a></span></tt>
1753
-
1754
-
1755
-
1756
-
1757
-
1758
- </h3><div class="docstring">
1759
- <div class="discussion">
1760
-
1761
- <p>Find an Office on the Moxi Works Platform</p>
1762
-
1763
-
1764
- </div>
1765
- </div>
1766
- <div class="tags">
1767
- <p class="tag_title">Parameters:</p>
1768
- <ul class="param">
1769
-
1770
- <li>
1771
-
1772
- <span class='name'>opts</span>
1773
-
1774
-
1775
- <span class='type'>(<tt>Hash</tt>)</span>
1776
-
1777
-
1778
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1779
-
1780
-
1781
- &mdash;
1782
- <div class='inline'>
1783
- <p>named parameter Hash</p>
1784
- </div>
1785
-
1786
- </li>
1787
-
1788
- </ul>
1789
-
1790
-
1791
-
1792
-
1793
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1794
- <ul class="option">
1795
-
1796
- <li>
1797
- <span class="name">:moxi_works_office_id</span>
1798
- <span class="type">(<tt>String</tt>)</span>
1799
- <span class="default">
1800
-
1801
- </span>
1802
-
1803
- &mdash; <div class='inline'>
1804
- <p><strong>REQUIRED</strong> The Moxi Works Office ID for the office</p>
1805
- </div>
1806
-
1807
- </li>
1808
-
1809
- </ul>
1810
-
1811
-
1812
- <p class="tag_title">Returns:</p>
1813
- <ul class="return">
1814
-
1815
- <li>
1816
-
1817
-
1818
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Office (class)">MoxiworksPlatform::Office</a></span></tt>)</span>
1819
-
1820
-
1821
-
1822
- </li>
1823
-
1824
- </ul>
1825
- <p class="tag_title">Raises:</p>
1826
- <ul class="raise">
1827
-
1828
- <li>
1829
-
1830
-
1831
- <span class='type'></span>
1832
-
1833
-
1834
-
1835
-
1836
- <div class='inline'>
1837
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
1838
- aren&#39;t included</p>
1839
- </div>
1840
-
1841
- </li>
1842
-
1843
- </ul>
1844
-
1845
- </div><table class="source_code">
1846
- <tr>
1847
- <td>
1848
- <pre class="lines">
1849
-
1850
-
1851
- 100
1852
- 101
1853
- 102
1854
- 103</pre>
1855
- </td>
1856
- <td>
1857
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 100</span>
1858
-
1859
- <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>
1860
- <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/offices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_office_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1861
- <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>
1862
- <span class='kw'>end</span></pre>
1863
- </td>
1864
- </tr>
1865
- </table>
1866
- </div>
1867
-
1868
- <div class="method_details ">
1869
- <h3 class="signature " id="search-class_method">
1870
-
1871
- .<strong>search</strong>(opts = {}) &#x21d2; <tt>Hash</tt>
1872
-
1873
-
1874
-
1875
-
1876
-
1877
- </h3><div class="docstring">
1878
- <div class="discussion">
1879
-
1880
- <p>Search For Offices in Moxi Works Platform</p>
1881
-
1882
-
1883
- </div>
1884
- </div>
1885
- <div class="tags">
1886
-
1887
- <div class="examples">
1888
- <p class="tag_title">Examples:</p>
1889
-
1890
-
1891
- <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'>Office</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
1892
- <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>
1893
- <span class='label'>page_number:</span> <span class='int'>2</span>
1894
- <span class='rparen'>)</span></code></pre>
1895
-
1896
- </div>
1897
- <p class="tag_title">Parameters:</p>
1898
- <ul class="param">
1899
-
1900
- <li>
1901
-
1902
- <span class='name'>opts</span>
1903
-
1904
-
1905
- <span class='type'>(<tt>Hash</tt>)</span>
1906
-
1907
-
1908
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1909
-
1910
-
1911
- &mdash;
1912
- <div class='inline'>
1913
- <p>named parameter Hash</p>
1914
- </div>
1915
-
1916
- </li>
1917
-
1918
- </ul>
1919
-
1920
-
1921
-
1922
-
1923
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1924
- <ul class="option">
1925
-
1926
- <li>
1927
- <span class="name">:moxi_works_company_id</span>
1928
- <span class="type">(<tt>String</tt>)</span>
1929
- <span class="default">
1930
-
1931
- </span>
1932
-
1933
- &mdash; <div class='inline'>
1934
- <p><strong>REQUIRED</strong> The Moxi Works Company ID For the search (use
1935
- Company.search to determine available moxi_works_company_id)</p>
1936
-
1937
- <p>optional Search parameters</p>
1938
- </div>
1939
-
1940
- </li>
1941
-
1942
- <li>
1943
- <span class="name">:page_number</span>
1944
- <span class="type">(<tt>Integer</tt>)</span>
1945
- <span class="default">
1946
-
1947
- </span>
1948
-
1949
- &mdash; <div class='inline'>
1950
- <p>the page of results to return</p>
1951
- </div>
1952
-
1953
- </li>
1954
-
1955
- </ul>
1956
-
1957
-
1958
- <p class="tag_title">Returns:</p>
1959
- <ul class="return">
1960
-
1961
- <li>
1962
-
1963
-
1964
- <span class='type'>(<tt>Hash</tt>)</span>
1965
-
1966
-
1967
-
1968
- &mdash;
1969
- <div class='inline'>
1970
- <p>with the format:
1971
- <pre class="code ruby"><code class="ruby">page_number: [Integer],
1972
- total_pages: [Integer],
1973
- offices: [Array] containing MoxiworkPlatform::Office objects</code></pre>
1974
-
1975
- <p></p>
1976
- </div>
1977
-
1978
- </li>
1979
-
1980
- </ul>
1981
- <p class="tag_title">Raises:</p>
1982
- <ul class="raise">
1983
-
1984
- <li>
1985
-
1986
-
1987
- <span class='type'></span>
1988
-
1989
-
1990
-
1991
-
1992
- <div class='inline'>
1993
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
1994
- aren&#39;t included</p>
1995
- </div>
1996
-
1997
- </li>
1998
-
1999
- </ul>
2000
-
2001
- </div><table class="source_code">
2002
- <tr>
2003
- <td>
2004
- <pre class="lines">
2005
-
2006
-
2007
- 143
2008
- 144
2009
- 145
2010
- 146
2011
- 147
2012
- 148
2013
- 149
2014
- 150
2015
- 151
2016
- 152
2017
- 153
2018
- 154
2019
- 155
2020
- 156
2021
- 157
2022
- 158
2023
- 159
2024
- 160
2025
- 161
2026
- 162
2027
- 163
2028
- 164
2029
- 165
2030
- 166</pre>
2031
- </td>
2032
- <td>
2033
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 143</span>
2034
-
2035
- <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>
2036
- <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/offices</span><span class='tstring_end'>&quot;</span></span>
2037
- <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>
2038
- <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>
2039
- <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>
2040
- <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>
2041
- <span class='kw'>end</span>
2042
- <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>
2043
- <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'>offices</span><span class='label_end'>&#39;:</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
2044
- <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>
2045
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
2046
- <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>
2047
- <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>
2048
- <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>
2049
- <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>
2050
-
2051
- <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>
2052
- <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'>offices</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>
2053
- <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'>Office</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>
2054
- <span class='kw'>end</span>
2055
- <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'>offices</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span>
2056
- <span class='kw'>end</span>
2057
- <span class='id identifier rubyid_json'>json</span>
2058
- <span class='kw'>end</span></pre>
2059
- </td>
2060
- </tr>
2061
- </table>
2062
- </div>
2063
-
2064
- <div class="method_details ">
2065
- <h3 class="signature " id="send_request-class_method">
2066
-
2067
- .<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; <tt>Object</tt>
2068
-
2069
-
2070
-
2071
-
2072
-
2073
- </h3><div class="docstring">
2074
- <div class="discussion">
2075
-
2076
-
2077
- </div>
2078
- </div>
2079
- <div class="tags">
2080
-
2081
- <p class="tag_title">Raises:</p>
2082
- <ul class="raise">
2083
-
2084
- <li>
2085
-
2086
-
2087
- <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>
2088
-
2089
-
2090
-
2091
- </li>
2092
-
2093
- </ul>
2094
-
2095
- </div><table class="source_code">
2096
- <tr>
2097
- <td>
2098
- <pre class="lines">
2099
-
2100
-
2101
- 105
2102
- 106
2103
- 107
2104
- 108
2105
- 109
2106
- 110
2107
- 111
2108
- 112
2109
- 113
2110
- 114
2111
- 115</pre>
2112
- </td>
2113
- <td>
2114
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/office.rb', line 105</span>
2115
-
2116
- <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>
2117
- <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/offices</span><span class='tstring_end'>&quot;</span></span>
2118
- <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_office_id</span><span class='rbracket'>]</span>
2119
- <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>
2120
- <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>
2121
- <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>
2122
- <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>
2123
- <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>
2124
- <span class='kw'>end</span>
2125
- <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>
2126
- <span class='kw'>end</span></pre>
2127
- </td>
2128
- </tr>
2129
- </table>
2130
- </div>
2131
-
2132
- </div>
2133
-
2134
- </div>
2135
-
2136
- <div id="footer">
2137
- Generated on Fri Apr 20 10:00:17 2018 by
2138
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2139
- 0.9.5 (ruby-2.2.4).
2140
- </div>
2141
-
2142
- </div>
2143
- </body>
2144
- </html>