lithic 0.6.0 → 0.8.0

data/lib/lithic/models/account_holder_update_response.rb

@@ -23,12 +23,6 @@ module Lithic
         #   @return [String, nil]
         optional :account_token, String
 
-        # @!attribute beneficial_owner_entities
-        #   Deprecated.
-        #
-        #   @return [Array<Lithic::Models::KYBBusinessEntity>, nil]
-        optional :beneficial_owner_entities, -> { Lithic::Internal::Type::ArrayOf[Lithic::KYBBusinessEntity] }
-
         # @!attribute beneficial_owner_individuals
         #   Only present when user_type == "BUSINESS". You must submit a list of all direct
         #   and indirect individuals with 25% or more ownership in the company. A maximum of
@@ -181,7 +175,7 @@ module Lithic
         #   @return [String, nil]
         optional :website_url, String
 
-        # @!method initialize(token: nil, account_token: nil, beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_account_token: nil, business_entity: nil, control_person: nil, created: nil, email: nil, exemption_type: nil, external_id: nil, individual: nil, naics_code: nil, nature_of_business: nil, phone_number: nil, required_documents: nil, status: nil, status_reasons: nil, user_type: nil, verification_application: nil, website_url: nil)
+        # @!method initialize(token: nil, account_token: nil, beneficial_owner_individuals: nil, business_account_token: nil, business_entity: nil, control_person: nil, created: nil, email: nil, exemption_type: nil, external_id: nil, individual: nil, naics_code: nil, nature_of_business: nil, phone_number: nil, required_documents: nil, status: nil, status_reasons: nil, user_type: nil, verification_application: nil, website_url: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse} for more
         #   details.
@@ -190,8 +184,6 @@ module Lithic
         #
         #   @param account_token [String] Globally unique identifier for the account.
         #
-        #   @param beneficial_owner_entities [Array<Lithic::Models::KYBBusinessEntity>] Deprecated.
-        #
         #   @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::BeneficialOwnerIndividual>] Only present when user_type == "BUSINESS". You must submit a list of all direct
         #
         #   @param business_account_token [String, nil] Only applicable for customers using the KYC-Exempt workflow to enroll authorized

data/lib/lithic/models/account_holder_updated_webhook_event.rb

@@ -83,14 +83,6 @@ module Lithic
 
         # @see Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload#update_request
         class UpdateRequest < Lithic::Internal::Type::BaseModel
-          # @!attribute beneficial_owner_entities
-          #   @deprecated
-          #
-          #   Deprecated.
-          #
-          #   @return [Array<Lithic::Models::KYBBusinessEntity>, nil]
-          optional :beneficial_owner_entities, -> { Lithic::Internal::Type::ArrayOf[Lithic::KYBBusinessEntity] }
-
           # @!attribute beneficial_owner_individuals
           #   You must submit a list of all direct and indirect individuals with 25% or more
           #   ownership in the company. A maximum of 4 beneficial owners can be submitted. If
@@ -124,15 +116,13 @@ module Lithic
           optional :control_person,
                    -> { Lithic::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson }
 
-          # @!method initialize(beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_entity: nil, control_person: nil)
+          # @!method initialize(beneficial_owner_individuals: nil, business_entity: nil, control_person: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest}
           #   for more details.
           #
           #   Original request to update the account holder.
           #
-          #   @param beneficial_owner_entities [Array<Lithic::Models::KYBBusinessEntity>] Deprecated.
-          #
           #   @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
           #
           #   @param business_entity [Lithic::Models::KYBBusinessEntity] Information for business for which the account is being opened and KYB is being

data/lib/lithic/models/account_holder_upload_document_params.rb

@@ -7,6 +7,11 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      # @!attribute account_holder_token
+      #
+      #   @return [String]
+      required :account_holder_token, String
+
       # @!attribute document_type
       #   The type of document to upload
       #
@@ -19,7 +24,9 @@ module Lithic
       #   @return [String]
       required :entity_token, String
 
-      # @!method initialize(document_type:, entity_token:, request_options: {})
+      # @!method initialize(account_holder_token:, document_type:, entity_token:, request_options: {})
+      #   @param account_holder_token [String]
+      #
       #   @param document_type [Symbol, Lithic::Models::AccountHolderUploadDocumentParams::DocumentType] The type of document to upload
       #
       #   @param entity_token [String] Globally unique identifier for the entity.

data/lib/lithic/models/account_holders/entity_create_params.rb

@@ -8,6 +8,11 @@ module Lithic
         extend Lithic::Internal::Type::RequestParameters::Converter
         include Lithic::Internal::Type::RequestParameters
 
+        # @!attribute account_holder_token
+        #
+        #   @return [String]
+        required :account_holder_token, String
+
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
         #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
@@ -61,10 +66,12 @@ module Lithic
         #   @return [Symbol, Lithic::Models::AccountHolders::EntityCreateParams::Type]
         required :type, enum: -> { Lithic::AccountHolders::EntityCreateParams::Type }
 
-        # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, type:, request_options: {})
+        # @!method initialize(account_holder_token:, address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, type:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::AccountHolders::EntityCreateParams} for more details.
         #
+        #   @param account_holder_token [String]
+        #
         #   @param address [Lithic::Models::AccountHolders::EntityCreateParams::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
         #
         #   @param dob [String] Individual's date of birth, as an RFC 3339 date.

data/lib/lithic/models/account_holders/entity_delete_params.rb

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

data/lib/lithic/models/account_retrieve_params.rb

@@ -7,7 +7,13 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute account_token
+      #
+      #   @return [String]
+      required :account_token, String
+
+      # @!method initialize(account_token:, request_options: {})
+      #   @param account_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/account_retrieve_spend_limits_params.rb

@@ -7,7 +7,13 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute account_token
+      #
+      #   @return [String]
+      required :account_token, String
+
+      # @!method initialize(account_token:, request_options: {})
+      #   @param account_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/account_update_params.rb

@@ -7,6 +7,11 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      # @!attribute account_token
+      #
+      #   @return [String]
+      required :account_token, String
+
       # @!attribute comment
       #   Additional context or information related to the account.
       #
@@ -88,10 +93,12 @@ module Lithic
       #   @return [Lithic::Models::AccountUpdateParams::VerificationAddress, nil]
       optional :verification_address, -> { Lithic::AccountUpdateParams::VerificationAddress }
 
-      # @!method initialize(comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {})
+      # @!method initialize(account_token:, comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::AccountUpdateParams} for more details.
       #
+      #   @param account_token [String]
+      #
       #   @param comment [String] Additional context or information related to the account.
       #
       #   @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1

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

@@ -82,17 +82,31 @@ module Lithic
         #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
         #   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
         #     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+        #   - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+        #     ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
         #
         #   @return [Symbol, Lithic::Models::AuthRules::AuthRule::Type]
         required :type, enum: -> { Lithic::AuthRules::AuthRule::Type }
 
+        # @!attribute excluded_account_tokens
+        #   Account tokens to which the Auth Rule does not apply.
+        #
+        #   @return [Array<String>, nil]
+        optional :excluded_account_tokens, Lithic::Internal::Type::ArrayOf[String]
+
+        # @!attribute excluded_business_account_tokens
+        #   Business account tokens to which the Auth Rule does not apply.
+        #
+        #   @return [Array<String>, nil]
+        optional :excluded_business_account_tokens, Lithic::Internal::Type::ArrayOf[String]
+
         # @!attribute excluded_card_tokens
         #   Card tokens to which the Auth Rule does not apply.
         #
         #   @return [Array<String>, nil]
         optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(token:, account_tokens:, business_account_tokens:, card_tokens:, current_version:, draft_version:, event_stream:, lithic_managed:, name:, program_level:, state:, type:, excluded_card_tokens: nil)
+        # @!method initialize(token:, account_tokens:, business_account_tokens:, card_tokens:, current_version:, draft_version:, event_stream:, lithic_managed:, name:, program_level:, state:, type:, excluded_account_tokens: nil, excluded_business_account_tokens: nil, excluded_card_tokens: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::AuthRules::AuthRule} for more details.
         #
@@ -120,6 +134,10 @@ module Lithic
         #
         #   @param type [Symbol, Lithic::Models::AuthRules::AuthRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
         #
+        #   @param excluded_account_tokens [Array<String>] Account tokens to which the Auth Rule does not apply.
+        #
+        #   @param excluded_business_account_tokens [Array<String>] Business account tokens to which the Auth Rule does not apply.
+        #
         #   @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
 
         # @see Lithic::Models::AuthRules::AuthRule#current_version
@@ -127,7 +145,7 @@ module Lithic
           # @!attribute parameters
           #   Parameters for the Auth Rule
           #
-          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters]
+          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters]
           required :parameters, union: -> { Lithic::AuthRules::AuthRule::CurrentVersion::Parameters }
 
           response_only do
@@ -143,7 +161,7 @@ module Lithic
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AuthRules::AuthRule::CurrentVersion} for more details.
           #
-          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule
+          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters] Parameters for the Auth Rule
           #
           #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
 
@@ -168,19 +186,44 @@ module Lithic
 
             variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
 
+            # Parameters for defining a TypeScript code rule
+            variant -> { Lithic::AuthRules::TypescriptCodeParameters }
+
             # @!method self.variants
-            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)]
+            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters)]
           end
         end
 
         # @see Lithic::Models::AuthRules::AuthRule#draft_version
         class DraftVersion < Lithic::Internal::Type::BaseModel
+          # @!attribute error
+          #   An error message if the draft version failed compilation. Populated when `state`
+          #   is `ERROR`, `null` otherwise.
+          #
+          #   @return [String, nil]
+          required :error, String, nil?: true
+
           # @!attribute parameters
           #   Parameters for the Auth Rule
           #
-          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters]
+          #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters]
           required :parameters, union: -> { Lithic::AuthRules::AuthRule::DraftVersion::Parameters }
 
+          # @!attribute state
+          #   The state of the draft version. Most rules are created synchronously and the
+          #   state is immediately `SHADOWING`. Rules backed by TypeScript code are compiled
+          #   asynchronously — the state starts as `PENDING` and transitions to `SHADOWING` on
+          #   success or `ERROR` on failure.
+          #
+          #   - `PENDING`: Compilation of the rule is in progress (TypeScript rules only).
+          #   - `SHADOWING`: The draft version is ready and evaluating in shadow mode
+          #     alongside the current active version. It can be promoted to the active
+          #     version.
+          #   - `ERROR`: Compilation of the rule failed. Check the `error` field for details.
+          #
+          #   @return [Symbol, Lithic::Models::AuthRules::AuthRule::DraftVersion::State]
+          required :state, enum: -> { Lithic::AuthRules::AuthRule::DraftVersion::State }
+
           response_only do
             # @!attribute version
             #   The version of the rule, this is incremented whenever the rule's parameters
@@ -190,11 +233,15 @@ module Lithic
             required :version, Integer
           end
 
-          # @!method initialize(parameters:, version:)
+          # @!method initialize(error:, parameters:, state:, version:)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AuthRules::AuthRule::DraftVersion} for more details.
           #
-          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule
+          #   @param error [String, nil] An error message if the draft version failed compilation. Populated when `state`
+          #
+          #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters] Parameters for the Auth Rule
+          #
+          #   @param state [Symbol, Lithic::Models::AuthRules::AuthRule::DraftVersion::State] The state of the draft version. Most rules are created synchronously and the sta
           #
           #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
 
@@ -219,8 +266,34 @@ module Lithic
 
             variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
 
+            # Parameters for defining a TypeScript code rule
+            variant -> { Lithic::AuthRules::TypescriptCodeParameters }
+
             # @!method self.variants
-            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)]
+            #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters)]
+          end
+
+          # The state of the draft version. Most rules are created synchronously and the
+          # state is immediately `SHADOWING`. Rules backed by TypeScript code are compiled
+          # asynchronously — the state starts as `PENDING` and transitions to `SHADOWING` on
+          # success or `ERROR` on failure.
+          #
+          # - `PENDING`: Compilation of the rule is in progress (TypeScript rules only).
+          # - `SHADOWING`: The draft version is ready and evaluating in shadow mode
+          #   alongside the current active version. It can be promoted to the active
+          #   version.
+          # - `ERROR`: Compilation of the rule failed. Check the `error` field for details.
+          #
+          # @see Lithic::Models::AuthRules::AuthRule::DraftVersion#state
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING = :PENDING
+            SHADOWING = :SHADOWING
+            ERROR = :ERROR
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
 
@@ -248,6 +321,8 @@ module Lithic
         # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
         # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
         #   ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+        # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+        #   ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
         #
         # @see Lithic::Models::AuthRules::AuthRule#type
         module Type
@@ -257,6 +332,7 @@ module Lithic
           VELOCITY_LIMIT = :VELOCITY_LIMIT
           MERCHANT_LOCK = :MERCHANT_LOCK
           CONDITIONAL_ACTION = :CONDITIONAL_ACTION
+          TYPESCRIPT_CODE = :TYPESCRIPT_CODE
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module AuthRules
+      class AuthRuleVersion < Lithic::Internal::Type::BaseModel
+        # @!attribute created
+        #   Timestamp of when this version was created.
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute parameters
+        #   Parameters for the Auth Rule
+        #
+        #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters]
+        required :parameters, union: -> { Lithic::AuthRules::AuthRuleVersion::Parameters }
+
+        # @!attribute state
+        #   The current state of this version.
+        #
+        #   @return [Symbol, Lithic::Models::AuthRules::AuthRuleVersion::State]
+        required :state, enum: -> { Lithic::AuthRules::AuthRuleVersion::State }
+
+        response_only do
+          # @!attribute version
+          #   The version of the rule, this is incremented whenever the rule's parameters
+          #   change.
+          #
+          #   @return [Integer]
+          required :version, Integer
+        end
+
+        # @!method initialize(created:, parameters:, state:, version:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::AuthRules::AuthRuleVersion} for more details.
+        #
+        #   @param created [Time] Timestamp of when this version was created.
+        #
+        #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters] Parameters for the Auth Rule
+        #
+        #   @param state [Symbol, Lithic::Models::AuthRules::AuthRuleVersion::State] The current state of this version.
+        #
+        #   @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
+
+        # Parameters for the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::AuthRuleVersion#parameters
+        module Parameters
+          extend Lithic::Internal::Type::Union
+
+          # Deprecated: Use CONDITIONAL_ACTION instead.
+          variant -> { Lithic::AuthRules::ConditionalBlockParameters }
+
+          variant -> { Lithic::AuthRules::VelocityLimitParams }
+
+          variant -> { Lithic::AuthRules::MerchantLockParameters }
+
+          variant -> { Lithic::AuthRules::Conditional3DSActionParameters }
+
+          variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters }
+
+          variant -> { Lithic::AuthRules::ConditionalACHActionParameters }
+
+          variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
+
+          # Parameters for defining a TypeScript code rule
+          variant -> { Lithic::AuthRules::TypescriptCodeParameters }
+
+          # @!method self.variants
+          #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters)]
+        end
+
+        # The current state of this version.
+        #
+        # @see Lithic::Models::AuthRules::AuthRuleVersion#state
+        module State
+          extend Lithic::Internal::Type::Enum
+
+          ACTIVE = :ACTIVE
+          SHADOW = :SHADOW
+          INACTIVE = :INACTIVE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AuthRuleVersion = AuthRules::AuthRuleVersion
+  end
+end

data/lib/lithic/models/auth_rules/{rule_stats.rb → backtest_stats.rb}

@@ -3,10 +3,10 @@
 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]
@@ -14,7 +14,7 @@ module Lithic
 
         # @!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 @@ module Lithic
 
         # @!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 @@ module Lithic
         # @!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 @@ module Lithic
 
         # @!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,10 +77,8 @@ module Lithic
           #   @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.
           #
@@ -94,7 +86,7 @@ module Lithic
 
           # 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
 

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

@@ -7,7 +7,7 @@ module Lithic
         # @!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 @@ module Lithic
                  -> { 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 @@ module Lithic
         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 Lithic
           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