class RealPage::Request::GetRentMatrix

Retrieve pricing data for units in a property.

Required intializer parameters:

@param least_term [Integer] Proposed lease term duration, in months @param need_by_date [Date] Proposed date when prospect would move in to

any apartment

@param pmc_id [String] the unique identifier for the property management

company in RealPage

@param site_id [String] the unique identifier for the property in RealPage @param unit_ids [Array<Integer|String>] Array of integer Unit ID numbers

as acquired from GetUnitsByProperty

@param viewing_quote_only [true|false] Identifies whether the user is

viewing or creating new quote

Attributes

lease_term[R]
need_by_date[R]
unit_ids[R]
viewing_quote_only[R]

Private Instance Methods

after_initialize(params) click to toggle source
# File lib/real_page/request/get_rent_matrix.rb, line 27
def after_initialize(params)
  %i[
    lease_term
    need_by_date
    unit_ids
    viewing_quote_only
  ].each do |required_param|
    unless params[required_param]
      raise ArgumentError, "Params must include :#{required_param}"
    end
    instance_variable_set("@#{required_param}", params[required_param])
  end
end
parser() click to toggle source
# File lib/real_page/request/get_rent_matrix.rb, line 52
def parser
  DocumentParser::RentMatrices.new
end
sections() click to toggle source
# File lib/real_page/request/get_rent_matrix.rb, line 41
def sections
  [
    RequestSection::GetRentMatrix.new(
      lease_term: lease_term,
      need_by_date: need_by_date,
      unit_ids: unit_ids,
      viewing_quote_only: viewing_quote_only
    )
  ]
end