class AmzSpApi::FulfillmentOutboundApiModel::FulfillmentOrderItem

Item information for a fulfillment order.

Attributes

cancelled_quantity[RW]
displayable_comment[RW]

Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.

estimated_arrival_date[RW]
estimated_ship_date[RW]
fulfillment_network_sku[RW]

Amazon's fulfillment network SKU of the item.

gift_message[RW]

A message to the gift recipient, if applicable.

order_item_disposition[RW]

Indicates whether the item is sellable or unsellable.

per_unit_declared_value[RW]
per_unit_price[RW]
per_unit_tax[RW]
quantity[RW]
seller_fulfillment_order_item_id[RW]

A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation.

seller_sku[RW]

The seller SKU of the item.

unfulfillable_quantity[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 52
def self.attribute_map
  {
    :'seller_sku' => :'sellerSku',
    :'seller_fulfillment_order_item_id' => :'sellerFulfillmentOrderItemId',
    :'quantity' => :'quantity',
    :'gift_message' => :'giftMessage',
    :'displayable_comment' => :'displayableComment',
    :'fulfillment_network_sku' => :'fulfillmentNetworkSku',
    :'order_item_disposition' => :'orderItemDisposition',
    :'cancelled_quantity' => :'cancelledQuantity',
    :'unfulfillable_quantity' => :'unfulfillableQuantity',
    :'estimated_ship_date' => :'estimatedShipDate',
    :'estimated_arrival_date' => :'estimatedArrivalDate',
    :'per_unit_price' => :'perUnitPrice',
    :'per_unit_tax' => :'perUnitTax',
    :'per_unit_declared_value' => :'perUnitDeclaredValue'
  }
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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 243
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 99
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentOutboundApiModel::FulfillmentOrderItem` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::FulfillmentOutboundApiModel::FulfillmentOrderItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'seller_sku')
    self.seller_sku = attributes[:'seller_sku']
  end

  if attributes.key?(:'seller_fulfillment_order_item_id')
    self.seller_fulfillment_order_item_id = attributes[:'seller_fulfillment_order_item_id']
  end

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.key?(:'gift_message')
    self.gift_message = attributes[:'gift_message']
  end

  if attributes.key?(:'displayable_comment')
    self.displayable_comment = attributes[:'displayable_comment']
  end

  if attributes.key?(:'fulfillment_network_sku')
    self.fulfillment_network_sku = attributes[:'fulfillment_network_sku']
  end

  if attributes.key?(:'order_item_disposition')
    self.order_item_disposition = attributes[:'order_item_disposition']
  end

  if attributes.key?(:'cancelled_quantity')
    self.cancelled_quantity = attributes[:'cancelled_quantity']
  end

  if attributes.key?(:'unfulfillable_quantity')
    self.unfulfillable_quantity = attributes[:'unfulfillable_quantity']
  end

  if attributes.key?(:'estimated_ship_date')
    self.estimated_ship_date = attributes[:'estimated_ship_date']
  end

  if attributes.key?(:'estimated_arrival_date')
    self.estimated_arrival_date = attributes[:'estimated_arrival_date']
  end

  if attributes.key?(:'per_unit_price')
    self.per_unit_price = attributes[:'per_unit_price']
  end

  if attributes.key?(:'per_unit_tax')
    self.per_unit_tax = attributes[:'per_unit_tax']
  end

  if attributes.key?(:'per_unit_declared_value')
    self.per_unit_declared_value = attributes[:'per_unit_declared_value']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 92
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 72
def self.openapi_types
  {
    :'seller_sku' => :'Object',
    :'seller_fulfillment_order_item_id' => :'Object',
    :'quantity' => :'Object',
    :'gift_message' => :'Object',
    :'displayable_comment' => :'Object',
    :'fulfillment_network_sku' => :'Object',
    :'order_item_disposition' => :'Object',
    :'cancelled_quantity' => :'Object',
    :'unfulfillable_quantity' => :'Object',
    :'estimated_ship_date' => :'Object',
    :'estimated_arrival_date' => :'Object',
    :'per_unit_price' => :'Object',
    :'per_unit_tax' => :'Object',
    :'per_unit_declared_value' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 209
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seller_sku == o.seller_sku &&
      seller_fulfillment_order_item_id == o.seller_fulfillment_order_item_id &&
      quantity == o.quantity &&
      gift_message == o.gift_message &&
      displayable_comment == o.displayable_comment &&
      fulfillment_network_sku == o.fulfillment_network_sku &&
      order_item_disposition == o.order_item_disposition &&
      cancelled_quantity == o.cancelled_quantity &&
      unfulfillable_quantity == o.unfulfillable_quantity &&
      estimated_ship_date == o.estimated_ship_date &&
      estimated_arrival_date == o.estimated_arrival_date &&
      per_unit_price == o.per_unit_price &&
      per_unit_tax == o.per_unit_tax &&
      per_unit_declared_value == o.per_unit_declared_value
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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 273
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
    AmzSpApi::FulfillmentOutboundApiModel.const_get(type).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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 342
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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 250
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 230
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 236
def hash
  [seller_sku, seller_fulfillment_order_item_id, quantity, gift_message, displayable_comment, fulfillment_network_sku, order_item_disposition, cancelled_quantity, unfulfillable_quantity, estimated_ship_date, estimated_arrival_date, per_unit_price, per_unit_tax, per_unit_declared_value].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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 171
def list_invalid_properties
  invalid_properties = Array.new
  if @seller_sku.nil?
    invalid_properties.push('invalid value for "seller_sku", seller_sku cannot be nil.')
  end

  if @seller_fulfillment_order_item_id.nil?
    invalid_properties.push('invalid value for "seller_fulfillment_order_item_id", seller_fulfillment_order_item_id cannot be nil.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @cancelled_quantity.nil?
    invalid_properties.push('invalid value for "cancelled_quantity", cancelled_quantity cannot be nil.')
  end

  if @unfulfillable_quantity.nil?
    invalid_properties.push('invalid value for "unfulfillable_quantity", unfulfillable_quantity cannot be nil.')
  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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 318
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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 324
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 312
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/fulfillment-outbound-api-model/models/fulfillment_order_item.rb, line 198
def valid?
  return false if @seller_sku.nil?
  return false if @seller_fulfillment_order_item_id.nil?
  return false if @quantity.nil?
  return false if @cancelled_quantity.nil?
  return false if @unfulfillable_quantity.nil?
  true
end