lithic 0.21.0 → 0.22.0

data/rbi/lithic/models/auth_rules/auth_rule_entities.rbi

@@ -0,0 +1,163 @@
+# typed: strong
+
+module Lithic
+  module Models
+    AuthRuleEntities = AuthRules::AuthRuleEntities
+
+    module AuthRules
+      class AuthRuleEntities < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::AuthRuleEntities,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Entities the Auth Rule does not apply to. Defaults to an empty list in requests.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program,
+                  Lithic::AuthRules::AuthRuleEntity::Card,
+                  Lithic::AuthRules::AuthRuleEntity::Account,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag
+                )
+              ]
+            )
+          )
+        end
+        attr_reader :exclude
+
+        sig do
+          params(
+            exclude:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :exclude
+
+        # Entities the Auth Rule applies to. Defaults to an empty list in requests.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program,
+                  Lithic::AuthRules::AuthRuleEntity::Card,
+                  Lithic::AuthRules::AuthRuleEntity::Account,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag
+                )
+              ]
+            )
+          )
+        end
+        attr_reader :include
+
+        sig do
+          params(
+            include:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :include
+
+        # The entities an Auth Rule applies to (`include`) and does not apply to
+        # (`exclude`). An exclusion overrides an inclusion, so a card excluded here is
+        # skipped even when the program, its account or one of its tags is included.
+        #
+        # The rule's resulting entities must satisfy these constraints after any write:
+        #
+        # - `include` must contain at least one entity.
+        # - If `PROGRAM` is included, it must be the only included entity.
+        # - `PROGRAM` cannot be excluded.
+        # - An entity cannot appear in both `include` and `exclude`, or twice in the same
+        #   list.
+        # - A rule can have at most 1,000 entities across `include` and `exclude`, not
+        #   counting `PROGRAM`.
+        # - Entity types must be valid for the rule's event stream.
+        # - `CARD`, `ACCOUNT` and `BUSINESS_ACCOUNT` tokens must belong to your program.
+        sig do
+          params(
+            exclude:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ],
+            include:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Entities the Auth Rule does not apply to. Defaults to an empty list in requests.
+          exclude: nil,
+          # Entities the Auth Rule applies to. Defaults to an empty list in requests.
+          include: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              exclude:
+                T::Array[
+                  T.any(
+                    Lithic::AuthRules::AuthRuleEntity::Program,
+                    Lithic::AuthRules::AuthRuleEntity::Card,
+                    Lithic::AuthRules::AuthRuleEntity::Account,
+                    Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+                    Lithic::AuthRules::AuthRuleEntity::CardTag
+                  )
+                ],
+              include:
+                T::Array[
+                  T.any(
+                    Lithic::AuthRules::AuthRuleEntity::Program,
+                    Lithic::AuthRules::AuthRuleEntity::Card,
+                    Lithic::AuthRules::AuthRuleEntity::Account,
+                    Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+                    Lithic::AuthRules::AuthRuleEntity::CardTag
+                  )
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/auth_rules/auth_rule_entities_response.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Lithic
+  module Models
+    AuthRuleEntitiesResponse = AuthRules::AuthRuleEntitiesResponse
+
+    module AuthRules
+      class AuthRuleEntitiesResponse < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::AuthRuleEntitiesResponse,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Entities the Auth Rule does not apply to
+        sig { returns(T::Array[Lithic::AuthRules::AuthRuleEntity::Variants]) }
+        attr_accessor :exclude
+
+        # Entities the Auth Rule applies to
+        sig { returns(T::Array[Lithic::AuthRules::AuthRuleEntity::Variants]) }
+        attr_accessor :include
+
+        # The entities the Auth Rule applies to (`include`) and does not apply to
+        # (`exclude`). An exclusion overrides an inclusion.
+        sig do
+          params(
+            exclude:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ],
+            include:
+              T::Array[
+                T.any(
+                  Lithic::AuthRules::AuthRuleEntity::Program::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Card::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::Account::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::BusinessAccount::OrHash,
+                  Lithic::AuthRules::AuthRuleEntity::CardTag::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Entities the Auth Rule does not apply to
+          exclude:,
+          # Entities the Auth Rule applies to
+          include:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              exclude: T::Array[Lithic::AuthRules::AuthRuleEntity::Variants],
+              include: T::Array[Lithic::AuthRules::AuthRuleEntity::Variants]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/auth_rules/auth_rule_entity.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module Lithic
+  module Models
+    AuthRuleEntity = AuthRules::AuthRuleEntity
+
+    module AuthRules
+      # An entity that an Auth Rule can apply to. The `type` field determines which
+      # other fields are present.
+      #
+      # - `PROGRAM`: the entire card program.
+      # - `CARD`: a single card.
+      # - `ACCOUNT`: a single account.
+      # - `BUSINESS_ACCOUNT`: a single business account.
+      # - `CARD_TAG`: every card that carries the given tag (`key` and `value`).
+      #
+      # `CARD` and `CARD_TAG` entities can only be used with rules on the
+      # `AUTHORIZATION`, `THREE_DS_AUTHENTICATION`, `TOKENIZATION` and
+      # `CARD_TRANSACTION_UPDATE` event streams. Rules on the other event streams accept
+      # `PROGRAM`, `ACCOUNT` and `BUSINESS_ACCOUNT` only.
+      module AuthRuleEntity
+        extend Lithic::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::AuthRuleEntity::Program,
+              Lithic::AuthRules::AuthRuleEntity::Card,
+              Lithic::AuthRules::AuthRuleEntity::Account,
+              Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+              Lithic::AuthRules::AuthRuleEntity::CardTag
+            )
+          end
+
+        class Program < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::AuthRuleEntity::Program,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The entire card program. Takes no other fields.
+          sig { params(type: Symbol).returns(T.attached_class) }
+          def self.new(type: :PROGRAM)
+          end
+
+          sig { override.returns({ type: Symbol }) }
+          def to_hash
+          end
+        end
+
+        class Card < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::AuthRuleEntity::Card,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Token of the card
+          sig { returns(String) }
+          attr_accessor :token
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A single card.
+          sig { params(token: String, type: Symbol).returns(T.attached_class) }
+          def self.new(
+            # Token of the card
+            token:,
+            type: :CARD
+          )
+          end
+
+          sig { override.returns({ token: String, type: Symbol }) }
+          def to_hash
+          end
+        end
+
+        class Account < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::AuthRuleEntity::Account,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Token of the account
+          sig { returns(String) }
+          attr_accessor :token
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A single account.
+          sig { params(token: String, type: Symbol).returns(T.attached_class) }
+          def self.new(
+            # Token of the account
+            token:,
+            type: :ACCOUNT
+          )
+          end
+
+          sig { override.returns({ token: String, type: Symbol }) }
+          def to_hash
+          end
+        end
+
+        class BusinessAccount < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::AuthRuleEntity::BusinessAccount,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Token of the business account
+          sig { returns(String) }
+          attr_accessor :token
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A single business account.
+          sig { params(token: String, type: Symbol).returns(T.attached_class) }
+          def self.new(
+            # Token of the business account
+            token:,
+            type: :BUSINESS_ACCOUNT
+          )
+          end
+
+          sig { override.returns({ token: String, type: Symbol }) }
+          def to_hash
+          end
+        end
+
+        class CardTag < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::AuthRuleEntity::CardTag,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Tag key. Keys starting with `lithic.` (case-insensitive) are reserved and
+          # rejected.
+          sig { returns(String) }
+          attr_accessor :key
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Tag value
+          sig { returns(String) }
+          attr_accessor :value
+
+          # Every card whose `tags` contain `key` set to `value`.
+          sig do
+            params(key: String, value: String, type: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Tag key. Keys starting with `lithic.` (case-insensitive) are reserved and
+            # rejected.
+            key:,
+            # Tag value
+            value:,
+            type: :CARD_TAG
+          )
+          end
+
+          sig { override.returns({ key: String, type: Symbol, value: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[Lithic::AuthRules::AuthRuleEntity::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/auth_rules/auth_rule_version.rbi

@@ -35,7 +35,6 @@ module Lithic
             created: Time,
             parameters:
               T.any(
-                Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                 Lithic::AuthRules::VelocityLimitParams::OrHash,
                 Lithic::AuthRules::MerchantLockParameters::OrHash,
                 Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
@@ -85,7 +84,6 @@ module Lithic
           Variants =
             T.type_alias do
               T.any(
-                Lithic::AuthRules::ConditionalBlockParameters,
                 Lithic::AuthRules::VelocityLimitParams,
                 Lithic::AuthRules::MerchantLockParameters,
                 Lithic::AuthRules::Conditional3DSActionParameters,

data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi

@@ -123,13 +123,24 @@ module Lithic
           #   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. Use an integer value.
-          # - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
-          #   risk level, with a higher value indicating a higher amount of risk. Use an
-          #   integer value.
+          # - `RISK_SCORE`: Mastercard, and Visa in some markets: Assessment by the network
+          #   of the authentication risk level, with a higher value indicating a higher
+          #   amount of risk. Use an integer value.
           # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
           # - `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`.
+          # - `CARD_STATE`: The current state of the card associated with the
+          #   authentication. Valid values are `CLOSED`, `OPEN`, `PAUSED`,
+          #   `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
+          # - `CARD_TYPE`: The type of the card associated with the authentication. Valid
+          #   values are `MERCHANT_LOCKED`, `PHYSICAL`, `SINGLE_USE`, `VIRTUAL`.
+          # - `CARD_PROGRAM_FAMILY`: The program family of the card associated with the
+          #   authentication. Valid values are `CONSUMER`, `COMMERCIAL`.
+          # - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
+          #   `OK`, `BLOCKED`.
+          # - `CARD_AGE`: The age of the card in seconds at the time of the authentication.
+          #   Use an integer value.
           sig do
             returns(
               Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol
@@ -172,13 +183,24 @@ module Lithic
             #   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. Use an integer value.
-            # - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
-            #   risk level, with a higher value indicating a higher amount of risk. Use an
-            #   integer value.
+            # - `RISK_SCORE`: Mastercard, and Visa in some markets: Assessment by the network
+            #   of the authentication risk level, with a higher value indicating a higher
+            #   amount of risk. Use an integer value.
             # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
             # - `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`.
+            # - `CARD_STATE`: The current state of the card associated with the
+            #   authentication. Valid values are `CLOSED`, `OPEN`, `PAUSED`,
+            #   `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
+            # - `CARD_TYPE`: The type of the card associated with the authentication. Valid
+            #   values are `MERCHANT_LOCKED`, `PHYSICAL`, `SINGLE_USE`, `VIRTUAL`.
+            # - `CARD_PROGRAM_FAMILY`: The program family of the card associated with the
+            #   authentication. Valid values are `CONSUMER`, `COMMERCIAL`.
+            # - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
+            #   `OK`, `BLOCKED`.
+            # - `CARD_AGE`: The age of the card in seconds at the time of the authentication.
+            #   Use an integer value.
             attribute:,
             # The operation to apply to the attribute
             operation:,
@@ -218,13 +240,24 @@ module Lithic
           #   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. Use an integer value.
-          # - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
-          #   risk level, with a higher value indicating a higher amount of risk. Use an
-          #   integer value.
+          # - `RISK_SCORE`: Mastercard, and Visa in some markets: Assessment by the network
+          #   of the authentication risk level, with a higher value indicating a higher
+          #   amount of risk. Use an integer value.
           # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
           # - `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`.
+          # - `CARD_STATE`: The current state of the card associated with the
+          #   authentication. Valid values are `CLOSED`, `OPEN`, `PAUSED`,
+          #   `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
+          # - `CARD_TYPE`: The type of the card associated with the authentication. Valid
+          #   values are `MERCHANT_LOCKED`, `PHYSICAL`, `SINGLE_USE`, `VIRTUAL`.
+          # - `CARD_PROGRAM_FAMILY`: The program family of the card associated with the
+          #   authentication. Valid values are `CONSUMER`, `COMMERCIAL`.
+          # - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
+          #   `OK`, `BLOCKED`.
+          # - `CARD_AGE`: The age of the card in seconds at the time of the authentication.
+          #   Use an integer value.
           module Attribute
             extend Lithic::Internal::Type::Enum
 
@@ -282,6 +315,31 @@ module Lithic
                 :ADDRESS_MATCH,
                 Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
               )
+            CARD_STATE =
+              T.let(
+                :CARD_STATE,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_TYPE =
+              T.let(
+                :CARD_TYPE,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_PROGRAM_FAMILY =
+              T.let(
+                :CARD_PROGRAM_FAMILY,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            PIN_STATUS =
+              T.let(
+                :PIN_STATUS,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_AGE =
+              T.let(
+                :CARD_AGE,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
 
             sig do
               override.returns(