class CyberSource::Vasv2taxOrderInformationBillTo
Attributes
First line of the billing street address. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.
Second line of the billing street address. #### Tax Calculation Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.
Credit card billing state or province. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.
Credit card billing country. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). If `orderInformation.shipTo.country` is not provided, `orderInformation.billTo.country` is used in its place. If `orderInformation.billTo.country` is set to `US` or `CA`, then `orderInformation.billTo.postalCode` and `orderInformation.billTo.administrativeArea` are also required. #### Tax Calculation Required for U.S., Canadian, international and value added taxes.
Credit card billing city. #### Tax Calculation Required for U.S. and Canadian taxes only. Not applicable to international and value added taxes.
Postal code for the billing address. The postal code must consist of 5 to 9 digits. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example: 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha] [numeric][numeric] Example: A1B 2C3 #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 36 def self.attribute_map { :'address1' => :'address1', :'address2' => :'address2', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'postal_code' => :'postalCode', :'country' => :'country' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 61 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?(:'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 end
Attribute type mapping.
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 48 def self.swagger_types { :'address1' => :'String', :'address2' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'postal_code' => :'String', :'country' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && address1 == o.address1 && address2 == o.address2 && locality == o.locality && administrative_area == o.administrative_area && postal_code == o.postal_code && country == o.country 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/vasv2tax_order_information_bill_to.rb, line 190 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/vasv2tax_order_information_bill_to.rb, line 256 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/vasv2tax_order_information_bill_to.rb, line 107 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/vasv2tax_order_information_bill_to.rb, line 113 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/vasv2tax_order_information_bill_to.rb, line 125 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/vasv2tax_order_information_bill_to.rb, line 169 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] country Value to be assigned
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 137 def country=(country) @country = country end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 156 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 162 def hash [address1, address2, locality, administrative_area, postal_code, country].hash 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/vasv2tax_order_information_bill_to.rb, line 94 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/vasv2tax_order_information_bill_to.rb, line 119 def locality=(locality) @locality = locality end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb, line 131 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/vasv2tax_order_information_bill_to.rb, line 242 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/vasv2tax_order_information_bill_to.rb, line 230 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/vasv2tax_order_information_bill_to.rb, line 101 def valid? true end