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.
- checksums.yaml +4 -4
- data/.gitignore +3 -1
- data/Gemfile +2 -0
- data/lib/moxiworks_platform/action_log.rb +31 -2
- data/lib/moxiworks_platform/company.rb +0 -3
- data/lib/moxiworks_platform/contact.rb +5 -6
- data/lib/moxiworks_platform/listing.rb +11 -1
- data/lib/moxiworks_platform/version.rb +1 -1
- data/publish_docs.sh +7 -2
- metadata +2 -28
- data/MoxiworksPlatform/ActionLog.html +0 -1155
- data/MoxiworksPlatform/Agent.html +0 -3668
- data/MoxiworksPlatform/Brand.html +0 -2897
- data/MoxiworksPlatform/BuyerTransaction.html +0 -4703
- data/MoxiworksPlatform/Company.html +0 -678
- data/MoxiworksPlatform/Config.html +0 -323
- data/MoxiworksPlatform/Contact.html +0 -7540
- data/MoxiworksPlatform/Credentials.html +0 -1078
- data/MoxiworksPlatform/EmailCampaign.html +0 -1076
- data/MoxiworksPlatform/Event.html +0 -2987
- data/MoxiworksPlatform/Exception.html +0 -117
- data/MoxiworksPlatform/Exception/ArgumentError.html +0 -146
- data/MoxiworksPlatform/Exception/AuthorizationError.html +0 -134
- data/MoxiworksPlatform/Exception/PlatformError.html +0 -141
- data/MoxiworksPlatform/Exception/RemoteRequestFailure.html +0 -134
- data/MoxiworksPlatform/Gallery.html +0 -877
- data/MoxiworksPlatform/Group.html +0 -941
- data/MoxiworksPlatform/Listing.html +0 -6242
- data/MoxiworksPlatform/Office.html +0 -2144
- data/MoxiworksPlatform/PresentationLog.html +0 -1715
- data/MoxiworksPlatform/Resource.html +0 -1906
- data/MoxiworksPlatform/SellerTransaction.html +0 -4222
- data/MoxiworksPlatform/Session.html +0 -209
- data/MoxiworksPlatform/SoldListing.html +0 -5606
- data/MoxiworksPlatform/Task.html +0 -2351
- data/MoxiworksPlatform/Team.html +0 -2147
|
@@ -1,4703 +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::BuyerTransaction
|
|
8
|
-
|
|
9
|
-
— 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::BuyerTransaction";
|
|
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 (B)</a> »
|
|
40
|
-
<span class='title'><span class='object_link'><a href="../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span>
|
|
41
|
-
»
|
|
42
|
-
<span class="title">BuyerTransaction</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::BuyerTransaction
|
|
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::BuyerTransaction</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/buyer_transaction.rb</dd>
|
|
102
|
-
</dl>
|
|
103
|
-
|
|
104
|
-
</div>
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
111
|
-
<ul class="summary">
|
|
112
|
-
|
|
113
|
-
<li class="public ">
|
|
114
|
-
<span class="summary_signature">
|
|
115
|
-
|
|
116
|
-
<a href="#address-instance_method" title="#address (instance method)">#<strong>address</strong> ⇒ String </a>
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
</span>
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
<span class="summary_desc"><div class='inline'>
|
|
134
|
-
<p>Street address of property being sold.</p>
|
|
135
|
-
</div></span>
|
|
136
|
-
|
|
137
|
-
</li>
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
<li class="public ">
|
|
141
|
-
<span class="summary_signature">
|
|
142
|
-
|
|
143
|
-
<a href="#area_of_interest-instance_method" title="#area_of_interest (instance method)">#<strong>area_of_interest</strong> ⇒ String </a>
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
</span>
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
<span class="summary_desc"><div class='inline'>
|
|
161
|
-
<p>String representing a locality that the client is interested in purchasing
|
|
162
|
-
a property in.</p>
|
|
163
|
-
</div></span>
|
|
164
|
-
|
|
165
|
-
</li>
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
<li class="public ">
|
|
169
|
-
<span class="summary_signature">
|
|
170
|
-
|
|
171
|
-
<a href="#city-instance_method" title="#city (instance method)">#<strong>city</strong> ⇒ String </a>
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
</span>
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
<span class="summary_desc"><div class='inline'>
|
|
189
|
-
<p>City or township of property being sold.</p>
|
|
190
|
-
</div></span>
|
|
191
|
-
|
|
192
|
-
</li>
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
<li class="public ">
|
|
196
|
-
<span class="summary_signature">
|
|
197
|
-
|
|
198
|
-
<a href="#closing_price-instance_method" title="#closing_price (instance method)">#<strong>closing_price</strong> ⇒ Integer </a>
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
</span>
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
<span class="summary_desc"><div class='inline'>
|
|
216
|
-
<p>This is the closing price for the sale .</p>
|
|
217
|
-
</div></span>
|
|
218
|
-
|
|
219
|
-
</li>
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
<li class="public ">
|
|
223
|
-
<span class="summary_signature">
|
|
224
|
-
|
|
225
|
-
<a href="#closing_timestamp-instance_method" title="#closing_timestamp (instance method)">#<strong>closing_timestamp</strong> ⇒ Integer </a>
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
</span>
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
<span class="summary_desc"><div class='inline'>
|
|
243
|
-
<p>A Unix timestamp representing the point in time when the transaction for
|
|
244
|
-
this BuyerTransaction object was completed.</p>
|
|
245
|
-
</div></span>
|
|
246
|
-
|
|
247
|
-
</li>
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
<li class="public ">
|
|
251
|
-
<span class="summary_signature">
|
|
252
|
-
|
|
253
|
-
<a href="#commission_flat_fee-instance_method" title="#commission_flat_fee (instance method)">#<strong>commission_flat_fee</strong> ⇒ Integer </a>
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
</span>
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
<span class="summary_desc"><div class='inline'>
|
|
271
|
-
<p>If the agent is to receive a flat-rate commission upon sale of the property
|
|
272
|
-
associated with this BuyerTransaction, then this will represent the
|
|
273
|
-
commission that the agent is to receive.</p>
|
|
274
|
-
</div></span>
|
|
275
|
-
|
|
276
|
-
</li>
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
<li class="public ">
|
|
280
|
-
<span class="summary_signature">
|
|
281
|
-
|
|
282
|
-
<a href="#commission_percentage-instance_method" title="#commission_percentage (instance method)">#<strong>commission_percentage</strong> ⇒ Float </a>
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
</span>
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
<span class="summary_desc"><div class='inline'>
|
|
300
|
-
<p>If the agent is to receive commission based on percentage of sale price for
|
|
301
|
-
the property associated with this BuyerTransaction, then this will
|
|
302
|
-
represent the commission that the agent is to receive.This should be null
|
|
303
|
-
if the BuyerTransaction uses commission_flat_fee.</p>
|
|
304
|
-
</div></span>
|
|
305
|
-
|
|
306
|
-
</li>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
<li class="public ">
|
|
310
|
-
<span class="summary_signature">
|
|
311
|
-
|
|
312
|
-
<a href="#is_mls_transaction-instance_method" title="#is_mls_transaction (instance method)">#<strong>is_mls_transaction</strong> ⇒ Boolean </a>
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
</span>
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
<span class="summary_desc"><div class='inline'>
|
|
330
|
-
<p>Whether the property is being listed on an MLS.</p>
|
|
331
|
-
</div></span>
|
|
332
|
-
|
|
333
|
-
</li>
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
<li class="public ">
|
|
337
|
-
<span class="summary_signature">
|
|
338
|
-
|
|
339
|
-
<a href="#max_baths-instance_method" title="#max_baths (instance method)">#<strong>max_baths</strong> ⇒ Float </a>
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
</span>
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
<span class="summary_desc"><div class='inline'>
|
|
357
|
-
<p>Maximum desired bathrooms in potential properties.</p>
|
|
358
|
-
</div></span>
|
|
359
|
-
|
|
360
|
-
</li>
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
<li class="public ">
|
|
364
|
-
<span class="summary_signature">
|
|
365
|
-
|
|
366
|
-
<a href="#max_beds-instance_method" title="#max_beds (instance method)">#<strong>max_beds</strong> ⇒ Integer </a>
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
</span>
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
<span class="summary_desc"><div class='inline'>
|
|
384
|
-
<p>Maximum desired bedrooms in potential properties.</p>
|
|
385
|
-
</div></span>
|
|
386
|
-
|
|
387
|
-
</li>
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
<li class="public ">
|
|
391
|
-
<span class="summary_signature">
|
|
392
|
-
|
|
393
|
-
<a href="#max_price-instance_method" title="#max_price (instance method)">#<strong>max_price</strong> ⇒ Integer </a>
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
</span>
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
<span class="summary_desc"><div class='inline'>
|
|
411
|
-
<p>The maximum desired price range for potential properties if using a price
|
|
412
|
-
range rather than target price.</p>
|
|
413
|
-
</div></span>
|
|
414
|
-
|
|
415
|
-
</li>
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
<li class="public ">
|
|
419
|
-
<span class="summary_signature">
|
|
420
|
-
|
|
421
|
-
<a href="#max_sqft-instance_method" title="#max_sqft (instance method)">#<strong>max_sqft</strong> ⇒ Integer </a>
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
</span>
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
<span class="summary_desc"><div class='inline'>
|
|
439
|
-
<p>Maximum desired living area of potential properties.</p>
|
|
440
|
-
</div></span>
|
|
441
|
-
|
|
442
|
-
</li>
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
<li class="public ">
|
|
446
|
-
<span class="summary_signature">
|
|
447
|
-
|
|
448
|
-
<a href="#min_baths-instance_method" title="#min_baths (instance method)">#<strong>min_baths</strong> ⇒ Float </a>
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
</span>
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
<span class="summary_desc"><div class='inline'>
|
|
466
|
-
<p>Minimum desired bathrooms in potential properties.</p>
|
|
467
|
-
</div></span>
|
|
468
|
-
|
|
469
|
-
</li>
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
<li class="public ">
|
|
473
|
-
<span class="summary_signature">
|
|
474
|
-
|
|
475
|
-
<a href="#min_beds-instance_method" title="#min_beds (instance method)">#<strong>min_beds</strong> ⇒ Integer </a>
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
</span>
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
<span class="summary_desc"><div class='inline'>
|
|
493
|
-
<p>Minimum desired bedrooms in potential properties.</p>
|
|
494
|
-
</div></span>
|
|
495
|
-
|
|
496
|
-
</li>
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
<li class="public ">
|
|
500
|
-
<span class="summary_signature">
|
|
501
|
-
|
|
502
|
-
<a href="#min_price-instance_method" title="#min_price (instance method)">#<strong>min_price</strong> ⇒ Integer </a>
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
</span>
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
<span class="summary_desc"><div class='inline'>
|
|
520
|
-
<p>The minimum desired price range for potential properties if using a price
|
|
521
|
-
range rather than target price.</p>
|
|
522
|
-
</div></span>
|
|
523
|
-
|
|
524
|
-
</li>
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
<li class="public ">
|
|
528
|
-
<span class="summary_signature">
|
|
529
|
-
|
|
530
|
-
<a href="#min_sqft-instance_method" title="#min_sqft (instance method)">#<strong>min_sqft</strong> ⇒ Integer </a>
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
</span>
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
<span class="summary_desc"><div class='inline'>
|
|
548
|
-
<p>Minimum desired living area of potential properties.</p>
|
|
549
|
-
</div></span>
|
|
550
|
-
|
|
551
|
-
</li>
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
<li class="public ">
|
|
555
|
-
<span class="summary_signature">
|
|
556
|
-
|
|
557
|
-
<a href="#mls_number-instance_method" title="#mls_number (instance method)">#<strong>mls_number</strong> ⇒ String </a>
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
</span>
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
<span class="summary_desc"><div class='inline'>
|
|
575
|
-
<p>**MLS TRANSACTIONS ONLY** mls number for the listing associated with this
|
|
576
|
-
BuyerTransaction.</p>
|
|
577
|
-
</div></span>
|
|
578
|
-
|
|
579
|
-
</li>
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
<li class="public ">
|
|
583
|
-
<span class="summary_signature">
|
|
584
|
-
|
|
585
|
-
<a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong> ⇒ String </a>
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
</span>
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
<span class="summary_desc"><div class='inline'>
|
|
603
|
-
<p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
|
|
604
|
-
BuyerTransaction is or is to be associated with.</p>
|
|
605
|
-
</div></span>
|
|
606
|
-
|
|
607
|
-
</li>
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
<li class="public ">
|
|
611
|
-
<span class="summary_signature">
|
|
612
|
-
|
|
613
|
-
<a href="#moxi_works_contact_id-instance_method" title="#moxi_works_contact_id (instance method)">#<strong>moxi_works_contact_id</strong> ⇒ Object </a>
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
</span>
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
<span class="summary_desc"><div class='inline'>
|
|
631
|
-
<p>The Moxi Works Platform unique identifier for the Contact.</p>
|
|
632
|
-
</div></span>
|
|
633
|
-
|
|
634
|
-
</li>
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
<li class="public ">
|
|
638
|
-
<span class="summary_signature">
|
|
639
|
-
|
|
640
|
-
<a href="#moxi_works_transaction_id-instance_method" title="#moxi_works_transaction_id (instance method)">#<strong>moxi_works_transaction_id</strong> ⇒ String </a>
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
</span>
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
<span class="summary_desc"><div class='inline'>
|
|
658
|
-
<p>The Moxi Works Platform unique identifier for the BuyerTransaction.</p>
|
|
659
|
-
</div></span>
|
|
660
|
-
|
|
661
|
-
</li>
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
<li class="public ">
|
|
665
|
-
<span class="summary_signature">
|
|
666
|
-
|
|
667
|
-
<a href="#notes-instance_method" title="#notes (instance method)">#<strong>notes</strong> ⇒ String </a>
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
</span>
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
<span class="summary_desc"><div class='inline'>
|
|
685
|
-
<p>Brief, human readable content that is shown to the agent as notes about the
|
|
686
|
-
BuyerTransaction.</p>
|
|
687
|
-
</div></span>
|
|
688
|
-
|
|
689
|
-
</li>
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
<li class="public ">
|
|
693
|
-
<span class="summary_signature">
|
|
694
|
-
|
|
695
|
-
<a href="#partner_contact_id-instance_method" title="#partner_contact_id (instance method)">#<strong>partner_contact_id</strong> ⇒ String </a>
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
</span>
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
<span class="summary_desc"><div class='inline'>
|
|
713
|
-
<p>*your system's* unique ID for the Contact.</p>
|
|
714
|
-
</div></span>
|
|
715
|
-
|
|
716
|
-
</li>
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
<li class="public ">
|
|
720
|
-
<span class="summary_signature">
|
|
721
|
-
|
|
722
|
-
<a href="#promote_transaction-instance_method" title="#promote_transaction (instance method)">#<strong>promote_transaction</strong> ⇒ Object </a>
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
</span>
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
<span class="summary_desc"><div class='inline'>
|
|
740
|
-
<p>In order to promote a BuyerTransaction to the next stage, set the
|
|
741
|
-
promote_transaction attribute to true.</p>
|
|
742
|
-
</div></span>
|
|
743
|
-
|
|
744
|
-
</li>
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
<li class="public ">
|
|
748
|
-
<span class="summary_signature">
|
|
749
|
-
|
|
750
|
-
<a href="#stage-instance_method" title="#stage (instance method)">#<strong>stage</strong> ⇒ Object </a>
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
</span>
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
<span class="summary_desc"><div class='inline'>
|
|
768
|
-
<p>Each BuyerTransaction has five stages (1-5).</p>
|
|
769
|
-
</div></span>
|
|
770
|
-
|
|
771
|
-
</li>
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
<li class="public ">
|
|
775
|
-
<span class="summary_signature">
|
|
776
|
-
|
|
777
|
-
<a href="#stage_name-instance_method" title="#stage_name (instance method)">#<strong>stage_name</strong> ⇒ Object </a>
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
</span>
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
<span class="summary_desc"><div class='inline'>
|
|
795
|
-
<p>This attribute displays a human readable stage name that is associated with
|
|
796
|
-
the current stage attribute.</p>
|
|
797
|
-
</div></span>
|
|
798
|
-
|
|
799
|
-
</li>
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
<li class="public ">
|
|
803
|
-
<span class="summary_signature">
|
|
804
|
-
|
|
805
|
-
<a href="#start_timestamp-instance_method" title="#start_timestamp (instance method)">#<strong>start_timestamp</strong> ⇒ Object </a>
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
</span>
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
<span class="summary_desc"><div class='inline'>
|
|
823
|
-
<p>this is the Unix timestamp representing the date the agent initiated
|
|
824
|
-
transaction discussions with the client.</p>
|
|
825
|
-
</div></span>
|
|
826
|
-
|
|
827
|
-
</li>
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
<li class="public ">
|
|
831
|
-
<span class="summary_signature">
|
|
832
|
-
|
|
833
|
-
<a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> ⇒ String </a>
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
</span>
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
<span class="summary_desc"><div class='inline'>
|
|
851
|
-
<p>State or province of property being sold.</p>
|
|
852
|
-
</div></span>
|
|
853
|
-
|
|
854
|
-
</li>
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
<li class="public ">
|
|
858
|
-
<span class="summary_signature">
|
|
859
|
-
|
|
860
|
-
<a href="#target_price-instance_method" title="#target_price (instance method)">#<strong>target_price</strong> ⇒ Integer </a>
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
</span>
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
<span class="summary_desc"><div class='inline'>
|
|
878
|
-
<p>The desired selling price for the property if using target rather than
|
|
879
|
-
range.</p>
|
|
880
|
-
</div></span>
|
|
881
|
-
|
|
882
|
-
</li>
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
<li class="public ">
|
|
886
|
-
<span class="summary_signature">
|
|
887
|
-
|
|
888
|
-
<a href="#transaction_name-instance_method" title="#transaction_name (instance method)">#<strong>transaction_name</strong> ⇒ String </a>
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
</span>
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
<span class="summary_desc"><div class='inline'>
|
|
906
|
-
<p>A brief, human readable title that is shown to the agent as the subject of
|
|
907
|
-
the BuyerTransaction.</p>
|
|
908
|
-
</div></span>
|
|
909
|
-
|
|
910
|
-
</li>
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
<li class="public ">
|
|
914
|
-
<span class="summary_signature">
|
|
915
|
-
|
|
916
|
-
<a href="#zip_code-instance_method" title="#zip_code (instance method)">#<strong>zip_code</strong> ⇒ String </a>
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
</span>
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
<span class="summary_desc"><div class='inline'>
|
|
934
|
-
<p>Postal code of property being sold.</p>
|
|
935
|
-
</div></span>
|
|
936
|
-
|
|
937
|
-
</li>
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
</ul>
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
|
|
947
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
<h2>
|
|
952
|
-
Class Method Summary
|
|
953
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
954
|
-
</h2>
|
|
955
|
-
|
|
956
|
-
<ul class="summary">
|
|
957
|
-
|
|
958
|
-
<li class="public ">
|
|
959
|
-
<span class="summary_signature">
|
|
960
|
-
|
|
961
|
-
<a href="#create-class_method" title="create (class method)">.<strong>create</strong>(opts = {}) ⇒ MoxiworksPlatform::BuyerTransaction </a>
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
</span>
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
<span class="summary_desc"><div class='inline'>
|
|
976
|
-
<p>Creates a new BuyerTransaction in Moxi Works Platform.</p>
|
|
977
|
-
</div></span>
|
|
978
|
-
|
|
979
|
-
</li>
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
<li class="public ">
|
|
983
|
-
<span class="summary_signature">
|
|
984
|
-
|
|
985
|
-
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) ⇒ MoxiworksPlatform::BuyerTransaction </a>
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
</span>
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
<span class="summary_desc"><div class='inline'>
|
|
1000
|
-
<p>Find a BuyerTransaction using The Moxi Works Platform.</p>
|
|
1001
|
-
</div></span>
|
|
1002
|
-
|
|
1003
|
-
</li>
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
<li class="public ">
|
|
1007
|
-
<span class="summary_signature">
|
|
1008
|
-
|
|
1009
|
-
<a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) ⇒ Hash </a>
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
</span>
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
<span class="summary_desc"><div class='inline'>
|
|
1024
|
-
<p>Search Agent's BuyerTransactions in Moxi Works Platform.</p>
|
|
1025
|
-
</div></span>
|
|
1026
|
-
|
|
1027
|
-
</li>
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
<li class="public ">
|
|
1031
|
-
<span class="summary_signature">
|
|
1032
|
-
|
|
1033
|
-
<a href="#send_request-class_method" title="send_request (class method)">.<strong>send_request</strong>(method, opts = {}, url = nil) ⇒ MoxiworksPlatform::BuyerTransaction </a>
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
</span>
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
<span class="summary_desc"><div class='inline'>
|
|
1048
|
-
<p>Send our remote request to the Moxi Works Platform.</p>
|
|
1049
|
-
</div></span>
|
|
1050
|
-
|
|
1051
|
-
</li>
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
<li class="public ">
|
|
1055
|
-
<span class="summary_signature">
|
|
1056
|
-
|
|
1057
|
-
<a href="#update-class_method" title="update (class method)">.<strong>update</strong>(opts = {}) ⇒ MoxiworksPlatform::BuyerTransaction </a>
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
</span>
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
<span class="summary_desc"><div class='inline'>
|
|
1072
|
-
<p>Updates an existing BuyerTransaction in Leads Gateway.</p>
|
|
1073
|
-
</div></span>
|
|
1074
|
-
|
|
1075
|
-
</li>
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
</ul>
|
|
1079
|
-
|
|
1080
|
-
<h2>
|
|
1081
|
-
Instance Method Summary
|
|
1082
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
1083
|
-
</h2>
|
|
1084
|
-
|
|
1085
|
-
<ul class="summary">
|
|
1086
|
-
|
|
1087
|
-
<li class="public ">
|
|
1088
|
-
<span class="summary_signature">
|
|
1089
|
-
|
|
1090
|
-
<a href="#promote-instance_method" title="#promote (instance method)">#<strong>promote</strong> ⇒ Object </a>
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
</span>
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
1105
|
-
|
|
1106
|
-
</li>
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
<li class="public ">
|
|
1110
|
-
<span class="summary_signature">
|
|
1111
|
-
|
|
1112
|
-
<a href="#save-instance_method" title="#save (instance method)">#<strong>save</strong> ⇒ MoxiWorksPlatform:BuyerTransaction </a>
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
</span>
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
<span class="summary_desc"><div class='inline'>
|
|
1127
|
-
<p>Save an instance of MoxiWorksPlatform::BuyerTransaction to Moxi Works
|
|
1128
|
-
Platform.</p>
|
|
1129
|
-
</div></span>
|
|
1130
|
-
|
|
1131
|
-
</li>
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
</ul>
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
|
|
1147
|
-
<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>
|
|
1148
|
-
<div id="constructor_details" class="method_details_list">
|
|
1149
|
-
<h2>Constructor Details</h2>
|
|
1150
|
-
|
|
1151
|
-
<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>
|
|
1152
|
-
|
|
1153
|
-
</div>
|
|
1154
|
-
<div id="method_missing_details" class="method_details_list">
|
|
1155
|
-
<h2>Dynamic Method Handling</h2>
|
|
1156
|
-
<p class="notice super">
|
|
1157
|
-
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
1158
|
-
|
|
1159
|
-
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>
|
|
1160
|
-
|
|
1161
|
-
</p>
|
|
1162
|
-
|
|
1163
|
-
</div>
|
|
1164
|
-
|
|
1165
|
-
<div id="instance_attr_details" class="attr_details">
|
|
1166
|
-
<h2>Instance Attribute Details</h2>
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
<span id="address=-instance_method"></span>
|
|
1170
|
-
<div class="method_details first">
|
|
1171
|
-
<h3 class="signature first" id="address-instance_method">
|
|
1172
|
-
|
|
1173
|
-
#<strong>address</strong> ⇒ <tt>String</tt>
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
</h3><div class="docstring">
|
|
1180
|
-
<div class="discussion">
|
|
1181
|
-
|
|
1182
|
-
<p>Returns street address of property being sold</p>
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
</div>
|
|
1186
|
-
</div>
|
|
1187
|
-
<div class="tags">
|
|
1188
|
-
|
|
1189
|
-
<p class="tag_title">Returns:</p>
|
|
1190
|
-
<ul class="return">
|
|
1191
|
-
|
|
1192
|
-
<li>
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
—
|
|
1200
|
-
<div class='inline'>
|
|
1201
|
-
<p>street address of property being sold</p>
|
|
1202
|
-
</div>
|
|
1203
|
-
|
|
1204
|
-
</li>
|
|
1205
|
-
|
|
1206
|
-
</ul>
|
|
1207
|
-
|
|
1208
|
-
</div><table class="source_code">
|
|
1209
|
-
<tr>
|
|
1210
|
-
<td>
|
|
1211
|
-
<pre class="lines">
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
84
|
|
1215
|
-
85
|
|
1216
|
-
86</pre>
|
|
1217
|
-
</td>
|
|
1218
|
-
<td>
|
|
1219
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 84</span>
|
|
1220
|
-
|
|
1221
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_address'>address</span>
|
|
1222
|
-
<span class='ivar'>@address</span>
|
|
1223
|
-
<span class='kw'>end</span></pre>
|
|
1224
|
-
</td>
|
|
1225
|
-
</tr>
|
|
1226
|
-
</table>
|
|
1227
|
-
</div>
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
<span id="area_of_interest=-instance_method"></span>
|
|
1231
|
-
<div class="method_details ">
|
|
1232
|
-
<h3 class="signature " id="area_of_interest-instance_method">
|
|
1233
|
-
|
|
1234
|
-
#<strong>area_of_interest</strong> ⇒ <tt>String</tt>
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
</h3><div class="docstring">
|
|
1241
|
-
<div class="discussion">
|
|
1242
|
-
|
|
1243
|
-
<p>Returns string representing a locality that the client is interested in
|
|
1244
|
-
purchasing a property in</p>
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
</div>
|
|
1248
|
-
</div>
|
|
1249
|
-
<div class="tags">
|
|
1250
|
-
|
|
1251
|
-
<p class="tag_title">Returns:</p>
|
|
1252
|
-
<ul class="return">
|
|
1253
|
-
|
|
1254
|
-
<li>
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
—
|
|
1262
|
-
<div class='inline'>
|
|
1263
|
-
<p>string representing a locality that the client is interested in purchasing
|
|
1264
|
-
a property in</p>
|
|
1265
|
-
</div>
|
|
1266
|
-
|
|
1267
|
-
</li>
|
|
1268
|
-
|
|
1269
|
-
</ul>
|
|
1270
|
-
|
|
1271
|
-
</div><table class="source_code">
|
|
1272
|
-
<tr>
|
|
1273
|
-
<td>
|
|
1274
|
-
<pre class="lines">
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
149
|
|
1278
|
-
150
|
|
1279
|
-
151</pre>
|
|
1280
|
-
</td>
|
|
1281
|
-
<td>
|
|
1282
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 149</span>
|
|
1283
|
-
|
|
1284
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_area_of_interest'>area_of_interest</span>
|
|
1285
|
-
<span class='ivar'>@area_of_interest</span>
|
|
1286
|
-
<span class='kw'>end</span></pre>
|
|
1287
|
-
</td>
|
|
1288
|
-
</tr>
|
|
1289
|
-
</table>
|
|
1290
|
-
</div>
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
<span id="city=-instance_method"></span>
|
|
1294
|
-
<div class="method_details ">
|
|
1295
|
-
<h3 class="signature " id="city-instance_method">
|
|
1296
|
-
|
|
1297
|
-
#<strong>city</strong> ⇒ <tt>String</tt>
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
</h3><div class="docstring">
|
|
1304
|
-
<div class="discussion">
|
|
1305
|
-
|
|
1306
|
-
<p>Returns city or township of property being sold</p>
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
</div>
|
|
1310
|
-
</div>
|
|
1311
|
-
<div class="tags">
|
|
1312
|
-
|
|
1313
|
-
<p class="tag_title">Returns:</p>
|
|
1314
|
-
<ul class="return">
|
|
1315
|
-
|
|
1316
|
-
<li>
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
—
|
|
1324
|
-
<div class='inline'>
|
|
1325
|
-
<p>city or township of property being sold</p>
|
|
1326
|
-
</div>
|
|
1327
|
-
|
|
1328
|
-
</li>
|
|
1329
|
-
|
|
1330
|
-
</ul>
|
|
1331
|
-
|
|
1332
|
-
</div><table class="source_code">
|
|
1333
|
-
<tr>
|
|
1334
|
-
<td>
|
|
1335
|
-
<pre class="lines">
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
90
|
|
1339
|
-
91
|
|
1340
|
-
92</pre>
|
|
1341
|
-
</td>
|
|
1342
|
-
<td>
|
|
1343
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 90</span>
|
|
1344
|
-
|
|
1345
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_city'>city</span>
|
|
1346
|
-
<span class='ivar'>@city</span>
|
|
1347
|
-
<span class='kw'>end</span></pre>
|
|
1348
|
-
</td>
|
|
1349
|
-
</tr>
|
|
1350
|
-
</table>
|
|
1351
|
-
</div>
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
<span id="closing_price=-instance_method"></span>
|
|
1355
|
-
<div class="method_details ">
|
|
1356
|
-
<h3 class="signature " id="closing_price-instance_method">
|
|
1357
|
-
|
|
1358
|
-
#<strong>closing_price</strong> ⇒ <tt>Integer</tt>
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
</h3><div class="docstring">
|
|
1365
|
-
<div class="discussion">
|
|
1366
|
-
|
|
1367
|
-
<p>This is the closing price for the sale . This should be null if the
|
|
1368
|
-
BuyerTransaction is not yet in stage 5 (complete).</p>
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
</div>
|
|
1372
|
-
</div>
|
|
1373
|
-
<div class="tags">
|
|
1374
|
-
|
|
1375
|
-
<p class="tag_title">Returns:</p>
|
|
1376
|
-
<ul class="return">
|
|
1377
|
-
|
|
1378
|
-
<li>
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
—
|
|
1386
|
-
<div class='inline'>
|
|
1387
|
-
<p>closing price for this BuyerTransaction</p>
|
|
1388
|
-
</div>
|
|
1389
|
-
|
|
1390
|
-
</li>
|
|
1391
|
-
|
|
1392
|
-
</ul>
|
|
1393
|
-
|
|
1394
|
-
</div><table class="source_code">
|
|
1395
|
-
<tr>
|
|
1396
|
-
<td>
|
|
1397
|
-
<pre class="lines">
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
243
|
|
1401
|
-
244
|
|
1402
|
-
245</pre>
|
|
1403
|
-
</td>
|
|
1404
|
-
<td>
|
|
1405
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 243</span>
|
|
1406
|
-
|
|
1407
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_closing_price'>closing_price</span>
|
|
1408
|
-
<span class='ivar'>@closing_price</span>
|
|
1409
|
-
<span class='kw'>end</span></pre>
|
|
1410
|
-
</td>
|
|
1411
|
-
</tr>
|
|
1412
|
-
</table>
|
|
1413
|
-
</div>
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
<span id="closing_timestamp=-instance_method"></span>
|
|
1417
|
-
<div class="method_details ">
|
|
1418
|
-
<h3 class="signature " id="closing_timestamp-instance_method">
|
|
1419
|
-
|
|
1420
|
-
#<strong>closing_timestamp</strong> ⇒ <tt>Integer</tt>
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
</h3><div class="docstring">
|
|
1427
|
-
<div class="discussion">
|
|
1428
|
-
|
|
1429
|
-
<p>A Unix timestamp representing the point in time when the transaction for
|
|
1430
|
-
this BuyerTransaction object was completed. This should be null if the
|
|
1431
|
-
BuyerTransaction is not yet in stage 5 (complete).</p>
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
</div>
|
|
1435
|
-
</div>
|
|
1436
|
-
<div class="tags">
|
|
1437
|
-
|
|
1438
|
-
<p class="tag_title">Returns:</p>
|
|
1439
|
-
<ul class="return">
|
|
1440
|
-
|
|
1441
|
-
<li>
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
—
|
|
1449
|
-
<div class='inline'>
|
|
1450
|
-
<p>Unix timestamp representing the date the transaction closed</p>
|
|
1451
|
-
</div>
|
|
1452
|
-
|
|
1453
|
-
</li>
|
|
1454
|
-
|
|
1455
|
-
</ul>
|
|
1456
|
-
|
|
1457
|
-
</div><table class="source_code">
|
|
1458
|
-
<tr>
|
|
1459
|
-
<td>
|
|
1460
|
-
<pre class="lines">
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
253
|
|
1464
|
-
254
|
|
1465
|
-
255</pre>
|
|
1466
|
-
</td>
|
|
1467
|
-
<td>
|
|
1468
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 253</span>
|
|
1469
|
-
|
|
1470
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_closing_timestamp'>closing_timestamp</span>
|
|
1471
|
-
<span class='ivar'>@closing_timestamp</span>
|
|
1472
|
-
<span class='kw'>end</span></pre>
|
|
1473
|
-
</td>
|
|
1474
|
-
</tr>
|
|
1475
|
-
</table>
|
|
1476
|
-
</div>
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
<span id="commission_flat_fee=-instance_method"></span>
|
|
1480
|
-
<div class="method_details ">
|
|
1481
|
-
<h3 class="signature " id="commission_flat_fee-instance_method">
|
|
1482
|
-
|
|
1483
|
-
#<strong>commission_flat_fee</strong> ⇒ <tt>Integer</tt>
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
</h3><div class="docstring">
|
|
1490
|
-
<div class="discussion">
|
|
1491
|
-
|
|
1492
|
-
<p>If the agent is to receive a flat-rate commission upon sale of the property
|
|
1493
|
-
associated with this BuyerTransaction, then this will represent the
|
|
1494
|
-
commission that the agent is to receive. This should be null if the
|
|
1495
|
-
BuyerTransaction uses commission_percentage.</p>
|
|
1496
|
-
|
|
1497
|
-
<p>– both commission_flat_fee and commission_percentage cannot be set</p>
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
</div>
|
|
1501
|
-
</div>
|
|
1502
|
-
<div class="tags">
|
|
1503
|
-
|
|
1504
|
-
<p class="tag_title">Returns:</p>
|
|
1505
|
-
<ul class="return">
|
|
1506
|
-
|
|
1507
|
-
<li>
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
</li>
|
|
1515
|
-
|
|
1516
|
-
</ul>
|
|
1517
|
-
|
|
1518
|
-
</div><table class="source_code">
|
|
1519
|
-
<tr>
|
|
1520
|
-
<td>
|
|
1521
|
-
<pre class="lines">
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
201
|
|
1525
|
-
202
|
|
1526
|
-
203</pre>
|
|
1527
|
-
</td>
|
|
1528
|
-
<td>
|
|
1529
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 201</span>
|
|
1530
|
-
|
|
1531
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_commission_flat_fee'>commission_flat_fee</span>
|
|
1532
|
-
<span class='ivar'>@commission_flat_fee</span>
|
|
1533
|
-
<span class='kw'>end</span></pre>
|
|
1534
|
-
</td>
|
|
1535
|
-
</tr>
|
|
1536
|
-
</table>
|
|
1537
|
-
</div>
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
<span id="commission_percentage=-instance_method"></span>
|
|
1541
|
-
<div class="method_details ">
|
|
1542
|
-
<h3 class="signature " id="commission_percentage-instance_method">
|
|
1543
|
-
|
|
1544
|
-
#<strong>commission_percentage</strong> ⇒ <tt>Float</tt>
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
</h3><div class="docstring">
|
|
1551
|
-
<div class="discussion">
|
|
1552
|
-
|
|
1553
|
-
<p>If the agent is to receive commission based on percentage of sale price for
|
|
1554
|
-
the property associated with this BuyerTransaction, then this will
|
|
1555
|
-
represent the commission that the agent is to receive.This should be null
|
|
1556
|
-
if the BuyerTransaction uses commission_flat_fee.</p>
|
|
1557
|
-
|
|
1558
|
-
<p>– both commission_flat_fee and commission_percentage cannot be set</p>
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
</div>
|
|
1562
|
-
</div>
|
|
1563
|
-
<div class="tags">
|
|
1564
|
-
|
|
1565
|
-
<p class="tag_title">Returns:</p>
|
|
1566
|
-
<ul class="return">
|
|
1567
|
-
|
|
1568
|
-
<li>
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
<span class='type'>(<tt>Float</tt>)</span>
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
</li>
|
|
1576
|
-
|
|
1577
|
-
</ul>
|
|
1578
|
-
|
|
1579
|
-
</div><table class="source_code">
|
|
1580
|
-
<tr>
|
|
1581
|
-
<td>
|
|
1582
|
-
<pre class="lines">
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
189
|
|
1586
|
-
190
|
|
1587
|
-
191</pre>
|
|
1588
|
-
</td>
|
|
1589
|
-
<td>
|
|
1590
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 189</span>
|
|
1591
|
-
|
|
1592
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_commission_percentage'>commission_percentage</span>
|
|
1593
|
-
<span class='ivar'>@commission_percentage</span>
|
|
1594
|
-
<span class='kw'>end</span></pre>
|
|
1595
|
-
</td>
|
|
1596
|
-
</tr>
|
|
1597
|
-
</table>
|
|
1598
|
-
</div>
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
<span id="is_mls_transaction=-instance_method"></span>
|
|
1602
|
-
<div class="method_details ">
|
|
1603
|
-
<h3 class="signature " id="is_mls_transaction-instance_method">
|
|
1604
|
-
|
|
1605
|
-
#<strong>is_mls_transaction</strong> ⇒ <tt>Boolean</tt>
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
</h3><div class="docstring">
|
|
1612
|
-
<div class="discussion">
|
|
1613
|
-
|
|
1614
|
-
<p>Returns Whether the property is being listed on an MLS.</p>
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
</div>
|
|
1618
|
-
</div>
|
|
1619
|
-
<div class="tags">
|
|
1620
|
-
|
|
1621
|
-
<p class="tag_title">Returns:</p>
|
|
1622
|
-
<ul class="return">
|
|
1623
|
-
|
|
1624
|
-
<li>
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
—
|
|
1632
|
-
<div class='inline'>
|
|
1633
|
-
<p>Whether the property is being listed on an MLS.</p>
|
|
1634
|
-
</div>
|
|
1635
|
-
|
|
1636
|
-
</li>
|
|
1637
|
-
|
|
1638
|
-
</ul>
|
|
1639
|
-
|
|
1640
|
-
</div><table class="source_code">
|
|
1641
|
-
<tr>
|
|
1642
|
-
<td>
|
|
1643
|
-
<pre class="lines">
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
156
|
|
1647
|
-
157
|
|
1648
|
-
158</pre>
|
|
1649
|
-
</td>
|
|
1650
|
-
<td>
|
|
1651
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 156</span>
|
|
1652
|
-
|
|
1653
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_is_mls_transaction'>is_mls_transaction</span>
|
|
1654
|
-
<span class='ivar'>@is_mls_transaction</span>
|
|
1655
|
-
<span class='kw'>end</span></pre>
|
|
1656
|
-
</td>
|
|
1657
|
-
</tr>
|
|
1658
|
-
</table>
|
|
1659
|
-
</div>
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
<span id="max_baths=-instance_method"></span>
|
|
1663
|
-
<div class="method_details ">
|
|
1664
|
-
<h3 class="signature " id="max_baths-instance_method">
|
|
1665
|
-
|
|
1666
|
-
#<strong>max_baths</strong> ⇒ <tt>Float</tt>
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
</h3><div class="docstring">
|
|
1673
|
-
<div class="discussion">
|
|
1674
|
-
|
|
1675
|
-
<p>Returns maximum desired bathrooms in potential properties</p>
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
</div>
|
|
1679
|
-
</div>
|
|
1680
|
-
<div class="tags">
|
|
1681
|
-
|
|
1682
|
-
<p class="tag_title">Returns:</p>
|
|
1683
|
-
<ul class="return">
|
|
1684
|
-
|
|
1685
|
-
<li>
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
<span class='type'>(<tt>Float</tt>)</span>
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
—
|
|
1693
|
-
<div class='inline'>
|
|
1694
|
-
<p>maximum desired bathrooms in potential properties</p>
|
|
1695
|
-
</div>
|
|
1696
|
-
|
|
1697
|
-
</li>
|
|
1698
|
-
|
|
1699
|
-
</ul>
|
|
1700
|
-
|
|
1701
|
-
</div><table class="source_code">
|
|
1702
|
-
<tr>
|
|
1703
|
-
<td>
|
|
1704
|
-
<pre class="lines">
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
142
|
|
1708
|
-
143
|
|
1709
|
-
144</pre>
|
|
1710
|
-
</td>
|
|
1711
|
-
<td>
|
|
1712
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 142</span>
|
|
1713
|
-
|
|
1714
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_max_baths'>max_baths</span>
|
|
1715
|
-
<span class='ivar'>@max_baths</span>
|
|
1716
|
-
<span class='kw'>end</span></pre>
|
|
1717
|
-
</td>
|
|
1718
|
-
</tr>
|
|
1719
|
-
</table>
|
|
1720
|
-
</div>
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
<span id="max_beds=-instance_method"></span>
|
|
1724
|
-
<div class="method_details ">
|
|
1725
|
-
<h3 class="signature " id="max_beds-instance_method">
|
|
1726
|
-
|
|
1727
|
-
#<strong>max_beds</strong> ⇒ <tt>Integer</tt>
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
</h3><div class="docstring">
|
|
1734
|
-
<div class="discussion">
|
|
1735
|
-
|
|
1736
|
-
<p>Returns maximum desired bedrooms in potential properties</p>
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
</div>
|
|
1740
|
-
</div>
|
|
1741
|
-
<div class="tags">
|
|
1742
|
-
|
|
1743
|
-
<p class="tag_title">Returns:</p>
|
|
1744
|
-
<ul class="return">
|
|
1745
|
-
|
|
1746
|
-
<li>
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
—
|
|
1754
|
-
<div class='inline'>
|
|
1755
|
-
<p>maximum desired bedrooms in potential properties</p>
|
|
1756
|
-
</div>
|
|
1757
|
-
|
|
1758
|
-
</li>
|
|
1759
|
-
|
|
1760
|
-
</ul>
|
|
1761
|
-
|
|
1762
|
-
</div><table class="source_code">
|
|
1763
|
-
<tr>
|
|
1764
|
-
<td>
|
|
1765
|
-
<pre class="lines">
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
128
|
|
1769
|
-
129
|
|
1770
|
-
130</pre>
|
|
1771
|
-
</td>
|
|
1772
|
-
<td>
|
|
1773
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 128</span>
|
|
1774
|
-
|
|
1775
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_max_beds'>max_beds</span>
|
|
1776
|
-
<span class='ivar'>@max_beds</span>
|
|
1777
|
-
<span class='kw'>end</span></pre>
|
|
1778
|
-
</td>
|
|
1779
|
-
</tr>
|
|
1780
|
-
</table>
|
|
1781
|
-
</div>
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
<span id="max_price=-instance_method"></span>
|
|
1785
|
-
<div class="method_details ">
|
|
1786
|
-
<h3 class="signature " id="max_price-instance_method">
|
|
1787
|
-
|
|
1788
|
-
#<strong>max_price</strong> ⇒ <tt>Integer</tt>
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
</h3><div class="docstring">
|
|
1795
|
-
<div class="discussion">
|
|
1796
|
-
|
|
1797
|
-
<p>The maximum desired price range for potential properties if using a price
|
|
1798
|
-
range rather than target price.</p>
|
|
1799
|
-
|
|
1800
|
-
<p>– both target_price and max_price cannot be set</p>
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
</div>
|
|
1804
|
-
</div>
|
|
1805
|
-
<div class="tags">
|
|
1806
|
-
|
|
1807
|
-
<p class="tag_title">Returns:</p>
|
|
1808
|
-
<ul class="return">
|
|
1809
|
-
|
|
1810
|
-
<li>
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
</li>
|
|
1818
|
-
|
|
1819
|
-
</ul>
|
|
1820
|
-
|
|
1821
|
-
</div><table class="source_code">
|
|
1822
|
-
<tr>
|
|
1823
|
-
<td>
|
|
1824
|
-
<pre class="lines">
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
234
|
|
1828
|
-
235
|
|
1829
|
-
236</pre>
|
|
1830
|
-
</td>
|
|
1831
|
-
<td>
|
|
1832
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 234</span>
|
|
1833
|
-
|
|
1834
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_max_price'>max_price</span>
|
|
1835
|
-
<span class='ivar'>@max_price</span>
|
|
1836
|
-
<span class='kw'>end</span></pre>
|
|
1837
|
-
</td>
|
|
1838
|
-
</tr>
|
|
1839
|
-
</table>
|
|
1840
|
-
</div>
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
<span id="max_sqft=-instance_method"></span>
|
|
1844
|
-
<div class="method_details ">
|
|
1845
|
-
<h3 class="signature " id="max_sqft-instance_method">
|
|
1846
|
-
|
|
1847
|
-
#<strong>max_sqft</strong> ⇒ <tt>Integer</tt>
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
</h3><div class="docstring">
|
|
1854
|
-
<div class="discussion">
|
|
1855
|
-
|
|
1856
|
-
<p>Returns maximum desired living area of potential properties</p>
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
</div>
|
|
1860
|
-
</div>
|
|
1861
|
-
<div class="tags">
|
|
1862
|
-
|
|
1863
|
-
<p class="tag_title">Returns:</p>
|
|
1864
|
-
<ul class="return">
|
|
1865
|
-
|
|
1866
|
-
<li>
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
—
|
|
1874
|
-
<div class='inline'>
|
|
1875
|
-
<p>maximum desired living area of potential properties</p>
|
|
1876
|
-
</div>
|
|
1877
|
-
|
|
1878
|
-
</li>
|
|
1879
|
-
|
|
1880
|
-
</ul>
|
|
1881
|
-
|
|
1882
|
-
</div><table class="source_code">
|
|
1883
|
-
<tr>
|
|
1884
|
-
<td>
|
|
1885
|
-
<pre class="lines">
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
114
|
|
1889
|
-
115
|
|
1890
|
-
116</pre>
|
|
1891
|
-
</td>
|
|
1892
|
-
<td>
|
|
1893
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 114</span>
|
|
1894
|
-
|
|
1895
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_max_sqft'>max_sqft</span>
|
|
1896
|
-
<span class='ivar'>@max_sqft</span>
|
|
1897
|
-
<span class='kw'>end</span></pre>
|
|
1898
|
-
</td>
|
|
1899
|
-
</tr>
|
|
1900
|
-
</table>
|
|
1901
|
-
</div>
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
<span id="min_baths=-instance_method"></span>
|
|
1905
|
-
<div class="method_details ">
|
|
1906
|
-
<h3 class="signature " id="min_baths-instance_method">
|
|
1907
|
-
|
|
1908
|
-
#<strong>min_baths</strong> ⇒ <tt>Float</tt>
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
</h3><div class="docstring">
|
|
1915
|
-
<div class="discussion">
|
|
1916
|
-
|
|
1917
|
-
<p>Returns minimum desired bathrooms in potential properties</p>
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
</div>
|
|
1921
|
-
</div>
|
|
1922
|
-
<div class="tags">
|
|
1923
|
-
|
|
1924
|
-
<p class="tag_title">Returns:</p>
|
|
1925
|
-
<ul class="return">
|
|
1926
|
-
|
|
1927
|
-
<li>
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
<span class='type'>(<tt>Float</tt>)</span>
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
—
|
|
1935
|
-
<div class='inline'>
|
|
1936
|
-
<p>minimum desired bathrooms in potential properties</p>
|
|
1937
|
-
</div>
|
|
1938
|
-
|
|
1939
|
-
</li>
|
|
1940
|
-
|
|
1941
|
-
</ul>
|
|
1942
|
-
|
|
1943
|
-
</div><table class="source_code">
|
|
1944
|
-
<tr>
|
|
1945
|
-
<td>
|
|
1946
|
-
<pre class="lines">
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
135
|
|
1950
|
-
136
|
|
1951
|
-
137</pre>
|
|
1952
|
-
</td>
|
|
1953
|
-
<td>
|
|
1954
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 135</span>
|
|
1955
|
-
|
|
1956
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_min_baths'>min_baths</span>
|
|
1957
|
-
<span class='ivar'>@min_baths</span>
|
|
1958
|
-
<span class='kw'>end</span></pre>
|
|
1959
|
-
</td>
|
|
1960
|
-
</tr>
|
|
1961
|
-
</table>
|
|
1962
|
-
</div>
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
<span id="min_beds=-instance_method"></span>
|
|
1966
|
-
<div class="method_details ">
|
|
1967
|
-
<h3 class="signature " id="min_beds-instance_method">
|
|
1968
|
-
|
|
1969
|
-
#<strong>min_beds</strong> ⇒ <tt>Integer</tt>
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
</h3><div class="docstring">
|
|
1976
|
-
<div class="discussion">
|
|
1977
|
-
|
|
1978
|
-
<p>Returns minimum desired bedrooms in potential properties</p>
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
</div>
|
|
1982
|
-
</div>
|
|
1983
|
-
<div class="tags">
|
|
1984
|
-
|
|
1985
|
-
<p class="tag_title">Returns:</p>
|
|
1986
|
-
<ul class="return">
|
|
1987
|
-
|
|
1988
|
-
<li>
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
—
|
|
1996
|
-
<div class='inline'>
|
|
1997
|
-
<p>minimum desired bedrooms in potential properties</p>
|
|
1998
|
-
</div>
|
|
1999
|
-
|
|
2000
|
-
</li>
|
|
2001
|
-
|
|
2002
|
-
</ul>
|
|
2003
|
-
|
|
2004
|
-
</div><table class="source_code">
|
|
2005
|
-
<tr>
|
|
2006
|
-
<td>
|
|
2007
|
-
<pre class="lines">
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
121
|
|
2011
|
-
122
|
|
2012
|
-
123</pre>
|
|
2013
|
-
</td>
|
|
2014
|
-
<td>
|
|
2015
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 121</span>
|
|
2016
|
-
|
|
2017
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_min_beds'>min_beds</span>
|
|
2018
|
-
<span class='ivar'>@min_beds</span>
|
|
2019
|
-
<span class='kw'>end</span></pre>
|
|
2020
|
-
</td>
|
|
2021
|
-
</tr>
|
|
2022
|
-
</table>
|
|
2023
|
-
</div>
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
<span id="min_price=-instance_method"></span>
|
|
2027
|
-
<div class="method_details ">
|
|
2028
|
-
<h3 class="signature " id="min_price-instance_method">
|
|
2029
|
-
|
|
2030
|
-
#<strong>min_price</strong> ⇒ <tt>Integer</tt>
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
</h3><div class="docstring">
|
|
2037
|
-
<div class="discussion">
|
|
2038
|
-
|
|
2039
|
-
<p>The minimum desired price range for potential properties if using a price
|
|
2040
|
-
range rather than target price.</p>
|
|
2041
|
-
|
|
2042
|
-
<p>– both target_price and min_price cannot be set</p>
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
</div>
|
|
2046
|
-
</div>
|
|
2047
|
-
<div class="tags">
|
|
2048
|
-
|
|
2049
|
-
<p class="tag_title">Returns:</p>
|
|
2050
|
-
<ul class="return">
|
|
2051
|
-
|
|
2052
|
-
<li>
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
</li>
|
|
2060
|
-
|
|
2061
|
-
</ul>
|
|
2062
|
-
|
|
2063
|
-
</div><table class="source_code">
|
|
2064
|
-
<tr>
|
|
2065
|
-
<td>
|
|
2066
|
-
<pre class="lines">
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
224
|
|
2070
|
-
225
|
|
2071
|
-
226</pre>
|
|
2072
|
-
</td>
|
|
2073
|
-
<td>
|
|
2074
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 224</span>
|
|
2075
|
-
|
|
2076
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_min_price'>min_price</span>
|
|
2077
|
-
<span class='ivar'>@min_price</span>
|
|
2078
|
-
<span class='kw'>end</span></pre>
|
|
2079
|
-
</td>
|
|
2080
|
-
</tr>
|
|
2081
|
-
</table>
|
|
2082
|
-
</div>
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
<span id="min_sqft=-instance_method"></span>
|
|
2086
|
-
<div class="method_details ">
|
|
2087
|
-
<h3 class="signature " id="min_sqft-instance_method">
|
|
2088
|
-
|
|
2089
|
-
#<strong>min_sqft</strong> ⇒ <tt>Integer</tt>
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
</h3><div class="docstring">
|
|
2096
|
-
<div class="discussion">
|
|
2097
|
-
|
|
2098
|
-
<p>Returns minimum desired living area of potential properties</p>
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
</div>
|
|
2102
|
-
</div>
|
|
2103
|
-
<div class="tags">
|
|
2104
|
-
|
|
2105
|
-
<p class="tag_title">Returns:</p>
|
|
2106
|
-
<ul class="return">
|
|
2107
|
-
|
|
2108
|
-
<li>
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
—
|
|
2116
|
-
<div class='inline'>
|
|
2117
|
-
<p>minimum desired living area of potential properties</p>
|
|
2118
|
-
</div>
|
|
2119
|
-
|
|
2120
|
-
</li>
|
|
2121
|
-
|
|
2122
|
-
</ul>
|
|
2123
|
-
|
|
2124
|
-
</div><table class="source_code">
|
|
2125
|
-
<tr>
|
|
2126
|
-
<td>
|
|
2127
|
-
<pre class="lines">
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
108
|
|
2131
|
-
109
|
|
2132
|
-
110</pre>
|
|
2133
|
-
</td>
|
|
2134
|
-
<td>
|
|
2135
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 108</span>
|
|
2136
|
-
|
|
2137
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_min_sqft'>min_sqft</span>
|
|
2138
|
-
<span class='ivar'>@min_sqft</span>
|
|
2139
|
-
<span class='kw'>end</span></pre>
|
|
2140
|
-
</td>
|
|
2141
|
-
</tr>
|
|
2142
|
-
</table>
|
|
2143
|
-
</div>
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
<span id="mls_number=-instance_method"></span>
|
|
2147
|
-
<div class="method_details ">
|
|
2148
|
-
<h3 class="signature " id="mls_number-instance_method">
|
|
2149
|
-
|
|
2150
|
-
#<strong>mls_number</strong> ⇒ <tt>String</tt>
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
</h3><div class="docstring">
|
|
2157
|
-
<div class="discussion">
|
|
2158
|
-
|
|
2159
|
-
<p>**MLS TRANSACTIONS ONLY** mls number for the listing associated with this
|
|
2160
|
-
BuyerTransaction</p>
|
|
2161
|
-
|
|
2162
|
-
<p>– mls_number should be populated only if is_mls_transaction is true.</p>
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
</div>
|
|
2166
|
-
</div>
|
|
2167
|
-
<div class="tags">
|
|
2168
|
-
|
|
2169
|
-
<p class="tag_title">Returns:</p>
|
|
2170
|
-
<ul class="return">
|
|
2171
|
-
|
|
2172
|
-
<li>
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
</li>
|
|
2180
|
-
|
|
2181
|
-
</ul>
|
|
2182
|
-
|
|
2183
|
-
</div><table class="source_code">
|
|
2184
|
-
<tr>
|
|
2185
|
-
<td>
|
|
2186
|
-
<pre class="lines">
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
166
|
|
2190
|
-
167
|
|
2191
|
-
168</pre>
|
|
2192
|
-
</td>
|
|
2193
|
-
<td>
|
|
2194
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 166</span>
|
|
2195
|
-
|
|
2196
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_mls_number'>mls_number</span>
|
|
2197
|
-
<span class='ivar'>@mls_number</span>
|
|
2198
|
-
<span class='kw'>end</span></pre>
|
|
2199
|
-
</td>
|
|
2200
|
-
</tr>
|
|
2201
|
-
</table>
|
|
2202
|
-
</div>
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
<span id="moxi_works_agent_id=-instance_method"></span>
|
|
2206
|
-
<div class="method_details ">
|
|
2207
|
-
<h3 class="signature " id="moxi_works_agent_id-instance_method">
|
|
2208
|
-
|
|
2209
|
-
#<strong>moxi_works_agent_id</strong> ⇒ <tt>String</tt>
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
</h3><div class="docstring">
|
|
2216
|
-
<div class="discussion">
|
|
2217
|
-
|
|
2218
|
-
<p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
|
|
2219
|
-
BuyerTransaction is or is to be associated with.</p>
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
</div>
|
|
2223
|
-
</div>
|
|
2224
|
-
<div class="tags">
|
|
2225
|
-
|
|
2226
|
-
<p class="tag_title">Returns:</p>
|
|
2227
|
-
<ul class="return">
|
|
2228
|
-
|
|
2229
|
-
<li>
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
—
|
|
2237
|
-
<div class='inline'>
|
|
2238
|
-
<p>the Moxi Works Platform ID of the agent</p>
|
|
2239
|
-
</div>
|
|
2240
|
-
|
|
2241
|
-
</li>
|
|
2242
|
-
|
|
2243
|
-
</ul>
|
|
2244
|
-
|
|
2245
|
-
</div><table class="source_code">
|
|
2246
|
-
<tr>
|
|
2247
|
-
<td>
|
|
2248
|
-
<pre class="lines">
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
11
|
|
2252
|
-
12
|
|
2253
|
-
13</pre>
|
|
2254
|
-
</td>
|
|
2255
|
-
<td>
|
|
2256
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 11</span>
|
|
2257
|
-
|
|
2258
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
|
|
2259
|
-
<span class='ivar'>@moxi_works_agent_id</span>
|
|
2260
|
-
<span class='kw'>end</span></pre>
|
|
2261
|
-
</td>
|
|
2262
|
-
</tr>
|
|
2263
|
-
</table>
|
|
2264
|
-
</div>
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
<span id="moxi_works_contact_id=-instance_method"></span>
|
|
2268
|
-
<div class="method_details ">
|
|
2269
|
-
<h3 class="signature " id="moxi_works_contact_id-instance_method">
|
|
2270
|
-
|
|
2271
|
-
#<strong>moxi_works_contact_id</strong> ⇒ <tt>Object</tt>
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
</h3><div class="docstring">
|
|
2278
|
-
<div class="discussion">
|
|
2279
|
-
|
|
2280
|
-
<p>The Moxi Works Platform unique identifier for the Contact</p>
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
</div>
|
|
2284
|
-
</div>
|
|
2285
|
-
<div class="tags">
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
</div><table class="source_code">
|
|
2289
|
-
<tr>
|
|
2290
|
-
<td>
|
|
2291
|
-
<pre class="lines">
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
22
|
|
2295
|
-
23
|
|
2296
|
-
24</pre>
|
|
2297
|
-
</td>
|
|
2298
|
-
<td>
|
|
2299
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 22</span>
|
|
2300
|
-
|
|
2301
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_contact_id'>moxi_works_contact_id</span>
|
|
2302
|
-
<span class='ivar'>@moxi_works_contact_id</span>
|
|
2303
|
-
<span class='kw'>end</span></pre>
|
|
2304
|
-
</td>
|
|
2305
|
-
</tr>
|
|
2306
|
-
</table>
|
|
2307
|
-
</div>
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
<span id="moxi_works_transaction_id=-instance_method"></span>
|
|
2311
|
-
<div class="method_details ">
|
|
2312
|
-
<h3 class="signature " id="moxi_works_transaction_id-instance_method">
|
|
2313
|
-
|
|
2314
|
-
#<strong>moxi_works_transaction_id</strong> ⇒ <tt>String</tt>
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
</h3><div class="docstring">
|
|
2321
|
-
<div class="discussion">
|
|
2322
|
-
|
|
2323
|
-
<p>Returns The Moxi Works Platform unique identifier for the BuyerTransaction</p>
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
</div>
|
|
2327
|
-
</div>
|
|
2328
|
-
<div class="tags">
|
|
2329
|
-
|
|
2330
|
-
<p class="tag_title">Returns:</p>
|
|
2331
|
-
<ul class="return">
|
|
2332
|
-
|
|
2333
|
-
<li>
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
—
|
|
2341
|
-
<div class='inline'>
|
|
2342
|
-
<p>The Moxi Works Platform unique identifier for the BuyerTransaction</p>
|
|
2343
|
-
</div>
|
|
2344
|
-
|
|
2345
|
-
</li>
|
|
2346
|
-
|
|
2347
|
-
</ul>
|
|
2348
|
-
|
|
2349
|
-
</div><table class="source_code">
|
|
2350
|
-
<tr>
|
|
2351
|
-
<td>
|
|
2352
|
-
<pre class="lines">
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
16
|
|
2356
|
-
17
|
|
2357
|
-
18</pre>
|
|
2358
|
-
</td>
|
|
2359
|
-
<td>
|
|
2360
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 16</span>
|
|
2361
|
-
|
|
2362
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_transaction_id'>moxi_works_transaction_id</span>
|
|
2363
|
-
<span class='ivar'>@moxi_works_transaction_id</span>
|
|
2364
|
-
<span class='kw'>end</span></pre>
|
|
2365
|
-
</td>
|
|
2366
|
-
</tr>
|
|
2367
|
-
</table>
|
|
2368
|
-
</div>
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
<span id="notes=-instance_method"></span>
|
|
2372
|
-
<div class="method_details ">
|
|
2373
|
-
<h3 class="signature " id="notes-instance_method">
|
|
2374
|
-
|
|
2375
|
-
#<strong>notes</strong> ⇒ <tt>String</tt>
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
</h3><div class="docstring">
|
|
2382
|
-
<div class="discussion">
|
|
2383
|
-
|
|
2384
|
-
<p>Brief, human readable content that is shown to the agent as notes about the
|
|
2385
|
-
BuyerTransaction. Use this attribute to store and display data to the agent
|
|
2386
|
-
that is not otherwise explicitly available via attributes for the entity.</p>
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
</div>
|
|
2390
|
-
</div>
|
|
2391
|
-
<div class="tags">
|
|
2392
|
-
|
|
2393
|
-
<p class="tag_title">Returns:</p>
|
|
2394
|
-
<ul class="return">
|
|
2395
|
-
|
|
2396
|
-
<li>
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
—
|
|
2404
|
-
<div class='inline'>
|
|
2405
|
-
<p>human readable notes about this BuyerTransaction</p>
|
|
2406
|
-
</div>
|
|
2407
|
-
|
|
2408
|
-
</li>
|
|
2409
|
-
|
|
2410
|
-
</ul>
|
|
2411
|
-
|
|
2412
|
-
</div><table class="source_code">
|
|
2413
|
-
<tr>
|
|
2414
|
-
<td>
|
|
2415
|
-
<pre class="lines">
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
50
|
|
2419
|
-
51
|
|
2420
|
-
52</pre>
|
|
2421
|
-
</td>
|
|
2422
|
-
<td>
|
|
2423
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 50</span>
|
|
2424
|
-
|
|
2425
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_notes'>notes</span>
|
|
2426
|
-
<span class='ivar'>@notes</span>
|
|
2427
|
-
<span class='kw'>end</span></pre>
|
|
2428
|
-
</td>
|
|
2429
|
-
</tr>
|
|
2430
|
-
</table>
|
|
2431
|
-
</div>
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
<span id="partner_contact_id=-instance_method"></span>
|
|
2435
|
-
<div class="method_details ">
|
|
2436
|
-
<h3 class="signature " id="partner_contact_id-instance_method">
|
|
2437
|
-
|
|
2438
|
-
#<strong>partner_contact_id</strong> ⇒ <tt>String</tt>
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
</h3><div class="docstring">
|
|
2445
|
-
<div class="discussion">
|
|
2446
|
-
|
|
2447
|
-
<p>*your system's* unique ID for the Contact</p>
|
|
2448
|
-
|
|
2449
|
-
<p>this or moxi_works_contact_id can be used in operations that require a
|
|
2450
|
-
Contact ID</p>
|
|
2451
|
-
|
|
2452
|
-
<p>this will only be populated for Contact objects that your system has
|
|
2453
|
-
created on the Moxi Works Platform</p>
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
</div>
|
|
2457
|
-
</div>
|
|
2458
|
-
<div class="tags">
|
|
2459
|
-
|
|
2460
|
-
<p class="tag_title">Returns:</p>
|
|
2461
|
-
<ul class="return">
|
|
2462
|
-
|
|
2463
|
-
<li>
|
|
2464
|
-
|
|
2465
|
-
|
|
2466
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
—
|
|
2471
|
-
<div class='inline'>
|
|
2472
|
-
<p>your system's unique ID for the contact</p>
|
|
2473
|
-
</div>
|
|
2474
|
-
|
|
2475
|
-
</li>
|
|
2476
|
-
|
|
2477
|
-
</ul>
|
|
2478
|
-
|
|
2479
|
-
</div><table class="source_code">
|
|
2480
|
-
<tr>
|
|
2481
|
-
<td>
|
|
2482
|
-
<pre class="lines">
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
32
|
|
2486
|
-
33
|
|
2487
|
-
34</pre>
|
|
2488
|
-
</td>
|
|
2489
|
-
<td>
|
|
2490
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 32</span>
|
|
2491
|
-
|
|
2492
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_partner_contact_id'>partner_contact_id</span>
|
|
2493
|
-
<span class='ivar'>@partner_contact_id</span>
|
|
2494
|
-
<span class='kw'>end</span></pre>
|
|
2495
|
-
</td>
|
|
2496
|
-
</tr>
|
|
2497
|
-
</table>
|
|
2498
|
-
</div>
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
<span id="promote_transaction=-instance_method"></span>
|
|
2502
|
-
<div class="method_details ">
|
|
2503
|
-
<h3 class="signature " id="promote_transaction-instance_method">
|
|
2504
|
-
|
|
2505
|
-
#<strong>promote_transaction</strong> ⇒ <tt>Object</tt>
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
</h3><div class="docstring">
|
|
2512
|
-
<div class="discussion">
|
|
2513
|
-
|
|
2514
|
-
<p>In order to promote a BuyerTransaction to the next stage, set the
|
|
2515
|
-
promote_transaction attribute to true. For more information about
|
|
2516
|
-
BuyerTransaction stages, see
|
|
2517
|
-
<a href="https://moxiworks-platform.github.io/#promoting-buyertransaction-stage" target="_parent" title="The Moxi Works Platform Documentation">The Moxi Works Platform Documentation</a>. promote_transaction is only available
|
|
2518
|
-
for BuyerTransaction updates. Newly created BuyerTransaction objects will
|
|
2519
|
-
automatically be created in stage 3 (active)</p>
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
</div>
|
|
2523
|
-
</div>
|
|
2524
|
-
<div class="tags">
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
</div><table class="source_code">
|
|
2528
|
-
<tr>
|
|
2529
|
-
<td>
|
|
2530
|
-
<pre class="lines">
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
263
|
|
2534
|
-
264
|
|
2535
|
-
265</pre>
|
|
2536
|
-
</td>
|
|
2537
|
-
<td>
|
|
2538
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 263</span>
|
|
2539
|
-
|
|
2540
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_promote_transaction'>promote_transaction</span>
|
|
2541
|
-
<span class='ivar'>@promote_transaction</span>
|
|
2542
|
-
<span class='kw'>end</span></pre>
|
|
2543
|
-
</td>
|
|
2544
|
-
</tr>
|
|
2545
|
-
</table>
|
|
2546
|
-
</div>
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
<span id="stage=-instance_method"></span>
|
|
2550
|
-
<div class="method_details ">
|
|
2551
|
-
<h3 class="signature " id="stage-instance_method">
|
|
2552
|
-
|
|
2553
|
-
#<strong>stage</strong> ⇒ <tt>Object</tt>
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
</h3><div class="docstring">
|
|
2560
|
-
<div class="discussion">
|
|
2561
|
-
|
|
2562
|
-
<p>Each BuyerTransaction has five stages (1-5). stage displays the</p>
|
|
2563
|
-
|
|
2564
|
-
<pre class="code ruby"><code class="ruby">stage number that the BuyerTransaction is currently in.</code></pre>
|
|
2565
|
-
|
|
2566
|
-
<p>This will be a single digit integer that can be [1,2,3,4,5].</p>
|
|
2567
|
-
|
|
2568
|
-
<pre class="code ruby"><code class="ruby">For more information on BuyerTransaction stages see
|
|
2569
|
-
{https://moxiworks-platform.github.io/#buyertransaction-stages The Moxi Works Platform Documentation}</code></pre>
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
</div>
|
|
2573
|
-
</div>
|
|
2574
|
-
<div class="tags">
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
</div><table class="source_code">
|
|
2578
|
-
<tr>
|
|
2579
|
-
<td>
|
|
2580
|
-
<pre class="lines">
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
62
|
|
2584
|
-
63
|
|
2585
|
-
64</pre>
|
|
2586
|
-
</td>
|
|
2587
|
-
<td>
|
|
2588
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 62</span>
|
|
2589
|
-
|
|
2590
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_stage'>stage</span>
|
|
2591
|
-
<span class='ivar'>@stage</span>
|
|
2592
|
-
<span class='kw'>end</span></pre>
|
|
2593
|
-
</td>
|
|
2594
|
-
</tr>
|
|
2595
|
-
</table>
|
|
2596
|
-
</div>
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
<span id="stage_name=-instance_method"></span>
|
|
2600
|
-
<div class="method_details ">
|
|
2601
|
-
<h3 class="signature " id="stage_name-instance_method">
|
|
2602
|
-
|
|
2603
|
-
#<strong>stage_name</strong> ⇒ <tt>Object</tt>
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
</h3><div class="docstring">
|
|
2610
|
-
<div class="discussion">
|
|
2611
|
-
|
|
2612
|
-
<p>This attribute displays a human readable stage name that is associated with
|
|
2613
|
-
the current stage attribute. When created through the Moxi Works Platform
|
|
2614
|
-
BuyerTransaction objects will automatically be configured as
|
|
2615
|
-
'active' transactions.</p>
|
|
2616
|
-
|
|
2617
|
-
<p>This will be an enumerated string that can be can be 'initialized',
|
|
2618
|
-
'configured' , 'active' , 'pending' or
|
|
2619
|
-
'complete' For more information on BuyerTransaction stages see</p>
|
|
2620
|
-
|
|
2621
|
-
<pre class="code ruby"><code class="ruby">{https://moxiworks-platform.github.io/#buyertransaction-stages The Moxi Works Platform Documentation}</code></pre>
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
</div>
|
|
2625
|
-
</div>
|
|
2626
|
-
<div class="tags">
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
</div><table class="source_code">
|
|
2630
|
-
<tr>
|
|
2631
|
-
<td>
|
|
2632
|
-
<pre class="lines">
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
78
|
|
2636
|
-
79
|
|
2637
|
-
80</pre>
|
|
2638
|
-
</td>
|
|
2639
|
-
<td>
|
|
2640
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 78</span>
|
|
2641
|
-
|
|
2642
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_stage_name'>stage_name</span>
|
|
2643
|
-
<span class='ivar'>@stage_name</span>
|
|
2644
|
-
<span class='kw'>end</span></pre>
|
|
2645
|
-
</td>
|
|
2646
|
-
</tr>
|
|
2647
|
-
</table>
|
|
2648
|
-
</div>
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
<span id="start_timestamp=-instance_method"></span>
|
|
2652
|
-
<div class="method_details ">
|
|
2653
|
-
<h3 class="signature " id="start_timestamp-instance_method">
|
|
2654
|
-
|
|
2655
|
-
#<strong>start_timestamp</strong> ⇒ <tt>Object</tt>
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
</h3><div class="docstring">
|
|
2662
|
-
<div class="discussion">
|
|
2663
|
-
|
|
2664
|
-
<p>this is the Unix timestamp</p>
|
|
2665
|
-
|
|
2666
|
-
<pre class="code ruby"><code class="ruby">representing the date the agent initiated transaction discussions
|
|
2667
|
-
with the client.</code></pre>
|
|
2668
|
-
|
|
2669
|
-
|
|
2670
|
-
</div>
|
|
2671
|
-
</div>
|
|
2672
|
-
<div class="tags">
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
</div><table class="source_code">
|
|
2676
|
-
<tr>
|
|
2677
|
-
<td>
|
|
2678
|
-
<pre class="lines">
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
176
|
|
2682
|
-
177
|
|
2683
|
-
178</pre>
|
|
2684
|
-
</td>
|
|
2685
|
-
<td>
|
|
2686
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 176</span>
|
|
2687
|
-
|
|
2688
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_start_timestamp'>start_timestamp</span>
|
|
2689
|
-
<span class='ivar'>@start_timestamp</span>
|
|
2690
|
-
<span class='kw'>end</span></pre>
|
|
2691
|
-
</td>
|
|
2692
|
-
</tr>
|
|
2693
|
-
</table>
|
|
2694
|
-
</div>
|
|
2695
|
-
|
|
2696
|
-
|
|
2697
|
-
<span id="state=-instance_method"></span>
|
|
2698
|
-
<div class="method_details ">
|
|
2699
|
-
<h3 class="signature " id="state-instance_method">
|
|
2700
|
-
|
|
2701
|
-
#<strong>state</strong> ⇒ <tt>String</tt>
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
</h3><div class="docstring">
|
|
2708
|
-
<div class="discussion">
|
|
2709
|
-
|
|
2710
|
-
<p>Returns state or province of property being sold</p>
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
</div>
|
|
2714
|
-
</div>
|
|
2715
|
-
<div class="tags">
|
|
2716
|
-
|
|
2717
|
-
<p class="tag_title">Returns:</p>
|
|
2718
|
-
<ul class="return">
|
|
2719
|
-
|
|
2720
|
-
<li>
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
—
|
|
2728
|
-
<div class='inline'>
|
|
2729
|
-
<p>state or province of property being sold</p>
|
|
2730
|
-
</div>
|
|
2731
|
-
|
|
2732
|
-
</li>
|
|
2733
|
-
|
|
2734
|
-
</ul>
|
|
2735
|
-
|
|
2736
|
-
</div><table class="source_code">
|
|
2737
|
-
<tr>
|
|
2738
|
-
<td>
|
|
2739
|
-
<pre class="lines">
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
96
|
|
2743
|
-
97
|
|
2744
|
-
98</pre>
|
|
2745
|
-
</td>
|
|
2746
|
-
<td>
|
|
2747
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 96</span>
|
|
2748
|
-
|
|
2749
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
|
|
2750
|
-
<span class='ivar'>@state</span>
|
|
2751
|
-
<span class='kw'>end</span></pre>
|
|
2752
|
-
</td>
|
|
2753
|
-
</tr>
|
|
2754
|
-
</table>
|
|
2755
|
-
</div>
|
|
2756
|
-
|
|
2757
|
-
|
|
2758
|
-
<span id="target_price=-instance_method"></span>
|
|
2759
|
-
<div class="method_details ">
|
|
2760
|
-
<h3 class="signature " id="target_price-instance_method">
|
|
2761
|
-
|
|
2762
|
-
#<strong>target_price</strong> ⇒ <tt>Integer</tt>
|
|
2763
|
-
|
|
2764
|
-
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
|
|
2768
|
-
</h3><div class="docstring">
|
|
2769
|
-
<div class="discussion">
|
|
2770
|
-
|
|
2771
|
-
<p>The desired selling price for the property if using target rather than
|
|
2772
|
-
range.</p>
|
|
2773
|
-
|
|
2774
|
-
<p>– both target_price and min_price cannot be set – both target_price and
|
|
2775
|
-
max_price cannot be set</p>
|
|
2776
|
-
|
|
2777
|
-
|
|
2778
|
-
</div>
|
|
2779
|
-
</div>
|
|
2780
|
-
<div class="tags">
|
|
2781
|
-
|
|
2782
|
-
<p class="tag_title">Returns:</p>
|
|
2783
|
-
<ul class="return">
|
|
2784
|
-
|
|
2785
|
-
<li>
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
|
|
2792
|
-
</li>
|
|
2793
|
-
|
|
2794
|
-
</ul>
|
|
2795
|
-
|
|
2796
|
-
</div><table class="source_code">
|
|
2797
|
-
<tr>
|
|
2798
|
-
<td>
|
|
2799
|
-
<pre class="lines">
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
213
|
|
2803
|
-
214
|
|
2804
|
-
215</pre>
|
|
2805
|
-
</td>
|
|
2806
|
-
<td>
|
|
2807
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 213</span>
|
|
2808
|
-
|
|
2809
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_target_price'>target_price</span>
|
|
2810
|
-
<span class='ivar'>@target_price</span>
|
|
2811
|
-
<span class='kw'>end</span></pre>
|
|
2812
|
-
</td>
|
|
2813
|
-
</tr>
|
|
2814
|
-
</table>
|
|
2815
|
-
</div>
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
<span id="transaction_name=-instance_method"></span>
|
|
2819
|
-
<div class="method_details ">
|
|
2820
|
-
<h3 class="signature " id="transaction_name-instance_method">
|
|
2821
|
-
|
|
2822
|
-
#<strong>transaction_name</strong> ⇒ <tt>String</tt>
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
</h3><div class="docstring">
|
|
2829
|
-
<div class="discussion">
|
|
2830
|
-
|
|
2831
|
-
<p>A brief, human readable title that is shown to the agent as the subject of
|
|
2832
|
-
the BuyerTransaction.</p>
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
</div>
|
|
2836
|
-
</div>
|
|
2837
|
-
<div class="tags">
|
|
2838
|
-
|
|
2839
|
-
<p class="tag_title">Returns:</p>
|
|
2840
|
-
<ul class="return">
|
|
2841
|
-
|
|
2842
|
-
<li>
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
—
|
|
2850
|
-
<div class='inline'>
|
|
2851
|
-
<p>name of transaction</p>
|
|
2852
|
-
</div>
|
|
2853
|
-
|
|
2854
|
-
</li>
|
|
2855
|
-
|
|
2856
|
-
</ul>
|
|
2857
|
-
|
|
2858
|
-
</div><table class="source_code">
|
|
2859
|
-
<tr>
|
|
2860
|
-
<td>
|
|
2861
|
-
<pre class="lines">
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
40
|
|
2865
|
-
41
|
|
2866
|
-
42</pre>
|
|
2867
|
-
</td>
|
|
2868
|
-
<td>
|
|
2869
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 40</span>
|
|
2870
|
-
|
|
2871
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_transaction_name'>transaction_name</span>
|
|
2872
|
-
<span class='ivar'>@transaction_name</span>
|
|
2873
|
-
<span class='kw'>end</span></pre>
|
|
2874
|
-
</td>
|
|
2875
|
-
</tr>
|
|
2876
|
-
</table>
|
|
2877
|
-
</div>
|
|
2878
|
-
|
|
2879
|
-
|
|
2880
|
-
<span id="zip_code=-instance_method"></span>
|
|
2881
|
-
<div class="method_details ">
|
|
2882
|
-
<h3 class="signature " id="zip_code-instance_method">
|
|
2883
|
-
|
|
2884
|
-
#<strong>zip_code</strong> ⇒ <tt>String</tt>
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
</h3><div class="docstring">
|
|
2891
|
-
<div class="discussion">
|
|
2892
|
-
|
|
2893
|
-
<p>Returns postal code of property being sold</p>
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
</div>
|
|
2897
|
-
</div>
|
|
2898
|
-
<div class="tags">
|
|
2899
|
-
|
|
2900
|
-
<p class="tag_title">Returns:</p>
|
|
2901
|
-
<ul class="return">
|
|
2902
|
-
|
|
2903
|
-
<li>
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
—
|
|
2911
|
-
<div class='inline'>
|
|
2912
|
-
<p>postal code of property being sold</p>
|
|
2913
|
-
</div>
|
|
2914
|
-
|
|
2915
|
-
</li>
|
|
2916
|
-
|
|
2917
|
-
</ul>
|
|
2918
|
-
|
|
2919
|
-
</div><table class="source_code">
|
|
2920
|
-
<tr>
|
|
2921
|
-
<td>
|
|
2922
|
-
<pre class="lines">
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
102
|
|
2926
|
-
103
|
|
2927
|
-
104</pre>
|
|
2928
|
-
</td>
|
|
2929
|
-
<td>
|
|
2930
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 102</span>
|
|
2931
|
-
|
|
2932
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_zip_code'>zip_code</span>
|
|
2933
|
-
<span class='ivar'>@zip_code</span>
|
|
2934
|
-
<span class='kw'>end</span></pre>
|
|
2935
|
-
</td>
|
|
2936
|
-
</tr>
|
|
2937
|
-
</table>
|
|
2938
|
-
</div>
|
|
2939
|
-
|
|
2940
|
-
</div>
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
<div id="class_method_details" class="method_details_list">
|
|
2944
|
-
<h2>Class Method Details</h2>
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
<div class="method_details first">
|
|
2948
|
-
<h3 class="signature first" id="create-class_method">
|
|
2949
|
-
|
|
2950
|
-
.<strong>create</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
</h3><div class="docstring">
|
|
2957
|
-
<div class="discussion">
|
|
2958
|
-
|
|
2959
|
-
<p>Creates a new BuyerTransaction in Moxi Works Platform</p>
|
|
2960
|
-
|
|
2961
|
-
<p>– Either moxi_works_contact_id or partner_contact_id must be</p>
|
|
2962
|
-
|
|
2963
|
-
<pre class="code ruby"><code class="ruby"> populated; however, you should only populate one of these attributes.
|
|
2964
|
-
|
|
2965
|
-
optional BuyerTransaction parameters</code></pre>
|
|
2966
|
-
|
|
2967
|
-
|
|
2968
|
-
</div>
|
|
2969
|
-
</div>
|
|
2970
|
-
<div class="tags">
|
|
2971
|
-
|
|
2972
|
-
<div class="examples">
|
|
2973
|
-
<p class="tag_title">Examples:</p>
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
<pre class="example code"><code>Resource::TechConnectGateway::BuyerTransaction.create(
|
|
2977
|
-
agent_identifier:'testis@testomatical.com',
|
|
2978
|
-
moxi_works_contact_id:'deadbeef-dead-beef-bad4-feedfacebad',
|
|
2979
|
-
notes: 'foo deeaz',
|
|
2980
|
-
transaction_name: 'whateverz'
|
|
2981
|
-
address: '1234 there ave',
|
|
2982
|
-
city: 'cityville'
|
|
2983
|
-
state: 'provinceland',
|
|
2984
|
-
zip_code: '12323',
|
|
2985
|
-
min_beds: 12,
|
|
2986
|
-
max_beds: 34,
|
|
2987
|
-
min_baths: 1.25,
|
|
2988
|
-
max_baths: 3.75,
|
|
2989
|
-
min_sqft: 12345,
|
|
2990
|
-
max_sqft: 34567,
|
|
2991
|
-
area_of_interest: 'Lake Interesting'
|
|
2992
|
-
is_mls_transaction: true,
|
|
2993
|
-
commission_flat_fee: nil,
|
|
2994
|
-
commission_percentage: 12.34,
|
|
2995
|
-
target_price: 12345,
|
|
2996
|
-
min_price: nil,
|
|
2997
|
-
max_price: nil,
|
|
2998
|
-
mls_number: 'abc1234'
|
|
2999
|
-
)</code></pre>
|
|
3000
|
-
|
|
3001
|
-
</div>
|
|
3002
|
-
<p class="tag_title">Parameters:</p>
|
|
3003
|
-
<ul class="param">
|
|
3004
|
-
|
|
3005
|
-
<li>
|
|
3006
|
-
|
|
3007
|
-
<span class='name'>opts</span>
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
—
|
|
3017
|
-
<div class='inline'>
|
|
3018
|
-
<p>named parameter Hash</p>
|
|
3019
|
-
</div>
|
|
3020
|
-
|
|
3021
|
-
</li>
|
|
3022
|
-
|
|
3023
|
-
</ul>
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
3029
|
-
<ul class="option">
|
|
3030
|
-
|
|
3031
|
-
<li>
|
|
3032
|
-
<span class="name">:moxi_works_agent_id</span>
|
|
3033
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3034
|
-
<span class="default">
|
|
3035
|
-
|
|
3036
|
-
</span>
|
|
3037
|
-
|
|
3038
|
-
— <div class='inline'>
|
|
3039
|
-
<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
|
|
3040
|
-
this transaction is to be associated</p>
|
|
3041
|
-
</div>
|
|
3042
|
-
|
|
3043
|
-
</li>
|
|
3044
|
-
|
|
3045
|
-
<li>
|
|
3046
|
-
<span class="name">:moxi_works_contact_id</span>
|
|
3047
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3048
|
-
<span class="default">
|
|
3049
|
-
|
|
3050
|
-
</span>
|
|
3051
|
-
|
|
3052
|
-
— <div class='inline'>
|
|
3053
|
-
<p><strong>REQUIRED</strong> The unique identifier for the Contact on the Moxi
|
|
3054
|
-
Works Platform. Either moxi_works_contact_id or partner_contact_id is
|
|
3055
|
-
required when creating BuyerTransaction objects</p>
|
|
3056
|
-
</div>
|
|
3057
|
-
|
|
3058
|
-
</li>
|
|
3059
|
-
|
|
3060
|
-
<li>
|
|
3061
|
-
<span class="name">:partner_contact_id</span>
|
|
3062
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3063
|
-
<span class="default">
|
|
3064
|
-
|
|
3065
|
-
</span>
|
|
3066
|
-
|
|
3067
|
-
— <div class='inline'>
|
|
3068
|
-
<p><strong>REQUIRED</strong> Your system's unique id for associated
|
|
3069
|
-
contact. should already have been created in Moxi Works Platform. If the
|
|
3070
|
-
Contact was not created by your system, use the moxi_works_contact_id
|
|
3071
|
-
attribute. Either moxi_works_contact_id or partner_contact_id is required
|
|
3072
|
-
when creating BuyerTransaction objects</p>
|
|
3073
|
-
</div>
|
|
3074
|
-
|
|
3075
|
-
</li>
|
|
3076
|
-
|
|
3077
|
-
<li>
|
|
3078
|
-
<span class="name">:transaction_name</span>
|
|
3079
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3080
|
-
<span class="default">
|
|
3081
|
-
|
|
3082
|
-
</span>
|
|
3083
|
-
|
|
3084
|
-
— <div class='inline'>
|
|
3085
|
-
<p><strong>REQUIRED</strong> short description of the transaction meaningful
|
|
3086
|
-
to the agent</p>
|
|
3087
|
-
</div>
|
|
3088
|
-
|
|
3089
|
-
</li>
|
|
3090
|
-
|
|
3091
|
-
<li>
|
|
3092
|
-
<span class="name">:notes</span>
|
|
3093
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3094
|
-
<span class="default">
|
|
3095
|
-
|
|
3096
|
-
</span>
|
|
3097
|
-
|
|
3098
|
-
— <div class='inline'>
|
|
3099
|
-
<p>human readable notes associated with the transaction meaningful to the
|
|
3100
|
-
agent</p>
|
|
3101
|
-
</div>
|
|
3102
|
-
|
|
3103
|
-
</li>
|
|
3104
|
-
|
|
3105
|
-
<li>
|
|
3106
|
-
<span class="name">:address</span>
|
|
3107
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3108
|
-
<span class="default">
|
|
3109
|
-
|
|
3110
|
-
</span>
|
|
3111
|
-
|
|
3112
|
-
— <div class='inline'>
|
|
3113
|
-
<p>street address of the property associated with the transaction</p>
|
|
3114
|
-
</div>
|
|
3115
|
-
|
|
3116
|
-
</li>
|
|
3117
|
-
|
|
3118
|
-
<li>
|
|
3119
|
-
<span class="name">:city</span>
|
|
3120
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3121
|
-
<span class="default">
|
|
3122
|
-
|
|
3123
|
-
</span>
|
|
3124
|
-
|
|
3125
|
-
— <div class='inline'>
|
|
3126
|
-
<p>city of the property associated with the transaction</p>
|
|
3127
|
-
</div>
|
|
3128
|
-
|
|
3129
|
-
</li>
|
|
3130
|
-
|
|
3131
|
-
<li>
|
|
3132
|
-
<span class="name">:state</span>
|
|
3133
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3134
|
-
<span class="default">
|
|
3135
|
-
|
|
3136
|
-
</span>
|
|
3137
|
-
|
|
3138
|
-
— <div class='inline'>
|
|
3139
|
-
<p>state or province of the property associated with the transaction</p>
|
|
3140
|
-
</div>
|
|
3141
|
-
|
|
3142
|
-
</li>
|
|
3143
|
-
|
|
3144
|
-
<li>
|
|
3145
|
-
<span class="name">:zip_code</span>
|
|
3146
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3147
|
-
<span class="default">
|
|
3148
|
-
|
|
3149
|
-
</span>
|
|
3150
|
-
|
|
3151
|
-
— <div class='inline'>
|
|
3152
|
-
<p>postal code of the property associated with the transaction</p>
|
|
3153
|
-
</div>
|
|
3154
|
-
|
|
3155
|
-
</li>
|
|
3156
|
-
|
|
3157
|
-
<li>
|
|
3158
|
-
<span class="name">:min_sqft</span>
|
|
3159
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3160
|
-
<span class="default">
|
|
3161
|
-
|
|
3162
|
-
</span>
|
|
3163
|
-
|
|
3164
|
-
— <div class='inline'>
|
|
3165
|
-
<p>minimum desired square feet of living area in potential properties</p>
|
|
3166
|
-
</div>
|
|
3167
|
-
|
|
3168
|
-
</li>
|
|
3169
|
-
|
|
3170
|
-
<li>
|
|
3171
|
-
<span class="name">:max_sqft</span>
|
|
3172
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3173
|
-
<span class="default">
|
|
3174
|
-
|
|
3175
|
-
</span>
|
|
3176
|
-
|
|
3177
|
-
— <div class='inline'>
|
|
3178
|
-
<p>maximum desired square feet of living area in potential properties</p>
|
|
3179
|
-
</div>
|
|
3180
|
-
|
|
3181
|
-
</li>
|
|
3182
|
-
|
|
3183
|
-
<li>
|
|
3184
|
-
<span class="name">:min_beds</span>
|
|
3185
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3186
|
-
<span class="default">
|
|
3187
|
-
|
|
3188
|
-
</span>
|
|
3189
|
-
|
|
3190
|
-
— <div class='inline'>
|
|
3191
|
-
<p>minimum desired number of bedrooms in potential properties</p>
|
|
3192
|
-
</div>
|
|
3193
|
-
|
|
3194
|
-
</li>
|
|
3195
|
-
|
|
3196
|
-
<li>
|
|
3197
|
-
<span class="name">:max_beds</span>
|
|
3198
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3199
|
-
<span class="default">
|
|
3200
|
-
|
|
3201
|
-
</span>
|
|
3202
|
-
|
|
3203
|
-
— <div class='inline'>
|
|
3204
|
-
<p>maximum desired number of bedrooms in potential properties</p>
|
|
3205
|
-
</div>
|
|
3206
|
-
|
|
3207
|
-
</li>
|
|
3208
|
-
|
|
3209
|
-
<li>
|
|
3210
|
-
<span class="name">:area_of_interest</span>
|
|
3211
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3212
|
-
<span class="default">
|
|
3213
|
-
|
|
3214
|
-
</span>
|
|
3215
|
-
|
|
3216
|
-
— <div class='inline'>
|
|
3217
|
-
<p>string representing a locality that the client has expressed interest in
|
|
3218
|
-
purchasing a property within</p>
|
|
3219
|
-
</div>
|
|
3220
|
-
|
|
3221
|
-
</li>
|
|
3222
|
-
|
|
3223
|
-
<li>
|
|
3224
|
-
<span class="name">:min_baths</span>
|
|
3225
|
-
<span class="type">(<tt>Integer or Float</tt>)</span>
|
|
3226
|
-
<span class="default">
|
|
3227
|
-
|
|
3228
|
-
</span>
|
|
3229
|
-
|
|
3230
|
-
— <div class='inline'>
|
|
3231
|
-
<p>minimum desired number of bathrooms in potential properties</p>
|
|
3232
|
-
</div>
|
|
3233
|
-
|
|
3234
|
-
</li>
|
|
3235
|
-
|
|
3236
|
-
<li>
|
|
3237
|
-
<span class="name">:max_baths</span>
|
|
3238
|
-
<span class="type">(<tt>Integer or Float</tt>)</span>
|
|
3239
|
-
<span class="default">
|
|
3240
|
-
|
|
3241
|
-
</span>
|
|
3242
|
-
|
|
3243
|
-
— <div class='inline'>
|
|
3244
|
-
<p>maximum desired number of bathrooms in potential properties</p>
|
|
3245
|
-
</div>
|
|
3246
|
-
|
|
3247
|
-
</li>
|
|
3248
|
-
|
|
3249
|
-
<li>
|
|
3250
|
-
<span class="name">:is_mls_transaction</span>
|
|
3251
|
-
<span class="type">(<tt>Boolean</tt>)</span>
|
|
3252
|
-
<span class="default">
|
|
3253
|
-
|
|
3254
|
-
</span>
|
|
3255
|
-
|
|
3256
|
-
— <div class='inline'>
|
|
3257
|
-
<p>Whether the property being purchased is being listed on an MLS. This should
|
|
3258
|
-
be false for paperwork-only, for sale by owner, off-market, or pocket
|
|
3259
|
-
listing type transactions or any transactions that will not be tracked
|
|
3260
|
-
through an MLS.</p>
|
|
3261
|
-
</div>
|
|
3262
|
-
|
|
3263
|
-
</li>
|
|
3264
|
-
|
|
3265
|
-
<li>
|
|
3266
|
-
<span class="name">:mls_number</span>
|
|
3267
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3268
|
-
<span class="default">
|
|
3269
|
-
|
|
3270
|
-
</span>
|
|
3271
|
-
|
|
3272
|
-
— <div class='inline'>
|
|
3273
|
-
<p>mls number associated with the transaction – mls_number should be populated
|
|
3274
|
-
only if is_mls_transaction is true.</p>
|
|
3275
|
-
</div>
|
|
3276
|
-
|
|
3277
|
-
</li>
|
|
3278
|
-
|
|
3279
|
-
<li>
|
|
3280
|
-
<span class="name">:start_timestamp</span>
|
|
3281
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3282
|
-
<span class="default">
|
|
3283
|
-
|
|
3284
|
-
</span>
|
|
3285
|
-
|
|
3286
|
-
— <div class='inline'>
|
|
3287
|
-
<p>Unix timestamp representing the date the agent initiated transaction
|
|
3288
|
-
discussions with the client.</p>
|
|
3289
|
-
</div>
|
|
3290
|
-
|
|
3291
|
-
</li>
|
|
3292
|
-
|
|
3293
|
-
<li>
|
|
3294
|
-
<span class="name">:commission_percentage</span>
|
|
3295
|
-
<span class="type">(<tt>Float</tt>)</span>
|
|
3296
|
-
<span class="default">
|
|
3297
|
-
|
|
3298
|
-
</span>
|
|
3299
|
-
|
|
3300
|
-
— <div class='inline'>
|
|
3301
|
-
<p>what percentage the commission is if percentage based – A BuyerTransaction
|
|
3302
|
-
can only have either commission_percentage or commission_flat_fee
|
|
3303
|
-
populated. Both can not be populated.</p>
|
|
3304
|
-
</div>
|
|
3305
|
-
|
|
3306
|
-
</li>
|
|
3307
|
-
|
|
3308
|
-
<li>
|
|
3309
|
-
<span class="name">:commission_flat_fee</span>
|
|
3310
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3311
|
-
<span class="default">
|
|
3312
|
-
|
|
3313
|
-
</span>
|
|
3314
|
-
|
|
3315
|
-
— <div class='inline'>
|
|
3316
|
-
<p>how much the commission is if flat fee – A BuyerTransaction can only have
|
|
3317
|
-
either commission_percentage or commission_flat_fee populated. Both can not
|
|
3318
|
-
be populated.</p>
|
|
3319
|
-
</div>
|
|
3320
|
-
|
|
3321
|
-
</li>
|
|
3322
|
-
|
|
3323
|
-
<li>
|
|
3324
|
-
<span class="name">:target_price</span>
|
|
3325
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3326
|
-
<span class="default">
|
|
3327
|
-
|
|
3328
|
-
</span>
|
|
3329
|
-
|
|
3330
|
-
— <div class='inline'>
|
|
3331
|
-
<p>target price associated with the transaction if using a target price rather
|
|
3332
|
-
than price range</p>
|
|
3333
|
-
</div>
|
|
3334
|
-
|
|
3335
|
-
</li>
|
|
3336
|
-
|
|
3337
|
-
<li>
|
|
3338
|
-
<span class="name">:min_price</span>
|
|
3339
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3340
|
-
<span class="default">
|
|
3341
|
-
|
|
3342
|
-
</span>
|
|
3343
|
-
|
|
3344
|
-
— <div class='inline'>
|
|
3345
|
-
<p>minimum acceptable price associated with the transaction if using a price
|
|
3346
|
-
range rather than target price</p>
|
|
3347
|
-
</div>
|
|
3348
|
-
|
|
3349
|
-
</li>
|
|
3350
|
-
|
|
3351
|
-
<li>
|
|
3352
|
-
<span class="name">:max_price</span>
|
|
3353
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3354
|
-
<span class="default">
|
|
3355
|
-
|
|
3356
|
-
</span>
|
|
3357
|
-
|
|
3358
|
-
— <div class='inline'>
|
|
3359
|
-
<p>maximum price associated with the transaction if using a price range rather
|
|
3360
|
-
than target price</p>
|
|
3361
|
-
</div>
|
|
3362
|
-
|
|
3363
|
-
</li>
|
|
3364
|
-
|
|
3365
|
-
</ul>
|
|
3366
|
-
|
|
3367
|
-
|
|
3368
|
-
<p class="tag_title">Returns:</p>
|
|
3369
|
-
<ul class="return">
|
|
3370
|
-
|
|
3371
|
-
<li>
|
|
3372
|
-
|
|
3373
|
-
|
|
3374
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>)</span>
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
|
|
3378
|
-
</li>
|
|
3379
|
-
|
|
3380
|
-
</ul>
|
|
3381
|
-
<p class="tag_title">Raises:</p>
|
|
3382
|
-
<ul class="raise">
|
|
3383
|
-
|
|
3384
|
-
<li>
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
<span class='type'></span>
|
|
3388
|
-
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
<div class='inline'>
|
|
3393
|
-
<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
|
|
3394
|
-
aren't included</p>
|
|
3395
|
-
</div>
|
|
3396
|
-
|
|
3397
|
-
</li>
|
|
3398
|
-
|
|
3399
|
-
</ul>
|
|
3400
|
-
|
|
3401
|
-
</div><table class="source_code">
|
|
3402
|
-
<tr>
|
|
3403
|
-
<td>
|
|
3404
|
-
<pre class="lines">
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
334
|
|
3408
|
-
335
|
|
3409
|
-
336
|
|
3410
|
-
337
|
|
3411
|
-
338
|
|
3412
|
-
339
|
|
3413
|
-
340
|
|
3414
|
-
341
|
|
3415
|
-
342
|
|
3416
|
-
343
|
|
3417
|
-
344</pre>
|
|
3418
|
-
</td>
|
|
3419
|
-
<td>
|
|
3420
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 334</span>
|
|
3421
|
-
|
|
3422
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</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>
|
|
3423
|
-
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span>
|
|
3424
|
-
<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>
|
|
3425
|
-
<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'>"</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'>"</span></span> <span class='kw'>if</span>
|
|
3426
|
-
<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>
|
|
3427
|
-
<span class='kw'>end</span>
|
|
3428
|
-
<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>
|
|
3429
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>moxi_works_contact_id or partner_contact_id required</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span>
|
|
3430
|
-
<span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:moxi_works_contact_id</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:partner_contact_id</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3431
|
-
<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'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
|
3432
|
-
<span class='kw'>end</span></pre>
|
|
3433
|
-
</td>
|
|
3434
|
-
</tr>
|
|
3435
|
-
</table>
|
|
3436
|
-
</div>
|
|
3437
|
-
|
|
3438
|
-
<div class="method_details ">
|
|
3439
|
-
<h3 class="signature " id="find-class_method">
|
|
3440
|
-
|
|
3441
|
-
.<strong>find</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
</h3><div class="docstring">
|
|
3448
|
-
<div class="discussion">
|
|
3449
|
-
|
|
3450
|
-
<p>Find a BuyerTransaction using The Moxi Works Platform</p>
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
</div>
|
|
3454
|
-
</div>
|
|
3455
|
-
<div class="tags">
|
|
3456
|
-
<p class="tag_title">Parameters:</p>
|
|
3457
|
-
<ul class="param">
|
|
3458
|
-
|
|
3459
|
-
<li>
|
|
3460
|
-
|
|
3461
|
-
<span class='name'>opts</span>
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
—
|
|
3471
|
-
<div class='inline'>
|
|
3472
|
-
<p>named parameter Hash</p>
|
|
3473
|
-
</div>
|
|
3474
|
-
|
|
3475
|
-
</li>
|
|
3476
|
-
|
|
3477
|
-
</ul>
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
3483
|
-
<ul class="option">
|
|
3484
|
-
|
|
3485
|
-
<li>
|
|
3486
|
-
<span class="name">:moxi_works_agent_id</span>
|
|
3487
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3488
|
-
<span class="default">
|
|
3489
|
-
|
|
3490
|
-
</span>
|
|
3491
|
-
|
|
3492
|
-
— <div class='inline'>
|
|
3493
|
-
<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
|
|
3494
|
-
this transaction is associated</p>
|
|
3495
|
-
</div>
|
|
3496
|
-
|
|
3497
|
-
</li>
|
|
3498
|
-
|
|
3499
|
-
<li>
|
|
3500
|
-
<span class="name">:moxi_works_transaction_id</span>
|
|
3501
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3502
|
-
<span class="default">
|
|
3503
|
-
|
|
3504
|
-
</span>
|
|
3505
|
-
|
|
3506
|
-
— <div class='inline'>
|
|
3507
|
-
<p><strong>REQUIRED</strong> The Moxi Works Platform ID for this transaction.</p>
|
|
3508
|
-
</div>
|
|
3509
|
-
|
|
3510
|
-
</li>
|
|
3511
|
-
|
|
3512
|
-
</ul>
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
<p class="tag_title">Returns:</p>
|
|
3516
|
-
<ul class="return">
|
|
3517
|
-
|
|
3518
|
-
<li>
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>)</span>
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
</li>
|
|
3526
|
-
|
|
3527
|
-
</ul>
|
|
3528
|
-
<p class="tag_title">Raises:</p>
|
|
3529
|
-
<ul class="raise">
|
|
3530
|
-
|
|
3531
|
-
<li>
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
<span class='type'></span>
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
<div class='inline'>
|
|
3540
|
-
<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
|
|
3541
|
-
aren't included</p>
|
|
3542
|
-
</div>
|
|
3543
|
-
|
|
3544
|
-
</li>
|
|
3545
|
-
|
|
3546
|
-
</ul>
|
|
3547
|
-
|
|
3548
|
-
</div><table class="source_code">
|
|
3549
|
-
<tr>
|
|
3550
|
-
<td>
|
|
3551
|
-
<pre class="lines">
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
356
|
|
3555
|
-
357
|
|
3556
|
-
358
|
|
3557
|
-
359
|
|
3558
|
-
360
|
|
3559
|
-
361
|
|
3560
|
-
362
|
|
3561
|
-
363
|
|
3562
|
-
364</pre>
|
|
3563
|
-
</td>
|
|
3564
|
-
<td>
|
|
3565
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 356</span>
|
|
3566
|
-
|
|
3567
|
-
<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>
|
|
3568
|
-
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='comma'>,</span> <span class='symbol'>:moxi_works_transaction_id</span><span class='rbracket'>]</span>
|
|
3569
|
-
<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>
|
|
3570
|
-
<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'>"</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'>"</span></span> <span class='kw'>if</span>
|
|
3571
|
-
<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>
|
|
3572
|
-
<span class='kw'>end</span>
|
|
3573
|
-
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</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/buyer_transactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_transaction_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
3574
|
-
<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>
|
|
3575
|
-
<span class='kw'>end</span></pre>
|
|
3576
|
-
</td>
|
|
3577
|
-
</tr>
|
|
3578
|
-
</table>
|
|
3579
|
-
</div>
|
|
3580
|
-
|
|
3581
|
-
<div class="method_details ">
|
|
3582
|
-
<h3 class="signature " id="search-class_method">
|
|
3583
|
-
|
|
3584
|
-
.<strong>search</strong>(opts = {}) ⇒ <tt>Hash</tt>
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
</h3><div class="docstring">
|
|
3591
|
-
<div class="discussion">
|
|
3592
|
-
|
|
3593
|
-
<p>Search Agent's BuyerTransactions in Moxi Works Platform</p>
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
</div>
|
|
3597
|
-
</div>
|
|
3598
|
-
<div class="tags">
|
|
3599
|
-
|
|
3600
|
-
<div class="examples">
|
|
3601
|
-
<p class="tag_title">Examples:</p>
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
<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'>BuyerTransaction</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
|
|
3605
|
-
<span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123abc</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
3606
|
-
<span class='label'>page_number:</span> <span class='int'>2</span>
|
|
3607
|
-
<span class='rparen'>)</span></code></pre>
|
|
3608
|
-
|
|
3609
|
-
</div>
|
|
3610
|
-
<p class="tag_title">Parameters:</p>
|
|
3611
|
-
<ul class="param">
|
|
3612
|
-
|
|
3613
|
-
<li>
|
|
3614
|
-
|
|
3615
|
-
<span class='name'>opts</span>
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
3622
|
-
|
|
3623
|
-
|
|
3624
|
-
—
|
|
3625
|
-
<div class='inline'>
|
|
3626
|
-
<p>named parameter Hash</p>
|
|
3627
|
-
</div>
|
|
3628
|
-
|
|
3629
|
-
</li>
|
|
3630
|
-
|
|
3631
|
-
</ul>
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
3637
|
-
<ul class="option">
|
|
3638
|
-
|
|
3639
|
-
<li>
|
|
3640
|
-
<span class="name">:moxi_works_agent_id</span>
|
|
3641
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3642
|
-
<span class="default">
|
|
3643
|
-
|
|
3644
|
-
</span>
|
|
3645
|
-
|
|
3646
|
-
— <div class='inline'>
|
|
3647
|
-
<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
|
|
3648
|
-
this contact is associated</p>
|
|
3649
|
-
|
|
3650
|
-
<p>optional Search parameters</p>
|
|
3651
|
-
</div>
|
|
3652
|
-
|
|
3653
|
-
</li>
|
|
3654
|
-
|
|
3655
|
-
<li>
|
|
3656
|
-
<span class="name">:moxi_works_contact_id</span>
|
|
3657
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3658
|
-
<span class="default">
|
|
3659
|
-
|
|
3660
|
-
</span>
|
|
3661
|
-
|
|
3662
|
-
— <div class='inline'>
|
|
3663
|
-
<p>The Moxi Works Contact ID for the contact whose BuyerTransactions you are
|
|
3664
|
-
searching for</p>
|
|
3665
|
-
</div>
|
|
3666
|
-
|
|
3667
|
-
</li>
|
|
3668
|
-
|
|
3669
|
-
<li>
|
|
3670
|
-
<span class="name">:partner_contact_id</span>
|
|
3671
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3672
|
-
<span class="default">
|
|
3673
|
-
|
|
3674
|
-
</span>
|
|
3675
|
-
|
|
3676
|
-
— <div class='inline'>
|
|
3677
|
-
<p>The partner's ID for the contact whose BuyerTransactions they are
|
|
3678
|
-
looking for</p>
|
|
3679
|
-
</div>
|
|
3680
|
-
|
|
3681
|
-
</li>
|
|
3682
|
-
|
|
3683
|
-
<li>
|
|
3684
|
-
<span class="name">:page_number</span>
|
|
3685
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3686
|
-
<span class="default">
|
|
3687
|
-
|
|
3688
|
-
</span>
|
|
3689
|
-
|
|
3690
|
-
— <div class='inline'>
|
|
3691
|
-
<p>the page of results to return</p>
|
|
3692
|
-
</div>
|
|
3693
|
-
|
|
3694
|
-
</li>
|
|
3695
|
-
|
|
3696
|
-
<li>
|
|
3697
|
-
<span class="name">:include_unconfigured</span>
|
|
3698
|
-
<span class="type">(<tt>Boolean</tt>)</span>
|
|
3699
|
-
<span class="default">
|
|
3700
|
-
|
|
3701
|
-
</span>
|
|
3702
|
-
|
|
3703
|
-
— <div class='inline'>
|
|
3704
|
-
<p>whether to include stage 1 transactions in response</p>
|
|
3705
|
-
</div>
|
|
3706
|
-
|
|
3707
|
-
</li>
|
|
3708
|
-
|
|
3709
|
-
</ul>
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
<p class="tag_title">Returns:</p>
|
|
3713
|
-
<ul class="return">
|
|
3714
|
-
|
|
3715
|
-
<li>
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
3719
|
-
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
—
|
|
3723
|
-
<div class='inline'>
|
|
3724
|
-
<p>with the format:
|
|
3725
|
-
<pre class="code ruby"><code class="ruby">page_number: [Integer],
|
|
3726
|
-
total_pages: [Integer],
|
|
3727
|
-
transactions: [Array] containing MoxiworkPlatform::BuyerTransaction objects</code></pre>
|
|
3728
|
-
|
|
3729
|
-
<p></p>
|
|
3730
|
-
</div>
|
|
3731
|
-
|
|
3732
|
-
</li>
|
|
3733
|
-
|
|
3734
|
-
</ul>
|
|
3735
|
-
<p class="tag_title">Raises:</p>
|
|
3736
|
-
<ul class="raise">
|
|
3737
|
-
|
|
3738
|
-
<li>
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
<span class='type'></span>
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
<div class='inline'>
|
|
3747
|
-
<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
|
|
3748
|
-
aren't included</p>
|
|
3749
|
-
</div>
|
|
3750
|
-
|
|
3751
|
-
</li>
|
|
3752
|
-
|
|
3753
|
-
</ul>
|
|
3754
|
-
|
|
3755
|
-
</div><table class="source_code">
|
|
3756
|
-
<tr>
|
|
3757
|
-
<td>
|
|
3758
|
-
<pre class="lines">
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
397
|
|
3762
|
-
398
|
|
3763
|
-
399
|
|
3764
|
-
400
|
|
3765
|
-
401
|
|
3766
|
-
402
|
|
3767
|
-
403
|
|
3768
|
-
404
|
|
3769
|
-
405
|
|
3770
|
-
406
|
|
3771
|
-
407
|
|
3772
|
-
408
|
|
3773
|
-
409
|
|
3774
|
-
410
|
|
3775
|
-
411
|
|
3776
|
-
412
|
|
3777
|
-
413
|
|
3778
|
-
414
|
|
3779
|
-
415
|
|
3780
|
-
416
|
|
3781
|
-
417
|
|
3782
|
-
418
|
|
3783
|
-
419
|
|
3784
|
-
420
|
|
3785
|
-
421</pre>
|
|
3786
|
-
</td>
|
|
3787
|
-
<td>
|
|
3788
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 397</span>
|
|
3789
|
-
|
|
3790
|
-
<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>
|
|
3791
|
-
<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>
|
|
3792
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>arguments must be passed as named parameters</span><span class='tstring_end'>'</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>
|
|
3793
|
-
<span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</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/buyer_transactions</span><span class='tstring_end'>"</span></span>
|
|
3794
|
-
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span>
|
|
3795
|
-
<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>
|
|
3796
|
-
<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'>"</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'>"</span></span> <span class='kw'>if</span>
|
|
3797
|
-
<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>
|
|
3798
|
-
<span class='kw'>end</span>
|
|
3799
|
-
<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>
|
|
3800
|
-
<span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>page_number</span><span class='label_end'>':</span> <span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>total_pages</span><span class='label_end'>':</span> <span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>transactions</span><span class='label_end'>':</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
|
|
3801
|
-
<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>
|
|
3802
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
3803
|
-
<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>
|
|
3804
|
-
<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>
|
|
3805
|
-
<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>
|
|
3806
|
-
<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>
|
|
3807
|
-
<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>
|
|
3808
|
-
<span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>transactions</span><span class='tstring_end'>'</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>
|
|
3809
|
-
<span class='id identifier rubyid_results'>results</span> <span class='op'><<</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>BuyerTransaction</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>
|
|
3810
|
-
<span class='kw'>end</span>
|
|
3811
|
-
<span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>transactions</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span>
|
|
3812
|
-
<span class='kw'>end</span>
|
|
3813
|
-
<span class='id identifier rubyid_json'>json</span>
|
|
3814
|
-
<span class='kw'>end</span></pre>
|
|
3815
|
-
</td>
|
|
3816
|
-
</tr>
|
|
3817
|
-
</table>
|
|
3818
|
-
</div>
|
|
3819
|
-
|
|
3820
|
-
<div class="method_details ">
|
|
3821
|
-
<h3 class="signature " id="send_request-class_method">
|
|
3822
|
-
|
|
3823
|
-
.<strong>send_request</strong>(method, opts = {}, url = nil) ⇒ <tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
|
|
3828
|
-
|
|
3829
|
-
</h3><div class="docstring">
|
|
3830
|
-
<div class="discussion">
|
|
3831
|
-
|
|
3832
|
-
<p>Send our remote request to the Moxi Works Platform</p>
|
|
3833
|
-
|
|
3834
|
-
|
|
3835
|
-
</div>
|
|
3836
|
-
</div>
|
|
3837
|
-
<div class="tags">
|
|
3838
|
-
<p class="tag_title">Parameters:</p>
|
|
3839
|
-
<ul class="param">
|
|
3840
|
-
|
|
3841
|
-
<li>
|
|
3842
|
-
|
|
3843
|
-
<span class='name'>opts</span>
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
—
|
|
3853
|
-
<div class='inline'>
|
|
3854
|
-
<p>named parameter Hash</p>
|
|
3855
|
-
</div>
|
|
3856
|
-
|
|
3857
|
-
</li>
|
|
3858
|
-
|
|
3859
|
-
</ul>
|
|
3860
|
-
|
|
3861
|
-
|
|
3862
|
-
|
|
3863
|
-
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
3867
|
-
<ul class="option">
|
|
3868
|
-
|
|
3869
|
-
<li>
|
|
3870
|
-
<span class="name">:moxi_works_agent_id</span>
|
|
3871
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3872
|
-
<span class="default">
|
|
3873
|
-
|
|
3874
|
-
</span>
|
|
3875
|
-
|
|
3876
|
-
— <div class='inline'>
|
|
3877
|
-
<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
|
|
3878
|
-
this transaction is to be associated</p>
|
|
3879
|
-
</div>
|
|
3880
|
-
|
|
3881
|
-
</li>
|
|
3882
|
-
|
|
3883
|
-
<li>
|
|
3884
|
-
<span class="name">:moxi_works_transaction_id</span>
|
|
3885
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3886
|
-
<span class="default">
|
|
3887
|
-
|
|
3888
|
-
</span>
|
|
3889
|
-
|
|
3890
|
-
— <div class='inline'>
|
|
3891
|
-
<p><strong>REQUIRED</strong> The Moxi Works Platform unique ID for this
|
|
3892
|
-
transaction.</p>
|
|
3893
|
-
</div>
|
|
3894
|
-
|
|
3895
|
-
</li>
|
|
3896
|
-
|
|
3897
|
-
<li>
|
|
3898
|
-
<span class="name">:partner_contact_id</span>
|
|
3899
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3900
|
-
<span class="default">
|
|
3901
|
-
|
|
3902
|
-
</span>
|
|
3903
|
-
|
|
3904
|
-
— <div class='inline'>
|
|
3905
|
-
<p><strong>REQUIRED</strong> Your system's unique ID for the Contact for
|
|
3906
|
-
whom this BuyerTransaction is to be associated.</p>
|
|
3907
|
-
|
|
3908
|
-
<p>optional BuyerTransaction parameters</p>
|
|
3909
|
-
</div>
|
|
3910
|
-
|
|
3911
|
-
</li>
|
|
3912
|
-
|
|
3913
|
-
<li>
|
|
3914
|
-
<span class="name">:transaction_name</span>
|
|
3915
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3916
|
-
<span class="default">
|
|
3917
|
-
|
|
3918
|
-
</span>
|
|
3919
|
-
|
|
3920
|
-
— <div class='inline'>
|
|
3921
|
-
<p>short description of the transaction</p>
|
|
3922
|
-
</div>
|
|
3923
|
-
|
|
3924
|
-
</li>
|
|
3925
|
-
|
|
3926
|
-
<li>
|
|
3927
|
-
<span class="name">:description</span>
|
|
3928
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3929
|
-
<span class="default">
|
|
3930
|
-
|
|
3931
|
-
</span>
|
|
3932
|
-
|
|
3933
|
-
— <div class='inline'>
|
|
3934
|
-
<p>longer description of the transaction</p>
|
|
3935
|
-
</div>
|
|
3936
|
-
|
|
3937
|
-
</li>
|
|
3938
|
-
|
|
3939
|
-
<li>
|
|
3940
|
-
<span class="name">:due_at</span>
|
|
3941
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3942
|
-
<span class="default">
|
|
3943
|
-
|
|
3944
|
-
</span>
|
|
3945
|
-
|
|
3946
|
-
— <div class='inline'>
|
|
3947
|
-
<p>Unix timestamp representing the due date</p>
|
|
3948
|
-
</div>
|
|
3949
|
-
|
|
3950
|
-
</li>
|
|
3951
|
-
|
|
3952
|
-
<li>
|
|
3953
|
-
<span class="name">:duration</span>
|
|
3954
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3955
|
-
<span class="default">
|
|
3956
|
-
|
|
3957
|
-
</span>
|
|
3958
|
-
|
|
3959
|
-
— <div class='inline'>
|
|
3960
|
-
<p>Length of time in minutes that the transaction should take</p>
|
|
3961
|
-
</div>
|
|
3962
|
-
|
|
3963
|
-
</li>
|
|
3964
|
-
|
|
3965
|
-
<li>
|
|
3966
|
-
<span class="name">:completed_at</span>
|
|
3967
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
3968
|
-
<span class="default">
|
|
3969
|
-
|
|
3970
|
-
</span>
|
|
3971
|
-
|
|
3972
|
-
— <div class='inline'>
|
|
3973
|
-
<p>Unix timestamp representing the date the transaction was completed</p>
|
|
3974
|
-
</div>
|
|
3975
|
-
|
|
3976
|
-
</li>
|
|
3977
|
-
|
|
3978
|
-
<li>
|
|
3979
|
-
<span class="name">:status</span>
|
|
3980
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
3981
|
-
<span class="default">
|
|
3982
|
-
|
|
3983
|
-
</span>
|
|
3984
|
-
|
|
3985
|
-
— <div class='inline'>
|
|
3986
|
-
<p>enumerated string representing transaction status</p>
|
|
3987
|
-
</div>
|
|
3988
|
-
|
|
3989
|
-
</li>
|
|
3990
|
-
|
|
3991
|
-
</ul>
|
|
3992
|
-
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
<p class="tag_title">Returns:</p>
|
|
3997
|
-
<ul class="return">
|
|
3998
|
-
|
|
3999
|
-
<li>
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>)</span>
|
|
4003
|
-
|
|
4004
|
-
|
|
4005
|
-
|
|
4006
|
-
</li>
|
|
4007
|
-
|
|
4008
|
-
</ul>
|
|
4009
|
-
<p class="tag_title">Raises:</p>
|
|
4010
|
-
<ul class="raise">
|
|
4011
|
-
|
|
4012
|
-
<li>
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
|
-
<span class='type'></span>
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4020
|
-
<div class='inline'>
|
|
4021
|
-
<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
|
|
4022
|
-
aren't included</p>
|
|
4023
|
-
</div>
|
|
4024
|
-
|
|
4025
|
-
</li>
|
|
4026
|
-
|
|
4027
|
-
</ul>
|
|
4028
|
-
|
|
4029
|
-
</div><table class="source_code">
|
|
4030
|
-
<tr>
|
|
4031
|
-
<td>
|
|
4032
|
-
<pre class="lines">
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
523
|
|
4036
|
-
524
|
|
4037
|
-
525
|
|
4038
|
-
526
|
|
4039
|
-
527
|
|
4040
|
-
528
|
|
4041
|
-
529
|
|
4042
|
-
530
|
|
4043
|
-
531
|
|
4044
|
-
532
|
|
4045
|
-
533</pre>
|
|
4046
|
-
</td>
|
|
4047
|
-
<td>
|
|
4048
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 523</span>
|
|
4049
|
-
|
|
4050
|
-
<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>
|
|
4051
|
-
<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>
|
|
4052
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>arguments must be passed as named parameters</span><span class='tstring_end'>'</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>
|
|
4053
|
-
<span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</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/buyer_transactions</span><span class='tstring_end'>"</span></span>
|
|
4054
|
-
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span>
|
|
4055
|
-
<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>
|
|
4056
|
-
<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'>"</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'>"</span></span> <span class='kw'>if</span>
|
|
4057
|
-
<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>
|
|
4058
|
-
<span class='kw'>end</span>
|
|
4059
|
-
<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>
|
|
4060
|
-
<span class='kw'>end</span></pre>
|
|
4061
|
-
</td>
|
|
4062
|
-
</tr>
|
|
4063
|
-
</table>
|
|
4064
|
-
</div>
|
|
4065
|
-
|
|
4066
|
-
<div class="method_details ">
|
|
4067
|
-
<h3 class="signature " id="update-class_method">
|
|
4068
|
-
|
|
4069
|
-
.<strong>update</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
</h3><div class="docstring">
|
|
4076
|
-
<div class="discussion">
|
|
4077
|
-
|
|
4078
|
-
<p>Updates an existing BuyerTransaction in Leads Gateway</p>
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
|
-
</div>
|
|
4082
|
-
</div>
|
|
4083
|
-
<div class="tags">
|
|
4084
|
-
|
|
4085
|
-
<div class="examples">
|
|
4086
|
-
<p class="tag_title">Examples:</p>
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
<pre class="example code"><code>Resource::TechConnectGateway::BuyerTransaction.update(
|
|
4090
|
-
agent_identifier:'testis@testomatical.com',
|
|
4091
|
-
moxi_works_transaction_id:'deadbeef-dead-beef-bad4-feedfacebad',
|
|
4092
|
-
notes: 'foo deeaz',
|
|
4093
|
-
transaction_name: 'whateverz'
|
|
4094
|
-
address: '1234 there ave',
|
|
4095
|
-
city: 'cityville'
|
|
4096
|
-
state: 'provinceland',
|
|
4097
|
-
zip_code: '12323',
|
|
4098
|
-
min_beds: 12,
|
|
4099
|
-
max_beds: 34,
|
|
4100
|
-
min_baths: 1.25,
|
|
4101
|
-
max_baths: 3.75,
|
|
4102
|
-
min_sqft: 12345,
|
|
4103
|
-
max_sqft: 34567,
|
|
4104
|
-
area_of_interest: 'Lake Interesting'
|
|
4105
|
-
is_mls_transaction: true,
|
|
4106
|
-
commission_flat_fee: nil,
|
|
4107
|
-
commission_percentage: 12.34,
|
|
4108
|
-
target_price: 12345,
|
|
4109
|
-
min_price: nil,
|
|
4110
|
-
max_price: nil,
|
|
4111
|
-
mls_number: 'abc1234'
|
|
4112
|
-
closing_price: 123456,
|
|
4113
|
-
closing_timestamp: Time.now.to_i,
|
|
4114
|
-
promote_transaction: true
|
|
4115
|
-
)</code></pre>
|
|
4116
|
-
|
|
4117
|
-
</div>
|
|
4118
|
-
<p class="tag_title">Parameters:</p>
|
|
4119
|
-
<ul class="param">
|
|
4120
|
-
|
|
4121
|
-
<li>
|
|
4122
|
-
|
|
4123
|
-
<span class='name'>opts</span>
|
|
4124
|
-
|
|
4125
|
-
|
|
4126
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
—
|
|
4133
|
-
<div class='inline'>
|
|
4134
|
-
<p>named parameter Hash</p>
|
|
4135
|
-
</div>
|
|
4136
|
-
|
|
4137
|
-
</li>
|
|
4138
|
-
|
|
4139
|
-
</ul>
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
4145
|
-
<ul class="option">
|
|
4146
|
-
|
|
4147
|
-
<li>
|
|
4148
|
-
<span class="name">:moxi_works_agent_id</span>
|
|
4149
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4150
|
-
<span class="default">
|
|
4151
|
-
|
|
4152
|
-
</span>
|
|
4153
|
-
|
|
4154
|
-
— <div class='inline'>
|
|
4155
|
-
<p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
|
|
4156
|
-
this transaction is associated</p>
|
|
4157
|
-
</div>
|
|
4158
|
-
|
|
4159
|
-
</li>
|
|
4160
|
-
|
|
4161
|
-
<li>
|
|
4162
|
-
<span class="name">:moxi_works_transaction_id</span>
|
|
4163
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4164
|
-
<span class="default">
|
|
4165
|
-
|
|
4166
|
-
</span>
|
|
4167
|
-
|
|
4168
|
-
— <div class='inline'>
|
|
4169
|
-
<p><strong>REQUIRED</strong> partner system's unique ID for this
|
|
4170
|
-
transaction.</p>
|
|
4171
|
-
|
|
4172
|
-
<p>optional BuyerTransaction parameters</p>
|
|
4173
|
-
</div>
|
|
4174
|
-
|
|
4175
|
-
</li>
|
|
4176
|
-
|
|
4177
|
-
<li>
|
|
4178
|
-
<span class="name">:transaction_name</span>
|
|
4179
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4180
|
-
<span class="default">
|
|
4181
|
-
|
|
4182
|
-
</span>
|
|
4183
|
-
|
|
4184
|
-
— <div class='inline'>
|
|
4185
|
-
<p>short description of the transaction meaningful to the agent</p>
|
|
4186
|
-
</div>
|
|
4187
|
-
|
|
4188
|
-
</li>
|
|
4189
|
-
|
|
4190
|
-
<li>
|
|
4191
|
-
<span class="name">:notes</span>
|
|
4192
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4193
|
-
<span class="default">
|
|
4194
|
-
|
|
4195
|
-
</span>
|
|
4196
|
-
|
|
4197
|
-
— <div class='inline'>
|
|
4198
|
-
<p>human readable notes associated with the transaction meaningful to the
|
|
4199
|
-
agent</p>
|
|
4200
|
-
</div>
|
|
4201
|
-
|
|
4202
|
-
</li>
|
|
4203
|
-
|
|
4204
|
-
<li>
|
|
4205
|
-
<span class="name">:address</span>
|
|
4206
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4207
|
-
<span class="default">
|
|
4208
|
-
|
|
4209
|
-
</span>
|
|
4210
|
-
|
|
4211
|
-
— <div class='inline'>
|
|
4212
|
-
<p>street address of the property associated with the transaction</p>
|
|
4213
|
-
</div>
|
|
4214
|
-
|
|
4215
|
-
</li>
|
|
4216
|
-
|
|
4217
|
-
<li>
|
|
4218
|
-
<span class="name">:city</span>
|
|
4219
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4220
|
-
<span class="default">
|
|
4221
|
-
|
|
4222
|
-
</span>
|
|
4223
|
-
|
|
4224
|
-
— <div class='inline'>
|
|
4225
|
-
<p>city of the property associated with the transaction</p>
|
|
4226
|
-
</div>
|
|
4227
|
-
|
|
4228
|
-
</li>
|
|
4229
|
-
|
|
4230
|
-
<li>
|
|
4231
|
-
<span class="name">:state</span>
|
|
4232
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4233
|
-
<span class="default">
|
|
4234
|
-
|
|
4235
|
-
</span>
|
|
4236
|
-
|
|
4237
|
-
— <div class='inline'>
|
|
4238
|
-
<p>state or province of the property associated with the transaction</p>
|
|
4239
|
-
</div>
|
|
4240
|
-
|
|
4241
|
-
</li>
|
|
4242
|
-
|
|
4243
|
-
<li>
|
|
4244
|
-
<span class="name">:zip_code</span>
|
|
4245
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4246
|
-
<span class="default">
|
|
4247
|
-
|
|
4248
|
-
</span>
|
|
4249
|
-
|
|
4250
|
-
— <div class='inline'>
|
|
4251
|
-
<p>postal code of the property associated with the transaction</p>
|
|
4252
|
-
</div>
|
|
4253
|
-
|
|
4254
|
-
</li>
|
|
4255
|
-
|
|
4256
|
-
<li>
|
|
4257
|
-
<span class="name">:min_sqft</span>
|
|
4258
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4259
|
-
<span class="default">
|
|
4260
|
-
|
|
4261
|
-
</span>
|
|
4262
|
-
|
|
4263
|
-
— <div class='inline'>
|
|
4264
|
-
<p>minimum desired square feet of living area in potential properties</p>
|
|
4265
|
-
</div>
|
|
4266
|
-
|
|
4267
|
-
</li>
|
|
4268
|
-
|
|
4269
|
-
<li>
|
|
4270
|
-
<span class="name">:max_sqft</span>
|
|
4271
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4272
|
-
<span class="default">
|
|
4273
|
-
|
|
4274
|
-
</span>
|
|
4275
|
-
|
|
4276
|
-
— <div class='inline'>
|
|
4277
|
-
<p>maximum desired square feet of living area in potential properties</p>
|
|
4278
|
-
</div>
|
|
4279
|
-
|
|
4280
|
-
</li>
|
|
4281
|
-
|
|
4282
|
-
<li>
|
|
4283
|
-
<span class="name">:min_beds</span>
|
|
4284
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4285
|
-
<span class="default">
|
|
4286
|
-
|
|
4287
|
-
</span>
|
|
4288
|
-
|
|
4289
|
-
— <div class='inline'>
|
|
4290
|
-
<p>minimum desired number of bedrooms in potential properties</p>
|
|
4291
|
-
</div>
|
|
4292
|
-
|
|
4293
|
-
</li>
|
|
4294
|
-
|
|
4295
|
-
<li>
|
|
4296
|
-
<span class="name">:max_beds</span>
|
|
4297
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4298
|
-
<span class="default">
|
|
4299
|
-
|
|
4300
|
-
</span>
|
|
4301
|
-
|
|
4302
|
-
— <div class='inline'>
|
|
4303
|
-
<p>maximum desired number of bedrooms in potential properties</p>
|
|
4304
|
-
</div>
|
|
4305
|
-
|
|
4306
|
-
</li>
|
|
4307
|
-
|
|
4308
|
-
<li>
|
|
4309
|
-
<span class="name">:area_of_interest</span>
|
|
4310
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4311
|
-
<span class="default">
|
|
4312
|
-
|
|
4313
|
-
</span>
|
|
4314
|
-
|
|
4315
|
-
— <div class='inline'>
|
|
4316
|
-
<p>string representing a locality that the client has expressed interest in
|
|
4317
|
-
purchasing a property within</p>
|
|
4318
|
-
</div>
|
|
4319
|
-
|
|
4320
|
-
</li>
|
|
4321
|
-
|
|
4322
|
-
<li>
|
|
4323
|
-
<span class="name">:min_baths</span>
|
|
4324
|
-
<span class="type">(<tt>Integer or Float</tt>)</span>
|
|
4325
|
-
<span class="default">
|
|
4326
|
-
|
|
4327
|
-
</span>
|
|
4328
|
-
|
|
4329
|
-
— <div class='inline'>
|
|
4330
|
-
<p>minimum desired number of bathrooms in potential properties</p>
|
|
4331
|
-
</div>
|
|
4332
|
-
|
|
4333
|
-
</li>
|
|
4334
|
-
|
|
4335
|
-
<li>
|
|
4336
|
-
<span class="name">:max_baths</span>
|
|
4337
|
-
<span class="type">(<tt>Integer or Float</tt>)</span>
|
|
4338
|
-
<span class="default">
|
|
4339
|
-
|
|
4340
|
-
</span>
|
|
4341
|
-
|
|
4342
|
-
— <div class='inline'>
|
|
4343
|
-
<p>maximum desired number of bathrooms in potential properties</p>
|
|
4344
|
-
</div>
|
|
4345
|
-
|
|
4346
|
-
</li>
|
|
4347
|
-
|
|
4348
|
-
<li>
|
|
4349
|
-
<span class="name">:is_mls_transaction</span>
|
|
4350
|
-
<span class="type">(<tt>Boolean</tt>)</span>
|
|
4351
|
-
<span class="default">
|
|
4352
|
-
|
|
4353
|
-
</span>
|
|
4354
|
-
|
|
4355
|
-
— <div class='inline'>
|
|
4356
|
-
<p>Whether the property being purchased is being listed on an MLS. This should
|
|
4357
|
-
be false for paperwork-only, for sale by owner, off-market, or pocket
|
|
4358
|
-
listing type transactions or any transactions that will not be tracked
|
|
4359
|
-
through an MLS.</p>
|
|
4360
|
-
</div>
|
|
4361
|
-
|
|
4362
|
-
</li>
|
|
4363
|
-
|
|
4364
|
-
<li>
|
|
4365
|
-
<span class="name">:mls_number</span>
|
|
4366
|
-
<span class="type">(<tt>String</tt>)</span>
|
|
4367
|
-
<span class="default">
|
|
4368
|
-
|
|
4369
|
-
</span>
|
|
4370
|
-
|
|
4371
|
-
— <div class='inline'>
|
|
4372
|
-
<p>mls number associated with the transaction – mls_number should be populated
|
|
4373
|
-
only if is_mls_transaction is true.</p>
|
|
4374
|
-
</div>
|
|
4375
|
-
|
|
4376
|
-
</li>
|
|
4377
|
-
|
|
4378
|
-
<li>
|
|
4379
|
-
<span class="name">:start_timestamp</span>
|
|
4380
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4381
|
-
<span class="default">
|
|
4382
|
-
|
|
4383
|
-
</span>
|
|
4384
|
-
|
|
4385
|
-
— <div class='inline'>
|
|
4386
|
-
<p>Unix timestamp representing the date the agent initiated transaction
|
|
4387
|
-
discussions with the client.</p>
|
|
4388
|
-
</div>
|
|
4389
|
-
|
|
4390
|
-
</li>
|
|
4391
|
-
|
|
4392
|
-
<li>
|
|
4393
|
-
<span class="name">:commission_percentage</span>
|
|
4394
|
-
<span class="type">(<tt>Float</tt>)</span>
|
|
4395
|
-
<span class="default">
|
|
4396
|
-
|
|
4397
|
-
</span>
|
|
4398
|
-
|
|
4399
|
-
— <div class='inline'>
|
|
4400
|
-
<p>what percentage the commission is if percentage based – A BuyerTransaction
|
|
4401
|
-
can only have either commission_percentage or commission_flat_fee
|
|
4402
|
-
populated. Both can not be populated.</p>
|
|
4403
|
-
</div>
|
|
4404
|
-
|
|
4405
|
-
</li>
|
|
4406
|
-
|
|
4407
|
-
<li>
|
|
4408
|
-
<span class="name">:commission_flat_fee</span>
|
|
4409
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4410
|
-
<span class="default">
|
|
4411
|
-
|
|
4412
|
-
</span>
|
|
4413
|
-
|
|
4414
|
-
— <div class='inline'>
|
|
4415
|
-
<p>how much the commission is if flat fee – A BuyerTransaction can only have
|
|
4416
|
-
either commission_percentage or commission_flat_fee populated. Both can not
|
|
4417
|
-
be populated.</p>
|
|
4418
|
-
</div>
|
|
4419
|
-
|
|
4420
|
-
</li>
|
|
4421
|
-
|
|
4422
|
-
<li>
|
|
4423
|
-
<span class="name">:target_price</span>
|
|
4424
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4425
|
-
<span class="default">
|
|
4426
|
-
|
|
4427
|
-
</span>
|
|
4428
|
-
|
|
4429
|
-
— <div class='inline'>
|
|
4430
|
-
<p>target price associated with the transaction if using a target price rather
|
|
4431
|
-
than price range</p>
|
|
4432
|
-
</div>
|
|
4433
|
-
|
|
4434
|
-
</li>
|
|
4435
|
-
|
|
4436
|
-
<li>
|
|
4437
|
-
<span class="name">:min_price</span>
|
|
4438
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4439
|
-
<span class="default">
|
|
4440
|
-
|
|
4441
|
-
</span>
|
|
4442
|
-
|
|
4443
|
-
— <div class='inline'>
|
|
4444
|
-
<p>minimum acceptable price associated with the transaction if using a price
|
|
4445
|
-
range rather than target price</p>
|
|
4446
|
-
</div>
|
|
4447
|
-
|
|
4448
|
-
</li>
|
|
4449
|
-
|
|
4450
|
-
<li>
|
|
4451
|
-
<span class="name">:max_price</span>
|
|
4452
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4453
|
-
<span class="default">
|
|
4454
|
-
|
|
4455
|
-
</span>
|
|
4456
|
-
|
|
4457
|
-
— <div class='inline'>
|
|
4458
|
-
<p>maximum price associated with the transaction if using a price range rather
|
|
4459
|
-
than target price</p>
|
|
4460
|
-
</div>
|
|
4461
|
-
|
|
4462
|
-
</li>
|
|
4463
|
-
|
|
4464
|
-
<li>
|
|
4465
|
-
<span class="name">:closing_timestamp</span>
|
|
4466
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4467
|
-
<span class="default">
|
|
4468
|
-
|
|
4469
|
-
</span>
|
|
4470
|
-
|
|
4471
|
-
— <div class='inline'>
|
|
4472
|
-
<p>Unix timestamp representing the date the sale of the property closed –
|
|
4473
|
-
closing_timestamp should only be used when the SellerTransaction state = 5
|
|
4474
|
-
(complete)</p>
|
|
4475
|
-
</div>
|
|
4476
|
-
|
|
4477
|
-
</li>
|
|
4478
|
-
|
|
4479
|
-
<li>
|
|
4480
|
-
<span class="name">:closing_price</span>
|
|
4481
|
-
<span class="type">(<tt>Integer</tt>)</span>
|
|
4482
|
-
<span class="default">
|
|
4483
|
-
|
|
4484
|
-
</span>
|
|
4485
|
-
|
|
4486
|
-
— <div class='inline'>
|
|
4487
|
-
<p>selling price of the property – closing_price should only be used when the
|
|
4488
|
-
SellerTransaction state = 5 (complete)</p>
|
|
4489
|
-
</div>
|
|
4490
|
-
|
|
4491
|
-
</li>
|
|
4492
|
-
|
|
4493
|
-
<li>
|
|
4494
|
-
<span class="name">:promote_transaction</span>
|
|
4495
|
-
<span class="type">(<tt>Boolean</tt>)</span>
|
|
4496
|
-
<span class="default">
|
|
4497
|
-
|
|
4498
|
-
</span>
|
|
4499
|
-
|
|
4500
|
-
— <div class='inline'>
|
|
4501
|
-
<p>If this is set to true then The Moxi Works Platform will promote this
|
|
4502
|
-
transaction to the next stage</p>
|
|
4503
|
-
</div>
|
|
4504
|
-
|
|
4505
|
-
</li>
|
|
4506
|
-
|
|
4507
|
-
</ul>
|
|
4508
|
-
|
|
4509
|
-
|
|
4510
|
-
<p class="tag_title">Returns:</p>
|
|
4511
|
-
<ul class="return">
|
|
4512
|
-
|
|
4513
|
-
<li>
|
|
4514
|
-
|
|
4515
|
-
|
|
4516
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::BuyerTransaction (class)">MoxiworksPlatform::BuyerTransaction</a></span></tt>)</span>
|
|
4517
|
-
|
|
4518
|
-
|
|
4519
|
-
|
|
4520
|
-
</li>
|
|
4521
|
-
|
|
4522
|
-
</ul>
|
|
4523
|
-
<p class="tag_title">Raises:</p>
|
|
4524
|
-
<ul class="raise">
|
|
4525
|
-
|
|
4526
|
-
<li>
|
|
4527
|
-
|
|
4528
|
-
|
|
4529
|
-
<span class='type'></span>
|
|
4530
|
-
|
|
4531
|
-
|
|
4532
|
-
|
|
4533
|
-
|
|
4534
|
-
<div class='inline'>
|
|
4535
|
-
<p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
|
|
4536
|
-
aren't included</p>
|
|
4537
|
-
</div>
|
|
4538
|
-
|
|
4539
|
-
</li>
|
|
4540
|
-
|
|
4541
|
-
</ul>
|
|
4542
|
-
|
|
4543
|
-
</div><table class="source_code">
|
|
4544
|
-
<tr>
|
|
4545
|
-
<td>
|
|
4546
|
-
<pre class="lines">
|
|
4547
|
-
|
|
4548
|
-
|
|
4549
|
-
491
|
|
4550
|
-
492
|
|
4551
|
-
493
|
|
4552
|
-
494
|
|
4553
|
-
495
|
|
4554
|
-
496
|
|
4555
|
-
497
|
|
4556
|
-
498
|
|
4557
|
-
499</pre>
|
|
4558
|
-
</td>
|
|
4559
|
-
<td>
|
|
4560
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 491</span>
|
|
4561
|
-
|
|
4562
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</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>
|
|
4563
|
-
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='comma'>,</span> <span class='symbol'>:moxi_works_transaction_id</span><span class='rbracket'>]</span>
|
|
4564
|
-
<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>
|
|
4565
|
-
<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'>"</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'>"</span></span> <span class='kw'>if</span>
|
|
4566
|
-
<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>
|
|
4567
|
-
<span class='kw'>end</span>
|
|
4568
|
-
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</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/buyer_transactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_transaction_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
4569
|
-
<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'>:put</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>
|
|
4570
|
-
<span class='kw'>end</span></pre>
|
|
4571
|
-
</td>
|
|
4572
|
-
</tr>
|
|
4573
|
-
</table>
|
|
4574
|
-
</div>
|
|
4575
|
-
|
|
4576
|
-
</div>
|
|
4577
|
-
|
|
4578
|
-
<div id="instance_method_details" class="method_details_list">
|
|
4579
|
-
<h2>Instance Method Details</h2>
|
|
4580
|
-
|
|
4581
|
-
|
|
4582
|
-
<div class="method_details first">
|
|
4583
|
-
<h3 class="signature first" id="promote-instance_method">
|
|
4584
|
-
|
|
4585
|
-
#<strong>promote</strong> ⇒ <tt>Object</tt>
|
|
4586
|
-
|
|
4587
|
-
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
|
|
4591
|
-
</h3><table class="source_code">
|
|
4592
|
-
<tr>
|
|
4593
|
-
<td>
|
|
4594
|
-
<pre class="lines">
|
|
4595
|
-
|
|
4596
|
-
|
|
4597
|
-
555
|
|
4598
|
-
556
|
|
4599
|
-
557
|
|
4600
|
-
558</pre>
|
|
4601
|
-
</td>
|
|
4602
|
-
<td>
|
|
4603
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 555</span>
|
|
4604
|
-
|
|
4605
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_promote'>promote</span>
|
|
4606
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_promote_transaction'>promote_transaction</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
4607
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
4608
|
-
<span class='kw'>end</span></pre>
|
|
4609
|
-
</td>
|
|
4610
|
-
</tr>
|
|
4611
|
-
</table>
|
|
4612
|
-
</div>
|
|
4613
|
-
|
|
4614
|
-
<div class="method_details ">
|
|
4615
|
-
<h3 class="signature " id="save-instance_method">
|
|
4616
|
-
|
|
4617
|
-
#<strong>save</strong> ⇒ <tt>MoxiWorksPlatform:BuyerTransaction</tt>
|
|
4618
|
-
|
|
4619
|
-
|
|
4620
|
-
|
|
4621
|
-
|
|
4622
|
-
|
|
4623
|
-
</h3><div class="docstring">
|
|
4624
|
-
<div class="discussion">
|
|
4625
|
-
|
|
4626
|
-
<p>Save an instance of MoxiWorksPlatform::BuyerTransaction to Moxi Works
|
|
4627
|
-
Platform</p>
|
|
4628
|
-
|
|
4629
|
-
|
|
4630
|
-
</div>
|
|
4631
|
-
</div>
|
|
4632
|
-
<div class="tags">
|
|
4633
|
-
|
|
4634
|
-
<div class="examples">
|
|
4635
|
-
<p class="tag_title">Examples:</p>
|
|
4636
|
-
|
|
4637
|
-
|
|
4638
|
-
<pre class="example code"><code><span class='id identifier rubyid_transaction'>transaction</span> <span class='op'>=</span> <span class='const'>MoxiWorksPlatform</span><span class='op'>::</span><span class='const'>BuyerTransaction</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
4639
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1234abc</span><span class='tstring_end'>'</span></span>
|
|
4640
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_moxi_works_transaction_id'>moxi_works_transaction_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>burbywurb</span><span class='tstring_end'>'</span></span>
|
|
4641
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_promote_transaction'>promote_transaction</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
4642
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_closing_timestamp'>closing_timestamp</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
4643
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_closing_price'>closing_price</span> <span class='op'>=</span> <span class='int'>1234567</span>
|
|
4644
|
-
<span class='id identifier rubyid_transaction'>transaction</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span></code></pre>
|
|
4645
|
-
|
|
4646
|
-
</div>
|
|
4647
|
-
|
|
4648
|
-
<p class="tag_title">Returns:</p>
|
|
4649
|
-
<ul class="return">
|
|
4650
|
-
|
|
4651
|
-
<li>
|
|
4652
|
-
|
|
4653
|
-
|
|
4654
|
-
<span class='type'>(<tt>MoxiWorksPlatform:BuyerTransaction</tt>)</span>
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
</li>
|
|
4659
|
-
|
|
4660
|
-
</ul>
|
|
4661
|
-
|
|
4662
|
-
</div><table class="source_code">
|
|
4663
|
-
<tr>
|
|
4664
|
-
<td>
|
|
4665
|
-
<pre class="lines">
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
547
|
|
4669
|
-
548
|
|
4670
|
-
549
|
|
4671
|
-
550
|
|
4672
|
-
551
|
|
4673
|
-
552
|
|
4674
|
-
553</pre>
|
|
4675
|
-
</td>
|
|
4676
|
-
<td>
|
|
4677
|
-
<pre class="code"><span class="info file"># File 'lib/moxiworks_platform/buyer_transaction.rb', line 547</span>
|
|
4678
|
-
|
|
4679
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span>
|
|
4680
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>BuyerTransaction</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span>
|
|
4681
|
-
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_moxi_works_transaction_id'>moxi_works_transaction_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_moxi_works_transaction_id'>moxi_works_transaction_id</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
4682
|
-
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_r'>r</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rbrace'>}</span>
|
|
4683
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_promote_transaction'>promote_transaction</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
4684
|
-
<span class='kw'>self</span>
|
|
4685
|
-
<span class='kw'>end</span></pre>
|
|
4686
|
-
</td>
|
|
4687
|
-
</tr>
|
|
4688
|
-
</table>
|
|
4689
|
-
</div>
|
|
4690
|
-
|
|
4691
|
-
</div>
|
|
4692
|
-
|
|
4693
|
-
</div>
|
|
4694
|
-
|
|
4695
|
-
<div id="footer">
|
|
4696
|
-
Generated on Fri Apr 20 10:00:20 2018 by
|
|
4697
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
4698
|
-
0.9.5 (ruby-2.2.4).
|
|
4699
|
-
</div>
|
|
4700
|
-
|
|
4701
|
-
</div>
|
|
4702
|
-
</body>
|
|
4703
|
-
</html>
|