class SibApiV3Sdk::GetTransacEmailsListTransactionalEmails

Attributes

date[RW]

Date on which transactional email was sent

email[RW]

Email address to which transactional email has been sent

from[RW]

Email address of the sender from which the email was sent

message_id[RW]

Message Id of the sent email

subject[RW]

Subject of the sent email

tags[RW]

Tags used for your email

template_id[RW]

Id of the template

uuid[RW]

Unique id of the email sent to a particular contact

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 42
def self.attribute_map
  {
    :'email' => :'email',
    :'subject' => :'subject',
    :'template_id' => :'templateId',
    :'message_id' => :'messageId',
    :'uuid' => :'uuid',
    :'date' => :'date',
    :'from' => :'from',
    :'tags' => :'tags'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 71
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 }

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

  if attributes.has_key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.has_key?(:'templateId')
    self.template_id = attributes[:'templateId']
  end

  if attributes.has_key?(:'messageId')
    self.message_id = attributes[:'messageId']
  end

  if attributes.has_key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.has_key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 56
def self.swagger_types
  {
    :'email' => :'String',
    :'subject' => :'String',
    :'template_id' => :'Integer',
    :'message_id' => :'String',
    :'uuid' => :'String',
    :'date' => :'String',
    :'from' => :'String',
    :'tags' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 152
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      subject == o.subject &&
      template_id == o.template_id &&
      message_id == o.message_id &&
      uuid == o.uuid &&
      date == o.date &&
      from == o.from &&
      tags == o.tags
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 201
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = SibApiV3Sdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 267
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 180
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 167
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 173
def hash
  [email, subject, template_id, message_id, uuid, date, from, tags].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 114
def list_invalid_properties
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @subject.nil?
    invalid_properties.push('invalid value for "subject", subject cannot be nil.')
  end

  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
  end

  if @uuid.nil?
    invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 247
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 253
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 241
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb, line 141
def valid?
  return false if @email.nil?
  return false if @subject.nil?
  return false if @message_id.nil?
  return false if @uuid.nil?
  return false if @date.nil?
  true
end