lithic 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

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

@@ -23,11 +23,17 @@ module Lithic
         # @!attribute parameters
         #   Parameters for the Auth Rule
         #
-        #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, nil]
+        #   @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters, nil]
         optional :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Parameters }
 
         # @!attribute type
-        #   The type of Auth Rule
+        #   The type of Auth Rule. Effectively determines the event stream during which it
+        #   will be evaluated.
+        #
+        #   - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
+        #   - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+        #   - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+        #   - `CONDITIONAL_3DS_ACTION`: THREE_DS_AUTHENTICATION event stream.
         #
         #   @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type, nil]
         optional :type, enum: -> { Lithic::AuthRules::V2CreateParams::Type }
@@ -51,6 +57,9 @@ module Lithic
         optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
 
         # @!method initialize(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::AuthRules::V2CreateParams} for more details.
+        #
         #   @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
         #
         #   @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
@@ -59,9 +68,9 @@ module Lithic
         #
         #   @param name [String, nil] Auth Rule Name
         #
-        #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters] Parameters for the Auth Rule
+        #   @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters] Parameters for the Auth Rule
         #
-        #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
+        #   @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. Effectively determines the event stream during which it w
         #
         #   @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
         #
@@ -77,6 +86,8 @@ module Lithic
 
           variant -> { Lithic::AuthRules::V2CreateParams::Parameters::MerchantLockParameters }
 
+          variant -> { Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters }
+
           class MerchantLockParameters < Lithic::Internal::Type::BaseModel
             # @!attribute merchants
             #   A list of merchant locks defining specific merchants or groups of merchants
@@ -136,17 +147,205 @@ module Lithic
             end
           end
 
+          class Conditional3DSActionParameters < Lithic::Internal::Type::BaseModel
+            # @!attribute action
+            #   The action to take if the conditions are met.
+            #
+            #   @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Action]
+            required :action,
+                     enum: -> {
+                       Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Action
+                     }
+
+            # @!attribute conditions
+            #
+            #   @return [Array<Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition>]
+            required :conditions,
+                     -> {
+                       Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition]
+                     }
+
+            # @!method initialize(action:, conditions:)
+            #   @param action [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Action] The action to take if the conditions are met.
+            #
+            #   @param conditions [Array<Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition>]
+
+            # The action to take if the conditions are met.
+            #
+            # @see Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters#action
+            module Action
+              extend Lithic::Internal::Type::Enum
+
+              DECLINE = :DECLINE
+              CHALLENGE = :CHALLENGE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            class Condition < Lithic::Internal::Type::BaseModel
+              # @!attribute attribute
+              #   The attribute to target.
+              #
+              #   The following attributes may be targeted:
+              #
+              #   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
+              #     business by the types of goods or services it provides.
+              #   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
+              #     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
+              #     Netherlands Antilles.
+              #   - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+              #     the transaction.
+              #   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
+              #     (merchant).
+              #   - `DESCRIPTOR`: Short description of card acceptor.
+              #   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
+              #     fee field in the settlement/cardholder billing currency. This is the amount
+              #     the issuer should authorize against unless the issuer is paying the acquirer
+              #     fee on behalf of the cardholder.
+              #   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+              #     given authentication. Scores are on a range of 0-999, with 0 representing the
+              #     lowest risk and 999 representing the highest risk. For Visa transactions,
+              #     where the raw score has a range of 0-99, Lithic will normalize the score by
+              #     multiplying the raw score by 10x.
+              #   - `MESSAGE_CATEGORY`: The category of the authentication being processed.
+              #
+              #   @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Attribute, nil]
+              optional :attribute,
+                       enum: -> {
+                         Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Attribute
+                       }
+
+              # @!attribute operation
+              #   The operation to apply to the attribute
+              #
+              #   @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Operation, nil]
+              optional :operation,
+                       enum: -> {
+                         Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Operation
+                       }
+
+              # @!attribute value
+              #   A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+              #
+              #   @return [String, Integer, Array<String>, nil]
+              optional :value,
+                       union: -> {
+                         Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Value
+                       }
+
+              # @!method initialize(attribute: nil, operation: nil, value: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition}
+              #   for more details.
+              #
+              #   @param attribute [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Attribute] The attribute to target.
+              #
+              #   @param operation [Symbol, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Operation] The operation to apply to the attribute
+              #
+              #   @param value [String, Integer, Array<String>] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+
+              # The attribute to target.
+              #
+              # The following attributes may be targeted:
+              #
+              # - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
+              #   business by the types of goods or services it provides.
+              # - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
+              #   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
+              #   Netherlands Antilles.
+              # - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+              #   the transaction.
+              # - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
+              #   (merchant).
+              # - `DESCRIPTOR`: Short description of card acceptor.
+              # - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
+              #   fee field in the settlement/cardholder billing currency. This is the amount
+              #   the issuer should authorize against unless the issuer is paying the acquirer
+              #   fee on behalf of the cardholder.
+              # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+              #   given authentication. Scores are on a range of 0-999, with 0 representing the
+              #   lowest risk and 999 representing the highest risk. For Visa transactions,
+              #   where the raw score has a range of 0-99, Lithic will normalize the score by
+              #   multiplying the raw score by 10x.
+              # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
+              #
+              # @see Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition#attribute
+              module Attribute
+                extend Lithic::Internal::Type::Enum
+
+                MCC = :MCC
+                COUNTRY = :COUNTRY
+                CURRENCY = :CURRENCY
+                MERCHANT_ID = :MERCHANT_ID
+                DESCRIPTOR = :DESCRIPTOR
+                TRANSACTION_AMOUNT = :TRANSACTION_AMOUNT
+                RISK_SCORE = :RISK_SCORE
+                MESSAGE_CATEGORY = :MESSAGE_CATEGORY
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # The operation to apply to the attribute
+              #
+              # @see Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition#operation
+              module Operation
+                extend Lithic::Internal::Type::Enum
+
+                IS_ONE_OF = :IS_ONE_OF
+                IS_NOT_ONE_OF = :IS_NOT_ONE_OF
+                MATCHES = :MATCHES
+                DOES_NOT_MATCH = :DOES_NOT_MATCH
+                IS_GREATER_THAN = :IS_GREATER_THAN
+                IS_LESS_THAN = :IS_LESS_THAN
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+              #
+              # @see Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition#value
+              module Value
+                extend Lithic::Internal::Type::Union
+
+                # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+                variant String
+
+                # A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN`
+                variant Integer
+
+                # An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
+                variant -> { Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::Condition::Value::StringArray }
+
+                # @!method self.variants
+                #   @return [Array(String, Integer, Array<String>)]
+
+                # @type [Lithic::Internal::Type::Converter]
+                StringArray = Lithic::Internal::Type::ArrayOf[String]
+              end
+            end
+          end
+
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters)]
+          #   @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters)]
         end
 
-        # The type of Auth Rule
+        # The type of Auth Rule. Effectively determines the event stream during which it
+        # will be evaluated.
+        #
+        # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
+        # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+        # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+        # - `CONDITIONAL_3DS_ACTION`: THREE_DS_AUTHENTICATION event stream.
         module Type
           extend Lithic::Internal::Type::Enum
 
           CONDITIONAL_BLOCK = :CONDITIONAL_BLOCK
           VELOCITY_LIMIT = :VELOCITY_LIMIT
           MERCHANT_LOCK = :MERCHANT_LOCK
+          CONDITIONAL_3DS_ACTION = :CONDITIONAL_3DS_ACTION
 
           # @!method self.values
           #   @return [Array<Symbol>]