class OpenapiClient::PaymentRegistration

Attributes

customer[RW]
device[RW]
issuer_response[RW]
merchant[RW]
merchant_ref[RW]

Merchant reference code. Used by FirstAPI and reflected in settlement records and webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction.

original_transaction_type[RW]

Defines the type of the original transaction that is being evaluated for the Fraud Score.

registration_method[RW]
transaction_type[RW]

Type of transaction merchant wants to process.

user_defined[RW]

A JSON object that can carry any additional information that might be helpful for fraud detection.

verification3ds[RW]
verification_avs[RW]
verification_cvv[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/payment_registration.rb, line 46
def self.attribute_map
  {
    :'merchant_ref' => :'merchantRef',
    :'transaction_type' => :'transactionType',
    :'customer' => :'customer',
    :'merchant' => :'merchant',
    :'device' => :'device',
    :'user_defined' => :'userDefined',
    :'original_transaction_type' => :'originalTransactionType',
    :'issuer_response' => :'issuerResponse',
    :'verification_avs' => :'verificationAvs',
    :'verification3ds' => :'verification3ds',
    :'verification_cvv' => :'verificationCvv',
    :'registration_method' => :'registrationMethod'
  }
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/openapi_client/models/payment_registration.rb, line 224
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/openapi_client/models/payment_registration.rb, line 90
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentRegistration` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PaymentRegistration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'merchant_ref')
    self.merchant_ref = attributes[:'merchant_ref']
  end

  if attributes.key?(:'transaction_type')
    self.transaction_type = attributes[:'transaction_type']
  end

  if attributes.key?(:'customer')
    self.customer = attributes[:'customer']
  end

  if attributes.key?(:'merchant')
    self.merchant = attributes[:'merchant']
  end

  if attributes.key?(:'device')
    self.device = attributes[:'device']
  end

  if attributes.key?(:'user_defined')
    self.user_defined = attributes[:'user_defined']
  end

  if attributes.key?(:'original_transaction_type')
    self.original_transaction_type = attributes[:'original_transaction_type']
  end

  if attributes.key?(:'issuer_response')
    self.issuer_response = attributes[:'issuer_response']
  end

  if attributes.key?(:'verification_avs')
    self.verification_avs = attributes[:'verification_avs']
  end

  if attributes.key?(:'verification3ds')
    self.verification3ds = attributes[:'verification3ds']
  end

  if attributes.key?(:'verification_cvv')
    self.verification_cvv = attributes[:'verification_cvv']
  end

  if attributes.key?(:'registration_method')
    self.registration_method = attributes[:'registration_method']
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/openapi_client/models/payment_registration.rb, line 82
def self.openapi_all_of
  [
  :'FraudRegistration'
  ]
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/payment_registration.rb, line 64
def self.openapi_types
  {
    :'merchant_ref' => :'String',
    :'transaction_type' => :'String',
    :'customer' => :'Customer',
    :'merchant' => :'Merchant',
    :'device' => :'FraudRegistrationDevice',
    :'user_defined' => :'Object',
    :'original_transaction_type' => :'String',
    :'issuer_response' => :'IssuerResponse',
    :'verification_avs' => :'VerificationAvs',
    :'verification3ds' => :'Verification3ds',
    :'verification_cvv' => :'VerificationCvv',
    :'registration_method' => :'RegistrationMethod'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/openapi_client/models/payment_registration.rb, line 192
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_ref == o.merchant_ref &&
      transaction_type == o.transaction_type &&
      customer == o.customer &&
      merchant == o.merchant &&
      device == o.device &&
      user_defined == o.user_defined &&
      original_transaction_type == o.original_transaction_type &&
      issuer_response == o.issuer_response &&
      verification_avs == o.verification_avs &&
      verification3ds == o.verification3ds &&
      verification_cvv == o.verification_cvv &&
      registration_method == o.registration_method
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/openapi_client/models/payment_registration.rb, line 252
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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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/openapi_client/models/payment_registration.rb, line 326
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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) 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/openapi_client/models/payment_registration.rb, line 231
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/payment_registration.rb, line 211
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/payment_registration.rb, line 217
def hash
  [merchant_ref, transaction_type, customer, merchant, device, user_defined, original_transaction_type, issuer_response, verification_avs, verification3ds, verification_cvv, registration_method].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/openapi_client/models/payment_registration.rb, line 154
def list_invalid_properties
  invalid_properties = Array.new
  if @transaction_type.nil?
    invalid_properties.push('invalid value for "transaction_type", transaction_type cannot be nil.')
  end

  if @customer.nil?
    invalid_properties.push('invalid value for "customer", customer cannot be nil.')
  end

  if @merchant.nil?
    invalid_properties.push('invalid value for "merchant", merchant cannot be nil.')
  end

  if @original_transaction_type.nil?
    invalid_properties.push('invalid value for "original_transaction_type", original_transaction_type cannot be nil.')
  end

  if @registration_method.nil?
    invalid_properties.push('invalid value for "registration_method", registration_method cannot be nil.')
  end

  invalid_properties
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/openapi_client/models/payment_registration.rb, line 302
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/payment_registration.rb, line 308
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/openapi_client/models/payment_registration.rb, line 296
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/openapi_client/models/payment_registration.rb, line 181
def valid?
  return false if @transaction_type.nil?
  return false if @customer.nil?
  return false if @merchant.nil?
  return false if @original_transaction_type.nil?
  return false if @registration_method.nil?
  true
end