lithic 0.1.0.pre.alpha.55 → 0.1.0.pre.alpha.56

data/rbi/lithic/models/financial_accounts/statement.rbi

@@ -70,15 +70,10 @@ module Lithic
         sig { returns(T.nilable(Date)) }
         attr_accessor :payment_due_date
 
-        sig { returns(Lithic::FinancialAccounts::Statement::PeriodTotals) }
+        sig { returns(Lithic::StatementTotals) }
         attr_reader :period_totals
 
-        sig do
-          params(
-            period_totals:
-              Lithic::FinancialAccounts::Statement::PeriodTotals::OrHash
-          ).void
-        end
+        sig { params(period_totals: Lithic::StatementTotals::OrHash).void }
         attr_writer :period_totals
 
         # Balance at the start of the billing period
@@ -104,14 +99,10 @@ module Lithic
         sig { returns(Time) }
         attr_accessor :updated
 
-        sig { returns(Lithic::FinancialAccounts::Statement::YtdTotals) }
+        sig { returns(Lithic::StatementTotals) }
         attr_reader :ytd_totals
 
-        sig do
-          params(
-            ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals::OrHash
-          ).void
-        end
+        sig { params(ytd_totals: Lithic::StatementTotals::OrHash).void }
         attr_writer :ytd_totals
 
         sig do
@@ -145,6 +136,24 @@ module Lithic
         sig { params(next_statement_end_date: Date).void }
         attr_writer :next_statement_end_date
 
+        # Details on number and size of payments to pay off balance
+        sig do
+          returns(
+            T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails)
+          )
+        end
+        attr_reader :payoff_details
+
+        sig do
+          params(
+            payoff_details:
+              T.nilable(
+                Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash
+              )
+          ).void
+        end
+        attr_writer :payoff_details
+
         sig do
           params(
             token: String,
@@ -159,21 +168,24 @@ module Lithic
             ending_balance: Integer,
             financial_account_token: String,
             payment_due_date: T.nilable(Date),
-            period_totals:
-              Lithic::FinancialAccounts::Statement::PeriodTotals::OrHash,
+            period_totals: Lithic::StatementTotals::OrHash,
             starting_balance: Integer,
             statement_end_date: Date,
             statement_start_date: Date,
             statement_type:
               Lithic::FinancialAccounts::Statement::StatementType::OrSymbol,
             updated: Time,
-            ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals::OrHash,
+            ytd_totals: Lithic::StatementTotals::OrHash,
             interest_details:
               T.nilable(
                 Lithic::FinancialAccounts::Statement::InterestDetails::OrHash
               ),
             next_payment_due_date: Date,
-            next_statement_end_date: Date
+            next_statement_end_date: Date,
+            payoff_details:
+              T.nilable(
+                Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -213,7 +225,9 @@ module Lithic
           # Date when the next payment is due
           next_payment_due_date: nil,
           # Date when the next billing period will end
-          next_statement_end_date: nil
+          next_statement_end_date: nil,
+          # Details on number and size of payments to pay off balance
+          payoff_details: nil
         )
         end
 
@@ -232,20 +246,22 @@ module Lithic
               ending_balance: Integer,
               financial_account_token: String,
               payment_due_date: T.nilable(Date),
-              period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals,
+              period_totals: Lithic::StatementTotals,
               starting_balance: Integer,
               statement_end_date: Date,
               statement_start_date: Date,
               statement_type:
                 Lithic::FinancialAccounts::Statement::StatementType::TaggedSymbol,
               updated: Time,
-              ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals,
+              ytd_totals: Lithic::StatementTotals,
               interest_details:
                 T.nilable(
                   Lithic::FinancialAccounts::Statement::InterestDetails
                 ),
               next_payment_due_date: Date,
-              next_statement_end_date: Date
+              next_statement_end_date: Date,
+              payoff_details:
+                T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails)
             }
           )
         end
@@ -596,132 +612,6 @@ module Lithic
           end
         end
 
-        class PeriodTotals < Lithic::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Lithic::FinancialAccounts::Statement::PeriodTotals,
-                Lithic::Internal::AnyHash
-              )
-            end
-
-          # Opening balance transferred from previous account in cents
-          sig { returns(Integer) }
-          attr_accessor :balance_transfers
-
-          # ATM and cashback transactions in cents
-          sig { returns(Integer) }
-          attr_accessor :cash_advances
-
-          # Volume of credit management operation transactions less any balance transfers in
-          # cents
-          sig { returns(Integer) }
-          attr_accessor :credits
-
-          # Volume of debit management operation transactions less any interest in cents
-          sig { returns(Integer) }
-          attr_accessor :debits
-
-          # Volume of debit management operation transactions less any interest in cents
-          sig { returns(Integer) }
-          attr_accessor :fees
-
-          # Interest accrued in cents
-          sig { returns(Integer) }
-          attr_accessor :interest
-
-          # Any funds transfers which affective the balance in cents
-          sig { returns(Integer) }
-          attr_accessor :payments
-
-          # Net card transaction volume less any cash advances in cents
-          sig { returns(Integer) }
-          attr_accessor :purchases
-
-          # Breakdown of credits
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :credit_details
-
-          sig { params(credit_details: T.anything).void }
-          attr_writer :credit_details
-
-          # Breakdown of debits
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :debit_details
-
-          sig { params(debit_details: T.anything).void }
-          attr_writer :debit_details
-
-          # Breakdown of payments
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :payment_details
-
-          sig { params(payment_details: T.anything).void }
-          attr_writer :payment_details
-
-          sig do
-            params(
-              balance_transfers: Integer,
-              cash_advances: Integer,
-              credits: Integer,
-              debits: Integer,
-              fees: Integer,
-              interest: Integer,
-              payments: Integer,
-              purchases: Integer,
-              credit_details: T.anything,
-              debit_details: T.anything,
-              payment_details: T.anything
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Opening balance transferred from previous account in cents
-            balance_transfers:,
-            # ATM and cashback transactions in cents
-            cash_advances:,
-            # Volume of credit management operation transactions less any balance transfers in
-            # cents
-            credits:,
-            # Volume of debit management operation transactions less any interest in cents
-            debits:,
-            # Volume of debit management operation transactions less any interest in cents
-            fees:,
-            # Interest accrued in cents
-            interest:,
-            # Any funds transfers which affective the balance in cents
-            payments:,
-            # Net card transaction volume less any cash advances in cents
-            purchases:,
-            # Breakdown of credits
-            credit_details: nil,
-            # Breakdown of debits
-            debit_details: nil,
-            # Breakdown of payments
-            payment_details: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                balance_transfers: Integer,
-                cash_advances: Integer,
-                credits: Integer,
-                debits: Integer,
-                fees: Integer,
-                interest: Integer,
-                payments: Integer,
-                purchases: Integer,
-                credit_details: T.anything,
-                debit_details: T.anything,
-                payment_details: T.anything
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
         module StatementType
           extend Lithic::Internal::Type::Enum
 
@@ -758,132 +648,6 @@ module Lithic
           end
         end
 
-        class YtdTotals < Lithic::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Lithic::FinancialAccounts::Statement::YtdTotals,
-                Lithic::Internal::AnyHash
-              )
-            end
-
-          # Opening balance transferred from previous account in cents
-          sig { returns(Integer) }
-          attr_accessor :balance_transfers
-
-          # ATM and cashback transactions in cents
-          sig { returns(Integer) }
-          attr_accessor :cash_advances
-
-          # Volume of credit management operation transactions less any balance transfers in
-          # cents
-          sig { returns(Integer) }
-          attr_accessor :credits
-
-          # Volume of debit management operation transactions less any interest in cents
-          sig { returns(Integer) }
-          attr_accessor :debits
-
-          # Volume of debit management operation transactions less any interest in cents
-          sig { returns(Integer) }
-          attr_accessor :fees
-
-          # Interest accrued in cents
-          sig { returns(Integer) }
-          attr_accessor :interest
-
-          # Any funds transfers which affective the balance in cents
-          sig { returns(Integer) }
-          attr_accessor :payments
-
-          # Net card transaction volume less any cash advances in cents
-          sig { returns(Integer) }
-          attr_accessor :purchases
-
-          # Breakdown of credits
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :credit_details
-
-          sig { params(credit_details: T.anything).void }
-          attr_writer :credit_details
-
-          # Breakdown of debits
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :debit_details
-
-          sig { params(debit_details: T.anything).void }
-          attr_writer :debit_details
-
-          # Breakdown of payments
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :payment_details
-
-          sig { params(payment_details: T.anything).void }
-          attr_writer :payment_details
-
-          sig do
-            params(
-              balance_transfers: Integer,
-              cash_advances: Integer,
-              credits: Integer,
-              debits: Integer,
-              fees: Integer,
-              interest: Integer,
-              payments: Integer,
-              purchases: Integer,
-              credit_details: T.anything,
-              debit_details: T.anything,
-              payment_details: T.anything
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Opening balance transferred from previous account in cents
-            balance_transfers:,
-            # ATM and cashback transactions in cents
-            cash_advances:,
-            # Volume of credit management operation transactions less any balance transfers in
-            # cents
-            credits:,
-            # Volume of debit management operation transactions less any interest in cents
-            debits:,
-            # Volume of debit management operation transactions less any interest in cents
-            fees:,
-            # Interest accrued in cents
-            interest:,
-            # Any funds transfers which affective the balance in cents
-            payments:,
-            # Net card transaction volume less any cash advances in cents
-            purchases:,
-            # Breakdown of credits
-            credit_details: nil,
-            # Breakdown of debits
-            debit_details: nil,
-            # Breakdown of payments
-            payment_details: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                balance_transfers: Integer,
-                cash_advances: Integer,
-                credits: Integer,
-                debits: Integer,
-                fees: Integer,
-                interest: Integer,
-                payments: Integer,
-                purchases: Integer,
-                credit_details: T.anything,
-                debit_details: T.anything,
-                payment_details: T.anything
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
         class InterestDetails < Lithic::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -896,34 +660,18 @@ module Lithic
           sig { returns(T.nilable(Integer)) }
           attr_accessor :actual_interest_charged
 
-          sig do
-            returns(
-              Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts
-            )
-          end
+          sig { returns(Lithic::CategoryDetails) }
           attr_reader :daily_balance_amounts
 
           sig do
-            params(
-              daily_balance_amounts:
-                Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts::OrHash
-            ).void
+            params(daily_balance_amounts: Lithic::CategoryDetails::OrHash).void
           end
           attr_writer :daily_balance_amounts
 
-          sig do
-            returns(
-              Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr
-            )
-          end
+          sig { returns(Lithic::CategoryDetails) }
           attr_reader :effective_apr
 
-          sig do
-            params(
-              effective_apr:
-                Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr::OrHash
-            ).void
-          end
+          sig { params(effective_apr: Lithic::CategoryDetails::OrHash).void }
           attr_writer :effective_apr
 
           sig do
@@ -933,18 +681,11 @@ module Lithic
           end
           attr_accessor :interest_calculation_method
 
-          sig do
-            returns(
-              Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod
-            )
-          end
+          sig { returns(Lithic::CategoryDetails) }
           attr_reader :interest_for_period
 
           sig do
-            params(
-              interest_for_period:
-                Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod::OrHash
-            ).void
+            params(interest_for_period: Lithic::CategoryDetails::OrHash).void
           end
           attr_writer :interest_for_period
 
@@ -957,14 +698,11 @@ module Lithic
           sig do
             params(
               actual_interest_charged: T.nilable(Integer),
-              daily_balance_amounts:
-                Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts::OrHash,
-              effective_apr:
-                Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr::OrHash,
+              daily_balance_amounts: Lithic::CategoryDetails::OrHash,
+              effective_apr: Lithic::CategoryDetails::OrHash,
               interest_calculation_method:
                 Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod::OrSymbol,
-              interest_for_period:
-                Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod::OrHash,
+              interest_for_period: Lithic::CategoryDetails::OrHash,
               prime_rate: T.nilable(String),
               minimum_interest_charged: T.nilable(Integer)
             ).returns(T.attached_class)
@@ -984,14 +722,11 @@ module Lithic
             override.returns(
               {
                 actual_interest_charged: T.nilable(Integer),
-                daily_balance_amounts:
-                  Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts,
-                effective_apr:
-                  Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr,
+                daily_balance_amounts: Lithic::CategoryDetails,
+                effective_apr: Lithic::CategoryDetails,
                 interest_calculation_method:
                   Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod::TaggedSymbol,
-                interest_for_period:
-                  Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod,
+                interest_for_period: Lithic::CategoryDetails,
                 prime_rate: T.nilable(String),
                 minimum_interest_charged: T.nilable(Integer)
               }
@@ -1000,88 +735,6 @@ module Lithic
           def to_hash
           end
 
-          class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts,
-                  Lithic::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :balance_transfers
-
-            sig { returns(String) }
-            attr_accessor :cash_advances
-
-            sig { returns(String) }
-            attr_accessor :purchases
-
-            sig do
-              params(
-                balance_transfers: String,
-                cash_advances: String,
-                purchases: String
-              ).returns(T.attached_class)
-            end
-            def self.new(balance_transfers:, cash_advances:, purchases:)
-            end
-
-            sig do
-              override.returns(
-                {
-                  balance_transfers: String,
-                  cash_advances: String,
-                  purchases: String
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          class EffectiveApr < Lithic::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr,
-                  Lithic::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :balance_transfers
-
-            sig { returns(String) }
-            attr_accessor :cash_advances
-
-            sig { returns(String) }
-            attr_accessor :purchases
-
-            sig do
-              params(
-                balance_transfers: String,
-                cash_advances: String,
-                purchases: String
-              ).returns(T.attached_class)
-            end
-            def self.new(balance_transfers:, cash_advances:, purchases:)
-            end
-
-            sig do
-              override.returns(
-                {
-                  balance_transfers: String,
-                  cash_advances: String,
-                  purchases: String
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
           module InterestCalculationMethod
             extend Lithic::Internal::Type::Enum
 
@@ -1115,46 +768,81 @@ module Lithic
             def self.values
             end
           end
+        end
 
-          class InterestForPeriod < Lithic::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod,
-                  Lithic::Internal::AnyHash
-                )
-              end
+        class PayoffDetails < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::Statement::PayoffDetails,
+                Lithic::Internal::AnyHash
+              )
+            end
 
-            sig { returns(String) }
-            attr_accessor :balance_transfers
+          # 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
+          sig { returns(String) }
+          attr_accessor :minimum_payment_months
 
-            sig { returns(String) }
-            attr_accessor :cash_advances
+          # The sum of all interest and principal paid, in cents, when only paying minimum
+          # monthly payment. "NA" will signal negative or zero amortization
+          sig { returns(String) }
+          attr_accessor :minimum_payment_total
 
-            sig { returns(String) }
-            attr_accessor :purchases
+          # Number of months to full pay off
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_length_months
 
-            sig do
-              params(
-                balance_transfers: String,
-                cash_advances: String,
-                purchases: String
-              ).returns(T.attached_class)
-            end
-            def self.new(balance_transfers:, cash_advances:, purchases:)
-            end
+          # The amount needed to be paid, in cents, each month in order to pay off current
+          # balance in the payoff period
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_monthly_payment_amount
 
-            sig do
-              override.returns(
-                {
-                  balance_transfers: String,
-                  cash_advances: String,
-                  purchases: String
-                }
-              )
-            end
-            def to_hash
-            end
+          # The sum of all interest and principal paid, in cents, when paying off in the
+          # payoff period
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_payment_total
+
+          # Details on number and size of payments to pay off balance
+          sig do
+            params(
+              minimum_payment_months: String,
+              minimum_payment_total: String,
+              payoff_period_length_months: Integer,
+              payoff_period_monthly_payment_amount: Integer,
+              payoff_period_payment_total: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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
+            minimum_payment_months:,
+            # The sum of all interest and principal paid, in cents, when only paying minimum
+            # monthly payment. "NA" will signal negative or zero amortization
+            minimum_payment_total:,
+            # Number of months to full pay off
+            payoff_period_length_months:,
+            # The amount needed to be paid, in cents, each month in order to pay off current
+            # balance in the payoff period
+            payoff_period_monthly_payment_amount:,
+            # The sum of all interest and principal paid, in cents, when paying off in the
+            # payoff period
+            payoff_period_payment_total:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                minimum_payment_months: String,
+                minimum_payment_total: String,
+                payoff_period_length_months: Integer,
+                payoff_period_monthly_payment_amount: Integer,
+                payoff_period_payment_total: Integer
+              }
+            )
+          end
+          def to_hash
           end
         end
       end