class ShipEngine::Manifest
Used for combining packages into one scannable form that a carrier can use when picking up a large number of shipments
Attributes
A string that uniquely identifies the carrier
The date-time that the manifest was created
A string that uniquely identifies the form
A string that uniquely identifies the manifest
The date-time that the manifests shipments will be picked up
The number of shipments that are included in this manifest
A string that uniquely identifies the submission
A string that uniquely identifies the warehouse
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/manifest.rb, line 45 def self.attribute_map { :'manifest_id' => :'manifest_id', :'form_id' => :'form_id', :'created_at' => :'created_at', :'ship_date' => :'ship_date', :'shipments' => :'shipments', :'warehouse_id' => :'warehouse_id', :'submission_id' => :'submission_id', :'carrier_id' => :'carrier_id', :'manifest_download' => :'manifest_download' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ship_engine/models/manifest.rb, line 204 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/ship_engine/models/manifest.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::Manifest` 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| h[k.to_sym] = v } if attributes.key?(:'manifest_id') self.manifest_id = attributes[:'manifest_id'] end if attributes.key?(:'form_id') self.form_id = attributes[:'form_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'ship_date') self.ship_date = attributes[:'ship_date'] end if attributes.key?(:'shipments') self.shipments = attributes[:'shipments'] end if attributes.key?(:'warehouse_id') self.warehouse_id = attributes[:'warehouse_id'] end if attributes.key?(:'submission_id') self.submission_id = attributes[:'submission_id'] end if attributes.key?(:'carrier_id') self.carrier_id = attributes[:'carrier_id'] end if attributes.key?(:'manifest_download') self.manifest_download = attributes[:'manifest_download'] end end
List of attributes with nullable: true
# File lib/ship_engine/models/manifest.rb, line 75 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ship_engine/models/manifest.rb, line 60 def self.openapi_types { :'manifest_id' => :'String', :'form_id' => :'String', :'created_at' => :'DateTime', :'ship_date' => :'DateTime', :'shipments' => :'Integer', :'warehouse_id' => :'String', :'submission_id' => :'String', :'carrier_id' => :'String', :'manifest_download' => :'ManifestDownload' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/manifest.rb, line 175 def ==(o) return true if self.equal?(o) self.class == o.class && manifest_id == o.manifest_id && form_id == o.form_id && created_at == o.created_at && ship_date == o.ship_date && shipments == o.shipments && warehouse_id == o.warehouse_id && submission_id == o.submission_id && carrier_id == o.carrier_id && manifest_download == o.manifest_download 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/ship_engine/models/manifest.rb, line 232 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 ShipEngine.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/ship_engine/models/manifest.rb, line 301 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/ship_engine/models/manifest.rb, line 211 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]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ship_engine/models/manifest.rb, line 191 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/manifest.rb, line 197 def hash [manifest_id, form_id, created_at, ship_date, shipments, warehouse_id, submission_id, carrier_id, manifest_download].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ship_engine/models/manifest.rb, line 132 def list_invalid_properties invalid_properties = Array.new if !@shipments.nil? && @shipments < 1 invalid_properties.push('invalid value for "shipments", must be greater than or equal to 1.') end if !@submission_id.nil? && @submission_id.to_s.length < 1 invalid_properties.push('invalid value for "submission_id", the character length must be great than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] shipments Value to be assigned
# File lib/ship_engine/models/manifest.rb, line 155 def shipments=(shipments) if !shipments.nil? && shipments < 1 fail ArgumentError, 'invalid value for "shipments", must be greater than or equal to 1.' end @shipments = shipments end
Custom attribute writer method with validation @param [Object] submission_id
Value to be assigned
# File lib/ship_engine/models/manifest.rb, line 165 def submission_id=(submission_id) if !submission_id.nil? && submission_id.to_s.length < 1 fail ArgumentError, 'invalid value for "submission_id", the character length must be great than or equal to 1.' end @submission_id = submission_id end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ship_engine/models/manifest.rb, line 283 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/ship_engine/models/manifest.rb, line 271 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/ship_engine/models/manifest.rb, line 147 def valid? return false if !@shipments.nil? && @shipments < 1 return false if !@submission_id.nil? && @submission_id.to_s.length < 1 true end