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
data/MoxiworksPlatform/Company.html DELETED
@@ -1,678 +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::Company
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::Company";
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 (C)</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">Company</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::Company
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::Company</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/company.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+Company">Moxi Works Platform Company</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="#moxi_works_company_id-instance_method" title="#moxi_works_company_id (instance method)">#<strong>moxi_works_company_id</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>moxi_works_company_id is the Moxi Works Platform ID of the company.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#name-instance_method" title="#name (instance method)">#<strong>name</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 human readable name of this Company.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- </ul>
179
-
180
-
181
-
182
-
183
-
184
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
185
- <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
186
-
187
-
188
-
189
- <h2>
190
- Class Method Summary
191
- <small><a href="#" class="summary_toggle">collapse</a></small>
192
- </h2>
193
-
194
- <ul class="summary">
195
-
196
- <li class="public ">
197
- <span class="summary_signature">
198
-
199
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Company </a>
200
-
201
-
202
-
203
- </span>
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
- <span class="summary_desc"><div class='inline'>
214
- <p>Find a Company by ID in Moxi Works Platform.</p>
215
- </div></span>
216
-
217
- </li>
218
-
219
-
220
- <li class="public ">
221
- <span class="summary_signature">
222
-
223
- <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Array </a>
224
-
225
-
226
-
227
- </span>
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
- <span class="summary_desc"><div class='inline'>
238
- <p>Show all my Companies in Moxi Works Platform.</p>
239
- </div></span>
240
-
241
- </li>
242
-
243
-
244
- </ul>
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
257
- <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#send_request-class_method" title="MoxiworksPlatform::Resource.send_request (method)">send_request</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>
258
- <div id="constructor_details" class="method_details_list">
259
- <h2>Constructor Details</h2>
260
-
261
- <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>
262
-
263
- </div>
264
- <div id="method_missing_details" class="method_details_list">
265
- <h2>Dynamic Method Handling</h2>
266
- <p class="notice super">
267
- This class handles dynamic methods through the <tt>method_missing</tt> method
268
-
269
- 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>
270
-
271
- </p>
272
-
273
- </div>
274
-
275
- <div id="instance_attr_details" class="attr_details">
276
- <h2>Instance Attribute Details</h2>
277
-
278
-
279
- <span id="moxi_works_company_id=-instance_method"></span>
280
- <div class="method_details first">
281
- <h3 class="signature first" id="moxi_works_company_id-instance_method">
282
-
283
- #<strong>moxi_works_company_id</strong> &#x21d2; <tt>String</tt>
284
-
285
-
286
-
287
-
288
-
289
- </h3><div class="docstring">
290
- <div class="discussion">
291
-
292
- <p>moxi_works_company_id is the Moxi Works Platform ID of the company</p>
293
-
294
-
295
- </div>
296
- </div>
297
- <div class="tags">
298
-
299
- <p class="tag_title">Returns:</p>
300
- <ul class="return">
301
-
302
- <li>
303
-
304
-
305
- <span class='type'>(<tt>String</tt>)</span>
306
-
307
-
308
-
309
- &mdash;
310
- <div class='inline'>
311
- <p>the Moxi Works Platform ID of the company</p>
312
- </div>
313
-
314
- </li>
315
-
316
- </ul>
317
-
318
- </div><table class="source_code">
319
- <tr>
320
- <td>
321
- <pre class="lines">
322
-
323
-
324
- 9
325
- 10
326
- 11</pre>
327
- </td>
328
- <td>
329
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/company.rb', line 9</span>
330
-
331
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_company_id'>moxi_works_company_id</span>
332
- <span class='ivar'>@moxi_works_company_id</span>
333
- <span class='kw'>end</span></pre>
334
- </td>
335
- </tr>
336
- </table>
337
- </div>
338
-
339
-
340
- <span id="name=-instance_method"></span>
341
- <div class="method_details ">
342
- <h3 class="signature " id="name-instance_method">
343
-
344
- #<strong>name</strong> &#x21d2; <tt>String</tt>
345
-
346
-
347
-
348
-
349
-
350
- </h3><div class="docstring">
351
- <div class="discussion">
352
-
353
- <p>the human readable name of this Company</p>
354
-
355
-
356
- </div>
357
- </div>
358
- <div class="tags">
359
-
360
- <p class="tag_title">Returns:</p>
361
- <ul class="return">
362
-
363
- <li>
364
-
365
-
366
- <span class='type'>(<tt>String</tt>)</span>
367
-
368
-
369
-
370
- &mdash;
371
- <div class='inline'>
372
- <p>the human readable name of the company</p>
373
- </div>
374
-
375
- </li>
376
-
377
- </ul>
378
-
379
- </div><table class="source_code">
380
- <tr>
381
- <td>
382
- <pre class="lines">
383
-
384
-
385
- 15
386
- 16
387
- 17</pre>
388
- </td>
389
- <td>
390
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/company.rb', line 15</span>
391
-
392
- <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
393
- <span class='ivar'>@name</span>
394
- <span class='kw'>end</span></pre>
395
- </td>
396
- </tr>
397
- </table>
398
- </div>
399
-
400
- </div>
401
-
402
-
403
- <div id="class_method_details" class="method_details_list">
404
- <h2>Class Method Details</h2>
405
-
406
-
407
- <div class="method_details first">
408
- <h3 class="signature first" id="find-class_method">
409
-
410
- .<strong>find</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Company (class)">MoxiworksPlatform::Company</a></span></tt>
411
-
412
-
413
-
414
-
415
-
416
- </h3><div class="docstring">
417
- <div class="discussion">
418
-
419
- <p>Find a Company by ID in Moxi Works Platform</p>
420
-
421
-
422
- </div>
423
- </div>
424
- <div class="tags">
425
- <p class="tag_title">Parameters:</p>
426
- <ul class="param">
427
-
428
- <li>
429
-
430
- <span class='name'>opts</span>
431
-
432
-
433
- <span class='type'>(<tt>Hash</tt>)</span>
434
-
435
-
436
- <em class="default">(defaults to: <tt>{}</tt>)</em>
437
-
438
-
439
- &mdash;
440
- <div class='inline'>
441
- <p>named parameter Hash</p>
442
- </div>
443
-
444
- </li>
445
-
446
- </ul>
447
-
448
-
449
-
450
-
451
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
452
- <ul class="option">
453
-
454
- <li>
455
- <span class="name">:moxi_works_company_id</span>
456
- <span class="type">(<tt>String</tt>)</span>
457
- <span class="default">
458
-
459
- </span>
460
-
461
- &mdash; <div class='inline'>
462
- <p><strong>REQUIRED</strong> The Moxi Works Company ID</p>
463
- </div>
464
-
465
- </li>
466
-
467
- </ul>
468
-
469
-
470
- <p class="tag_title">Returns:</p>
471
- <ul class="return">
472
-
473
- <li>
474
-
475
-
476
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Company (class)">MoxiworksPlatform::Company</a></span></tt>)</span>
477
-
478
-
479
-
480
- </li>
481
-
482
- </ul>
483
- <p class="tag_title">Raises:</p>
484
- <ul class="raise">
485
-
486
- <li>
487
-
488
-
489
- <span class='type'></span>
490
-
491
-
492
-
493
-
494
- <div class='inline'>
495
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
496
- aren&#39;t included</p>
497
- </div>
498
-
499
- </li>
500
-
501
- </ul>
502
-
503
- </div><table class="source_code">
504
- <tr>
505
- <td>
506
- <pre class="lines">
507
-
508
-
509
- 26
510
- 27
511
- 28
512
- 29
513
- 30
514
- 31
515
- 32
516
- 33
517
- 34
518
- 35
519
- 36</pre>
520
- </td>
521
- <td>
522
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/company.rb', line 26</span>
523
-
524
- <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>
525
- <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>
526
- <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>
527
- <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>
528
- <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>
529
- <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>
530
- <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>
531
- <span class='kw'>end</span>
532
- <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/companies/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_company_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
533
- <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>
534
- <span class='kw'>end</span></pre>
535
- </td>
536
- </tr>
537
- </table>
538
- </div>
539
-
540
- <div class="method_details ">
541
- <h3 class="signature " id="search-class_method">
542
-
543
- .<strong>search</strong>(opts = {}) &#x21d2; <tt>Array</tt>
544
-
545
-
546
-
547
-
548
-
549
- </h3><div class="docstring">
550
- <div class="discussion">
551
-
552
- <p>Show all my Companies in Moxi Works Platform</p>
553
-
554
-
555
- </div>
556
- </div>
557
- <div class="tags">
558
-
559
- <div class="examples">
560
- <p class="tag_title">Examples:</p>
561
-
562
-
563
- <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'>Companies</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span></code></pre>
564
-
565
- </div>
566
-
567
- <p class="tag_title">Returns:</p>
568
- <ul class="return">
569
-
570
- <li>
571
-
572
-
573
- <span class='type'>(<tt>Array</tt>)</span>
574
-
575
-
576
-
577
- &mdash;
578
- <div class='inline'>
579
- <p>containing MoxiworksPlatform::Companies objects</p>
580
- </div>
581
-
582
- </li>
583
-
584
- </ul>
585
- <p class="tag_title">Raises:</p>
586
- <ul class="raise">
587
-
588
- <li>
589
-
590
-
591
- <span class='type'></span>
592
-
593
-
594
-
595
-
596
- <div class='inline'>
597
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
598
- aren&#39;t included</p>
599
- </div>
600
-
601
- </li>
602
-
603
- </ul>
604
-
605
- </div><table class="source_code">
606
- <tr>
607
- <td>
608
- <pre class="lines">
609
-
610
-
611
- 49
612
- 50
613
- 51
614
- 52
615
- 53
616
- 54
617
- 55
618
- 56
619
- 57
620
- 58
621
- 59
622
- 60
623
- 61
624
- 62
625
- 63
626
- 64
627
- 65
628
- 66
629
- 67
630
- 68
631
- 69
632
- 70
633
- 71</pre>
634
- </td>
635
- <td>
636
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/company.rb', line 49</span>
637
-
638
- <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>
639
- <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>
640
- <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>
641
- <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/companies</span><span class='tstring_end'>&quot;</span></span>
642
- <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
643
- <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>
644
- <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>
645
- <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>
646
- <span class='kw'>end</span>
647
- <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>
648
- <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>
649
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
650
- <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>
651
- <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>
652
- <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>
653
- <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>
654
- <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>
655
- <span class='id identifier rubyid_json'>json</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>
656
- <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'>Company</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>
657
- <span class='kw'>end</span>
658
- <span class='kw'>end</span>
659
- <span class='id identifier rubyid_results'>results</span>
660
- <span class='kw'>end</span></pre>
661
- </td>
662
- </tr>
663
- </table>
664
- </div>
665
-
666
- </div>
667
-
668
- </div>
669
-
670
- <div id="footer">
671
- Generated on Fri Apr 20 10:00:19 2018 by
672
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
673
- 0.9.5 (ruby-2.2.4).
674
- </div>
675
-
676
- </div>
677
- </body>
678
- </html>