Class: Buildium::ListingPropertyMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/listing_property_message.rb

Overview

Details of the unit property.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListingPropertyMessage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 110

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::ListingPropertyMessage` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Buildium::ListingPropertyMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.key?(:'number_units')
    self.number_units = attributes[:'number_units']
  end

  if attributes.key?(:'structure_description')
    self.structure_description = attributes[:'structure_description']
  end

  if attributes.key?(:'year_built')
    self.year_built = attributes[:'year_built']
  end

  if attributes.key?(:'features')
    if (value = attributes[:'features']).is_a?(Array)
      self.features = value
    end
  end

  if attributes.key?(:'included_in_rent')
    if (value = attributes[:'included_in_rent']).is_a?(Array)
      self.included_in_rent = value
    end
  end

  if attributes.key?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  end
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



25
26
27
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 25

def address
  @address
end

#features ⇒ Object

List of features for the property.



37
38
39
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 37

def features
  @features
end

#files ⇒ Object

List of media files associated with the property.



43
44
45
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 43

def files
  @files
end

#id ⇒ Object

Rental property unique identifier.



20
21
22
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 20

def id
  @id
end

#included_in_rent ⇒ Object

The list of amenities included in rent the property has.



40
41
42
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 40

def included_in_rent
  @included_in_rent
end

#name ⇒ Object

Name of the rental property.



23
24
25
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 23

def name
  @name
end

#number_units ⇒ Object

Number of units in the rental property.



28
29
30
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 28

def number_units
  @number_units
end

#structure_description ⇒ Object

Description of the rental property structure.



31
32
33
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 31

def structure_description
  @structure_description
end

#year_built ⇒ Object

Year the rental property was built.



34
35
36
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 34

def year_built
  @year_built
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 68

def self.attribute_map
  {
    :'id' => :'Id',
    :'name' => :'Name',
    :'address' => :'Address',
    :'number_units' => :'NumberUnits',
    :'structure_description' => :'StructureDescription',
    :'year_built' => :'YearBuilt',
    :'features' => :'Features',
    :'included_in_rent' => :'IncludedInRent',
    :'files' => :'Files'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



210
211
212
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 210

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 103

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 88

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'address' => :'AddressMessage',
    :'number_units' => :'Integer',
    :'structure_description' => :'String',
    :'year_built' => :'Integer',
    :'features' => :'Array<String>',
    :'included_in_rent' => :'Array<String>',
    :'files' => :'Array<ListingFileMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      number_units == o.number_units &&
      structure_description == o.structure_description &&
      year_built == o.year_built &&
      features == o.features &&
      included_in_rent == o.included_in_rent &&
      files == o.files
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 241

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 312

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 217

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 203

def hash
  [id, name, address, number_units, structure_description, year_built, features, included_in_rent, files].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



168
169
170
171
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 288

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 294

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



282
283
284
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 282

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



175
176
177
 
# File 'lib/buildium-ruby/models/listing_property_message.rb', line 175

def valid?
  true
end