class CyberSource::V2paymentsConsumerAuthenticationInformation

Attributes

cavv[RW]

Cardholder authentication verification value (CAVV).

cavv_algorithm[RW]

Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard SecureCode.

eci_raw[RW]

Raw electronic commerce indicator (ECI).

pares_status[RW]

Payer authentication response status.

ucaf_authentication_data[RW]

Universal cardholder authentication field (UCAF) data.

ucaf_collection_indicator[RW]

Universal cardholder authentication field (UCAF) collection indicator.

veres_enrolled[RW]

Verification response enrollment status.

xid[RW]

Transaction identifier.

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_consumer_authentication_information.rb, line 42
def self.attribute_map
  {
    :'cavv' => :'cavv',
    :'cavv_algorithm' => :'cavvAlgorithm',
    :'eci_raw' => :'eciRaw',
    :'pares_status' => :'paresStatus',
    :'veres_enrolled' => :'veresEnrolled',
    :'xid' => :'xid',
    :'ucaf_authentication_data' => :'ucafAuthenticationData',
    :'ucaf_collection_indicator' => :'ucafCollectionIndicator'
  }
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_consumer_authentication_information.rb, line 71
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?(:'cavv')
    self.cavv = attributes[:'cavv']
  end

  if attributes.has_key?(:'cavvAlgorithm')
    self.cavv_algorithm = attributes[:'cavvAlgorithm']
  end

  if attributes.has_key?(:'eciRaw')
    self.eci_raw = attributes[:'eciRaw']
  end

  if attributes.has_key?(:'paresStatus')
    self.pares_status = attributes[:'paresStatus']
  end

  if attributes.has_key?(:'veresEnrolled')
    self.veres_enrolled = attributes[:'veresEnrolled']
  end

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

  if attributes.has_key?(:'ucafAuthenticationData')
    self.ucaf_authentication_data = attributes[:'ucafAuthenticationData']
  end

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

Attribute type mapping.

# File lib/cyberSource_client/models/v2payments_consumer_authentication_information.rb, line 56
def self.swagger_types
  {
    :'cavv' => :'String',
    :'cavv_algorithm' => :'String',
    :'eci_raw' => :'String',
    :'pares_status' => :'String',
    :'veres_enrolled' => :'String',
    :'xid' => :'String',
    :'ucaf_authentication_data' => :'String',
    :'ucaf_collection_indicator' => :'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_consumer_authentication_information.rb, line 245
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cavv == o.cavv &&
      cavv_algorithm == o.cavv_algorithm &&
      eci_raw == o.eci_raw &&
      pares_status == o.pares_status &&
      veres_enrolled == o.veres_enrolled &&
      xid == o.xid &&
      ucaf_authentication_data == o.ucaf_authentication_data &&
      ucaf_collection_indicator == o.ucaf_collection_indicator
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_consumer_authentication_information.rb, line 294
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_consumer_authentication_information.rb, line 360
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
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_consumer_authentication_information.rb, line 273
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
cavv=(cavv) click to toggle source

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

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

  @cavv = cavv
end
cavv_algorithm=(cavv_algorithm) click to toggle source

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

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

  @cavv_algorithm = cavv_algorithm
end
eci_raw=(eci_raw) click to toggle source

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

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

  @eci_raw = eci_raw
end
eql?(o) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_consumer_authentication_information.rb, line 260
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_consumer_authentication_information.rb, line 266
def hash
  [cavv, cavv_algorithm, eci_raw, pares_status, veres_enrolled, xid, ucaf_authentication_data, ucaf_collection_indicator].hash
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_consumer_authentication_information.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  if !@cavv.nil? && @cavv.to_s.length > 40
    invalid_properties.push('invalid value for "cavv", the character length must be smaller than or equal to 40.')
  end

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

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

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

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

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

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

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

  invalid_properties
end
pares_status=(pares_status) click to toggle source

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

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

  @pares_status = pares_status
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_consumer_authentication_information.rb, line 340
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_consumer_authentication_information.rb, line 346
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_consumer_authentication_information.rb, line 334
def to_s
  to_hash.to_s
end
ucaf_authentication_data=(ucaf_authentication_data) click to toggle source

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

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

  @ucaf_authentication_data = ucaf_authentication_data
end
ucaf_collection_indicator=(ucaf_collection_indicator) click to toggle source

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

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

  @ucaf_collection_indicator = ucaf_collection_indicator
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_consumer_authentication_information.rb, line 151
def valid?
  return false if !@cavv.nil? && @cavv.to_s.length > 40
  return false if !@cavv_algorithm.nil? && @cavv_algorithm.to_s.length > 1
  return false if !@eci_raw.nil? && @eci_raw.to_s.length > 2
  return false if !@pares_status.nil? && @pares_status.to_s.length > 1
  return false if !@veres_enrolled.nil? && @veres_enrolled.to_s.length > 1
  return false if !@xid.nil? && @xid.to_s.length > 40
  return false if !@ucaf_authentication_data.nil? && @ucaf_authentication_data.to_s.length > 32
  return false if !@ucaf_collection_indicator.nil? && @ucaf_collection_indicator.to_s.length > 1
  true
end
veres_enrolled=(veres_enrolled) click to toggle source

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

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

  @veres_enrolled = veres_enrolled
end
xid=(xid) click to toggle source

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

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

  @xid = xid
end