lithic 0.21.0 → 0.22.0

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

@@ -9,28 +9,172 @@ module Lithic
         include Lithic::Internal::Type::RequestParameters
 
         # @!attribute body
+        #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
         #
-        #   @return [Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
+        #   @return [Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
         required :body, union: -> { Lithic::AuthRules::V2CreateParams::Body }
 
         # @!method initialize(body:, request_options: {})
-        #   @param body [Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
+        #   @param body [Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule] Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
+        # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
         module Body
           extend Lithic::Internal::Type::Union
 
+          variant -> { Lithic::AuthRules::V2CreateParams::Body::Rule }
+
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule }
 
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2CreateParams::Body::CardLevelRule }
 
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule }
 
+          class Rule < Lithic::Internal::Type::BaseModel
+            # @!attribute entities
+            #   The entities an Auth Rule applies to (`include`) and does not apply to
+            #   (`exclude`). An exclusion overrides an inclusion, so a card excluded here is
+            #   skipped even when the program, its account or one of its tags is included.
+            #
+            #   The rule's resulting entities must satisfy these constraints after any write:
+            #
+            #   - `include` must contain at least one entity.
+            #   - If `PROGRAM` is included, it must be the only included entity.
+            #   - `PROGRAM` cannot be excluded.
+            #   - An entity cannot appear in both `include` and `exclude`, or twice in the same
+            #     list.
+            #   - A rule can have at most 1,000 entities across `include` and `exclude`, not
+            #     counting `PROGRAM`.
+            #   - Entity types must be valid for the rule's event stream.
+            #   - `CARD`, `ACCOUNT` and `BUSINESS_ACCOUNT` tokens must belong to your program.
+            #
+            #   @return [Lithic::Models::AuthRules::AuthRuleEntities]
+            required :entities, -> { Lithic::AuthRules::AuthRuleEntities }
+
+            # @!attribute parameters
+            #   Parameters for the Auth Rule
+            #
+            #   @return [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
+            required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::Rule::Parameters }
+
+            # @!attribute type
+            #   The type of Auth Rule. For certain rule types, this determines the event stream
+            #   during which it will be evaluated. For rules that can be applied to one of
+            #   several event streams, the effective one is defined by the separate
+            #   `event_stream` field.
+            #
+            #   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+            #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+            #   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+            #     ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
+            #     ACH_PAYMENT_UPDATE event stream.
+            #   - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+            #     ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
+            #     ACH_PAYMENT_UPDATE event stream.
+            #   - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
+            #     are read-only; `OTHER` cannot be used when creating a rule.
+            #
+            #   @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::Rule::Type]
+            required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Body::Rule::Type }
+
+            # @!attribute event_stream
+            #   The event stream during which the rule will be evaluated.
+            #
+            #   @return [Symbol, Lithic::Models::AuthRules::EventStream, nil]
+            optional :event_stream, enum: -> { Lithic::AuthRules::EventStream }
+
+            # @!attribute name
+            #   Auth Rule Name
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!method initialize(entities:, parameters:, type:, event_stream: nil, name: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::AuthRules::V2CreateParams::Body::Rule} for more details.
+            #
+            #   @param entities [Lithic::Models::AuthRules::AuthRuleEntities] The entities an Auth Rule applies to (`include`) and does not apply to (`exclude
+            #
+            #   @param parameters [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
+            #
+            #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::Rule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
+            #
+            #   @param event_stream [Symbol, Lithic::Models::AuthRules::EventStream] The event stream during which the rule will be evaluated.
+            #
+            #   @param name [String, nil] Auth Rule Name
+
+            # Parameters for the Auth Rule
+            #
+            # @see Lithic::Models::AuthRules::V2CreateParams::Body::Rule#parameters
+            module Parameters
+              extend Lithic::Internal::Type::Union
+
+              variant -> { Lithic::AuthRules::VelocityLimitParams }
+
+              variant -> { Lithic::AuthRules::MerchantLockParameters }
+
+              variant -> { Lithic::AuthRules::Conditional3DSActionParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalACHActionParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters }
+
+              # Parameters for defining a TypeScript code rule
+              variant -> { Lithic::AuthRules::TypescriptCodeParameters }
+
+              variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
+
+              # @!method self.variants
+              #   @return [Array(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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
+            end
+
+            # The type of Auth Rule. For certain rule types, this determines the event stream
+            # during which it will be evaluated. For rules that can be applied to one of
+            # several event streams, the effective one is defined by the separate
+            # `event_stream` field.
+            #
+            # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+            # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+            # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+            #   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
+            #   ACH_PAYMENT_UPDATE event stream.
+            # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+            #   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
+            #   ACH_PAYMENT_UPDATE event stream.
+            # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
+            #   are read-only; `OTHER` cannot be used when creating a rule.
+            #
+            # @see Lithic::Models::AuthRules::V2CreateParams::Body::Rule#type
+            module Type
+              extend Lithic::Internal::Type::Enum
+
+              VELOCITY_LIMIT = :VELOCITY_LIMIT
+              MERCHANT_LOCK = :MERCHANT_LOCK
+              CONDITIONAL_ACTION = :CONDITIONAL_ACTION
+              TYPESCRIPT_CODE = :TYPESCRIPT_CODE
+              OTHER = :OTHER
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @deprecated
           class AccountLevelRule < Lithic::Internal::Type::BaseModel
             # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
+            #   @return [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
             required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Parameters }
 
             # @!attribute type
@@ -39,8 +183,6 @@ module Lithic
             #   several event streams, the effective one is defined by the separate
             #   `event_stream` field.
             #
-            #   - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #     AUTHORIZATION event stream.
             #   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             #   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -56,12 +198,20 @@ module Lithic
             required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type }
 
             # @!attribute account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
+            #
             #   Account tokens to which the Auth Rule applies.
             #
             #   @return [Array<String>, nil]
             optional :account_tokens, Lithic::Internal::Type::ArrayOf[String]
 
             # @!attribute business_account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
+            #
             #   Business Account tokens to which the Auth Rule applies.
             #
             #   @return [Array<String>, nil]
@@ -84,13 +234,15 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule} 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, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+            #
+            #   @param parameters [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
             #
             #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
             #
-            #   @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
+            #   @param account_tokens [Array<String>] Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
             #
-            #   @param business_account_tokens [Array<String>] Business Account tokens to which the Auth Rule applies.
+            #   @param business_account_tokens [Array<String>] Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
             #
             #   @param event_stream [Symbol, Lithic::Models::AuthRules::EventStream] The event stream during which the rule will be evaluated.
             #
@@ -102,9 +254,6 @@ module Lithic
             module Parameters
               extend Lithic::Internal::Type::Union
 
-              # Deprecated: Use CONDITIONAL_ACTION instead.
-              variant -> { Lithic::AuthRules::ConditionalBlockParameters }
-
               variant -> { Lithic::AuthRules::VelocityLimitParams }
 
               variant -> { Lithic::AuthRules::MerchantLockParameters }
@@ -127,7 +276,7 @@ module Lithic
               variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
 
               # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
+              #   @return [Array(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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
             end
 
             # The type of Auth Rule. For certain rule types, this determines the event stream
@@ -135,8 +284,6 @@ module Lithic
             # several event streams, the effective one is defined by the separate
             # `event_stream` field.
             #
-            # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #   AUTHORIZATION event stream.
             # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -152,7 +299,6 @@ module Lithic
             module Type
               extend Lithic::Internal::Type::Enum
 
-              CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
               VELOCITY_LIMIT = :VELOCITY_LIMIT
               MERCHANT_LOCK = :MERCHANT_LOCK
               CONDITIONAL_ACTION = :CONDITIONAL_ACTION
@@ -164,9 +310,15 @@ module Lithic
             end
           end
 
+          # @deprecated
           class CardLevelRule < Lithic::Internal::Type::BaseModel
             # @!attribute card_tokens
-            #   Card tokens to which the Auth Rule applies.
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `CARD` entities instead.
+            #
+            #   Card tokens to which the Auth Rule applies. Cards the rule applies to through a
+            #   `CARD_TAG` entity are not listed.
             #
             #   @return [Array<String>]
             required :card_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -174,7 +326,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, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
+            #   @return [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
             required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Parameters }
 
             # @!attribute type
@@ -183,8 +335,6 @@ module Lithic
             #   several event streams, the effective one is defined by the separate
             #   `event_stream` field.
             #
-            #   - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #     AUTHORIZATION event stream.
             #   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             #   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -216,9 +366,11 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule} for more
             #   details.
             #
-            #   @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
             #
-            #   @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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
+            #   @param card_tokens [Array<String>] Deprecated: Use `entities.include` with `CARD` entities instead.
+            #
+            #   @param parameters [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
             #
             #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
             #
@@ -232,9 +384,6 @@ module Lithic
             module Parameters
               extend Lithic::Internal::Type::Union
 
-              # Deprecated: Use CONDITIONAL_ACTION instead.
-              variant -> { Lithic::AuthRules::ConditionalBlockParameters }
-
               variant -> { Lithic::AuthRules::VelocityLimitParams }
 
               variant -> { Lithic::AuthRules::MerchantLockParameters }
@@ -257,7 +406,7 @@ module Lithic
               variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
 
               # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
+              #   @return [Array(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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
             end
 
             # The type of Auth Rule. For certain rule types, this determines the event stream
@@ -265,8 +414,6 @@ module Lithic
             # several event streams, the effective one is defined by the separate
             # `event_stream` field.
             #
-            # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #   AUTHORIZATION event stream.
             # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -282,7 +429,6 @@ module Lithic
             module Type
               extend Lithic::Internal::Type::Enum
 
-              CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
               VELOCITY_LIMIT = :VELOCITY_LIMIT
               MERCHANT_LOCK = :MERCHANT_LOCK
               CONDITIONAL_ACTION = :CONDITIONAL_ACTION
@@ -294,14 +440,19 @@ module Lithic
             end
           end
 
+          # @deprecated
           class ProgramLevelRule < Lithic::Internal::Type::BaseModel
             # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
+            #   @return [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
             required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Parameters }
 
             # @!attribute program_level
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
+            #
             #   Whether the Auth Rule applies to all authorizations on the card program.
             #
             #   @return [Boolean]
@@ -313,8 +464,6 @@ module Lithic
             #   several event streams, the effective one is defined by the separate
             #   `event_stream` field.
             #
-            #   - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #     AUTHORIZATION event stream.
             #   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             #   - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -336,19 +485,32 @@ module Lithic
             optional :event_stream, enum: -> { Lithic::AuthRules::EventStream }
 
             # @!attribute excluded_account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
+            #
             #   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
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
+            #
             #   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.
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `CARD` entities instead.
+            #
+            #   Card tokens to which the Auth Rule does not apply. Cards excluded through a
+            #   `CARD_TAG` entity are not listed.
             #
             #   @return [Array<String>, nil]
             optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -364,19 +526,21 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule} 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, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
             #
-            #   @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
+            #   @param parameters [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
+            #
+            #   @param program_level [Boolean] Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
             #
             #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
             #
             #   @param event_stream [Symbol, Lithic::Models::AuthRules::EventStream] The event stream during which the rule will be evaluated.
             #
-            #   @param excluded_account_tokens [Array<String>] Account tokens to which the Auth Rule does not apply.
+            #   @param excluded_account_tokens [Array<String>] Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
             #
-            #   @param excluded_business_account_tokens [Array<String>] Business account tokens to which the Auth Rule does not apply.
+            #   @param excluded_business_account_tokens [Array<String>] Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
             #
-            #   @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
+            #   @param excluded_card_tokens [Array<String>] Deprecated: Use `entities.exclude` with `CARD` entities instead.
             #
             #   @param name [String, nil] Auth Rule Name
 
@@ -386,9 +550,6 @@ module Lithic
             module Parameters
               extend Lithic::Internal::Type::Union
 
-              # Deprecated: Use CONDITIONAL_ACTION instead.
-              variant -> { Lithic::AuthRules::ConditionalBlockParameters }
-
               variant -> { Lithic::AuthRules::VelocityLimitParams }
 
               variant -> { Lithic::AuthRules::MerchantLockParameters }
@@ -411,7 +572,7 @@ module Lithic
               variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
 
               # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
+              #   @return [Array(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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
             end
 
             # The type of Auth Rule. For certain rule types, this determines the event stream
@@ -419,8 +580,6 @@ module Lithic
             # several event streams, the effective one is defined by the separate
             # `event_stream` field.
             #
-            # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
-            #   AUTHORIZATION event stream.
             # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
             # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
             # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -436,7 +595,6 @@ module Lithic
             module Type
               extend Lithic::Internal::Type::Enum
 
-              CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
               VELOCITY_LIMIT = :VELOCITY_LIMIT
               MERCHANT_LOCK = :MERCHANT_LOCK
               CONDITIONAL_ACTION = :CONDITIONAL_ACTION
@@ -449,7 +607,7 @@ module Lithic
           end
 
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule)]
+          #   @return [Array(Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule)]
         end
       end
     end

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

@@ -16,13 +16,13 @@ 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, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil]
+        #   @return [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil]
         optional :parameters, union: -> { Lithic::AuthRules::V2DraftParams::Parameters }, nil?: true
 
         # @!method initialize(auth_rule_token:, parameters: nil, request_options: {})
         #   @param auth_rule_token [String]
         #
-        #   @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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
+        #   @param parameters [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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
         #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
@@ -30,9 +30,6 @@ module Lithic
         module Parameters
           extend Lithic::Internal::Type::Union
 
-          # Deprecated: Use CONDITIONAL_ACTION instead.
-          variant -> { Lithic::AuthRules::ConditionalBlockParameters }
-
           variant -> { Lithic::AuthRules::VelocityLimitParams }
 
           variant -> { Lithic::AuthRules::MerchantLockParameters }
@@ -55,7 +52,7 @@ module Lithic
           variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
 
           # @!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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
+          #   @return [Array(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::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
         end
       end
     end

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

@@ -55,7 +55,8 @@ module Lithic
         optional :page_size, Integer
 
         # @!attribute scope
-        #   Only return Auth Rules that are bound to the provided scope.
+        #   Only return Auth Rules that are bound to the provided scope. When no token is
+        #   provided, `CARD` also returns Auth Rules that include a `CARD_TAG` entity.
         #
         #   @return [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope, nil]
         optional :scope, enum: -> { Lithic::AuthRules::V2ListParams::Scope }
@@ -85,13 +86,14 @@ module Lithic
         #
         #   @param page_size [Integer] Page size (for pagination).
         #
-        #   @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
+        #   @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope. When no token is pr
         #
         #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
         #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
-        # Only return Auth Rules that are bound to the provided scope.
+        # Only return Auth Rules that are bound to the provided scope. When no token is
+        # provided, `CARD` also returns Auth Rules that include a `CARD_TAG` entity.
         module Scope
           extend Lithic::Internal::Type::Enum
 

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#update_entities
+      class V2UpdateEntitiesParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!attribute auth_rule_token
+        #
+        #   @return [String]
+        required :auth_rule_token, String
+
+        # @!attribute add
+        #   Entities to add to the rule's `include` and `exclude` lists
+        #
+        #   @return [Lithic::Models::AuthRules::AuthRuleEntities, nil]
+        optional :add, -> { Lithic::AuthRules::AuthRuleEntities }
+
+        # @!attribute remove
+        #   Entities to remove from the rule's `include` and `exclude` lists
+        #
+        #   @return [Lithic::Models::AuthRules::AuthRuleEntities, nil]
+        optional :remove, -> { Lithic::AuthRules::AuthRuleEntities }
+
+        # @!method initialize(auth_rule_token:, add: nil, remove: nil, request_options: {})
+        #   @param auth_rule_token [String]
+        #
+        #   @param add [Lithic::Models::AuthRules::AuthRuleEntities] Entities to add to the rule's `include` and `exclude` lists
+        #
+        #   @param remove [Lithic::Models::AuthRules::AuthRuleEntities] Entities to remove from the rule's `include` and `exclude` lists
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end