class CyberSource::Ptsv2paymentsOrderInformationShipTo
Attributes
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.
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.
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.
Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187
Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
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.
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
Shipping destination of item. Example: Commercial, Residential, Store
Neighborhood, community, or region within a city or municipality.
First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
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.
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 associated with the shipping address.
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 mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 63 def self.attribute_map { :'first_name' => :'firstName', :'last_name' => :'lastName', :'address1' => :'address1', :'address2' => :'address2', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'postal_code' => :'postalCode', :'country' => :'country', :'district' => :'district', :'building_number' => :'buildingNumber', :'phone_number' => :'phoneNumber', :'company' => :'company', :'destination_types' => :'destinationTypes', :'destination_code' => :'destinationCode', :'method' => :'method' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 106 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?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'administrativeArea') self.administrative_area = attributes[:'administrativeArea'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'district') self.district = attributes[:'district'] end if attributes.has_key?(:'buildingNumber') self.building_number = attributes[:'buildingNumber'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'company') self.company = attributes[:'company'] end if attributes.has_key?(:'destinationTypes') self.destination_types = attributes[:'destinationTypes'] end if attributes.has_key?(:'destinationCode') self.destination_code = attributes[:'destinationCode'] end if attributes.has_key?(:'method') self.method = attributes[:'method'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 84 def self.swagger_types { :'first_name' => :'String', :'last_name' => :'String', :'address1' => :'String', :'address2' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'postal_code' => :'String', :'country' => :'String', :'district' => :'String', :'building_number' => :'String', :'phone_number' => :'String', :'company' => :'String', :'destination_types' => :'String', :'destination_code' => :'Integer', :'method' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 272 def ==(o) return true if self.equal?(o) self.class == o.class && first_name == o.first_name && last_name == o.last_name && address1 == o.address1 && address2 == o.address2 && locality == o.locality && administrative_area == o.administrative_area && postal_code == o.postal_code && country == o.country && district == o.district && building_number == o.building_number && phone_number == o.phone_number && company == o.company && destination_types == o.destination_types && destination_code == o.destination_code && method == o.method 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_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 328 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_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 394 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
Custom attribute writer method with validation @param [Object] address1 Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 200 def address1=(address1) @address1 = address1 end
Custom attribute writer method with validation @param [Object] address2 Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 206 def address2=(address2) @address2 = address2 end
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 218 def administrative_area=(administrative_area) @administrative_area = administrative_area 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_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 307 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
Custom attribute writer method with validation @param [Object] building_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 242 def building_number=(building_number) @building_number = building_number end
Custom attribute writer method with validation @param [Object] company Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 254 def company=(company) @company = company end
Custom attribute writer method with validation @param [Object] country Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 230 def country=(country) @country = country end
Custom attribute writer method with validation @param [Object] destination_types
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 260 def destination_types=(destination_types) @destination_types = destination_types end
Custom attribute writer method with validation @param [Object] district Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 236 def district=(district) @district = district end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 294 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] first_name
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 188 def first_name=(first_name) @first_name = first_name end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 300 def hash [first_name, last_name, address1, address2, locality, administrative_area, postal_code, country, district, building_number, phone_number, company, destination_types, destination_code, method].hash end
Custom attribute writer method with validation @param [Object] last_name
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 194 def last_name=(last_name) @last_name = last_name end
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/ptsv2payments_order_information_ship_to.rb, line 175 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] locality Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 212 def locality=(locality) @locality = locality end
Custom attribute writer method with validation @param [Object] method Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 266 def method=(method) @method = method end
Custom attribute writer method with validation @param [Object] phone_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 248 def phone_number=(phone_number) @phone_number = phone_number end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 224 def postal_code=(postal_code) @postal_code = postal_code end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 380 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_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 368 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_rest_client/models/ptsv2payments_order_information_ship_to.rb, line 182 def valid? true end