class UltracartClient::EmailCommseqStep

Attributes

alt_child_email_communication_sequence_steps[RW]

Array of child steps for the alternate path

child_email_communication_sequence_steps[RW]

Array of child steps

email_communication_sequence_step_uuid[RW]

Email commseq step UUID

email_pending_review[RW]

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

email_rejected[RW]

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

email_requires_review[RW]

True if the content of the email associated with this step requires review by UltraCart

filter_profile_equation_json[RW]

Filter profile equation JSON

merchant_notes[RW]

Internal merchant notes

step_config_json[RW]

Arbitrary Configuration for a step

type[RW]

Type of step

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_step.rb, line 70
def self.attribute_map
  {
    :'alt_child_email_communication_sequence_steps' => :'alt_child_email_communication_sequence_steps',
    :'child_email_communication_sequence_steps' => :'child_email_communication_sequence_steps',
    :'email_communication_sequence_step_uuid' => :'email_communication_sequence_step_uuid',
    :'email_pending_review' => :'email_pending_review',
    :'email_rejected' => :'email_rejected',
    :'email_requires_review' => :'email_requires_review',
    :'filter_profile_equation_json' => :'filter_profile_equation_json',
    :'merchant_notes' => :'merchant_notes',
    :'step_config_json' => :'step_config_json',
    :'type' => :'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_commseq_step.rb, line 103
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?(:'alt_child_email_communication_sequence_steps')
    if (value = attributes[:'alt_child_email_communication_sequence_steps']).is_a?(Array)
      self.alt_child_email_communication_sequence_steps = value
    end
  end

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/email_commseq_step.rb, line 86
def self.swagger_types
  {
    :'alt_child_email_communication_sequence_steps' => :'Array<EmailCommseqStep>',
    :'child_email_communication_sequence_steps' => :'Array<EmailCommseqStep>',
    :'email_communication_sequence_step_uuid' => :'String',
    :'email_pending_review' => :'BOOLEAN',
    :'email_rejected' => :'BOOLEAN',
    :'email_requires_review' => :'BOOLEAN',
    :'filter_profile_equation_json' => :'String',
    :'merchant_notes' => :'String',
    :'step_config_json' => :'String',
    :'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_commseq_step.rb, line 181
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alt_child_email_communication_sequence_steps == o.alt_child_email_communication_sequence_steps &&
      child_email_communication_sequence_steps == o.child_email_communication_sequence_steps &&
      email_communication_sequence_step_uuid == o.email_communication_sequence_step_uuid &&
      email_pending_review == o.email_pending_review &&
      email_rejected == o.email_rejected &&
      email_requires_review == o.email_requires_review &&
      filter_profile_equation_json == o.filter_profile_equation_json &&
      merchant_notes == o.merchant_notes &&
      step_config_json == o.step_config_json &&
      type == o.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_commseq_step.rb, line 232
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_step.rb, line 298
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_step.rb, line 211
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_step.rb, line 198
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_step.rb, line 204
def hash
  [alt_child_email_communication_sequence_steps, child_email_communication_sequence_steps, email_communication_sequence_step_uuid, email_pending_review, email_rejected, email_requires_review, filter_profile_equation_json, merchant_notes, step_config_json, 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_commseq_step.rb, line 156
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_step.rb, line 278
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_step.rb, line 284
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_step.rb, line 272
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/ultracart_api/models/email_commseq_step.rb, line 171
def type=(type)
  validator = EnumAttributeValidator.new('String', ['begin', 'wait', 'email', 'merge', 'condition', 'end'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = 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_commseq_step.rb, line 163
def valid?
  type_validator = EnumAttributeValidator.new('String', ['begin', 'wait', 'email', 'merge', 'condition', 'end'])
  return false unless type_validator.valid?(@type)
  true
end