Class: Buildium::ClientLeadSearchMessage

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

Overview

This object represents a filter for a client lead search.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientLeadSearchMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 91

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

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

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

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

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

Instance Attribute Details

#date_received_from ⇒ Object

Filters results to any client leads that were received on or after the specified date. The value must be formatted as YYYY-MM-DD.



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

def date_received_from
  @date_received_from
end

#date_received_to ⇒ Object

Filters results to any client leads that were received on or before the specified date. The value must be formatted as YYYY-MM-DD.



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

def date_received_to
  @date_received_to
end

#include_credited_leads ⇒ Object

This will also return client leads that were credited. By default credited leads will not be returned.



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

def include_credited_leads
  @include_credited_leads
end

#lead_statuses ⇒ Object

Filters results to any client leads that are in one of the given statuses.



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

def lead_statuses
  @lead_statuses
end

#property_types ⇒ Object

Filters results to any client leads that have a property in one of the given property types.



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

def property_types
  @property_types
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 57

def self.attribute_map
  {
    :'lead_statuses' => :'LeadStatuses',
    :'property_types' => :'PropertyTypes',
    :'date_received_from' => :'DateReceivedFrom',
    :'date_received_to' => :'DateReceivedTo',
    :'include_credited_leads' => :'IncludeCreditedLeads'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 73

def self.openapi_types
  {
    :'lead_statuses' => :'Array<String>',
    :'property_types' => :'Array<String>',
    :'date_received_from' => :'Time',
    :'date_received_to' => :'Time',
    :'include_credited_leads' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      lead_statuses == o.lead_statuses &&
      property_types == o.property_types &&
      date_received_from == o.date_received_from &&
      date_received_to == o.date_received_to &&
      include_credited_leads == o.include_credited_leads
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 200

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 271

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 176

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


156
157
158
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [lead_statuses, property_types, date_received_from, date_received_to, include_credited_leads].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



131
132
133
134
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 131

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



247
248
249
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 247

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 253

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



241
242
243
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 241

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



138
139
140
 
# File 'lib/buildium-ruby/models/client_lead_search_message.rb', line 138

def valid?
  true
end