Class: Buildium::RentalSearchMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalSearchMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
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
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 105

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

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

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

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

#last_updated_from ⇒ Object

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



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

def last_updated_from
  @last_updated_from
end

#last_updated_to ⇒ Object

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



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

def last_updated_to
  @last_updated_to
end

#location ⇒ Object

Filters results to only rental properties whose city or state contains the specified value.



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

def location
  @location
end

#property_ids ⇒ Object

Filters results to only rental properties units whose Rental matches the specified Id.



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

def property_ids
  @property_ids
end

#rental_owner_ids ⇒ Object

Filters results to only rental properties whose RentalOwnerId matches the specified Id.



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

def rental_owner_ids
  @rental_owner_ids
end

#status ⇒ Object

Filters results by the status of the rental property. If no status is specified both ‘active` and `inactive` rental properties will be returned.



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

def status
  @status
end

#sub_types ⇒ Object

Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.



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

def sub_types
  @sub_types
end

#types ⇒ Object

Filters results by the rental type. If no type is provided all types will be returned.



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

def types
  @types
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 65

def self.attribute_map
  {
    :'location' => :'Location',
    :'types' => :'Types',
    :'sub_types' => :'SubTypes',
    :'status' => :'Status',
    :'rental_owner_ids' => :'RentalOwnerIds',
    :'property_ids' => :'PropertyIds',
    :'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



214
215
216
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 214

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 84

def self.openapi_types
  {
    :'location' => :'String',
    :'types' => :'Array<String>',
    :'sub_types' => :'Array<String>',
    :'status' => :'String',
    :'rental_owner_ids' => :'Array<Integer>',
    :'property_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



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location == o.location &&
      types == o.types &&
      sub_types == o.sub_types &&
      status == o.status &&
      rental_owner_ids == o.rental_owner_ids &&
      property_ids == o.property_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



245
246
247
248
249
250
251
252
253
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
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 245

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 316

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 221

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


201
202
203
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 207

def hash
  [location, types, sub_types, status, rental_owner_ids, property_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



161
162
163
164
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 161

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



292
293
294
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 298

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



286
287
288
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 286

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



168
169
170
171
172
 
# File 'lib/buildium-ruby/models/rental_search_message.rb', line 168

def valid?
  status_validator = EnumAttributeValidator.new('String', ["Active", "InActive"])
  return false unless status_validator.valid?(@status)
  true
end