lithic 0.20.0 → 0.22.0

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/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,
@@ -926,6 +956,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/open_to_buy.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class FinancialAccountsOpenToBuy < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::FinancialAccountsOpenToBuy,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Funds available for card spend backed by this Security Account, in the
+        # currency's smallest unit (e.g., cents for USD). Equal to the sum of the amounts
+        # in `summary`, and reaches zero once outstanding spend has consumed all available
+        # funding
+        sig { returns(Integer) }
+        attr_accessor :open_to_buy
+
+        # Balances that open to buy is derived from
+        sig { returns(Lithic::FinancialAccounts::OpenToBuySummary) }
+        attr_reader :summary
+
+        sig do
+          params(
+            summary: Lithic::FinancialAccounts::OpenToBuySummary::OrHash
+          ).void
+        end
+        attr_writer :summary
+
+        # Open to Buy
+        sig do
+          params(
+            open_to_buy: Integer,
+            summary: Lithic::FinancialAccounts::OpenToBuySummary::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Funds available for card spend backed by this Security Account, in the
+          # currency's smallest unit (e.g., cents for USD). Equal to the sum of the amounts
+          # in `summary`, and reaches zero once outstanding spend has consumed all available
+          # funding
+          open_to_buy:,
+          # Balances that open to buy is derived from
+          summary:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              open_to_buy: Integer,
+              summary: Lithic::FinancialAccounts::OpenToBuySummary
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class OpenToBuyRetrieveParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::OpenToBuyRetrieveParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        sig do
+          params(
+            financial_account_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(financial_account_token:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class OpenToBuySummary < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::OpenToBuySummary,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Available balance of the Security Account backing card spend, in the currency's
+        # smallest unit (e.g., cents for USD)
+        sig { returns(Integer) }
+        attr_accessor :security
+
+        # Funding that has moved out of the Security Account to cover card spend Lithic
+        # has already paid out to the networks, in the currency's smallest unit (e.g.,
+        # cents for USD). Open to buy counts it alongside `security`, and it clears once
+        # collected from your business clients. Only Commercial Charge tracks this
+        # separately, so this is `null` for every other program setup
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :settled_funds
+
+        # Customer card spend that has not yet been collected, in the currency's smallest
+        # unit (e.g., cents for USD). Reported as a negative amount, because it reduces
+        # open to buy
+        sig { returns(Integer) }
+        attr_accessor :total_outstanding_spend
+
+        # Open to Buy Summary
+        sig do
+          params(
+            security: Integer,
+            settled_funds: T.nilable(Integer),
+            total_outstanding_spend: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Available balance of the Security Account backing card spend, in the currency's
+          # smallest unit (e.g., cents for USD)
+          security:,
+          # Funding that has moved out of the Security Account to cover card spend Lithic
+          # has already paid out to the networks, in the currency's smallest unit (e.g.,
+          # cents for USD). Open to buy counts it alongside `security`, and it clears once
+          # collected from your business clients. Only Commercial Charge tracks this
+          # separately, so this is `null` for every other program setup
+          settled_funds:,
+          # Customer card spend that has not yet been collected, in the currency's smallest
+          # unit (e.g., cents for USD). Reported as a negative amount, because it reduces
+          # open to buy
+          total_outstanding_spend:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              security: Integer,
+              settled_funds: T.nilable(Integer),
+              total_outstanding_spend: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -293,6 +293,11 @@ module Lithic
                   :EXTERNAL_RTP,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
                 )
+              EXTERNAL_STABLECOIN =
+                T.let(
+                  :EXTERNAL_STABLECOIN,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
+                )
               EXTERNAL_TRANSFER =
                 T.let(
                   :EXTERNAL_TRANSFER,
@@ -632,6 +637,31 @@ module Lithic
                   :EXTERNAL_RTP_SETTLED,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
                 )
+              EXTERNAL_STABLECOIN_CANCELED =
+                T.let(
+                  :EXTERNAL_STABLECOIN_CANCELED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              EXTERNAL_STABLECOIN_INITIATED =
+                T.let(
+                  :EXTERNAL_STABLECOIN_INITIATED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              EXTERNAL_STABLECOIN_RELEASED =
+                T.let(
+                  :EXTERNAL_STABLECOIN_RELEASED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              EXTERNAL_STABLECOIN_REVERSED =
+                T.let(
+                  :EXTERNAL_STABLECOIN_REVERSED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              EXTERNAL_STABLECOIN_SETTLED =
+                T.let(
+                  :EXTERNAL_STABLECOIN_SETTLED,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
               EXTERNAL_TRANSFER_CANCELED =
                 T.let(
                   :EXTERNAL_TRANSFER_CANCELED,
@@ -682,6 +712,16 @@ module Lithic
                   :EXTERNAL_WIRE_SETTLED,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
                 )
+              FEE =
+                T.let(
+                  :FEE,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              FEE_REVERSAL =
+                T.let(
+                  :FEE_REVERSAL,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
               FINANCIAL_AUTHORIZATION =
                 T.let(
                   :FINANCIAL_AUTHORIZATION,
@@ -692,6 +732,16 @@ module Lithic
                   :FINANCIAL_CREDIT_AUTHORIZATION,
                   Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
                 )
+              INSTALLMENT_FEE =
+                T.let(
+                  :INSTALLMENT_FEE,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
+              INSTALLMENT_FEE_REVERSAL =
+                T.let(
+                  :INSTALLMENT_FEE_REVERSAL,
+                  Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType::TaggedSymbol
+                )
               INTEREST =
                 T.let(
                   :INTEREST,

data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class TransactionCategoryBalances < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::TransactionCategoryBalances,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Amounts attributable to balance transfers
+        sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+        attr_reader :balance_transfers
+
+        sig do
+          params(
+            balance_transfers:
+              Lithic::FinancialAccounts::CategoryBalances::OrHash
+          ).void
+        end
+        attr_writer :balance_transfers
+
+        # Amounts attributable to cash advances
+        sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+        attr_reader :cash_advances
+
+        sig do
+          params(
+            cash_advances: Lithic::FinancialAccounts::CategoryBalances::OrHash
+          ).void
+        end
+        attr_writer :cash_advances
+
+        # Amounts attributable to purchases
+        sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+        attr_reader :purchases
+
+        sig do
+          params(
+            purchases: Lithic::FinancialAccounts::CategoryBalances::OrHash
+          ).void
+        end
+        attr_writer :purchases
+
+        sig do
+          params(
+            balance_transfers:
+              Lithic::FinancialAccounts::CategoryBalances::OrHash,
+            cash_advances: Lithic::FinancialAccounts::CategoryBalances::OrHash,
+            purchases: Lithic::FinancialAccounts::CategoryBalances::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Amounts attributable to balance transfers
+          balance_transfers:,
+          # Amounts attributable to cash advances
+          cash_advances:,
+          # Amounts attributable to purchases
+          purchases:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              balance_transfers: Lithic::FinancialAccounts::CategoryBalances,
+              cash_advances: Lithic::FinancialAccounts::CategoryBalances,
+              purchases: Lithic::FinancialAccounts::CategoryBalances
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_event.rbi

@@ -341,6 +341,31 @@ module Lithic
             :EXTERNAL_RTP_SETTLED,
             Lithic::FinancialEvent::Type::TaggedSymbol
           )
+        EXTERNAL_STABLECOIN_CANCELED =
+          T.let(
+            :EXTERNAL_STABLECOIN_CANCELED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        EXTERNAL_STABLECOIN_INITIATED =
+          T.let(
+            :EXTERNAL_STABLECOIN_INITIATED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        EXTERNAL_STABLECOIN_RELEASED =
+          T.let(
+            :EXTERNAL_STABLECOIN_RELEASED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        EXTERNAL_STABLECOIN_REVERSED =
+          T.let(
+            :EXTERNAL_STABLECOIN_REVERSED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
+        EXTERNAL_STABLECOIN_SETTLED =
+          T.let(
+            :EXTERNAL_STABLECOIN_SETTLED,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
         EXTERNAL_TRANSFER_CANCELED =
           T.let(
             :EXTERNAL_TRANSFER_CANCELED,
@@ -391,6 +416,9 @@ module Lithic
             :EXTERNAL_WIRE_SETTLED,
             Lithic::FinancialEvent::Type::TaggedSymbol
           )
+        FEE = T.let(:FEE, Lithic::FinancialEvent::Type::TaggedSymbol)
+        FEE_REVERSAL =
+          T.let(:FEE_REVERSAL, Lithic::FinancialEvent::Type::TaggedSymbol)
         FINANCIAL_AUTHORIZATION =
           T.let(
             :FINANCIAL_AUTHORIZATION,
@@ -401,6 +429,13 @@ module Lithic
             :FINANCIAL_CREDIT_AUTHORIZATION,
             Lithic::FinancialEvent::Type::TaggedSymbol
           )
+        INSTALLMENT_FEE =
+          T.let(:INSTALLMENT_FEE, Lithic::FinancialEvent::Type::TaggedSymbol)
+        INSTALLMENT_FEE_REVERSAL =
+          T.let(
+            :INSTALLMENT_FEE_REVERSAL,
+            Lithic::FinancialEvent::Type::TaggedSymbol
+          )
         INTEREST = T.let(:INTEREST, Lithic::FinancialEvent::Type::TaggedSymbol)
         INTEREST_REVERSAL =
           T.let(:INTEREST_REVERSAL, Lithic::FinancialEvent::Type::TaggedSymbol)

data/rbi/lithic/models/kyb.rbi

@@ -176,7 +176,8 @@ module Lithic
           end
 
         # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        # and KYC workflows.
         sig { returns(Lithic::Address) }
         attr_reader :address
 
@@ -228,7 +229,8 @@ module Lithic
         end
         def self.new(
           # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          # and KYC workflows.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,
@@ -366,7 +368,8 @@ module Lithic
           end
 
         # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        # and KYC workflows.
         sig { returns(Lithic::Address) }
         attr_reader :address
 
@@ -425,7 +428,8 @@ module Lithic
         end
         def self.new(
           # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          # and KYC workflows.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,