class UltracartClient::EmailTemplate

Attributes

container_cjson[RW]

Container cjson

description[RW]

Description of email template

email_template_oid[RW]

Email template oid

email_template_vm_path[RW]

Email Template VM Path

merchant_id[RW]

Merchant ID

name[RW]

Name of email template

preview_amazon_listing_key[RW]

Amazon key for preview png image

sort_order[RW]

Sort order (optional)

storefront_oid[RW]

StoreFront oid

system[RW]

True if this email template is system-wide,false if merchant specific

trigger_type[RW]

Trigger type

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/email_template.rb, line 51
def self.attribute_map
  {
    :'container_cjson' => :'container_cjson',
    :'description' => :'description',
    :'email_template_oid' => :'email_template_oid',
    :'email_template_vm_path' => :'email_template_vm_path',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'preview_amazon_listing_key' => :'preview_amazon_listing_key',
    :'sort_order' => :'sort_order',
    :'storefront_oid' => :'storefront_oid',
    :'system' => :'system',
    :'trigger_type' => :'trigger_type'
  }
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/email_template.rb, line 86
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?(:'container_cjson')
    self.container_cjson = attributes[:'container_cjson']
  end

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/email_template.rb, line 68
def self.swagger_types
  {
    :'container_cjson' => :'String',
    :'description' => :'String',
    :'email_template_oid' => :'Integer',
    :'email_template_vm_path' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'preview_amazon_listing_key' => :'String',
    :'sort_order' => :'Integer',
    :'storefront_oid' => :'Integer',
    :'system' => :'BOOLEAN',
    :'trigger_type' => :'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/email_template.rb, line 197
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      container_cjson == o.container_cjson &&
      description == o.description &&
      email_template_oid == o.email_template_oid &&
      email_template_vm_path == o.email_template_vm_path &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      preview_amazon_listing_key == o.preview_amazon_listing_key &&
      sort_order == o.sort_order &&
      storefront_oid == o.storefront_oid &&
      system == o.system &&
      trigger_type == o.trigger_type
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/email_template.rb, line 249
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/email_template.rb, line 315
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/email_template.rb, line 228
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/email_template.rb, line 215
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/email_template.rb, line 221
def hash
  [container_cjson, description, email_template_oid, email_template_vm_path, merchant_id, name, preview_amazon_listing_key, sort_order, storefront_oid, system, trigger_type].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/email_template.rb, line 139
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 250
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 250.')
  end

  if !@preview_amazon_listing_key.nil? && @preview_amazon_listing_key.to_s.length > 250
    invalid_properties.push('invalid value for "preview_amazon_listing_key", the character length must be smaller than or equal to 250.')
  end

  if !@trigger_type.nil? && @trigger_type.to_s.length > 100
    invalid_properties.push('invalid value for "trigger_type", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/ultracart_api/models/email_template.rb, line 167
def name=(name)
  if !name.nil? && name.to_s.length > 250
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 250.'
  end

  @name = name
end
preview_amazon_listing_key=(preview_amazon_listing_key) click to toggle source

Custom attribute writer method with validation @param [Object] preview_amazon_listing_key Value to be assigned

# File lib/ultracart_api/models/email_template.rb, line 177
def preview_amazon_listing_key=(preview_amazon_listing_key)
  if !preview_amazon_listing_key.nil? && preview_amazon_listing_key.to_s.length > 250
    fail ArgumentError, 'invalid value for "preview_amazon_listing_key", the character length must be smaller than or equal to 250.'
  end

  @preview_amazon_listing_key = preview_amazon_listing_key
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/email_template.rb, line 295
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/email_template.rb, line 301
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/email_template.rb, line 289
def to_s
  to_hash.to_s
end
trigger_type=(trigger_type) click to toggle source

Custom attribute writer method with validation @param [Object] trigger_type Value to be assigned

# File lib/ultracart_api/models/email_template.rb, line 187
def trigger_type=(trigger_type)
  if !trigger_type.nil? && trigger_type.to_s.length > 100
    fail ArgumentError, 'invalid value for "trigger_type", the character length must be smaller than or equal to 100.'
  end

  @trigger_type = trigger_type
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/email_template.rb, line 158
def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  return false if !@preview_amazon_listing_key.nil? && @preview_amazon_listing_key.to_s.length > 250
  return false if !@trigger_type.nil? && @trigger_type.to_s.length > 100
  true
end