class UltracartClient::EmailPlan

Attributes

additional_customers[RW]
additional_emails[RW]
additional_fee[RW]
allow_list_import[RW]
allow_tracking_emails[RW]
customer_tiers[RW]
initial_sending_limits[RW]
plan_customers[RW]
plan_emails[RW]
plan_name[RW]
plan_name_formatted[RW]
require_order_within_last_days[RW]
revenue_percent[RW]
spam_percent_limit[RW]
total_customers[RW]
total_emails[RW]
upgrade_to[RW]

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_plan.rb, line 52
def self.attribute_map
  {
    :'additional_customers' => :'additional_customers',
    :'additional_emails' => :'additional_emails',
    :'additional_fee' => :'additional_fee',
    :'allow_list_import' => :'allow_list_import',
    :'allow_tracking_emails' => :'allow_tracking_emails',
    :'customer_tiers' => :'customer_tiers',
    :'initial_sending_limits' => :'initial_sending_limits',
    :'plan_customers' => :'plan_customers',
    :'plan_emails' => :'plan_emails',
    :'plan_name' => :'plan_name',
    :'plan_name_formatted' => :'plan_name_formatted',
    :'require_order_within_last_days' => :'require_order_within_last_days',
    :'revenue_percent' => :'revenue_percent',
    :'spam_percent_limit' => :'spam_percent_limit',
    :'total_customers' => :'total_customers',
    :'total_emails' => :'total_emails',
    :'upgrade_to' => :'upgrade_to'
  }
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_plan.rb, line 99
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?(:'additional_customers')
    self.additional_customers = attributes[:'additional_customers']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/email_plan.rb, line 75
def self.swagger_types
  {
    :'additional_customers' => :'Integer',
    :'additional_emails' => :'Integer',
    :'additional_fee' => :'Float',
    :'allow_list_import' => :'BOOLEAN',
    :'allow_tracking_emails' => :'BOOLEAN',
    :'customer_tiers' => :'Array<EmailPlanAdditional>',
    :'initial_sending_limits' => :'Integer',
    :'plan_customers' => :'Integer',
    :'plan_emails' => :'Integer',
    :'plan_name' => :'String',
    :'plan_name_formatted' => :'String',
    :'require_order_within_last_days' => :'Integer',
    :'revenue_percent' => :'Integer',
    :'spam_percent_limit' => :'Integer',
    :'total_customers' => :'Integer',
    :'total_emails' => :'Integer',
    :'upgrade_to' => :'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_plan.rb, line 191
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_customers == o.additional_customers &&
      additional_emails == o.additional_emails &&
      additional_fee == o.additional_fee &&
      allow_list_import == o.allow_list_import &&
      allow_tracking_emails == o.allow_tracking_emails &&
      customer_tiers == o.customer_tiers &&
      initial_sending_limits == o.initial_sending_limits &&
      plan_customers == o.plan_customers &&
      plan_emails == o.plan_emails &&
      plan_name == o.plan_name &&
      plan_name_formatted == o.plan_name_formatted &&
      require_order_within_last_days == o.require_order_within_last_days &&
      revenue_percent == o.revenue_percent &&
      spam_percent_limit == o.spam_percent_limit &&
      total_customers == o.total_customers &&
      total_emails == o.total_emails &&
      upgrade_to == o.upgrade_to
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_plan.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_plan.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_plan.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_plan.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_plan.rb, line 221
def hash
  [additional_customers, additional_emails, additional_fee, allow_list_import, allow_tracking_emails, customer_tiers, initial_sending_limits, plan_customers, plan_emails, plan_name, plan_name_formatted, require_order_within_last_days, revenue_percent, spam_percent_limit, total_customers, total_emails, upgrade_to].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_plan.rb, line 178
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_plan.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_plan.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_plan.rb, line 289
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_plan.rb, line 185
def valid?
  true
end