class PureCloud::CampaignStats

Attributes

adjusted_calls_per_agent[RW]

Calls per agent adjusted by pace

contact_rate[RW]

Information regarding the campaign's connect rate

effective_idle_agents[RW]

Number of effective available agents not currently being utilized

idle_agents[RW]

Number of available agents not currently being utilized

outstanding_calls[RW]

Number of campaign calls currently ongoing

scheduled_calls[RW]

Number of campaign calls currently scheduled

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/campaign_stats.rb, line 40
def self.attribute_map
  {
    
    :'contact_rate' => :'contactRate',
    
    :'idle_agents' => :'idleAgents',
    
    :'effective_idle_agents' => :'effectiveIdleAgents',
    
    :'adjusted_calls_per_agent' => :'adjustedCallsPerAgent',
    
    :'outstanding_calls' => :'outstandingCalls',
    
    :'scheduled_calls' => :'scheduledCalls'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/campaign_stats.rb, line 71
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  
  if attributes[:'contactRate']
    self.contact_rate = attributes[:'contactRate']
  end
  
  if attributes[:'idleAgents']
    self.idle_agents = attributes[:'idleAgents']
  end
  
  if attributes[:'effectiveIdleAgents']
    self.effective_idle_agents = attributes[:'effectiveIdleAgents']
  end
  
  if attributes[:'adjustedCallsPerAgent']
    self.adjusted_calls_per_agent = attributes[:'adjustedCallsPerAgent']
  end
  
  if attributes[:'outstandingCalls']
    self.outstanding_calls = attributes[:'outstandingCalls']
  end
  
  if attributes[:'scheduledCalls']
    self.scheduled_calls = attributes[:'scheduledCalls']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/campaign_stats.rb, line 59
def self.swagger_types
  {
    :'contact_rate' => :'ConnectRate',
    :'idle_agents' => :'Integer',
    :'effective_idle_agents' => :'Float',
    :'adjusted_calls_per_agent' => :'Float',
    :'outstanding_calls' => :'Integer',
    :'scheduled_calls' => :'Integer'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/campaign_stats.rb, line 105
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_rate == o.contact_rate &&
      idle_agents == o.idle_agents &&
      effective_idle_agents == o.effective_idle_agents &&
      adjusted_calls_per_agent == o.adjusted_calls_per_agent &&
      outstanding_calls == o.outstanding_calls &&
      scheduled_calls == o.scheduled_calls
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/campaign_stats.rb, line 146
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/purecloud/models/campaign_stats.rb, line 206
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/purecloud/models/campaign_stats.rb, line 127
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

# File lib/purecloud/models/campaign_stats.rb, line 117
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/campaign_stats.rb, line 122
def hash
  [contact_rate, idle_agents, effective_idle_agents, adjusted_calls_per_agent, outstanding_calls, scheduled_calls].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/campaign_stats.rb, line 189
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/campaign_stats.rb, line 194
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/purecloud/models/campaign_stats.rb, line 184
def to_s
  to_hash.to_s
end