lithic 0.21.0 → 0.23.0

data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi

@@ -0,0 +1,191 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        class StatementListParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Globally unique identifier for financial account.
+          sig { returns(String) }
+          attr_accessor :financial_account_token
+
+          # Globally unique identifier for installment plan.
+          sig { returns(String) }
+          attr_accessor :installment_plan_token
+
+          # Date string in RFC 3339 format. Only entries created after the specified date
+          # will be included.
+          sig { returns(T.nilable(Date)) }
+          attr_reader :begin_
+
+          sig { params(begin_: Date).void }
+          attr_writer :begin_
+
+          # Date string in RFC 3339 format. Only entries created before the specified date
+          # will be included.
+          sig { returns(T.nilable(Date)) }
+          attr_reader :end_
+
+          sig { params(end_: Date).void }
+          attr_writer :end_
+
+          # A cursor representing an item's token before which a page of results should end.
+          # Used to retrieve the previous page of results before this item.
+          sig { returns(T.nilable(String)) }
+          attr_reader :ending_before
+
+          sig { params(ending_before: String).void }
+          attr_writer :ending_before
+
+          # Page size (for pagination).
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          # A cursor representing an item's token after which a page of results should
+          # begin. Used to retrieve the next page of results after this item.
+          sig { returns(T.nilable(String)) }
+          attr_reader :starting_after
+
+          sig { params(starting_after: String).void }
+          attr_writer :starting_after
+
+          # Only snapshots in which the plan was in this state will be included.
+          sig do
+            returns(
+              T.nilable(
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::OrSymbol
+              )
+            )
+          end
+          attr_accessor :state
+
+          sig do
+            params(
+              financial_account_token: String,
+              installment_plan_token: String,
+              begin_: Date,
+              end_: Date,
+              ending_before: String,
+              page_size: Integer,
+              starting_after: String,
+              state:
+                T.nilable(
+                  Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::OrSymbol
+                ),
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Globally unique identifier for financial account.
+            financial_account_token:,
+            # Globally unique identifier for installment plan.
+            installment_plan_token:,
+            # Date string in RFC 3339 format. Only entries created after the specified date
+            # will be included.
+            begin_: nil,
+            # Date string in RFC 3339 format. Only entries created before the specified date
+            # will be included.
+            end_: nil,
+            # A cursor representing an item's token before which a page of results should end.
+            # Used to retrieve the previous page of results before this item.
+            ending_before: nil,
+            # Page size (for pagination).
+            page_size: nil,
+            # A cursor representing an item's token after which a page of results should
+            # begin. Used to retrieve the next page of results after this item.
+            starting_after: nil,
+            # Only snapshots in which the plan was in this state will be included.
+            state: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                financial_account_token: String,
+                installment_plan_token: String,
+                begin_: Date,
+                end_: Date,
+                ending_before: String,
+                page_size: Integer,
+                starting_after: String,
+                state:
+                  T.nilable(
+                    Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::OrSymbol
+                  ),
+                request_options: Lithic::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Only snapshots in which the plan was in this state will be included.
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :PENDING,
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+              )
+            ACTIVE =
+              T.let(
+                :ACTIVE,
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+              )
+            REBUILD_IN_PROGRESS =
+              T.let(
+                :REBUILD_IN_PROGRESS,
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+              )
+            FULLY_PAID =
+              T.let(
+                :FULLY_PAID,
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+              )
+            CANCELLED =
+              T.let(
+                :CANCELLED,
+                Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        class StatementRetrieveParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::InstallmentPlans::StatementRetrieveParams,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Globally unique identifier for financial account.
+          sig { returns(String) }
+          attr_accessor :financial_account_token
+
+          # Globally unique identifier for installment plan.
+          sig { returns(String) }
+          attr_accessor :installment_plan_token
+
+          # Globally unique identifier for statement.
+          sig { returns(String) }
+          attr_accessor :statement_token
+
+          sig do
+            params(
+              financial_account_token: String,
+              installment_plan_token: String,
+              statement_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Globally unique identifier for financial account.
+            financial_account_token:,
+            # Globally unique identifier for installment plan.
+            installment_plan_token:,
+            # Globally unique identifier for statement.
+            statement_token:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                financial_account_token: String,
+                installment_plan_token: String,
+                statement_token: String,
+                request_options: Lithic::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule.rbi

@@ -22,34 +22,25 @@ module Lithic
 
         # Custom rates per category for penalties
         sig { returns(T.nilable(T.anything)) }
-        attr_reader :penalty_rates
-
-        sig { params(penalty_rates: T.anything).void }
-        attr_writer :penalty_rates
+        attr_accessor :penalty_rates
 
         # Name of a tier contained in the credit product. Mutually exclusive with
         # tier_rates
         sig { returns(T.nilable(String)) }
-        attr_reader :tier_name
-
-        sig { params(tier_name: String).void }
-        attr_writer :tier_name
+        attr_accessor :tier_name
 
         # Custom rates per category. Mutually exclusive with tier_name
         sig { returns(T.nilable(T.anything)) }
-        attr_reader :tier_rates
-
-        sig { params(tier_rates: T.anything).void }
-        attr_writer :tier_rates
+        attr_accessor :tier_rates
 
         # Entry in the Tier Schedule of an account
         sig do
           params(
             credit_product_token: String,
             effective_date: Date,
-            penalty_rates: T.anything,
-            tier_name: String,
-            tier_rates: T.anything
+            penalty_rates: T.nilable(T.anything),
+            tier_name: T.nilable(String),
+            tier_rates: T.nilable(T.anything)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -72,9 +63,9 @@ module Lithic
             {
               credit_product_token: String,
               effective_date: Date,
-              penalty_rates: T.anything,
-              tier_name: String,
-              tier_rates: T.anything
+              penalty_rates: T.nilable(T.anything),
+              tier_name: T.nilable(String),
+              tier_rates: T.nilable(T.anything)
             }
           )
         end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbi

@@ -23,33 +23,24 @@ module Lithic
 
         # Custom rates per category for penalties
         sig { returns(T.nilable(T.anything)) }
-        attr_reader :penalty_rates
-
-        sig { params(penalty_rates: T.anything).void }
-        attr_writer :penalty_rates
+        attr_accessor :penalty_rates
 
         # Name of a tier contained in the credit product. Mutually exclusive with
         # tier_rates
         sig { returns(T.nilable(String)) }
-        attr_reader :tier_name
-
-        sig { params(tier_name: String).void }
-        attr_writer :tier_name
+        attr_accessor :tier_name
 
         # Custom rates per category. Mutually exclusive with tier_name
         sig { returns(T.nilable(T.anything)) }
-        attr_reader :tier_rates
-
-        sig { params(tier_rates: T.anything).void }
-        attr_writer :tier_rates
+        attr_accessor :tier_rates
 
         sig do
           params(
             financial_account_token: String,
             effective_date: Date,
-            penalty_rates: T.anything,
-            tier_name: String,
-            tier_rates: T.anything,
+            penalty_rates: T.nilable(T.anything),
+            tier_name: T.nilable(String),
+            tier_rates: T.nilable(T.anything),
             request_options: Lithic::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -72,9 +63,9 @@ module Lithic
             {
               financial_account_token: String,
               effective_date: Date,
-              penalty_rates: T.anything,
-              tier_name: String,
-              tier_rates: T.anything,
+              penalty_rates: T.nilable(T.anything),
+              tier_name: T.nilable(String),
+              tier_rates: T.nilable(T.anything),
               request_options: Lithic::RequestOptions
             }
           )

data/rbi/lithic/models/financial_accounts/loan_tape.rbi

@@ -120,6 +120,26 @@ module Lithic
         end
         attr_writer :payment_allocation
 
+        # Allocation of payments only, excluding credits
+        sig do
+          returns(
+            T.nilable(
+              Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation
+            )
+          )
+        end
+        attr_reader :payment_only_allocation
+
+        sig do
+          params(
+            payment_only_allocation:
+              T.nilable(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation::OrHash
+              )
+          ).void
+        end
+        attr_writer :payment_only_allocation
+
         sig { returns(Lithic::StatementTotals) }
         attr_reader :period_totals
 
@@ -188,6 +208,10 @@ module Lithic
               Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance::OrHash,
             payment_allocation:
               Lithic::FinancialAccounts::LoanTape::PaymentAllocation::OrHash,
+            payment_only_allocation:
+              T.nilable(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation::OrHash
+              ),
             period_totals: Lithic::StatementTotals::OrHash,
             previous_statement_balance:
               Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance::OrHash,
@@ -228,6 +252,8 @@ module Lithic
           interest_details:,
           minimum_payment_balance:,
           payment_allocation:,
+          # Allocation of payments only, excluding credits
+          payment_only_allocation:,
           period_totals:,
           previous_statement_balance:,
           # Balance at the start of the day
@@ -266,6 +292,10 @@ module Lithic
                 Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance,
               payment_allocation:
                 Lithic::FinancialAccounts::LoanTape::PaymentAllocation,
+              payment_only_allocation:
+                T.nilable(
+                  Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation
+                ),
               period_totals: Lithic::StatementTotals,
               previous_statement_balance:
                 Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance,
@@ -649,6 +679,20 @@ module Lithic
           end
           attr_writer :past_statements_due
 
+          # Amounts converted into installment plans
+          sig do
+            returns(T.nilable(Lithic::FinancialAccounts::CategoryBalances))
+          end
+          attr_reader :installments
+
+          sig do
+            params(
+              installments:
+                T.nilable(Lithic::FinancialAccounts::CategoryBalances::OrHash)
+            ).void
+          end
+          attr_writer :installments
+
           sig do
             params(
               due: Lithic::FinancialAccounts::CategoryBalances::OrHash,
@@ -656,7 +700,9 @@ module Lithic
                 Lithic::FinancialAccounts::CategoryBalances::OrHash,
               past_due: Lithic::FinancialAccounts::CategoryBalances::OrHash,
               past_statements_due:
-                Lithic::FinancialAccounts::CategoryBalances::OrHash
+                Lithic::FinancialAccounts::CategoryBalances::OrHash,
+              installments:
+                T.nilable(Lithic::FinancialAccounts::CategoryBalances::OrHash)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -670,7 +716,9 @@ module Lithic
             # Amount not paid off on previous due dates
             past_due:,
             # Amount due for the past billing cycles.
-            past_statements_due:
+            past_statements_due:,
+            # Amounts converted into installment plans
+            installments: nil
           )
           end
 
@@ -680,7 +728,10 @@ module Lithic
                 due: Lithic::FinancialAccounts::CategoryBalances,
                 next_statement_due: Lithic::FinancialAccounts::CategoryBalances,
                 past_due: Lithic::FinancialAccounts::CategoryBalances,
-                past_statements_due: Lithic::FinancialAccounts::CategoryBalances
+                past_statements_due:
+                  Lithic::FinancialAccounts::CategoryBalances,
+                installments:
+                  T.nilable(Lithic::FinancialAccounts::CategoryBalances)
               }
             )
           end
@@ -926,6 +977,95 @@ module Lithic
           end
         end
 
+        class PaymentOnlyAllocation < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :fee_details
+
+          sig do
+            params(fee_details: T.nilable(Lithic::CategoryDetails::OrHash)).void
+          end
+          attr_writer :fee_details
+
+          # Amount allocated to fees in cents
+          sig { returns(Integer) }
+          attr_accessor :fees
+
+          # Amount allocated to interest in cents
+          sig { returns(Integer) }
+          attr_accessor :interest
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :interest_details
+
+          sig do
+            params(
+              interest_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).void
+          end
+          attr_writer :interest_details
+
+          # Amount allocated to principal in cents
+          sig { returns(Integer) }
+          attr_accessor :principal
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :principal_details
+
+          sig do
+            params(
+              principal_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).void
+          end
+          attr_writer :principal_details
+
+          # Allocation of payments only, excluding credits
+          sig do
+            params(
+              fee_details: T.nilable(Lithic::CategoryDetails::OrHash),
+              fees: Integer,
+              interest: Integer,
+              interest_details: T.nilable(Lithic::CategoryDetails::OrHash),
+              principal: Integer,
+              principal_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            fee_details:,
+            # Amount allocated to fees in cents
+            fees:,
+            # Amount allocated to interest in cents
+            interest:,
+            interest_details:,
+            # Amount allocated to principal in cents
+            principal:,
+            principal_details:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                fee_details: T.nilable(Lithic::CategoryDetails),
+                fees: Integer,
+                interest: Integer,
+                interest_details: T.nilable(Lithic::CategoryDetails),
+                principal: Integer,
+                principal_details: T.nilable(Lithic::CategoryDetails)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi

@@ -238,6 +238,11 @@ module Lithic
                   :STABLECOIN,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
                 )
+              INTRA_BANK =
+                T.let(
+                  :INTRA_BANK,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
+                )
               BALANCE_OR_FUNDING =
                 T.let(
                   :BALANCE_OR_FUNDING,
@@ -757,6 +762,21 @@ module Lithic
                   :INTERNAL_ADJUSTMENT,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
                 )
+              INTRA_BANK_CANCELED =
+                T.let(
+                  :INTRA_BANK_CANCELED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              INTRA_BANK_INITIATED =
+                T.let(
+                  :INTRA_BANK_INITIATED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              INTRA_BANK_SETTLED =
+                T.let(
+                  :INTRA_BANK_SETTLED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
               LATE_PAYMENT =
                 T.let(
                   :LATE_PAYMENT,
@@ -897,6 +917,11 @@ module Lithic
                   :STABLECOIN_REJECTED,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
                 )
+              INSTANCE_TO_INSTANCE =
+                T.let(
+                  :INSTANCE_TO_INSTANCE,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
 
               sig do
                 override.returns(

data/rbi/lithic/models/financial_event.rbi

@@ -444,6 +444,18 @@ module Lithic
             :INTERNAL_ADJUSTMENT,
             Lithic::FinancialEvent::Type::TaggedSymbol
           )
+        INTRA_BANK_CANCELED =
+          T.let(
+            :INTRA_BANK_CANCELED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        INTRA_BANK_INITIATED =
+          T.let(
+            :INTRA_BANK_INITIATED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        INTRA_BANK_SETTLED =
+          T.let(:INTRA_BANK_SETTLED, Lithic::FinancialEvent::Type::TaggedSymbol)
         LATE_PAYMENT =
           T.let(:LATE_PAYMENT, Lithic::FinancialEvent::Type::TaggedSymbol)
         LATE_PAYMENT_REVERSAL =
@@ -528,6 +540,11 @@ module Lithic
             :STABLECOIN_REJECTED,
             Lithic::FinancialEvent::Type::TaggedSymbol
           )
+        INSTANCE_TO_INSTANCE =
+          T.let(
+            :INSTANCE_TO_INSTANCE,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(T::Array[Lithic::FinancialEvent::Type::TaggedSymbol])