conditional_authorization_action_parameters.rb

# frozen_string_literal: true

module Lithic
  module Models
    module AuthRules
      class ConditionalAuthorizationActionParameters < Lithic::Internal::Type::BaseModel
        # @!attribute action
        #   The action to take if the conditions are met.
        #
        #   @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Action]
        required :action, enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action }

        # @!attribute conditions
        #
        #   @return [Array<Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition>]
        required :conditions,
                 -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition] }

        # @!method initialize(action:, conditions:)
        #   @param action [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Action] The action to take if the conditions are met.
        #
        #   @param conditions [Array<Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition>]

        # The action to take if the conditions are met.
        #
        # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters#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.
          #   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
          #     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
          #     `TOKEN_AUTHENTICATED`.
          #   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
          #     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
          #     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
          #     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
          #     `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
          #   - `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.
          #   - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
          #     represents the amount of cash being withdrawn or advanced.
          #   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
          #     given authorization. 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.
          #   - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
          #     trailing 15 minutes before the authorization.
          #   - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
          #     trailing hour up and until the authorization.
          #   - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
          #     trailing 24 hours up and until the authorization.
          #   - `CARD_STATE`: The current state of the card associated with the transaction.
          #     Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
          #     `PENDING_FULFILLMENT`.
          #   - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
          #     Valid values are `TRUE`, `FALSE`.
          #   - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
          #     `OK`, `BLOCKED`.
          #   - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
          #     source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
          #     `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
          #   - `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates
          #     the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
          #   - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
          #     data with the cardholder KYC data if it exists. Valid values are `MATCH`,
          #     `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
          #   - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
          #     cardholder received the service, e.g. "NY". When a service location is present
          #     in the network data, the service location state is used. Otherwise, falls back
          #     to the card acceptor state.
          #   - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
          #     the service, e.g. "10001". When a service location is present in the network
          #     data, the service location postal code is used. Otherwise, falls back to the
          #     card acceptor postal code.
          #   - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
          #   - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
          #     of the authorization.
          #
          #   @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute]
          required :attribute,
                   enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute }

          # @!attribute operation
          #   The operation to apply to the attribute
          #
          #   @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation]
          required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation }

          # @!attribute value
          #   A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
          #
          #   @return [String, Integer, Array<String>, Time]
          required :value, union: -> { Lithic::AuthRules::ConditionalValue }

          # @!method initialize(attribute:, operation:, value:)
          #   Some parameter documentations has been truncated, see
          #   {Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition}
          #   for more details.
          #
          #   @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute] The attribute to target.
          #
          #   @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute
          #
          #   @param value [String, Integer, Array<String>, Time] 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.
          # - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
          #   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
          #   `TOKEN_AUTHENTICATED`.
          # - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
          #   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
          #   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
          #   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
          #   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
          # - `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.
          # - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
          #   represents the amount of cash being withdrawn or advanced.
          # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
          #   given authorization. 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.
          # - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
          #   trailing 15 minutes before the authorization.
          # - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
          #   trailing hour up and until the authorization.
          # - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
          #   trailing 24 hours up and until the authorization.
          # - `CARD_STATE`: The current state of the card associated with the transaction.
          #   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
          #   `PENDING_FULFILLMENT`.
          # - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
          #   Valid values are `TRUE`, `FALSE`.
          # - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
          #   `OK`, `BLOCKED`.
          # - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
          #   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
          #   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
          # - `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates
          #   the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
          # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
          #   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
          #   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
          # - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
          #   cardholder received the service, e.g. "NY". When a service location is present
          #   in the network data, the service location state is used. Otherwise, falls back
          #   to the card acceptor state.
          # - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
          #   the service, e.g. "10001". When a service location is present in the network
          #   data, the service location postal code is used. Otherwise, falls back to the
          #   card acceptor postal code.
          # - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
          # - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
          #   of the authorization.
          #
          # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition#attribute
          module Attribute
            extend Lithic::Internal::Type::Enum

            MCC = :MCC
            COUNTRY = :COUNTRY
            CURRENCY = :CURRENCY
            MERCHANT_ID = :MERCHANT_ID
            DESCRIPTOR = :DESCRIPTOR
            LIABILITY_SHIFT = :LIABILITY_SHIFT
            PAN_ENTRY_MODE = :PAN_ENTRY_MODE
            TRANSACTION_AMOUNT = :TRANSACTION_AMOUNT
            CASH_AMOUNT = :CASH_AMOUNT
            RISK_SCORE = :RISK_SCORE
            CARD_TRANSACTION_COUNT_15_M = :CARD_TRANSACTION_COUNT_15M
            CARD_TRANSACTION_COUNT_1_H = :CARD_TRANSACTION_COUNT_1H
            CARD_TRANSACTION_COUNT_24_H = :CARD_TRANSACTION_COUNT_24H
            CARD_STATE = :CARD_STATE
            PIN_ENTERED = :PIN_ENTERED
            PIN_STATUS = :PIN_STATUS
            WALLET_TYPE = :WALLET_TYPE
            TRANSACTION_INITIATOR = :TRANSACTION_INITIATOR
            ADDRESS_MATCH = :ADDRESS_MATCH
            SERVICE_LOCATION_STATE = :SERVICE_LOCATION_STATE
            SERVICE_LOCATION_POSTAL_CODE = :SERVICE_LOCATION_POSTAL_CODE
            CARD_AGE = :CARD_AGE
            ACCOUNT_AGE = :ACCOUNT_AGE

            # @!method self.values
            #   @return [Array<Symbol>]
          end
        end
      end
    end
  end
end