class UltracartClient::OrderSummary

Attributes

actual_fulfillment[RW]
actual_payment_processing[RW]
actual_shipping[RW]
arbitrary_shipping_handling_total[RW]
other_refunded[RW]
shipping_handling_refunded[RW]
shipping_handling_total[RW]
shipping_handling_total_discount[RW]
subtotal[RW]
subtotal_discount[RW]
subtotal_discount_refunded[RW]
subtotal_refunded[RW]
tax[RW]
tax_refunded[RW]
taxable_subtotal[RW]
taxable_subtotal_discount[RW]
total[RW]
total_refunded[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/order_summary.rb, line 54
def self.attribute_map
  {
    :'actual_fulfillment' => :'actual_fulfillment',
    :'actual_payment_processing' => :'actual_payment_processing',
    :'actual_shipping' => :'actual_shipping',
    :'arbitrary_shipping_handling_total' => :'arbitrary_shipping_handling_total',
    :'other_refunded' => :'other_refunded',
    :'shipping_handling_refunded' => :'shipping_handling_refunded',
    :'shipping_handling_total' => :'shipping_handling_total',
    :'shipping_handling_total_discount' => :'shipping_handling_total_discount',
    :'subtotal' => :'subtotal',
    :'subtotal_discount' => :'subtotal_discount',
    :'subtotal_discount_refunded' => :'subtotal_discount_refunded',
    :'subtotal_refunded' => :'subtotal_refunded',
    :'tax' => :'tax',
    :'tax_refunded' => :'tax_refunded',
    :'taxable_subtotal' => :'taxable_subtotal',
    :'taxable_subtotal_discount' => :'taxable_subtotal_discount',
    :'total' => :'total',
    :'total_refunded' => :'total_refunded'
  }
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/order_summary.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?(:'actual_fulfillment')
    self.actual_fulfillment = attributes[:'actual_fulfillment']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/order_summary.rb, line 78
def self.swagger_types
  {
    :'actual_fulfillment' => :'Currency',
    :'actual_payment_processing' => :'Currency',
    :'actual_shipping' => :'Currency',
    :'arbitrary_shipping_handling_total' => :'Currency',
    :'other_refunded' => :'Currency',
    :'shipping_handling_refunded' => :'Currency',
    :'shipping_handling_total' => :'Currency',
    :'shipping_handling_total_discount' => :'Currency',
    :'subtotal' => :'Currency',
    :'subtotal_discount' => :'Currency',
    :'subtotal_discount_refunded' => :'Currency',
    :'subtotal_refunded' => :'Currency',
    :'tax' => :'Currency',
    :'tax_refunded' => :'Currency',
    :'taxable_subtotal' => :'Currency',
    :'taxable_subtotal_discount' => :'Currency',
    :'total' => :'Currency',
    :'total_refunded' => :'Currency'
  }
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/order_summary.rb, line 197
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actual_fulfillment == o.actual_fulfillment &&
      actual_payment_processing == o.actual_payment_processing &&
      actual_shipping == o.actual_shipping &&
      arbitrary_shipping_handling_total == o.arbitrary_shipping_handling_total &&
      other_refunded == o.other_refunded &&
      shipping_handling_refunded == o.shipping_handling_refunded &&
      shipping_handling_total == o.shipping_handling_total &&
      shipping_handling_total_discount == o.shipping_handling_total_discount &&
      subtotal == o.subtotal &&
      subtotal_discount == o.subtotal_discount &&
      subtotal_discount_refunded == o.subtotal_discount_refunded &&
      subtotal_refunded == o.subtotal_refunded &&
      tax == o.tax &&
      tax_refunded == o.tax_refunded &&
      taxable_subtotal == o.taxable_subtotal &&
      taxable_subtotal_discount == o.taxable_subtotal_discount &&
      total == o.total &&
      total_refunded == o.total_refunded
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/order_summary.rb, line 256
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/order_summary.rb, line 322
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/order_summary.rb, line 235
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/order_summary.rb, line 222
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/order_summary.rb, line 228
def hash
  [actual_fulfillment, actual_payment_processing, actual_shipping, arbitrary_shipping_handling_total, other_refunded, shipping_handling_refunded, shipping_handling_total, shipping_handling_total_discount, subtotal, subtotal_discount, subtotal_discount_refunded, subtotal_refunded, tax, tax_refunded, taxable_subtotal, taxable_subtotal_discount, total, total_refunded].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/order_summary.rb, line 184
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/order_summary.rb, line 302
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/order_summary.rb, line 308
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/order_summary.rb, line 296
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/order_summary.rb, line 191
def valid?
  true
end