class CyberSource::V2paymentsOrderInformationBillTo
Attributes
First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Building number in the street address. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource
Latin American Processing.
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 billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on Cielo.
Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Customer’s middle name.
Customer’s name suffix.
Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource
recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Customer's phone number type. For Payouts: This field may be sent only for FDC Compass. Possible Values - * day * home * night * work
Postal code for the billing address. 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 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Title.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 91 def self.attribute_map { :'first_name' => :'firstName', :'last_name' => :'lastName', :'middle_name' => :'middleName', :'name_suffix' => :'nameSuffix', :'title' => :'title', :'company' => :'company', :'address1' => :'address1', :'address2' => :'address2', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'postal_code' => :'postalCode', :'country' => :'country', :'district' => :'district', :'building_number' => :'buildingNumber', :'email' => :'email', :'phone_number' => :'phoneNumber', :'phone_type' => :'phoneType' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 138 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?(:'middleName') self.middle_name = attributes[:'middleName'] end if attributes.has_key?(:'nameSuffix') self.name_suffix = attributes[:'nameSuffix'] end if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'company') self.company = attributes[:'company'] 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?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'phoneType') self.phone_type = attributes[:'phoneType'] end end
Attribute type mapping.
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 114 def self.swagger_types { :'first_name' => :'String', :'last_name' => :'String', :'middle_name' => :'String', :'name_suffix' => :'String', :'title' => :'String', :'company' => :'String', :'address1' => :'String', :'address2' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'postal_code' => :'String', :'country' => :'String', :'district' => :'String', :'building_number' => :'String', :'email' => :'String', :'phone_number' => :'String', :'phone_type' => :'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_bill_to.rb, line 480 def ==(o) return true if self.equal?(o) self.class == o.class && first_name == o.first_name && last_name == o.last_name && middle_name == o.middle_name && name_suffix == o.name_suffix && title == o.title && company == o.company && 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 && email == o.email && phone_number == o.phone_number && phone_type == o.phone_type 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_bill_to.rb, line 538 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_bill_to.rb, line 604 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_client/models/v2payments_order_information_bill_to.rb, line 370 def address1=(address1) if !address1.nil? && address1.to_s.length > 60 fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 60.' end @address1 = address1 end
Custom attribute writer method with validation @param [Object] address2 Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 380 def address2=(address2) if !address2.nil? && address2.to_s.length > 60 fail ArgumentError, 'invalid value for "address2", the character length must be smaller than or equal to 60.' end @address2 = address2 end
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 400 def administrative_area=(administrative_area) if !administrative_area.nil? && administrative_area.to_s.length > 2 fail ArgumentError, 'invalid value for "administrative_area", the character length must be smaller than or equal to 2.' end @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_client/models/v2payments_order_information_bill_to.rb, line 517 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_client/models/v2payments_order_information_bill_to.rb, line 440 def building_number=(building_number) if !building_number.nil? && building_number.to_s.length > 256 fail ArgumentError, 'invalid value for "building_number", the character length must be smaller than or equal to 256.' end @building_number = building_number end
Custom attribute writer method with validation @param [Object] company Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 360 def company=(company) if !company.nil? && company.to_s.length > 60 fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 60.' end @company = company end
Custom attribute writer method with validation @param [Object] country Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 420 def country=(country) if !country.nil? && country.to_s.length > 2 fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.' end @country = country end
Custom attribute writer method with validation @param [Object] district Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 430 def district=(district) if !district.nil? && district.to_s.length > 50 fail ArgumentError, 'invalid value for "district", the character length must be smaller than or equal to 50.' end @district = district end
Custom attribute writer method with validation @param [Object] email Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 450 def email=(email) if !email.nil? && email.to_s.length > 255 fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 255.' end @email = email end
@see the `==` method @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 504 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] first_name
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 310 def first_name=(first_name) if !first_name.nil? && first_name.to_s.length > 60 fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 60.' end @first_name = first_name end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 510 def hash [first_name, last_name, middle_name, name_suffix, title, company, address1, address2, locality, administrative_area, postal_code, country, district, building_number, email, phone_number, phone_type].hash end
Custom attribute writer method with validation @param [Object] last_name
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 320 def last_name=(last_name) if !last_name.nil? && last_name.to_s.length > 60 fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 60.' end @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_client/models/v2payments_order_information_bill_to.rb, line 215 def list_invalid_properties invalid_properties = Array.new if !@first_name.nil? && @first_name.to_s.length > 60 invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 60.') end if !@last_name.nil? && @last_name.to_s.length > 60 invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 60.') end if !@middle_name.nil? && @middle_name.to_s.length > 60 invalid_properties.push('invalid value for "middle_name", the character length must be smaller than or equal to 60.') end if !@name_suffix.nil? && @name_suffix.to_s.length > 60 invalid_properties.push('invalid value for "name_suffix", the character length must be smaller than or equal to 60.') end if !@title.nil? && @title.to_s.length > 60 invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 60.') end if !@company.nil? && @company.to_s.length > 60 invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 60.') end if !@address1.nil? && @address1.to_s.length > 60 invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 60.') end if !@address2.nil? && @address2.to_s.length > 60 invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 60.') end if !@locality.nil? && @locality.to_s.length > 50 invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 50.') end if !@administrative_area.nil? && @administrative_area.to_s.length > 2 invalid_properties.push('invalid value for "administrative_area", the character length must be smaller than or equal to 2.') end if !@postal_code.nil? && @postal_code.to_s.length > 10 invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 10.') end if !@country.nil? && @country.to_s.length > 2 invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.') end if !@district.nil? && @district.to_s.length > 50 invalid_properties.push('invalid value for "district", the character length must be smaller than or equal to 50.') end if !@building_number.nil? && @building_number.to_s.length > 256 invalid_properties.push('invalid value for "building_number", the character length must be smaller than or equal to 256.') end if !@email.nil? && @email.to_s.length > 255 invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.') end if !@phone_number.nil? && @phone_number.to_s.length > 15 invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 15.') end invalid_properties end
Custom attribute writer method with validation @param [Object] locality Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 390 def locality=(locality) if !locality.nil? && locality.to_s.length > 50 fail ArgumentError, 'invalid value for "locality", the character length must be smaller than or equal to 50.' end @locality = locality end
Custom attribute writer method with validation @param [Object] middle_name
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 330 def middle_name=(middle_name) if !middle_name.nil? && middle_name.to_s.length > 60 fail ArgumentError, 'invalid value for "middle_name", the character length must be smaller than or equal to 60.' end @middle_name = middle_name end
Custom attribute writer method with validation @param [Object] name_suffix
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 340 def name_suffix=(name_suffix) if !name_suffix.nil? && name_suffix.to_s.length > 60 fail ArgumentError, 'invalid value for "name_suffix", the character length must be smaller than or equal to 60.' end @name_suffix = name_suffix end
Custom attribute writer method with validation @param [Object] phone_number
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 460 def phone_number=(phone_number) if !phone_number.nil? && phone_number.to_s.length > 15 fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 15.' end @phone_number = phone_number end
Custom attribute writer method checking allowed values (enum). @param [Object] phone_type
Object to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 470 def phone_type=(phone_type) validator = EnumAttributeValidator.new('String', ['day', 'home', 'night', 'work']) unless validator.valid?(phone_type) fail ArgumentError, 'invalid value for "phone_type", must be one of #{validator.allowable_values}.' end @phone_type = phone_type end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 410 def postal_code=(postal_code) if !postal_code.nil? && postal_code.to_s.length > 10 fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 10.' end @postal_code = postal_code end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_bill_to.rb, line 350 def title=(title) if !title.nil? && title.to_s.length > 60 fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 60.' end @title = title 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_bill_to.rb, line 590 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_bill_to.rb, line 578 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_bill_to.rb, line 286 def valid? return false if !@first_name.nil? && @first_name.to_s.length > 60 return false if !@last_name.nil? && @last_name.to_s.length > 60 return false if !@middle_name.nil? && @middle_name.to_s.length > 60 return false if !@name_suffix.nil? && @name_suffix.to_s.length > 60 return false if !@title.nil? && @title.to_s.length > 60 return false if !@company.nil? && @company.to_s.length > 60 return false if !@address1.nil? && @address1.to_s.length > 60 return false if !@address2.nil? && @address2.to_s.length > 60 return false if !@locality.nil? && @locality.to_s.length > 50 return false if !@administrative_area.nil? && @administrative_area.to_s.length > 2 return false if !@postal_code.nil? && @postal_code.to_s.length > 10 return false if !@country.nil? && @country.to_s.length > 2 return false if !@district.nil? && @district.to_s.length > 50 return false if !@building_number.nil? && @building_number.to_s.length > 256 return false if !@email.nil? && @email.to_s.length > 255 return false if !@phone_number.nil? && @phone_number.to_s.length > 15 phone_type_validator = EnumAttributeValidator.new('String', ['day', 'home', 'night', 'work']) return false unless phone_type_validator.valid?(@phone_type) true end