Class: OCI::Email::Models::Suppression

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

Overview

The full information representing an email suppression.

Constant Summary collapse

REASON_ENUM =
[
  REASON_UNKNOWN = 'UNKNOWN'.freeze,
  REASON_HARDBOUNCE = 'HARDBOUNCE'.freeze,
  REASON_COMPLAINT = 'COMPLAINT'.freeze,
  REASON_MANUAL = 'MANUAL'.freeze,
  REASON_SOFTBOUNCE = 'SOFTBOUNCE'.freeze,
  REASON_UNSUBSCRIBE = 'UNSUBSCRIBE'.freeze,
  REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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

Options Hash (attributes):

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :email_address (String)

    The value to assign to the #email_address property

  • :id (String)

    The value to assign to the #id property

  • :reason (String)

    The value to assign to the #reason property

  • :time_created (DateTime)

    The value to assign to the #time_created property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/oci/email/models/suppression.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress']

  raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')

  self.email_address = attributes[:'email_address'] if attributes[:'email_address']

  self.id = attributes[:'id'] if attributes[:'id']

  self.reason = attributes[:'reason'] if attributes[:'reason']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']
end

Instance Attribute Details

#compartment_idString

The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#email_addressString

Email address of the suppression.

Returns:

  • (String)


30
31
32
# File 'lib/oci/email/models/suppression.rb', line 30

def email_address
  @email_address
end

#idString

The unique ID of the suppression.

Returns:

  • (String)


34
35
36
# File 'lib/oci/email/models/suppression.rb', line 34

def id
  @id
end

#reasonString

The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.

Returns:

  • (String)


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

def reason
  @reason
end

#time_createdDateTime

The date and time the suppression was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Returns:

  • (DateTime)


44
45
46
# File 'lib/oci/email/models/suppression.rb', line 44

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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



47
48
49
50
51
52
53
54
55
56
57
# File 'lib/oci/email/models/suppression.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'email_address': :'emailAddress',
    'id': :'id',
    'reason': :'reason',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
# File 'lib/oci/email/models/suppression.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'email_address': :'String',
    'id': :'String',
    'reason': :'String',
    'time_created': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



132
133
134
135
136
137
138
139
140
141
# File 'lib/oci/email/models/suppression.rb', line 132

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    email_address == other.email_address &&
    id == other.id &&
    reason == other.reason &&
    time_created == other.time_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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/email/models/suppression.rb', line 166

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
# File 'lib/oci/email/models/suppression.rb', line 146

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



155
156
157
# File 'lib/oci/email/models/suppression.rb', line 155

def hash
  [compartment_id, email_address, id, reason, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
# File 'lib/oci/email/models/suppression.rb', line 199

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



193
194
195
# File 'lib/oci/email/models/suppression.rb', line 193

def to_s
  to_hash.to_s
end