lithic 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

data/rbi/lithic/models/funding_event_list_response.rbi

@@ -23,7 +23,8 @@ module Lithic
       end
       attr_accessor :collection_resource_type
 
-      # IDs of collections
+      # IDs of collections, further information can be gathered from the appropriate
+      # collection API based on collection_resource_type
       sig { returns(T::Array[String]) }
       attr_accessor :collection_tokens
 
@@ -35,19 +36,19 @@ module Lithic
       sig { returns(Time) }
       attr_accessor :high_watermark
 
-      # Time of the previous high watermark
-      sig { returns(Time) }
-      attr_accessor :previous_high_watermark
-
-      # List of settlements
+      # Network settlement summary breakdown by network settlement date
       sig do
         returns(
           T::Array[
-            Lithic::Models::FundingEventListResponse::SettlementBreakdown
+            Lithic::Models::FundingEventListResponse::NetworkSettlementSummary
           ]
         )
       end
-      attr_accessor :settlement_breakdowns
+      attr_accessor :network_settlement_summary
+
+      # Time of the previous high watermark
+      sig { returns(Time) }
+      attr_accessor :previous_high_watermark
 
       # Time of the update
       sig { returns(Time) }
@@ -61,11 +62,11 @@ module Lithic
           collection_tokens: T::Array[String],
           created: Time,
           high_watermark: Time,
-          previous_high_watermark: Time,
-          settlement_breakdowns:
+          network_settlement_summary:
             T::Array[
-              Lithic::Models::FundingEventListResponse::SettlementBreakdown::OrHash
+              Lithic::Models::FundingEventListResponse::NetworkSettlementSummary::OrHash
             ],
+          previous_high_watermark: Time,
           updated: Time
         ).returns(T.attached_class)
       end
@@ -74,16 +75,17 @@ module Lithic
         token:,
         # Collection resource type
         collection_resource_type:,
-        # IDs of collections
+        # IDs of collections, further information can be gathered from the appropriate
+        # collection API based on collection_resource_type
         collection_tokens:,
         # Time of the creation
         created:,
         # Time of the high watermark
         high_watermark:,
+        # Network settlement summary breakdown by network settlement date
+        network_settlement_summary:,
         # Time of the previous high watermark
         previous_high_watermark:,
-        # List of settlements
-        settlement_breakdowns:,
         # Time of the update
         updated:
       )
@@ -98,11 +100,11 @@ module Lithic
             collection_tokens: T::Array[String],
             created: Time,
             high_watermark: Time,
-            previous_high_watermark: Time,
-            settlement_breakdowns:
+            network_settlement_summary:
               T::Array[
-                Lithic::Models::FundingEventListResponse::SettlementBreakdown
+                Lithic::Models::FundingEventListResponse::NetworkSettlementSummary
               ],
+            previous_high_watermark: Time,
             updated: Time
           }
         )
@@ -145,30 +147,35 @@ module Lithic
         end
       end
 
-      class SettlementBreakdown < Lithic::Internal::Type::BaseModel
+      class NetworkSettlementSummary < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Lithic::Models::FundingEventListResponse::SettlementBreakdown,
+              Lithic::Models::FundingEventListResponse::NetworkSettlementSummary,
               Lithic::Internal::AnyHash
             )
           end
 
-        sig { returns(Integer) }
-        attr_accessor :amount
-
         sig { returns(Date) }
-        attr_accessor :settlement_date
+        attr_accessor :network_settlement_date
+
+        sig { returns(Integer) }
+        attr_accessor :settled_gross_amount
 
         sig do
-          params(amount: Integer, settlement_date: Date).returns(
-            T.attached_class
-          )
+          params(
+            network_settlement_date: Date,
+            settled_gross_amount: Integer
+          ).returns(T.attached_class)
         end
-        def self.new(amount:, settlement_date:)
+        def self.new(network_settlement_date:, settled_gross_amount:)
         end
 
-        sig { override.returns({ amount: Integer, settlement_date: Date }) }
+        sig do
+          override.returns(
+            { network_settlement_date: Date, settled_gross_amount: Integer }
+          )
+        end
         def to_hash
         end
       end

data/rbi/lithic/models/funding_event_retrieve_response.rbi

@@ -23,7 +23,8 @@ module Lithic
       end
       attr_accessor :collection_resource_type
 
-      # IDs of collections
+      # IDs of collections, further information can be gathered from the appropriate
+      # collection API based on collection_resource_type
       sig { returns(T::Array[String]) }
       attr_accessor :collection_tokens
 
@@ -35,19 +36,19 @@ module Lithic
       sig { returns(Time) }
       attr_accessor :high_watermark
 
-      # Time of the previous high watermark
-      sig { returns(Time) }
-      attr_accessor :previous_high_watermark
-
-      # List of settlements
+      # Network settlement summary breakdown by network settlement date
       sig do
         returns(
           T::Array[
-            Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown
+            Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary
           ]
         )
       end
-      attr_accessor :settlement_breakdowns
+      attr_accessor :network_settlement_summary
+
+      # Time of the previous high watermark
+      sig { returns(Time) }
+      attr_accessor :previous_high_watermark
 
       # Time of the update
       sig { returns(Time) }
@@ -61,11 +62,11 @@ module Lithic
           collection_tokens: T::Array[String],
           created: Time,
           high_watermark: Time,
-          previous_high_watermark: Time,
-          settlement_breakdowns:
+          network_settlement_summary:
             T::Array[
-              Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown::OrHash
+              Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary::OrHash
             ],
+          previous_high_watermark: Time,
           updated: Time
         ).returns(T.attached_class)
       end
@@ -74,16 +75,17 @@ module Lithic
         token:,
         # Collection resource type
         collection_resource_type:,
-        # IDs of collections
+        # IDs of collections, further information can be gathered from the appropriate
+        # collection API based on collection_resource_type
         collection_tokens:,
         # Time of the creation
         created:,
         # Time of the high watermark
         high_watermark:,
+        # Network settlement summary breakdown by network settlement date
+        network_settlement_summary:,
         # Time of the previous high watermark
         previous_high_watermark:,
-        # List of settlements
-        settlement_breakdowns:,
         # Time of the update
         updated:
       )
@@ -98,11 +100,11 @@ module Lithic
             collection_tokens: T::Array[String],
             created: Time,
             high_watermark: Time,
-            previous_high_watermark: Time,
-            settlement_breakdowns:
+            network_settlement_summary:
               T::Array[
-                Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown
+                Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary
               ],
+            previous_high_watermark: Time,
             updated: Time
           }
         )
@@ -145,30 +147,35 @@ module Lithic
         end
       end
 
-      class SettlementBreakdown < Lithic::Internal::Type::BaseModel
+      class NetworkSettlementSummary < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown,
+              Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary,
               Lithic::Internal::AnyHash
             )
           end
 
-        sig { returns(Integer) }
-        attr_accessor :amount
-
         sig { returns(Date) }
-        attr_accessor :settlement_date
+        attr_accessor :network_settlement_date
+
+        sig { returns(Integer) }
+        attr_accessor :settled_gross_amount
 
         sig do
-          params(amount: Integer, settlement_date: Date).returns(
-            T.attached_class
-          )
+          params(
+            network_settlement_date: Date,
+            settled_gross_amount: Integer
+          ).returns(T.attached_class)
         end
-        def self.new(amount:, settlement_date:)
+        def self.new(network_settlement_date:, settled_gross_amount:)
         end
 
-        sig { override.returns({ amount: Integer, settlement_date: Date }) }
+        sig do
+          override.returns(
+            { network_settlement_date: Date, settled_gross_amount: Integer }
+          )
+        end
         def to_hash
         end
       end

data/rbi/lithic/models/payment.rbi

@@ -255,7 +255,7 @@ module Lithic
         # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
         # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
         # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
-        #   the fed.
+        #   the Federal Reserve.
         # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
         # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
         #   available balance.
@@ -318,7 +318,7 @@ module Lithic
           # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
           # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
           # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
-          #   the fed.
+          #   the Federal Reserve.
           # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
           # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
           #   available balance.
@@ -383,7 +383,7 @@ module Lithic
         # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
         # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
         # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
-        #   the fed.
+        #   the Federal Reserve.
         # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
         # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
         #   available balance.

data/rbi/lithic/models/required_document.rbi

@@ -12,7 +12,7 @@ module Lithic
       sig { returns(String) }
       attr_accessor :entity_token
 
-      # rovides the status reasons that will be satisfied by providing one of the valid
+      # Provides the status reasons that will be satisfied by providing one of the valid
       # documents.
       sig { returns(T::Array[String]) }
       attr_accessor :status_reasons
@@ -32,7 +32,7 @@ module Lithic
       def self.new(
         # Globally unique identifier for an entity.
         entity_token:,
-        # rovides the status reasons that will be satisfied by providing one of the valid
+        # Provides the status reasons that will be satisfied by providing one of the valid
         # documents.
         status_reasons:,
         # A list of valid documents that will satisfy the KYC requirements for the

data/rbi/lithic/models/transaction.rbi

@@ -21,7 +21,8 @@ module Lithic
       attr_accessor :acquirer_fee
 
       # Unique identifier assigned to a transaction by the acquirer that can be used in
-      # dispute and chargeback filing.
+      # dispute and chargeback filing. This field has been deprecated in favor of the
+      # `acquirer_reference_number` that resides in the event-level `network_info`.
       sig { returns(T.nilable(String)) }
       attr_accessor :acquirer_reference_number
 
@@ -180,7 +181,8 @@ module Lithic
         # as a negative value to indicate credited fees.
         acquirer_fee:,
         # Unique identifier assigned to a transaction by the acquirer that can be used in
-        # dispute and chargeback filing.
+        # dispute and chargeback filing. This field has been deprecated in favor of the
+        # `acquirer_reference_number` that resides in the event-level `network_info`.
         acquirer_reference_number:,
         # When the transaction is pending, this represents the authorization amount of the
         # transaction in the anticipated settlement currency. Once the transaction has

data/rbi/lithic/resources/accounts.rbi

@@ -53,8 +53,8 @@ module Lithic
         state: nil,
         # Address used during Address Verification Service (AVS) checks during
         # transactions if enabled via Auth Rules. This field is deprecated as AVS checks
-        # are no longer supported by Authorization Rules. The field will be removed from
-        # the schema in a future release.
+        # are no longer supported by Auth Rules. The field will be removed from the schema
+        # in a future release.
         verification_address: nil,
         request_options: {}
       )

data/rbi/lithic/resources/auth_rules/v2/backtests.rbi

@@ -5,16 +5,15 @@ module Lithic
     class AuthRules
       class V2
         class Backtests
-          # Initiates a request to asynchronously generate a backtest for an authorization
-          # rule. During backtesting, both the active version (if one exists) and the draft
-          # version of the Authorization Rule are evaluated by replaying historical
-          # transaction data against the rule's conditions. This process allows customers to
-          # simulate and understand the effects of proposed rule changes before deployment.
-          # The generated backtest report provides detailed results showing whether the
-          # draft version of the Auth Rule would have approved or declined historical
-          # transactions which were processed during the backtest period. These reports help
-          # evaluate how changes to rule configurations might affect overall transaction
-          # approval rates.
+          # Initiates a request to asynchronously generate a backtest for an Auth rule.
+          # During backtesting, both the active version (if one exists) and the draft
+          # version of the Auth Rule are evaluated by replaying historical transaction data
+          # against the rule's conditions. This process allows customers to simulate and
+          # understand the effects of proposed rule changes before deployment. The generated
+          # backtest report provides detailed results showing whether the draft version of
+          # the Auth Rule would have approved or declined historical transactions which were
+          # processed during the backtest period. These reports help evaluate how changes to
+          # rule configurations might affect overall transaction approval rates.
           #
           # The generated backtest report will be delivered asynchronously through a webhook
           # with `event_type` = `auth_rules.backtest_report.created`. See the docs on
@@ -49,7 +48,7 @@ module Lithic
           )
           end
 
-          # Returns the backtest results of an authorization rule (if available).
+          # Returns the backtest results of an Auth rule (if available).
           #
           # Backtesting is an asynchronous process that requires time to complete. If a
           # customer retrieves the backtest results using this endpoint before the report is
@@ -65,8 +64,8 @@ module Lithic
           # also always represent the configuration of the rule at the time requests are
           # made to this endpoint. For example, the results for `current_version` in the
           # served backtest report will be consistent with which version of the rule is
-          # currently activated in the Auth Stream, regardless of which version of the rule
-          # was active in the Auth Stream at the time a backtest is requested.
+          # currently activated in the respective event stream, regardless of which version
+          # of the rule was active in the event stream at the time a backtest is requested.
           sig do
             params(
               auth_rule_backtest_token: String,

data/rbi/lithic/resources/auth_rules/v2.rbi

@@ -7,7 +7,7 @@ module Lithic
         sig { returns(Lithic::Resources::AuthRules::V2::Backtests) }
         attr_reader :backtests
 
-        # Creates a new V2 authorization rule in draft mode
+        # Creates a new V2 Auth rule in draft mode
         sig do
           params(
             account_tokens: T::Array[String],
@@ -18,7 +18,8 @@ module Lithic
               T.any(
                 Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                 Lithic::AuthRules::VelocityLimitParams::OrHash,
-                Lithic::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::OrHash
+                Lithic::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::OrHash,
+                Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::OrHash
               ),
             type: Lithic::AuthRules::V2CreateParams::Type::OrSymbol,
             excluded_card_tokens: T::Array[String],
@@ -36,7 +37,13 @@ module Lithic
           name: nil,
           # Parameters for the Auth Rule
           parameters: nil,
-          # The type of Auth Rule
+          # The type of Auth Rule. Effectively determines the event stream during which it
+          # will be evaluated.
+          #
+          # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
+          # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+          # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+          # - `CONDITIONAL_3DS_ACTION`: THREE_DS_AUTHENTICATION event stream.
           type: nil,
           # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
@@ -44,7 +51,7 @@ module Lithic
         )
         end
 
-        # Fetches a V2 authorization rule by its token
+        # Fetches a V2 Auth rule by its token
         sig do
           params(
             auth_rule_token: String,
@@ -58,7 +65,7 @@ module Lithic
         )
         end
 
-        # Updates a V2 authorization rule's properties
+        # Updates a V2 Auth rule's properties
         #
         # If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
         # is provided, this will replace existing associations with the provided list of
@@ -98,12 +105,14 @@ module Lithic
         )
         end
 
-        # Lists V2 authorization rules
+        # Lists V2 Auth rules
         sig do
           params(
             account_token: String,
             card_token: String,
             ending_before: String,
+            event_stream:
+              Lithic::AuthRules::V2ListParams::EventStream::OrSymbol,
             page_size: Integer,
             scope: Lithic::AuthRules::V2ListParams::Scope::OrSymbol,
             starting_after: String,
@@ -115,16 +124,18 @@ module Lithic
           )
         end
         def list(
-          # Only return Authorization Rules that are bound to the provided account token.
+          # Only return Auth Rules that are bound to the provided account token.
           account_token: nil,
-          # Only return Authorization Rules that are bound to the provided card token.
+          # Only return Auth Rules that are bound to the provided card token.
           card_token: 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 return Auth rules that are executed during the provided event stream.
+          event_stream: nil,
           # Page size (for pagination).
           page_size: nil,
-          # Only return Authorization Rules that are bound to the provided scope;
+          # Only return Auth Rules that are bound to the provided scope.
           scope: 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.
@@ -133,7 +144,7 @@ module Lithic
         )
         end
 
-        # Deletes a V2 authorization rule
+        # Deletes a V2 Auth rule
         sig do
           params(
             auth_rule_token: String,
@@ -147,8 +158,8 @@ module Lithic
         )
         end
 
-        # Associates a V2 authorization rule with a card program, the provided account(s)
-        # or card(s).
+        # Associates a V2 Auth rule with a card program, the provided account(s) or
+        # card(s).
         #
         # Prefer using the `PATCH` method for this operation.
         sig do
@@ -188,7 +199,8 @@ module Lithic
                 T.any(
                   Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                   Lithic::AuthRules::VelocityLimitParams::OrHash,
-                  Lithic::AuthRules::V2DraftParams::Parameters::MerchantLockParameters::OrHash
+                  Lithic::AuthRules::V2DraftParams::Parameters::MerchantLockParameters::OrHash,
+                  Lithic::AuthRules::V2DraftParams::Parameters::Conditional3DSActionParameters::OrHash
                 )
               ),
             request_options: Lithic::RequestOptions::OrHash
@@ -203,8 +215,8 @@ module Lithic
         )
         end
 
-        # Promotes the draft version of an authorization rule to the currently active
-        # version such that it is enforced in the authorization stream.
+        # Promotes the draft version of an Auth rule to the currently active version such
+        # that it is enforced in the respective stream.
         sig do
           params(
             auth_rule_token: String,
@@ -218,26 +230,25 @@ module Lithic
         )
         end
 
-        # Requests a performance report of an authorization rule to be asynchronously
-        # generated. Reports can only be run on rules in draft or active mode and will
-        # included approved and declined statistics as well as examples. The generated
-        # report will be delivered asynchronously through a webhook with `event_type` =
+        # Requests a performance report of an Auth rule to be asynchronously generated.
+        # Reports can only be run on rules in draft or active mode and will included
+        # approved and declined statistics as well as examples. The generated report will
+        # be delivered asynchronously through a webhook with `event_type` =
         # `auth_rules.performance_report.created`. See the docs on setting up
         # [webhook subscriptions](https://docs.lithic.com/docs/events-api).
         #
-        # Reports are generated based on data collected by Lithic's authorization
-        # processing system in the trailing week. The performance of the auth rule will be
-        # assessed on the configuration of the auth rule at the time the report is
-        # requested. This implies that if a performance report is requested, right after
-        # updating an auth rule, depending on the number of authorizations processed for a
-        # card program, it may be the case that no data is available for the report.
-        # Therefore Lithic recommends to decouple making updates to an Auth Rule, and
-        # requesting performance reports.
+        # Reports are generated based on data collected by Lithic's processing system in
+        # the trailing week. The performance of the auth rule will be assessed on the
+        # configuration of the auth rule at the time the report is requested. This implies
+        # that if a performance report is requested, right after updating an auth rule,
+        # depending on the number of events processed for a card program, it may be the
+        # case that no data is available for the report. Therefore Lithic recommends to
+        # decouple making updates to an Auth Rule, and requesting performance reports.
         #
         # To make this concrete, consider the following example:
         #
-        # 1. At time `t`, a new Auth Rule is created, and applies to all authorizations on
-        #    a card program. The Auth Rule has not yet been promoted, causing the draft
+        # 1. At time `t`, a new Auth Rule is created, and applies to all auth events on a
+        #    card program. The Auth Rule has not yet been promoted, causing the draft
         #    version of the rule to be applied in shadow mode.
         # 2. At time `t + 1 hour` a performance report is requested for the Auth Rule.
         #    This performance report will _only_ contain data for the Auth Rule being
@@ -252,17 +263,17 @@ module Lithic
         #    `t + 2 hours`.
         # 4. At time `t + 3 hours` a new version of the rule is drafted by calling the
         #    `/v2/auth_rules/{auth_rule_token}/draft` endpoint. If a performance report is
-        #    requested right at this moment, it will only contain data for authorizations
-        #    to which both the active version and the draft version is applied. Lithic
-        #    does this to ensure that performance reports represent a fair comparison
-        #    between rules. Because there may be no authorizations in this window, and
-        #    because there may be some lag before data is available in a performance
-        #    report, the requested performance report could contain no to little data.
+        #    requested right at this moment, it will only contain data for events to which
+        #    both the active version and the draft version is applied. Lithic does this to
+        #    ensure that performance reports represent a fair comparison between rules.
+        #    Because there may be no events in this window, and because there may be some
+        #    lag before data is available in a performance report, the requested
+        #    performance report could contain no to little data.
         # 5. At time `t + 4 hours` another performance report is requested: this time the
         #    performance report will contain data from the window between `t + 3 hours`
-        #    and `t + 4 hours`, for any authorizations to which both the current version
-        #    of the authorization rule (in enforcing mode) and the draft version of the
-        #    authorization rule (in shadow mode) applied.
+        #    and `t + 4 hours`, for any events to which both the current version of the
+        #    Auth rule (in enforcing mode) and the draft version of the Auth rule (in
+        #    shadow mode) applied.
         #
         # Note that generating a report may take up to 15 minutes and that delivery is not
         # guaranteed. Customers are required to have created an event subscription to