class CyberSource::V2paymentsOrderInformationShippingDetails
Attributes
TBD
Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource
account. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: `[5 digits][4 digits]` Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: `[alpha][alpha] [numeric][numeric]` Example A1B 2C3 This field is frequently used for Level II and Level III transactions.
Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 27 def self.attribute_map { :'gift_wrap' => :'giftWrap', :'shipping_method' => :'shippingMethod', :'ship_from_postal_code' => :'shipFromPostalCode' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 46 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'giftWrap') self.gift_wrap = attributes[:'giftWrap'] end if attributes.has_key?(:'shippingMethod') self.shipping_method = attributes[:'shippingMethod'] end if attributes.has_key?(:'shipFromPostalCode') self.ship_from_postal_code = attributes[:'shipFromPostalCode'] end end
Attribute type mapping.
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 36 def self.swagger_types { :'gift_wrap' => :'BOOLEAN', :'shipping_method' => :'String', :'ship_from_postal_code' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 110 def ==(o) return true if self.equal?(o) self.class == o.class && gift_wrap == o.gift_wrap && shipping_method == o.shipping_method && ship_from_postal_code == o.ship_from_postal_code 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/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 154 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 temp_model = CyberSource.const_get(type).new temp_model.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/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 220 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/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 133 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 120 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 126 def hash [gift_wrap, shipping_method, ship_from_postal_code].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 67 def list_invalid_properties invalid_properties = Array.new if !@shipping_method.nil? && @shipping_method.to_s.length > 10 invalid_properties.push('invalid value for "shipping_method", the character length must be smaller than or equal to 10.') end if !@ship_from_postal_code.nil? && @ship_from_postal_code.to_s.length > 10 invalid_properties.push('invalid value for "ship_from_postal_code", the character length must be smaller than or equal to 10.') end invalid_properties end
Custom attribute writer method with validation @param [Object] ship_from_postal_code
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 100 def ship_from_postal_code=(ship_from_postal_code) if !ship_from_postal_code.nil? && ship_from_postal_code.to_s.length > 10 fail ArgumentError, 'invalid value for "ship_from_postal_code", the character length must be smaller than or equal to 10.' end @ship_from_postal_code = ship_from_postal_code end
Custom attribute writer method with validation @param [Object] shipping_method
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 90 def shipping_method=(shipping_method) if !shipping_method.nil? && shipping_method.to_s.length > 10 fail ArgumentError, 'invalid value for "shipping_method", the character length must be smaller than or equal to 10.' end @shipping_method = shipping_method end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 206 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 194 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/cyberSource_client/models/v2payments_order_information_shipping_details.rb, line 82 def valid? return false if !@shipping_method.nil? && @shipping_method.to_s.length > 10 return false if !@ship_from_postal_code.nil? && @ship_from_postal_code.to_s.length > 10 true end