Class: Buildium::ClientLeadMessage

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

Overview

This is an object that represents a client lead

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientLeadMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 119

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#comments ⇒ Object

Additional comments submitted for the lead.



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

def comments
  @comments
end

#credit_request ⇒ Object

Returns the value of attribute credit_request.



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

def credit_request
  @credit_request
end

#date_received ⇒ Object

The date the lead was received.



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

def date_received
  @date_received
end

#email ⇒ Object

The email of the lead.



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

def email
  @email
end

#id ⇒ Object

Client lead unique identifier.



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

def id
  @id
end

#lead_status ⇒ Object

The current status of the client lead.



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

def lead_status
  @lead_status
end

#name ⇒ Object

The name of the lead.



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

def name
  @name
end

#phone_number ⇒ Object

The phone number of the lead.



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

def phone_number
  @phone_number
end

#price_paid ⇒ Object

The price paid for the lead.



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

def price_paid
  @price_paid
end

#property_type ⇒ Object

The property type of the lead’s property.



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

def property_type
  @property_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'Id',
    :'date_received' => :'DateReceived',
    :'name' => :'Name',
    :'email' => :'Email',
    :'phone_number' => :'PhoneNumber',
    :'price_paid' => :'PricePaid',
    :'address' => :'Address',
    :'property_type' => :'PropertyType',
    :'comments' => :'Comments',
    :'lead_status' => :'LeadStatus',
    :'credit_request' => :'CreditRequest'
  }
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
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 247

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'date_received' => :'Time',
    :'name' => :'String',
    :'email' => :'String',
    :'phone_number' => :'String',
    :'price_paid' => :'Float',
    :'address' => :'AddressMessage',
    :'property_type' => :'String',
    :'comments' => :'String',
    :'lead_status' => :'String',
    :'credit_request' => :'ClientLeadCreditRequestMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date_received == o.date_received &&
      name == o.name &&
      email == o.email &&
      phone_number == o.phone_number &&
      price_paid == o.price_paid &&
      address == o.address &&
      property_type == o.property_type &&
      comments == o.comments &&
      lead_status == o.lead_status &&
      credit_request == o.credit_request
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



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
309
310
311
312
313
314
315
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 278

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



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

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



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

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


234
235
236
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [id, date_received, name, email, phone_number, price_paid, address, property_type, comments, lead_status, credit_request].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



179
180
181
182
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 179

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



325
326
327
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 325

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



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

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



319
320
321
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 319

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



186
187
188
189
190
191
192
 
# File 'lib/buildium-ruby/models/client_lead_message.rb', line 186

def valid?
  property_type_validator = EnumAttributeValidator.new('String', ["SingleHomeUpToThreeHundredThousand", "SingleHomeThreeHundredToFiveHundredThousand", "SingleHomeFiveHundredThousandToOneMillion", "SingleHomeOverOneMillion", "MultiFamilyTwoToFourUnits", "MultiFamilyFiveToNineteenUnits", "MultiFamilyTwentyToFortyNineUnits", "MultiFamilyOverOneHundredUnits", "OfficeLessThanTenThousandSqFt", "OfficeTenThousandToOneHundredThousandSqFt", "OfficeOverOneHundredThousandSqFt", "RetailLessThanTenThousandSqFt", "RetailTenThousandToOneHundredThousandSqFt", "RetailOverOneHundredThousandSqFt", "LightManufacturingUpToOneHundredThousandSqFt", "LightManufacturingOverOneHundredThousandSqFt", "WarehouseUpToOneHundredThousandSqFt", "WarehouseOverOneHundredThousandSqFt", "VacationOneToTwoUnits", "VacationOverThreeUnits", "ParkingGarage", "OtherAssociation", "BiotechMissionCritical", "HOATwoToFortyNineUnits", "HOAFiftyToNinetyNineUnits", "HOAOverOneHundredUnits", "COATwoToFortyNineUnits", "COAFiftyToNinetyNineUnits", "COAOverOneHundredUnits", "MobileHomeCommunity"])
  return false unless property_type_validator.valid?(@property_type)
  lead_status_validator = EnumAttributeValidator.new('String', ["Unknown", "New", "Contacting", "Qualifying", "Closing", "ClosedWon", "ClosedLost"])
  return false unless lead_status_validator.valid?(@lead_status)
  true
end