Class: SendX::ReportData
- Inherits:
-
Object
- Object
- SendX::ReportData
- Defined in:
- lib/sendx-ruby-sdk/models/report_data.rb
Overview
Contains the report data for a given campaign
Instance Attribute Summary collapse
-
#bounce_contact_count ⇒ Object
The total number of bounced contacts.
-
#campaign_id ⇒ Object
The ID of the campaign.
-
#clicked_contact_count ⇒ Object
The total number of contacts that clicked on any link.
-
#clicked_unique_contact_count ⇒ Object
The unique number of contacts that clicked on any link.
-
#currency ⇒ Object
The currency in which the revenue is measured.
-
#email_revenue ⇒ Object
The total revenue generated from the campaign email.
-
#link_stats ⇒ Object
Statistics about the links clicked within the campaign.
-
#opened_contact_count ⇒ Object
The total number of contacts that opened the campaign email.
-
#opened_unique_contact_count ⇒ Object
The unique number of contacts that opened the campaign email.
-
#replied_contact_count ⇒ Object
The total number of contacts that replied to the campaign email.
-
#replied_unique_contact_count ⇒ Object
The unique number of contacts that replied to the campaign email.
-
#revenue_per_recipient ⇒ Object
The average revenue generated per recipient.
-
#sent_contact_count ⇒ Object
The total number of contacts the campaign was sent to.
-
#spam_contact_count ⇒ Object
The total number of contacts that marked the email as spam.
-
#unsubscribe_contact_count ⇒ Object
The total number of contacts that unsubscribed.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ReportData
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 = {}) ⇒ ReportData
Initializes the object
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 150 151 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 189 190 191 192 193 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 119 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SendX::ReportData` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `SendX::ReportData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'link_stats') if (value = attributes[:'link_stats']).is_a?(Hash) self.link_stats = value end end if attributes.key?(:'clicked_contact_count') self.clicked_contact_count = attributes[:'clicked_contact_count'] end if attributes.key?(:'opened_contact_count') self.opened_contact_count = attributes[:'opened_contact_count'] end if attributes.key?(:'replied_contact_count') self.replied_contact_count = attributes[:'replied_contact_count'] end if attributes.key?(:'clicked_unique_contact_count') self.clicked_unique_contact_count = attributes[:'clicked_unique_contact_count'] end if attributes.key?(:'opened_unique_contact_count') self.opened_unique_contact_count = attributes[:'opened_unique_contact_count'] end if attributes.key?(:'replied_unique_contact_count') self.replied_unique_contact_count = attributes[:'replied_unique_contact_count'] end if attributes.key?(:'sent_contact_count') self.sent_contact_count = attributes[:'sent_contact_count'] end if attributes.key?(:'unsubscribe_contact_count') self.unsubscribe_contact_count = attributes[:'unsubscribe_contact_count'] end if attributes.key?(:'bounce_contact_count') self.bounce_contact_count = attributes[:'bounce_contact_count'] end if attributes.key?(:'spam_contact_count') self.spam_contact_count = attributes[:'spam_contact_count'] end if attributes.key?(:'email_revenue') self.email_revenue = attributes[:'email_revenue'] end if attributes.key?(:'revenue_per_recipient') self.revenue_per_recipient = attributes[:'revenue_per_recipient'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end end |
Instance Attribute Details
#bounce_contact_count ⇒ Object
The total number of bounced contacts
50 51 52 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 50 def bounce_contact_count @bounce_contact_count end |
#campaign_id ⇒ Object
The ID of the campaign
20 21 22 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 20 def campaign_id @campaign_id end |
#clicked_contact_count ⇒ Object
The total number of contacts that clicked on any link
26 27 28 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 26 def clicked_contact_count @clicked_contact_count end |
#clicked_unique_contact_count ⇒ Object
The unique number of contacts that clicked on any link
35 36 37 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 35 def clicked_unique_contact_count @clicked_unique_contact_count end |
#currency ⇒ Object
The currency in which the revenue is measured
62 63 64 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 62 def currency @currency end |
#email_revenue ⇒ Object
The total revenue generated from the campaign email
56 57 58 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 56 def email_revenue @email_revenue end |
#link_stats ⇒ Object
Statistics about the links clicked within the campaign
23 24 25 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 23 def link_stats @link_stats end |
#opened_contact_count ⇒ Object
The total number of contacts that opened the campaign email
29 30 31 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 29 def opened_contact_count @opened_contact_count end |
#opened_unique_contact_count ⇒ Object
The unique number of contacts that opened the campaign email
38 39 40 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 38 def opened_unique_contact_count @opened_unique_contact_count end |
#replied_contact_count ⇒ Object
The total number of contacts that replied to the campaign email
32 33 34 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 32 def replied_contact_count @replied_contact_count end |
#replied_unique_contact_count ⇒ Object
The unique number of contacts that replied to the campaign email
41 42 43 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 41 def replied_unique_contact_count @replied_unique_contact_count end |
#revenue_per_recipient ⇒ Object
The average revenue generated per recipient
59 60 61 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 59 def revenue_per_recipient @revenue_per_recipient end |
#sent_contact_count ⇒ Object
The total number of contacts the campaign was sent to
44 45 46 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 44 def sent_contact_count @sent_contact_count end |
#spam_contact_count ⇒ Object
The total number of contacts that marked the email as spam
53 54 55 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 53 def spam_contact_count @spam_contact_count end |
#unsubscribe_contact_count ⇒ Object
The total number of contacts that unsubscribed
47 48 49 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 47 def unsubscribe_contact_count @unsubscribe_contact_count end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 271 def self._deserialize(type, value) case type.to_sym when :Time Time.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 =~ /\A(true|t|yes|y|1)\z/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 # models (e.g. Pet) or oneOf klass = SendX.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
86 87 88 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 86 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 65 def self.attribute_map { :'campaign_id' => :'campaignId', :'link_stats' => :'linkStats', :'clicked_contact_count' => :'clickedContactCount', :'opened_contact_count' => :'openedContactCount', :'replied_contact_count' => :'repliedContactCount', :'clicked_unique_contact_count' => :'clickedUniqueContactCount', :'opened_unique_contact_count' => :'openedUniqueContactCount', :'replied_unique_contact_count' => :'repliedUniqueContactCount', :'sent_contact_count' => :'sentContactCount', :'unsubscribe_contact_count' => :'unsubscribeContactCount', :'bounce_contact_count' => :'bounceContactCount', :'spam_contact_count' => :'spamContactCount', :'email_revenue' => :'emailRevenue', :'revenue_per_recipient' => :'revenuePerRecipient', :'currency' => :'currency' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 247 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
112 113 114 115 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 112 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 91 def self.openapi_types { :'campaign_id' => :'String', :'link_stats' => :'Hash<String, Integer>', :'clicked_contact_count' => :'Integer', :'opened_contact_count' => :'Integer', :'replied_contact_count' => :'Integer', :'clicked_unique_contact_count' => :'Integer', :'opened_unique_contact_count' => :'Integer', :'replied_unique_contact_count' => :'Integer', :'sent_contact_count' => :'Integer', :'unsubscribe_contact_count' => :'Integer', :'bounce_contact_count' => :'Integer', :'spam_contact_count' => :'Integer', :'email_revenue' => :'String', :'revenue_per_recipient' => :'String', :'currency' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 212 def ==(o) return true if self.equal?(o) self.class == o.class && campaign_id == o.campaign_id && link_stats == o.link_stats && clicked_contact_count == o.clicked_contact_count && opened_contact_count == o.opened_contact_count && replied_contact_count == o.replied_contact_count && clicked_unique_contact_count == o.clicked_unique_contact_count && opened_unique_contact_count == o.opened_unique_contact_count && replied_unique_contact_count == o.replied_unique_contact_count && sent_contact_count == o.sent_contact_count && unsubscribe_contact_count == o.unsubscribe_contact_count && bounce_contact_count == o.bounce_contact_count && spam_contact_count == o.spam_contact_count && email_revenue == o.email_revenue && revenue_per_recipient == o.revenue_per_recipient && currency == o.currency end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 342 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 |
#eql?(o) ⇒ Boolean
234 235 236 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 234 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
240 241 242 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 240 def hash [campaign_id, link_stats, clicked_contact_count, opened_contact_count, replied_contact_count, clicked_unique_contact_count, opened_unique_contact_count, replied_unique_contact_count, sent_contact_count, unsubscribe_contact_count, bounce_contact_count, spam_contact_count, email_revenue, revenue_per_recipient, currency].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
197 198 199 200 201 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 197 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
318 319 320 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 318 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 324 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
312 313 314 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 312 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
205 206 207 208 |
# File 'lib/sendx-ruby-sdk/models/report_data.rb', line 205 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |