moxiworks_platform 0.13.15 → 0.13.16

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