class UltracartClient::TransactionEmail

Attributes

content[RW]

Actual template contents

esp_domain_uuid[RW]

The uuid of the sending domain

esp_friendly_name[RW]

Friendly from that will appear in customer email clients.

esp_user[RW]

The username of the sending email. This is not the full email. Only the username which is everything before the @ sign.

file_exists[RW]

An internal identifier used to aid in retrieving templates from the filesystem.

file_name[RW]

File name

group[RW]
handlebar_variables[RW]

Handlebar Variables available for email template

invalid[RW]

Invalid will be true if the template cannot compile

last_modified[RW]

Last modified timestamp

library_item_oid[RW]

If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.

options[RW]

Options that help govern how and when this template is used

path[RW]

directory path where template is stored in file system

size[RW]

Size of file in friendly description

store_front_fs_directory_oid[RW]

Internal identifier used to store and retrieve template from filesystem

store_front_fs_file_oid[RW]

Internal identifier used to store and retrieve template from filesystem

subject[RW]

Subject

syntax_errors[RW]

Any syntax errors contained within the tempalate

template_path_relative_path[RW]

Internal value used to locate the template in the filesystem

theme_relative_path[RW]

Theme relative path in the filesystem.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/transaction_email.rb, line 78
def self.attribute_map
  {
    :'content' => :'content',
    :'esp_domain_uuid' => :'esp_domain_uuid',
    :'esp_friendly_name' => :'esp_friendly_name',
    :'esp_user' => :'esp_user',
    :'file_exists' => :'file_exists',
    :'file_name' => :'file_name',
    :'group' => :'group',
    :'handlebar_variables' => :'handlebar_variables',
    :'invalid' => :'invalid',
    :'last_modified' => :'last_modified',
    :'library_item_oid' => :'library_item_oid',
    :'options' => :'options',
    :'path' => :'path',
    :'size' => :'size',
    :'store_front_fs_directory_oid' => :'store_front_fs_directory_oid',
    :'store_front_fs_file_oid' => :'store_front_fs_file_oid',
    :'subject' => :'subject',
    :'syntax_errors' => :'syntax_errors',
    :'template_path_relative_path' => :'template_path_relative_path',
    :'theme_relative_path' => :'theme_relative_path'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/transaction_email.rb, line 131
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?(:'content')
    self.content = attributes[:'content']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'handlebar_variables')
    if (value = attributes[:'handlebar_variables']).is_a?(Array)
      self.handlebar_variables = value
    end
  end

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

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

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

  if attributes.has_key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/transaction_email.rb, line 104
def self.swagger_types
  {
    :'content' => :'String',
    :'esp_domain_uuid' => :'String',
    :'esp_friendly_name' => :'String',
    :'esp_user' => :'String',
    :'file_exists' => :'BOOLEAN',
    :'file_name' => :'String',
    :'group' => :'String',
    :'handlebar_variables' => :'Array<String>',
    :'invalid' => :'BOOLEAN',
    :'last_modified' => :'String',
    :'library_item_oid' => :'Integer',
    :'options' => :'Array<TransactionEmailOption>',
    :'path' => :'String',
    :'size' => :'String',
    :'store_front_fs_directory_oid' => :'Integer',
    :'store_front_fs_file_oid' => :'Integer',
    :'subject' => :'String',
    :'syntax_errors' => :'String',
    :'template_path_relative_path' => :'String',
    :'theme_relative_path' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/transaction_email.rb, line 237
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      esp_domain_uuid == o.esp_domain_uuid &&
      esp_friendly_name == o.esp_friendly_name &&
      esp_user == o.esp_user &&
      file_exists == o.file_exists &&
      file_name == o.file_name &&
      group == o.group &&
      handlebar_variables == o.handlebar_variables &&
      invalid == o.invalid &&
      last_modified == o.last_modified &&
      library_item_oid == o.library_item_oid &&
      options == o.options &&
      path == o.path &&
      size == o.size &&
      store_front_fs_directory_oid == o.store_front_fs_directory_oid &&
      store_front_fs_file_oid == o.store_front_fs_file_oid &&
      subject == o.subject &&
      syntax_errors == o.syntax_errors &&
      template_path_relative_path == o.template_path_relative_path &&
      theme_relative_path == o.theme_relative_path
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/ultracart_api/models/transaction_email.rb, line 298
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 = UltracartClient.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/ultracart_api/models/transaction_email.rb, line 364
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/ultracart_api/models/transaction_email.rb, line 277
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/ultracart_api/models/transaction_email.rb, line 264
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/transaction_email.rb, line 270
def hash
  [content, esp_domain_uuid, esp_friendly_name, esp_user, file_exists, file_name, group, handlebar_variables, invalid, last_modified, library_item_oid, options, path, size, store_front_fs_directory_oid, store_front_fs_file_oid, subject, syntax_errors, template_path_relative_path, theme_relative_path].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/ultracart_api/models/transaction_email.rb, line 224
def list_invalid_properties
  invalid_properties = Array.new
  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/ultracart_api/models/transaction_email.rb, line 344
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/ultracart_api/models/transaction_email.rb, line 350
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/ultracart_api/models/transaction_email.rb, line 338
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/ultracart_api/models/transaction_email.rb, line 231
def valid?
  true
end