Class: Buildium::RentalMessage

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

Overview

This is an object that represents a rental property.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 124

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::RentalMessage` 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::RentalMessage`. 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?(:'structure_description')
    self.structure_description = attributes[:'structure_description']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#id ⇒ Object

Rental property unique identifier.



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

def id
  @id
end

#is_active ⇒ Object

Indicates whether the rental property is active within the Buildium platform.



32
33
34
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 32

def is_active
  @is_active
end

#name ⇒ Object

Name of the rental property.



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

def name
  @name
end

#number_units ⇒ Object

Number of units in the rental property.



29
30
31
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 29

def number_units
  @number_units
end

#operating_bank_account_id ⇒ Object

The primary bank account that a rental property uses for its income and expenses.



35
36
37
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 35

def 
  
end

#rental_manager ⇒ Object

Returns the value of attribute rental_manager.



51
52
53
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 51

def rental_manager
  @rental_manager
end

#rental_sub_type ⇒ Object

Indicates the sub type of the rental property.



49
50
51
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 49

def rental_sub_type
  @rental_sub_type
end

#rental_type ⇒ Object

Indicates the type of rental property.



46
47
48
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 46

def rental_type
  @rental_type
end

#reserve ⇒ Object

A property reserve is cash that a property manager keeps on hand in case of unexpected expenses. It is available cash that isn’t disbursed in an owner draw.



38
39
40
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 38

def reserve
  @reserve
end

#structure_description ⇒ Object

Description of the rental property structure.



26
27
28
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 26

def structure_description
  @structure_description
end

#year_built ⇒ Object

Year the rental property was built.



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

def year_built
  @year_built
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 76

def self.attribute_map
  {
    :'id' => :'Id',
    :'name' => :'Name',
    :'structure_description' => :'StructureDescription',
    :'number_units' => :'NumberUnits',
    :'is_active' => :'IsActive',
    :'operating_bank_account_id' => :'OperatingBankAccountId',
    :'reserve' => :'Reserve',
    :'address' => :'Address',
    :'year_built' => :'YearBuilt',
    :'rental_type' => :'RentalType',
    :'rental_sub_type' => :'RentalSubType',
    :'rental_manager' => :'RentalManager'
  }
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



257
258
259
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 257

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 99

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'structure_description' => :'String',
    :'number_units' => :'Integer',
    :'is_active' => :'Boolean',
    :'operating_bank_account_id' => :'Integer',
    :'reserve' => :'Float',
    :'address' => :'AddressMessage',
    :'year_built' => :'Integer',
    :'rental_type' => :'String',
    :'rental_sub_type' => :'String',
    :'rental_manager' => :'PropertyManagerMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      structure_description == o.structure_description &&
      number_units == o.number_units &&
      is_active == o.is_active &&
       == o. &&
      reserve == o.reserve &&
      address == o.address &&
      year_built == o.year_built &&
      rental_type == o.rental_type &&
      rental_sub_type == o.rental_sub_type &&
      rental_manager == o.rental_manager
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 288

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 359

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 264

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


244
245
246
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 250

def hash
  [id, name, structure_description, number_units, is_active, , reserve, address, year_built, rental_type, rental_sub_type, rental_manager].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



188
189
190
191
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 188

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



335
336
337
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 341

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



329
330
331
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 329

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



195
196
197
198
199
200
201
 
# File 'lib/buildium-ruby/models/rental_message.rb', line 195

def valid?
  rental_type_validator = EnumAttributeValidator.new('String', ["None", "Residential", "Commercial"])
  return false unless rental_type_validator.valid?(@rental_type)
  rental_sub_type_validator = EnumAttributeValidator.new('String', ["CondoTownhome", "MultiFamily", "SingleFamily", "Industrial", "Office", "Retail", "ShoppingCenter", "Storage", "ParkingSpace"])
  return false unless rental_sub_type_validator.valid?(@rental_sub_type)
  true
end