lithic 0.13.0 → 0.15.0

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

@@ -61,26 +61,27 @@ module Lithic
           #   - `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.
+          #     fee on behalf of the cardholder. Use an integer value.
           #   - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
-          #     represents the amount of cash being withdrawn or advanced.
+          #     represents the amount of cash being withdrawn or advanced. Use an integer
+          #     value.
           #   - `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.
+          #     multiplying the raw score by 10x. Use an integer value.
           #   - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
-          #     trailing 15 minutes before the authorization.
+          #     trailing 15 minutes before the authorization. Use an integer value.
           #   - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
-          #     trailing hour up and until the authorization.
+          #     trailing hour up and until the authorization. Use an integer value.
           #   - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
-          #     trailing 24 hours up and until the authorization.
+          #     trailing 24 hours up and until the authorization. Use an integer value.
           #   - `CARD_DECLINE_COUNT_15M`: The number of declined transactions on the card in
-          #     the trailing 15 minutes before the authorization.
+          #     the trailing 15 minutes before the authorization. Use an integer value.
           #   - `CARD_DECLINE_COUNT_1H`: The number of declined transactions on the card in
-          #     the trailing hour up and until the authorization.
+          #     the trailing hour up and until the authorization. Use an integer value.
           #   - `CARD_DECLINE_COUNT_24H`: The number of declined transactions on the card in
-          #     the trailing 24 hours up and until the authorization.
+          #     the trailing 24 hours up and until the authorization. Use an integer value.
           #   - `CARD_STATE`: The current state of the card associated with the transaction.
           #     Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
           #     `PENDING_FULFILLMENT`.
@@ -105,18 +106,21 @@ module Lithic
           #     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.
+          #     Use an integer value.
           #   - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
-          #     of the authorization.
+          #     of the authorization. Use an integer value. For programs where Lithic does not
+          #     manage or retain account holder data, this attribute does not evaluate.
           #   - `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`.
+          #     Use a decimal value.
           #   - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
           #     entity over the specified window, in cents. Requires `parameters.scope` and
-          #     `parameters.interval`.
+          #     `parameters.interval`. Use a decimal value.
           #   - `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`.
+          #     and `parameters.interval`. Use a decimal value.
           #   - `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`.
@@ -127,17 +131,31 @@ module Lithic
           #     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.
+          #     supported for `BUSINESS_ACCOUNT` scope. Use an integer value.
           #   - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
-          #     transaction for the entity. Requires `parameters.scope`.
+          #     transaction for the entity, rounded to the nearest whole day. Requires
+          #     `parameters.scope`. Use an integer value.
           #   - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
-          #     the entity's transaction history. Requires `parameters.scope`.
+          #     the entity's transaction history. Requires `parameters.scope`. Use an integer
+          #     value.
           #   - `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.
+          #     Use a decimal value.
+          #   - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
+          #     between the postal code centers of the last card-present transaction and the
+          #     current transaction, divided by the elapsed time. Null if there is no prior
+          #     card-present transaction, if either postal code cannot be geocoded, or if
+          #     elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
+          #     decimal value.
+          #   - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
+          #     code centers of the last card-present transaction and the current transaction.
+          #     Null if there is no prior card-present transaction or if either postal code
+          #     cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
+          #     Use a decimal value.
           #
           #   @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute]
           required :attribute,
@@ -152,15 +170,16 @@ module Lithic
           # @!attribute value
           #   A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
           #
-          #   @return [String, Integer, Array<String>, Time]
+          #   @return [String, Integer, Float, Array<String>, Time]
           required :value, union: -> { Lithic::AuthRules::ConditionalValue }
 
           # @!attribute parameters
-          #   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.
+          #   Additional parameters for certain 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` (require `scope`); or
+          #   `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
+          #   for other attributes.
           #
           #   @return [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters, nil]
           optional :parameters,
@@ -175,9 +194,9 @@ module Lithic
           #
           #   @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`
+          #   @param value [String, Integer, Float, Array<String>, Time] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
           #
-          #   @param parameters [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters] Additional parameters required for transaction history signal attributes. Requir
+          #   @param parameters [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters] Additional parameters for certain attributes. Required when `attribute` is one o
 
           # The attribute to target.
           #
@@ -204,26 +223,27 @@ module Lithic
           # - `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.
+          #   fee on behalf of the cardholder. Use an integer value.
           # - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
-          #   represents the amount of cash being withdrawn or advanced.
+          #   represents the amount of cash being withdrawn or advanced. Use an integer
+          #   value.
           # - `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.
+          #   multiplying the raw score by 10x. Use an integer value.
           # - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
-          #   trailing 15 minutes before the authorization.
+          #   trailing 15 minutes before the authorization. Use an integer value.
           # - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
-          #   trailing hour up and until the authorization.
+          #   trailing hour up and until the authorization. Use an integer value.
           # - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
-          #   trailing 24 hours up and until the authorization.
+          #   trailing 24 hours up and until the authorization. Use an integer value.
           # - `CARD_DECLINE_COUNT_15M`: The number of declined transactions on the card in
-          #   the trailing 15 minutes before the authorization.
+          #   the trailing 15 minutes before the authorization. Use an integer value.
           # - `CARD_DECLINE_COUNT_1H`: The number of declined transactions on the card in
-          #   the trailing hour up and until the authorization.
+          #   the trailing hour up and until the authorization. Use an integer value.
           # - `CARD_DECLINE_COUNT_24H`: The number of declined transactions on the card in
-          #   the trailing 24 hours up and until the authorization.
+          #   the trailing 24 hours up and until the authorization. Use an integer value.
           # - `CARD_STATE`: The current state of the card associated with the transaction.
           #   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
           #   `PENDING_FULFILLMENT`.
@@ -248,18 +268,21 @@ module Lithic
           #   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.
+          #   Use an integer value.
           # - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
-          #   of the authorization.
+          #   of the authorization. Use an integer value. For programs where Lithic does not
+          #   manage or retain account holder data, this attribute does not evaluate.
           # - `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`.
+          #   Use a decimal value.
           # - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
           #   entity over the specified window, in cents. Requires `parameters.scope` and
-          #   `parameters.interval`.
+          #   `parameters.interval`. Use a decimal value.
           # - `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`.
+          #   and `parameters.interval`. Use a decimal value.
           # - `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`.
@@ -270,17 +293,31 @@ module Lithic
           #   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.
+          #   supported for `BUSINESS_ACCOUNT` scope. Use an integer value.
           # - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
-          #   transaction for the entity. Requires `parameters.scope`.
+          #   transaction for the entity, rounded to the nearest whole day. Requires
+          #   `parameters.scope`. Use an integer value.
           # - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
-          #   the entity's transaction history. Requires `parameters.scope`.
+          #   the entity's transaction history. Requires `parameters.scope`. Use an integer
+          #   value.
           # - `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.
+          #   Use a decimal value.
+          # - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
+          #   between the postal code centers of the last card-present transaction and the
+          #   current transaction, divided by the elapsed time. Null if there is no prior
+          #   card-present transaction, if either postal code cannot be geocoded, or if
+          #   elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
+          #   decimal value.
+          # - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
+          #   code centers of the last card-present transaction and the current transaction.
+          #   Null if there is no prior card-present transaction or if either postal code
+          #   cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
+          #   Use a decimal value.
           #
           # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition#attribute
           module Attribute
@@ -323,6 +360,8 @@ module Lithic
             DISTINCT_COUNTRY_COUNT = :DISTINCT_COUNTRY_COUNT
             IS_NEW_MERCHANT = :IS_NEW_MERCHANT
             THREE_DS_SUCCESS_RATE = :THREE_DS_SUCCESS_RATE
+            TRAVEL_SPEED = :TRAVEL_SPEED
+            DISTANCE_FROM_LAST_TRANSACTION = :DISTANCE_FROM_LAST_TRANSACTION
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -346,20 +385,36 @@ module Lithic
             optional :scope,
                      enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope }
 
-            # @!method initialize(interval: nil, scope: nil)
+            # @!attribute unit
+            #   The unit for impossible travel attributes. Required when `attribute` is
+            #   `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
+            #
+            #   For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
+            #
+            #   For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
+            #
+            #   @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit, nil]
+            optional :unit,
+                     enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit }
+
+            # @!method initialize(interval: nil, scope: nil, unit: nil)
             #   Some parameter documentations has been truncated, see
             #   {Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters}
             #   for more details.
             #
-            #   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.
+            #   Additional parameters for certain 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` (require `scope`); or
+            #   `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
+            #   for other attributes.
             #
             #   @param interval [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval] The time window for statistical attributes (`AMOUNT_Z_SCORE`, `AVG_TRANSACTION_A
             #
             #   @param scope [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope] The entity scope to evaluate the attribute against.
+            #
+            #   @param unit [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit] The unit for impossible travel attributes. Required when `attribute` is
+            #   `TRAVEL\_
 
             # The time window for statistical attributes (`AMOUNT_Z_SCORE`,
             # `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
@@ -391,6 +446,26 @@ module Lithic
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # The unit for impossible travel attributes. Required when `attribute` is
+            # `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
+            #
+            # For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
+            #
+            # For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
+            #
+            # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters#unit
+            module Unit
+              extend Lithic::Internal::Type::Enum
+
+              MPH = :MPH
+              KPH = :KPH
+              MILES = :MILES
+              KILOMETERS = :KILOMETERS
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
           end
         end
       end