Class: PureCloud::CampaignDiagnostics

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignDiagnostics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 55

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

  if attributes.has_key?(:'queueUtilizationDiagnostic')
    self.queue_utilization_diagnostic = attributes[:'queueUtilizationDiagnostic']
  end

  if attributes.has_key?(:'ruleSetDiagnostics')
    if (value = attributes[:'ruleSetDiagnostics']).is_a?(Array)
      self.rule_set_diagnostics = value
    end
  end

  if attributes.has_key?(:'outstandingInteractionsCount')
    self.outstanding_interactions_count = attributes[:'outstandingInteractionsCount']
  end

end

Instance Attribute Details

#callable_contacts ⇒ Object

Campaign properties that can impact which contacts are callable



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

def callable_contacts
  @callable_contacts
end

#outstanding_interactions_count ⇒ Object

Current number of outstanding interactions on the campaign



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

def outstanding_interactions_count
  @outstanding_interactions_count
end

#queue_utilization_diagnostic ⇒ Object

Information regarding the campaign’s queue



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

def queue_utilization_diagnostic
  @queue_utilization_diagnostic
end

#rule_set_diagnostics ⇒ Object

Information regarding the campaign’s rule sets



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

def rule_set_diagnostics
  @rule_set_diagnostics
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 34

def self.attribute_map
  {
    :'callable_contacts' => :'callableContacts',
    :'queue_utilization_diagnostic' => :'queueUtilizationDiagnostic',
    :'rule_set_diagnostics' => :'ruleSetDiagnostics',
    :'outstanding_interactions_count' => :'outstandingInteractionsCount'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 44

def self.swagger_types
  {
    :'callable_contacts' => :'CallableContactsDiagnostic',
    :'queue_utilization_diagnostic' => :'QueueUtilizationDiagnostic',
    :'rule_set_diagnostics' => :'Array<RuleSetDiagnostic>',
    :'outstanding_interactions_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
101
102
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 95

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      callable_contacts == o.callable_contacts &&
      queue_utilization_diagnostic == o.queue_utilization_diagnostic &&
      rule_set_diagnostics == o.rule_set_diagnostics &&
      outstanding_interactions_count == o.outstanding_interactions_count
end

#_deserialize(type, value) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 136

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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 196

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



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

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


106
107
108
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 106

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 112

def hash
  [callable_contacts, queue_utilization_diagnostic, rule_set_diagnostics, outstanding_interactions_count].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



83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 83

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



179
180
181
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 179

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 184

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 



174
175
176
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 174

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



90
91
 
# File 'lib/purecloudplatformclientv2/models/campaign_diagnostics.rb', line 90

def valid?
end