lithic 0.10.0 → 0.12.0

data/lib/lithic/models/auth_rules/rule_feature.rb

@@ -24,6 +24,10 @@ module Lithic
       # - `SPEND_VELOCITY`: Spend velocity data for the card or account. Requires
       #   `scope`, `period`, and optionally `filters` to configure the velocity
       #   calculation. Available for AUTHORIZATION event stream rules.
+      # - `TRANSACTION_HISTORY_SIGNALS`: Behavioral feature state derived from the
+      #   entity's transaction history. Requires `scope` to specify whether to load
+      #   card, account, or business account history. Available for AUTHORIZATION event
+      #   stream rules.
       module RuleFeature
         extend Lithic::Internal::Type::Union
 
@@ -43,6 +47,8 @@ module Lithic
 
         variant -> { Lithic::AuthRules::RuleFeature::SpendVelocityFeature }
 
+        variant -> { Lithic::AuthRules::RuleFeature::TransactionHistorySignalsFeature }
+
         class AuthorizationFeature < Lithic::Internal::Type::BaseModel
           # @!attribute type
           #
@@ -223,8 +229,48 @@ module Lithic
           end
         end
 
+        class TransactionHistorySignalsFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute scope
+          #   The entity scope to load transaction history signals for.
+          #
+          #   @return [Symbol, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature::Scope]
+          required :scope, enum: -> { Lithic::AuthRules::RuleFeature::TransactionHistorySignalsFeature::Scope }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :TRANSACTION_HISTORY_SIGNALS]
+          required :type, const: :TRANSACTION_HISTORY_SIGNALS
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(scope:, name: nil, type: :TRANSACTION_HISTORY_SIGNALS)
+          #   @param scope [Symbol, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature::Scope] The entity scope to load transaction history signals for.
+          #
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :TRANSACTION_HISTORY_SIGNALS]
+
+          # The entity scope to load transaction history signals for.
+          #
+          # @see Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature#scope
+          module Scope
+            extend Lithic::Internal::Type::Enum
+
+            CARD = :CARD
+            ACCOUNT = :ACCOUNT
+            BUSINESS_ACCOUNT = :BUSINESS_ACCOUNT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature)]
+        #   @return [Array(Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature)]
       end
     end
   end

data/lib/lithic/models/auth_rules/typescript_code_parameters.rb

@@ -15,7 +15,7 @@ module Lithic
         # @!attribute features
         #   Features available to the TypeScript code at evaluation time
         #
-        #   @return [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature>]
+        #   @return [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature>]
         required :features, -> { Lithic::Internal::Type::ArrayOf[union: Lithic::AuthRules::RuleFeature] }
 
         # @!method initialize(code:, features:)
@@ -26,7 +26,7 @@ module Lithic
         #
         #   @param code [String] The TypeScript source code of the rule. Must define a `rule()` function that acc
         #
-        #   @param features [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature>] Features available to the TypeScript code at evaluation time
+        #   @param features [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature>] Features available to the TypeScript code at evaluation time
       end
     end
   end

data/lib/lithic/models/auth_rules/v2_list_results_response.rb

@@ -67,7 +67,13 @@ module Lithic
           #   @return [Integer]
           required :rule_version, Integer
 
-          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, event_stream: :AUTHORIZATION)
+          # @!attribute transaction_token
+          #   The token of the transaction that triggered the rule evaluation
+          #
+          #   @return [String, nil]
+          required :transaction_token, String, nil?: true
+
+          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, transaction_token:, event_stream: :AUTHORIZATION)
           #   @param token [String] Globally unique identifier for the evaluation
           #
           #   @param actions [Array<Lithic::Models::AuthRules::V2ListResultsResponse::AuthorizationResult::Action::DeclineActionAuthorization, Lithic::Models::AuthRules::V2ListResultsResponse::AuthorizationResult::Action::ChallengeActionAuthorization>] Actions returned by the rule evaluation
@@ -82,6 +88,8 @@ module Lithic
           #
           #   @param rule_version [Integer] Version of the rule that was evaluated
           #
+          #   @param transaction_token [String, nil] The token of the transaction that triggered the rule evaluation
+          #
           #   @param event_stream [Symbol, :AUTHORIZATION] The event stream during which the rule was evaluated
 
           module Action
@@ -295,7 +303,13 @@ module Lithic
           #   @return [Integer]
           required :rule_version, Integer
 
-          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, event_stream: :THREE_DS_AUTHENTICATION)
+          # @!attribute transaction_token
+          #   The token of the transaction that triggered the rule evaluation
+          #
+          #   @return [String, nil]
+          required :transaction_token, String, nil?: true
+
+          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, transaction_token:, event_stream: :THREE_DS_AUTHENTICATION)
           #   @param token [String] Globally unique identifier for the evaluation
           #
           #   @param actions [Array<Lithic::Models::AuthRules::V2ListResultsResponse::Authentication3DSResult::Action>] Actions returned by the rule evaluation
@@ -310,6 +324,8 @@ module Lithic
           #
           #   @param rule_version [Integer] Version of the rule that was evaluated
           #
+          #   @param transaction_token [String, nil] The token of the transaction that triggered the rule evaluation
+          #
           #   @param event_stream [Symbol, :THREE_DS_AUTHENTICATION] The event stream during which the rule was evaluated
 
           class Action < Lithic::Internal::Type::BaseModel
@@ -406,7 +422,13 @@ module Lithic
           #   @return [Integer]
           required :rule_version, Integer
 
-          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, event_stream: :TOKENIZATION)
+          # @!attribute transaction_token
+          #   The token of the transaction that triggered the rule evaluation
+          #
+          #   @return [String, nil]
+          required :transaction_token, String, nil?: true
+
+          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, transaction_token:, event_stream: :TOKENIZATION)
           #   @param token [String] Globally unique identifier for the evaluation
           #
           #   @param actions [Array<Lithic::Models::AuthRules::V2ListResultsResponse::TokenizationResult::Action::DeclineActionTokenization, Lithic::Models::AuthRules::V2ListResultsResponse::TokenizationResult::Action::RequireTfaAction>] Actions returned by the rule evaluation
@@ -421,6 +443,8 @@ module Lithic
           #
           #   @param rule_version [Integer] Version of the rule that was evaluated
           #
+          #   @param transaction_token [String, nil] The token of the transaction that triggered the rule evaluation
+          #
           #   @param event_stream [Symbol, :TOKENIZATION] The event stream during which the rule was evaluated
 
           module Action
@@ -631,7 +655,13 @@ module Lithic
           #   @return [Integer]
           required :rule_version, Integer
 
-          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_stream:, event_token:, mode:, rule_version:)
+          # @!attribute transaction_token
+          #   The token of the transaction that triggered the rule evaluation
+          #
+          #   @return [String, nil]
+          required :transaction_token, String, nil?: true
+
+          # @!method initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_stream:, event_token:, mode:, rule_version:, transaction_token:)
           #   @param token [String] Globally unique identifier for the evaluation
           #
           #   @param actions [Array<Lithic::Models::AuthRules::V2ListResultsResponse::ACHResult::Action::ApproveActionACH, Lithic::Models::AuthRules::V2ListResultsResponse::ACHResult::Action::ReturnAction>] Actions returned by the rule evaluation
@@ -647,6 +677,8 @@ module Lithic
           #   @param mode [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHResult::Mode] The state of the Auth Rule
           #
           #   @param rule_version [Integer] Version of the rule that was evaluated
+          #
+          #   @param transaction_token [String, nil] The token of the transaction that triggered the rule evaluation
 
           module Action
             extend Lithic::Internal::Type::Union