class Atrium::Account

Attributes

account_number[RW]
apr[RW]
apy[RW]
available_balance[RW]
available_credit[RW]
balance[RW]
cash_balance[RW]
cash_surrender_value[RW]
created_at[RW]
credit_limit[RW]
currency_code[RW]
day_payment_is_due[RW]
death_benefit[RW]
guid[RW]
holdings_value[RW]
institution_code[RW]
insured_name[RW]
interest_rate[RW]
is_closed[RW]
last_payment[RW]
last_payment_at[RW]
loan_amount[RW]
matures_on[RW]
member_guid[RW]
minimum_balance[RW]
minimum_payment[RW]
name[RW]
original_balance[RW]
pay_out_amount[RW]
payment_due_at[RW]
payoff_balance[RW]
premium_amount[RW]
started_on[RW]
subtype[RW]
total_account_value[RW]
type[RW]
updated_at[RW]
user_guid[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/atrium-ruby/models/account.rb, line 90
def self.attribute_map
  {
    :'account_number' => :'account_number',
    :'apr' => :'apr',
    :'apy' => :'apy',
    :'available_balance' => :'available_balance',
    :'available_credit' => :'available_credit',
    :'balance' => :'balance',
    :'cash_balance' => :'cash_balance',
    :'cash_surrender_value' => :'cash_surrender_value',
    :'created_at' => :'created_at',
    :'credit_limit' => :'credit_limit',
    :'currency_code' => :'currency_code',
    :'day_payment_is_due' => :'day_payment_is_due',
    :'death_benefit' => :'death_benefit',
    :'guid' => :'guid',
    :'holdings_value' => :'holdings_value',
    :'insured_name' => :'insured_name',
    :'institution_code' => :'institution_code',
    :'interest_rate' => :'interest_rate',
    :'is_closed' => :'is_closed',
    :'last_payment' => :'last_payment',
    :'last_payment_at' => :'last_payment_at',
    :'loan_amount' => :'loan_amount',
    :'matures_on' => :'matures_on',
    :'member_guid' => :'member_guid',
    :'minimum_balance' => :'minimum_balance',
    :'minimum_payment' => :'minimum_payment',
    :'name' => :'name',
    :'original_balance' => :'original_balance',
    :'payment_due_at' => :'payment_due_at',
    :'payoff_balance' => :'payoff_balance',
    :'pay_out_amount' => :'pay_out_amount',
    :'premium_amount' => :'premium_amount',
    :'started_on' => :'started_on',
    :'subtype' => :'subtype',
    :'total_account_value' => :'total_account_value',
    :'type' => :'type',
    :'updated_at' => :'updated_at',
    :'user_guid' => :'user_guid'
  }
end
mx_types() click to toggle source

Attribute type mapping.

# File lib/atrium-ruby/models/account.rb, line 134
def self.mx_types
  {
    :'account_number' => :'String',
    :'apr' => :'Float',
    :'apy' => :'Float',
    :'available_balance' => :'Float',
    :'available_credit' => :'Float',
    :'balance' => :'Float',
    :'cash_balance' => :'Float',
    :'cash_surrender_value' => :'Float',
    :'created_at' => :'String',
    :'credit_limit' => :'Float',
    :'currency_code' => :'String',
    :'day_payment_is_due' => :'Integer',
    :'death_benefit' => :'Float',
    :'guid' => :'String',
    :'holdings_value' => :'Float',
    :'insured_name' => :'String',
    :'institution_code' => :'String',
    :'interest_rate' => :'Float',
    :'is_closed' => :'BOOLEAN',
    :'last_payment' => :'Float',
    :'last_payment_at' => :'String',
    :'loan_amount' => :'Float',
    :'matures_on' => :'String',
    :'member_guid' => :'String',
    :'minimum_balance' => :'Float',
    :'minimum_payment' => :'Float',
    :'name' => :'String',
    :'original_balance' => :'Float',
    :'payment_due_at' => :'String',
    :'payoff_balance' => :'Float',
    :'pay_out_amount' => :'Float',
    :'premium_amount' => :'Float',
    :'started_on' => :'String',
    :'subtype' => :'String',
    :'total_account_value' => :'Float',
    :'type' => :'String',
    :'updated_at' => :'String',
    :'user_guid' => :'String'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/atrium-ruby/models/account.rb, line 179
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?(:'account_number')
    self.account_number = attributes[:'account_number']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Instance Methods

==(o) click to toggle source

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

# File lib/atrium-ruby/models/account.rb, line 353
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_number == o.account_number &&
      apr == o.apr &&
      apy == o.apy &&
      available_balance == o.available_balance &&
      available_credit == o.available_credit &&
      balance == o.balance &&
      cash_balance == o.cash_balance &&
      cash_surrender_value == o.cash_surrender_value &&
      created_at == o.created_at &&
      credit_limit == o.credit_limit &&
      currency_code == o.currency_code &&
      day_payment_is_due == o.day_payment_is_due &&
      death_benefit == o.death_benefit &&
      guid == o.guid &&
      holdings_value == o.holdings_value &&
      insured_name == o.insured_name &&
      institution_code == o.institution_code &&
      interest_rate == o.interest_rate &&
      is_closed == o.is_closed &&
      last_payment == o.last_payment &&
      last_payment_at == o.last_payment_at &&
      loan_amount == o.loan_amount &&
      matures_on == o.matures_on &&
      member_guid == o.member_guid &&
      minimum_balance == o.minimum_balance &&
      minimum_payment == o.minimum_payment &&
      name == o.name &&
      original_balance == o.original_balance &&
      payment_due_at == o.payment_due_at &&
      payoff_balance == o.payoff_balance &&
      pay_out_amount == o.pay_out_amount &&
      premium_amount == o.premium_amount &&
      started_on == o.started_on &&
      subtype == o.subtype &&
      total_account_value == o.total_account_value &&
      type == o.type &&
      updated_at == o.updated_at &&
      user_guid == o.user_guid
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/atrium-ruby/models/account.rb, line 432
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 = Atrium.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/atrium-ruby/models/account.rb, line 498
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/atrium-ruby/models/account.rb, line 411
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.mx_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
eql?(o) click to toggle source

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

# File lib/atrium-ruby/models/account.rb, line 398
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/atrium-ruby/models/account.rb, line 404
def hash
  [account_number, apr, apy, available_balance, available_credit, balance, cash_balance, cash_surrender_value, created_at, credit_limit, currency_code, day_payment_is_due, death_benefit, guid, holdings_value, insured_name, institution_code, interest_rate, is_closed, last_payment, last_payment_at, loan_amount, matures_on, member_guid, minimum_balance, minimum_payment, name, original_balance, payment_due_at, payoff_balance, pay_out_amount, premium_amount, started_on, subtype, total_account_value, type, updated_at, user_guid].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/atrium-ruby/models/account.rb, line 340
def list_invalid_properties
  invalid_properties = Array.new
  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/atrium-ruby/models/account.rb, line 478
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/atrium-ruby/models/account.rb, line 484
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/atrium-ruby/models/account.rb, line 472
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/atrium-ruby/models/account.rb, line 347
def valid?
  true
end