Class: PureCloud::CampaignProgressNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/campaign_progress_notification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignProgressNotification

Returns a new instance of CampaignProgressNotification.



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
87
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 60

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[:'campaign']
    self.campaign = attributes[:'campaign']
  end
  
  if attributes[:'numberOfContactsCalled']
    self.number_of_contacts_called = attributes[:'numberOfContactsCalled']
  end
  
  if attributes[:'totalNumberOfContacts']
    self.total_number_of_contacts = attributes[:'totalNumberOfContacts']
  end
  
  if attributes[:'percentage']
    self.percentage = attributes[:'percentage']
  end
  
  if attributes[:'additionalProperties']
    self.additional_properties = attributes[:'additionalProperties']
  end
  
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



29
30
31
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 29

def additional_properties
  @additional_properties
end

#campaign ⇒ Object

Returns the value of attribute campaign.



21
22
23
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 21

def campaign
  @campaign
end

#number_of_contacts_called ⇒ Object

Returns the value of attribute number_of_contacts_called.



23
24
25
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 23

def number_of_contacts_called
  @number_of_contacts_called
end

#percentage ⇒ Object

Returns the value of attribute percentage.



27
28
29
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 27

def percentage
  @percentage
end

#total_number_of_contacts ⇒ Object

Returns the value of attribute total_number_of_contacts.



25
26
27
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 25

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.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 32

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

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 49

def self.swagger_types
  {
    :'campaign' => :'DocumentDataNotificationCreatedBy',
    :'number_of_contacts_called' => :'Float',
    :'total_number_of_contacts' => :'Float',
    :'percentage' => :'Integer',
    :'additional_properties' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



90
91
92
93
94
95
96
97
98
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 90

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

#_deserialize(type, value) ⇒ Object 



130
131
132
133
134
135
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
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 130

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



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 190

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 111

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

Returns:

  • (Boolean)

See Also:

  • `==` method


101
102
103
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 101

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



106
107
108
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 106

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



173
174
175
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 173

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



178
179
180
181
182
183
184
185
186
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 178

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 



168
169
170
 
# File 'lib/purecloud/models/campaign_progress_notification.rb', line 168

def to_s
  to_hash.to_s
end