fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/loan_account_entity.rb

@@ -0,0 +1,432 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxApi
+  # A loan account type
+  class LoanAccountEntity < AccountEntity
+    # As-of date for balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Principal balance of loan
+    # @return [Float]
+    attr_accessor :principal_balance
+
+    # Escrow balance of loan
+    # @return [Float]
+    attr_accessor :escrow_balance
+
+    # Original principal of loan
+    # @return [Float]
+    attr_accessor :original_principal
+
+    # Loan origination date
+    # @return [Date]
+    attr_accessor :originating_date
+
+    # Term of loan in months
+    # @return [Integer]
+    attr_accessor :loan_term
+
+    # Total number of payments
+    # @return [Integer]
+    attr_accessor :total_number_of_payments
+
+    # Amount of next payment
+    # @return [Float]
+    attr_accessor :next_payment_amount
+
+    # Date of next payment
+    # @return [Date]
+    attr_accessor :next_payment_date
+
+    # DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
+    # @return [PaymentFrequency1]
+    attr_accessor :payment_frequency
+
+    # DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
+    # @return [CompoundingPeriod2]
+    attr_accessor :compounding_period
+
+    # Payoff amount
+    # @return [Float]
+    attr_accessor :pay_off_amount
+
+    # Last payment amount
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # Last payment date
+    # @return [Date]
+    attr_accessor :last_payment_date
+
+    # Maturity date
+    # @return [Date]
+    attr_accessor :maturity_date
+
+    # Interest paid year to date
+    # @return [Float]
+    attr_accessor :interest_paid_year_to_date
+
+    # Transactions on the loan account
+    # @return [Array[LoanTransactionEntity]]
+    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['principal_balance'] = 'principalBalance'
+      @_hash['escrow_balance'] = 'escrowBalance'
+      @_hash['original_principal'] = 'originalPrincipal'
+      @_hash['originating_date'] = 'originatingDate'
+      @_hash['loan_term'] = 'loanTerm'
+      @_hash['total_number_of_payments'] = 'totalNumberOfPayments'
+      @_hash['next_payment_amount'] = 'nextPaymentAmount'
+      @_hash['next_payment_date'] = 'nextPaymentDate'
+      @_hash['payment_frequency'] = 'paymentFrequency'
+      @_hash['compounding_period'] = 'compoundingPeriod'
+      @_hash['pay_off_amount'] = 'payOffAmount'
+      @_hash['last_payment_amount'] = 'lastPaymentAmount'
+      @_hash['last_payment_date'] = 'lastPaymentDate'
+      @_hash['maturity_date'] = 'maturityDate'
+      @_hash['interest_paid_year_to_date'] = 'interestPaidYearToDate'
+      @_hash['transactions'] = 'transactions'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        balance_as_of
+        principal_balance
+        escrow_balance
+        original_principal
+        originating_date
+        loan_term
+        total_number_of_payments
+        next_payment_amount
+        next_payment_date
+        payment_frequency
+        compounding_period
+        pay_off_amount
+        last_payment_amount
+        last_payment_date
+        maturity_date
+        interest_paid_year_to_date
+        transactions
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(balance_as_of: SKIP, principal_balance: SKIP,
+                   escrow_balance: SKIP, original_principal: SKIP,
+                   originating_date: SKIP, loan_term: SKIP,
+                   total_number_of_payments: SKIP, next_payment_amount: SKIP,
+                   next_payment_date: SKIP, payment_frequency: SKIP,
+                   compounding_period: SKIP, pay_off_amount: SKIP,
+                   last_payment_amount: SKIP, last_payment_date: SKIP,
+                   maturity_date: SKIP, interest_paid_year_to_date: 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: 'Loan 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
+      @principal_balance = principal_balance unless principal_balance == SKIP
+      @escrow_balance = escrow_balance unless escrow_balance == SKIP
+      @original_principal = original_principal unless original_principal == SKIP
+      @originating_date = originating_date unless originating_date == SKIP
+      @loan_term = loan_term unless loan_term == SKIP
+      @total_number_of_payments = total_number_of_payments unless total_number_of_payments == SKIP
+      @next_payment_amount = next_payment_amount unless next_payment_amount == SKIP
+      @next_payment_date = next_payment_date unless next_payment_date == SKIP
+      @payment_frequency = payment_frequency unless payment_frequency == SKIP
+      @compounding_period = compounding_period unless compounding_period == SKIP
+      @pay_off_amount = pay_off_amount unless pay_off_amount == SKIP
+      @last_payment_amount = last_payment_amount unless last_payment_amount == SKIP
+      @last_payment_date = last_payment_date unless last_payment_date == SKIP
+      @maturity_date = maturity_date unless maturity_date == SKIP
+      unless interest_paid_year_to_date == SKIP
+        @interest_paid_year_to_date =
+          interest_paid_year_to_date
+      end
+      @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
+      principal_balance =
+        hash.key?('principalBalance') ? hash['principalBalance'] : SKIP
+      escrow_balance = hash.key?('escrowBalance') ? hash['escrowBalance'] : SKIP
+      original_principal =
+        hash.key?('originalPrincipal') ? hash['originalPrincipal'] : SKIP
+      originating_date =
+        hash.key?('originatingDate') ? hash['originatingDate'] : SKIP
+      loan_term = hash.key?('loanTerm') ? hash['loanTerm'] : SKIP
+      total_number_of_payments =
+        hash.key?('totalNumberOfPayments') ? hash['totalNumberOfPayments'] : SKIP
+      next_payment_amount =
+        hash.key?('nextPaymentAmount') ? hash['nextPaymentAmount'] : SKIP
+      next_payment_date =
+        hash.key?('nextPaymentDate') ? hash['nextPaymentDate'] : SKIP
+      payment_frequency =
+        hash.key?('paymentFrequency') ? hash['paymentFrequency'] : SKIP
+      compounding_period =
+        hash.key?('compoundingPeriod') ? hash['compoundingPeriod'] : SKIP
+      pay_off_amount = hash.key?('payOffAmount') ? hash['payOffAmount'] : SKIP
+      last_payment_amount =
+        hash.key?('lastPaymentAmount') ? hash['lastPaymentAmount'] : SKIP
+      last_payment_date =
+        hash.key?('lastPaymentDate') ? hash['lastPaymentDate'] : SKIP
+      maturity_date = hash.key?('maturityDate') ? hash['maturityDate'] : SKIP
+      interest_paid_year_to_date =
+        hash.key?('interestPaidYearToDate') ? hash['interestPaidYearToDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (LoanTransactionEntity.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'] ||= 'Loan 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.
+      LoanAccountEntity.new(balance_as_of: balance_as_of,
+                            principal_balance: principal_balance,
+                            escrow_balance: escrow_balance,
+                            original_principal: original_principal,
+                            originating_date: originating_date,
+                            loan_term: loan_term,
+                            total_number_of_payments: total_number_of_payments,
+                            next_payment_amount: next_payment_amount,
+                            next_payment_date: next_payment_date,
+                            payment_frequency: payment_frequency,
+                            compounding_period: compounding_period,
+                            pay_off_amount: pay_off_amount,
+                            last_payment_amount: last_payment_amount,
+                            last_payment_date: last_payment_date,
+                            maturity_date: maturity_date,
+                            interest_paid_year_to_date: interest_paid_year_to_date,
+                            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 [LoanAccountEntity | 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}, principal_balance:"\
+      " #{@principal_balance}, escrow_balance: #{@escrow_balance}, original_principal:"\
+      " #{@original_principal}, originating_date: #{@originating_date}, loan_term: #{@loan_term},"\
+      " total_number_of_payments: #{@total_number_of_payments}, next_payment_amount:"\
+      " #{@next_payment_amount}, next_payment_date: #{@next_payment_date}, payment_frequency:"\
+      " #{@payment_frequency}, compounding_period: #{@compounding_period}, pay_off_amount:"\
+      " #{@pay_off_amount}, last_payment_amount: #{@last_payment_amount}, last_payment_date:"\
+      " #{@last_payment_date}, maturity_date: #{@maturity_date}, interest_paid_year_to_date:"\
+      " #{@interest_paid_year_to_date}, 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},"\
+      " principal_balance: #{@principal_balance.inspect}, escrow_balance:"\
+      " #{@escrow_balance.inspect}, original_principal: #{@original_principal.inspect},"\
+      " originating_date: #{@originating_date.inspect}, loan_term: #{@loan_term.inspect},"\
+      " total_number_of_payments: #{@total_number_of_payments.inspect}, next_payment_amount:"\
+      " #{@next_payment_amount.inspect}, next_payment_date: #{@next_payment_date.inspect},"\
+      " payment_frequency: #{@payment_frequency.inspect}, compounding_period:"\
+      " #{@compounding_period.inspect}, pay_off_amount: #{@pay_off_amount.inspect},"\
+      " last_payment_amount: #{@last_payment_amount.inspect}, last_payment_date:"\
+      " #{@last_payment_date.inspect}, maturity_date: #{@maturity_date.inspect},"\
+      " interest_paid_year_to_date: #{@interest_paid_year_to_date.inspect}, transactions:"\
+      " #{@transactions.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/loan_payment_frequency.rb

@@ -0,0 +1,47 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The frequency of payments on a loan
+  class LoanPaymentFrequency
+    LOAN_PAYMENT_FREQUENCY = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/loan_payment_frequency2.rb

@@ -0,0 +1,48 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # WEEKLY, BIWEEKLY, TWICEMONTHLY, MONTHLY, FOURWEEKS, BIMONTHLY, QUARTERLY,
+  # SEMIANNUALLY, ANNUALLY, OTHER
+  class LoanPaymentFrequency2
+    LOAN_PAYMENT_FREQUENCY2 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end