Class: Buildium::RentalPropertyPostMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalPropertyPostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 114

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



24
25
26
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 24

def address
  @address
end

#name ⇒ Object

Rental property name. The value cannot exceed 127 characters.



19
20
21
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 19

def name
  @name
end

#operating_bank_account_id ⇒ Object

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



33
34
35
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 33

def 
  @operating_bank_account_id
end

#property_manager_id ⇒ Object

Indicates the staff member identifier that acts as the property manager for this rental property. Note, the staff member must have permissions to this rental to be assigned as the property manager. Set this field to null if you don’t want to assign a staff member to the rental property.



36
37
38
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 36

def property_manager_id
  @property_manager_id
end

#rental_owner_ids ⇒ Object

List of existing rental owner ID’s that are owners of this property.



30
31
32
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 30

def rental_owner_ids
  @rental_owner_ids
end

#rental_sub_type ⇒ Object

Subtype of the rental property.



27
28
29
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 27

def rental_sub_type
  @rental_sub_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.



39
40
41
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 39

def reserve
  @reserve
end

#structure_description ⇒ Object

Description of the rental property building. The description cannot exceed 65,535 characters.



22
23
24
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 22

def structure_description
  @structure_description
end

#units ⇒ Object

Units of the rental property. If no values are provided, a default unit will be created for the property. The number of units cannot exceed 100. If you need to create more than 100 units for the property, use the <a href="#operation/RentalUnitsCreateRentalUnit">Create a unit</a> endpoint to create the additional units once the property has been created.



45
46
47
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 45

def units
  @units
end

#year_built ⇒ Object

Indicates the year the rental property was built. If provided this value must be a four digit integer between 1000 and the current year.



42
43
44
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 42

def year_built
  @year_built
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 70

def self.attribute_map
  {
    :'name' => :'Name',
    :'structure_description' => :'StructureDescription',
    :'address' => :'Address',
    :'rental_sub_type' => :'RentalSubType',
    :'rental_owner_ids' => :'RentalOwnerIds',
    :'operating_bank_account_id' => :'OperatingBankAccountId',
    :'property_manager_id' => :'PropertyManagerId',
    :'reserve' => :'Reserve',
    :'year_built' => :'YearBuilt',
    :'units' => :'Units'
  }
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



249
250
251
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 249

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 91

def self.openapi_types
  {
    :'name' => :'String',
    :'structure_description' => :'String',
    :'address' => :'SaveAddressMessage',
    :'rental_sub_type' => :'String',
    :'rental_owner_ids' => :'Array<Integer>',
    :'operating_bank_account_id' => :'Integer',
    :'property_manager_id' => :'Integer',
    :'reserve' => :'Float',
    :'year_built' => :'Integer',
    :'units' => :'Array<RentalPropertyUnitPostMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      structure_description == o.structure_description &&
      address == o.address &&
      rental_sub_type == o.rental_sub_type &&
      rental_owner_ids == o.rental_owner_ids &&
       == o. &&
      property_manager_id == o.property_manager_id &&
      reserve == o.reserve &&
      year_built == o.year_built &&
      units == o.units
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



280
281
282
283
284
285
286
287
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
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 280

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 351

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 256

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


236
237
238
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



242
243
244
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 242

def hash
  [name, structure_description, address, rental_sub_type, rental_owner_ids, , property_manager_id, reserve, year_built, units].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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 174

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

  if @rental_sub_type.nil?
    invalid_properties.push('invalid value for "rental_sub_type", rental_sub_type cannot be nil.')
  end

  if @operating_bank_account_id.nil?
    invalid_properties.push('invalid value for "operating_bank_account_id", operating_bank_account_id cannot be nil.')
  end

  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



327
328
329
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 333

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



321
322
323
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 321

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



197
198
199
200
201
202
203
204
205
 
# File 'lib/buildium-ruby/models/rental_property_post_message.rb', line 197

def valid?
  return false if @name.nil?
  return false if @address.nil?
  return false if @rental_sub_type.nil?
  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)
  return false if @operating_bank_account_id.nil?
  true
end