Module: YieldStarClient::LeaseTermRentMethods
- Includes:
- Validations
- Included in:
- Client
- Defined in:
- lib/yield_star_client/lease_term_rent_methods.rb
Instance Method Summary collapse
-
#get_lease_term_rent(external_property_id, unit_number, opts = {}) ⇒ Array<YieldStarClient::LeaseTermRent>
Retrieves a matrix providing the specific rate for each combination of lease term and move-in date for a particular unit.
-
#get_lease_term_rent_plus(external_property_id, unit_number, opts = {}) ⇒ Object
This method is identical to #get_lease_term_rent, but the return value also includes the last date for which the price is valid.
-
#get_renewal_lease_term_rent(external_property_id, unit_number, opts = {}) ⇒ Array<YieldStarClient::RenewalLeaseTermRent>
Retrieves rate data for units that are within “Renewal Notice Days” of lease expiration, and those units for which renewal rates have been manually generated and accepted.
Methods included from Validations
#validate_client_name!, #validate_external_property_id!
Instance Method Details
#get_lease_term_rent(external_property_id, unit_number, opts = {}) ⇒ Array<YieldStarClient::LeaseTermRent>
Retrieves a matrix providing the specific rate for each combination of lease term and move-in date for a particular unit.
104 105 106 107 108 109 110 111 112 |
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 104 def get_lease_term_rent(external_property_id, unit_number, opts={}) opts ||= {} call_lease_term_rent_method(external_property_id, unit_number, opts.merge(:request_element => :lease_term_rent_unit_request, :soap_action => :get_lease_term_rent, :response_element => :lease_term_rent_unit_response, :result_class => LeaseTermRent)) end |
#get_lease_term_rent_plus(external_property_id, unit_number, opts = {}) ⇒ Object
This method is identical to #get_lease_term_rent, but the return value also includes the last date for which the price is valid.
#get_lease_term_rent
118 119 120 121 122 123 124 125 126 |
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 118 def get_lease_term_rent_plus(external_property_id, unit_number, opts={}) opts ||= {} call_lease_term_rent_method(external_property_id, unit_number, opts.merge(:request_element => :lease_term_rent_unit_request, :soap_action => :get_lease_term_rent_plus, :response_element => :lease_term_rent_unit_plus_response, :result_class => LeaseTermRent)) end |
#get_renewal_lease_term_rent(external_property_id, unit_number, opts = {}) ⇒ Array<YieldStarClient::RenewalLeaseTermRent>
Retrieves rate data for units that are within “Renewal Notice Days” of lease expiration, and those units for which renewal rates have been manually generated and accepted.
142 143 144 145 146 147 148 149 150 |
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 142 def get_renewal_lease_term_rent(external_property_id, unit_number, opts={}) opts ||= {} call_lease_term_rent_method(external_property_id, unit_number, opts.merge(:request_element => :renewal_lease_term_rent_unit_request, :soap_action => :get_renewal_lease_term_rent, :response_element => :renewal_lease_term_rent_unit_response, :result_class => RenewalLeaseTermRent)) end |