Class: BombBomb::JerichoPerformance
- Inherits:
-
Object
- Object
- BombBomb::JerichoPerformance
- Defined in:
- lib/bombbomb/models/jericho_performance.rb
Overview
Reports on the aggregate performance of a Jericho send
Instance Attribute Summary collapse
-
#abuse_complaints ⇒ Object
The number of recipients that marked the message as abusive.
-
#bounce ⇒ Object
The number of emails that bounced as undeliverable.
-
#click ⇒ Object
The total number of times links in the emails were clicked.
-
#contacts ⇒ Object
The total number of contacts submitted to be sent, may be more than was sent to.
-
#delivered ⇒ Object
The number of emails delivered, likely less than sent due to bounces, and other common delivery issues.
-
#landing_page_views ⇒ Object
The total number of people that visisted the landing page.
-
#open ⇒ Object
The total number of times the emails were viewed.
-
#sent ⇒ Object
The number of emails sent.
-
#unique_landing_page_views ⇒ Object
The unique number of people that visited the landing page.
-
#unique_views ⇒ Object
The unique number of people that viewed the email.
-
#video_play ⇒ Object
The total number of times videos in the emails were played.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ JerichoPerformance
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ JerichoPerformance
Initializes the object
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 141 142 143 144 145 146 147 148 149 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 99 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?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'uniqueViews') self.unique_views = attributes[:'uniqueViews'] end if attributes.has_key?(:'uniqueLandingPageViews') self.unique_landing_page_views = attributes[:'uniqueLandingPageViews'] end if attributes.has_key?(:'landingPageViews') self.landing_page_views = attributes[:'landingPageViews'] end if attributes.has_key?(:'delivered') self.delivered = attributes[:'delivered'] end if attributes.has_key?(:'bounce') self.bounce = attributes[:'bounce'] end if attributes.has_key?(:'open') self.open = attributes[:'open'] end if attributes.has_key?(:'click') self.click = attributes[:'click'] end if attributes.has_key?(:'videoPlay') self.video_play = attributes[:'videoPlay'] end if attributes.has_key?(:'abuseComplaints') self.abuse_complaints = attributes[:'abuseComplaints'] end if attributes.has_key?(:'contacts') self.contacts = attributes[:'contacts'] end end |
Instance Attribute Details
#abuse_complaints ⇒ Object
The number of recipients that marked the message as abusive
57 58 59 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 57 def abuse_complaints @abuse_complaints end |
#bounce ⇒ Object
The number of emails that bounced as undeliverable
45 46 47 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 45 def bounce @bounce end |
#click ⇒ Object
The total number of times links in the emails were clicked
51 52 53 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 51 def click @click end |
#contacts ⇒ Object
The total number of contacts submitted to be sent, may be more than was sent to
60 61 62 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 60 def contacts @contacts end |
#delivered ⇒ Object
The number of emails delivered, likely less than sent due to bounces, and other common delivery issues
42 43 44 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 42 def delivered @delivered end |
#landing_page_views ⇒ Object
The total number of people that visisted the landing page
39 40 41 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 39 def landing_page_views @landing_page_views end |
#open ⇒ Object
The total number of times the emails were viewed
48 49 50 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 48 def open @open end |
#sent ⇒ Object
The number of emails sent
30 31 32 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 30 def sent @sent end |
#unique_landing_page_views ⇒ Object
The unique number of people that visited the landing page
36 37 38 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 36 def unique_landing_page_views @unique_landing_page_views end |
#unique_views ⇒ Object
The unique number of people that viewed the email
33 34 35 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 33 def unique_views @unique_views end |
#video_play ⇒ Object
The total number of times videos in the emails were played
54 55 56 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 54 def video_play @video_play end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 64 def self.attribute_map { :'sent' => :'sent', :'unique_views' => :'uniqueViews', :'unique_landing_page_views' => :'uniqueLandingPageViews', :'landing_page_views' => :'landingPageViews', :'delivered' => :'delivered', :'bounce' => :'bounce', :'open' => :'open', :'click' => :'click', :'video_play' => :'videoPlay', :'abuse_complaints' => :'abuseComplaints', :'contacts' => :'contacts' } end |
.swagger_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 81 def self.swagger_types { :'sent' => :'Integer', :'unique_views' => :'Integer', :'unique_landing_page_views' => :'Integer', :'landing_page_views' => :'Integer', :'delivered' => :'Integer', :'bounce' => :'Integer', :'open' => :'Integer', :'click' => :'Integer', :'video_play' => :'Integer', :'abuse_complaints' => :'Integer', :'contacts' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 166 def ==(o) return true if self.equal?(o) self.class == o.class && sent == o.sent && unique_views == o.unique_views && unique_landing_page_views == o.unique_landing_page_views && landing_page_views == o.landing_page_views && delivered == o.delivered && bounce == o.bounce && open == o.open && click == o.click && video_play == o.video_play && abuse_complaints == o.abuse_complaints && contacts == o.contacts end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 218 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 temp_model = BombBomb.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 284 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
Builds the object from hash
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 197 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 # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
184 185 186 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 184 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
190 191 192 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 190 def hash [sent, unique_views, unique_landing_page_views, landing_page_views, delivered, bounce, open, click, video_play, abuse_complaints, contacts].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
153 154 155 156 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 153 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
264 265 266 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 264 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
270 271 272 273 274 275 276 277 278 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 270 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 ⇒ String
Returns the string representation of the object
258 259 260 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 258 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
160 161 162 |
# File 'lib/bombbomb/models/jericho_performance.rb', line 160 def valid? return true end |