lithic 0.20.0 → 0.21.0

data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InstallmentPlanListParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InstallmentPlanListParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Globally unique identifier for financial account.
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        # 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 installment plans in this state will be included.
+        sig do
+          returns(
+            T.nilable(
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::OrSymbol
+            )
+          )
+        end
+        attr_accessor :state
+
+        sig do
+          params(
+            financial_account_token: String,
+            ending_before: String,
+            page_size: Integer,
+            starting_after: String,
+            state:
+              T.nilable(
+                Lithic::FinancialAccounts::InstallmentPlanListParams::State::OrSymbol
+              ),
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Globally unique identifier for financial account.
+          financial_account_token:,
+          # 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 installment plans in this state will be included.
+          state: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              ending_before: String,
+              page_size: Integer,
+              starting_after: String,
+              state:
+                T.nilable(
+                  Lithic::FinancialAccounts::InstallmentPlanListParams::State::OrSymbol
+                ),
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Only installment plans in this state will be included.
+        module State
+          extend Lithic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Lithic::FinancialAccounts::InstallmentPlanListParams::State
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :PENDING,
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+            )
+          REBUILD_IN_PROGRESS =
+            T.let(
+              :REBUILD_IN_PROGRESS,
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+            )
+          FULLY_PAID =
+            T.let(
+              :FULLY_PAID,
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :CANCELLED,
+              Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Lithic::FinancialAccounts::InstallmentPlanListParams::State::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InstallmentPlanRetrieveParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InstallmentPlanRetrieveParams,
+              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
+
+        sig do
+          params(
+            financial_account_token: String,
+            installment_plan_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:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              installment_plan_token: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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/management_operation_create_params.rbi

@@ -266,6 +266,16 @@ module Lithic
             :INTEREST_REVERSAL,
             Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
           )
+        INSTALLMENT_FEE =
+          T.let(
+            :INSTALLMENT_FEE,
+            Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
+          )
+        INSTALLMENT_FEE_REVERSAL =
+          T.let(
+            :INSTALLMENT_FEE_REVERSAL,
+            Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
+          )
         LATE_PAYMENT =
           T.let(
             :LATE_PAYMENT,
@@ -356,6 +366,16 @@ module Lithic
             :MONTHLY_REVERSAL,
             Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
           )
+        FEE =
+          T.let(
+            :FEE,
+            Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
+          )
+        FEE_REVERSAL =
+          T.let(
+            :FEE_REVERSAL,
+            Lithic::ManagementOperationCreateParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/lithic/models/management_operation_transaction.rbi

@@ -592,6 +592,16 @@ module Lithic
               :INTEREST_REVERSAL,
               Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
             )
+          INSTALLMENT_FEE =
+            T.let(
+              :INSTALLMENT_FEE,
+              Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
+            )
+          INSTALLMENT_FEE_REVERSAL =
+            T.let(
+              :INSTALLMENT_FEE_REVERSAL,
+              Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
+            )
           LATE_PAYMENT =
             T.let(
               :LATE_PAYMENT,
@@ -682,6 +692,16 @@ module Lithic
               :MONTHLY_REVERSAL,
               Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
             )
+          FEE =
+            T.let(
+              :FEE,
+              Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
+            )
+          FEE_REVERSAL =
+            T.let(
+              :FEE_REVERSAL,
+              Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/lithic/models/parsed_webhook_event.rbi

@@ -24,6 +24,7 @@ module Lithic
             Lithic::BookTransferTransactionUpdatedWebhookEvent,
             Lithic::CardCreatedWebhookEvent,
             Lithic::CardConvertedWebhookEvent,
+            Lithic::CardPinUpdatedWebhookEvent,
             Lithic::CardRenewedWebhookEvent,
             Lithic::CardReissuedWebhookEvent,
             Lithic::CardShippedWebhookEvent,

data/rbi/lithic/models/payment.rbi

@@ -267,6 +267,8 @@ module Lithic
           T.let(:EXTERNAL_FEDNOW, Lithic::Payment::Category::TaggedSymbol)
         EXTERNAL_RTP =
           T.let(:EXTERNAL_RTP, Lithic::Payment::Category::TaggedSymbol)
+        EXTERNAL_STABLECOIN =
+          T.let(:EXTERNAL_STABLECOIN, Lithic::Payment::Category::TaggedSymbol)
         EXTERNAL_TRANSFER =
           T.let(:EXTERNAL_TRANSFER, Lithic::Payment::Category::TaggedSymbol)
         EXTERNAL_WIRE =