class UltracartClient::ItemShippingMethod

Attributes

cost[RW]

Cost

each_additional_item_markup[RW]

Each additional item markup

filter_to_if_available[RW]

Filter to this method if available

first_item_markup[RW]

First item markup

fixed_shipping_cost[RW]

Fixed shipping cost

flat_fee_markup[RW]

Flat fee markup

free_shipping[RW]

Free shipping

per_item_fee_markup[RW]

Per item fee markup

percentage_markup[RW]

Percentage markup

percentage_of_item_markup[RW]

Percentage of item markup

relax_restrictions_on_upsell[RW]

Relax restrictions on upsell

shipping_method[RW]

Shipping method name

shipping_method_oid[RW]

Shipping method object identifier

shipping_method_validity[RW]

Shipping method validity

signature_required[RW]

Signature required

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/item_shipping_method.rb, line 85
def self.attribute_map
  {
    :'cost' => :'cost',
    :'each_additional_item_markup' => :'each_additional_item_markup',
    :'filter_to_if_available' => :'filter_to_if_available',
    :'first_item_markup' => :'first_item_markup',
    :'fixed_shipping_cost' => :'fixed_shipping_cost',
    :'flat_fee_markup' => :'flat_fee_markup',
    :'free_shipping' => :'free_shipping',
    :'per_item_fee_markup' => :'per_item_fee_markup',
    :'percentage_markup' => :'percentage_markup',
    :'percentage_of_item_markup' => :'percentage_of_item_markup',
    :'relax_restrictions_on_upsell' => :'relax_restrictions_on_upsell',
    :'shipping_method' => :'shipping_method',
    :'shipping_method_oid' => :'shipping_method_oid',
    :'shipping_method_validity' => :'shipping_method_validity',
    :'signature_required' => :'signature_required'
  }
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/item_shipping_method.rb, line 128
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?(:'cost')
    self.cost = attributes[:'cost']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/item_shipping_method.rb, line 106
def self.swagger_types
  {
    :'cost' => :'Float',
    :'each_additional_item_markup' => :'Float',
    :'filter_to_if_available' => :'BOOLEAN',
    :'first_item_markup' => :'Float',
    :'fixed_shipping_cost' => :'Float',
    :'flat_fee_markup' => :'Float',
    :'free_shipping' => :'BOOLEAN',
    :'per_item_fee_markup' => :'Float',
    :'percentage_markup' => :'Float',
    :'percentage_of_item_markup' => :'Float',
    :'relax_restrictions_on_upsell' => :'BOOLEAN',
    :'shipping_method' => :'String',
    :'shipping_method_oid' => :'Integer',
    :'shipping_method_validity' => :'String',
    :'signature_required' => :'BOOLEAN'
  }
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/item_shipping_method.rb, line 222
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cost == o.cost &&
      each_additional_item_markup == o.each_additional_item_markup &&
      filter_to_if_available == o.filter_to_if_available &&
      first_item_markup == o.first_item_markup &&
      fixed_shipping_cost == o.fixed_shipping_cost &&
      flat_fee_markup == o.flat_fee_markup &&
      free_shipping == o.free_shipping &&
      per_item_fee_markup == o.per_item_fee_markup &&
      percentage_markup == o.percentage_markup &&
      percentage_of_item_markup == o.percentage_of_item_markup &&
      relax_restrictions_on_upsell == o.relax_restrictions_on_upsell &&
      shipping_method == o.shipping_method &&
      shipping_method_oid == o.shipping_method_oid &&
      shipping_method_validity == o.shipping_method_validity &&
      signature_required == o.signature_required
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/item_shipping_method.rb, line 278
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/item_shipping_method.rb, line 344
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/item_shipping_method.rb, line 257
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/item_shipping_method.rb, line 244
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/item_shipping_method.rb, line 250
def hash
  [cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, signature_required].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/item_shipping_method.rb, line 197
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
shipping_method_validity=(shipping_method_validity) click to toggle source

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

# File lib/ultracart_api/models/item_shipping_method.rb, line 212
def shipping_method_validity=(shipping_method_validity)
  validator = EnumAttributeValidator.new('String', ['invalid for', 'valid for', 'valid only for'])
  unless validator.valid?(shipping_method_validity)
    fail ArgumentError, 'invalid value for "shipping_method_validity", must be one of #{validator.allowable_values}.'
  end
  @shipping_method_validity = shipping_method_validity
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/item_shipping_method.rb, line 324
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/item_shipping_method.rb, line 330
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/item_shipping_method.rb, line 318
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/item_shipping_method.rb, line 204
def valid?
  shipping_method_validity_validator = EnumAttributeValidator.new('String', ['invalid for', 'valid for', 'valid only for'])
  return false unless shipping_method_validity_validator.valid?(@shipping_method_validity)
  true
end