class AmzSpApi::FulfillmentInboundApiModel::InboundShipmentPlan
Inbound shipment information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation.
Attributes
An Amazon fulfillment center identifier created by Amazon.
A shipment identifier originally returned by the createInboundShipmentPlan operation.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 32 def self.attribute_map { :'shipment_id' => :'ShipmentId', :'destination_fulfillment_center_id' => :'DestinationFulfillmentCenterId', :'ship_to_address' => :'ShipToAddress', :'label_prep_type' => :'LabelPrepType', :'items' => :'Items', :'estimated_box_contents_fee' => :'EstimatedBoxContentsFee' } end
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_plan.rb, line 167 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 63 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentInboundApiModel::InboundShipmentPlan` 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::InboundShipmentPlan`. 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?(:'destination_fulfillment_center_id') self.destination_fulfillment_center_id = attributes[:'destination_fulfillment_center_id'] end if attributes.key?(:'ship_to_address') self.ship_to_address = attributes[:'ship_to_address'] end if attributes.key?(:'label_prep_type') self.label_prep_type = attributes[:'label_prep_type'] end if attributes.key?(:'items') self.items = attributes[:'items'] end if attributes.key?(:'estimated_box_contents_fee') self.estimated_box_contents_fee = attributes[:'estimated_box_contents_fee'] end end
List of attributes with nullable: true
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 56 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 44 def self.openapi_types { :'shipment_id' => :'Object', :'destination_fulfillment_center_id' => :'Object', :'ship_to_address' => :'Object', :'label_prep_type' => :'Object', :'items' => :'Object', :'estimated_box_contents_fee' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 141 def ==(o) return true if self.equal?(o) self.class == o.class && shipment_id == o.shipment_id && destination_fulfillment_center_id == o.destination_fulfillment_center_id && ship_to_address == o.ship_to_address && label_prep_type == o.label_prep_type && items == o.items && estimated_box_contents_fee == o.estimated_box_contents_fee end
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_plan.rb, line 197 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
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_plan.rb, line 266 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
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_plan.rb, line 174 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
@see the `==` method @param [Object] Object to be compared
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 154 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 160 def hash [shipment_id, destination_fulfillment_center_id, ship_to_address, label_prep_type, items, estimated_box_contents_fee].hash end
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_plan.rb, line 103 def list_invalid_properties invalid_properties = Array.new if @shipment_id.nil? invalid_properties.push('invalid value for "shipment_id", shipment_id cannot be nil.') end if @destination_fulfillment_center_id.nil? invalid_properties.push('invalid value for "destination_fulfillment_center_id", destination_fulfillment_center_id cannot be nil.') end if @ship_to_address.nil? invalid_properties.push('invalid value for "ship_to_address", ship_to_address cannot be nil.') end if @label_prep_type.nil? invalid_properties.push('invalid value for "label_prep_type", label_prep_type cannot be nil.') end if @items.nil? invalid_properties.push('invalid value for "items", items cannot be nil.') end invalid_properties end
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_plan.rb, line 248 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/fulfillment-inbound-api-model/models/inbound_shipment_plan.rb, line 236 def to_s to_hash.to_s end
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_plan.rb, line 130 def valid? return false if @shipment_id.nil? return false if @destination_fulfillment_center_id.nil? return false if @ship_to_address.nil? return false if @label_prep_type.nil? return false if @items.nil? true end