Class: PureCloud::Condition

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/condition.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Condition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
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
189
190
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 100

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?(:'type')
    
    
    self.type = attributes[:'type']
    
  
  end

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#attribute_name ⇒ Object

An attribute name associated with this Condition. Required for a contactAttributeCondition.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 28

def attribute_name
  @attribute_name
end

#codes ⇒ Object

List of wrap-up code identifiers. Required for a wrapupCondition.



40
41
42
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 40

def codes
  @codes
end

#inverted ⇒ Object

If true, inverts the result of evaluating this Condition. Default is false.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 25

def inverted
  @inverted
end

#operator ⇒ Object

An operation with which to evaluate the Condition.



37
38
39
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 37

def operator
  @operator
end

#property ⇒ Object

A value associated with the property type of this Condition. Required for a contactPropertyCondition.



43
44
45
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 43

def property
  @property
end

#property_type ⇒ Object

The type of the property associated with this Condition.



46
47
48
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 46

def property_type
  @property_type
end

#type ⇒ Object

The type of the condition.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 22

def type
  @type
end

#value ⇒ Object

A value associated with this Condition. 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).



31
32
33
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 31

def value
  @value
end

#value_type ⇒ Object

The type of the value associated with this Condition.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 34

def value_type
  @value_type
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 49

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'inverted' => :'inverted',
    
    :'attribute_name' => :'attributeName',
    
    :'value' => :'value',
    
    :'value_type' => :'valueType',
    
    :'operator' => :'operator',
    
    :'codes' => :'codes',
    
    :'property' => :'property',
    
    :'property_type' => :'propertyType'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 74

def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'inverted' => :'BOOLEAN',
    
    :'attribute_name' => :'String',
    
    :'value' => :'String',
    
    :'value_type' => :'String',
    
    :'operator' => :'String',
    
    :'codes' => :'Array<String>',
    
    :'property' => :'String',
    
    :'property_type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      inverted == o.inverted &&
      attribute_name == o.attribute_name &&
      value == o.value &&
      value_type == o.value_type &&
      operator == o.operator &&
      codes == o.codes &&
      property == o.property &&
      property_type == o.property_type
end

#_deserialize(type, value) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 393

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 453

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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 374

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


363
364
365
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 363

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



369
370
371
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 369

def hash
  [type, inverted, attribute_name, value, value_type, operator, codes, property, property_type].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



194
195
196
197
198
199
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 194

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))



436
437
438
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 436

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



441
442
443
444
445
446
447
448
449
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 441

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 



431
432
433
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 431

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



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloudclient_v2a/models/condition.rb', line 203

def valid?
  
  
  
  allowed_values = ["wrapupCondition", "contactAttributeCondition", "phoneNumberCondition", "phoneNumberTypeCondition", "callAnalysisCondition", "contactPropertyCondition"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["STRING", "NUMERIC", "DATETIME", "PERIOD"]
  if @value_type && !allowed_values.include?(@value_type)
    return false
  end
  
  
  
  
  
  allowed_values = ["EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "IN"]
  if @operator && !allowed_values.include?(@operator)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["LAST_ATTEMPT_BY_COLUMN", "LAST_ATTEMPT_OVERALL", "LAST_WRAPUP_BY_COLUMN", "LAST_WRAPUP_OVERALL"]
  if @property_type && !allowed_values.include?(@property_type)
    return false
  end
  
  
  
end