Class: ElasticEmail::RecipientEvent
- Inherits:
-
Object
- Object
- ElasticEmail::RecipientEvent
- Defined in:
- lib/ElasticEmail/models/recipient_event.rb
Overview
Detailed information about message recipient
Instance Attribute Summary collapse
-
#channel_name ⇒ Object
Name of selected channel.
-
#event_date ⇒ Object
Creation date.
-
#event_type ⇒ Object
Returns the value of attribute event_type.
-
#from_email ⇒ Object
Default From: email address.
-
#ip_address ⇒ Object
IP which this email was sent through.
-
#message ⇒ Object
Content of message, HTML encoded.
-
#message_category ⇒ Object
Returns the value of attribute message_category.
-
#msg_id ⇒ Object
ID number of selected message.
-
#next_try_on ⇒ Object
Date of next try.
-
#pool_name ⇒ Object
Name of an IP pool this email was sent through.
-
#subject ⇒ Object
Default subject of email.
-
#to ⇒ Object
Ending date for search in YYYY-MM-DDThh:mm:ss format.
-
#transaction_id ⇒ Object
ID number of transaction.
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 = {}) ⇒ RecipientEvent
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 = {}) ⇒ RecipientEvent
Initializes the object
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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 108 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::RecipientEvent` 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::RecipientEvent`. 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?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.key?(:'msg_id') self.msg_id = attributes[:'msg_id'] end if attributes.key?(:'from_email') self.from_email = attributes[:'from_email'] end if attributes.key?(:'to') self.to = attributes[:'to'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end if attributes.key?(:'event_type') self.event_type = attributes[:'event_type'] else self.event_type = 'Submission' end if attributes.key?(:'event_date') self.event_date = attributes[:'event_date'] end if attributes.key?(:'channel_name') self.channel_name = attributes[:'channel_name'] end if attributes.key?(:'message_category') self. = attributes[:'message_category'] else self. = 'Unknown' end if attributes.key?(:'next_try_on') self.next_try_on = attributes[:'next_try_on'] end if attributes.key?(:'message') self. = attributes[:'message'] end if attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] end if attributes.key?(:'pool_name') self.pool_name = attributes[:'pool_name'] end end |
Instance Attribute Details
#channel_name ⇒ Object
Name of selected channel.
40 41 42 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 40 def channel_name @channel_name end |
#event_date ⇒ Object
Creation date
37 38 39 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 37 def event_date @event_date end |
#event_type ⇒ Object
Returns the value of attribute event_type.
34 35 36 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 34 def event_type @event_type end |
#from_email ⇒ Object
Default From: email address.
26 27 28 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 26 def from_email @from_email end |
#ip_address ⇒ Object
IP which this email was sent through
51 52 53 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 51 def ip_address @ip_address end |
#message ⇒ Object
Content of message, HTML encoded
48 49 50 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 48 def @message end |
#message_category ⇒ Object
Returns the value of attribute message_category.
42 43 44 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 42 def @message_category end |
#msg_id ⇒ Object
ID number of selected message.
23 24 25 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 23 def msg_id @msg_id end |
#next_try_on ⇒ Object
Date of next try
45 46 47 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 45 def next_try_on @next_try_on end |
#pool_name ⇒ Object
Name of an IP pool this email was sent through
54 55 56 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 54 def pool_name @pool_name end |
#subject ⇒ Object
Default subject of email.
32 33 34 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 32 def subject @subject end |
#to ⇒ Object
Ending date for search in YYYY-MM-DDThh:mm:ss format.
29 30 31 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 29 def to @to end |
#transaction_id ⇒ Object
ID number of transaction
20 21 22 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 20 def transaction_id @transaction_id end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
76 77 78 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 76 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 57 def self.attribute_map { :'transaction_id' => :'TransactionID', :'msg_id' => :'MsgID', :'from_email' => :'FromEmail', :'to' => :'To', :'subject' => :'Subject', :'event_type' => :'EventType', :'event_date' => :'EventDate', :'channel_name' => :'ChannelName', :'message_category' => :'MessageCategory', :'next_try_on' => :'NextTryOn', :'message' => :'Message', :'ip_address' => :'IPAddress', :'pool_name' => :'PoolName' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
226 227 228 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 226 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
100 101 102 103 104 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 100 def self.openapi_nullable Set.new([ :'next_try_on', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 81 def self.openapi_types { :'transaction_id' => :'String', :'msg_id' => :'String', :'from_email' => :'String', :'to' => :'String', :'subject' => :'String', :'event_type' => :'EventType', :'event_date' => :'Time', :'channel_name' => :'String', :'message_category' => :'MessageCategory', :'next_try_on' => :'Time', :'message' => :'String', :'ip_address' => :'String', :'pool_name' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 193 def ==(o) return true if self.equal?(o) self.class == o.class && transaction_id == o.transaction_id && msg_id == o.msg_id && from_email == o.from_email && to == o.to && subject == o.subject && event_type == o.event_type && event_date == o.event_date && channel_name == o.channel_name && == o. && next_try_on == o.next_try_on && == o. && ip_address == o.ip_address && pool_name == o.pool_name end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 256 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
327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 327 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
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 233 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
213 214 215 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 213 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
219 220 221 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 219 def hash [transaction_id, msg_id, from_email, to, subject, event_type, event_date, channel_name, , next_try_on, , ip_address, pool_name].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
180 181 182 183 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 180 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
303 304 305 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 303 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 309 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
297 298 299 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 297 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
187 188 189 |
# File 'lib/ElasticEmail/models/recipient_event.rb', line 187 def valid? true end |