Class: Buildium::ApplicantSearchMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicantSearchMessage

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
 
# File 'lib/buildium-ruby/models/applicant_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::ApplicantSearchMessage` 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::ApplicantSearchMessage`. 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?(:'entity_id')
    self.entity_id = attributes[:'entity_id']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#application_statuses ⇒ Object

Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned.



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

def application_statuses
  @application_statuses
end

#application_submitted_end_date ⇒ Object

Filters results to any applicant who submitted an application on or prior to the date specified.



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

def application_submitted_end_date
  @application_submitted_end_date
end

#application_submitted_start_date ⇒ Object

Filters results to any applicant who submitted an application on or after the date specified.



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

def application_submitted_start_date
  @application_submitted_start_date
end

#email ⇒ Object

Filters results to applicants whose email contains the specified value



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

def email
  @email
end

#entity_id ⇒ Object

Filters results to any applicant associated with the specified entity identifier. This filter is used in conjunction with the ‘EntityType` field which must be set to the type of entity this identifier references.



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

def entity_id
  @entity_id
end

#entity_type ⇒ Object

Specifies the type of entity that ‘EntityId` refers to. This field is required if `EntityId` is specified.



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

def entity_type
  @entity_type
end

#name ⇒ Object

Filters results to applicants whose name contains the specified value.



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

def name
  @name
end

#unit_ids ⇒ Object

Filters results to applicants associated to any of the specified rental property unit identifiers.



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

def unit_ids
  @unit_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/buildium-ruby/models/applicant_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/applicant_search_message.rb', line 65

def self.attribute_map
  {
    :'entity_id' => :'EntityId',
    :'entity_type' => :'EntityType',
    :'application_statuses' => :'ApplicationStatuses',
    :'unit_ids' => :'UnitIds',
    :'name' => :'Name',
    :'email' => :'Email',
    :'application_submitted_start_date' => :'ApplicationSubmittedStartDate',
    :'application_submitted_end_date' => :'ApplicationSubmittedEndDate'
  }
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



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

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/applicant_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/applicant_search_message.rb', line 84

def self.openapi_types
  {
    :'entity_id' => :'Integer',
    :'entity_type' => :'String',
    :'application_statuses' => :'Array<String>',
    :'unit_ids' => :'Array<Integer>',
    :'name' => :'String',
    :'email' => :'String',
    :'application_submitted_start_date' => :'Time',
    :'application_submitted_end_date' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_id == o.entity_id &&
      entity_type == o.entity_type &&
      application_statuses == o.application_statuses &&
      unit_ids == o.unit_ids &&
      name == o.name &&
      email == o.email &&
      application_submitted_start_date == o.application_submitted_start_date &&
      application_submitted_end_date == o.application_submitted_end_date
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



241
242
243
244
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
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 241

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 312

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 217

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


197
198
199
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 203

def hash
  [entity_id, entity_type, application_statuses, unit_ids, name, email, application_submitted_start_date, application_submitted_end_date].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



157
158
159
160
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 157

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



288
289
290
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 294

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



282
283
284
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 282

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



164
165
166
167
168
 
# File 'lib/buildium-ruby/models/applicant_search_message.rb', line 164

def valid?
  entity_type_validator = EnumAttributeValidator.new('String', ["Rental", "RentalOwner"])
  return false unless entity_type_validator.valid?(@entity_type)
  true
end