class ShipEngine::BulkRate
A bulk rate
Attributes
An array of errors that were returned while retrieving the bulk rate
A string that uniquely identifies the rate request
A string that uniquely identifies the shipment
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/bulk_rate.rb, line 32 def self.attribute_map { :'rate_request_id' => :'rate_request_id', :'shipment_id' => :'shipment_id', :'created_at' => :'created_at', :'status' => :'status', :'errors' => :'errors' } 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/bulk_rate.rb, line 160 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/bulk_rate.rb, line 61 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::BulkRate` 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?(:'rate_request_id') self.rate_request_id = attributes[:'rate_request_id'] end if attributes.key?(:'shipment_id') self.shipment_id = attributes[:'shipment_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'errors') if (value = attributes[:'errors']).is_a?(Array) self.errors = value end end end
List of attributes with nullable: true
# File lib/ship_engine/models/bulk_rate.rb, line 54 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ship_engine/models/bulk_rate.rb, line 43 def self.openapi_types { :'rate_request_id' => :'String', :'shipment_id' => :'String', :'created_at' => :'DateTime', :'status' => :'RateResponseStatus', :'errors' => :'Array<Error>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/bulk_rate.rb, line 135 def ==(o) return true if self.equal?(o) self.class == o.class && rate_request_id == o.rate_request_id && shipment_id == o.shipment_id && created_at == o.created_at && status == o.status && errors == o.errors 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/bulk_rate.rb, line 188 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/bulk_rate.rb, line 257 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/bulk_rate.rb, line 167 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/bulk_rate.rb, line 147 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/bulk_rate.rb, line 153 def hash [rate_request_id, shipment_id, created_at, status, errors].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/bulk_rate.rb, line 97 def list_invalid_properties invalid_properties = Array.new if @rate_request_id.nil? invalid_properties.push('invalid value for "rate_request_id", rate_request_id cannot be nil.') end if @shipment_id.nil? invalid_properties.push('invalid value for "shipment_id", shipment_id cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @errors.nil? invalid_properties.push('invalid value for "errors", errors 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/ship_engine/models/bulk_rate.rb, line 239 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/bulk_rate.rb, line 227 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/bulk_rate.rb, line 124 def valid? return false if @rate_request_id.nil? return false if @shipment_id.nil? return false if @created_at.nil? return false if @status.nil? return false if @errors.nil? true end