class UltracartClient::ItemShippingDistributionCenter

Attributes

allocated_to_placed_orders[RW]

Allocated to placed orders

allocated_to_shopping_carts[RW]

Allocated to shopping carts

available_to_allocate[RW]

Available to allocate

desired_inventory_level[RW]

Desired inventory level

distribution_center_code[RW]

Distribution center code

distribution_center_oid[RW]

Distribution center object identifier

eta[RW]

Estimated time of arrival

handles[RW]

True if this distribution center handles this item

inventory_level[RW]

Inventory level

maximum_backorder[RW]

Maximum back-order

reorder_inventory_level[RW]

Reorder inventory level (triggers notification)

sku[RW]

SKU

stock_picking_location[RW]

Stock picking location

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_distribution_center.rb, line 57
def self.attribute_map
  {
    :'allocated_to_placed_orders' => :'allocated_to_placed_orders',
    :'allocated_to_shopping_carts' => :'allocated_to_shopping_carts',
    :'available_to_allocate' => :'available_to_allocate',
    :'desired_inventory_level' => :'desired_inventory_level',
    :'distribution_center_code' => :'distribution_center_code',
    :'distribution_center_oid' => :'distribution_center_oid',
    :'eta' => :'eta',
    :'handles' => :'handles',
    :'inventory_level' => :'inventory_level',
    :'maximum_backorder' => :'maximum_backorder',
    :'reorder_inventory_level' => :'reorder_inventory_level',
    :'sku' => :'sku',
    :'stock_picking_location' => :'stock_picking_location'
  }
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_distribution_center.rb, line 96
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?(:'allocated_to_placed_orders')
    self.allocated_to_placed_orders = attributes[:'allocated_to_placed_orders']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/item_shipping_distribution_center.rb, line 76
def self.swagger_types
  {
    :'allocated_to_placed_orders' => :'Float',
    :'allocated_to_shopping_carts' => :'Float',
    :'available_to_allocate' => :'Float',
    :'desired_inventory_level' => :'Float',
    :'distribution_center_code' => :'String',
    :'distribution_center_oid' => :'Integer',
    :'eta' => :'String',
    :'handles' => :'BOOLEAN',
    :'inventory_level' => :'Float',
    :'maximum_backorder' => :'Integer',
    :'reorder_inventory_level' => :'Float',
    :'sku' => :'String',
    :'stock_picking_location' => :'String'
  }
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_distribution_center.rb, line 200
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allocated_to_placed_orders == o.allocated_to_placed_orders &&
      allocated_to_shopping_carts == o.allocated_to_shopping_carts &&
      available_to_allocate == o.available_to_allocate &&
      desired_inventory_level == o.desired_inventory_level &&
      distribution_center_code == o.distribution_center_code &&
      distribution_center_oid == o.distribution_center_oid &&
      eta == o.eta &&
      handles == o.handles &&
      inventory_level == o.inventory_level &&
      maximum_backorder == o.maximum_backorder &&
      reorder_inventory_level == o.reorder_inventory_level &&
      sku == o.sku &&
      stock_picking_location == o.stock_picking_location
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_distribution_center.rb, line 254
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_distribution_center.rb, line 320
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_distribution_center.rb, line 233
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_distribution_center.rb, line 220
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_distribution_center.rb, line 226
def hash
  [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, desired_inventory_level, distribution_center_code, distribution_center_oid, eta, handles, inventory_level, maximum_backorder, reorder_inventory_level, sku, stock_picking_location].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_distribution_center.rb, line 157
def list_invalid_properties
  invalid_properties = Array.new
  if !@sku.nil? && @sku.to_s.length > 50
    invalid_properties.push('invalid value for "sku", the character length must be smaller than or equal to 50.')
  end

  if !@stock_picking_location.nil? && @stock_picking_location.to_s.length > 20
    invalid_properties.push('invalid value for "stock_picking_location", the character length must be smaller than or equal to 20.')
  end

  invalid_properties
end
sku=(sku) click to toggle source

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

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

  @sku = sku
end
stock_picking_location=(stock_picking_location) click to toggle source

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

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

  @stock_picking_location = stock_picking_location
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_distribution_center.rb, line 300
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_distribution_center.rb, line 306
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_distribution_center.rb, line 294
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_distribution_center.rb, line 172
def valid?
  return false if !@sku.nil? && @sku.to_s.length > 50
  return false if !@stock_picking_location.nil? && @stock_picking_location.to_s.length > 20
  true
end