class PureCloud::ConversationProperties

Attributes

filter_wrap_up_notes[RW]

Indicates filtering for WrapUpNotes

is_acd[RW]

Indicates filtering for Acd

is_active[RW]

Indicates filtering for active

is_cobrowse[RW]

Indicates filtering for Cobrowse

is_flagged[RW]

Indicates filtering for flagged

is_monitored[RW]

Indicates filtering for monitored

is_preferred[RW]

Indicates filtering for Preferred Agent Routing

is_screenshare[RW]

Indicates filtering for screenshare

is_voicemail[RW]

Indicates filtering for Voice mail

is_waiting[RW]

Indicates filtering for waiting

match_all[RW]

Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/conversation_properties.rb, line 55
def self.attribute_map
  {
    
    :'is_waiting' => :'isWaiting',
    
    :'is_active' => :'isActive',
    
    :'is_acd' => :'isAcd',
    
    :'is_preferred' => :'isPreferred',
    
    :'is_screenshare' => :'isScreenshare',
    
    :'is_cobrowse' => :'isCobrowse',
    
    :'is_voicemail' => :'isVoicemail',
    
    :'is_flagged' => :'isFlagged',
    
    :'is_monitored' => :'isMonitored',
    
    :'filter_wrap_up_notes' => :'filterWrapUpNotes',
    
    :'match_all' => :'matchAll'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/conversation_properties.rb, line 114
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?(:'isWaiting')
    
    
    self.is_waiting = attributes[:'isWaiting']
    
  
  end

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/conversation_properties.rb, line 84
def self.swagger_types
  {
    
    :'is_waiting' => :'BOOLEAN',
    
    :'is_active' => :'BOOLEAN',
    
    :'is_acd' => :'BOOLEAN',
    
    :'is_preferred' => :'BOOLEAN',
    
    :'is_screenshare' => :'BOOLEAN',
    
    :'is_cobrowse' => :'BOOLEAN',
    
    :'is_voicemail' => :'BOOLEAN',
    
    :'is_flagged' => :'BOOLEAN',
    
    :'is_monitored' => :'BOOLEAN',
    
    :'filter_wrap_up_notes' => :'BOOLEAN',
    
    :'match_all' => :'BOOLEAN'
    
  }
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/conversation_properties.rb, line 339
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_waiting == o.is_waiting &&
      is_active == o.is_active &&
      is_acd == o.is_acd &&
      is_preferred == o.is_preferred &&
      is_screenshare == o.is_screenshare &&
      is_cobrowse == o.is_cobrowse &&
      is_voicemail == o.is_voicemail &&
      is_flagged == o.is_flagged &&
      is_monitored == o.is_monitored &&
      filter_wrap_up_notes == o.filter_wrap_up_notes &&
      match_all == o.match_all
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/conversation_properties.rb, line 387
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/conversation_properties.rb, line 447
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/conversation_properties.rb, line 368
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/conversation_properties.rb, line 357
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/conversation_properties.rb, line 363
def hash
  [is_waiting, is_active, is_acd, is_preferred, is_screenshare, is_cobrowse, is_voicemail, is_flagged, is_monitored, filter_wrap_up_notes, match_all].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/conversation_properties.rb, line 224
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/conversation_properties.rb, line 435
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/conversation_properties.rb, line 425
def to_s
  to_hash.to_s
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/conversation_properties.rb, line 233
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end