Class: Sendpost::EventMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/models/event_metadata.rb

Overview

Additional contextual information about an email event. The available fields depend on the event type: - delivered/bounced: smtpCode, smtpDescription - opened/clicked: userAgent, os, device, geo, trackedIp - clicked: clickedUrl

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventMetadata

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



94
95
96
97
98
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
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 94

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Sendpost::EventMetadata` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Sendpost::EventMetadata`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'smtp_code')
    self.smtp_code = attributes[:'smtp_code']
  end

  if attributes.key?(:'smtp_description')
    self.smtp_description = attributes[:'smtp_description']
  end

  if attributes.key?(:'user_agent')
    self.user_agent = attributes[:'user_agent']
  end

  if attributes.key?(:'os')
    self.os = attributes[:'os']
  end

  if attributes.key?(:'device')
    self.device = attributes[:'device']
  end

  if attributes.key?(:'geo')
    self.geo = attributes[:'geo']
  end

  if attributes.key?(:'clicked_url')
    self.clicked_url = attributes[:'clicked_url']
  end

  if attributes.key?(:'tracked_ip')
    self.tracked_ip = attributes[:'tracked_ip']
  end

  if attributes.key?(:'raw_user_agent')
    self.raw_user_agent = attributes[:'raw_user_agent']
  end
end

Instance Attribute Details

#clicked_url ⇒ Object

The original URL that was clicked (only for click events)



38
39
40
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 38

def clicked_url
  @clicked_url
end

#device ⇒ Object

Device type information (for open/click events)



32
33
34
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 32

def device
  @device
end

#geo ⇒ Object

Geographic location based on IP address (for open/click events)



35
36
37
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 35

def geo
  @geo
end

#os ⇒ Object

Parsed operating system information (for open/click events)



29
30
31
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 29

def os
  @os
end

#raw_user_agent ⇒ Object

Raw User-Agent header string from the HTTP request



44
45
46
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 44

def raw_user_agent
  @raw_user_agent
end

#smtp_code ⇒ Object

SMTP response code from the receiving mail server. - 250: Success - 4xx: Temporary failure (soft bounce) - 5xx: Permanent failure (hard bounce)



20
21
22
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 20

def smtp_code
  @smtp_code
end

#smtp_description ⇒ Object

Full SMTP response message from the receiving server. Useful for diagnosing delivery issues.



23
24
25
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 23

def smtp_description
  @smtp_description
end

#tracked_ip ⇒ Object

IP address of the user who triggered the event (open/click)



41
42
43
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 41

def tracked_ip
  @tracked_ip
end

#user_agent ⇒ Object

Parsed browser/email client information (for open/click events)



26
27
28
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 26

def user_agent
  @user_agent
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



215
216
217
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
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 215

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 = Sendpost.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 47

def self.attribute_map
  {
    :'smtp_code' => :'smtpCode',
    :'smtp_description' => :'smtpDescription',
    :'user_agent' => :'userAgent',
    :'os' => :'os',
    :'device' => :'device',
    :'geo' => :'geo',
    :'clicked_url' => :'clickedUrl',
    :'tracked_ip' => :'trackedIp',
    :'raw_user_agent' => :'rawUserAgent'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 191

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



87
88
89
90
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 87

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 72

def self.openapi_types
  {
    :'smtp_code' => :'Integer',
    :'smtp_description' => :'String',
    :'user_agent' => :'UserAgent',
    :'os' => :'Os',
    :'device' => :'Device',
    :'geo' => :'GeoLocation',
    :'clicked_url' => :'String',
    :'tracked_ip' => :'String',
    :'raw_user_agent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      smtp_code == o.smtp_code &&
      smtp_description == o.smtp_description &&
      user_agent == o.user_agent &&
      os == o.os &&
      device == o.device &&
      geo == o.geo &&
      clicked_url == o.clicked_url &&
      tracked_ip == o.tracked_ip &&
      raw_user_agent == o.raw_user_agent
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 286

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 184

def hash
  [smtp_code, smtp_description, user_agent, os, device, geo, clicked_url, tracked_ip, raw_user_agent].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



147
148
149
150
151
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 147

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 262

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 268

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

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 256

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



155
156
157
158
 
# File 'lib/sendpost_ruby_sdk/models/event_metadata.rb', line 155

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end