feat(api): add action_counts to rule performance reports and code to authorization actions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 185
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-a45946df228eec554b3cd2491f658bd5a45cb91509da0a9f92d50468ea88072f.yml
-openapi_spec_hash: 24c7c13e1e7385cab5442ca66091ffc6
-config_hash: 50031f78031362c2e4900222b9ce7ada
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-b29a4bd5ca21348ef426162cbd1fa21070f695572626e4e6faabfa14af38f0b0.yml
+openapi_spec_hash: e7c285d6b7006d040ecb50a9d0d2fc17
+config_hash: fb5070d41fcabdedbc084b83964b592a

lib/lithic.rb

@@ -114,6 +114,7 @@
 require_relative "lithic/models/api_status"
 require_relative "lithic/models/auth_rules/auth_rule"
 require_relative "lithic/models/auth_rules/auth_rule_condition"
+require_relative "lithic/models/auth_rules/backtest_stats"
 require_relative "lithic/models/auth_rules/conditional_3ds_action_parameters"
 require_relative "lithic/models/auth_rules/conditional_ach_action_parameters"
 require_relative "lithic/models/auth_rules/conditional_attribute"
@@ -124,7 +125,7 @@
 require_relative "lithic/models/auth_rules/conditional_value"
 require_relative "lithic/models/auth_rules/event_stream"
 require_relative "lithic/models/auth_rules/merchant_lock_parameters"
-require_relative "lithic/models/auth_rules/rule_stats"
+require_relative "lithic/models/auth_rules/report_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_retrieve_params"

…b/lithic/models/auth_rules/rule_stats.rb …thic/models/auth_rules/backtest_stats.rblib/lithic/models/auth_rules/rule_stats.rb renamed to lib/lithic/models/auth_rules/backtest_stats.rb lib/lithic/models/auth_rules/rule_stats.rb renamed to lib/lithic/models/auth_rules/backtest_stats.rb

@@ -3,18 +3,18 @@
 module Lithic
   module Models
     module AuthRules
-      class RuleStats < Lithic::Internal::Type::BaseModel
+      class BacktestStats < Lithic::Internal::Type::BaseModel
         # @!attribute approved
         #   The total number of historical transactions approved by this rule during the
-        #   relevant period, or the number of transactions that would have been approved if
+        #   backtest period, or the number of transactions that would have been approved if
         #   the rule was evaluated in shadow mode.
         #
         #   @return [Integer, nil]
         optional :approved, Integer
 
         # @!attribute challenged
         #   The total number of historical transactions challenged by this rule during the
-        #   relevant period, or the number of transactions that would have been challenged
+        #   backtest 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.
         #
@@ -23,7 +23,7 @@ class RuleStats < Lithic::Internal::Type::BaseModel
 
         # @!attribute declined
         #   The total number of historical transactions declined by this rule during the
-        #   relevant period, or the number of transactions that would have been declined if
+        #   backtest period, or the number of transactions that would have been declined if
         #   the rule was evaluated in shadow mode.
         #
         #   @return [Integer, nil]
@@ -32,8 +32,8 @@ class RuleStats < Lithic::Internal::Type::BaseModel
         # @!attribute examples
         #   Example events and their outcomes.
         #
-        #   @return [Array<Lithic::Models::AuthRules::RuleStats::Example>, nil]
-        optional :examples, -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::RuleStats::Example] }
+        #   @return [Array<Lithic::Models::AuthRules::BacktestStats::Example>, nil]
+        optional :examples, -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::BacktestStats::Example] }
 
         response_only do
           # @!attribute version
@@ -46,30 +46,24 @@ class RuleStats < Lithic::Internal::Type::BaseModel
 
         # @!method initialize(approved: nil, challenged: nil, declined: nil, examples: nil, version: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::AuthRules::RuleStats} for more details.
+        #   {Lithic::Models::AuthRules::BacktestStats} for more details.
         #
-        #   @param approved [Integer] The total number of historical transactions approved by this rule during the rel
+        #   @param approved [Integer] The total number of historical transactions approved by this rule during the bac
         #
-        #   @param challenged [Integer] The total number of historical transactions challenged by this rule during the r
+        #   @param challenged [Integer] The total number of historical transactions challenged by this rule during the b
         #
-        #   @param declined [Integer] The total number of historical transactions declined by this rule during the rel
+        #   @param declined [Integer] The total number of historical transactions declined by this rule during the bac
         #
-        #   @param examples [Array<Lithic::Models::AuthRules::RuleStats::Example>] Example events and their outcomes.
+        #   @param examples [Array<Lithic::Models::AuthRules::BacktestStats::Example>] Example events and their outcomes.
         #
         #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
 
         class Example < Lithic::Internal::Type::BaseModel
-          # @!attribute approved
-          #   Whether the rule would have approved the request.
-          #
-          #   @return [Boolean, nil]
-          optional :approved, Lithic::Internal::Type::Boolean
-
           # @!attribute decision
           #   The decision made by the rule for this event.
           #
-          #   @return [Symbol, Lithic::Models::AuthRules::RuleStats::Example::Decision, nil]
-          optional :decision, enum: -> { Lithic::AuthRules::RuleStats::Example::Decision }
+          #   @return [Symbol, Lithic::Models::AuthRules::BacktestStats::Example::Decision, nil]
+          optional :decision, enum: -> { Lithic::AuthRules::BacktestStats::Example::Decision }
 
           # @!attribute event_token
           #   The event token.
@@ -83,18 +77,16 @@ class Example < Lithic::Internal::Type::BaseModel
           #   @return [Time, nil]
           optional :timestamp, Time
 
-          # @!method initialize(approved: nil, decision: nil, event_token: nil, timestamp: nil)
-          #   @param approved [Boolean] Whether the rule would have approved the request.
-          #
-          #   @param decision [Symbol, Lithic::Models::AuthRules::RuleStats::Example::Decision] The decision made by the rule for this event.
+          # @!method initialize(decision: nil, event_token: nil, timestamp: nil)
+          #   @param decision [Symbol, Lithic::Models::AuthRules::BacktestStats::Example::Decision] The decision made by the rule for this event.
           #
           #   @param event_token [String] The event token.
           #
           #   @param timestamp [Time] The timestamp of the event.
 
           # The decision made by the rule for this event.
           #
-          # @see Lithic::Models::AuthRules::RuleStats::Example#decision
+          # @see Lithic::Models::AuthRules::BacktestStats::Example#decision
           module Decision
             extend Lithic::Internal::Type::Enum
 

lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb

@@ -7,7 +7,7 @@ class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel
         # @!attribute action
         #   The action to take if the conditions are met.
         #
-        #   @return [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction]
+        #   @return [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction]
         required :action, union: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action }
 
         # @!attribute conditions
@@ -17,7 +17,7 @@ class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel
                  -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::ConditionalACHActionParameters::Condition] }
 
         # @!method initialize(action:, conditions:)
-        #   @param action [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction] The action to take if the conditions are met.
+        #   @param action [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction] The action to take if the conditions are met.
         #
         #   @param conditions [Array<Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition>]
 
@@ -27,24 +27,24 @@ class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel
         module Action
           extend Lithic::Internal::Type::Union
 
-          variant -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction }
+          variant -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH }
 
           variant -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction }
 
-          class ApproveAction < Lithic::Internal::Type::BaseModel
+          class ApproveActionACH < Lithic::Internal::Type::BaseModel
             # @!attribute type
             #   Approve the ACH transaction
             #
-            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type]
+            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH::Type]
             required :type,
-                     enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type }
+                     enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH::Type }
 
             # @!method initialize(type:)
-            #   @param type [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type] Approve the ACH transaction
+            #   @param type [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH::Type] Approve the ACH transaction
 
             # Approve the ACH transaction
             #
-            # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction#type
+            # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH#type
             module Type
               extend Lithic::Internal::Type::Enum
 
@@ -176,7 +176,7 @@ module Type
           end
 
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction)]
+          #   @return [Array(Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveActionACH, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction)]
         end
 
         class Condition < Lithic::Internal::Type::BaseModel

lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb

@@ -7,7 +7,7 @@ class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseMode
         # @!attribute action
         #   The action to take if the conditions are met.
         #
-        #   @return [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction]
+        #   @return [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction]
         required :action, union: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action }
 
         # @!attribute conditions
@@ -17,7 +17,7 @@ class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseMode
                  -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] }
 
         # @!method initialize(action:, conditions:)
-        #   @param action [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction] The action to take if the conditions are met.
+        #   @param action [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction] The action to take if the conditions are met.
         #
         #   @param conditions [Array<Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition>]
 
@@ -27,33 +27,33 @@ class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseMode
         module Action
           extend Lithic::Internal::Type::Union
 
-          variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction }
+          variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization }
 
           variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction }
 
-          class DeclineAction < Lithic::Internal::Type::BaseModel
+          class DeclineActionTokenization < Lithic::Internal::Type::BaseModel
             # @!attribute type
             #   Decline the tokenization request
             #
-            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type]
+            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Type]
             required :type,
-                     enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type }
+                     enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Type }
 
             # @!attribute reason
             #   Reason code for declining the tokenization request
             #
-            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason, nil]
+            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Reason, nil]
             optional :reason,
-                     enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason }
+                     enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Reason }
 
             # @!method initialize(type:, reason: nil)
-            #   @param type [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type] Decline the tokenization request
+            #   @param type [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Type] Decline the tokenization request
             #
-            #   @param reason [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason] Reason code for declining the tokenization request
+            #   @param reason [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization::Reason] Reason code for declining the tokenization request
 
             # Decline the tokenization request
             #
-            # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction#type
+            # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization#type
             module Type
               extend Lithic::Internal::Type::Enum
 
@@ -65,7 +65,7 @@ module Type
 
             # Reason code for declining the tokenization request
             #
-            # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction#reason
+            # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization#reason
             module Reason
               extend Lithic::Internal::Type::Enum
 
@@ -148,7 +148,7 @@ module Reason
           end
 
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction)]
+          #   @return [Array(Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineActionTokenization, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction)]
         end
 
         class Condition < Lithic::Internal::Type::BaseModel