class SibApiV3Sdk::GetSmtpTemplateOverview

Attributes

created_at[RW]

Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

doi_template[RW]

It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.

html_content[RW]

HTML content of the template

id[RW]

ID of the template

is_active[RW]

Status of template (true=active, false=inactive)

modified_at[RW]

Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

name[RW]

Name of the template

reply_to[RW]

Email defined as the "Reply to" for the template

sender[RW]
subject[RW]

Subject of the template

tag[RW]

Tag of the template

test_sent[RW]

Status of test sending for the template (true=test email has been sent, false=test email has not been sent)

to_field[RW]

Customisation of the "to" field for the template

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_smtp_template_overview.rb, line 56
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'subject' => :'subject',
    :'is_active' => :'isActive',
    :'test_sent' => :'testSent',
    :'sender' => :'sender',
    :'reply_to' => :'replyTo',
    :'to_field' => :'toField',
    :'tag' => :'tag',
    :'html_content' => :'htmlContent',
    :'created_at' => :'createdAt',
    :'modified_at' => :'modifiedAt',
    :'doi_template' => :'doiTemplate'
  }
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_smtp_template_overview.rb, line 95
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'doiTemplate')
    self.doi_template = attributes[:'doiTemplate']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb, line 75
def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'subject' => :'String',
    :'is_active' => :'BOOLEAN',
    :'test_sent' => :'BOOLEAN',
    :'sender' => :'GetSmtpTemplateOverviewSender',
    :'reply_to' => :'String',
    :'to_field' => :'String',
    :'tag' => :'String',
    :'html_content' => :'String',
    :'created_at' => :'String',
    :'modified_at' => :'String',
    :'doi_template' => :'BOOLEAN'
  }
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_smtp_template_overview.rb, line 229
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      subject == o.subject &&
      is_active == o.is_active &&
      test_sent == o.test_sent &&
      sender == o.sender &&
      reply_to == o.reply_to &&
      to_field == o.to_field &&
      tag == o.tag &&
      html_content == o.html_content &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      doi_template == o.doi_template
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_smtp_template_overview.rb, line 283
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_smtp_template_overview.rb, line 349
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_smtp_template_overview.rb, line 262
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_smtp_template_overview.rb, line 249
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_smtp_template_overview.rb, line 255
def hash
  [id, name, subject, is_active, test_sent, sender, reply_to, to_field, tag, html_content, created_at, modified_at, doi_template].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_smtp_template_overview.rb, line 156
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

  if @modified_at.nil?
    invalid_properties.push('invalid value for "modified_at", modified_at 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_smtp_template_overview.rb, line 329
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_smtp_template_overview.rb, line 335
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_smtp_template_overview.rb, line 323
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_smtp_template_overview.rb, line 211
def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @subject.nil?
  return false if @is_active.nil?
  return false if @test_sent.nil?
  return false if @sender.nil?
  return false if @reply_to.nil?
  return false if @to_field.nil?
  return false if @tag.nil?
  return false if @html_content.nil?
  return false if @created_at.nil?
  return false if @modified_at.nil?
  true
end