class UltracartClient::EmailCommseqEmail

Attributes

deleted[RW]

Deleted

edited_by_user[RW]

Edited by user

email_communication_sequence_email_uuid[RW]

Email communication sequence email uuid

email_communication_sequence_uuid[RW]

Email commseq UUID

email_container_cjson[RW]

Email container cjson

email_container_cjson_last_modified_dts[RW]

Timestamp the last time the container was modified.

email_template_vm_path[RW]

Email template virtual path

filter_profile_equation_json[RW]

Filter profile equation json

individually_render[RW]

Individually render

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.

merchant_id[RW]

Merchant ID

pending_review[RW]

True if the content of this email is pending review by UltraCart

preview_text[RW]

Preview text

rejected[RW]

True if the content of this email was rejected during review by UltraCart

requires_review[RW]

True if the content of this email is requires review by UltraCart

screenshot_large_full_url[RW]

URL to screenshot in large form factor full page

screenshot_large_viewport_url[RW]

URL to screenshot in large form factor viewport

screenshot_small_full_url[RW]

URL to screenshot in small form factor full page

screenshot_small_viewport_url[RW]

URL to screenshot in small form factor viewport

smart_sending[RW]

Smart sending

storefront_oid[RW]

Storefront oid

subject[RW]

Subject

suspended_for_spam[RW]

True if the email was suspended for too high of a spam rate.

transactional_email[RW]

Transactional email

version[RW]

Version

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_commseq_email.rb, line 93
def self.attribute_map
  {
    :'deleted' => :'deleted',
    :'edited_by_user' => :'edited_by_user',
    :'email_communication_sequence_email_uuid' => :'email_communication_sequence_email_uuid',
    :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
    :'email_container_cjson' => :'email_container_cjson',
    :'email_container_cjson_last_modified_dts' => :'email_container_cjson_last_modified_dts',
    :'email_template_vm_path' => :'email_template_vm_path',
    :'filter_profile_equation_json' => :'filter_profile_equation_json',
    :'individually_render' => :'individually_render',
    :'library_item_oid' => :'library_item_oid',
    :'merchant_id' => :'merchant_id',
    :'pending_review' => :'pending_review',
    :'preview_text' => :'preview_text',
    :'rejected' => :'rejected',
    :'requires_review' => :'requires_review',
    :'screenshot_large_full_url' => :'screenshot_large_full_url',
    :'screenshot_large_viewport_url' => :'screenshot_large_viewport_url',
    :'screenshot_small_full_url' => :'screenshot_small_full_url',
    :'screenshot_small_viewport_url' => :'screenshot_small_viewport_url',
    :'smart_sending' => :'smart_sending',
    :'storefront_oid' => :'storefront_oid',
    :'subject' => :'subject',
    :'suspended_for_spam' => :'suspended_for_spam',
    :'transactional_email' => :'transactional_email',
    :'version' => :'version'
  }
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_commseq_email.rb, line 156
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?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/email_commseq_email.rb, line 124
def self.swagger_types
  {
    :'deleted' => :'BOOLEAN',
    :'edited_by_user' => :'String',
    :'email_communication_sequence_email_uuid' => :'String',
    :'email_communication_sequence_uuid' => :'String',
    :'email_container_cjson' => :'String',
    :'email_container_cjson_last_modified_dts' => :'String',
    :'email_template_vm_path' => :'String',
    :'filter_profile_equation_json' => :'String',
    :'individually_render' => :'BOOLEAN',
    :'library_item_oid' => :'Integer',
    :'merchant_id' => :'String',
    :'pending_review' => :'BOOLEAN',
    :'preview_text' => :'String',
    :'rejected' => :'BOOLEAN',
    :'requires_review' => :'BOOLEAN',
    :'screenshot_large_full_url' => :'String',
    :'screenshot_large_viewport_url' => :'String',
    :'screenshot_small_full_url' => :'String',
    :'screenshot_small_viewport_url' => :'String',
    :'smart_sending' => :'BOOLEAN',
    :'storefront_oid' => :'Integer',
    :'subject' => :'String',
    :'suspended_for_spam' => :'BOOLEAN',
    :'transactional_email' => :'BOOLEAN',
    :'version' => :'Integer'
  }
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_commseq_email.rb, line 278
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      deleted == o.deleted &&
      edited_by_user == o.edited_by_user &&
      email_communication_sequence_email_uuid == o.email_communication_sequence_email_uuid &&
      email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
      email_container_cjson == o.email_container_cjson &&
      email_container_cjson_last_modified_dts == o.email_container_cjson_last_modified_dts &&
      email_template_vm_path == o.email_template_vm_path &&
      filter_profile_equation_json == o.filter_profile_equation_json &&
      individually_render == o.individually_render &&
      library_item_oid == o.library_item_oid &&
      merchant_id == o.merchant_id &&
      pending_review == o.pending_review &&
      preview_text == o.preview_text &&
      rejected == o.rejected &&
      requires_review == o.requires_review &&
      screenshot_large_full_url == o.screenshot_large_full_url &&
      screenshot_large_viewport_url == o.screenshot_large_viewport_url &&
      screenshot_small_full_url == o.screenshot_small_full_url &&
      screenshot_small_viewport_url == o.screenshot_small_viewport_url &&
      smart_sending == o.smart_sending &&
      storefront_oid == o.storefront_oid &&
      subject == o.subject &&
      suspended_for_spam == o.suspended_for_spam &&
      transactional_email == o.transactional_email &&
      version == o.version
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_commseq_email.rb, line 344
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_commseq_email.rb, line 410
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_commseq_email.rb, line 323
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_commseq_email.rb, line 310
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_commseq_email.rb, line 316
def hash
  [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].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_commseq_email.rb, line 265
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/email_commseq_email.rb, line 390
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_commseq_email.rb, line 396
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_commseq_email.rb, line 384
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/email_commseq_email.rb, line 272
def valid?
  true
end