Class: Sendpost::Stat

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

Overview

Email statistics for a specific time period. These metrics help you understand your email performance and deliverability. Metric Flow: processed → sent → delivered → opened → clicked ↘ dropped ↘ softBounced ↘ smtpDropped ↘ hardBounced ↘ unsubscribed ↘ spam

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Stat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Sendpost::Stat` 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::Stat`. 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?(:'processed')
    self.processed = attributes[:'processed']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clicked ⇒ Object

Number of emails with at least one link clicked. Requires trackClicks=true.



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

def clicked
  @clicked
end

#delivered ⇒ Object

Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox.



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

def delivered
  @delivered
end

#dropped ⇒ Object

Number of emails dropped before sending. Common reasons: - Recipient email in suppression list (hard bounce, spam complaint, unsubscribe) - Invalid recipient email format - Sender domain not verified



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

def dropped
  @dropped
end

#hard_bounced ⇒ Object

Number of permanent delivery failures (hard bounces). Common causes: - Recipient email doesn't exist - Domain doesn't exist - Recipient has blocked sender Hard bounced addresses are automatically added to suppression list.



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

def hard_bounced
  @hard_bounced
end

#opened ⇒ Object

Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels.



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

def opened
  @opened
end

#processed ⇒ Object

Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API.



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

def processed
  @processed
end

#sent ⇒ Object

Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped



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

def sent
  @sent
end

#smtp_dropped ⇒ Object

Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed.



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

def smtp_dropped
  @smtp_dropped
end

#soft_bounced ⇒ Object

Number of temporary delivery failures (soft bounces). Common causes: - Recipient mailbox full - Server temporarily unavailable - Message too large SendPost automatically retries soft bounces.



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

def soft_bounced
  @soft_bounced
end

#spam ⇒ Object

Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%.



50
51
52
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 50

def spam
  @spam
end

#unsubscribed ⇒ Object

Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list.



47
48
49
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 47

def unsubscribed
  @unsubscribed
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



235
236
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
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 235

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



70
71
72
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 53

def self.attribute_map
  {
    :'processed' => :'processed',
    :'sent' => :'sent',
    :'dropped' => :'dropped',
    :'smtp_dropped' => :'smtpDropped',
    :'delivered' => :'delivered',
    :'soft_bounced' => :'softBounced',
    :'hard_bounced' => :'hardBounced',
    :'opened' => :'opened',
    :'clicked' => :'clicked',
    :'unsubscribed' => :'unsubscribed',
    :'spam' => :'spam'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 211

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



97
98
99
100
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 80

def self.openapi_types
  {
    :'processed' => :'Integer',
    :'sent' => :'Integer',
    :'dropped' => :'Integer',
    :'smtp_dropped' => :'Integer',
    :'delivered' => :'Integer',
    :'soft_bounced' => :'Integer',
    :'hard_bounced' => :'Integer',
    :'opened' => :'Integer',
    :'clicked' => :'Integer',
    :'unsubscribed' => :'Integer',
    :'spam' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      processed == o.processed &&
      sent == o.sent &&
      dropped == o.dropped &&
      smtp_dropped == o.smtp_dropped &&
      delivered == o.delivered &&
      soft_bounced == o.soft_bounced &&
      hard_bounced == o.hard_bounced &&
      opened == o.opened &&
      clicked == o.clicked &&
      unsubscribed == o.unsubscribed &&
      spam == o.spam
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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 306

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


198
199
200
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 204

def hash
  [processed, sent, dropped, smtp_dropped, delivered, soft_bounced, hard_bounced, opened, clicked, unsubscribed, spam].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



165
166
167
168
169
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 165

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



282
283
284
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 288

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



276
277
278
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 276

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



173
174
175
176
 
# File 'lib/sendpost_ruby_sdk/models/stat.rb', line 173

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