lithic 0.1.0.pre.alpha.32 → 0.1.0.pre.alpha.34

data/lib/lithic/models/three_ds/authentication_simulate_params.rb

@@ -9,6 +9,7 @@ module Lithic
         include Lithic::Internal::Type::RequestParameters
 
         # @!attribute merchant
+        #   Merchant information for the simulated transaction
         #
         #   @return [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
         required :merchant, -> { Lithic::ThreeDS::AuthenticationSimulateParams::Merchant }
@@ -20,6 +21,7 @@ module Lithic
         required :pan, String
 
         # @!attribute transaction
+        #   Transaction details for the simulation
         #
         #   @return [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
         required :transaction, -> { Lithic::ThreeDS::AuthenticationSimulateParams::Transaction }
@@ -38,11 +40,11 @@ module Lithic
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::ThreeDS::AuthenticationSimulateParams} for more details.
         #
-        #   @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
+        #   @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant] Merchant information for the simulated transaction
         #
         #   @param pan [String] Sixteen digit card number.
         #
-        #   @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
+        #   @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction] Transaction details for the simulation
         #
         #   @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck] When set will use the following values as part of the Simulated Authentication.
         #
@@ -83,6 +85,8 @@ module Lithic
           #   {Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant} for more
           #   details.
           #
+          #   Merchant information for the simulated transaction
+          #
           #   @param id [String] Unique identifier to identify the payment card acceptor. Corresponds to `merchan
           #
           #   @param country [String] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
@@ -106,6 +110,8 @@ module Lithic
           required :currency, String
 
           # @!method initialize(amount:, currency:)
+          #   Transaction details for the simulation
+          #
           #   @param amount [Integer] Amount (in cents) to authenticate.
           #
           #   @param currency [String] 3-character alphabetic ISO 4217 currency code.

data/lib/lithic/models/three_ds/authentication_simulate_response.rb

@@ -6,17 +6,13 @@ module Lithic
       # @see Lithic::Resources::ThreeDS::Authentication#simulate
       class AuthenticationSimulateResponse < Lithic::Internal::Type::BaseModel
         # @!attribute token
-        #   A unique token to reference this transaction with later calls to void or clear
-        #   the authorization.
+        #   Globally unique identifier for the 3DS authentication.
         #
         #   @return [String, nil]
         optional :token, String
 
         # @!method initialize(token: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::ThreeDS::AuthenticationSimulateResponse} for more details.
-        #
-        #   @param token [String] A unique token to reference this transaction with later calls to void or clear t
+        #   @param token [String] Globally unique identifier for the 3DS authentication.
       end
     end
   end

data/lib/lithic/models/three_ds/challenge_response.rb

@@ -5,16 +5,14 @@ module Lithic
     module ThreeDS
       class ChallengeResponse < Lithic::Internal::Type::BaseModel
         # @!attribute token
-        #   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.
         #
         #   @return [String]
         required :token, String
 
         # @!attribute challenge_response
-        #   Whether the Cardholder has Approved or Declined the issued Challenge
+        #   Whether the Cardholder has approved or declined the issued Challenge
         #
         #   @return [Symbol, Lithic::Models::ThreeDS::ChallengeResult]
         required :challenge_response, enum: -> { Lithic::ThreeDS::ChallengeResult }
@@ -23,9 +21,11 @@ module Lithic
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::ThreeDS::ChallengeResponse} for more details.
         #
-        #   @param token [String] Globally unique identifier for the 3DS authentication. This token is sent as par
+        #   Response from Card Program to a 3DS Authentication challenge
         #
-        #   @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has Approved or Declined the issued Challenge
+        #   @param token [String] Globally unique identifier for 3DS Authentication that resulted in PENDING_CHALL
+        #
+        #   @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has approved or declined the issued Challenge
       end
     end
   end

data/lib/lithic/models/three_ds/challenge_result.rb

@@ -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/lib/lithic/models/transfer.rb

@@ -228,6 +228,7 @@ module Lithic
           CASH_BACK = :CASH_BACK
           CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
           CLEARING = :CLEARING
+          COLLECTION = :COLLECTION
           CORRECTION_CREDIT = :CORRECTION_CREDIT
           CORRECTION_DEBIT = :CORRECTION_DEBIT
           CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION

data/lib/lithic/models.rb

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

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

@@ -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.
           #
           # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
           #

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

@@ -246,10 +246,13 @@ 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` =
+        # @deprecated
+        #
+        # 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).
         #
@@ -315,6 +318,44 @@ 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.
+        #
+        # @overload retrieve_report(auth_rule_token, begin_:, end_:, request_options: {})
+        #
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
+        # @param begin_ [Date] Start date for the report
+        #
+        # @param end_ [Date] End date for the report
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AuthRules::V2RetrieveReportResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2RetrieveReportParams
+        def retrieve_report(auth_rule_token, params)
+          parsed, options = Lithic::AuthRules::V2RetrieveReportParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v2/auth_rules/%1$s/report", auth_rule_token],
+            query: parsed.transform_keys(begin_: "begin", end_: "end"),
+            model: Lithic::Models::AuthRules::V2RetrieveReportResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Lithic::Client]

data/lib/lithic/resources/fraud/transactions.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class Fraud
+      class Transactions
+        # Retrieve a fraud report for a specific transaction identified by its unique
+        # transaction token.
+        #
+        # @overload retrieve(transaction_token, request_options: {})
+        #
+        # @param transaction_token [String] The token of the transaction that the enhanced data is associated with.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::Fraud::TransactionRetrieveResponse]
+        #
+        # @see Lithic::Models::Fraud::TransactionRetrieveParams
+        def retrieve(transaction_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/fraud/transactions/%1$s", transaction_token],
+            model: Lithic::Models::Fraud::TransactionRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Fraud::TransactionReportParams} for more details.
+        #
+        # Report fraud for a specific transaction token by providing details such as fraud
+        # type, fraud status, and any additional comments.
+        #
+        # @overload report(transaction_token, fraud_status:, comment: nil, fraud_type: nil, request_options: {})
+        #
+        # @param transaction_token [String] The token of the transaction that the enhanced data is associated with.
+        #
+        # @param fraud_status [Symbol, Lithic::Models::Fraud::TransactionReportParams::FraudStatus] The fraud status of the transaction, string (enum) supporting the following valu
+        #
+        # @param comment [String] Optional field providing additional information or context about why the transac
+        #
+        # @param fraud_type [Symbol, Lithic::Models::Fraud::TransactionReportParams::FraudType] Specifies the type or category of fraud that the transaction is suspected or con
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::Fraud::TransactionReportResponse]
+        #
+        # @see Lithic::Models::Fraud::TransactionReportParams
+        def report(transaction_token, params)
+          parsed, options = Lithic::Fraud::TransactionReportParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/fraud/transactions/%1$s", transaction_token],
+            body: parsed,
+            model: Lithic::Models::Fraud::TransactionReportResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/fraud.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class Fraud
+      # @return [Lithic::Resources::Fraud::Transactions]
+      attr_reader :transactions
+
+      # @api private
+      #
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+        @transactions = Lithic::Resources::Fraud::Transactions.new(client: client)
+      end
+    end
+  end
+end

data/lib/lithic/resources/three_ds/authentication.rb

@@ -8,7 +8,7 @@ module Lithic
         #
         # @overload retrieve(three_ds_authentication_token, request_options: {})
         #
-        # @param three_ds_authentication_token [String] 3DS Authentication Token
+        # @param three_ds_authentication_token [String] Globally unique identifier for the 3DS authentication.
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -36,11 +36,11 @@ module Lithic
         #
         # @overload simulate(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
         #
-        # @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
+        # @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant] Merchant information for the simulated transaction
         #
         # @param pan [String] Sixteen digit card number.
         #
-        # @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
+        # @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction] Transaction details for the simulation
         #
         # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck] When set will use the following values as part of the Simulated Authentication.
         #
@@ -65,9 +65,9 @@ module Lithic
         # details.
         #
         # 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.
         #
         # @overload simulate_otp_entry(token:, otp:, request_options: {})
         #

data/lib/lithic/resources/three_ds/decisioning.rb

@@ -7,13 +7,18 @@ module Lithic
         # Some parameter documentations has been truncated, see
         # {Lithic::Models::ThreeDS::DecisioningChallengeResponseParams} for more details.
         #
-        # 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).
         #
         # @overload challenge_response(token:, challenge_response:, request_options: {})
         #
-        # @param token [String] Globally unique identifier for the 3DS authentication. This token is sent as par
+        # @param token [String] Globally unique identifier for 3DS Authentication that resulted in PENDING_CHALL
         #
-        # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has Approved or Declined the issued Challenge
+        # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has approved or declined the issued Challenge
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/lithic/version.rb

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

data/lib/lithic.rb

@@ -85,6 +85,7 @@ require_relative "lithic/models/auth_rules/auth_rule"
 require_relative "lithic/models/auth_rules/auth_rule_condition"
 require_relative "lithic/models/auth_rules/conditional_attribute"
 require_relative "lithic/models/auth_rules/conditional_block_parameters"
+require_relative "lithic/models/auth_rules/rule_stats"
 require_relative "lithic/models/auth_rules/v2/backtest_create_params"
 require_relative "lithic/models/auth_rules/v2/backtest_create_response"
 require_relative "lithic/models/auth_rules/v2/backtest_results"
@@ -103,6 +104,8 @@ require_relative "lithic/models/auth_rules/v2_promote_response"
 require_relative "lithic/models/auth_rules/v2_report_params"
 require_relative "lithic/models/auth_rules/v2_report_response"
 require_relative "lithic/models/auth_rules/v2_retrieve_params"
+require_relative "lithic/models/auth_rules/v2_retrieve_report_params"
+require_relative "lithic/models/auth_rules/v2_retrieve_report_response"
 require_relative "lithic/models/auth_rules/v2_retrieve_response"
 require_relative "lithic/models/auth_rules/v2_update_params"
 require_relative "lithic/models/auth_rules/v2_update_response"
@@ -232,6 +235,10 @@ require_relative "lithic/models/financial_accounts/statements/statement_line_ite
 require_relative "lithic/models/financial_account_update_params"
 require_relative "lithic/models/financial_account_update_status_params"
 require_relative "lithic/models/financial_transaction"
+require_relative "lithic/models/fraud/transaction_report_params"
+require_relative "lithic/models/fraud/transaction_report_response"
+require_relative "lithic/models/fraud/transaction_retrieve_params"
+require_relative "lithic/models/fraud/transaction_retrieve_response"
 require_relative "lithic/models/funding_event_list_params"
 require_relative "lithic/models/funding_event_list_response"
 require_relative "lithic/models/funding_event_retrieve_details_params"
@@ -366,6 +373,8 @@ require_relative "lithic/resources/financial_accounts/financial_transactions"
 require_relative "lithic/resources/financial_accounts/loan_tapes"
 require_relative "lithic/resources/financial_accounts/statements"
 require_relative "lithic/resources/financial_accounts/statements/line_items"
+require_relative "lithic/resources/fraud"
+require_relative "lithic/resources/fraud/transactions"
 require_relative "lithic/resources/funding_events"
 require_relative "lithic/resources/management_operations"
 require_relative "lithic/resources/payments"

data/rbi/lithic/client.rbi

@@ -100,6 +100,9 @@ module Lithic
     sig { returns(Lithic::Resources::FundingEvents) }
     attr_reader :funding_events
 
+    sig { returns(Lithic::Resources::Fraud) }
+    attr_reader :fraud
+
     # Status of api
     sig do
       params(request_options: Lithic::RequestOptions::OrHash).returns(

data/rbi/lithic/errors.rbi

@@ -8,6 +8,22 @@ module Lithic
     end
 
     class ConversionError < Lithic::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < Lithic::Errors::Error

data/rbi/lithic/internal/type/boolean.rbi

@@ -22,6 +22,8 @@ module Lithic
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(

data/rbi/lithic/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module Lithic
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -84,6 +86,15 @@ module Lithic
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              Lithic::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -105,14 +116,11 @@ module Lithic
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-            # coercion strategy when we have to decide between multiple possible conversion
-            # targets:
+            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
+            # when we have to decide between multiple possible conversion targets:
             #
             # - `true`: the conversion must be exact, with minimum coercion.
             # - `false`: the conversion can be approximate, with some coercion.
-            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
-            #   if not possible.
             #
             # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
             # any given conversion attempt, the exactness will be updated based on how closely
@@ -124,15 +132,7 @@ module Lithic
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {
-              strictness: true,
-              exactness: {
-                yes: 0,
-                no: 0,
-                maybe: 0
-              },
-              branched: 0
-            }
+            state: Lithic::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/lithic/internal/type/union.rbi

@@ -78,6 +78,11 @@ module Lithic
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(

data/rbi/lithic/internal/type/unknown.rbi

@@ -22,6 +22,8 @@ module Lithic
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(