class Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg

Attributes

contact_properties[RW]

The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.

custom_properties[RW]

The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}. Note: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.

email_id[RW]

The content ID for the transactional email, which can be found in email tool UI.

message[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 31
def self.attribute_map
  {
    :'message' => :'message',
    :'contact_properties' => :'contactProperties',
    :'custom_properties' => :'customProperties',
    :'email_id' => :'emailId'
  }
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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 149
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 58
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'contact_properties')
    if (value = attributes[:'contact_properties']).is_a?(Hash)
      self.contact_properties = value
    end
  end

  if attributes.key?(:'custom_properties')
    self.custom_properties = attributes[:'custom_properties']
  end

  if attributes.key?(:'email_id')
    self.email_id = attributes[:'email_id']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 51
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 41
def self.openapi_types
  {
    :'message' => :'PublicSingleSendEmail',
    :'contact_properties' => :'Hash<String, String>',
    :'custom_properties' => :'Object',
    :'email_id' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message == o.message &&
      contact_properties == o.contact_properties &&
      custom_properties == o.custom_properties &&
      email_id == o.email_id
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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 177
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
    Hubspot::Marketing::Transactional.const_get(type).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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 246
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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 156
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 136
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 142
def hash
  [message, contact_properties, custom_properties, email_id].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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 92
def list_invalid_properties
  invalid_properties = Array.new
  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

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

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

  if @email_id.nil?
    invalid_properties.push('invalid value for "email_id", email_id 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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 222
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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 228
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 216
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/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb, line 115
def valid?
  return false if @message.nil?
  return false if @contact_properties.nil?
  return false if @custom_properties.nil?
  return false if @email_id.nil?
  true
end