lithic 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.31

data/lib/lithic/models/funding_event_retrieve_response.rb

@@ -18,7 +18,8 @@ module Lithic
                enum: -> { Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType }
 
       # @!attribute collection_tokens
-      #   IDs of collections
+      #   IDs of collections, further information can be gathered from the appropriate
+      #   collection API based on collection_resource_type
       #
       #   @return [Array<String>]
       required :collection_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -35,39 +36,42 @@ module Lithic
       #   @return [Time]
       required :high_watermark, Time
 
+      # @!attribute network_settlement_summary
+      #   Network settlement summary breakdown by network settlement date
+      #
+      #   @return [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>]
+      required :network_settlement_summary,
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary] }
+
       # @!attribute previous_high_watermark
       #   Time of the previous high watermark
       #
       #   @return [Time]
       required :previous_high_watermark, Time
 
-      # @!attribute settlement_breakdowns
-      #   List of settlements
-      #
-      #   @return [Array<Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown>]
-      required :settlement_breakdowns,
-               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown] }
-
       # @!attribute updated
       #   Time of the update
       #
       #   @return [Time]
       required :updated, Time
 
-      # @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, previous_high_watermark:, settlement_breakdowns:, updated:)
+      # @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, network_settlement_summary:, previous_high_watermark:, updated:)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::FundingEventRetrieveResponse} for more details.
+      #
       #   @param token [String] Unique token ID
       #
       #   @param collection_resource_type [Symbol, Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType] Collection resource type
       #
-      #   @param collection_tokens [Array<String>] IDs of collections
+      #   @param collection_tokens [Array<String>] IDs of collections, further information can be gathered from the appropriate col
       #
       #   @param created [Time] Time of the creation
       #
       #   @param high_watermark [Time] Time of the high watermark
       #
-      #   @param previous_high_watermark [Time] Time of the previous high watermark
+      #   @param network_settlement_summary [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>] Network settlement summary breakdown by network settlement date
       #
-      #   @param settlement_breakdowns [Array<Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown>] List of settlements
+      #   @param previous_high_watermark [Time] Time of the previous high watermark
       #
       #   @param updated [Time] Time of the update
 
@@ -84,20 +88,20 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
-      class SettlementBreakdown < Lithic::Internal::Type::BaseModel
-        # @!attribute amount
+      class NetworkSettlementSummary < Lithic::Internal::Type::BaseModel
+        # @!attribute network_settlement_date
         #
-        #   @return [Integer]
-        required :amount, Integer
+        #   @return [Date]
+        required :network_settlement_date, Date
 
-        # @!attribute settlement_date
+        # @!attribute settled_gross_amount
         #
-        #   @return [Date]
-        required :settlement_date, Date
+        #   @return [Integer]
+        required :settled_gross_amount, Integer
 
-        # @!method initialize(amount:, settlement_date:)
-        #   @param amount [Integer]
-        #   @param settlement_date [Date]
+        # @!method initialize(network_settlement_date:, settled_gross_amount:)
+        #   @param network_settlement_date [Date]
+        #   @param settled_gross_amount [Integer]
       end
     end
   end

data/lib/lithic/models/payment.rb

@@ -221,7 +221,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.
@@ -282,7 +282,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/lib/lithic/models/required_document.rb

@@ -10,7 +10,7 @@ module Lithic
       required :entity_token, String
 
       # @!attribute status_reasons
-      #   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.
       #
       #   @return [Array<String>]
@@ -29,7 +29,7 @@ module Lithic
       #
       #   @param entity_token [String] Globally unique identifier for an entity.
       #
-      #   @param status_reasons [Array<String>] rovides the status reasons that will be satisfied by providing one of the valid
+      #   @param status_reasons [Array<String>] Provides the status reasons that will be satisfied by providing one of the valid
       #
       #   @param valid_documents [Array<String>] A list of valid documents that will satisfy the KYC requirements for the specifi
     end

data/lib/lithic/models/transaction.rb

@@ -28,7 +28,8 @@ module Lithic
       #   @deprecated
       #
       #   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`.
       #
       #   @return [String, nil]
       required :acquirer_reference_number, String, nil?: true

data/lib/lithic/resources/auth_rules/v2/backtests.rb

@@ -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
@@ -55,7 +54,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
@@ -71,8 +70,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.
           #
           # @overload retrieve(auth_rule_backtest_token, auth_rule_token:, request_options: {})
           #

data/lib/lithic/resources/auth_rules/v2.rb

@@ -7,7 +7,10 @@ module Lithic
         # @return [Lithic::Resources::AuthRules::V2::Backtests]
         attr_reader :backtests
 
-        # Creates a new V2 authorization rule in draft mode
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AuthRules::V2CreateParams} for more details.
+        #
+        # Creates a new V2 Auth rule in draft mode
         #
         # @overload create(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
         #
@@ -19,9 +22,9 @@ module Lithic
         #
         # @param name [String, nil] Auth Rule Name
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters] Parameters for the Auth Rule
         #
-        # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
+        # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. Effectively determines the event stream during which it w
         #
         # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
         #
@@ -41,7 +44,7 @@ module Lithic
           )
         end
 
-        # Fetches a V2 authorization rule by its token
+        # Fetches a V2 Auth rule by its token
         #
         # @overload retrieve(auth_rule_token, request_options: {})
         #
@@ -64,7 +67,7 @@ module Lithic
         # Some parameter documentations has been truncated, see
         # {Lithic::Models::AuthRules::V2UpdateParams} for more details.
         #
-        # 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
@@ -105,19 +108,21 @@ module Lithic
         # Some parameter documentations has been truncated, see
         # {Lithic::Models::AuthRules::V2ListParams} for more details.
         #
-        # Lists V2 authorization rules
+        # Lists V2 Auth rules
         #
-        # @overload list(account_token: nil, card_token: nil, ending_before: nil, page_size: nil, scope: nil, starting_after: nil, request_options: {})
+        # @overload list(account_token: nil, card_token: nil, ending_before: nil, event_stream: nil, page_size: nil, scope: nil, starting_after: nil, request_options: {})
         #
-        # @param account_token [String] Only return Authorization Rules that are bound to the provided account token.
+        # @param account_token [String] Only return Auth Rules that are bound to the provided account token.
         #
-        # @param card_token [String] Only return Authorization Rules that are bound to the provided card token.
+        # @param card_token [String] Only return Auth Rules that are bound to the provided card token.
         #
         # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
         #
+        # @param event_stream [Symbol, Lithic::Models::AuthRules::V2ListParams::EventStream] Only return Auth rules that are executed during the provided event stream.
+        #
         # @param page_size [Integer] Page size (for pagination).
         #
-        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Authorization Rules that are bound to the provided scope;
+        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
         #
         # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
         #
@@ -138,7 +143,7 @@ module Lithic
           )
         end
 
-        # Deletes a V2 authorization rule
+        # Deletes a V2 Auth rule
         #
         # @overload delete(auth_rule_token, request_options: {})
         #
@@ -160,8 +165,8 @@ module Lithic
 
         # @deprecated
         #
-        # 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.
         #
@@ -202,7 +207,7 @@ module Lithic
         #
         # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2DraftParams::Parameters::MerchantLockParameters, nil] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2DraftParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2DraftParams::Parameters::Conditional3DSActionParameters, nil] Parameters for the Auth Rule
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -220,8 +225,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.
         #
         # @overload promote(auth_rule_token, request_options: {})
         #
@@ -241,26 +246,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
@@ -275,17 +279,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

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.30"
+  VERSION = "0.1.0.pre.alpha.31"
 end

data/rbi/lithic/internal/util.rbi

@@ -332,6 +332,8 @@ module Lithic
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end

data/rbi/lithic/models/account_update_params.rbi

@@ -49,8 +49,8 @@ module Lithic
 
       # 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.
       sig do
         returns(T.nilable(Lithic::AccountUpdateParams::VerificationAddress))
       end
@@ -94,8 +94,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: {}
       )
@@ -186,8 +186,8 @@ module Lithic
 
         # 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.
         sig do
           params(
             address1: String,