class CyberSource::V2paymentsRecipientInformation

Attributes

account_id[RW]

Identifier for the recipient’s account. Use the first six digits and last four digits of the recipient’s account number. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.

last_name[RW]

Recipient’s last name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.

postal_code[RW]

Partial postal code for the recipient’s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: NN5. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 27
def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'last_name' => :'lastName',
    :'postal_code' => :'postalCode'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 46
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?(:'accountId')
    self.account_id = attributes[:'accountId']
  end

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

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

Attribute type mapping.

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 36
def self.swagger_types
  {
    :'account_id' => :'String',
    :'last_name' => :'String',
    :'postal_code' => :'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_client/models/v2payments_recipient_information.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      last_name == o.last_name &&
      postal_code == o.postal_code
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_client/models/v2payments_recipient_information.rb, line 169
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_client/models/v2payments_recipient_information.rb, line 235
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
account_id=(account_id) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 95
def account_id=(account_id)
  if !account_id.nil? && account_id.to_s.length > 10
    fail ArgumentError, 'invalid value for "account_id", the character length must be smaller than or equal to 10.'
  end

  @account_id = account_id
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_client/models/v2payments_recipient_information.rb, line 148
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
eql?(o) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 135
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cyberSource_client/models/v2payments_recipient_information.rb, line 141
def hash
  [account_id, last_name, postal_code].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_client/models/v2payments_recipient_information.rb, line 105
def last_name=(last_name)
  if !last_name.nil? && last_name.to_s.length > 6
    fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 6.'
  end

  @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_client/models/v2payments_recipient_information.rb, line 67
def list_invalid_properties
  invalid_properties = Array.new
  if !@account_id.nil? && @account_id.to_s.length > 10
    invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 10.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 6
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 6.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 6
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 6.')
  end

  invalid_properties
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_client/models/v2payments_recipient_information.rb, line 115
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 6
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 6.'
  end

  @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_client/models/v2payments_recipient_information.rb, line 215
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_client/models/v2payments_recipient_information.rb, line 221
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_client/models/v2payments_recipient_information.rb, line 209
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_client/models/v2payments_recipient_information.rb, line 86
def valid?
  return false if !@account_id.nil? && @account_id.to_s.length > 10
  return false if !@last_name.nil? && @last_name.to_s.length > 6
  return false if !@postal_code.nil? && @postal_code.to_s.length > 6
  true
end