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

data/rbi/lithic/models/auth_rules/v2/backtest_results.rbi

@@ -160,7 +160,7 @@ module Lithic
                 end
 
               # The total number of historical transactions approved by this rule during the
-              # backtest period, or the number of transactions that would have been approved if
+              # relevant period, or the number of transactions that would have been approved if
               # the rule was evaluated in shadow mode.
               sig { returns(T.nilable(Integer)) }
               attr_reader :approved
@@ -168,8 +168,18 @@ module Lithic
               sig { params(approved: Integer).void }
               attr_writer :approved
 
+              # The total number of historical transactions challenged by this rule during the
+              # relevant period, or the number of transactions that would have been challenged
+              # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
+              # Rules.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :challenged
+
+              sig { params(challenged: Integer).void }
+              attr_writer :challenged
+
               # The total number of historical transactions declined by this rule during the
-              # backtest period, or the number of transactions that would have been declined if
+              # relevant period, or the number of transactions that would have been declined if
               # the rule was evaluated in shadow mode.
               sig { returns(T.nilable(Integer)) }
               attr_reader :declined
@@ -177,7 +187,7 @@ module Lithic
               sig { params(declined: Integer).void }
               attr_writer :declined
 
-              # Example authorization request events that would have been approved or declined.
+              # Example events and their outcomes.
               sig do
                 returns(
                   T.nilable(
@@ -210,6 +220,7 @@ module Lithic
               sig do
                 params(
                   approved: Integer,
+                  challenged: Integer,
                   declined: Integer,
                   examples:
                     T::Array[
@@ -220,14 +231,19 @@ module Lithic
               end
               def self.new(
                 # The total number of historical transactions approved by this rule during the
-                # backtest period, or the number of transactions that would have been approved if
+                # relevant period, or the number of transactions that would have been approved if
                 # the rule was evaluated in shadow mode.
                 approved: nil,
+                # The total number of historical transactions challenged by this rule during the
+                # relevant period, or the number of transactions that would have been challenged
+                # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
+                # Rules.
+                challenged: nil,
                 # The total number of historical transactions declined by this rule during the
-                # backtest period, or the number of transactions that would have been declined if
+                # relevant period, or the number of transactions that would have been declined if
                 # the rule was evaluated in shadow mode.
                 declined: nil,
-                # Example authorization request events that would have been approved or declined.
+                # Example events and their outcomes.
                 examples: nil,
                 # The version of the rule, this is incremented whenever the rule's parameters
                 # change.
@@ -239,6 +255,7 @@ module Lithic
                 override.returns(
                   {
                     approved: Integer,
+                    challenged: Integer,
                     declined: Integer,
                     examples:
                       T::Array[
@@ -260,21 +277,39 @@ module Lithic
                     )
                   end
 
-                # Whether the rule would have approved the authorization request.
+                # Whether the rule would have approved the request.
                 sig { returns(T.nilable(T::Boolean)) }
                 attr_reader :approved
 
                 sig { params(approved: T::Boolean).void }
                 attr_writer :approved
 
-                # The authorization request event token.
+                # The decision made by the rule for this event.
+                sig do
+                  returns(
+                    T.nilable(
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol
+                    )
+                  )
+                end
+                attr_reader :decision
+
+                sig do
+                  params(
+                    decision:
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::OrSymbol
+                  ).void
+                end
+                attr_writer :decision
+
+                # The event token.
                 sig { returns(T.nilable(String)) }
                 attr_reader :event_token
 
                 sig { params(event_token: String).void }
                 attr_writer :event_token
 
-                # The timestamp of the authorization request event.
+                # The timestamp of the event.
                 sig { returns(T.nilable(Time)) }
                 attr_reader :timestamp
 
@@ -284,16 +319,20 @@ module Lithic
                 sig do
                   params(
                     approved: T::Boolean,
+                    decision:
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::OrSymbol,
                     event_token: String,
                     timestamp: Time
                   ).returns(T.attached_class)
                 end
                 def self.new(
-                  # Whether the rule would have approved the authorization request.
+                  # Whether the rule would have approved the request.
                   approved: nil,
-                  # The authorization request event token.
+                  # The decision made by the rule for this event.
+                  decision: nil,
+                  # The event token.
                   event_token: nil,
-                  # The timestamp of the authorization request event.
+                  # The timestamp of the event.
                   timestamp: nil
                 )
                 end
@@ -302,6 +341,8 @@ module Lithic
                   override.returns(
                     {
                       approved: T::Boolean,
+                      decision:
+                        Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol,
                       event_token: String,
                       timestamp: Time
                     }
@@ -309,6 +350,46 @@ module Lithic
                 end
                 def to_hash
                 end
+
+                # The decision made by the rule for this event.
+                module Decision
+                  extend Lithic::Internal::Type::Enum
+
+                  TaggedSymbol =
+                    T.type_alias do
+                      T.all(
+                        Symbol,
+                        Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision
+                      )
+                    end
+                  OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                  APPROVED =
+                    T.let(
+                      :APPROVED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol
+                    )
+                  DECLINED =
+                    T.let(
+                      :DECLINED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol
+                    )
+                  CHALLENGED =
+                    T.let(
+                      :CHALLENGED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol
+                    )
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::Decision::TaggedSymbol
+                      ]
+                    )
+                  end
+                  def self.values
+                  end
+                end
               end
             end
 
@@ -322,7 +403,7 @@ module Lithic
                 end
 
               # The total number of historical transactions approved by this rule during the
-              # backtest period, or the number of transactions that would have been approved if
+              # relevant period, or the number of transactions that would have been approved if
               # the rule was evaluated in shadow mode.
               sig { returns(T.nilable(Integer)) }
               attr_reader :approved
@@ -330,8 +411,18 @@ module Lithic
               sig { params(approved: Integer).void }
               attr_writer :approved
 
+              # The total number of historical transactions challenged by this rule during the
+              # relevant period, or the number of transactions that would have been challenged
+              # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
+              # Rules.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :challenged
+
+              sig { params(challenged: Integer).void }
+              attr_writer :challenged
+
               # The total number of historical transactions declined by this rule during the
-              # backtest period, or the number of transactions that would have been declined if
+              # relevant period, or the number of transactions that would have been declined if
               # the rule was evaluated in shadow mode.
               sig { returns(T.nilable(Integer)) }
               attr_reader :declined
@@ -339,7 +430,7 @@ module Lithic
               sig { params(declined: Integer).void }
               attr_writer :declined
 
-              # Example authorization request events that would have been approved or declined.
+              # Example events and their outcomes.
               sig do
                 returns(
                   T.nilable(
@@ -372,6 +463,7 @@ module Lithic
               sig do
                 params(
                   approved: Integer,
+                  challenged: Integer,
                   declined: Integer,
                   examples:
                     T::Array[
@@ -382,14 +474,19 @@ module Lithic
               end
               def self.new(
                 # The total number of historical transactions approved by this rule during the
-                # backtest period, or the number of transactions that would have been approved if
+                # relevant period, or the number of transactions that would have been approved if
                 # the rule was evaluated in shadow mode.
                 approved: nil,
+                # The total number of historical transactions challenged by this rule during the
+                # relevant period, or the number of transactions that would have been challenged
+                # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
+                # Rules.
+                challenged: nil,
                 # The total number of historical transactions declined by this rule during the
-                # backtest period, or the number of transactions that would have been declined if
+                # relevant period, or the number of transactions that would have been declined if
                 # the rule was evaluated in shadow mode.
                 declined: nil,
-                # Example authorization request events that would have been approved or declined.
+                # Example events and their outcomes.
                 examples: nil,
                 # The version of the rule, this is incremented whenever the rule's parameters
                 # change.
@@ -401,6 +498,7 @@ module Lithic
                 override.returns(
                   {
                     approved: Integer,
+                    challenged: Integer,
                     declined: Integer,
                     examples:
                       T::Array[
@@ -422,21 +520,39 @@ module Lithic
                     )
                   end
 
-                # Whether the rule would have approved the authorization request.
+                # Whether the rule would have approved the request.
                 sig { returns(T.nilable(T::Boolean)) }
                 attr_reader :approved
 
                 sig { params(approved: T::Boolean).void }
                 attr_writer :approved
 
-                # The authorization request event token.
+                # The decision made by the rule for this event.
+                sig do
+                  returns(
+                    T.nilable(
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol
+                    )
+                  )
+                end
+                attr_reader :decision
+
+                sig do
+                  params(
+                    decision:
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::OrSymbol
+                  ).void
+                end
+                attr_writer :decision
+
+                # The event token.
                 sig { returns(T.nilable(String)) }
                 attr_reader :event_token
 
                 sig { params(event_token: String).void }
                 attr_writer :event_token
 
-                # The timestamp of the authorization request event.
+                # The timestamp of the event.
                 sig { returns(T.nilable(Time)) }
                 attr_reader :timestamp
 
@@ -446,16 +562,20 @@ module Lithic
                 sig do
                   params(
                     approved: T::Boolean,
+                    decision:
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::OrSymbol,
                     event_token: String,
                     timestamp: Time
                   ).returns(T.attached_class)
                 end
                 def self.new(
-                  # Whether the rule would have approved the authorization request.
+                  # Whether the rule would have approved the request.
                   approved: nil,
-                  # The authorization request event token.
+                  # The decision made by the rule for this event.
+                  decision: nil,
+                  # The event token.
                   event_token: nil,
-                  # The timestamp of the authorization request event.
+                  # The timestamp of the event.
                   timestamp: nil
                 )
                 end
@@ -464,6 +584,8 @@ module Lithic
                   override.returns(
                     {
                       approved: T::Boolean,
+                      decision:
+                        Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol,
                       event_token: String,
                       timestamp: Time
                     }
@@ -471,6 +593,46 @@ module Lithic
                 end
                 def to_hash
                 end
+
+                # The decision made by the rule for this event.
+                module Decision
+                  extend Lithic::Internal::Type::Enum
+
+                  TaggedSymbol =
+                    T.type_alias do
+                      T.all(
+                        Symbol,
+                        Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision
+                      )
+                    end
+                  OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                  APPROVED =
+                    T.let(
+                      :APPROVED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol
+                    )
+                  DECLINED =
+                    T.let(
+                      :DECLINED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol
+                    )
+                  CHALLENGED =
+                    T.let(
+                      :CHALLENGED,
+                      Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol
+                    )
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::Decision::TaggedSymbol
+                      ]
+                    )
+                  end
+                  def self.values
+                  end
+                end
               end
             end
           end