lithic 0.1.0.pre.alpha.54 → 0.1.0.pre.alpha.56

data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi

@@ -0,0 +1,437 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AuthRules
+      class ConditionalAuthorizationActionParameters < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # The action to take if the conditions are met.
+        sig do
+          returns(
+            Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
+        sig do
+          returns(
+            T::Array[
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition
+            ]
+          )
+        end
+        attr_accessor :conditions
+
+        sig do
+          params(
+            action:
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::OrSymbol,
+            conditions:
+              T::Array[
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The action to take if the conditions are met.
+          action:,
+          conditions:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action:
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::OrSymbol,
+              conditions:
+                T::Array[
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The action to take if the conditions are met.
+        module Action
+          extend Lithic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DECLINE =
+            T.let(
+              :DECLINE,
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::TaggedSymbol
+            )
+          CHALLENGE =
+            T.let(
+              :CHALLENGE,
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Action::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Condition < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # 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`.
+          sig do
+            returns(
+              Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol
+            )
+          end
+          attr_accessor :attribute
+
+          # The operation to apply to the attribute
+          sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) }
+          attr_accessor :operation
+
+          # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+          sig { returns(Lithic::AuthRules::ConditionalValue::Variants) }
+          attr_accessor :value
+
+          sig do
+            params(
+              attribute:
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol,
+              operation: Lithic::AuthRules::ConditionalOperation::OrSymbol,
+              value: Lithic::AuthRules::ConditionalValue::Variants
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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`.
+            attribute:,
+            # The operation to apply to the attribute
+            operation:,
+            # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+            value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                attribute:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol,
+                operation: Lithic::AuthRules::ConditionalOperation::OrSymbol,
+                value: Lithic::AuthRules::ConditionalValue::Variants
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # 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`.
+          module Attribute
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MCC =
+              T.let(
+                :MCC,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            COUNTRY =
+              T.let(
+                :COUNTRY,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CURRENCY =
+              T.let(
+                :CURRENCY,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            MERCHANT_ID =
+              T.let(
+                :MERCHANT_ID,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            DESCRIPTOR =
+              T.let(
+                :DESCRIPTOR,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            LIABILITY_SHIFT =
+              T.let(
+                :LIABILITY_SHIFT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            PAN_ENTRY_MODE =
+              T.let(
+                :PAN_ENTRY_MODE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            TRANSACTION_AMOUNT =
+              T.let(
+                :TRANSACTION_AMOUNT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CASH_AMOUNT =
+              T.let(
+                :CASH_AMOUNT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            RISK_SCORE =
+              T.let(
+                :RISK_SCORE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_TRANSACTION_COUNT_15_M =
+              T.let(
+                :CARD_TRANSACTION_COUNT_15M,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_TRANSACTION_COUNT_1_H =
+              T.let(
+                :CARD_TRANSACTION_COUNT_1H,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_TRANSACTION_COUNT_24_H =
+              T.let(
+                :CARD_TRANSACTION_COUNT_24H,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_STATE =
+              T.let(
+                :CARD_STATE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            PIN_ENTERED =
+              T.let(
+                :PIN_ENTERED,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            PIN_STATUS =
+              T.let(
+                :PIN_STATUS,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            WALLET_TYPE =
+              T.let(
+                :WALLET_TYPE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            TRANSACTION_INITIATOR =
+              T.let(
+                :TRANSACTION_INITIATOR,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            ADDRESS_MATCH =
+              T.let(
+                :ADDRESS_MATCH,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/auth_rules/conditional_operation.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AuthRules
+      # The operation to apply to the attribute
+      module ConditionalOperation
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::AuthRules::ConditionalOperation)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IS_ONE_OF =
+          T.let(
+            :IS_ONE_OF,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_NOT_ONE_OF =
+          T.let(
+            :IS_NOT_ONE_OF,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        MATCHES =
+          T.let(:MATCHES, Lithic::AuthRules::ConditionalOperation::TaggedSymbol)
+        DOES_NOT_MATCH =
+          T.let(
+            :DOES_NOT_MATCH,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_EQUAL_TO =
+          T.let(
+            :IS_EQUAL_TO,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_NOT_EQUAL_TO =
+          T.let(
+            :IS_NOT_EQUAL_TO,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_GREATER_THAN =
+          T.let(
+            :IS_GREATER_THAN,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_GREATER_THAN_OR_EQUAL_TO =
+          T.let(
+            :IS_GREATER_THAN_OR_EQUAL_TO,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_LESS_THAN =
+          T.let(
+            :IS_LESS_THAN,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+        IS_LESS_THAN_OR_EQUAL_TO =
+          T.let(
+            :IS_LESS_THAN_OR_EQUAL_TO,
+            Lithic::AuthRules::ConditionalOperation::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Lithic::AuthRules::ConditionalOperation::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end