class CyberSource::Ptsv2payoutsSenderInformation
Attributes
Street address of sender. **Funds Disbursement** This value is the address of the originator sending the funds disbursement.
Sender’s state. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).
Country of sender. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). * CTV (3)
Sender’s date of birth in YYYYMMDD format. Required only for FDCCompass.
First name of sender (Optional). * CTV (14) * Paymentech (30)
Recipient last name (Optional). * CTV (14) * Paymentech (30)
City of sender. **Funds Disbursement** This value is the city of the originator sending the funds disbursement.
Recipient middle initial (Optional).
Name of sender. **Funds Disbursement** This value is the name of the originator sending the funds disbursement. * CTV, Paymentech (30)
Sender’s phone number. Required only for FDCCompass.
Sender’s postal code. Required only for FDCCompass.
Reference number generated by you that uniquely identifies the sender.
Customer's government-assigned tax identification number.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 59 def self.attribute_map { :'reference_number' => :'referenceNumber', :'account' => :'account', :'first_name' => :'firstName', :'middle_initial' => :'middleInitial', :'last_name' => :'lastName', :'name' => :'name', :'address1' => :'address1', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'country_code' => :'countryCode', :'postal_code' => :'postalCode', :'phone_number' => :'phoneNumber', :'date_of_birth' => :'dateOfBirth', :'vat_registration_number' => :'vatRegistrationNumber' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 100 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?(:'referenceNumber') self.reference_number = attributes[:'referenceNumber'] end if attributes.has_key?(:'account') self.account = attributes[:'account'] end if attributes.has_key?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'middleInitial') self.middle_initial = attributes[:'middleInitial'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'address1') self.address1 = attributes[:'address1'] 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?(:'countryCode') self.country_code = attributes[:'countryCode'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'dateOfBirth') self.date_of_birth = attributes[:'dateOfBirth'] end if attributes.has_key?(:'vatRegistrationNumber') self.vat_registration_number = attributes[:'vatRegistrationNumber'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 79 def self.swagger_types { :'reference_number' => :'String', :'account' => :'Ptsv2payoutsSenderInformationAccount', :'first_name' => :'String', :'middle_initial' => :'String', :'last_name' => :'String', :'name' => :'String', :'address1' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'country_code' => :'String', :'postal_code' => :'String', :'phone_number' => :'String', :'date_of_birth' => :'String', :'vat_registration_number' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 256 def ==(o) return true if self.equal?(o) self.class == o.class && reference_number == o.reference_number && account == o.account && first_name == o.first_name && middle_initial == o.middle_initial && last_name == o.last_name && name == o.name && address1 == o.address1 && locality == o.locality && administrative_area == o.administrative_area && country_code == o.country_code && postal_code == o.postal_code && phone_number == o.phone_number && date_of_birth == o.date_of_birth && vat_registration_number == o.vat_registration_number 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/ptsv2payouts_sender_information.rb, line 311 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/ptsv2payouts_sender_information.rb, line 377 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/ptsv2payouts_sender_information.rb, line 208 def address1=(address1) @address1 = address1 end
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 220 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/ptsv2payouts_sender_information.rb, line 290 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_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 226 def country_code=(country_code) @country_code = country_code end
Custom attribute writer method with validation @param [Object] date_of_birth
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 244 def date_of_birth=(date_of_birth) @date_of_birth = date_of_birth end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 277 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/ptsv2payouts_sender_information.rb, line 184 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/ptsv2payouts_sender_information.rb, line 283 def hash [reference_number, account, first_name, middle_initial, last_name, name, address1, locality, administrative_area, country_code, postal_code, phone_number, date_of_birth, vat_registration_number].hash end
Custom attribute writer method with validation @param [Object] last_name
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 196 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/ptsv2payouts_sender_information.rb, line 165 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/ptsv2payouts_sender_information.rb, line 214 def locality=(locality) @locality = locality end
Custom attribute writer method with validation @param [Object] middle_initial
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 190 def middle_initial=(middle_initial) @middle_initial = middle_initial end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 202 def name=(name) @name = name end
Custom attribute writer method with validation @param [Object] phone_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 238 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/ptsv2payouts_sender_information.rb, line 232 def postal_code=(postal_code) @postal_code = postal_code end
Custom attribute writer method with validation @param [Object] reference_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 178 def reference_number=(reference_number) @reference_number = reference_number 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/ptsv2payouts_sender_information.rb, line 363 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/ptsv2payouts_sender_information.rb, line 351 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/ptsv2payouts_sender_information.rb, line 172 def valid? true end
Custom attribute writer method with validation @param [Object] vat_registration_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb, line 250 def vat_registration_number=(vat_registration_number) @vat_registration_number = vat_registration_number end