lithic 0.1.0.pre.alpha.54 → 0.1.0.pre.alpha.56

data/lib/lithic/models/financial_accounts/statement.rb

@@ -72,8 +72,8 @@ module Lithic
 
         # @!attribute period_totals
         #
-        #   @return [Lithic::Models::FinancialAccounts::Statement::PeriodTotals]
-        required :period_totals, -> { Lithic::FinancialAccounts::Statement::PeriodTotals }
+        #   @return [Lithic::Models::StatementTotals]
+        required :period_totals, -> { Lithic::StatementTotals }
 
         # @!attribute starting_balance
         #   Balance at the start of the billing period
@@ -106,8 +106,8 @@ module Lithic
 
         # @!attribute ytd_totals
         #
-        #   @return [Lithic::Models::FinancialAccounts::Statement::YtdTotals]
-        required :ytd_totals, -> { Lithic::FinancialAccounts::Statement::YtdTotals }
+        #   @return [Lithic::Models::StatementTotals]
+        required :ytd_totals, -> { Lithic::StatementTotals }
 
         # @!attribute interest_details
         #
@@ -126,7 +126,13 @@ module Lithic
         #   @return [Date, nil]
         optional :next_statement_end_date, Date
 
-        # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil)
+        # @!attribute payoff_details
+        #   Details on number and size of payments to pay off balance
+        #
+        #   @return [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil]
+        optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true
+
+        # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::Statement} for more details.
         #
@@ -152,7 +158,7 @@ module Lithic
         #
         #   @param payment_due_date [Date, nil] Date when the payment is due
         #
-        #   @param period_totals [Lithic::Models::FinancialAccounts::Statement::PeriodTotals]
+        #   @param period_totals [Lithic::Models::StatementTotals]
         #
         #   @param starting_balance [Integer] Balance at the start of the billing period
         #
@@ -164,13 +170,15 @@ module Lithic
         #
         #   @param updated [Time] Timestamp of when the statement was updated
         #
-        #   @param ytd_totals [Lithic::Models::FinancialAccounts::Statement::YtdTotals]
+        #   @param ytd_totals [Lithic::Models::StatementTotals]
         #
         #   @param interest_details [Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil]
         #
         #   @param next_payment_due_date [Date] Date when the next payment is due
         #
         #   @param next_statement_end_date [Date] Date when the next billing period will end
+        #
+        #   @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance
 
         # @see Lithic::Models::FinancialAccounts::Statement#account_standing
         class AccountStanding < Lithic::Internal::Type::BaseModel
@@ -336,70 +344,6 @@ module Lithic
           #   @param past_due [Integer] Amount past due for statement in cents
         end
 
-        # @see Lithic::Models::FinancialAccounts::Statement#period_totals
-        class PeriodTotals < Lithic::Internal::Type::BaseModel
-          # @!attribute balance_transfers
-          #   Opening balance transferred from previous account in cents
-          #
-          #   @return [Integer]
-          required :balance_transfers, Integer
-
-          # @!attribute cash_advances
-          #   ATM and cashback transactions in cents
-          #
-          #   @return [Integer]
-          required :cash_advances, Integer
-
-          # @!attribute credits
-          #   Volume of credit management operation transactions less any balance transfers in
-          #   cents
-          #
-          #   @return [Integer]
-          required :credits, Integer
-
-          # @!attribute fees
-          #   Volume of debit management operation transactions less any interest in cents
-          #
-          #   @return [Integer]
-          required :fees, Integer
-
-          # @!attribute interest
-          #   Interest accrued in cents
-          #
-          #   @return [Integer]
-          required :interest, Integer
-
-          # @!attribute payments
-          #   Any funds transfers which affective the balance in cents
-          #
-          #   @return [Integer]
-          required :payments, Integer
-
-          # @!attribute purchases
-          #   Net card transaction volume less any cash advances in cents
-          #
-          #   @return [Integer]
-          required :purchases, Integer
-
-          # @!method initialize(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          #   Some parameter documentations has been truncated, see
-          #   {Lithic::Models::FinancialAccounts::Statement::PeriodTotals} for more details.
-          #
-          #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
-          #
-          #   @param cash_advances [Integer] ATM and cashback transactions in cents
-          #
-          #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
-          #
-          #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
-          #
-          #   @param interest [Integer] Interest accrued in cents
-          #
-          #   @param payments [Integer] Any funds transfers which affective the balance in cents
-          #
-          #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
-        end
-
         # @see Lithic::Models::FinancialAccounts::Statement#statement_type
         module StatementType
           extend Lithic::Internal::Type::Enum
@@ -412,70 +356,6 @@ module Lithic
           #   @return [Array<Symbol>]
         end
 
-        # @see Lithic::Models::FinancialAccounts::Statement#ytd_totals
-        class YtdTotals < Lithic::Internal::Type::BaseModel
-          # @!attribute balance_transfers
-          #   Opening balance transferred from previous account in cents
-          #
-          #   @return [Integer]
-          required :balance_transfers, Integer
-
-          # @!attribute cash_advances
-          #   ATM and cashback transactions in cents
-          #
-          #   @return [Integer]
-          required :cash_advances, Integer
-
-          # @!attribute credits
-          #   Volume of credit management operation transactions less any balance transfers in
-          #   cents
-          #
-          #   @return [Integer]
-          required :credits, Integer
-
-          # @!attribute fees
-          #   Volume of debit management operation transactions less any interest in cents
-          #
-          #   @return [Integer]
-          required :fees, Integer
-
-          # @!attribute interest
-          #   Interest accrued in cents
-          #
-          #   @return [Integer]
-          required :interest, Integer
-
-          # @!attribute payments
-          #   Any funds transfers which affective the balance in cents
-          #
-          #   @return [Integer]
-          required :payments, Integer
-
-          # @!attribute purchases
-          #   Net card transaction volume less any cash advances in cents
-          #
-          #   @return [Integer]
-          required :purchases, Integer
-
-          # @!method initialize(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          #   Some parameter documentations has been truncated, see
-          #   {Lithic::Models::FinancialAccounts::Statement::YtdTotals} for more details.
-          #
-          #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
-          #
-          #   @param cash_advances [Integer] ATM and cashback transactions in cents
-          #
-          #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
-          #
-          #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
-          #
-          #   @param interest [Integer] Interest accrued in cents
-          #
-          #   @param payments [Integer] Any funds transfers which affective the balance in cents
-          #
-          #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
-        end
-
         # @see Lithic::Models::FinancialAccounts::Statement#interest_details
         class InterestDetails < Lithic::Internal::Type::BaseModel
           # @!attribute actual_interest_charged
@@ -485,14 +365,13 @@ module Lithic
 
           # @!attribute daily_balance_amounts
           #
-          #   @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts]
-          required :daily_balance_amounts,
-                   -> { Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts }
+          #   @return [Lithic::Models::CategoryDetails]
+          required :daily_balance_amounts, -> { Lithic::CategoryDetails }
 
           # @!attribute effective_apr
           #
-          #   @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr]
-          required :effective_apr, -> { Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr }
+          #   @return [Lithic::Models::CategoryDetails]
+          required :effective_apr, -> { Lithic::CategoryDetails }
 
           # @!attribute interest_calculation_method
           #
@@ -502,9 +381,8 @@ module Lithic
 
           # @!attribute interest_for_period
           #
-          #   @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod]
-          required :interest_for_period,
-                   -> { Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod }
+          #   @return [Lithic::Models::CategoryDetails]
+          required :interest_for_period, -> { Lithic::CategoryDetails }
 
           # @!attribute prime_rate
           #
@@ -518,59 +396,13 @@ module Lithic
 
           # @!method initialize(actual_interest_charged:, daily_balance_amounts:, effective_apr:, interest_calculation_method:, interest_for_period:, prime_rate:, minimum_interest_charged: nil)
           #   @param actual_interest_charged [Integer, nil]
-          #   @param daily_balance_amounts [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts]
-          #   @param effective_apr [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr]
+          #   @param daily_balance_amounts [Lithic::Models::CategoryDetails]
+          #   @param effective_apr [Lithic::Models::CategoryDetails]
           #   @param interest_calculation_method [Symbol, Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod]
-          #   @param interest_for_period [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod]
+          #   @param interest_for_period [Lithic::Models::CategoryDetails]
           #   @param prime_rate [String, nil]
           #   @param minimum_interest_charged [Integer, nil]
 
-          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#daily_balance_amounts
-          class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel
-            # @!attribute balance_transfers
-            #
-            #   @return [String]
-            required :balance_transfers, String
-
-            # @!attribute cash_advances
-            #
-            #   @return [String]
-            required :cash_advances, String
-
-            # @!attribute purchases
-            #
-            #   @return [String]
-            required :purchases, String
-
-            # @!method initialize(balance_transfers:, cash_advances:, purchases:)
-            #   @param balance_transfers [String]
-            #   @param cash_advances [String]
-            #   @param purchases [String]
-          end
-
-          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#effective_apr
-          class EffectiveApr < Lithic::Internal::Type::BaseModel
-            # @!attribute balance_transfers
-            #
-            #   @return [String]
-            required :balance_transfers, String
-
-            # @!attribute cash_advances
-            #
-            #   @return [String]
-            required :cash_advances, String
-
-            # @!attribute purchases
-            #
-            #   @return [String]
-            required :purchases, String
-
-            # @!method initialize(balance_transfers:, cash_advances:, purchases:)
-            #   @param balance_transfers [String]
-            #   @param cash_advances [String]
-            #   @param purchases [String]
-          end
-
           # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_calculation_method
           module InterestCalculationMethod
             extend Lithic::Internal::Type::Enum
@@ -581,29 +413,59 @@ module Lithic
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+        end
 
-          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_for_period
-          class InterestForPeriod < Lithic::Internal::Type::BaseModel
-            # @!attribute balance_transfers
-            #
-            #   @return [String]
-            required :balance_transfers, String
+        # @see Lithic::Models::FinancialAccounts::Statement#payoff_details
+        class PayoffDetails < Lithic::Internal::Type::BaseModel
+          # @!attribute minimum_payment_months
+          #   The number of months it would take to pay off the balance in full by only paying
+          #   the minimum payment. "NA" will signal negative or zero amortization
+          #
+          #   @return [String]
+          required :minimum_payment_months, String
 
-            # @!attribute cash_advances
-            #
-            #   @return [String]
-            required :cash_advances, String
+          # @!attribute minimum_payment_total
+          #   The sum of all interest and principal paid, in cents, when only paying minimum
+          #   monthly payment. "NA" will signal negative or zero amortization
+          #
+          #   @return [String]
+          required :minimum_payment_total, String
 
-            # @!attribute purchases
-            #
-            #   @return [String]
-            required :purchases, String
+          # @!attribute payoff_period_length_months
+          #   Number of months to full pay off
+          #
+          #   @return [Integer]
+          required :payoff_period_length_months, Integer
 
-            # @!method initialize(balance_transfers:, cash_advances:, purchases:)
-            #   @param balance_transfers [String]
-            #   @param cash_advances [String]
-            #   @param purchases [String]
-          end
+          # @!attribute payoff_period_monthly_payment_amount
+          #   The amount needed to be paid, in cents, each month in order to pay off current
+          #   balance in the payoff period
+          #
+          #   @return [Integer]
+          required :payoff_period_monthly_payment_amount, Integer
+
+          # @!attribute payoff_period_payment_total
+          #   The sum of all interest and principal paid, in cents, when paying off in the
+          #   payoff period
+          #
+          #   @return [Integer]
+          required :payoff_period_payment_total, Integer
+
+          # @!method initialize(minimum_payment_months:, minimum_payment_total:, payoff_period_length_months:, payoff_period_monthly_payment_amount:, payoff_period_payment_total:)
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::Statement::PayoffDetails} for more details.
+          #
+          #   Details on number and size of payments to pay off balance
+          #
+          #   @param minimum_payment_months [String] The number of months it would take to pay off the balance in full by only paying
+          #
+          #   @param minimum_payment_total [String] The sum of all interest and principal paid, in cents, when only paying minimum m
+          #
+          #   @param payoff_period_length_months [Integer] Number of months to full pay off
+          #
+          #   @param payoff_period_monthly_payment_amount [Integer] The amount needed to be paid, in cents, each month in order to pay off current b
+          #
+          #   @param payoff_period_payment_total [Integer] The sum of all interest and principal paid, in cents, when paying off in the pay
         end
       end
     end

data/lib/lithic/models/financial_event.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class FinancialEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Globally unique identifier.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!attribute amount
+      #   Amount of the financial event that has been settled in the currency's smallest
+      #   unit (e.g., cents).
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer
+
+      # @!attribute created
+      #   Date and time when the financial event occurred. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :created, Time
+
+      # @!attribute result
+      #   APPROVED financial events were successful while DECLINED financial events were
+      #   declined by user, Lithic, or the network.
+      #
+      #   @return [Symbol, Lithic::Models::FinancialEvent::Result, nil]
+      optional :result, enum: -> { Lithic::FinancialEvent::Result }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Lithic::Models::FinancialEvent::Type, nil]
+      optional :type, enum: -> { Lithic::FinancialEvent::Type }
+
+      # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::FinancialEvent} for more details.
+      #
+      #   Financial Event
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
+      #
+      #   @param created [Time] Date and time when the financial event occurred. UTC time zone.
+      #
+      #   @param result [Symbol, Lithic::Models::FinancialEvent::Result] APPROVED financial events were successful while DECLINED financial events were d
+      #
+      #   @param type [Symbol, Lithic::Models::FinancialEvent::Type]
+
+      # APPROVED financial events were successful while DECLINED financial events were
+      # declined by user, Lithic, or the network.
+      #
+      # @see Lithic::Models::FinancialEvent#result
+      module Result
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Lithic::Models::FinancialEvent#type
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
+        ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
+        ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
+        ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
+        ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
+        ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
+        ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
+        ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
+        ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
+        ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
+        ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
+        ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
+        ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
+        ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
+        AUTHORIZATION = :AUTHORIZATION
+        AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
+        AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
+        AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
+        BALANCE_INQUIRY = :BALANCE_INQUIRY
+        BILLING_ERROR = :BILLING_ERROR
+        BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
+        CARD_TO_CARD = :CARD_TO_CARD
+        CASH_BACK = :CASH_BACK
+        CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
+        CLEARING = :CLEARING
+        COLLECTION = :COLLECTION
+        CORRECTION_CREDIT = :CORRECTION_CREDIT
+        CORRECTION_DEBIT = :CORRECTION_DEBIT
+        CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
+        CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
+        CURRENCY_CONVERSION = :CURRENCY_CONVERSION
+        CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
+        DISPUTE_WON = :DISPUTE_WON
+        EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
+        EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
+        EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
+        EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
+        EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
+        EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
+        EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
+        EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
+        EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
+        EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
+        EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
+        EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
+        EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
+        EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
+        EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
+        EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
+        EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
+        EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
+        EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
+        EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
+        FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
+        FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
+        INTEREST = :INTEREST
+        INTEREST_REVERSAL = :INTEREST_REVERSAL
+        INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
+        LATE_PAYMENT = :LATE_PAYMENT
+        LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
+        LOSS_WRITE_OFF = :LOSS_WRITE_OFF
+        PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
+        PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
+        SERVICE = :SERVICE
+        RETURN = :RETURN
+        RETURN_REVERSAL = :RETURN_REVERSAL
+        TRANSFER = :TRANSFER
+        TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
+        RETURNED_PAYMENT = :RETURNED_PAYMENT
+        RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
+        LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end