class Conekta::ShippingRequest
Attributes
Shipping amount in cents
Carrier name for the shipment
Hash where the user can send additional information for each ‘shipping’.
Method of shipment
Tracking number can be used to track the shipment
Public Class Methods
Source
# File lib/conekta/models/shipping_request.rb, line 215 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Conekta.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/conekta/models/shipping_request.rb, line 45 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/conekta/models/shipping_request.rb, line 34 def self.attribute_map { :'amount' => :'amount', :'carrier' => :'carrier', :'tracking_number' => :'tracking_number', :'method' => :'method', :'metadata' => :'metadata' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/conekta/models/shipping_request.rb, line 191 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/conekta/models/shipping_request.rb, line 68 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::ShippingRequest` 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 `Conekta::ShippingRequest`. 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?(:'amount') self.amount = attributes[:'amount'] else self.amount = nil end if attributes.key?(:'carrier') self.carrier = attributes[:'carrier'] end if attributes.key?(:'tracking_number') self.tracking_number = attributes[:'tracking_number'] end if attributes.key?(:'method') self.method = attributes[:'method'] end if attributes.key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/conekta/models/shipping_request.rb, line 61 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/conekta/models/shipping_request.rb, line 50 def self.openapi_types { :'amount' => :'Integer', :'carrier' => :'String', :'tracking_number' => :'String', :'method' => :'String', :'metadata' => :'Hash<String, Object>' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/conekta/models/shipping_request.rb, line 166 def ==(o) return true if self.equal?(o) self.class == o.class && amount == o.amount && carrier == o.carrier && tracking_number == o.tracking_number && method == o.method && metadata == o.metadata end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/conekta/models/shipping_request.rb, line 286 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
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
Source
# File lib/conekta/models/shipping_request.rb, line 138 def amount=(amount) if amount.nil? fail ArgumentError, 'amount cannot be nil' end if amount < 0 fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.' end @amount = amount end
Custom attribute writer method with validation @param [Object] amount Value to be assigned
Source
# File lib/conekta/models/shipping_request.rb, line 178 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/conekta/models/shipping_request.rb, line 184 def hash [amount, carrier, tracking_number, method, metadata].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/conekta/models/shipping_request.rb, line 108 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @amount < 0 invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.') end if !@metadata.nil? && @metadata.length > 100 invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/conekta/models/shipping_request.rb, line 152 def metadata=(metadata) if metadata.nil? fail ArgumentError, 'metadata cannot be nil' end if metadata.length > 100 fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.' end @metadata = metadata end
Custom attribute writer method with validation @param [Object] metadata Value to be assigned
Source
Source
# File lib/conekta/models/shipping_request.rb, line 268 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/conekta/models/shipping_request.rb, line 256 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/conekta/models/shipping_request.rb, line 128 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @amount.nil? return false if @amount < 0 return false if !@metadata.nil? && @metadata.length > 100 true end
Check to see if the all the properties in the model are valid @return true if the model is valid