lithic 0.11.0 → 0.13.0

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

@@ -176,6 +176,37 @@ module Lithic
           # - `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.
+          # - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
+          #   entity's transaction history. Null if fewer than 30 approved transactions in
+          #   the specified window. Requires `parameters.scope` and `parameters.interval`.
+          # - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
+          #   entity over the specified window, in cents. Requires `parameters.scope` and
+          #   `parameters.interval`.
+          # - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
+          #   amounts for the entity over the specified window, in cents. Null if fewer than
+          #   30 approved transactions in the specified window. Requires `parameters.scope`
+          #   and `parameters.interval`.
+          # - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
+          #   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
+          #   Requires `parameters.scope`.
+          # - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
+          #   transaction history. Valid values are `TRUE`, `FALSE`. Requires
+          #   `parameters.scope`.
+          # - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
+          #   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
+          # - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
+          #   the entity over the last 30 days (rolling). Requires `parameters.scope`. Not
+          #   supported for `BUSINESS_ACCOUNT` scope.
+          # - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
+          #   transaction for the entity. Requires `parameters.scope`.
+          # - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
+          #   the entity's transaction history. Requires `parameters.scope`.
+          # - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
+          #   card's approved transaction history (capped at the 1000 most recently seen
+          #   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
+          #   `parameters` required.
+          # - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
+          #   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
           sig do
             returns(
               Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol
@@ -191,12 +222,36 @@ module Lithic
           sig { returns(Lithic::AuthRules::ConditionalValue::Variants) }
           attr_accessor :value
 
+          # Additional parameters required for transaction history signal attributes.
+          # Required when `attribute` is one of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
+          # `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
+          # `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
+          # or `DISTINCT_COUNTRY_COUNT`. Not used for other attributes.
+          sig do
+            returns(
+              T.nilable(
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters
+              )
+            )
+          end
+          attr_reader :parameters
+
+          sig do
+            params(
+              parameters:
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::OrHash
+            ).void
+          end
+          attr_writer :parameters
+
           sig do
             params(
               attribute:
                 Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol,
               operation: Lithic::AuthRules::ConditionalOperation::OrSymbol,
-              value: Lithic::AuthRules::ConditionalValue::Variants
+              value: Lithic::AuthRules::ConditionalValue::Variants,
+              parameters:
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
@@ -271,11 +326,48 @@ module Lithic
             # - `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.
+            # - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
+            #   entity's transaction history. Null if fewer than 30 approved transactions in
+            #   the specified window. Requires `parameters.scope` and `parameters.interval`.
+            # - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
+            #   entity over the specified window, in cents. Requires `parameters.scope` and
+            #   `parameters.interval`.
+            # - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
+            #   amounts for the entity over the specified window, in cents. Null if fewer than
+            #   30 approved transactions in the specified window. Requires `parameters.scope`
+            #   and `parameters.interval`.
+            # - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
+            #   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
+            #   Requires `parameters.scope`.
+            # - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
+            #   transaction history. Valid values are `TRUE`, `FALSE`. Requires
+            #   `parameters.scope`.
+            # - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
+            #   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
+            # - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
+            #   the entity over the last 30 days (rolling). Requires `parameters.scope`. Not
+            #   supported for `BUSINESS_ACCOUNT` scope.
+            # - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
+            #   transaction for the entity. Requires `parameters.scope`.
+            # - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
+            #   the entity's transaction history. Requires `parameters.scope`.
+            # - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
+            #   card's approved transaction history (capped at the 1000 most recently seen
+            #   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
+            #   `parameters` required.
+            # - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
+            #   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
             attribute:,
             # The operation to apply to the attribute
             operation:,
             # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
-            value:
+            value:,
+            # Additional parameters required for transaction history signal attributes.
+            # Required when `attribute` is one of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
+            # `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
+            # `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
+            # or `DISTINCT_COUNTRY_COUNT`. Not used for other attributes.
+            parameters: nil
           )
           end
 
@@ -285,7 +377,9 @@ module Lithic
                 attribute:
                   Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol,
                 operation: Lithic::AuthRules::ConditionalOperation::OrSymbol,
-                value: Lithic::AuthRules::ConditionalValue::Variants
+                value: Lithic::AuthRules::ConditionalValue::Variants,
+                parameters:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters
               }
             )
           end
@@ -363,6 +457,37 @@ module Lithic
           # - `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.
+          # - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
+          #   entity's transaction history. Null if fewer than 30 approved transactions in
+          #   the specified window. Requires `parameters.scope` and `parameters.interval`.
+          # - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
+          #   entity over the specified window, in cents. Requires `parameters.scope` and
+          #   `parameters.interval`.
+          # - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
+          #   amounts for the entity over the specified window, in cents. Null if fewer than
+          #   30 approved transactions in the specified window. Requires `parameters.scope`
+          #   and `parameters.interval`.
+          # - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
+          #   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
+          #   Requires `parameters.scope`.
+          # - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
+          #   transaction history. Valid values are `TRUE`, `FALSE`. Requires
+          #   `parameters.scope`.
+          # - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
+          #   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
+          # - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
+          #   the entity over the last 30 days (rolling). Requires `parameters.scope`. Not
+          #   supported for `BUSINESS_ACCOUNT` scope.
+          # - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
+          #   transaction for the entity. Requires `parameters.scope`.
+          # - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
+          #   the entity's transaction history. Requires `parameters.scope`.
+          # - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
+          #   card's approved transaction history (capped at the 1000 most recently seen
+          #   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
+          #   `parameters` required.
+          # - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
+          #   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
           module Attribute
             extend Lithic::Internal::Type::Enum
 
@@ -505,6 +630,61 @@ module Lithic
                 :ACCOUNT_AGE,
                 Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
               )
+            AMOUNT_Z_SCORE =
+              T.let(
+                :AMOUNT_Z_SCORE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            AVG_TRANSACTION_AMOUNT =
+              T.let(
+                :AVG_TRANSACTION_AMOUNT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            STDEV_TRANSACTION_AMOUNT =
+              T.let(
+                :STDEV_TRANSACTION_AMOUNT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            IS_NEW_COUNTRY =
+              T.let(
+                :IS_NEW_COUNTRY,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            IS_NEW_MCC =
+              T.let(
+                :IS_NEW_MCC,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            IS_FIRST_TRANSACTION =
+              T.let(
+                :IS_FIRST_TRANSACTION,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CONSECUTIVE_DECLINES =
+              T.let(
+                :CONSECUTIVE_DECLINES,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            TIME_SINCE_LAST_TRANSACTION =
+              T.let(
+                :TIME_SINCE_LAST_TRANSACTION,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            DISTINCT_COUNTRY_COUNT =
+              T.let(
+                :DISTINCT_COUNTRY_COUNT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            IS_NEW_MERCHANT =
+              T.let(
+                :IS_NEW_MERCHANT,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            THREE_DS_SUCCESS_RATE =
+              T.let(
+                :THREE_DS_SUCCESS_RATE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -516,6 +696,177 @@ module Lithic
             def self.values
             end
           end
+
+          class Parameters < Lithic::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters,
+                  Lithic::Internal::AnyHash
+                )
+              end
+
+            # The time window for statistical attributes (`AMOUNT_Z_SCORE`,
+            # `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
+            # all-time history or a specific window (`7D`, `30D`, `90D`).
+            sig do
+              returns(
+                T.nilable(
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::OrSymbol
+                )
+              )
+            end
+            attr_reader :interval
+
+            sig do
+              params(
+                interval:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::OrSymbol
+              ).void
+            end
+            attr_writer :interval
+
+            # The entity scope to evaluate the attribute against.
+            sig do
+              returns(
+                T.nilable(
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::OrSymbol
+                )
+              )
+            end
+            attr_reader :scope
+
+            sig do
+              params(
+                scope:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::OrSymbol
+              ).void
+            end
+            attr_writer :scope
+
+            # Additional parameters required for transaction history signal attributes.
+            # Required when `attribute` is one of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
+            # `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
+            # `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
+            # or `DISTINCT_COUNTRY_COUNT`. Not used for other attributes.
+            sig do
+              params(
+                interval:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::OrSymbol,
+                scope:
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The time window for statistical attributes (`AMOUNT_Z_SCORE`,
+              # `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
+              # all-time history or a specific window (`7D`, `30D`, `90D`).
+              interval: nil,
+              # The entity scope to evaluate the attribute against.
+              scope: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  interval:
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::OrSymbol,
+                  scope:
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The time window for statistical attributes (`AMOUNT_Z_SCORE`,
+            # `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
+            # all-time history or a specific window (`7D`, `30D`, `90D`).
+            module Interval
+              extend Lithic::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              LIFETIME =
+                T.let(
+                  :LIFETIME,
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::TaggedSymbol
+                )
+              INTERVAL_7_D =
+                T.let(
+                  :"7D",
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::TaggedSymbol
+                )
+              INTERVAL_30_D =
+                T.let(
+                  :"30D",
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::TaggedSymbol
+                )
+              INTERVAL_90_D =
+                T.let(
+                  :"90D",
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The entity scope to evaluate the attribute against.
+            module Scope
+              extend Lithic::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              CARD =
+                T.let(
+                  :CARD,
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::TaggedSymbol
+                )
+              ACCOUNT =
+                T.let(
+                  :ACCOUNT,
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::TaggedSymbol
+                )
+              BUSINESS_ACCOUNT =
+                T.let(
+                  :BUSINESS_ACCOUNT,
+                  Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
       end
     end