lithic 0.6.0 → 0.8.0

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

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module AuthRules
+      # A feature made available to the rule. The `name` field is the variable name used
+      # in the rule function signature. The `type` field determines which data the
+      # feature provides to the rule at evaluation time.
+      #
+      # - `AUTHORIZATION`: The authorization request being evaluated. Only available for
+      #   AUTHORIZATION event stream rules.
+      # - `AUTHENTICATION`: The 3DS authentication request being evaluated. Only
+      #   available for THREE_DS_AUTHENTICATION event stream rules.
+      # - `TOKENIZATION`: The tokenization request being evaluated. Only available for
+      #   TOKENIZATION event stream rules.
+      # - `ACH_RECEIPT`: The ACH receipt being evaluated. Only available for
+      #   ACH_CREDIT_RECEIPT and ACH_DEBIT_RECEIPT event stream rules.
+      # - `CARD`: The card associated with the event. Available for AUTHORIZATION and
+      #   THREE_DS_AUTHENTICATION event stream rules.
+      # - `ACCOUNT_HOLDER`: The account holder associated with the card. Available for
+      #   THREE_DS_AUTHENTICATION event stream rules.
+      # - `IP_METADATA`: IP address metadata for the request. Available for
+      #   THREE_DS_AUTHENTICATION event stream rules.
+      # - `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.
+      module RuleFeature
+        extend Lithic::Internal::Type::Union
+
+        variant -> { Lithic::AuthRules::RuleFeature::AuthorizationFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::AuthenticationFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::TokenizationFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::ACHReceiptFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::CardFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::AccountHolderFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::IPMetadataFeature }
+
+        variant -> { Lithic::AuthRules::RuleFeature::SpendVelocityFeature }
+
+        class AuthorizationFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :AUTHORIZATION]
+          required :type, const: :AUTHORIZATION
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :AUTHORIZATION)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :AUTHORIZATION]
+        end
+
+        class AuthenticationFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :AUTHENTICATION]
+          required :type, const: :AUTHENTICATION
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :AUTHENTICATION)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :AUTHENTICATION]
+        end
+
+        class TokenizationFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :TOKENIZATION]
+          required :type, const: :TOKENIZATION
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :TOKENIZATION)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :TOKENIZATION]
+        end
+
+        class ACHReceiptFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :ACH_RECEIPT]
+          required :type, const: :ACH_RECEIPT
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :ACH_RECEIPT)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :ACH_RECEIPT]
+        end
+
+        class CardFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :CARD]
+          required :type, const: :CARD
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :CARD)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :CARD]
+        end
+
+        class AccountHolderFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :ACCOUNT_HOLDER]
+          required :type, const: :ACCOUNT_HOLDER
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :ACCOUNT_HOLDER)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :ACCOUNT_HOLDER]
+        end
+
+        class IPMetadataFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :IP_METADATA]
+          required :type, const: :IP_METADATA
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(name: nil, type: :IP_METADATA)
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :IP_METADATA]
+        end
+
+        class SpendVelocityFeature < Lithic::Internal::Type::BaseModel
+          # @!attribute period
+          #   Velocity over the current day since 00:00 / 12 AM in Eastern Time
+          #
+          #   @return [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear]
+          required :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }
+
+          # @!attribute scope
+          #   The scope the velocity is calculated for
+          #
+          #   @return [Symbol, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature::Scope]
+          required :scope, enum: -> { Lithic::AuthRules::RuleFeature::SpendVelocityFeature::Scope }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :SPEND_VELOCITY]
+          required :type, const: :SPEND_VELOCITY
+
+          # @!attribute filters
+          #
+          #   @return [Lithic::Models::AuthRules::VelocityLimitFilters, nil]
+          optional :filters, -> { Lithic::AuthRules::VelocityLimitFilters }
+
+          # @!attribute name
+          #   The variable name for this feature in the rule function signature
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(period:, scope:, filters: nil, name: nil, type: :SPEND_VELOCITY)
+          #   @param period [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear] Velocity over the current day since 00:00 / 12 AM in Eastern Time
+          #
+          #   @param scope [Symbol, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature::Scope] The scope the velocity is calculated for
+          #
+          #   @param filters [Lithic::Models::AuthRules::VelocityLimitFilters]
+          #
+          #   @param name [String] The variable name for this feature in the rule function signature
+          #
+          #   @param type [Symbol, :SPEND_VELOCITY]
+
+          # The scope the velocity is calculated for
+          #
+          # @see Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature#scope
+          module Scope
+            extend Lithic::Internal::Type::Enum
+
+            CARD = :CARD
+            ACCOUNT = :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)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module AuthRules
+      class TypescriptCodeParameters < Lithic::Internal::Type::BaseModel
+        # @!attribute code
+        #   The TypeScript source code of the rule. Must define a `rule()` function that
+        #   accepts the declared features as positional arguments (in the same order as the
+        #   `features` array) and returns an array of actions.
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!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>]
+        required :features, -> { Lithic::Internal::Type::ArrayOf[union: Lithic::AuthRules::RuleFeature] }
+
+        # @!method initialize(code:, features:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::AuthRules::TypescriptCodeParameters} for more details.
+        #
+        #   Parameters for defining a TypeScript code rule
+        #
+        #   @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
+      end
+    end
+  end
+end

data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb

@@ -9,6 +9,11 @@ module Lithic
           extend Lithic::Internal::Type::RequestParameters::Converter
           include Lithic::Internal::Type::RequestParameters
 
+          # @!attribute auth_rule_token
+          #
+          #   @return [String]
+          required :auth_rule_token, String
+
           # @!attribute end_
           #   The end time of the backtest.
           #
@@ -21,7 +26,9 @@ module Lithic
           #   @return [Time, nil]
           optional :start, Time
 
-          # @!method initialize(end_: nil, start: nil, request_options: {})
+          # @!method initialize(auth_rule_token:, end_: nil, start: nil, request_options: {})
+          #   @param auth_rule_token [String]
+          #
           #   @param end_ [Time] The end time of the backtest.
           #
           #   @param start [Time] The start time of the backtest.

data/lib/lithic/models/auth_rules/v2/backtest_results.rb

@@ -33,45 +33,37 @@ module Lithic
           class Results < Lithic::Internal::Type::BaseModel
             # @!attribute current_version
             #
-            #   @return [Lithic::Models::AuthRules::RuleStats, nil]
-            optional :current_version, -> { Lithic::AuthRules::RuleStats }, nil?: true
+            #   @return [Lithic::Models::AuthRules::BacktestStats, nil]
+            optional :current_version, -> { Lithic::AuthRules::BacktestStats }, nil?: true
 
             # @!attribute draft_version
             #
-            #   @return [Lithic::Models::AuthRules::RuleStats, nil]
-            optional :draft_version, -> { Lithic::AuthRules::RuleStats }, nil?: true
+            #   @return [Lithic::Models::AuthRules::BacktestStats, nil]
+            optional :draft_version, -> { Lithic::AuthRules::BacktestStats }, nil?: true
 
             # @!method initialize(current_version: nil, draft_version: nil)
-            #   @param current_version [Lithic::Models::AuthRules::RuleStats, nil]
-            #   @param draft_version [Lithic::Models::AuthRules::RuleStats, nil]
+            #   @param current_version [Lithic::Models::AuthRules::BacktestStats, nil]
+            #   @param draft_version [Lithic::Models::AuthRules::BacktestStats, nil]
           end
 
           # @see Lithic::Models::AuthRules::V2::BacktestResults#simulation_parameters
           class SimulationParameters < Lithic::Internal::Type::BaseModel
-            # @!attribute auth_rule_token
-            #   Auth Rule Token
-            #
-            #   @return [String, nil]
-            optional :auth_rule_token, String
-
             # @!attribute end_
-            #   The end time of the simulation.
+            #   The end time of the simulation
             #
-            #   @return [Time, nil]
-            optional :end_, Time, api_name: :end
+            #   @return [Time]
+            required :end_, Time, api_name: :end
 
             # @!attribute start
-            #   The start time of the simulation.
+            #   The start time of the simulation
             #
-            #   @return [Time, nil]
-            optional :start, Time
+            #   @return [Time]
+            required :start, Time
 
-            # @!method initialize(auth_rule_token: nil, end_: nil, start: nil)
-            #   @param auth_rule_token [String] Auth Rule Token
-            #
-            #   @param end_ [Time] The end time of the simulation.
+            # @!method initialize(end_:, start:)
+            #   @param end_ [Time] The end time of the simulation
             #
-            #   @param start [Time] The start time of the simulation.
+            #   @param start [Time] The start time of the simulation
           end
         end
       end

data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb

@@ -14,8 +14,14 @@ module Lithic
           #   @return [String]
           required :auth_rule_token, String
 
-          # @!method initialize(auth_rule_token:, request_options: {})
+          # @!attribute auth_rule_backtest_token
+          #
+          #   @return [String]
+          required :auth_rule_backtest_token, String
+
+          # @!method initialize(auth_rule_token:, auth_rule_backtest_token:, request_options: {})
           #   @param auth_rule_token [String]
+          #   @param auth_rule_backtest_token [String]
           #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
         end
       end