class OpenapiClient::PaymentCard

Payment card model.

Attributes

bin[RW]

The payment card BIN.

brand[RW]

Required only if using dual branded card.

card_function[RW]
cardholder_name[RW]

Name of the cardholder. Note - Only supported with request payload.

expiry_date[RW]
last4[RW]

The last 4 numbers of a payment card.

number[RW]

Payment card number.

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_card.rb, line 41
def self.attribute_map
  {
    :'number' => :'number',
    :'expiry_date' => :'expiryDate',
    :'security_code' => :'securityCode',
    :'card_function' => :'cardFunction',
    :'cardholder_name' => :'cardholderName',
    :'bin' => :'bin',
    :'last4' => :'last4',
    :'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_card.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_card.rb, line 70
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentCard` 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::PaymentCard`. 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?(:'number')
    self.number = attributes[:'number']
  end

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

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

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

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

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

  if attributes.key?(:'last4')
    self.last4 = attributes[:'last4']
  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_card.rb, line 55
def self.openapi_types
  {
    :'number' => :'String',
    :'expiry_date' => :'Expiration',
    :'security_code' => :'String',
    :'card_function' => :'CardFunction',
    :'cardholder_name' => :'String',
    :'bin' => :'String',
    :'last4' => :'String',
    :'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_card.rb, line 196
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number == o.number &&
      expiry_date == o.expiry_date &&
      security_code == o.security_code &&
      card_function == o.card_function &&
      cardholder_name == o.cardholder_name &&
      bin == o.bin &&
      last4 == o.last4 &&
      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_card.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_card.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_card.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
cardholder_name=(cardholder_name) click to toggle source

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

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

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

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

# File lib/openapi_client/models/payment_card.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_card.rb, line 217
def hash
  [number, expiry_date, security_code, card_function, cardholder_name, bin, last4, 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_card.rb, line 118
def list_invalid_properties
  invalid_properties = Array.new
  if @number.nil?
    invalid_properties.push('invalid value for "number", number cannot be nil.')
  end

  pattern = Regexp.new(/[0-9]{13,19}/)
  if @number !~ pattern
    invalid_properties.push("invalid value for \"number\", 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

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

  invalid_properties
end
number=(number) click to toggle source

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

# File lib/openapi_client/models/payment_card.rb, line 157
def number=(number)
  if number.nil?
    fail ArgumentError, 'number cannot be nil'
  end

  pattern = Regexp.new(/[0-9]{13,19}/)
  if number !~ pattern
    fail ArgumentError, "invalid value for \"number\", must conform to the pattern #{pattern}."
  end

  @number = number
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_card.rb, line 172
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_card.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_card.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_card.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_card.rb, line 146
def valid?
  return false if @number.nil?
  return false if @number !~ Regexp.new(/[0-9]{13,19}/)
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  return false if !@security_code.nil? && @security_code.to_s.length < 3
  return false if !@cardholder_name.nil? && @cardholder_name.to_s.length > 96
  true
end