class CyberSource::Riskv1decisionsOrderInformationShipTo

Attributes

address1[RW]

First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

address2[RW]

Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

administrative_area[RW]

State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

country[RW]

Country of the shipping address. Use the two-character [ISO Standard Country Codes.](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

destination_code[RW]

Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other

destination_types[RW]

Shipping destination of item. Example: Commercial, Residential, Store

first_name[RW]

First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.

last_name[RW]

Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.

locality[RW]

City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

method[RW]

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 Required for American Express SafeKey (U.S.).

phone_number[RW]

Phone number associated with the shipping address.

postal_code[RW]

Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. 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 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.

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/riskv1decisions_order_information_ship_to.rb, line 54
def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'destination_types' => :'destinationTypes',
    :'locality' => :'locality',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'phone_number' => :'phoneNumber',
    :'postal_code' => :'postalCode',
    :'destination_code' => :'destinationCode',
    :'method' => :'method'
  }
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/riskv1decisions_order_information_ship_to.rb, line 91
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?(:'address1')
    self.address1 = attributes[:'address1']
  end

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

  if attributes.has_key?(:'administrativeArea')
    self.administrative_area = attributes[:'administrativeArea']
  end

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

  if attributes.has_key?(:'destinationTypes')
    self.destination_types = attributes[:'destinationTypes']
  end

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

  if attributes.has_key?(:'firstName')
    self.first_name = attributes[:'firstName']
  end

  if attributes.has_key?(:'lastName')
    self.last_name = attributes[:'lastName']
  end

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

  if attributes.has_key?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  end

  if attributes.has_key?(:'destinationCode')
    self.destination_code = attributes[:'destinationCode']
  end

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 72
def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'destination_types' => :'String',
    :'locality' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'String',
    :'postal_code' => :'String',
    :'destination_code' => :'Integer',
    :'method' => :'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/riskv1decisions_order_information_ship_to.rb, line 227
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      administrative_area == o.administrative_area &&
      country == o.country &&
      destination_types == o.destination_types &&
      locality == o.locality &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      phone_number == o.phone_number &&
      postal_code == o.postal_code &&
      destination_code == o.destination_code &&
      method == o.method
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/riskv1decisions_order_information_ship_to.rb, line 280
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/riskv1decisions_order_information_ship_to.rb, line 346
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
address1=(address1) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 161
def address1=(address1)
  @address1 = address1
end
address2=(address2) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 167
def address2=(address2)
  @address2 = address2
end
administrative_area=(administrative_area) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 173
def administrative_area=(administrative_area)
  @administrative_area = administrative_area
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/riskv1decisions_order_information_ship_to.rb, line 259
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
country=(country) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 179
def country=(country)
  @country = country
end
destination_types=(destination_types) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 185
def destination_types=(destination_types)
  @destination_types = destination_types
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 246
def eql?(o)
  self == o
end
first_name=(first_name) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 197
def first_name=(first_name)
  @first_name = first_name
end
hash() click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 252
def hash
  [address1, address2, administrative_area, country, destination_types, locality, first_name, last_name, phone_number, postal_code, destination_code, method].hash
end
last_name=(last_name) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 203
def last_name=(last_name)
  @last_name = last_name
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/riskv1decisions_order_information_ship_to.rb, line 148
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
locality=(locality) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 191
def locality=(locality)
  @locality = locality
end
method=(method) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 221
def method=(method)
  @method = method
end
phone_number=(phone_number) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 209
def phone_number=(phone_number)
  @phone_number = phone_number
end
postal_code=(postal_code) click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb, line 215
def postal_code=(postal_code)
  @postal_code = 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/riskv1decisions_order_information_ship_to.rb, line 326
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/riskv1decisions_order_information_ship_to.rb, line 332
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/riskv1decisions_order_information_ship_to.rb, line 320
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/riskv1decisions_order_information_ship_to.rb, line 155
def valid?
  true
end