Class: OCI::EmailDataPlane::Models::EmailSubmittedResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email_data_plane/models/email_submitted_response.rb

Overview

Response object that is returned to sender upon successfully submitting the email request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailSubmittedResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 56

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.message_id = attributes[:'messageId'] if attributes[:'messageId']

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

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

  self.envelope_id = attributes[:'envelopeId'] if attributes[:'envelopeId']

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

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

  self.suppressed_recipients = attributes[:'suppressedRecipients'] if attributes[:'suppressedRecipients']

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

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

Instance Attribute Details

#envelope_id ⇒ String

[Required] Email Delivery generated unique Envelope ID of the email submission. If you need to contact Email Delivery about a particular request, please provide the Envelope ID.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 19

def envelope_id
  @envelope_id
end

#message_id ⇒ String

[Required] The unique ID for the email's Message-ID header used for service log correlation. The submission will return an error if the syntax is not a valid RFC 5322 Message-ID. This will be generated if not provided. Example: sdiofu234qwermls24fd@mail.example.com

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 15

def message_id
  @message_id
end

#suppressed_recipients ⇒ Array<OCI::EmailDataPlane::Models::EmailAddress>

[Required] Return list of suppressed email addresses.

Returns:



23
24
25
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 23

def suppressed_recipients
  @suppressed_recipients
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message_id': :'messageId',
    'envelope_id': :'envelopeId',
    'suppressed_recipients': :'suppressedRecipients'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message_id': :'String',
    'envelope_id': :'String',
    'suppressed_recipients': :'Array<OCI::EmailDataPlane::Models::EmailAddress>'
    # 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



88
89
90
91
92
93
94
95
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 88

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

  self.class == other.class &&
    message_id == other.message_id &&
    envelope_id == other.envelope_id &&
    suppressed_recipients == other.suppressed_recipients
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 120

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


100
101
102
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 109

def hash
  [message_id, envelope_id, suppressed_recipients].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 153

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



147
148
149
 
# File 'lib/oci/email_data_plane/models/email_submitted_response.rb', line 147

def to_s
  to_hash.to_s
end