lithic 0.22.0 → 0.23.0

data/rbi/lithic/models/funding_event_list_params.rbi

@@ -11,6 +11,22 @@ module Lithic
           T.any(Lithic::FundingEventListParams, Lithic::Internal::AnyHash)
         end
 
+      # Date string in RFC 3339 format. Only entries created after the specified time
+      # will be included. UTC time zone.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :begin_
+
+      sig { params(begin_: Time).void }
+      attr_writer :begin_
+
+      # Date string in RFC 3339 format. Only entries created before the specified time
+      # will be included. UTC time zone.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :end_
+
+      sig { params(end_: Time).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)) }
@@ -19,6 +35,14 @@ module Lithic
       sig { params(ending_before: String).void }
       attr_writer :ending_before
 
+      # Only funding events with a settlement breakout for this network settlement date
+      # will be included.
+      sig { returns(T.nilable(Date)) }
+      attr_reader :network_settlement_date
+
+      sig { params(network_settlement_date: Date).void }
+      attr_writer :network_settlement_date
+
       # Page size (for pagination).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
@@ -36,16 +60,28 @@ module Lithic
 
       sig do
         params(
+          begin_: Time,
+          end_: Time,
           ending_before: String,
+          network_settlement_date: Date,
           page_size: Integer,
           starting_after: String,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
+        begin_: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
+        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,
+        # Only funding events with a settlement breakout for this network settlement date
+        # will be included.
+        network_settlement_date: nil,
         # Page size (for pagination).
         page_size: nil,
         # A cursor representing an item's token after which a page of results should
@@ -58,7 +94,10 @@ module Lithic
       sig do
         override.returns(
           {
+            begin_: Time,
+            end_: Time,
             ending_before: String,
+            network_settlement_date: Date,
             page_size: Integer,
             starting_after: String,
             request_options: Lithic::RequestOptions

data/rbi/lithic/models/hold.rbi

@@ -13,10 +13,6 @@ module Lithic
       sig { returns(Time) }
       attr_accessor :created
 
-      # Status of a hold transaction
-      sig { returns(Lithic::Hold::Status::TaggedSymbol) }
-      attr_accessor :status
-
       # ISO 8601 timestamp of when the transaction was last updated
       sig { returns(Time) }
       attr_accessor :updated
@@ -63,6 +59,13 @@ module Lithic
       sig { params(result: Lithic::Hold::Result::OrSymbol).void }
       attr_writer :result
 
+      # Status of a hold transaction
+      sig { returns(T.nilable(Lithic::Hold::Status::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Lithic::Hold::Status::OrSymbol).void }
+      attr_writer :status
+
       sig { returns(T.nilable(String)) }
       attr_accessor :user_defined_id
 
@@ -74,7 +77,6 @@ module Lithic
         params(
           token: String,
           created: Time,
-          status: Lithic::Hold::Status::OrSymbol,
           updated: Time,
           currency: String,
           events: T::Array[Lithic::HoldEvent::OrHash],
@@ -83,6 +85,7 @@ module Lithic
           financial_account_token: String,
           pending_amount: Integer,
           result: Lithic::Hold::Result::OrSymbol,
+          status: Lithic::Hold::Status::OrSymbol,
           user_defined_id: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -91,8 +94,6 @@ module Lithic
         token:,
         # ISO 8601 timestamp of when the transaction was created
         created:,
-        # Status of a hold transaction
-        status:,
         # ISO 8601 timestamp of when the transaction was last updated
         updated:,
         currency: nil,
@@ -105,6 +106,8 @@ module Lithic
         # Current pending amount (0 when resolved)
         pending_amount: nil,
         result: nil,
+        # Status of a hold transaction
+        status: nil,
         user_defined_id: nil
       )
       end
@@ -114,7 +117,6 @@ module Lithic
           {
             token: String,
             created: Time,
-            status: Lithic::Hold::Status::TaggedSymbol,
             updated: Time,
             currency: String,
             events: T::Array[Lithic::HoldEvent],
@@ -123,6 +125,7 @@ module Lithic
             financial_account_token: String,
             pending_amount: Integer,
             result: Lithic::Hold::Result::TaggedSymbol,
+            status: Lithic::Hold::Status::TaggedSymbol,
             user_defined_id: T.nilable(String)
           }
         )
@@ -130,27 +133,6 @@ module Lithic
       def to_hash
       end
 
-      # Status of a hold transaction
-      module Status
-        extend Lithic::Internal::Type::Enum
-
-        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Hold::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PENDING = T.let(:PENDING, Lithic::Hold::Status::TaggedSymbol)
-        SETTLED = T.let(:SETTLED, Lithic::Hold::Status::TaggedSymbol)
-        EXPIRED = T.let(:EXPIRED, Lithic::Hold::Status::TaggedSymbol)
-        VOIDED = T.let(:VOIDED, Lithic::Hold::Status::TaggedSymbol)
-        DECLINED = T.let(:DECLINED, Lithic::Hold::Status::TaggedSymbol)
-        REVERSED = T.let(:REVERSED, Lithic::Hold::Status::TaggedSymbol)
-        CANCELED = T.let(:CANCELED, Lithic::Hold::Status::TaggedSymbol)
-        RETURNED = T.let(:RETURNED, Lithic::Hold::Status::TaggedSymbol)
-
-        sig { override.returns(T::Array[Lithic::Hold::Status::TaggedSymbol]) }
-        def self.values
-        end
-      end
-
       # HOLD - Hold Transaction
       module Family
         extend Lithic::Internal::Type::Enum
@@ -178,6 +160,23 @@ module Lithic
         def self.values
         end
       end
+
+      # Status of a hold transaction
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Hold::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:PENDING, Lithic::Hold::Status::TaggedSymbol)
+        SETTLED = T.let(:SETTLED, Lithic::Hold::Status::TaggedSymbol)
+        EXPIRED = T.let(:EXPIRED, Lithic::Hold::Status::TaggedSymbol)
+        VOIDED = T.let(:VOIDED, Lithic::Hold::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Hold::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/lithic/models/ip_range_retrieve_params.rbi

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

data/rbi/lithic/models/ip_range_retrieve_response.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class IPRangeRetrieveResponse < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Lithic::Models::IPRangeRetrieveResponse,
+            Lithic::Internal::AnyHash
+          )
+        end
+
+      # IP ranges that responder requests are sent from, in CIDR notation
+      sig { returns(T::Array[String]) }
+      attr_accessor :responders
+
+      # Date and time the IP ranges were last changed
+      sig { returns(Time) }
+      attr_accessor :updated
+
+      sig do
+        params(responders: T::Array[String], updated: Time).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # IP ranges that responder requests are sent from, in CIDR notation
+        responders:,
+        # Date and time the IP ranges were last changed
+        updated:
+      )
+      end
+
+      sig { override.returns({ responders: T::Array[String], updated: Time }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lithic/models/payment.rbi

@@ -252,6 +252,7 @@ module Lithic
         ACH = T.let(:ACH, Lithic::Payment::Category::TaggedSymbol)
         WIRE = T.let(:WIRE, Lithic::Payment::Category::TaggedSymbol)
         STABLECOIN = T.let(:STABLECOIN, Lithic::Payment::Category::TaggedSymbol)
+        INTRA_BANK = T.let(:INTRA_BANK, Lithic::Payment::Category::TaggedSymbol)
         BALANCE_OR_FUNDING =
           T.let(:BALANCE_OR_FUNDING, Lithic::Payment::Category::TaggedSymbol)
         FEE = T.let(:FEE, Lithic::Payment::Category::TaggedSymbol)

data/rbi/lithic/models/transaction.rbi

@@ -108,10 +108,12 @@ module Lithic
       sig { returns(T.nilable(Integer)) }
       attr_accessor :network_risk_score
 
-      sig { returns(Lithic::Transaction::Pos) }
+      # Point of sale data for the transaction. Null when no point of sale data is
+      # available, such as clearing-only records that never went through authorization
+      sig { returns(T.nilable(Lithic::Transaction::Pos)) }
       attr_reader :pos
 
-      sig { params(pos: Lithic::Transaction::Pos::OrHash).void }
+      sig { params(pos: T.nilable(Lithic::Transaction::Pos::OrHash)).void }
       attr_writer :pos
 
       sig { returns(Lithic::Transaction::Result::TaggedSymbol) }
@@ -183,7 +185,7 @@ module Lithic
           merchant_currency: String,
           network: T.nilable(Lithic::Transaction::Network::OrSymbol),
           network_risk_score: T.nilable(Integer),
-          pos: Lithic::Transaction::Pos::OrHash,
+          pos: T.nilable(Lithic::Transaction::Pos::OrHash),
           result: Lithic::Transaction::Result::OrSymbol,
           service_location:
             T.nilable(Lithic::Transaction::ServiceLocation::OrHash),
@@ -243,6 +245,8 @@ module Lithic
         # score has a range of 0-99, Lithic will normalize the score by multiplying the
         # raw score by 10x.
         network_risk_score:,
+        # Point of sale data for the transaction. Null when no point of sale data is
+        # available, such as clearing-only records that never went through authorization
         pos:,
         result:,
         # Where the cardholder received the service, when different from the card acceptor
@@ -287,7 +291,7 @@ module Lithic
             merchant_currency: String,
             network: T.nilable(Lithic::Transaction::Network::TaggedSymbol),
             network_risk_score: T.nilable(Integer),
-            pos: Lithic::Transaction::Pos,
+            pos: T.nilable(Lithic::Transaction::Pos),
             result: Lithic::Transaction::Result::TaggedSymbol,
             service_location: T.nilable(Lithic::Transaction::ServiceLocation),
             settled_amount: Integer,
@@ -605,6 +609,7 @@ module Lithic
           T.type_alias { T.all(Symbol, Lithic::Transaction::Network) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        ALLPOINT = T.let(:ALLPOINT, Lithic::Transaction::Network::TaggedSymbol)
         AMEX = T.let(:AMEX, Lithic::Transaction::Network::TaggedSymbol)
         INTERLINK =
           T.let(:INTERLINK, Lithic::Transaction::Network::TaggedSymbol)
@@ -643,6 +648,8 @@ module Lithic
         end
         attr_writer :terminal
 
+        # Point of sale data for the transaction. Null when no point of sale data is
+        # available, such as clearing-only records that never went through authorization
         sig do
           params(
             entry_mode: Lithic::Transaction::Pos::EntryMode::OrHash,

data/rbi/lithic/models/transactions/events/enhanced_data.rbi

@@ -174,7 +174,8 @@ module Lithic
                   )
                 end
 
-              # The price of the item purchased in merchant currency.
+              # Deprecated: Use unit_amount instead. The price of the item purchased in merchant
+              # currency.
               sig { returns(T.nilable(String)) }
               attr_accessor :amount
 
@@ -190,24 +191,41 @@ module Lithic
               sig { returns(T.nilable(String)) }
               attr_accessor :quantity
 
+              # The total cost for the line item in merchant currency, covering all units
+              # purchased.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :total_amount
+
+              # The price per individual unit in merchant currency.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :unit_amount
+
               # An L2/L3 enhanced commercial data line item.
               sig do
                 params(
                   amount: T.nilable(String),
                   description: T.nilable(String),
                   product_code: T.nilable(String),
-                  quantity: T.nilable(String)
+                  quantity: T.nilable(String),
+                  total_amount: T.nilable(String),
+                  unit_amount: T.nilable(String)
                 ).returns(T.attached_class)
               end
               def self.new(
-                # The price of the item purchased in merchant currency.
+                # Deprecated: Use unit_amount instead. The price of the item purchased in merchant
+                # currency.
                 amount: nil,
                 # A human-readable description of the item.
                 description: nil,
                 # An identifier for the item purchased.
                 product_code: nil,
                 # The quantity of the item purchased.
-                quantity: nil
+                quantity: nil,
+                # The total cost for the line item in merchant currency, covering all units
+                # purchased.
+                total_amount: nil,
+                # The price per individual unit in merchant currency.
+                unit_amount: nil
               )
               end
 
@@ -217,7 +235,9 @@ module Lithic
                     amount: T.nilable(String),
                     description: T.nilable(String),
                     product_code: T.nilable(String),
-                    quantity: T.nilable(String)
+                    quantity: T.nilable(String),
+                    total_amount: T.nilable(String),
+                    unit_amount: T.nilable(String)
                   }
                 )
               end

data/rbi/lithic/models/transfer_limits_response.rbi

@@ -70,6 +70,10 @@ module Lithic
         sig { returns(Date) }
         attr_accessor :date
 
+        # Financial entity ID the limits are scoped to
+        sig { returns(String) }
+        attr_accessor :financial_entity_id
+
         # Whether the company is a FBO; based on the company ID prefix
         sig { returns(T::Boolean) }
         attr_accessor :is_fbo
@@ -108,6 +112,7 @@ module Lithic
             daily_limit:
               Lithic::TransferLimitsResponse::Data::DailyLimit::OrHash,
             date: Date,
+            financial_entity_id: String,
             is_fbo: T::Boolean,
             monthly_limit:
               Lithic::TransferLimitsResponse::Data::MonthlyLimit::OrHash,
@@ -122,6 +127,8 @@ module Lithic
           daily_limit:,
           # The date for the limit view (ISO format)
           date:,
+          # Financial entity ID the limits are scoped to
+          financial_entity_id:,
           # Whether the company is a FBO; based on the company ID prefix
           is_fbo:,
           # Monthly limits with progress
@@ -137,6 +144,7 @@ module Lithic
               company_id: String,
               daily_limit: Lithic::TransferLimitsResponse::Data::DailyLimit,
               date: Date,
+              financial_entity_id: String,
               is_fbo: T::Boolean,
               monthly_limit: Lithic::TransferLimitsResponse::Data::MonthlyLimit,
               program_limit_per_transaction:

data/rbi/lithic/models.rbi

@@ -438,6 +438,8 @@ module Lithic
   InternalTransactionUpdatedWebhookEvent =
     Lithic::Models::InternalTransactionUpdatedWebhookEvent
 
+  IPRangeRetrieveParams = Lithic::Models::IPRangeRetrieveParams
+
   KYB = Lithic::Models::KYB
 
   KYBBusinessEntity = Lithic::Models::KYBBusinessEntity

data/rbi/lithic/resources/cards/financial_transactions.rbi

@@ -29,13 +29,14 @@ module Lithic
               Lithic::Cards::FinancialTransactionListParams::Category::OrSymbol,
             end_: Time,
             ending_before: String,
+            page_size: Integer,
             result:
               Lithic::Cards::FinancialTransactionListParams::Result::OrSymbol,
             starting_after: String,
             status:
               Lithic::Cards::FinancialTransactionListParams::Status::OrSymbol,
             request_options: Lithic::RequestOptions::OrHash
-          ).returns(Lithic::Internal::SinglePage[Lithic::FinancialTransaction])
+          ).returns(Lithic::Internal::CursorPage[Lithic::FinancialTransaction])
         end
         def list(
           card_token,
@@ -50,6 +51,8 @@ module Lithic
           # 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,
           # Financial Transaction result to be returned.
           result: nil,
           # A cursor representing an item's token after which a page of results should

data/rbi/lithic/resources/financial_accounts/credit_configuration.rbi

@@ -18,7 +18,10 @@ module Lithic
         )
         end
 
-        # Update an account's credit configuration
+        # Update an account's credit configuration. A credit product can only be attached
+        # while the financial account is in the `PENDING` state; once a credit product has
+        # been assigned the account transitions to `OPEN` and `credit_product_token` can
+        # no longer be changed
         sig do
           params(
             financial_account_token: String,
@@ -36,7 +39,10 @@ module Lithic
           financial_account_token,
           auto_collection_configuration: nil,
           credit_limit: nil,
-          # Globally unique identifier for the credit product
+          # Globally unique identifier for the credit product. This can only be set while
+          # the financial account is in the `PENDING` state. Because assigning a credit
+          # product transitions the account to `OPEN`, a credit product can be attached only
+          # once; updating it on an account in any other state returns a `403`
           credit_product_token: nil,
           external_bank_account_token: nil,
           # Tier to assign to a financial account

data/rbi/lithic/resources/financial_accounts/financial_transactions.rbi

@@ -30,13 +30,14 @@ module Lithic
               Lithic::FinancialAccounts::FinancialTransactionListParams::Category::OrSymbol,
             end_: Time,
             ending_before: String,
+            page_size: Integer,
             result:
               Lithic::FinancialAccounts::FinancialTransactionListParams::Result::OrSymbol,
             starting_after: String,
             status:
               Lithic::FinancialAccounts::FinancialTransactionListParams::Status::OrSymbol,
             request_options: Lithic::RequestOptions::OrHash
-          ).returns(Lithic::Internal::SinglePage[Lithic::FinancialTransaction])
+          ).returns(Lithic::Internal::CursorPage[Lithic::FinancialTransaction])
         end
         def list(
           # Globally unique identifier for financial account.
@@ -52,6 +53,8 @@ module Lithic
           # 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,
           # Financial Transaction result to be returned.
           result: nil,
           # A cursor representing an item's token after which a page of results should

data/rbi/lithic/resources/financial_accounts/interest_tier_schedule.rbi

@@ -10,9 +10,9 @@ module Lithic
             financial_account_token: String,
             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),
             request_options: Lithic::RequestOptions::OrHash
           ).returns(
             Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule
@@ -60,9 +60,9 @@ module Lithic
           params(
             effective_date: Date,
             financial_account_token: String,
-            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(
             Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule

data/rbi/lithic/resources/funding_events.rbi

@@ -20,16 +20,28 @@ module Lithic
       # Get all funding events for program
       sig do
         params(
+          begin_: Time,
+          end_: Time,
           ending_before: String,
+          network_settlement_date: Date,
           page_size: Integer,
           starting_after: String,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(Lithic::Internal::CursorPage[Lithic::FundingEvent])
       end
       def list(
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
+        begin_: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
+        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,
+        # Only funding events with a settlement breakout for this network settlement date
+        # will be included.
+        network_settlement_date: nil,
         # Page size (for pagination).
         page_size: nil,
         # A cursor representing an item's token after which a page of results should

data/rbi/lithic/resources/ip_ranges.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class IPRanges
+      # Returns the IP addresses Lithic sends responder requests from (Auth Stream
+      # Access, 3DS decisioning, and tokenization decisioning), so you can allowlist
+      # them in your firewall. Each environment returns its own set of addresses. Lithic
+      # announces new addresses at least 30 days before sending traffic from them. Event
+      # webhooks are not sent from these addresses
+      sig do
+        params(request_options: Lithic::RequestOptions::OrHash).returns(
+          Lithic::Models::IPRangeRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/lithic/client.rbs

@@ -53,6 +53,8 @@ module Lithic
 
     attr_reader responder_endpoints: Lithic::Resources::ResponderEndpoints
 
+    attr_reader ip_ranges: Lithic::Resources::IPRanges
+
     attr_reader external_bank_accounts: Lithic::Resources::ExternalBankAccounts
 
     attr_reader blockchain_recipients: Lithic::Resources::BlockchainRecipients

data/sig/lithic/models/account_activity_list_params.rbs

@@ -104,6 +104,7 @@ module Lithic
         :ACH
         | :WIRE
         | :STABLECOIN
+        | :INTRA_BANK
         | :BALANCE_OR_FUNDING
         | :FEE
         | :REWARD
@@ -133,6 +134,7 @@ module Lithic
         ACH: :ACH
         WIRE: :WIRE
         STABLECOIN: :STABLECOIN
+        INTRA_BANK: :INTRA_BANK
         BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
         FEE: :FEE
         REWARD: :REWARD