lithic 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.39

data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb

@@ -37,9 +37,16 @@ module Lithic
           #   @return [String]
           required :institution_id, String
 
+          # @!attribute is_complete
+          #   Indicates that all settlement records related to this Network Total are
+          #   available in the details endpoint.
+          #
+          #   @return [Boolean]
+          required :is_complete, Lithic::Internal::Type::Boolean
+
           # @!attribute network
-          #   Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
-          #   INTERLINK.
+          #   Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          #   or INTERLINK.
           #
           #   @return [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network]
           required :network, enum: -> { Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network }
@@ -76,7 +83,7 @@ module Lithic
           #   @return [Integer, nil]
           optional :cycle, Integer
 
-          # @!method initialize(token:, amounts:, created:, currency:, institution_id:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
+          # @!method initialize(token:, amounts:, created:, currency:, institution_id:, is_complete:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse} for more
           #   details.
@@ -91,7 +98,9 @@ module Lithic
           #
           #   @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
           #
-          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network] Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INT
+          #   @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
+          #
+          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network] Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
           #
           #   @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
           #
@@ -144,13 +153,14 @@ module Lithic
             #   @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
           end
 
-          # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
-          # INTERLINK.
+          # Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          # or INTERLINK.
           #
           # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse#network
           module Network
             extend Lithic::Internal::Type::Enum
 
+            AMEX = :AMEX
             VISA = :VISA
             MASTERCARD = :MASTERCARD
             MAESTRO = :MAESTRO

data/lib/lithic/resources/auth_rules/v2.rb

@@ -22,7 +22,7 @@ module Lithic
         #
         # @param name [String, nil] Auth Rule Name
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters] Parameters for the Auth Rule
         #
         # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. Effectively determines the event stream during which it w
         #
@@ -207,7 +207,7 @@ module Lithic
         #
         # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2DraftParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2DraftParams::Parameters::Conditional3DSActionParameters, nil] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, nil] Parameters for the Auth Rule
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.37"
+  VERSION = "0.1.0.pre.alpha.39"
 end

data/lib/lithic.rb

@@ -83,8 +83,10 @@ require_relative "lithic/models/aggregate_balance_list_params"
 require_relative "lithic/models/api_status"
 require_relative "lithic/models/auth_rules/auth_rule"
 require_relative "lithic/models/auth_rules/auth_rule_condition"
+require_relative "lithic/models/auth_rules/conditional_3ds_action_parameters"
 require_relative "lithic/models/auth_rules/conditional_attribute"
 require_relative "lithic/models/auth_rules/conditional_block_parameters"
+require_relative "lithic/models/auth_rules/merchant_lock_parameters"
 require_relative "lithic/models/auth_rules/rule_stats"
 require_relative "lithic/models/auth_rules/v2/backtest_create_params"
 require_relative "lithic/models/auth_rules/v2/backtest_create_response"

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

@@ -0,0 +1,412 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AuthRules
+      class Conditional3DSActionParameters < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::Conditional3DSActionParameters,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # The action to take if the conditions are met.
+        sig do
+          returns(
+            Lithic::AuthRules::Conditional3DSActionParameters::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
+        sig do
+          returns(
+            T::Array[
+              Lithic::AuthRules::Conditional3DSActionParameters::Condition
+            ]
+          )
+        end
+        attr_accessor :conditions
+
+        sig do
+          params(
+            action:
+              Lithic::AuthRules::Conditional3DSActionParameters::Action::OrSymbol,
+            conditions:
+              T::Array[
+                Lithic::AuthRules::Conditional3DSActionParameters::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::Conditional3DSActionParameters::Action::OrSymbol,
+              conditions:
+                T::Array[
+                  Lithic::AuthRules::Conditional3DSActionParameters::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::Conditional3DSActionParameters::Action
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DECLINE =
+            T.let(
+              :DECLINE,
+              Lithic::AuthRules::Conditional3DSActionParameters::Action::TaggedSymbol
+            )
+          CHALLENGE =
+            T.let(
+              :CHALLENGE,
+              Lithic::AuthRules::Conditional3DSActionParameters::Action::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Lithic::AuthRules::Conditional3DSActionParameters::Action::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Condition < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::Conditional3DSActionParameters::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.
+          # - `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.
+          # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+          #   given authentication. 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.
+          # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
+          sig do
+            returns(
+              T.nilable(
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol
+              )
+            )
+          end
+          attr_reader :attribute
+
+          sig do
+            params(
+              attribute:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol
+            ).void
+          end
+          attr_writer :attribute
+
+          # The operation to apply to the attribute
+          sig do
+            returns(
+              T.nilable(
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol
+              )
+            )
+          end
+          attr_reader :operation
+
+          sig do
+            params(
+              operation:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol
+            ).void
+          end
+          attr_writer :operation
+
+          # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+          sig do
+            returns(
+              T.nilable(
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants
+              )
+            )
+          end
+          attr_reader :value
+
+          sig do
+            params(
+              value:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants
+            ).void
+          end
+          attr_writer :value
+
+          sig do
+            params(
+              attribute:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol,
+              operation:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol,
+              value:
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::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.
+            # - `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.
+            # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+            #   given authentication. 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.
+            # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
+            attribute: nil,
+            # The operation to apply to the attribute
+            operation: nil,
+            # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+            value: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                attribute:
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol,
+                operation:
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol,
+                value:
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::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.
+          # - `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.
+          # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+          #   given authentication. 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.
+          # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
+          module Attribute
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MCC =
+              T.let(
+                :MCC,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            COUNTRY =
+              T.let(
+                :COUNTRY,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CURRENCY =
+              T.let(
+                :CURRENCY,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            MERCHANT_ID =
+              T.let(
+                :MERCHANT_ID,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            DESCRIPTOR =
+              T.let(
+                :DESCRIPTOR,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            TRANSACTION_AMOUNT =
+              T.let(
+                :TRANSACTION_AMOUNT,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            RISK_SCORE =
+              T.let(
+                :RISK_SCORE,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            MESSAGE_CATEGORY =
+              T.let(
+                :MESSAGE_CATEGORY,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The operation to apply to the attribute
+          module Operation
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IS_ONE_OF =
+              T.let(
+                :IS_ONE_OF,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+            IS_NOT_ONE_OF =
+              T.let(
+                :IS_NOT_ONE_OF,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+            MATCHES =
+              T.let(
+                :MATCHES,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+            DOES_NOT_MATCH =
+              T.let(
+                :DOES_NOT_MATCH,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+            IS_GREATER_THAN =
+              T.let(
+                :IS_GREATER_THAN,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+            IS_LESS_THAN =
+              T.let(
+                :IS_LESS_THAN,
+                Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+          module Value
+            extend Lithic::Internal::Type::Union
+
+            Variants = T.type_alias { T.any(String, Integer, T::Array[String]) }
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            StringArray =
+              T.let(
+                Lithic::Internal::Type::ArrayOf[String],
+                Lithic::Internal::Type::Converter
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/auth_rules/merchant_lock_parameters.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AuthRules
+      class MerchantLockParameters < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AuthRules::MerchantLockParameters,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # A list of merchant locks defining specific merchants or groups of merchants
+        # (based on descriptors or IDs) that the lock applies to.
+        sig do
+          returns(T::Array[Lithic::AuthRules::MerchantLockParameters::Merchant])
+        end
+        attr_accessor :merchants
+
+        sig do
+          params(
+            merchants:
+              T::Array[
+                Lithic::AuthRules::MerchantLockParameters::Merchant::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A list of merchant locks defining specific merchants or groups of merchants
+          # (based on descriptors or IDs) that the lock applies to.
+          merchants:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              merchants:
+                T::Array[Lithic::AuthRules::MerchantLockParameters::Merchant]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Merchant < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::AuthRules::MerchantLockParameters::Merchant,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # A comment or explanation about the merchant, used internally for rule management
+          # purposes.
+          sig { returns(T.nilable(String)) }
+          attr_reader :comment
+
+          sig { params(comment: String).void }
+          attr_writer :comment
+
+          # Short description of the merchant, often used to provide more human-readable
+          # context about the transaction merchant. This is typically the name or label
+          # shown on transaction summaries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :descriptor
+
+          sig { params(descriptor: String).void }
+          attr_writer :descriptor
+
+          # Unique alphanumeric identifier for the payment card acceptor (merchant). This
+          # attribute specifies the merchant entity that will be locked or referenced for
+          # authorization rules.
+          sig { returns(T.nilable(String)) }
+          attr_reader :merchant_id
+
+          sig { params(merchant_id: String).void }
+          attr_writer :merchant_id
+
+          # Represents a specific merchant lock based on their ID or descriptor. Each
+          # merchant object allows transaction rules to work at a granular level and
+          # requires at least one of merchant_id or descriptor.
+          sig do
+            params(
+              comment: String,
+              descriptor: String,
+              merchant_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A comment or explanation about the merchant, used internally for rule management
+            # purposes.
+            comment: nil,
+            # Short description of the merchant, often used to provide more human-readable
+            # context about the transaction merchant. This is typically the name or label
+            # shown on transaction summaries.
+            descriptor: nil,
+            # Unique alphanumeric identifier for the payment card acceptor (merchant). This
+            # attribute specifies the merchant entity that will be locked or referenced for
+            # authorization rules.
+            merchant_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { comment: String, descriptor: String, merchant_id: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end