Class: Buildium::TenantSearchMessage

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

Overview

This object represents a filter for a rental tenant search.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TenantSearchMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.key?(:'property_ids')
    if (value = attributes[:'property_ids']).is_a?(Array)
      self.property_ids = value
    end
  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?(:'last_updated_from')
    self.last_updated_from = attributes[:'last_updated_from']
  end

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

Instance Attribute Details

#building_statuses ⇒ Object

Filters results by the status of the rental property the tenants are associated with. If no status is specified tenants in either ‘active` and `inactive` rental properties will be returned.



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

def building_statuses
  @building_statuses
end

#email ⇒ Object

Filters results to any tenant whose email contains the specified value.



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

def email
  @email
end

#last_updated_from ⇒ Object

Filters results to any rental tenants that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.



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

def last_updated_from
  @last_updated_from
end

#last_updated_to ⇒ Object

Filters results to any rental tenants that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.



47
48
49
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 47

def last_updated_to
  @last_updated_to
end

#lease_term_statuses ⇒ Object

Filters results to any tenant whose lease term matches the specified status. If no status is specified tenants with any lease terms status will be returned.



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

def lease_term_statuses
  @lease_term_statuses
end

#name ⇒ Object

Filters results to any tenant whose name contains the specified value.



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

def name
  @name
end

#phone ⇒ Object

Filters results to any tenant whose phone number contains the specified value.



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

def phone
  @phone
end

#property_ids ⇒ Object

Filters results to tenants whose rental unit belongs to the specified set of property ids.



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

def property_ids
  @property_ids
end

#rental_owner_ids ⇒ Object

Filters results to tenants whose rental unit belongs to a property with a rental owner in the specified set of rental owner ids.



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

def rental_owner_ids
  @rental_owner_ids
end

#unit_number ⇒ Object

Filters results to any tenant whose unit number contains the specified value.



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

def unit_number
  @unit_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'building_statuses' => :'BuildingStatuses',
    :'lease_term_statuses' => :'LeaseTermStatuses',
    :'unit_number' => :'UnitNumber',
    :'name' => :'Name',
    :'phone' => :'Phone',
    :'email' => :'Email',
    :'property_ids' => :'PropertyIds',
    :'rental_owner_ids' => :'RentalOwnerIds',
    :'last_updated_from' => :'LastUpdatedFrom',
    :'last_updated_to' => :'LastUpdatedTo'
  }
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



223
224
225
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 223

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'building_statuses' => :'Array<String>',
    :'lease_term_statuses' => :'Array<String>',
    :'unit_number' => :'String',
    :'name' => :'String',
    :'phone' => :'String',
    :'email' => :'String',
    :'property_ids' => :'Array<Integer>',
    :'rental_owner_ids' => :'Array<Integer>',
    :'last_updated_from' => :'Time',
    :'last_updated_to' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      building_statuses == o.building_statuses &&
      lease_term_statuses == o.lease_term_statuses &&
      unit_number == o.unit_number &&
      name == o.name &&
      phone == o.phone &&
      email == o.email &&
      property_ids == o.property_ids &&
      rental_owner_ids == o.rental_owner_ids &&
      last_updated_from == o.last_updated_from &&
      last_updated_to == o.last_updated_to
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 254

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



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

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 230

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


210
211
212
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 216

def hash
  [building_statuses, lease_term_statuses, unit_number, name, phone, email, property_ids, rental_owner_ids, last_updated_from, last_updated_to].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



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

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



301
302
303
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 307

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



295
296
297
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 295

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



187
188
189
 
# File 'lib/buildium-ruby/models/tenant_search_message.rb', line 187

def valid?
  true
end