Class: PureCloud::Condition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Condition

Initializes the object



70
71
72
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
98
99
100
101
102
103
104
105
106
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 70

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

end

Instance Attribute Details

#attribute_name ⇒ Object

An attribute name associated with the condition (applies only to certain rule conditions)



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

def attribute_name
  @attribute_name
end

#codes ⇒ Object

List of wrap-up code identifiers (used only in conditions of type ‘wrapupCondition’)



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

def codes
  @codes
end

#inverted ⇒ Object

Indicates whether to evaluate for the opposite of the stated condition; default is false



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

def inverted
  @inverted
end

#operator ⇒ Object

An operation type for condition evaluation



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

def operator
  @operator
end

#type ⇒ Object

The type of the condition



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

def type
  @type
end

#value ⇒ Object

A value associated with the condition



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

def value
  @value
end

#value_type ⇒ Object

Determines the type of the value associated with the condition



34
35
36
 
# File 'lib/purecloudplatformclientv2/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.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 43

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

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 56

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 164

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
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 208

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 268

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 189

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

See Also:

  • `==` method


178
179
180
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



184
185
186
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 184

def hash
  [type, inverted, attribute_name, value, value_type, operator, codes].hash
end

#list_invalid_properties ⇒ Object

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



110
111
112
113
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 110

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



251
252
253
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 251

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 256

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 



246
247
248
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 246

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/purecloudplatformclientv2/models/condition.rb', line 117

def valid?
  allowed_values = ["wrapupCondition", "contactAttributeCondition", "phoneNumberCondition", "phoneNumberTypeCondition", "callAnalysisCondition"]
  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"]
  if @operator && !allowed_values.include?(@operator)
    return false
  end
end