Class: OneSignal::FilterExpressions

Inherits:
Object
  • Object
show all
Defined in:
lib/onesignal/models/filter_expressions.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterExpressions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
 
# File 'lib/onesignal/models/filter_expressions.rb', line 98

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

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

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

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

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

Instance Attribute Details

#field ⇒ Object

Name of the field to use as the first operand in the filter expression.



19
20
21
 
# File 'lib/onesignal/models/filter_expressions.rb', line 19

def field
  @field
end

#key ⇒ Object

If ‘field` is `tag`, this field is required to specify `key` inside the tags.



22
23
24
 
# File 'lib/onesignal/models/filter_expressions.rb', line 22

def key
  @key
end

#operator ⇒ Object

Strictly, this must be either ‘"OR"`, or `"AND"`. It can be used to compose Filters as part of a Filters object.



31
32
33
 
# File 'lib/onesignal/models/filter_expressions.rb', line 31

def operator
  @operator
end

#relation ⇒ Object

Operator of a filter expression.



28
29
30
 
# File 'lib/onesignal/models/filter_expressions.rb', line 28

def relation
  @relation
end

#value ⇒ Object

Constant value to use as the second operand in the filter expression. This value is required when the relation operator is a binary operator.



25
26
27
 
# File 'lib/onesignal/models/filter_expressions.rb', line 25

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/onesignal/models/filter_expressions.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/onesignal/models/filter_expressions.rb', line 56

def self.attribute_map
  {
    :'field' => :'field',
    :'key' => :'key',
    :'value' => :'value',
    :'relation' => :'relation',
    :'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



218
219
220
 
# File 'lib/onesignal/models/filter_expressions.rb', line 218

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

.openapi_any_of ⇒ Object

List of class defined in anyOf (OpenAPI v3)



89
90
91
92
93
94
 
# File 'lib/onesignal/models/filter_expressions.rb', line 89

def self.openapi_any_of
  [
  :'Filter',
  :'Operator'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/onesignal/models/filter_expressions.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/onesignal/models/filter_expressions.rb', line 72

def self.openapi_types
  {
    :'field' => :'String',
    :'key' => :'String',
    :'value' => :'String',
    :'relation' => :'String',
    :'operator' => :'String'
  }
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
 
# File 'lib/onesignal/models/filter_expressions.rb', line 193

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



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
283
284
285
286
 
# File 'lib/onesignal/models/filter_expressions.rb', line 249

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 = OneSignal.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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/onesignal/models/filter_expressions.rb', line 320

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/onesignal/models/filter_expressions.rb', line 225

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


205
206
207
 
# File 'lib/onesignal/models/filter_expressions.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/onesignal/models/filter_expressions.rb', line 211

def hash
  [field, key, value, relation, operator].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



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/onesignal/models/filter_expressions.rb', line 134

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

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

  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



296
297
298
 
# File 'lib/onesignal/models/filter_expressions.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/onesignal/models/filter_expressions.rb', line 302

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



290
291
292
 
# File 'lib/onesignal/models/filter_expressions.rb', line 290

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/onesignal/models/filter_expressions.rb', line 149

def valid?
  return false if @field.nil?
  return false if @relation.nil?
  relation_validator = EnumAttributeValidator.new('String', [">", "<", "=", "!=", "exists", "not_exists", "time_elapsed_gt", "time_elapsed_lt"])
  return false unless relation_validator.valid?(@relation)
  operator_validator = EnumAttributeValidator.new('String', ["OR", "AND"])
  return false unless operator_validator.valid?(@operator)
  _any_of_found = false
  self.class.openapi_any_of.each do |_class|
    _any_of = OneSignal.const_get(_class).build_from_hash(self.to_hash)
    if _any_of.valid?
      _any_of_found = true
    end
  end

  if !_any_of_found
    return false
  end

  true
end