apimatic-ak-sdk 0.0.1

data/lib/akoya/models/investment_loan_entity.rb

@@ -0,0 +1,271 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Information about an investment loan.
+  class InvestmentLoanEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this loan
+    # @return [String]
+    attr_accessor :loan_id
+
+    # Description
+    # @return [String]
+    attr_accessor :loan_description
+
+    # Initial loan balance amount
+    # @return [Float]
+    attr_accessor :initial_loan_balance
+
+    # Start date of the loan
+    # @return [DateTime]
+    attr_accessor :loan_start_date
+
+    # Current loan principal balance amount
+    # @return [Float]
+    attr_accessor :current_loan_balance
+
+    # Date and time of current loan balance
+    # @return [DateTime]
+    attr_accessor :date_as_of
+
+    # Loan annual interest rate for the loan
+    # @return [Float]
+    attr_accessor :loan_rate
+
+    # Loan payment amount
+    # @return [Float]
+    attr_accessor :loan_payment_amount
+
+    # Loan payment amount
+    # @return [LoanPaymentFrequency]
+    attr_accessor :loan_payment_frequency
+
+    # Initial number of loan payments
+    # @return [Float]
+    attr_accessor :loan_payment_initial
+
+    # Remaining number of loan payments
+    # @return [Integer]
+    attr_accessor :loan_payments_remaining
+
+    # Expected loan end date
+    # @return [DateTime]
+    attr_accessor :loan_maturity_date
+
+    # Total interest paid to date on this loan
+    # @return [Float]
+    attr_accessor :loan_interest_to_date
+
+    # Total projected interest to be paid on this loan
+    # @return [Float]
+    attr_accessor :loan_total_projected_interest
+
+    # The next payment date for the loan
+    # @return [DateTime]
+    attr_accessor :loan_next_payment_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['loan_id'] = 'loanId'
+      @_hash['loan_description'] = 'loanDescription'
+      @_hash['initial_loan_balance'] = 'initialLoanBalance'
+      @_hash['loan_start_date'] = 'loanStartDate'
+      @_hash['current_loan_balance'] = 'currentLoanBalance'
+      @_hash['date_as_of'] = 'dateAsOf'
+      @_hash['loan_rate'] = 'loanRate'
+      @_hash['loan_payment_amount'] = 'loanPaymentAmount'
+      @_hash['loan_payment_frequency'] = 'loanPaymentFrequency'
+      @_hash['loan_payment_initial'] = 'loanPaymentInitial'
+      @_hash['loan_payments_remaining'] = 'loanPaymentsRemaining'
+      @_hash['loan_maturity_date'] = 'loanMaturityDate'
+      @_hash['loan_interest_to_date'] = 'loanInterestToDate'
+      @_hash['loan_total_projected_interest'] = 'loanTotalProjectedInterest'
+      @_hash['loan_next_payment_date'] = 'loanNextPaymentDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        loan_id
+        loan_description
+        initial_loan_balance
+        loan_start_date
+        current_loan_balance
+        date_as_of
+        loan_rate
+        loan_payment_amount
+        loan_payment_frequency
+        loan_payment_initial
+        loan_payments_remaining
+        loan_maturity_date
+        loan_interest_to_date
+        loan_total_projected_interest
+        loan_next_payment_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(loan_id: SKIP, loan_description: SKIP,
+                   initial_loan_balance: SKIP, loan_start_date: SKIP,
+                   current_loan_balance: SKIP, date_as_of: SKIP,
+                   loan_rate: SKIP, loan_payment_amount: SKIP,
+                   loan_payment_frequency: SKIP, loan_payment_initial: SKIP,
+                   loan_payments_remaining: SKIP, loan_maturity_date: SKIP,
+                   loan_interest_to_date: SKIP,
+                   loan_total_projected_interest: SKIP,
+                   loan_next_payment_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @loan_id = loan_id unless loan_id == SKIP
+      @loan_description = loan_description unless loan_description == SKIP
+      @initial_loan_balance = initial_loan_balance unless initial_loan_balance == SKIP
+      @loan_start_date = loan_start_date unless loan_start_date == SKIP
+      @current_loan_balance = current_loan_balance unless current_loan_balance == SKIP
+      @date_as_of = date_as_of unless date_as_of == SKIP
+      @loan_rate = loan_rate unless loan_rate == SKIP
+      @loan_payment_amount = loan_payment_amount unless loan_payment_amount == SKIP
+      @loan_payment_frequency = loan_payment_frequency unless loan_payment_frequency == SKIP
+      @loan_payment_initial = loan_payment_initial unless loan_payment_initial == SKIP
+      @loan_payments_remaining = loan_payments_remaining unless loan_payments_remaining == SKIP
+      @loan_maturity_date = loan_maturity_date unless loan_maturity_date == SKIP
+      @loan_interest_to_date = loan_interest_to_date unless loan_interest_to_date == SKIP
+      unless loan_total_projected_interest == SKIP
+        @loan_total_projected_interest =
+          loan_total_projected_interest
+      end
+      @loan_next_payment_date = loan_next_payment_date unless loan_next_payment_date == SKIP
+      @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.
+      loan_id = hash.key?('loanId') ? hash['loanId'] : SKIP
+      loan_description =
+        hash.key?('loanDescription') ? hash['loanDescription'] : SKIP
+      initial_loan_balance =
+        hash.key?('initialLoanBalance') ? hash['initialLoanBalance'] : SKIP
+      loan_start_date = if hash.key?('loanStartDate')
+                          (DateTimeHelper.from_rfc3339(hash['loanStartDate']) if hash['loanStartDate'])
+                        else
+                          SKIP
+                        end
+      current_loan_balance =
+        hash.key?('currentLoanBalance') ? hash['currentLoanBalance'] : SKIP
+      date_as_of = if hash.key?('dateAsOf')
+                     (DateTimeHelper.from_rfc3339(hash['dateAsOf']) if hash['dateAsOf'])
+                   else
+                     SKIP
+                   end
+      loan_rate = hash.key?('loanRate') ? hash['loanRate'] : SKIP
+      loan_payment_amount =
+        hash.key?('loanPaymentAmount') ? hash['loanPaymentAmount'] : SKIP
+      loan_payment_frequency =
+        hash.key?('loanPaymentFrequency') ? hash['loanPaymentFrequency'] : SKIP
+      loan_payment_initial =
+        hash.key?('loanPaymentInitial') ? hash['loanPaymentInitial'] : SKIP
+      loan_payments_remaining =
+        hash.key?('loanPaymentsRemaining') ? hash['loanPaymentsRemaining'] : SKIP
+      loan_maturity_date = if hash.key?('loanMaturityDate')
+                             (DateTimeHelper.from_rfc3339(hash['loanMaturityDate']) if hash['loanMaturityDate'])
+                           else
+                             SKIP
+                           end
+      loan_interest_to_date =
+        hash.key?('loanInterestToDate') ? hash['loanInterestToDate'] : SKIP
+      loan_total_projected_interest =
+        hash.key?('loanTotalProjectedInterest') ? hash['loanTotalProjectedInterest'] : SKIP
+      loan_next_payment_date = if hash.key?('loanNextPaymentDate')
+                                 (DateTimeHelper.from_rfc3339(hash['loanNextPaymentDate']) if hash['loanNextPaymentDate'])
+                               else
+                                 SKIP
+                               end
+
+      # 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.
+      InvestmentLoanEntity.new(loan_id: loan_id,
+                               loan_description: loan_description,
+                               initial_loan_balance: initial_loan_balance,
+                               loan_start_date: loan_start_date,
+                               current_loan_balance: current_loan_balance,
+                               date_as_of: date_as_of,
+                               loan_rate: loan_rate,
+                               loan_payment_amount: loan_payment_amount,
+                               loan_payment_frequency: loan_payment_frequency,
+                               loan_payment_initial: loan_payment_initial,
+                               loan_payments_remaining: loan_payments_remaining,
+                               loan_maturity_date: loan_maturity_date,
+                               loan_interest_to_date: loan_interest_to_date,
+                               loan_total_projected_interest: loan_total_projected_interest,
+                               loan_next_payment_date: loan_next_payment_date,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_loan_start_date
+      DateTimeHelper.to_rfc3339(loan_start_date)
+    end
+
+    def to_custom_date_as_of
+      DateTimeHelper.to_rfc3339(date_as_of)
+    end
+
+    def to_custom_loan_maturity_date
+      DateTimeHelper.to_rfc3339(loan_maturity_date)
+    end
+
+    def to_custom_loan_next_payment_date
+      DateTimeHelper.to_rfc3339(loan_next_payment_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} loan_id: #{@loan_id}, loan_description: #{@loan_description},"\
+      " initial_loan_balance: #{@initial_loan_balance}, loan_start_date: #{@loan_start_date},"\
+      " current_loan_balance: #{@current_loan_balance}, date_as_of: #{@date_as_of}, loan_rate:"\
+      " #{@loan_rate}, loan_payment_amount: #{@loan_payment_amount}, loan_payment_frequency:"\
+      " #{@loan_payment_frequency}, loan_payment_initial: #{@loan_payment_initial},"\
+      " loan_payments_remaining: #{@loan_payments_remaining}, loan_maturity_date:"\
+      " #{@loan_maturity_date}, loan_interest_to_date: #{@loan_interest_to_date},"\
+      " loan_total_projected_interest: #{@loan_total_projected_interest}, loan_next_payment_date:"\
+      " #{@loan_next_payment_date}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} loan_id: #{@loan_id.inspect}, loan_description:"\
+      " #{@loan_description.inspect}, initial_loan_balance: #{@initial_loan_balance.inspect},"\
+      " loan_start_date: #{@loan_start_date.inspect}, current_loan_balance:"\
+      " #{@current_loan_balance.inspect}, date_as_of: #{@date_as_of.inspect}, loan_rate:"\
+      " #{@loan_rate.inspect}, loan_payment_amount: #{@loan_payment_amount.inspect},"\
+      " loan_payment_frequency: #{@loan_payment_frequency.inspect}, loan_payment_initial:"\
+      " #{@loan_payment_initial.inspect}, loan_payments_remaining:"\
+      " #{@loan_payments_remaining.inspect}, loan_maturity_date: #{@loan_maturity_date.inspect},"\
+      " loan_interest_to_date: #{@loan_interest_to_date.inspect}, loan_total_projected_interest:"\
+      " #{@loan_total_projected_interest.inspect}, loan_next_payment_date:"\
+      " #{@loan_next_payment_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end