class Plaid::CreditCardLiability

An object representing a credit card account.

Attributes

account_id[RW]

The ID of the account that this liability belongs to.

aprs[RW]

The various interest rates that apply to the account. APR information is not provided by all card issuers; if APR data is not available, this array will be empty.

is_overdue[RW]

true if a payment is currently overdue. Availability for this field is limited.

last_payment_amount[RW]

The amount of the last payment.

last_payment_date[RW]

The date of the last payment. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.

last_statement_balance[RW]

The total amount owed as of the last statement issued

last_statement_issue_date[RW]

The date of the last statement. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

minimum_payment_amount[RW]

The minimum payment due for the next billing cycle.

next_payment_due_date[RW]

The due date for the next payment. The due date is ‘null` if a payment is not expected. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/credit_card_liability.rb, line 62
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/credit_card_liability.rb, line 47
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'aprs' => :'aprs',
    :'is_overdue' => :'is_overdue',
    :'last_payment_amount' => :'last_payment_amount',
    :'last_payment_date' => :'last_payment_date',
    :'last_statement_issue_date' => :'last_statement_issue_date',
    :'last_statement_balance' => :'last_statement_balance',
    :'minimum_payment_amount' => :'minimum_payment_amount',
    :'next_payment_due_date' => :'next_payment_due_date'
  }
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/plaid/models/credit_card_liability.rb, line 198
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/plaid/models/credit_card_liability.rb, line 97
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CreditCardLiability` 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 `Plaid::CreditCardLiability`. 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?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

  if attributes.key?(:'aprs')
    if (value = attributes[:'aprs']).is_a?(Array)
      self.aprs = value
    end
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/plaid/models/credit_card_liability.rb, line 82
def self.openapi_nullable
  Set.new([
    :'account_id',
    :'is_overdue',
    :'last_payment_amount',
    :'last_payment_date',
    :'last_statement_issue_date',
    :'last_statement_balance',
    :'minimum_payment_amount',
    :'next_payment_due_date'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/credit_card_liability.rb, line 67
def self.openapi_types
  {
    :'account_id' => :'String',
    :'aprs' => :'Array<APR>',
    :'is_overdue' => :'Boolean',
    :'last_payment_amount' => :'Float',
    :'last_payment_date' => :'Date',
    :'last_statement_issue_date' => :'Date',
    :'last_statement_balance' => :'Float',
    :'minimum_payment_amount' => :'Float',
    :'next_payment_due_date' => :'Date'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/plaid/models/credit_card_liability.rb, line 169
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      aprs == o.aprs &&
      is_overdue == o.is_overdue &&
      last_payment_amount == o.last_payment_amount &&
      last_payment_date == o.last_payment_date &&
      last_statement_issue_date == o.last_statement_issue_date &&
      last_statement_balance == o.last_statement_balance &&
      minimum_payment_amount == o.minimum_payment_amount &&
      next_payment_due_date == o.next_payment_due_date
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/plaid/models/credit_card_liability.rb, line 229
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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/plaid/models/credit_card_liability.rb, line 300
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/plaid/models/credit_card_liability.rb, line 205
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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[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
  end

  self
end
eql?(o) click to toggle source

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

# File lib/plaid/models/credit_card_liability.rb, line 185
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/plaid/models/credit_card_liability.rb, line 191
def hash
  [account_id, aprs, is_overdue, last_payment_amount, last_payment_date, last_statement_issue_date, last_statement_balance, minimum_payment_amount, next_payment_due_date].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/plaid/models/credit_card_liability.rb, line 151
def list_invalid_properties
  invalid_properties = Array.new
  if @aprs.nil?
    invalid_properties.push('invalid value for "aprs", aprs 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/plaid/models/credit_card_liability.rb, line 276
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/plaid/models/credit_card_liability.rb, line 282
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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/plaid/models/credit_card_liability.rb, line 270
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/plaid/models/credit_card_liability.rb, line 162
def valid?
  return false if @aprs.nil?
  true
end