Class: PureCloud::ContactListFilterPredicate

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContactListFilterPredicate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
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
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 78

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

  
  if attributes.has_key?(:'columnType')
    
    
    self.column_type = attributes[:'columnType']
    
  
  end

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

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

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

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

  
end

Instance Attribute Details

#column ⇒ Object

Contact List column that must match a contact list column in the ContactListFilter’s contactList object



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 22

def column
  @column
end

#column_type ⇒ Object

Whether the contact column contains numeric or alphabetic data



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 25

def column_type
  @column_type
end

#inverted ⇒ Object

Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false).



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 36

def inverted
  @inverted
end

#operator ⇒ Object

Returns the value of attribute operator.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 27

def operator
  @operator
end

#range ⇒ Object

Range is only required for ContactListFilterComparisonOperator’s BETWEEN and IN



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 33

def range
  @range
end

#value ⇒ Object

Contact List value to operate on. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes).



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 30

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 39

def self.attribute_map
  {
    
    :'column' => :'column',
    
    :'column_type' => :'columnType',
    
    :'operator' => :'operator',
    
    :'value' => :'value',
    
    :'range' => :'range',
    
    :'inverted' => :'inverted'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 58

def self.swagger_types
  {
    
    :'column' => :'String',
    
    :'column_type' => :'String',
    
    :'operator' => :'String',
    
    :'value' => :'String',
    
    :'range' => :'ContactListFilterRange',
    
    :'inverted' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      column == o.column &&
      column_type == o.column_type &&
      operator == o.operator &&
      value == o.value &&
      range == o.range &&
      inverted == o.inverted
end

#_deserialize(type, value) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 284

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 344

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

build the object from hash



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 260

def hash
  [column, column_type, operator, value, range, inverted].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



143
144
145
146
147
148
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 143

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



327
328
329
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 327

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



332
333
334
335
336
337
338
339
340
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 332

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



322
323
324
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 322

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb', line 152

def valid?
  
  
  
  
  
  
  
  allowed_values = ["numeric", "alphabetic"]
  if @column_type && !allowed_values.include?(@column_type)
    return false
  end
  
  
  
  
  
  allowed_values = ["EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "IN"]
  if @operator && !allowed_values.include?(@operator)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end