class CyberSource::Vasv2taxOrderInformationShippingDetails

Attributes

ship_from_administrative_area[RW]

State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

ship_from_country[RW]

Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes.

ship_from_locality[RW]

City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

ship_from_postal_code[RW]

Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 30
def self.attribute_map
  {
    :'ship_from_locality' => :'shipFromLocality',
    :'ship_from_country' => :'shipFromCountry',
    :'ship_from_postal_code' => :'shipFromPostalCode',
    :'ship_from_administrative_area' => :'shipFromAdministrativeArea'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 51
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?(:'shipFromLocality')
    self.ship_from_locality = attributes[:'shipFromLocality']
  end

  if attributes.has_key?(:'shipFromCountry')
    self.ship_from_country = attributes[:'shipFromCountry']
  end

  if attributes.has_key?(:'shipFromPostalCode')
    self.ship_from_postal_code = attributes[:'shipFromPostalCode']
  end

  if attributes.has_key?(:'shipFromAdministrativeArea')
    self.ship_from_administrative_area = attributes[:'shipFromAdministrativeArea']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 40
def self.swagger_types
  {
    :'ship_from_locality' => :'String',
    :'ship_from_country' => :'String',
    :'ship_from_postal_code' => :'String',
    :'ship_from_administrative_area' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 113
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ship_from_locality == o.ship_from_locality &&
      ship_from_country == o.ship_from_country &&
      ship_from_postal_code == o.ship_from_postal_code &&
      ship_from_administrative_area == o.ship_from_administrative_area
end
_deserialize(type, value) click to toggle source

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_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 158
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
_to_hash(value) click to toggle source

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_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 224
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 137
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 124
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 130
def hash
  [ship_from_locality, ship_from_country, ship_from_postal_code, ship_from_administrative_area].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 76
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
ship_from_administrative_area=(ship_from_administrative_area) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_administrative_area Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 107
def ship_from_administrative_area=(ship_from_administrative_area)
  @ship_from_administrative_area = ship_from_administrative_area
end
ship_from_country=(ship_from_country) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_country Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 95
def ship_from_country=(ship_from_country)
  @ship_from_country = ship_from_country
end
ship_from_locality=(ship_from_locality) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_locality Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 89
def ship_from_locality=(ship_from_locality)
  @ship_from_locality = ship_from_locality
end
ship_from_postal_code=(ship_from_postal_code) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_postal_code Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 101
def ship_from_postal_code=(ship_from_postal_code)
  @ship_from_postal_code = ship_from_postal_code
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 204
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 210
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 198
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb, line 83
def valid?
  true
end