Class: Buildium::RentalOwnerPutMessage

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

Overview

This is an object that represents a rental property owner.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalOwnerPutMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
109
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
165
166
167
168
169
170
171
172
173
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



48
49
50
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 48

def address
  @address
end

#alternate_email ⇒ Object

Alternate email of the rental owner.



44
45
46
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 44

def alternate_email
  @alternate_email
end

#comment ⇒ Object

Comments about the rental owner. The comments cannot exceed 65,535 characters.



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

def comment
  @comment
end

#company_name ⇒ Object

Company name of the rental owner. Required if ‘IsCompany` is `true`. The value cannot exceed 127 characters.



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

def company_name
  @company_name
end

#date_of_birth ⇒ Object

Date of birth of the rental owner. Must be formatted as ‘YYYY-MM-DD`.



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

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Email of the rental owner.



41
42
43
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 41

def email
  @email
end

#first_name ⇒ Object

First name of the rental owner. Required if ‘IsCompany` is `false`. The value cannot exceed 127 characters.



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

def first_name
  @first_name
end

#is_company ⇒ Object

Indicates whether the rental owner should be considered a company or person.



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

def is_company
  @is_company
end

#last_name ⇒ Object

Last name of the rental owner. Required if ‘IsCompany` is `false`. The value cannot exceed 127 characters.



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

def last_name
  @last_name
end

#management_agreement_end_date ⇒ Object

End date of the management agreement with the rental owner. Must be formatted as ‘YYYY-MM-DD`.



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

def management_agreement_end_date
  @management_agreement_end_date
end

#management_agreement_start_date ⇒ Object

Start date of the management agreement with the rental owner. Must be formatted as ‘YYYY-MM-DD`.



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

def management_agreement_start_date
  @management_agreement_start_date
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



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

def phone_numbers
  @phone_numbers
end

#property_ids ⇒ Object

A list of rental property ID’s to associate with this rental owner. At least one property ID must be provided.



54
55
56
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 54

def property_ids
  @property_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 57

def self.attribute_map
  {
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'is_company' => :'IsCompany',
    :'company_name' => :'CompanyName',
    :'date_of_birth' => :'DateOfBirth',
    :'management_agreement_start_date' => :'ManagementAgreementStartDate',
    :'management_agreement_end_date' => :'ManagementAgreementEndDate',
    :'email' => :'Email',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'address' => :'Address',
    :'comment' => :'Comment',
    :'property_ids' => :'PropertyIds'
  }
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



238
239
240
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 238

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 81

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'is_company' => :'Boolean',
    :'company_name' => :'String',
    :'date_of_birth' => :'Date',
    :'management_agreement_start_date' => :'Date',
    :'management_agreement_end_date' => :'Date',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'PhoneNumbersMessage',
    :'address' => :'SaveAddressMessage',
    :'comment' => :'String',
    :'property_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      is_company == o.is_company &&
      company_name == o.company_name &&
      date_of_birth == o.date_of_birth &&
      management_agreement_start_date == o.management_agreement_start_date &&
      management_agreement_end_date == o.management_agreement_end_date &&
      email == o.email &&
      alternate_email == o.alternate_email &&
      phone_numbers == o.phone_numbers &&
      address == o.address &&
      comment == o.comment &&
      property_ids == o.property_ids
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



269
270
271
272
273
274
275
276
277
278
279
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
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 269

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



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

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 245

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


225
226
227
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 231

def hash
  [first_name, last_name, is_company, company_name, date_of_birth, management_agreement_start_date, management_agreement_end_date, email, alternate_email, phone_numbers, address, comment, property_ids].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



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

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

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

  if @property_ids.nil?
    invalid_properties.push('invalid value for "property_ids", property_ids 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



316
317
318
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 322

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



310
311
312
 
# File 'lib/buildium-ruby/models/rental_owner_put_message.rb', line 310

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



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

def valid?
  return false if @is_company.nil?
  return false if @address.nil?
  return false if @property_ids.nil?
  true
end