class OpenapiClient::CustomsItem
The customs declaration for a single item in the shipment.
Attributes
The two-letter [ISO 3166-1 country code](en.wikipedia.org/wiki/ISO_3166-1) where this item originated
A string that uniquely identifies the customs item
A description of the item
The [Harmonized Tariff Code](en.wikipedia.org/wiki/Harmonized_System) of this item.
The quantity of this item in the shipment.
The SKU (Stock Keeping Unit) of the customs item
Description of the Custom Item's SKU
The total value of the customs item
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/openapi_client/models/customs_item.rb, line 45 def self.attribute_map { :'customs_item_id' => :'customs_item_id', :'description' => :'description', :'quantity' => :'quantity', :'value' => :'value', :'harmonized_tariff_code' => :'harmonized_tariff_code', :'country_of_origin' => :'country_of_origin', :'unit_of_measure' => :'unit_of_measure', :'sku' => :'sku', :'sku_description' => :'sku_description' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/openapi_client/models/customs_item.rb, line 223 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/openapi_client/models/customs_item.rb, line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CustomsItem` 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 `OpenapiClient::CustomsItem`. 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?(:'customs_item_id') self.customs_item_id = attributes[:'customs_item_id'] end if attributes.key?(:'description') self.description = attributes[:'description'] else self.description = 'null' end if attributes.key?(:'quantity') self.quantity = attributes[:'quantity'] else self.quantity = 0 end if attributes.key?(:'value') self.value = attributes[:'value'] end if attributes.key?(:'harmonized_tariff_code') self.harmonized_tariff_code = attributes[:'harmonized_tariff_code'] else self.harmonized_tariff_code = 'null' end if attributes.key?(:'country_of_origin') self.country_of_origin = attributes[:'country_of_origin'] end if attributes.key?(:'unit_of_measure') self.unit_of_measure = attributes[:'unit_of_measure'] end if attributes.key?(:'sku') self.sku = attributes[:'sku'] end if attributes.key?(:'sku_description') self.sku_description = attributes[:'sku_description'] end end
List of attributes with nullable: true
# File lib/openapi_client/models/customs_item.rb, line 75 def self.openapi_nullable Set.new([ :'description', :'harmonized_tariff_code', :'country_of_origin', :'unit_of_measure', :'sku', :'sku_description' ]) end
Attribute type mapping.
# File lib/openapi_client/models/customs_item.rb, line 60 def self.openapi_types { :'customs_item_id' => :'String', :'description' => :'String', :'quantity' => :'Integer', :'value' => :'MonetaryValue', :'harmonized_tariff_code' => :'String', :'country_of_origin' => :'String', :'unit_of_measure' => :'String', :'sku' => :'String', :'sku_description' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/openapi_client/models/customs_item.rb, line 194 def ==(o) return true if self.equal?(o) self.class == o.class && customs_item_id == o.customs_item_id && description == o.description && quantity == o.quantity && value == o.value && harmonized_tariff_code == o.harmonized_tariff_code && country_of_origin == o.country_of_origin && unit_of_measure == o.unit_of_measure && sku == o.sku && sku_description == o.sku_description 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/openapi_client/models/customs_item.rb, line 251 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 OpenapiClient.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/openapi_client/models/customs_item.rb, line 320 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/openapi_client/models/customs_item.rb, line 230 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
Custom attribute writer method with validation @param [Object] description Value to be assigned
# File lib/openapi_client/models/customs_item.rb, line 174 def description=(description) if !description.nil? && description.to_s.length > 100 fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 100.' end @description = description end
@see the `==` method @param [Object] Object to be compared
# File lib/openapi_client/models/customs_item.rb, line 210 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/openapi_client/models/customs_item.rb, line 216 def hash [customs_item_id, description, quantity, value, harmonized_tariff_code, country_of_origin, unit_of_measure, sku, sku_description].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/openapi_client/models/customs_item.rb, line 146 def list_invalid_properties invalid_properties = Array.new if @customs_item_id.nil? invalid_properties.push('invalid value for "customs_item_id", customs_item_id cannot be nil.') end if !@description.nil? && @description.to_s.length > 100 invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.') end if !@quantity.nil? && @quantity < 0 invalid_properties.push('invalid value for "quantity", must be greater than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] quantity Value to be assigned
# File lib/openapi_client/models/customs_item.rb, line 184 def quantity=(quantity) if !quantity.nil? && quantity < 0 fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 0.' end @quantity = quantity end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/openapi_client/models/customs_item.rb, line 302 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/openapi_client/models/customs_item.rb, line 290 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/openapi_client/models/customs_item.rb, line 165 def valid? return false if @customs_item_id.nil? return false if !@description.nil? && @description.to_s.length > 100 return false if !@quantity.nil? && @quantity < 0 true end