class UltracartClient::ItemShipping

Attributes

allow_back_order[RW]

Allow back order

amazon_fba[RW]

Fulfillment by Amazon.com

case_inner_packs[RW]

Case inner packs

case_units[RW]

Case units

cases[RW]

Cases

collect_serial_numbers[RW]

This item is on pre-order

country_code_of_origin[RW]

Country code of origin for customs forms. (ISO-3166 two letter code)

customs_description[RW]

Customs description

customs_value[RW]

Customs value

delivery_on_friday[RW]

Delivery on Friday

delivery_on_monday[RW]

Delivery on Monday

delivery_on_saturday[RW]

Delivery on Saturday

delivery_on_sunday[RW]

Delivery on Sunday

delivery_on_thursday[RW]

Delivery on Thursday

delivery_on_tuesday[RW]

Delivery on Tuesday

delivery_on_wednesday[RW]

Delivery on Wednesday

destination_markups[RW]

Destination markups

destination_restrictions[RW]

Destination restrictions

distribution_centers[RW]

Distribution centers

eta[RW]

Estimated time of arrival

free_shipping[RW]

Qualifies for free shipping

freight_class[RW]

Freight class

hazmat[RW]

Hazardous material

made_to_order[RW]

True if this item is made to order

made_to_order_lead_time[RW]

Number of days lead time it takes to make the item before ite can ship

max_days_time_in_transit[RW]

Maximum days allowed in transit

methods[RW]

Methods

no_shipping_discount[RW]

No shipping discounts

package_requirements[RW]

Package requirements

perishable_class_name[RW]

Perishable class name

perishable_class_oid[RW]

Perishable class object identifier

preorder[RW]

This item is on pre-order

require_delivery_date[RW]

True to require customer to select a delivery date

restrict_shipment_on_friday[RW]

Restrict shipment on Friday

restrict_shipment_on_monday[RW]

Restrict shipment on Monday

restrict_shipment_on_saturday[RW]

Restrict shipment on Saturday

restrict_shipment_on_sunday[RW]

Restrict shipment on Sunday

restrict_shipment_on_thursday[RW]

Restrict shipment on Thursday

restrict_shipment_on_tuesday[RW]

Restrict shipment on Tuesday

restrict_shipment_on_wednesday[RW]

Restrict shipment on Wednesday

ship_separately[RW]

Ship this item in a separate box

ship_separately_additional_weight[RW]
ship_separately_height[RW]
ship_separately_length[RW]
ship_separately_package_special_type[RW]

Ship separately package special type

ship_separately_width[RW]
special_product_type[RW]

Special product type (USPS Media Mail)

track_inventory[RW]

Track inventory

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.rb, line 158
def self.attribute_map
  {
    :'allow_back_order' => :'allow_back_order',
    :'amazon_fba' => :'amazon_fba',
    :'case_inner_packs' => :'case_inner_packs',
    :'case_units' => :'case_units',
    :'cases' => :'cases',
    :'collect_serial_numbers' => :'collect_serial_numbers',
    :'country_code_of_origin' => :'country_code_of_origin',
    :'customs_description' => :'customs_description',
    :'customs_value' => :'customs_value',
    :'delivery_on_friday' => :'delivery_on_friday',
    :'delivery_on_monday' => :'delivery_on_monday',
    :'delivery_on_saturday' => :'delivery_on_saturday',
    :'delivery_on_sunday' => :'delivery_on_sunday',
    :'delivery_on_thursday' => :'delivery_on_thursday',
    :'delivery_on_tuesday' => :'delivery_on_tuesday',
    :'delivery_on_wednesday' => :'delivery_on_wednesday',
    :'destination_markups' => :'destination_markups',
    :'destination_restrictions' => :'destination_restrictions',
    :'distribution_centers' => :'distribution_centers',
    :'eta' => :'eta',
    :'free_shipping' => :'free_shipping',
    :'freight_class' => :'freight_class',
    :'hazmat' => :'hazmat',
    :'made_to_order' => :'made_to_order',
    :'made_to_order_lead_time' => :'made_to_order_lead_time',
    :'max_days_time_in_transit' => :'max_days_time_in_transit',
    :'methods' => :'methods',
    :'no_shipping_discount' => :'no_shipping_discount',
    :'package_requirements' => :'package_requirements',
    :'perishable_class_name' => :'perishable_class_name',
    :'perishable_class_oid' => :'perishable_class_oid',
    :'preorder' => :'preorder',
    :'require_delivery_date' => :'require_delivery_date',
    :'restrict_shipment_on_friday' => :'restrict_shipment_on_friday',
    :'restrict_shipment_on_monday' => :'restrict_shipment_on_monday',
    :'restrict_shipment_on_saturday' => :'restrict_shipment_on_saturday',
    :'restrict_shipment_on_sunday' => :'restrict_shipment_on_sunday',
    :'restrict_shipment_on_thursday' => :'restrict_shipment_on_thursday',
    :'restrict_shipment_on_tuesday' => :'restrict_shipment_on_tuesday',
    :'restrict_shipment_on_wednesday' => :'restrict_shipment_on_wednesday',
    :'ship_separately' => :'ship_separately',
    :'ship_separately_additional_weight' => :'ship_separately_additional_weight',
    :'ship_separately_height' => :'ship_separately_height',
    :'ship_separately_length' => :'ship_separately_length',
    :'ship_separately_package_special_type' => :'ship_separately_package_special_type',
    :'ship_separately_width' => :'ship_separately_width',
    :'special_product_type' => :'special_product_type',
    :'track_inventory' => :'track_inventory'
  }
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.rb, line 267
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?(:'allow_back_order')
    self.allow_back_order = attributes[:'allow_back_order']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/item_shipping.rb, line 212
def self.swagger_types
  {
    :'allow_back_order' => :'BOOLEAN',
    :'amazon_fba' => :'BOOLEAN',
    :'case_inner_packs' => :'Integer',
    :'case_units' => :'Integer',
    :'cases' => :'Array<ItemShippingCase>',
    :'collect_serial_numbers' => :'BOOLEAN',
    :'country_code_of_origin' => :'String',
    :'customs_description' => :'String',
    :'customs_value' => :'Float',
    :'delivery_on_friday' => :'BOOLEAN',
    :'delivery_on_monday' => :'BOOLEAN',
    :'delivery_on_saturday' => :'BOOLEAN',
    :'delivery_on_sunday' => :'BOOLEAN',
    :'delivery_on_thursday' => :'BOOLEAN',
    :'delivery_on_tuesday' => :'BOOLEAN',
    :'delivery_on_wednesday' => :'BOOLEAN',
    :'destination_markups' => :'Array<ItemShippingDestinationMarkup>',
    :'destination_restrictions' => :'Array<ItemShippingDestinationRestriction>',
    :'distribution_centers' => :'Array<ItemShippingDistributionCenter>',
    :'eta' => :'String',
    :'free_shipping' => :'BOOLEAN',
    :'freight_class' => :'String',
    :'hazmat' => :'BOOLEAN',
    :'made_to_order' => :'BOOLEAN',
    :'made_to_order_lead_time' => :'Integer',
    :'max_days_time_in_transit' => :'Integer',
    :'methods' => :'Array<ItemShippingMethod>',
    :'no_shipping_discount' => :'BOOLEAN',
    :'package_requirements' => :'Array<ItemShippingPackageRequirement>',
    :'perishable_class_name' => :'String',
    :'perishable_class_oid' => :'Integer',
    :'preorder' => :'BOOLEAN',
    :'require_delivery_date' => :'BOOLEAN',
    :'restrict_shipment_on_friday' => :'BOOLEAN',
    :'restrict_shipment_on_monday' => :'BOOLEAN',
    :'restrict_shipment_on_saturday' => :'BOOLEAN',
    :'restrict_shipment_on_sunday' => :'BOOLEAN',
    :'restrict_shipment_on_thursday' => :'BOOLEAN',
    :'restrict_shipment_on_tuesday' => :'BOOLEAN',
    :'restrict_shipment_on_wednesday' => :'BOOLEAN',
    :'ship_separately' => :'BOOLEAN',
    :'ship_separately_additional_weight' => :'Weight',
    :'ship_separately_height' => :'Distance',
    :'ship_separately_length' => :'Distance',
    :'ship_separately_package_special_type' => :'String',
    :'ship_separately_width' => :'Distance',
    :'special_product_type' => :'String',
    :'track_inventory' => :'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.rb, line 508
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_back_order == o.allow_back_order &&
      amazon_fba == o.amazon_fba &&
      case_inner_packs == o.case_inner_packs &&
      case_units == o.case_units &&
      cases == o.cases &&
      collect_serial_numbers == o.collect_serial_numbers &&
      country_code_of_origin == o.country_code_of_origin &&
      customs_description == o.customs_description &&
      customs_value == o.customs_value &&
      delivery_on_friday == o.delivery_on_friday &&
      delivery_on_monday == o.delivery_on_monday &&
      delivery_on_saturday == o.delivery_on_saturday &&
      delivery_on_sunday == o.delivery_on_sunday &&
      delivery_on_thursday == o.delivery_on_thursday &&
      delivery_on_tuesday == o.delivery_on_tuesday &&
      delivery_on_wednesday == o.delivery_on_wednesday &&
      destination_markups == o.destination_markups &&
      destination_restrictions == o.destination_restrictions &&
      distribution_centers == o.distribution_centers &&
      eta == o.eta &&
      free_shipping == o.free_shipping &&
      freight_class == o.freight_class &&
      hazmat == o.hazmat &&
      made_to_order == o.made_to_order &&
      made_to_order_lead_time == o.made_to_order_lead_time &&
      max_days_time_in_transit == o.max_days_time_in_transit &&
      methods == o.methods &&
      no_shipping_discount == o.no_shipping_discount &&
      package_requirements == o.package_requirements &&
      perishable_class_name == o.perishable_class_name &&
      perishable_class_oid == o.perishable_class_oid &&
      preorder == o.preorder &&
      require_delivery_date == o.require_delivery_date &&
      restrict_shipment_on_friday == o.restrict_shipment_on_friday &&
      restrict_shipment_on_monday == o.restrict_shipment_on_monday &&
      restrict_shipment_on_saturday == o.restrict_shipment_on_saturday &&
      restrict_shipment_on_sunday == o.restrict_shipment_on_sunday &&
      restrict_shipment_on_thursday == o.restrict_shipment_on_thursday &&
      restrict_shipment_on_tuesday == o.restrict_shipment_on_tuesday &&
      restrict_shipment_on_wednesday == o.restrict_shipment_on_wednesday &&
      ship_separately == o.ship_separately &&
      ship_separately_additional_weight == o.ship_separately_additional_weight &&
      ship_separately_height == o.ship_separately_height &&
      ship_separately_length == o.ship_separately_length &&
      ship_separately_package_special_type == o.ship_separately_package_special_type &&
      ship_separately_width == o.ship_separately_width &&
      special_product_type == o.special_product_type &&
      track_inventory == o.track_inventory
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.rb, line 597
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.rb, line 663
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.rb, line 576
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
country_code_of_origin=(country_code_of_origin) click to toggle source

Custom attribute writer method with validation @param [Object] country_code_of_origin Value to be assigned

# File lib/ultracart_api/models/item_shipping.rb, line 498
def country_code_of_origin=(country_code_of_origin)
  if !country_code_of_origin.nil? && country_code_of_origin.to_s.length > 2
    fail ArgumentError, 'invalid value for "country_code_of_origin", the character length must be smaller than or equal to 2.'
  end

  @country_code_of_origin = country_code_of_origin
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/item_shipping.rb, line 563
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.rb, line 569
def hash
  [allow_back_order, amazon_fba, case_inner_packs, case_units, cases, collect_serial_numbers, country_code_of_origin, customs_description, customs_value, delivery_on_friday, delivery_on_monday, delivery_on_saturday, delivery_on_sunday, delivery_on_thursday, delivery_on_tuesday, delivery_on_wednesday, destination_markups, destination_restrictions, distribution_centers, eta, free_shipping, freight_class, hazmat, made_to_order, made_to_order_lead_time, max_days_time_in_transit, methods, no_shipping_discount, package_requirements, perishable_class_name, perishable_class_oid, preorder, require_delivery_date, restrict_shipment_on_friday, restrict_shipment_on_monday, restrict_shipment_on_saturday, restrict_shipment_on_sunday, restrict_shipment_on_thursday, restrict_shipment_on_tuesday, restrict_shipment_on_wednesday, ship_separately, ship_separately_additional_weight, ship_separately_height, ship_separately_length, ship_separately_package_special_type, ship_separately_width, special_product_type, track_inventory].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.rb, line 480
def list_invalid_properties
  invalid_properties = Array.new
  if !@country_code_of_origin.nil? && @country_code_of_origin.to_s.length > 2
    invalid_properties.push('invalid value for "country_code_of_origin", the character length must be smaller than or equal to 2.')
  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/ultracart_api/models/item_shipping.rb, line 643
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.rb, line 649
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.rb, line 637
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.rb, line 491
def valid?
  return false if !@country_code_of_origin.nil? && @country_code_of_origin.to_s.length > 2
  true
end