class OpenapiClient::PaymentDevice

Information from the payment device including the blob data and its mode of entry.

Attributes

brand[RW]

The card brand.

card_function[RW]
cardholder_name[RW]

Name of cardholder.

data[RW]

Data from device containing, at a minimum, a transaction-unique key serial number (KSN) and track 2 card data.

device_type[RW]

The data format.

security_code[RW]

Card verification value/number.

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_device.rb, line 58
def self.attribute_map
  {
    :'device_type' => :'deviceType',
    :'data' => :'data',
    :'security_code' => :'securityCode',
    :'cardholder_name' => :'cardholderName',
    :'card_function' => :'cardFunction',
    :'brand' => :'brand'
  }
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_device.rb, line 229
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_device.rb, line 83
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentDevice` 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::PaymentDevice`. 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?(:'device_type')
    self.device_type = attributes[:'device_type']
  end

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

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

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

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

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

Attribute type mapping.

# File lib/openapi_client/models/payment_device.rb, line 70
def self.openapi_types
  {
    :'device_type' => :'String',
    :'data' => :'String',
    :'security_code' => :'String',
    :'cardholder_name' => :'String',
    :'card_function' => :'CardFunction',
    :'brand' => :'String'
  }
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_device.rb, line 203
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      device_type == o.device_type &&
      data == o.data &&
      security_code == o.security_code &&
      cardholder_name == o.cardholder_name &&
      card_function == o.card_function &&
      brand == o.brand
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_device.rb, line 257
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_device.rb, line 331
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_device.rb, line 236
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
data=(data) click to toggle source

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

# File lib/openapi_client/models/payment_device.rb, line 174
def data=(data)
  if data.nil?
    fail ArgumentError, 'data cannot be nil'
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if data !~ pattern
    fail ArgumentError, "invalid value for \"data\", must conform to the pattern #{pattern}."
  end

  @data = data
end
device_type=(device_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] device_type Object to be assigned

# File lib/openapi_client/models/payment_device.rb, line 164
def device_type=(device_type)
  validator = EnumAttributeValidator.new('String', ["SWIPE"])
  unless validator.valid?(device_type)
    fail ArgumentError, "invalid value for \"device_type\", must be one of #{validator.allowable_values}."
  end
  @device_type = device_type
end
eql?(o) click to toggle source

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

# File lib/openapi_client/models/payment_device.rb, line 216
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_device.rb, line 222
def hash
  [device_type, data, security_code, cardholder_name, card_function, brand].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_device.rb, line 123
def list_invalid_properties
  invalid_properties = Array.new
  if @device_type.nil?
    invalid_properties.push('invalid value for "device_type", device_type cannot be nil.')
  end

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @data !~ pattern
    invalid_properties.push("invalid value for \"data\", must conform to the pattern #{pattern}.")
  end

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

  if !@security_code.nil? && @security_code.to_s.length < 3
    invalid_properties.push('invalid value for "security_code", the character length must be great than or equal to 3.')
  end

  invalid_properties
end
security_code=(security_code) click to toggle source

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

# File lib/openapi_client/models/payment_device.rb, line 189
def security_code=(security_code)
  if !security_code.nil? && security_code.to_s.length > 4
    fail ArgumentError, 'invalid value for "security_code", the character length must be smaller than or equal to 4.'
  end

  if !security_code.nil? && security_code.to_s.length < 3
    fail ArgumentError, 'invalid value for "security_code", the character length must be great than or equal to 3.'
  end

  @security_code = security_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/openapi_client/models/payment_device.rb, line 307
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_device.rb, line 313
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_device.rb, line 301
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_device.rb, line 151
def valid?
  return false if @device_type.nil?
  device_type_validator = EnumAttributeValidator.new('String', ["SWIPE"])
  return false unless device_type_validator.valid?(@device_type)
  return false if @data.nil?
  return false if @data !~ Regexp.new(/^(?!\s*$).+/)
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  return false if !@security_code.nil? && @security_code.to_s.length < 3
  true
end