lithic 0.1.0.pre.alpha.33 → 0.1.0.pre.alpha.35

data/rbi/lithic/models/three_ds/authentication_simulate_params.rbi

@@ -15,6 +15,7 @@ module Lithic
             )
           end
 
+        # Merchant information for the simulated transaction
         sig { returns(Lithic::ThreeDS::AuthenticationSimulateParams::Merchant) }
         attr_reader :merchant
 
@@ -30,6 +31,7 @@ module Lithic
         sig { returns(String) }
         attr_accessor :pan
 
+        # Transaction details for the simulation
         sig do
           returns(Lithic::ThreeDS::AuthenticationSimulateParams::Transaction)
         end
@@ -75,9 +77,11 @@ module Lithic
           ).returns(T.attached_class)
         end
         def self.new(
+          # Merchant information for the simulated transaction
           merchant:,
           # Sixteen digit card number.
           pan:,
+          # Transaction details for the simulation
           transaction:,
           # When set will use the following values as part of the Simulated Authentication.
           # When not set defaults to MATCH
@@ -132,6 +136,7 @@ module Lithic
           sig { returns(String) }
           attr_accessor :name
 
+          # Merchant information for the simulated transaction
           sig do
             params(
               id: String,
@@ -183,6 +188,7 @@ module Lithic
           sig { returns(String) }
           attr_accessor :currency
 
+          # Transaction details for the simulation
           sig do
             params(amount: Integer, currency: String).returns(T.attached_class)
           end

data/rbi/lithic/models/three_ds/authentication_simulate_response.rbi

@@ -12,8 +12,7 @@ module Lithic
             )
           end
 
-        # A unique token to reference this transaction with later calls to void or clear
-        # the authorization.
+        # Globally unique identifier for the 3DS authentication.
         sig { returns(T.nilable(String)) }
         attr_reader :token
 
@@ -22,8 +21,7 @@ module Lithic
 
         sig { params(token: String).returns(T.attached_class) }
         def self.new(
-          # A unique token to reference this transaction with later calls to void or clear
-          # the authorization.
+          # Globally unique identifier for the 3DS authentication.
           token: nil
         )
         end

data/rbi/lithic/models/three_ds/challenge_response.rbi

@@ -9,17 +9,16 @@ module Lithic
             T.any(Lithic::ThreeDS::ChallengeResponse, Lithic::Internal::AnyHash)
           end
 
-        # Globally unique identifier for the 3DS authentication. This token is sent as
-        # part of the initial 3DS Decisioning Request and as part of the 3DS Challenge
-        # Event in the [ThreeDSAuthentication](#/components/schemas/ThreeDSAuthentication)
-        # object
+        # Globally unique identifier for 3DS Authentication that resulted in
+        # PENDING_CHALLENGE authentication result.
         sig { returns(String) }
         attr_accessor :token
 
-        # Whether the Cardholder has Approved or Declined the issued Challenge
+        # Whether the Cardholder has approved or declined the issued Challenge
         sig { returns(Lithic::ThreeDS::ChallengeResult::OrSymbol) }
         attr_accessor :challenge_response
 
+        # Response from Card Program to a 3DS Authentication challenge
         sig do
           params(
             token: String,
@@ -27,12 +26,10 @@ module Lithic
           ).returns(T.attached_class)
         end
         def self.new(
-          # Globally unique identifier for the 3DS authentication. This token is sent as
-          # part of the initial 3DS Decisioning Request and as part of the 3DS Challenge
-          # Event in the [ThreeDSAuthentication](#/components/schemas/ThreeDSAuthentication)
-          # object
+          # Globally unique identifier for 3DS Authentication that resulted in
+          # PENDING_CHALLENGE authentication result.
           token:,
-          # Whether the Cardholder has Approved or Declined the issued Challenge
+          # Whether the Cardholder has approved or declined the issued Challenge
           challenge_response:
         )
         end

data/rbi/lithic/models/three_ds/challenge_result.rbi

@@ -3,7 +3,7 @@
 module Lithic
   module Models
     module ThreeDS
-      # Whether the Cardholder has Approved or Declined the issued Challenge
+      # Whether the Cardholder has approved or declined the issued Challenge
       module ChallengeResult
         extend Lithic::Internal::Type::Enum
 

data/rbi/lithic/models/transfer.rbi

@@ -420,6 +420,8 @@ module Lithic
             )
           CLEARING =
             T.let(:CLEARING, Lithic::Transfer::Event::Type::TaggedSymbol)
+          COLLECTION =
+            T.let(:COLLECTION, Lithic::Transfer::Event::Type::TaggedSymbol)
           CORRECTION_CREDIT =
             T.let(
               :CORRECTION_CREDIT,

data/rbi/lithic/models.rbi

@@ -220,6 +220,8 @@ module Lithic
 
   FinancialTransaction = Lithic::Models::FinancialTransaction
 
+  Fraud = Lithic::Models::Fraud
+
   FundingEventListParams = Lithic::Models::FundingEventListParams
 
   FundingEventRetrieveDetailsParams =

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

@@ -22,13 +22,14 @@ module Lithic
           # `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
           # endpoint.
           #
-          # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` rules. Backtesting
-          # for `VELOCITY_LIMIT` rules is generally not supported. In specific cases (i.e.
-          # where Lithic has pre-calculated the requested velocity metrics for historical
-          # transactions), a backtest may be feasible. However, such cases are uncommon and
-          # customers should not anticipate support for velocity backtests under most
-          # configurations. If a historical transaction does not feature the required inputs
-          # to evaluate the rule, then it will not be included in the final backtest report.
+          # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` /
+          # `CONDITIONAL_3DS_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is
+          # generally not supported. In specific cases (i.e. where Lithic has pre-calculated
+          # the requested velocity metrics for historical transactions), a backtest may be
+          # feasible. However, such cases are uncommon and customers should not anticipate
+          # support for velocity backtests under most configurations. If a historical
+          # transaction does not feature the required inputs to evaluate the rule, then it
+          # will not be included in the final backtest report.
           sig do
             params(
               auth_rule_token: String,

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

@@ -230,10 +230,11 @@ module Lithic
         )
         end
 
-        # 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` =
+        # This endpoint is deprecated and will be removed in the future. 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).
         #
@@ -293,6 +294,38 @@ module Lithic
         )
         end
 
+        # Retrieves a performance report for an Auth rule containing daily statistics and
+        # evaluation outcomes.
+        #
+        # **Time Range Limitations:**
+        #
+        # - Reports are supported for the past 3 months only
+        # - Maximum interval length is 1 month
+        # - Report data is available only through the previous day in UTC (current day
+        #   data is not available)
+        #
+        # The report provides daily statistics for both current and draft versions of the
+        # Auth rule, including approval, decline, and challenge counts along with sample
+        # events.
+        sig do
+          params(
+            auth_rule_token: String,
+            begin_: Date,
+            end_: Date,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::Models::AuthRules::V2RetrieveReportResponse)
+        end
+        def retrieve_report(
+          # Globally unique identifier for the Auth Rule.
+          auth_rule_token,
+          # Start date for the report
+          begin_:,
+          # End date for the report
+          end_:,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Lithic::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/lithic/resources/cards.rbi

@@ -107,10 +107,12 @@ module Lithic
         # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
         #   with tracking
         # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
-        # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
-        # - `2_DAY` - FedEx 2-day shipping, with tracking
-        # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+        # - `EXPRESS` - FedEx or UPS depending on card manufacturer, Express, 3-day
+        #   shipping, with tracking
+        # - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
         #   tracking
+        # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
+        #   or similar international option, with tracking
         shipping_method: nil,
         # Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
         # $1,000 limit). Transaction requests above the spend limit will be declined. Note
@@ -296,10 +298,12 @@ module Lithic
         # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
         #   with tracking
         # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
-        # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
-        # - `2_DAY` - FedEx 2-day shipping, with tracking
-        # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+        # - `EXPRESS` - FedEx or UPS depending on card manufacturer, Express, 3-day
+        #   shipping, with tracking
+        # - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
         #   tracking
+        # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
+        #   or similar international option, with tracking
         shipping_method: nil,
         request_options: {}
       )
@@ -429,10 +433,12 @@ module Lithic
         # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
         #   with tracking
         # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
-        # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
-        # - `2_DAY` - FedEx 2-day shipping, with tracking
-        # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+        # - `EXPRESS` - FedEx or UPS depending on card manufacturer, Express, 3-day
+        #   shipping, with tracking
+        # - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
         #   tracking
+        # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
+        #   or similar international option, with tracking
         shipping_method: nil,
         request_options: {}
       )
@@ -483,10 +489,12 @@ module Lithic
         # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
         #   with tracking
         # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
-        # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
-        # - `2_DAY` - FedEx 2-day shipping, with tracking
-        # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+        # - `EXPRESS` - FedEx or UPS depending on card manufacturer, Express, 3-day
+        #   shipping, with tracking
+        # - `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with
         #   tracking
+        # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
+        #   or similar international option, with tracking
         shipping_method: nil,
         request_options: {}
       )

data/rbi/lithic/resources/fraud/transactions.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class Fraud
+      class Transactions
+        # Retrieve a fraud report for a specific transaction identified by its unique
+        # transaction token.
+        sig do
+          params(
+            transaction_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::Models::Fraud::TransactionRetrieveResponse)
+        end
+        def retrieve(
+          # The token of the transaction that the enhanced data is associated with.
+          transaction_token,
+          request_options: {}
+        )
+        end
+
+        # Report fraud for a specific transaction token by providing details such as fraud
+        # type, fraud status, and any additional comments.
+        sig do
+          params(
+            transaction_token: String,
+            fraud_status:
+              Lithic::Fraud::TransactionReportParams::FraudStatus::OrSymbol,
+            comment: String,
+            fraud_type:
+              Lithic::Fraud::TransactionReportParams::FraudType::OrSymbol,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::Models::Fraud::TransactionReportResponse)
+        end
+        def report(
+          # The token of the transaction that the enhanced data is associated with.
+          transaction_token,
+          # The fraud status of the transaction, string (enum) supporting the following
+          # values:
+          #
+          # - `SUSPECTED_FRAUD`: The transaction is suspected to be fraudulent, but this
+          #   hasn’t been confirmed.
+          # - `FRAUDULENT`: The transaction is confirmed to be fraudulent. A transaction may
+          #   immediately be moved into this state, or be graduated into this state from the
+          #   `SUSPECTED_FRAUD` state.
+          # - `NOT_FRAUDULENT`: The transaction is (explicitly) marked as not fraudulent. A
+          #   transaction may immediately be moved into this state, or be graduated into
+          #   this state from the `SUSPECTED_FRAUD` state.
+          fraud_status:,
+          # Optional field providing additional information or context about why the
+          # transaction is considered fraudulent.
+          comment: nil,
+          # Specifies the type or category of fraud that the transaction is suspected or
+          # confirmed to involve, string (enum) supporting the following values:
+          #
+          # - `FIRST_PARTY_FRAUD`: First-party fraud occurs when a legitimate account or
+          #   cardholder intentionally misuses financial services for personal gain. This
+          #   includes actions such as disputing legitimate transactions to obtain a refund,
+          #   abusing return policies, or defaulting on credit obligations without intent to
+          #   repay.
+          # - `ACCOUNT_TAKEOVER`: Account takeover fraud occurs when a fraudster gains
+          #   unauthorized access to an existing account, modifies account settings, and
+          #   carries out fraudulent transactions.
+          # - `CARD_COMPROMISED`: Card compromised fraud occurs when a fraudster gains
+          #   access to card details without taking over the account, such as through
+          #   physical card theft, cloning, or online data breaches.
+          # - `IDENTITY_THEFT`: Identity theft fraud occurs when a fraudster uses stolen
+          #   personal information, such as Social Security numbers or addresses, to open
+          #   accounts, apply for loans, or conduct financial transactions in someone's
+          #   name.
+          # - `CARDHOLDER_MANIPULATION`: This type of fraud occurs when a fraudster
+          #   manipulates or coerces a legitimate cardholder into unauthorized transactions,
+          #   often through social engineering tactics.
+          fraud_type: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Lithic::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/fraud.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class Fraud
+      sig { returns(Lithic::Resources::Fraud::Transactions) }
+      attr_reader :transactions
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/lithic/resources/three_ds/authentication.rbi

@@ -12,7 +12,7 @@ module Lithic
           ).returns(Lithic::Models::ThreeDS::AuthenticationRetrieveResponse)
         end
         def retrieve(
-          # 3DS Authentication Token
+          # Globally unique identifier for the 3DS authentication.
           three_ds_authentication_token,
           request_options: {}
         )
@@ -37,9 +37,11 @@ module Lithic
           ).returns(Lithic::Models::ThreeDS::AuthenticationSimulateResponse)
         end
         def simulate(
+          # Merchant information for the simulated transaction
           merchant:,
           # Sixteen digit card number.
           pan:,
+          # Transaction details for the simulation
           transaction:,
           # When set will use the following values as part of the Simulated Authentication.
           # When not set defaults to MATCH
@@ -49,9 +51,9 @@ module Lithic
         end
 
         # Endpoint for simulating entering OTP into 3DS Challenge UI. A call to
-        # /v1/three_ds_authentication/simulate that resulted in triggered SMS-OTP
-        # challenge must precede. Only a single attempt is supported; upon entering OTP,
-        # the challenge is either approved or declined.
+        # [/v1/three_ds_authentication/simulate](https://docs.lithic.com/reference/postsimulateauthentication)
+        # that resulted in triggered SMS-OTP challenge must precede. Only a single attempt
+        # is supported; upon entering OTP, the challenge is either approved or declined.
         sig do
           params(
             token: String,

data/rbi/lithic/resources/three_ds/decisioning.rbi

@@ -4,7 +4,12 @@ module Lithic
   module Resources
     class ThreeDS
       class Decisioning
-        # Card program's response to a 3DS Challenge Request (CReq)
+        # Card program's response to a 3DS Challenge Request. Challenge Request is emitted
+        # as a webhook
+        # [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge)
+        # and your Card Program needs to be configured with Out of Band (OOB) Challenges
+        # in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for
+        # more information).
         sig do
           params(
             token: String,
@@ -13,12 +18,10 @@ module Lithic
           ).void
         end
         def challenge_response(
-          # Globally unique identifier for the 3DS authentication. This token is sent as
-          # part of the initial 3DS Decisioning Request and as part of the 3DS Challenge
-          # Event in the [ThreeDSAuthentication](#/components/schemas/ThreeDSAuthentication)
-          # object
+          # Globally unique identifier for 3DS Authentication that resulted in
+          # PENDING_CHALLENGE authentication result.
           token:,
-          # Whether the Cardholder has Approved or Declined the issued Challenge
+          # Whether the Cardholder has approved or declined the issued Challenge
           challenge_response:,
           request_options: {}
         )

data/sig/lithic/client.rbs

@@ -67,6 +67,8 @@ module Lithic
 
     attr_reader funding_events: Lithic::Resources::FundingEvents
 
+    attr_reader fraud: Lithic::Resources::Fraud
+
     def api_status: (
       ?request_options: Lithic::request_opts
     ) -> Lithic::APIStatus

data/sig/lithic/models/auth_rules/rule_stats.rbs

@@ -0,0 +1,108 @@
+module Lithic
+  module Models
+    module AuthRules
+      type rule_stats =
+        {
+          approved: Integer,
+          challenged: Integer,
+          declined: Integer,
+          examples: ::Array[Lithic::AuthRules::RuleStats::Example],
+          version: Integer
+        }
+
+      class RuleStats < Lithic::Internal::Type::BaseModel
+        attr_reader approved: Integer?
+
+        def approved=: (Integer) -> Integer
+
+        attr_reader challenged: Integer?
+
+        def challenged=: (Integer) -> Integer
+
+        attr_reader declined: Integer?
+
+        def declined=: (Integer) -> Integer
+
+        attr_reader examples: ::Array[Lithic::AuthRules::RuleStats::Example]?
+
+        def examples=: (
+          ::Array[Lithic::AuthRules::RuleStats::Example]
+        ) -> ::Array[Lithic::AuthRules::RuleStats::Example]
+
+        attr_reader version: Integer?
+
+        def version=: (Integer) -> Integer
+
+        def initialize: (
+          ?approved: Integer,
+          ?challenged: Integer,
+          ?declined: Integer,
+          ?examples: ::Array[Lithic::AuthRules::RuleStats::Example],
+          ?version: Integer
+        ) -> void
+
+        def to_hash: -> {
+          approved: Integer,
+          challenged: Integer,
+          declined: Integer,
+          examples: ::Array[Lithic::AuthRules::RuleStats::Example],
+          version: Integer
+        }
+
+        type example =
+          {
+            approved: bool,
+            decision: Lithic::Models::AuthRules::RuleStats::Example::decision,
+            event_token: String,
+            timestamp: Time
+          }
+
+        class Example < Lithic::Internal::Type::BaseModel
+          attr_reader approved: bool?
+
+          def approved=: (bool) -> bool
+
+          attr_reader decision: Lithic::Models::AuthRules::RuleStats::Example::decision?
+
+          def decision=: (
+            Lithic::Models::AuthRules::RuleStats::Example::decision
+          ) -> Lithic::Models::AuthRules::RuleStats::Example::decision
+
+          attr_reader event_token: String?
+
+          def event_token=: (String) -> String
+
+          attr_reader timestamp: Time?
+
+          def timestamp=: (Time) -> Time
+
+          def initialize: (
+            ?approved: bool,
+            ?decision: Lithic::Models::AuthRules::RuleStats::Example::decision,
+            ?event_token: String,
+            ?timestamp: Time
+          ) -> void
+
+          def to_hash: -> {
+            approved: bool,
+            decision: Lithic::Models::AuthRules::RuleStats::Example::decision,
+            event_token: String,
+            timestamp: Time
+          }
+
+          type decision = :APPROVED | :DECLINED | :CHALLENGED
+
+          module Decision
+            extend Lithic::Internal::Type::Enum
+
+            APPROVED: :APPROVED
+            DECLINED: :DECLINED
+            CHALLENGED: :CHALLENGED
+
+            def self?.values: -> ::Array[Lithic::Models::AuthRules::RuleStats::Example::decision]
+          end
+        end
+      end
+    end
+  end
+end