Class: Buildium::ApplicantMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicantMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 120

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

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

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

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

  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?(:'email')
    self.email = attributes[:'email']
  end

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

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

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

Instance Attribute Details

#applicant_group_id ⇒ Object

Applicant group unique identifier.



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

def applicant_group_id
  @applicant_group_id
end

#applications ⇒ Object

A collection of applications associated with the applicant.



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

def applications
  @applications
end

#email ⇒ Object

Applicant email address.



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

def email
  @email
end

#first_name ⇒ Object

Applicant first name.



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

def first_name
  @first_name
end

#id ⇒ Object

Applicant unique identifier.



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

def id
  @id
end

#last_name ⇒ Object

Applicant last name.



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

def last_name
  @last_name
end

#phone_numbers ⇒ Object

Applicant phone numbers.



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

def phone_numbers
  @phone_numbers
end

#property_id ⇒ Object

Rental property unique identifier that the applicant is associated with.



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

def property_id
  @property_id
end

#status ⇒ Object

Applicant status.



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

def status
  @status
end

#tenant_id ⇒ Object

The rental tenant identifier associated with the applicant. This value will be null if the applicant never transitioned into a tenant.



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

def tenant_id
  @tenant_id
end

#unit_id ⇒ Object

Rental property unit unique identifier that the applicant is associated with.



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

def unit_id
  @unit_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 74

def self.attribute_map
  {
    :'id' => :'Id',
    :'applicant_group_id' => :'ApplicantGroupId',
    :'property_id' => :'PropertyId',
    :'unit_id' => :'UnitId',
    :'tenant_id' => :'TenantId',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'email' => :'Email',
    :'phone_numbers' => :'PhoneNumbers',
    :'status' => :'Status',
    :'applications' => :'Applications'
  }
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



240
241
242
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 240

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 96

def self.openapi_types
  {
    :'id' => :'Integer',
    :'applicant_group_id' => :'Integer',
    :'property_id' => :'Integer',
    :'unit_id' => :'Integer',
    :'tenant_id' => :'Integer',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'phone_numbers' => :'Array<PhoneNumberMessage>',
    :'status' => :'String',
    :'applications' => :'Array<ApplicantApplicationMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      applicant_group_id == o.applicant_group_id &&
      property_id == o.property_id &&
      unit_id == o.unit_id &&
      tenant_id == o.tenant_id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      phone_numbers == o.phone_numbers &&
      status == o.status &&
      applications == o.applications
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



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
307
308
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 271

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



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

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



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

def build_from_hash(attributes)
  return 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


227
228
229
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 233

def hash
  [id, applicant_group_id, property_id, unit_id, tenant_id, first_name, last_name, email, phone_numbers, status, applications].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



184
185
186
187
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 184

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



318
319
320
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 318

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



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

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



312
313
314
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 312

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



191
192
193
194
195
 
# File 'lib/buildium-ruby/models/applicant_message.rb', line 191

def valid?
  status_validator = EnumAttributeValidator.new('String', ["Undecided", "Approved", "Rejected", "AddedToLease", "Cancelled", "Deferred", "New", "Draft"])
  return false unless status_validator.valid?(@status)
  true
end