class AmzSpApi::FulfillmentInboundApiModel::InboundShipmentInfo

Information about the seller's inbound shipments. Returned by the listInboundShipments operation.

Attributes

are_cases_required[RW]

Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.

box_contents_source[RW]
confirmed_need_by_date[RW]
destination_fulfillment_center_id[RW]

An Amazon fulfillment center identifier created by Amazon.

estimated_box_contents_fee[RW]
label_prep_type[RW]
ship_from_address[RW]
shipment_id[RW]

The shipment identifier submitted in the request.

shipment_name[RW]

The name for the inbound shipment.

shipment_status[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/fulfillment-inbound-api-model/models/inbound_shipment_info.rb, line 42
def self.attribute_map
  {
    :'shipment_id' => :'ShipmentId',
    :'shipment_name' => :'ShipmentName',
    :'ship_from_address' => :'ShipFromAddress',
    :'destination_fulfillment_center_id' => :'DestinationFulfillmentCenterId',
    :'shipment_status' => :'ShipmentStatus',
    :'label_prep_type' => :'LabelPrepType',
    :'are_cases_required' => :'AreCasesRequired',
    :'confirmed_need_by_date' => :'ConfirmedNeedByDate',
    :'box_contents_source' => :'BoxContentsSource',
    :'estimated_box_contents_fee' => :'EstimatedBoxContentsFee'
  }
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-inbound-api-model/models/inbound_shipment_info.rb, line 190
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-inbound-api-model/models/inbound_shipment_info.rb, line 81
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentInboundApiModel::InboundShipmentInfo` 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::FulfillmentInboundApiModel::InboundShipmentInfo`. 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?(:'shipment_id')
    self.shipment_id = attributes[:'shipment_id']
  end

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/fulfillment-inbound-api-model/models/inbound_shipment_info.rb, line 58
def self.openapi_types
  {
    :'shipment_id' => :'Object',
    :'shipment_name' => :'Object',
    :'ship_from_address' => :'Object',
    :'destination_fulfillment_center_id' => :'Object',
    :'shipment_status' => :'Object',
    :'label_prep_type' => :'Object',
    :'are_cases_required' => :'Object',
    :'confirmed_need_by_date' => :'Object',
    :'box_contents_source' => :'Object',
    :'estimated_box_contents_fee' => :'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-inbound-api-model/models/inbound_shipment_info.rb, line 160
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipment_id == o.shipment_id &&
      shipment_name == o.shipment_name &&
      ship_from_address == o.ship_from_address &&
      destination_fulfillment_center_id == o.destination_fulfillment_center_id &&
      shipment_status == o.shipment_status &&
      label_prep_type == o.label_prep_type &&
      are_cases_required == o.are_cases_required &&
      confirmed_need_by_date == o.confirmed_need_by_date &&
      box_contents_source == o.box_contents_source &&
      estimated_box_contents_fee == o.estimated_box_contents_fee
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-inbound-api-model/models/inbound_shipment_info.rb, line 220
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::FulfillmentInboundApiModel.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-inbound-api-model/models/inbound_shipment_info.rb, line 289
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-inbound-api-model/models/inbound_shipment_info.rb, line 197
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-inbound-api-model/models/inbound_shipment_info.rb, line 177
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-inbound-api-model/models/inbound_shipment_info.rb, line 183
def hash
  [shipment_id, shipment_name, ship_from_address, destination_fulfillment_center_id, shipment_status, label_prep_type, are_cases_required, confirmed_need_by_date, box_contents_source, estimated_box_contents_fee].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-inbound-api-model/models/inbound_shipment_info.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if @ship_from_address.nil?
    invalid_properties.push('invalid value for "ship_from_address", ship_from_address cannot be nil.')
  end

  if @are_cases_required.nil?
    invalid_properties.push('invalid value for "are_cases_required", are_cases_required 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-inbound-api-model/models/inbound_shipment_info.rb, line 265
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-inbound-api-model/models/inbound_shipment_info.rb, line 271
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-inbound-api-model/models/inbound_shipment_info.rb, line 259
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-inbound-api-model/models/inbound_shipment_info.rb, line 152
def valid?
  return false if @ship_from_address.nil?
  return false if @are_cases_required.nil?
  true
end