fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/line_of_credit_account_entity.rb

@@ -0,0 +1,474 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxApi
+  # A line of credit account
+  class LineOfCreditAccountEntity < AccountEntity
+    # As-of date for balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Credit limit
+    # @return [Float]
+    attr_accessor :credit_line
+
+    # Available credit
+    # @return [Float]
+    attr_accessor :available_credit
+
+    # Amount of next payment
+    # @return [Float]
+    attr_accessor :next_payment_amount
+
+    # Due date of next payment
+    # @return [Date]
+    attr_accessor :next_payment_date
+
+    # Principal balance
+    # @return [Float]
+    attr_accessor :principal_balance
+
+    # Current balance of the line of credit
+    # @return [Float]
+    attr_accessor :current_balance
+
+    # Minimum payment amount, which is due at the date specified in
+    # `nextPaymentDate`
+    # @return [Float]
+    attr_accessor :minimum_payment_amount
+
+    # Last payment amount
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # Last payment date
+    # @return [Date]
+    attr_accessor :last_payment_date
+
+    # Past Due Amount
+    # @return [Float]
+    attr_accessor :past_due_amount
+
+    # Last Statement Balance
+    # @return [Float]
+    attr_accessor :last_stmt_balance
+
+    # Last Statement Date
+    # @return [Date]
+    attr_accessor :last_stmt_date
+
+    # Purchases APR
+    # @return [Float]
+    attr_accessor :purchases_apr
+
+    # Advances APR
+    # @return [Float]
+    attr_accessor :advances_apr
+
+    # Cash advance limit
+    # @return [Float]
+    attr_accessor :cash_advance_limit
+
+    # Available cash
+    # @return [Float]
+    attr_accessor :available_cash
+
+    # Finance charges
+    # @return [Float]
+    attr_accessor :finance_charges
+
+    # Card network, e.g. "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER",
+    # "INTERLINK", "STAR" etc.
+    # @return [String]
+    attr_accessor :card_network
+
+    # Any Art associated to the Card related to the account
+    # @return [CardArtEntity2]
+    attr_accessor :card_art
+
+    # Transactions on the line-of-credit account
+    # @return [Array[LineOfCreditTransactionEntity]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance_as_of'] = 'balanceAsOf'
+      @_hash['credit_line'] = 'creditLine'
+      @_hash['available_credit'] = 'availableCredit'
+      @_hash['next_payment_amount'] = 'nextPaymentAmount'
+      @_hash['next_payment_date'] = 'nextPaymentDate'
+      @_hash['principal_balance'] = 'principalBalance'
+      @_hash['current_balance'] = 'currentBalance'
+      @_hash['minimum_payment_amount'] = 'minimumPaymentAmount'
+      @_hash['last_payment_amount'] = 'lastPaymentAmount'
+      @_hash['last_payment_date'] = 'lastPaymentDate'
+      @_hash['past_due_amount'] = 'pastDueAmount'
+      @_hash['last_stmt_balance'] = 'lastStmtBalance'
+      @_hash['last_stmt_date'] = 'lastStmtDate'
+      @_hash['purchases_apr'] = 'purchasesApr'
+      @_hash['advances_apr'] = 'advancesApr'
+      @_hash['cash_advance_limit'] = 'cashAdvanceLimit'
+      @_hash['available_cash'] = 'availableCash'
+      @_hash['finance_charges'] = 'financeCharges'
+      @_hash['card_network'] = 'cardNetwork'
+      @_hash['card_art'] = 'cardArt'
+      @_hash['transactions'] = 'transactions'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        balance_as_of
+        credit_line
+        available_credit
+        next_payment_amount
+        next_payment_date
+        principal_balance
+        current_balance
+        minimum_payment_amount
+        last_payment_amount
+        last_payment_date
+        past_due_amount
+        last_stmt_balance
+        last_stmt_date
+        purchases_apr
+        advances_apr
+        cash_advance_limit
+        available_cash
+        finance_charges
+        card_network
+        card_art
+        transactions
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(balance_as_of: SKIP, credit_line: SKIP,
+                   available_credit: SKIP, next_payment_amount: SKIP,
+                   next_payment_date: SKIP, principal_balance: SKIP,
+                   current_balance: SKIP, minimum_payment_amount: SKIP,
+                   last_payment_amount: SKIP, last_payment_date: SKIP,
+                   past_due_amount: SKIP, last_stmt_balance: SKIP,
+                   last_stmt_date: SKIP, purchases_apr: SKIP,
+                   advances_apr: SKIP, cash_advance_limit: SKIP,
+                   available_cash: SKIP, finance_charges: SKIP,
+                   card_network: SKIP, card_art: SKIP, transactions: SKIP,
+                   parent_account_id: SKIP, line_of_business: SKIP,
+                   routing_transit_number: SKIP, balance_type: SKIP,
+                   contact: SKIP, interest_rate: SKIP, interest_rate_type: SKIP,
+                   interest_rate_as_of: SKIP, prior_interest_rate: SKIP,
+                   interest_rate_index: SKIP, early_penalty_flag: SKIP,
+                   transfer_in: SKIP, transfer_out: SKIP, bill_pay_status: SKIP,
+                   micr_number: SKIP, last_activity_date: SKIP,
+                   reward_program_id: SKIP, transactions_included: SKIP,
+                   domicile: SKIP,
+                   account_category: 'Line of Credit Account entity',
+                   account_id: SKIP, error: SKIP, account_type: SKIP,
+                   account_number: SKIP, account_number_display: SKIP,
+                   product_name: SKIP, nickname: SKIP, status: SKIP,
+                   description: SKIP, account_open_date: SKIP,
+                   account_close_date: SKIP, currency: SKIP,
+                   fi_attributes: SKIP, additional_properties: nil)
+      @balance_as_of = balance_as_of unless balance_as_of == SKIP
+      @credit_line = credit_line unless credit_line == SKIP
+      @available_credit = available_credit unless available_credit == SKIP
+      @next_payment_amount = next_payment_amount unless next_payment_amount == SKIP
+      @next_payment_date = next_payment_date unless next_payment_date == SKIP
+      @principal_balance = principal_balance unless principal_balance == SKIP
+      @current_balance = current_balance unless current_balance == SKIP
+      @minimum_payment_amount = minimum_payment_amount unless minimum_payment_amount == SKIP
+      @last_payment_amount = last_payment_amount unless last_payment_amount == SKIP
+      @last_payment_date = last_payment_date unless last_payment_date == SKIP
+      @past_due_amount = past_due_amount unless past_due_amount == SKIP
+      @last_stmt_balance = last_stmt_balance unless last_stmt_balance == SKIP
+      @last_stmt_date = last_stmt_date unless last_stmt_date == SKIP
+      @purchases_apr = purchases_apr unless purchases_apr == SKIP
+      @advances_apr = advances_apr unless advances_apr == SKIP
+      @cash_advance_limit = cash_advance_limit unless cash_advance_limit == SKIP
+      @available_cash = available_cash unless available_cash == SKIP
+      @finance_charges = finance_charges unless finance_charges == SKIP
+      @card_network = card_network unless card_network == SKIP
+      @card_art = card_art unless card_art == SKIP
+      @transactions = transactions unless transactions == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(parent_account_id: parent_account_id,
+            line_of_business: line_of_business,
+            routing_transit_number: routing_transit_number,
+            balance_type: balance_type,
+            contact: contact,
+            interest_rate: interest_rate,
+            interest_rate_type: interest_rate_type,
+            interest_rate_as_of: interest_rate_as_of,
+            prior_interest_rate: prior_interest_rate,
+            interest_rate_index: interest_rate_index,
+            early_penalty_flag: early_penalty_flag,
+            transfer_in: transfer_in,
+            transfer_out: transfer_out,
+            bill_pay_status: bill_pay_status,
+            micr_number: micr_number,
+            last_activity_date: last_activity_date,
+            reward_program_id: reward_program_id,
+            transactions_included: transactions_included,
+            domicile: domicile,
+            account_category: account_category,
+            account_id: account_id,
+            error: error,
+            account_type: account_type,
+            account_number: account_number,
+            account_number_display: account_number_display,
+            product_name: product_name,
+            nickname: nickname,
+            status: status,
+            description: description,
+            account_open_date: account_open_date,
+            account_close_date: account_close_date,
+            currency: currency,
+            fi_attributes: fi_attributes,
+            additional_properties: additional_properties)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      balance_as_of = if hash.key?('balanceAsOf')
+                        (DateTimeHelper.from_rfc3339(hash['balanceAsOf']) if hash['balanceAsOf'])
+                      else
+                        SKIP
+                      end
+      credit_line = hash.key?('creditLine') ? hash['creditLine'] : SKIP
+      available_credit =
+        hash.key?('availableCredit') ? hash['availableCredit'] : SKIP
+      next_payment_amount =
+        hash.key?('nextPaymentAmount') ? hash['nextPaymentAmount'] : SKIP
+      next_payment_date =
+        hash.key?('nextPaymentDate') ? hash['nextPaymentDate'] : SKIP
+      principal_balance =
+        hash.key?('principalBalance') ? hash['principalBalance'] : SKIP
+      current_balance =
+        hash.key?('currentBalance') ? hash['currentBalance'] : SKIP
+      minimum_payment_amount =
+        hash.key?('minimumPaymentAmount') ? hash['minimumPaymentAmount'] : SKIP
+      last_payment_amount =
+        hash.key?('lastPaymentAmount') ? hash['lastPaymentAmount'] : SKIP
+      last_payment_date =
+        hash.key?('lastPaymentDate') ? hash['lastPaymentDate'] : SKIP
+      past_due_amount =
+        hash.key?('pastDueAmount') ? hash['pastDueAmount'] : SKIP
+      last_stmt_balance =
+        hash.key?('lastStmtBalance') ? hash['lastStmtBalance'] : SKIP
+      last_stmt_date = hash.key?('lastStmtDate') ? hash['lastStmtDate'] : SKIP
+      purchases_apr = hash.key?('purchasesApr') ? hash['purchasesApr'] : SKIP
+      advances_apr = hash.key?('advancesApr') ? hash['advancesApr'] : SKIP
+      cash_advance_limit =
+        hash.key?('cashAdvanceLimit') ? hash['cashAdvanceLimit'] : SKIP
+      available_cash = hash.key?('availableCash') ? hash['availableCash'] : SKIP
+      finance_charges =
+        hash.key?('financeCharges') ? hash['financeCharges'] : SKIP
+      card_network = hash.key?('cardNetwork') ? hash['cardNetwork'] : SKIP
+      card_art = CardArtEntity2.from_hash(hash['cardArt']) if hash['cardArt']
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (LineOfCreditTransactionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      parent_account_id =
+        hash.key?('parentAccountId') ? hash['parentAccountId'] : SKIP
+      line_of_business =
+        hash.key?('lineOfBusiness') ? hash['lineOfBusiness'] : SKIP
+      routing_transit_number =
+        hash.key?('routingTransitNumber') ? hash['routingTransitNumber'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      contact = AccountContactEntity2.from_hash(hash['contact']) if hash['contact']
+      interest_rate = hash.key?('interestRate') ? hash['interestRate'] : SKIP
+      interest_rate_type =
+        hash.key?('interestRateType') ? hash['interestRateType'] : SKIP
+      interest_rate_as_of = if hash.key?('interestRateAsOf')
+                              (DateTimeHelper.from_rfc3339(hash['interestRateAsOf']) if hash['interestRateAsOf'])
+                            else
+                              SKIP
+                            end
+      prior_interest_rate =
+        hash.key?('priorInterestRate') ? hash['priorInterestRate'] : SKIP
+      interest_rate_index =
+        hash.key?('interestRateIndex') ? hash['interestRateIndex'] : SKIP
+      early_penalty_flag =
+        hash.key?('earlyPenaltyFlag') ? hash['earlyPenaltyFlag'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : SKIP
+      bill_pay_status =
+        hash.key?('billPayStatus') ? hash['billPayStatus'] : SKIP
+      micr_number = hash.key?('micrNumber') ? hash['micrNumber'] : SKIP
+      last_activity_date =
+        hash.key?('lastActivityDate') ? hash['lastActivityDate'] : SKIP
+      reward_program_id =
+        hash.key?('rewardProgramId') ? hash['rewardProgramId'] : SKIP
+      transactions_included =
+        hash.key?('transactionsIncluded') ? hash['transactionsIncluded'] : SKIP
+      domicile = DomicileEntity1.from_hash(hash['domicile']) if hash['domicile']
+      account_category =
+        hash['accountCategory'] ||= 'Line of Credit Account entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      error = Error1.from_hash(hash['error']) if hash['error']
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_number_display =
+        hash.key?('accountNumberDisplay') ? hash['accountNumberDisplay'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      account_open_date =
+        hash.key?('accountOpenDate') ? hash['accountOpenDate'] : SKIP
+      account_close_date =
+        hash.key?('accountCloseDate') ? hash['accountCloseDate'] : SKIP
+      currency = CurrencyEntity4.from_hash(hash['currency']) if hash['currency']
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LineOfCreditAccountEntity.new(balance_as_of: balance_as_of,
+                                    credit_line: credit_line,
+                                    available_credit: available_credit,
+                                    next_payment_amount: next_payment_amount,
+                                    next_payment_date: next_payment_date,
+                                    principal_balance: principal_balance,
+                                    current_balance: current_balance,
+                                    minimum_payment_amount: minimum_payment_amount,
+                                    last_payment_amount: last_payment_amount,
+                                    last_payment_date: last_payment_date,
+                                    past_due_amount: past_due_amount,
+                                    last_stmt_balance: last_stmt_balance,
+                                    last_stmt_date: last_stmt_date,
+                                    purchases_apr: purchases_apr,
+                                    advances_apr: advances_apr,
+                                    cash_advance_limit: cash_advance_limit,
+                                    available_cash: available_cash,
+                                    finance_charges: finance_charges,
+                                    card_network: card_network,
+                                    card_art: card_art,
+                                    transactions: transactions,
+                                    parent_account_id: parent_account_id,
+                                    line_of_business: line_of_business,
+                                    routing_transit_number: routing_transit_number,
+                                    balance_type: balance_type,
+                                    contact: contact,
+                                    interest_rate: interest_rate,
+                                    interest_rate_type: interest_rate_type,
+                                    interest_rate_as_of: interest_rate_as_of,
+                                    prior_interest_rate: prior_interest_rate,
+                                    interest_rate_index: interest_rate_index,
+                                    early_penalty_flag: early_penalty_flag,
+                                    transfer_in: transfer_in,
+                                    transfer_out: transfer_out,
+                                    bill_pay_status: bill_pay_status,
+                                    micr_number: micr_number,
+                                    last_activity_date: last_activity_date,
+                                    reward_program_id: reward_program_id,
+                                    transactions_included: transactions_included,
+                                    domicile: domicile,
+                                    account_category: account_category,
+                                    account_id: account_id,
+                                    error: error,
+                                    account_type: account_type,
+                                    account_number: account_number,
+                                    account_number_display: account_number_display,
+                                    product_name: product_name,
+                                    nickname: nickname,
+                                    status: status,
+                                    description: description,
+                                    account_open_date: account_open_date,
+                                    account_close_date: account_close_date,
+                                    currency: currency,
+                                    fi_attributes: fi_attributes,
+                                    additional_properties: additional_properties)
+    end
+
+    def to_custom_balance_as_of
+      DateTimeHelper.to_rfc3339(balance_as_of)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LineOfCreditAccountEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, balance_as_of: #{@balance_as_of}, credit_line:"\
+      " #{@credit_line}, available_credit: #{@available_credit}, next_payment_amount:"\
+      " #{@next_payment_amount}, next_payment_date: #{@next_payment_date}, principal_balance:"\
+      " #{@principal_balance}, current_balance: #{@current_balance}, minimum_payment_amount:"\
+      " #{@minimum_payment_amount}, last_payment_amount: #{@last_payment_amount},"\
+      " last_payment_date: #{@last_payment_date}, past_due_amount: #{@past_due_amount},"\
+      " last_stmt_balance: #{@last_stmt_balance}, last_stmt_date: #{@last_stmt_date},"\
+      " purchases_apr: #{@purchases_apr}, advances_apr: #{@advances_apr}, cash_advance_limit:"\
+      " #{@cash_advance_limit}, available_cash: #{@available_cash}, finance_charges:"\
+      " #{@finance_charges}, card_network: #{@card_network}, card_art: #{@card_art}, transactions:"\
+      " #{@transactions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, balance_as_of: #{@balance_as_of.inspect}, credit_line:"\
+      " #{@credit_line.inspect}, available_credit: #{@available_credit.inspect},"\
+      " next_payment_amount: #{@next_payment_amount.inspect}, next_payment_date:"\
+      " #{@next_payment_date.inspect}, principal_balance: #{@principal_balance.inspect},"\
+      " current_balance: #{@current_balance.inspect}, minimum_payment_amount:"\
+      " #{@minimum_payment_amount.inspect}, last_payment_amount: #{@last_payment_amount.inspect},"\
+      " last_payment_date: #{@last_payment_date.inspect}, past_due_amount:"\
+      " #{@past_due_amount.inspect}, last_stmt_balance: #{@last_stmt_balance.inspect},"\
+      " last_stmt_date: #{@last_stmt_date.inspect}, purchases_apr: #{@purchases_apr.inspect},"\
+      " advances_apr: #{@advances_apr.inspect}, cash_advance_limit:"\
+      " #{@cash_advance_limit.inspect}, available_cash: #{@available_cash.inspect},"\
+      " finance_charges: #{@finance_charges.inspect}, card_network: #{@card_network.inspect},"\
+      " card_art: #{@card_art.inspect}, transactions: #{@transactions.inspect}>"
+    end
+  end
+end