Class: Hubspot::Crm::Contacts::Filter

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/contacts/models/filter.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Filter

Initializes the object

Parameters:

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

    Model attributes in the form of hash


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 73

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

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

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

Instance Attribute Details

#operatorObject

Returns the value of attribute operator


23
24
25
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 23

def operator
  @operator
end

#property_nameObject

Returns the value of attribute property_name


21
22
23
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 21

def property_name
  @property_name
end

#valueObject

Returns the value of attribute value


19
20
21
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 19

def value
  @value
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 48

def self.attribute_map
  {
    :'value' => :'value',
    :'property_name' => :'propertyName',
    :'operator' => :'operator'
  }
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


159
160
161
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 159

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

.openapi_nullableObject

List of attributes with nullable: true


66
67
68
69
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 66

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

.openapi_typesObject

Attribute type mapping.


57
58
59
60
61
62
63
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 57

def self.openapi_types
  {
    :'value' => :'String',
    :'property_name' => :'String',
    :'operator' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


136
137
138
139
140
141
142
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      value == o.value &&
      property_name == o.property_name &&
      operator == o.operator
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


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 187

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Hubspot::Crm::Contacts.const_get(type).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


256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 256

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


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 166

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

146
147
148
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 146

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


152
153
154
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 152

def hash
  [value, property_name, operator].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  if @property_name.nil?
    invalid_properties.push('invalid value for "property_name", property_name cannot be nil.')
  end

  if @operator.nil?
    invalid_properties.push('invalid value for "operator", operator cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


232
233
234
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 232

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 238

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


226
227
228
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 226

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


116
117
118
119
120
121
122
# File 'lib/hubspot/codegen/crm/contacts/models/filter.rb', line 116

def valid?
  return false if @property_name.nil?
  return false if @operator.nil?
  operator_validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
  return false unless operator_validator.valid?(@operator)
  true
end