class PureCloud::Condition

Attributes

attribute_name[RW]

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

codes[RW]

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

inverted[RW]

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

operator[RW]

An operation with which to evaluate the Condition. Not used for a DataActionCondition.

property[RW]

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

property_type[RW]

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

type[RW]

The type of the condition.

value[RW]

A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition.

value_type[RW]

The type of the value associated with this Condition. Not used for a DataActionCondition.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/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) click to toggle source
# File lib/purecloudplatformclientv2/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) click to toggle source

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

# File lib/purecloudplatformclientv2/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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/condition.rb, line 363
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/condition.rb, line 369
def hash
  [type, inverted, attribute_name, value, value_type, operator, codes, property, property_type].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/condition.rb, line 194
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
operator=(operator) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] operator Object to be assigned

# File lib/purecloudplatformclientv2/models/condition.rb, line 310
def operator=(operator)
  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)
    fail ArgumentError, "invalid value for 'operator', must be one of #{allowed_values}."
  end
  @operator = operator
end
property_type=(property_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] property_type Object to be assigned

# File lib/purecloudplatformclientv2/models/condition.rb, line 334
def property_type=(property_type)
  allowed_values = ["LAST_ATTEMPT_BY_COLUMN", "LAST_ATTEMPT_OVERALL", "LAST_WRAPUP_BY_COLUMN", "LAST_WRAPUP_OVERALL"]
  if property_type && !allowed_values.include?(property_type)
    fail ArgumentError, "invalid value for 'property_type', must be one of #{allowed_values}."
  end
  @property_type = property_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/condition.rb, line 436
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/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() click to toggle source
# File lib/purecloudplatformclientv2/models/condition.rb, line 431
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/purecloudplatformclientv2/models/condition.rb, line 267
def type=(type)
  allowed_values = ["wrapupCondition", "contactAttributeCondition", "phoneNumberCondition", "phoneNumberTypeCondition", "callAnalysisCondition", "contactPropertyCondition", "dataActionCondition"]
  if type && !allowed_values.include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/condition.rb, line 203
def valid?
  
  
  
  allowed_values = ["wrapupCondition", "contactAttributeCondition", "phoneNumberCondition", "phoneNumberTypeCondition", "callAnalysisCondition", "contactPropertyCondition", "dataActionCondition"]
  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
value_type=(value_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] value_type Object to be assigned

# File lib/purecloudplatformclientv2/models/condition.rb, line 296
def value_type=(value_type)
  allowed_values = ["STRING", "NUMERIC", "DATETIME", "PERIOD"]
  if value_type && !allowed_values.include?(value_type)
    fail ArgumentError, "invalid value for 'value_type', must be one of #{allowed_values}."
  end
  @value_type = value_type
end