moxiworks_platform 0.13.15 → 0.13.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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/Exception/RemoteRequestFailure.html DELETED
@@ -1,134 +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
- Exception: MoxiworksPlatform::Exception::RemoteRequestFailure
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::Exception::RemoteRequestFailure";
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 (R)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Exception.html" title="MoxiworksPlatform::Exception (module)">Exception</a></span></span>
41
- &raquo;
42
- <span class="title">RemoteRequestFailure</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>Exception: MoxiworksPlatform::Exception::RemoteRequestFailure
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="PlatformError.html" title="MoxiworksPlatform::Exception::PlatformError (class)">PlatformError</a></span></span>
75
-
76
- <ul class="fullTree">
77
- <li>Object</li>
78
-
79
- <li class="next">StandardError</li>
80
-
81
- <li class="next"><span class='object_link'><a href="PlatformError.html" title="MoxiworksPlatform::Exception::PlatformError (class)">PlatformError</a></span></li>
82
-
83
- <li class="next">MoxiworksPlatform::Exception::RemoteRequestFailure</li>
84
-
85
- </ul>
86
- <a href="#" class="inheritanceTree">show all</a>
87
-
88
- </dd>
89
- </dl>
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
- <dl>
102
- <dt>Defined in:</dt>
103
- <dd>lib/moxiworks_platform/exception.rb</dd>
104
- </dl>
105
-
106
- </div>
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
- </div>
125
-
126
- <div id="footer">
127
- Generated on Fri Apr 20 10:00:19 2018 by
128
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
129
- 0.9.5 (ruby-2.2.4).
130
- </div>
131
-
132
- </div>
133
- </body>
134
- </html>
data/MoxiworksPlatform/Gallery.html DELETED
@@ -1,877 +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::Gallery
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::Gallery";
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 (G)</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">Gallery</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::Gallery
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::Gallery</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/gallery.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+Gallery">Moxi Works Platform Gallery</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="#gallery_images-instance_method" title="#gallery_images (instance method)">#<strong>gallery_images</strong> &#x21d2; Array </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>Array of image Hashes in the format { thumb_url: [String] url to
146
- thumbail size image (smallest), small_url: [String] url to small size
147
- image (small), full_url: [String] url to full size image (medium),
148
- gallery_url: [String] url to gallery size image (large), raw_url:
149
- [String] url to raw image (largest) title: [String] human readable title
150
- of image is_main_listing_image: [Boolean] whether the image is the main
151
- image for the listing caption: [String] human readable caption for the
152
- image description: [String] human readable description of the image
153
- width: [Integer] width of the raw image height: [Integer] height of the
154
- raw image mime_type: [String] MIME or media type of the image.</p>
155
- </div></span>
156
-
157
- </li>
158
-
159
-
160
- <li class="public ">
161
- <span class="summary_signature">
162
-
163
- <a href="#list_office_aor-instance_method" title="#list_office_aor (instance method)">#<strong>list_office_aor</strong> &#x21d2; String </a>
164
-
165
-
166
-
167
- </span>
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
- <span class="summary_desc"><div class='inline'>
181
- <p>MLS the listing is listed with.</p>
182
- </div></span>
183
-
184
- </li>
185
-
186
-
187
- <li class="public ">
188
- <span class="summary_signature">
189
-
190
- <a href="#listing_id-instance_method" title="#listing_id (instance method)">#<strong>listing_id</strong> &#x21d2; String </a>
191
-
192
-
193
-
194
- </span>
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
- <span class="summary_desc"><div class='inline'>
208
- <p>The mls number associated with the listing.</p>
209
- </div></span>
210
-
211
- </li>
212
-
213
-
214
- <li class="public ">
215
- <span class="summary_signature">
216
-
217
- <a href="#listing_images-instance_method" title="#listing_images (instance method)">#<strong>listing_images</strong> &#x21d2; Array </a>
218
-
219
-
220
-
221
- </span>
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
- <span class="summary_desc"><div class='inline'>
235
- <p>Array of image Hashes in the format { thumb_url: [String] url to
236
- thumbail size image (smallest), small_url: [String] url to small size
237
- image (small), full_url: [String] url to full size image (medium),
238
- gallery_url: [String] url to gallery size image (large), raw_url:
239
- [String] url to raw image (largest) title: [String] human readable title
240
- of image is_main_listing_image: [Boolean] whether the image is the main
241
- image for the listing caption: [String] human readable caption for the
242
- image description: [String] human readable description of the image
243
- width: [Integer] width of the raw image height: [Integer] height of the
244
- raw image mime_type: [String] MIME or media type of the image.</p>
245
- </div></span>
246
-
247
- </li>
248
-
249
-
250
- </ul>
251
-
252
-
253
-
254
-
255
-
256
- <h3 class="inherited">Attributes 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#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
258
-
259
-
260
-
261
- <h2>
262
- Class Method Summary
263
- <small><a href="#" class="summary_toggle">collapse</a></small>
264
- </h2>
265
-
266
- <ul class="summary">
267
-
268
- <li class="public ">
269
- <span class="summary_signature">
270
-
271
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; Hash </a>
272
-
273
-
274
-
275
- </span>
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
- <span class="summary_desc"><div class='inline'>
286
- <p>Search For Galleries in Moxi Works Platform.</p>
287
- </div></span>
288
-
289
- </li>
290
-
291
-
292
- </ul>
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
305
- <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>
306
- <div id="constructor_details" class="method_details_list">
307
- <h2>Constructor Details</h2>
308
-
309
- <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>
310
-
311
- </div>
312
- <div id="method_missing_details" class="method_details_list">
313
- <h2>Dynamic Method Handling</h2>
314
- <p class="notice super">
315
- This class handles dynamic methods through the <tt>method_missing</tt> method
316
-
317
- 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>
318
-
319
- </p>
320
-
321
- </div>
322
-
323
- <div id="instance_attr_details" class="attr_details">
324
- <h2>Instance Attribute Details</h2>
325
-
326
-
327
- <span id="gallery_images=-instance_method"></span>
328
- <div class="method_details first">
329
- <h3 class="signature first" id="gallery_images-instance_method">
330
-
331
- #<strong>gallery_images</strong> &#x21d2; <tt>Array</tt>
332
-
333
-
334
-
335
-
336
-
337
- </h3><div class="docstring">
338
- <div class="discussion">
339
-
340
- <p>Returns array of image Hashes in the format
341
- <pre class="code ruby"><code class="ruby">thumb_url: [String] url to thumbail size image (smallest),
342
- small_url: [String] url to small size image (small),
343
- full_url: [String] url to full size image (medium),
344
- gallery_url: [String] url to gallery size image (large),
345
- raw_url: [String] url to raw image (largest)
346
- title: [String] human readable title of image
347
- is_main_listing_image: [Boolean] whether the image is the main image for the listing
348
- caption: [String] human readable caption for the image
349
- description: [String] human readable description of the image
350
- width: [Integer] width of the raw image
351
- height: [Integer] height of the raw image
352
- mime_type: [String] MIME or media type of the image</code></pre>
353
-
354
- <p></p>
355
-
356
-
357
- </div>
358
- </div>
359
- <div class="tags">
360
-
361
- <p class="tag_title">Returns:</p>
362
- <ul class="return">
363
-
364
- <li>
365
-
366
-
367
- <span class='type'>(<tt>Array</tt>)</span>
368
-
369
-
370
-
371
- &mdash;
372
- <div class='inline'>
373
- <p>array of image Hashes in the format
374
- <pre class="code ruby"><code class="ruby">thumb_url: [String] url to thumbail size image (smallest),
375
- small_url: [String] url to small size image (small),
376
- full_url: [String] url to full size image (medium),
377
- gallery_url: [String] url to gallery size image (large),
378
- raw_url: [String] url to raw image (largest)
379
- title: [String] human readable title of image
380
- is_main_listing_image: [Boolean] whether the image is the main image for the listing
381
- caption: [String] human readable caption for the image
382
- description: [String] human readable description of the image
383
- width: [Integer] width of the raw image
384
- height: [Integer] height of the raw image
385
- mime_type: [String] MIME or media type of the image</code></pre>
386
-
387
- <p></p>
388
- </div>
389
-
390
- </li>
391
-
392
- </ul>
393
-
394
- </div><table class="source_code">
395
- <tr>
396
- <td>
397
- <pre class="lines">
398
-
399
-
400
- 34
401
- 35
402
- 36</pre>
403
- </td>
404
- <td>
405
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/gallery.rb', line 34</span>
406
-
407
- <span class='kw'>def</span> <span class='id identifier rubyid_gallery_images'>gallery_images</span>
408
- <span class='ivar'>@gallery_images</span>
409
- <span class='kw'>end</span></pre>
410
- </td>
411
- </tr>
412
- </table>
413
- </div>
414
-
415
-
416
- <span id="list_office_aor=-instance_method"></span>
417
- <div class="method_details ">
418
- <h3 class="signature " id="list_office_aor-instance_method">
419
-
420
- #<strong>list_office_aor</strong> &#x21d2; <tt>String</tt>
421
-
422
-
423
-
424
-
425
-
426
- </h3><div class="docstring">
427
- <div class="discussion">
428
-
429
- <p>Returns MLS the listing is listed with</p>
430
-
431
-
432
- </div>
433
- </div>
434
- <div class="tags">
435
-
436
- <p class="tag_title">Returns:</p>
437
- <ul class="return">
438
-
439
- <li>
440
-
441
-
442
- <span class='type'>(<tt>String</tt>)</span>
443
-
444
-
445
-
446
- &mdash;
447
- <div class='inline'>
448
- <p>MLS the listing is listed with</p>
449
- </div>
450
-
451
- </li>
452
-
453
- </ul>
454
-
455
- </div><table class="source_code">
456
- <tr>
457
- <td>
458
- <pre class="lines">
459
-
460
-
461
- 8
462
- 9
463
- 10</pre>
464
- </td>
465
- <td>
466
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/gallery.rb', line 8</span>
467
-
468
- <span class='kw'>def</span> <span class='id identifier rubyid_list_office_aor'>list_office_aor</span>
469
- <span class='ivar'>@list_office_aor</span>
470
- <span class='kw'>end</span></pre>
471
- </td>
472
- </tr>
473
- </table>
474
- </div>
475
-
476
-
477
- <span id="listing_id=-instance_method"></span>
478
- <div class="method_details ">
479
- <h3 class="signature " id="listing_id-instance_method">
480
-
481
- #<strong>listing_id</strong> &#x21d2; <tt>String</tt>
482
-
483
-
484
-
485
-
486
-
487
- </h3><div class="docstring">
488
- <div class="discussion">
489
-
490
- <p>Returns the mls number associated with the listing</p>
491
-
492
-
493
- </div>
494
- </div>
495
- <div class="tags">
496
-
497
- <p class="tag_title">Returns:</p>
498
- <ul class="return">
499
-
500
- <li>
501
-
502
-
503
- <span class='type'>(<tt>String</tt>)</span>
504
-
505
-
506
-
507
- &mdash;
508
- <div class='inline'>
509
- <p>the mls number associated with the listing</p>
510
- </div>
511
-
512
- </li>
513
-
514
- </ul>
515
-
516
- </div><table class="source_code">
517
- <tr>
518
- <td>
519
- <pre class="lines">
520
-
521
-
522
- 13
523
- 14
524
- 15</pre>
525
- </td>
526
- <td>
527
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/gallery.rb', line 13</span>
528
-
529
- <span class='kw'>def</span> <span class='id identifier rubyid_listing_id'>listing_id</span>
530
- <span class='ivar'>@listing_id</span>
531
- <span class='kw'>end</span></pre>
532
- </td>
533
- </tr>
534
- </table>
535
- </div>
536
-
537
-
538
- <span id="listing_images=-instance_method"></span>
539
- <div class="method_details ">
540
- <h3 class="signature " id="listing_images-instance_method">
541
-
542
- #<strong>listing_images</strong> &#x21d2; <tt>Array</tt>
543
-
544
-
545
-
546
-
547
-
548
- </h3><div class="docstring">
549
- <div class="discussion">
550
-
551
- <p>Returns array of image Hashes in the format
552
- <pre class="code ruby"><code class="ruby">thumb_url: [String] url to thumbail size image (smallest),
553
- small_url: [String] url to small size image (small),
554
- full_url: [String] url to full size image (medium),
555
- gallery_url: [String] url to gallery size image (large),
556
- raw_url: [String] url to raw image (largest)
557
- title: [String] human readable title of image
558
- is_main_listing_image: [Boolean] whether the image is the main image for the listing
559
- caption: [String] human readable caption for the image
560
- description: [String] human readable description of the image
561
- width: [Integer] width of the raw image
562
- height: [Integer] height of the raw image
563
- mime_type: [String] MIME or media type of the image</code></pre>
564
-
565
- <p></p>
566
-
567
-
568
- </div>
569
- </div>
570
- <div class="tags">
571
-
572
- <p class="tag_title">Returns:</p>
573
- <ul class="return">
574
-
575
- <li>
576
-
577
-
578
- <span class='type'>(<tt>Array</tt>)</span>
579
-
580
-
581
-
582
- &mdash;
583
- <div class='inline'>
584
- <p>array of image Hashes in the format
585
- <pre class="code ruby"><code class="ruby">thumb_url: [String] url to thumbail size image (smallest),
586
- small_url: [String] url to small size image (small),
587
- full_url: [String] url to full size image (medium),
588
- gallery_url: [String] url to gallery size image (large),
589
- raw_url: [String] url to raw image (largest)
590
- title: [String] human readable title of image
591
- is_main_listing_image: [Boolean] whether the image is the main image for the listing
592
- caption: [String] human readable caption for the image
593
- description: [String] human readable description of the image
594
- width: [Integer] width of the raw image
595
- height: [Integer] height of the raw image
596
- mime_type: [String] MIME or media type of the image</code></pre>
597
-
598
- <p></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
- 34</pre>
612
- </td>
613
- <td>
614
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/gallery.rb', line 34</span>
615
-
616
- <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:gallery_images</span></pre>
617
- </td>
618
- </tr>
619
- </table>
620
- </div>
621
-
622
- </div>
623
-
624
-
625
- <div id="class_method_details" class="method_details_list">
626
- <h2>Class Method Details</h2>
627
-
628
-
629
- <div class="method_details first">
630
- <h3 class="signature first" id="find-class_method">
631
-
632
- .<strong>find</strong>(opts = {}) &#x21d2; <tt>Hash</tt>
633
-
634
-
635
-
636
-
637
-
638
- </h3><div class="docstring">
639
- <div class="discussion">
640
-
641
- <p>Search For Galleries in Moxi Works Platform</p>
642
-
643
-
644
- </div>
645
- </div>
646
- <div class="tags">
647
-
648
- <div class="examples">
649
- <p class="tag_title">Examples:</p>
650
-
651
-
652
- <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'>Gallery</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
653
- <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>
654
- <span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc123</span><span class='tstring_end'>&#39;</span></span>
655
- <span class='rparen'>)</span></code></pre>
656
-
657
-
658
- <pre class="example code"><code>MoxiworksPlatform::Gallery.search(
659
- moxi_works_company_id: &#39;the_company&#39;,
660
- moxi_works_agent_id: &#39;abc123&#39;
661
- agent_uuid: &#39;abc123&#39;) { |galleries| puts galleries.count }</code></pre>
662
-
663
- </div>
664
- <p class="tag_title">Parameters:</p>
665
- <ul class="param">
666
-
667
- <li>
668
-
669
- <span class='name'>opts</span>
670
-
671
-
672
- <span class='type'>(<tt>Hash</tt>)</span>
673
-
674
-
675
- <em class="default">(defaults to: <tt>{}</tt>)</em>
676
-
677
-
678
- &mdash;
679
- <div class='inline'>
680
- <p>named parameter Hash</p>
681
- </div>
682
-
683
- </li>
684
-
685
- </ul>
686
-
687
-
688
-
689
-
690
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
691
- <ul class="option">
692
-
693
- <li>
694
- <span class="name">:moxi_works_company_id</span>
695
- <span class="type">(<tt>String</tt>)</span>
696
- <span class="default">
697
-
698
- </span>
699
-
700
- &mdash; <div class='inline'>
701
- <p><strong>REQUIRED</strong> The Moxi Works Company ID For the search (use
702
- Company.search to determine available moxi_works_company_id)</p>
703
- </div>
704
-
705
- </li>
706
-
707
- <li>
708
- <span class="name">:moxi_works_agent_id</span>
709
- <span class="type">(<tt>String</tt>)</span>
710
- <span class="default">
711
-
712
- </span>
713
-
714
- &mdash; <div class='inline'>
715
- <p>The Moxi Works Agent ID For the search (use Agent.search to determine
716
- available moxi_works_agent_id) – only agent_uuid or moxi_works_agent_id are
717
- needed when searching for galleries by agent</p>
718
- </div>
719
-
720
- </li>
721
-
722
- <li>
723
- <span class="name">:agent_uuid</span>
724
- <span class="type">(<tt>String</tt>)</span>
725
- <span class="default">
726
-
727
- </span>
728
-
729
- &mdash; <div class='inline'>
730
- <p>The Agent UUID For the search (use Agent.search to determine available
731
- agent_uuid) – only agent_uuid or moxi_works_agent_id are needed when
732
- searching for galleries by agent</p>
733
-
734
- <p>optional Search parameters</p>
735
- </div>
736
-
737
- </li>
738
-
739
- </ul>
740
-
741
-
742
- <p class="tag_title">Returns:</p>
743
- <ul class="return">
744
-
745
- <li>
746
-
747
-
748
- <span class='type'>(<tt>Hash</tt>)</span>
749
-
750
-
751
-
752
- &mdash;
753
- <div class='inline'>
754
- <p>with the format:
755
- <pre class="code ruby"><code class="ruby">last_page: [Boolean],
756
- galleries: [Array] containing MoxiworkPlatform::Gallery objects</code></pre>
757
-
758
- <p></p>
759
- </div>
760
-
761
- </li>
762
-
763
- </ul>
764
- <p class="tag_title">Raises:</p>
765
- <ul class="raise">
766
-
767
- <li>
768
-
769
-
770
- <span class='type'></span>
771
-
772
-
773
-
774
-
775
- <div class='inline'>
776
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
777
- aren&#39;t included</p>
778
- </div>
779
-
780
- </li>
781
-
782
- </ul>
783
-
784
- </div><table class="source_code">
785
- <tr>
786
- <td>
787
- <pre class="lines">
788
-
789
-
790
- 74
791
- 75
792
- 76
793
- 77
794
- 78
795
- 79
796
- 80
797
- 81
798
- 82
799
- 83
800
- 84
801
- 85
802
- 86
803
- 87
804
- 88
805
- 89
806
- 90
807
- 91
808
- 92
809
- 93
810
- 94
811
- 95
812
- 96
813
- 97
814
- 98
815
- 99
816
- 100
817
- 101
818
- 102
819
- 103
820
- 104
821
- 105
822
- 106</pre>
823
- </td>
824
- <td>
825
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/gallery.rb', line 74</span>
826
-
827
- <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>
828
- <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>
829
- <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>
830
- <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>
831
- <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>
832
- <span class='kw'>end</span>
833
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:agent_uuid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
834
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span> <span class='op'>||=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
835
- <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#agent_uuid or moxi_works_agent_id required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
836
- <span class='id identifier rubyid_agent_identifier'>agent_identifier</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
837
-
838
- <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/galleries/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_identifier'>agent_identifier</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
839
-
840
- <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>
841
- <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'>galleries</span><span class='label_end'>&#39;:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
842
- <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>
843
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
844
- <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>
845
- <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>
846
- <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>
847
- <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>
848
- <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>
849
- <span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_underscore_attribute_names'>underscore_attribute_names</span> <span class='id identifier rubyid_json'>json</span>
850
- <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'>galleries</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>
851
- <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'>Gallery</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>
852
- <span class='kw'>end</span>
853
- <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'>galleries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span>
854
- <span class='kw'>end</span>
855
- <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
856
- <span class='kw'>yield</span><span class='lparen'>(</span><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'>galleries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
857
- <span class='kw'>end</span>
858
- <span class='id identifier rubyid_json'>json</span>
859
- <span class='kw'>end</span></pre>
860
- </td>
861
- </tr>
862
- </table>
863
- </div>
864
-
865
- </div>
866
-
867
- </div>
868
-
869
- <div id="footer">
870
- Generated on Fri Apr 20 10:00:17 2018 by
871
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
872
- 0.9.5 (ruby-2.2.4).
873
- </div>
874
-
875
- </div>
876
- </body>
877
- </html>