Class: PureCloud::CampaignProgress

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignProgress

Initializes the object



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 60

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

  if attributes.has_key?(:'contactList')
    self.contact_list = attributes[:'contactList']
  end

  if attributes.has_key?(:'numberOfContactsCalled')
    self.number_of_contacts_called = attributes[:'numberOfContactsCalled']
  end

  if attributes.has_key?(:'totalNumberOfContacts')
    self.total_number_of_contacts = attributes[:'totalNumberOfContacts']
  end

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

end

Instance Attribute Details

#campaign ⇒ Object

Identifier of the campaign



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

def campaign
  @campaign
end

#contact_list ⇒ Object

Identifier of the contact list



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

def contact_list
  @contact_list
end

#number_of_contacts_called ⇒ Object

Number of contacts processed during the campaign



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

def number_of_contacts_called
  @number_of_contacts_called
end

#percentage ⇒ Object

Percentage of contacts processed during the campaign



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 34

def percentage
  @percentage
end

#total_number_of_contacts ⇒ Object

Total number of contacts in the campaign



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

def total_number_of_contacts
  @total_number_of_contacts
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 37

def self.attribute_map
  {
    :'campaign' => :'campaign',
    :'contact_list' => :'contactList',
    :'number_of_contacts_called' => :'numberOfContactsCalled',
    :'total_number_of_contacts' => :'totalNumberOfContacts',
    :'percentage' => :'percentage'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 48

def self.swagger_types
  {
    :'campaign' => :'UriReference',
    :'contact_list' => :'UriReference',
    :'number_of_contacts_called' => :'Integer',
    :'total_number_of_contacts' => :'Integer',
    :'percentage' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      campaign == o.campaign &&
      contact_list == o.contact_list &&
      number_of_contacts_called == o.number_of_contacts_called &&
      total_number_of_contacts == o.total_number_of_contacts &&
      percentage == o.percentage
end

#_deserialize(type, value) ⇒ Object 



152
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
180
181
182
183
184
185
186
187
188
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 152

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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 212

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 133

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

See Also:

  • `==` method


122
123
124
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 122

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



128
129
130
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 128

def hash
  [campaign, contact_list, number_of_contacts_called, total_number_of_contacts, percentage].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



90
91
92
93
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 90

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



195
196
197
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 195

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 200

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 



190
191
192
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 190

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/purecloudplatformclientv2/models/campaign_progress.rb', line 97

def valid?
  if @campaign.nil?
    return false
  end

  if @contact_list.nil?
    return false
  end

end