Class: Sendpost::Suppression

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

Overview

A suppressed email address that will not receive emails from this sub-account. Emails to suppressed addresses are automatically dropped before sending. Suppressions are added automatically when: - An email hard bounces (permanent delivery failure) - A recipient marks an email as spam - A recipient clicks the unsubscribe link You can also manually add suppressions via the API.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Suppression

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 106

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

UNIX epoch timestamp in nanoseconds when the suppression was added



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

def created
  @created
end

#email ⇒ Object

The suppressed email address



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

def email
  @email
end

#id ⇒ Object

Unique identifier for the suppression record



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

def id
  @id
end

#message_uuid ⇒ Object

UUID of the message whose bounce/complaint caused this suppression. Empty for manually added suppressions. Useful for tracing the origin.



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

def message_uuid
  @message_uuid
end

#reason ⇒ Object

Reason code for the suppression: - 0 = Manual (added via API or dashboard) - 1 = Unsubscribe (recipient clicked unsubscribe link) - 2 = Hard Bounce (permanent delivery failure) - 3 = Spam Complaint (recipient marked as spam) - 4 = Hard Bounce (detected by post-send validation)



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

def reason
  @reason
end

#reason_text ⇒ Object

Human-readable suppression reason



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

def reason_text
  @reason_text
end

#smtp_error ⇒ Object

SMTP error message from the receiving server (only for hard bounce suppressions). Useful for diagnosing delivery issues.



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

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



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
275
276
277
278
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 241

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



76
77
78
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'reason' => :'reason',
    :'reason_text' => :'reasonText',
    :'smtp_error' => :'smtpError',
    :'message_uuid' => :'messageUUID',
    :'created' => :'created'
  }
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 217

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



99
100
101
102
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 86

def self.openapi_types
  {
    :'id' => :'Integer',
    :'email' => :'String',
    :'reason' => :'Integer',
    :'reason_text' => :'String',
    :'smtp_error' => :'String',
    :'message_uuid' => :'String',
    :'created' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      reason == o.reason &&
      reason_text == o.reason_text &&
      smtp_error == o.smtp_error &&
      message_uuid == o.message_uuid &&
      created == o.created
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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 312

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 210

def hash
  [id, email, reason, reason_text, smtp_error, message_uuid, created].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



151
152
153
154
155
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 151

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



288
289
290
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 294

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



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

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



159
160
161
162
163
164
165
166
 
# File 'lib/sendpost_ruby_sdk/models/suppression.rb', line 159

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  reason_validator = EnumAttributeValidator.new('Integer', [0, 1, 2, 3, 4])
  return false unless reason_validator.valid?(@reason)
  reason_text_validator = EnumAttributeValidator.new('String', ["manual", "unsubscribe", "hardBounce", "spamComplaint"])
  return false unless reason_text_validator.valid?(@reason_text)
  true
end