class ShipEngine::UpsInvoice
UPS invoice
Attributes
A string that uniquely identifies the control
invoice date
invoice number
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/ups_invoice.rb, line 30 def self.attribute_map { :'invoice_date' => :'invoice_date', :'invoice_number' => :'invoice_number', :'control_id' => :'control_id', :'invoice_amount' => :'invoice_amount' } 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/ups_invoice.rb, line 154 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/ups_invoice.rb, line 57 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::UpsInvoice` 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?(:'invoice_date') self.invoice_date = attributes[:'invoice_date'] end if attributes.key?(:'invoice_number') self.invoice_number = attributes[:'invoice_number'] end if attributes.key?(:'control_id') self.control_id = attributes[:'control_id'] end if attributes.key?(:'invoice_amount') self.invoice_amount = attributes[:'invoice_amount'] end end
List of attributes with nullable: true
# File lib/ship_engine/models/ups_invoice.rb, line 50 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ship_engine/models/ups_invoice.rb, line 40 def self.openapi_types { :'invoice_date' => :'DateTime', :'invoice_number' => :'String', :'control_id' => :'String', :'invoice_amount' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/ups_invoice.rb, line 130 def ==(o) return true if self.equal?(o) self.class == o.class && invoice_date == o.invoice_date && invoice_number == o.invoice_number && control_id == o.control_id && invoice_amount == o.invoice_amount 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/ups_invoice.rb, line 182 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/ups_invoice.rb, line 251 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/ups_invoice.rb, line 161 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/ups_invoice.rb, line 141 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/ups_invoice.rb, line 147 def hash [invoice_date, invoice_number, control_id, invoice_amount].hash end
Custom attribute writer method with validation @param [Object] invoice_amount
Value to be assigned
# File lib/ship_engine/models/ups_invoice.rb, line 120 def invoice_amount=(invoice_amount) if !invoice_amount.nil? && invoice_amount < 0 fail ArgumentError, 'invalid value for "invoice_amount", must be greater than or equal to 0.' end @invoice_amount = invoice_amount end
Custom attribute writer method with validation @param [Object] invoice_number
Value to be assigned
# File lib/ship_engine/models/ups_invoice.rb, line 110 def invoice_number=(invoice_number) if !invoice_number.nil? && invoice_number.to_s.length < 1 fail ArgumentError, 'invalid value for "invoice_number", the character length must be great than or equal to 1.' end @invoice_number = invoice_number 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/ups_invoice.rb, line 87 def list_invalid_properties invalid_properties = Array.new if !@invoice_number.nil? && @invoice_number.to_s.length < 1 invalid_properties.push('invalid value for "invoice_number", the character length must be great than or equal to 1.') end if !@invoice_amount.nil? && @invoice_amount < 0 invalid_properties.push('invalid value for "invoice_amount", must be greater than or equal to 0.') 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/ups_invoice.rb, line 233 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/ups_invoice.rb, line 221 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/ups_invoice.rb, line 102 def valid? return false if !@invoice_number.nil? && @invoice_number.to_s.length < 1 return false if !@invoice_amount.nil? && @invoice_amount < 0 true end