Class: PureCloud::CampaignStats

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 79

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

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

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

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

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

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

  
end

Instance Attribute Details

#adjusted_calls_per_agent ⇒ Object

Calls per agent adjusted by pace



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

def adjusted_calls_per_agent
  @adjusted_calls_per_agent
end

#contact_rate ⇒ Object

Information regarding the campaign’s connect rate



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

def contact_rate
  @contact_rate
end

#effective_idle_agents ⇒ Object

Number of effective available agents not currently being utilized



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

def effective_idle_agents
  @effective_idle_agents
end

#idle_agents ⇒ Object

Number of available agents not currently being utilized



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

def idle_agents
  @idle_agents
end

#outstanding_calls ⇒ Object

Number of campaign calls currently ongoing



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

def outstanding_calls
  @outstanding_calls
end

#scheduled_calls ⇒ Object

Number of campaign calls currently scheduled



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

def scheduled_calls
  @scheduled_calls
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudclient_v2a/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

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudclient_v2a/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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 214

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 257

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 317

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 238

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


227
228
229
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 233

def hash
  [contact_rate, idle_agents, effective_idle_agents, adjusted_calls_per_agent, outstanding_calls, scheduled_calls].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



144
145
146
147
148
149
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 144

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



300
301
302
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 300

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



305
306
307
308
309
310
311
312
313
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 305

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 



295
296
297
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 295

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



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
 
# File 'lib/purecloudclient_v2a/models/campaign_stats.rb', line 153

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end