Class: ElasticEmail::ContactActivity
- Inherits:
-
Object
- Object
- ElasticEmail::ContactActivity
- Defined in:
- lib/ElasticEmail/models/contact_activity.rb
Instance Attribute Summary collapse
-
#error_code ⇒ Object
Last RFC Error code if any occurred.
-
#friendly_error_message ⇒ Object
Last RFC error message if any occurred.
-
#last_clicked ⇒ Object
Date this contact last clicked an email.
-
#last_failed ⇒ Object
Last date when an email sent to this contact bounced.
-
#last_ip ⇒ Object
IP from which this contact opened or clicked their email last time.
-
#last_opened ⇒ Object
Date this contact last opened an email.
-
#last_sent ⇒ Object
Last date when an email was sent to this contact.
-
#total_clicked ⇒ Object
Total emails clicked.
-
#total_failed ⇒ Object
Total emails failed.
-
#total_opened ⇒ Object
Total emails opened.
-
#total_sent ⇒ Object
Total emails sent.
Class Method Summary collapse
-
.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.
-
#_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 ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ContactActivity
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 = {}) ⇒ ContactActivity
Initializes the object
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 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 103 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::ContactActivity` 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 `ElasticEmail::ContactActivity`. 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?(:'total_sent') self.total_sent = attributes[:'total_sent'] end if attributes.key?(:'total_opened') self.total_opened = attributes[:'total_opened'] end if attributes.key?(:'total_clicked') self.total_clicked = attributes[:'total_clicked'] end if attributes.key?(:'total_failed') self.total_failed = attributes[:'total_failed'] end if attributes.key?(:'last_sent') self.last_sent = attributes[:'last_sent'] end if attributes.key?(:'last_opened') self.last_opened = attributes[:'last_opened'] end if attributes.key?(:'last_clicked') self.last_clicked = attributes[:'last_clicked'] end if attributes.key?(:'last_failed') self.last_failed = attributes[:'last_failed'] end if attributes.key?(:'last_ip') self.last_ip = attributes[:'last_ip'] end if attributes.key?(:'error_code') self.error_code = attributes[:'error_code'] end if attributes.key?(:'friendly_error_message') self. = attributes[:'friendly_error_message'] end end |
Instance Attribute Details
#error_code ⇒ Object
Last RFC Error code if any occurred
46 47 48 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 46 def error_code @error_code end |
#friendly_error_message ⇒ Object
Last RFC error message if any occurred
49 50 51 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 49 def @friendly_error_message end |
#last_clicked ⇒ Object
Date this contact last clicked an email
37 38 39 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 37 def last_clicked @last_clicked end |
#last_failed ⇒ Object
Last date when an email sent to this contact bounced
40 41 42 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 40 def last_failed @last_failed end |
#last_ip ⇒ Object
IP from which this contact opened or clicked their email last time
43 44 45 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 43 def last_ip @last_ip end |
#last_opened ⇒ Object
Date this contact last opened an email
34 35 36 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 34 def last_opened @last_opened end |
#last_sent ⇒ Object
Last date when an email was sent to this contact
31 32 33 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 31 def last_sent @last_sent end |
#total_clicked ⇒ Object
Total emails clicked
25 26 27 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 25 def total_clicked @total_clicked end |
#total_failed ⇒ Object
Total emails failed.
28 29 30 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 28 def total_failed @total_failed end |
#total_opened ⇒ Object
Total emails opened.
22 23 24 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 22 def total_opened @total_opened end |
#total_sent ⇒ Object
Total emails sent.
19 20 21 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 19 def total_sent @total_sent end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
69 70 71 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 69 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 52 def self.attribute_map { :'total_sent' => :'TotalSent', :'total_opened' => :'TotalOpened', :'total_clicked' => :'TotalClicked', :'total_failed' => :'TotalFailed', :'last_sent' => :'LastSent', :'last_opened' => :'LastOpened', :'last_clicked' => :'LastClicked', :'last_failed' => :'LastFailed', :'last_ip' => :'LastIP', :'error_code' => :'ErrorCode', :'friendly_error_message' => :'FriendlyErrorMessage' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
207 208 209 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 207 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
91 92 93 94 95 96 97 98 99 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 91 def self.openapi_nullable Set.new([ :'last_sent', :'last_opened', :'last_clicked', :'last_failed', :'error_code', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 74 def self.openapi_types { :'total_sent' => :'Integer', :'total_opened' => :'Integer', :'total_clicked' => :'Integer', :'total_failed' => :'Integer', :'last_sent' => :'Time', :'last_opened' => :'Time', :'last_clicked' => :'Time', :'last_failed' => :'Time', :'last_ip' => :'String', :'error_code' => :'Integer', :'friendly_error_message' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 176 def ==(o) return true if self.equal?(o) self.class == o.class && total_sent == o.total_sent && total_opened == o.total_opened && total_clicked == o.total_clicked && total_failed == o.total_failed && last_sent == o.last_sent && last_opened == o.last_opened && last_clicked == o.last_clicked && last_failed == o.last_failed && last_ip == o.last_ip && error_code == o.error_code && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 237 def _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 = ElasticEmail.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 308 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
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 214 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{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[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 end self end |
#eql?(o) ⇒ Boolean
194 195 196 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 194 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
200 201 202 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 200 def hash [total_sent, total_opened, total_clicked, total_failed, last_sent, last_opened, last_clicked, last_failed, last_ip, error_code, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
163 164 165 166 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 163 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
284 285 286 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 284 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 290 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
278 279 280 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 278 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
170 171 172 |
# File 'lib/ElasticEmail/models/contact_activity.rb', line 170 def valid? true end |