lithic 0.20.0 → 0.22.0

data/lib/lithic/models/payment_create_stablecoin_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Payments#create_stablecoin
+    class PaymentCreateStablecoinParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   Payout amount in cents
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute blockchain_recipient_token
+      #   Token of the blockchain recipient to send the payout to. The recipient must be
+      #   in the `ENABLED` verification state
+      #
+      #   @return [String]
+      required :blockchain_recipient_token, String
+
+      # @!attribute financial_account_token
+      #   Token of the financial account the payout is funded from
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute type
+      #   Direction of the payment. Stablecoin supports payouts only
+      #
+      #   @return [Symbol, Lithic::Models::PaymentCreateStablecoinParams::Type]
+      required :type, enum: -> { Lithic::PaymentCreateStablecoinParams::Type }
+
+      # @!attribute token
+      #   Customer-provided token that will serve as an idempotency token. This token will
+      #   become the transaction token
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!attribute hold
+      #   Optional hold to settle when this payout is initiated
+      #
+      #   @return [Lithic::Models::PaymentCreateStablecoinParams::Hold, nil]
+      optional :hold, -> { Lithic::PaymentCreateStablecoinParams::Hold }
+
+      # @!attribute memo
+      #   Memo recorded on the payout. Defaults to `Stablecoin payout on <chain>` when
+      #   omitted
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!method initialize(amount:, blockchain_recipient_token:, financial_account_token:, type:, token: nil, hold: nil, memo: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::PaymentCreateStablecoinParams} for more details.
+      #
+      #   @param amount [Integer] Payout amount in cents
+      #
+      #   @param blockchain_recipient_token [String] Token of the blockchain recipient to send the payout to. The recipient must be i
+      #
+      #   @param financial_account_token [String] Token of the financial account the payout is funded from
+      #
+      #   @param type [Symbol, Lithic::Models::PaymentCreateStablecoinParams::Type] Direction of the payment. Stablecoin supports payouts only
+      #
+      #   @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      #
+      #   @param hold [Lithic::Models::PaymentCreateStablecoinParams::Hold] Optional hold to settle when this payout is initiated
+      #
+      #   @param memo [String] Memo recorded on the payout. Defaults to `Stablecoin payout on <chain>` when omi
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+      # Direction of the payment. Stablecoin supports payouts only
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        PAYMENT = :PAYMENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Hold < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Token of the hold to settle when this payout is initiated
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!method initialize(token:)
+        #   Optional hold to settle when this payout is initiated
+        #
+        #   @param token [String] Token of the hold to settle when this payout is initiated
+      end
+    end
+  end
+end

data/lib/lithic/models/payment_create_stablecoin_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Payments#create_stablecoin
+    class PaymentCreateStablecoinResponse < Lithic::Models::Payment
+      # @!attribute balance
+      #   Balance
+      #
+      #   @return [Lithic::Models::Balance, nil]
+      optional :balance, -> { Lithic::Balance }
+
+      # @!method initialize(balance: nil)
+      #   Payment transaction
+      #
+      #   @param balance [Lithic::Models::Balance] Balance
+    end
+  end
+end

data/lib/lithic/models/payment_list_params.rb

@@ -103,6 +103,7 @@ module Lithic
         extend Lithic::Internal::Type::Enum
 
         ACH = :ACH
+        STABLECOIN = :STABLECOIN
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/payment_retry_params.rb

@@ -12,9 +12,36 @@ module Lithic
       #   @return [String]
       required :payment_token, String
 
-      # @!method initialize(payment_token:, request_options: {})
+      # @!attribute method_
+      #   Settlement speed to retry the payment at. Defaults to the original payment's
+      #   method. An `ACH_SAME_DAY` retry is rejected if the payment is for $1,000,000.00
+      #   or more, or if it is submitted after the same day ACH cutoff
+      #
+      #   @return [Symbol, Lithic::Models::PaymentRetryParams::Method, nil]
+      optional :method_, enum: -> { Lithic::PaymentRetryParams::Method }, api_name: :method
+
+      # @!method initialize(payment_token:, method_: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::PaymentRetryParams} for more details.
+      #
       #   @param payment_token [String]
+      #
+      #   @param method_ [Symbol, Lithic::Models::PaymentRetryParams::Method] Settlement speed to retry the payment at. Defaults to the original payment's met
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+      # Settlement speed to retry the payment at. Defaults to the original payment's
+      # method. An `ACH_SAME_DAY` retry is rejected if the payment is for $1,000,000.00
+      # or more, or if it is submitted after the same day ACH cutoff
+      module Method
+        extend Lithic::Internal::Type::Enum
+
+        ACH_NEXT_DAY = :ACH_NEXT_DAY
+        ACH_SAME_DAY = :ACH_SAME_DAY
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/lithic/models/payment_simulate_action_params.rb

@@ -71,6 +71,7 @@ module Lithic
         ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
         ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
         ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
+        STABLECOIN_REVIEWED = :STABLECOIN_REVIEWED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/three_ds_authentication.rb

@@ -145,6 +145,14 @@ module Lithic
       #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::DecisionMadeBy, nil]
       optional :decision_made_by, enum: -> { Lithic::ThreeDSAuthentication::DecisionMadeBy }, nil?: true
 
+      # @!attribute psd2_context
+      #   PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+      #   transaction is in scope for PSD2 Strong Customer Authentication. Absent for
+      #   out-of-scope transactions.
+      #
+      #   @return [Lithic::Models::ThreeDSAuthentication::Psd2Context, nil]
+      optional :psd2_context, -> { Lithic::ThreeDSAuthentication::Psd2Context }, nil?: true
+
       # @!attribute three_ri_request_type
       #   Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       #   takes place at the initiation of the merchant rather than the cardholder. The
@@ -164,7 +172,7 @@ module Lithic
       #   @return [Lithic::Models::ThreeDSAuthentication::Transaction, nil]
       optional :transaction, -> { Lithic::ThreeDSAuthentication::Transaction }, nil?: true
 
-      # @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, three_ri_request_type: nil, transaction: nil)
+      # @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, psd2_context: nil, three_ri_request_type: nil, transaction: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::ThreeDSAuthentication} for more details.
       #
@@ -206,6 +214,8 @@ module Lithic
       #
       #   @param decision_made_by [Symbol, Lithic::Models::ThreeDSAuthentication::DecisionMadeBy, nil] Entity that made the authentication decision. This won't be set for authenticati
       #
+      #   @param psd2_context [Lithic::Models::ThreeDSAuthentication::Psd2Context, nil] PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+      #
       #   @param three_ri_request_type [Symbol, Lithic::Models::ThreeDSAuthentication::ThreeRiRequestType, nil] Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       #
       #   @param transaction [Lithic::Models::ThreeDSAuthentication::Transaction, nil] Object containing data about the e-commerce transaction for which the merchant i
@@ -1142,6 +1152,121 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
+      # @see Lithic::Models::ThreeDSAuthentication#psd2_context
+      class Psd2Context < Lithic::Internal::Type::BaseModel
+        # @!attribute acquirer_exemption
+        #   SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        #   - `NONE` - No exemption claimed
+        #   - `TRANSACTION_RISK_ANALYSIS` - Transaction Risk Analysis (TRA) exemption;
+        #     acquirer asserts low fraud risk
+        #   - `LOW_VALUE` - Low-value payment exemption; transaction is below the EUR 30
+        #     threshold
+        #   - `RECURRING_PAYMENT` - Recurring payment with a fixed amount to the same payee
+        #   - `MERCHANT_INITIATED_TRANSACTION` - Merchant-initiated transaction (MIT);
+        #     cardholder not present
+        #   - `TRUSTED_BENEFICIARY` - Trusted beneficiary; merchant is on cardholder's
+        #     whitelist
+        #   - `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION` - SCA already performed by a
+        #     delegated third-party authenticator
+        #   - `SECURE_CORPORATE_PAYMENT` - Secure corporate payment using a dedicated
+        #     corporate card or process
+        #   - `AUTHENTICATION_OUTAGE_EXCEPTION` - Authentication outage exception;
+        #     scheme-level fallback during ACS downtime
+        #   - `BUNDLED` - Mastercard only; bundled exemption code where the exact exemption
+        #     type cannot be distinguished
+        #
+        #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::AcquirerExemption, nil]
+        optional :acquirer_exemption, enum: -> { Lithic::ThreeDSAuthentication::Psd2Context::AcquirerExemption }
+
+        # @!attribute lithic_exemption_validation
+        #   Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+        #   exemption was declared.
+        #
+        #   - `ACCEPTED` - Lithic signals support the acquirer's claim
+        #   - `REJECTED` - Lithic signals contradict the claim, or a required signal is
+        #     missing
+        #   - `NOT_VALIDATED` - Exemption was declared but Lithic has no basis to evaluate
+        #     it; treated as `REJECTED` for challenge purposes
+        #
+        #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation, nil]
+        optional :lithic_exemption_validation,
+                 enum: -> { Lithic::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation }
+
+        # @!method initialize(acquirer_exemption: nil, lithic_exemption_validation: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::ThreeDSAuthentication::Psd2Context} for more details.
+        #
+        #   PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+        #   transaction is in scope for PSD2 Strong Customer Authentication. Absent for
+        #   out-of-scope transactions.
+        #
+        #   @param acquirer_exemption [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::AcquirerExemption] SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        #   @param lithic_exemption_validation [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation] Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+
+        # SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        # - `NONE` - No exemption claimed
+        # - `TRANSACTION_RISK_ANALYSIS` - Transaction Risk Analysis (TRA) exemption;
+        #   acquirer asserts low fraud risk
+        # - `LOW_VALUE` - Low-value payment exemption; transaction is below the EUR 30
+        #   threshold
+        # - `RECURRING_PAYMENT` - Recurring payment with a fixed amount to the same payee
+        # - `MERCHANT_INITIATED_TRANSACTION` - Merchant-initiated transaction (MIT);
+        #   cardholder not present
+        # - `TRUSTED_BENEFICIARY` - Trusted beneficiary; merchant is on cardholder's
+        #   whitelist
+        # - `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION` - SCA already performed by a
+        #   delegated third-party authenticator
+        # - `SECURE_CORPORATE_PAYMENT` - Secure corporate payment using a dedicated
+        #   corporate card or process
+        # - `AUTHENTICATION_OUTAGE_EXCEPTION` - Authentication outage exception;
+        #   scheme-level fallback during ACS downtime
+        # - `BUNDLED` - Mastercard only; bundled exemption code where the exact exemption
+        #   type cannot be distinguished
+        #
+        # @see Lithic::Models::ThreeDSAuthentication::Psd2Context#acquirer_exemption
+        module AcquirerExemption
+          extend Lithic::Internal::Type::Enum
+
+          NONE = :NONE
+          TRANSACTION_RISK_ANALYSIS = :TRANSACTION_RISK_ANALYSIS
+          LOW_VALUE = :LOW_VALUE
+          RECURRING_PAYMENT = :RECURRING_PAYMENT
+          MERCHANT_INITIATED_TRANSACTION = :MERCHANT_INITIATED_TRANSACTION
+          TRUSTED_BENEFICIARY = :TRUSTED_BENEFICIARY
+          STRONG_CUSTOMER_AUTHENTICATION_DELEGATION = :STRONG_CUSTOMER_AUTHENTICATION_DELEGATION
+          SECURE_CORPORATE_PAYMENT = :SECURE_CORPORATE_PAYMENT
+          AUTHENTICATION_OUTAGE_EXCEPTION = :AUTHENTICATION_OUTAGE_EXCEPTION
+          BUNDLED = :BUNDLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+        # exemption was declared.
+        #
+        # - `ACCEPTED` - Lithic signals support the acquirer's claim
+        # - `REJECTED` - Lithic signals contradict the claim, or a required signal is
+        #   missing
+        # - `NOT_VALIDATED` - Exemption was declared but Lithic has no basis to evaluate
+        #   it; treated as `REJECTED` for challenge purposes
+        #
+        # @see Lithic::Models::ThreeDSAuthentication::Psd2Context#lithic_exemption_validation
+        module LithicExemptionValidation
+          extend Lithic::Internal::Type::Enum
+
+          ACCEPTED = :ACCEPTED
+          REJECTED = :REJECTED
+          NOT_VALIDATED = :NOT_VALIDATED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       # takes place at the initiation of the merchant rather than the cardholder. The
       # most common example of this is where a merchant is authenticating before billing

data/lib/lithic/models/transaction.rb

@@ -173,7 +173,8 @@ module Lithic
 
       # @!attribute tags
       #   Key-value pairs for tagging resources. Tags allow you to associate arbitrary
-      #   metadata with a resource for your own purposes.
+      #   metadata with a resource for your own purposes. A resource can have at most 50
+      #   tags, with keys up to 40 characters and values up to 500 characters
       #
       #   @return [Hash{Symbol=>String}]
       required :tags, Lithic::Internal::Type::HashOf[String]
@@ -1060,6 +1061,7 @@ module Lithic
           PROGRAM_SUSPENDED = :PROGRAM_SUSPENDED
           PROGRAM_USAGE_RESTRICTION = :PROGRAM_USAGE_RESTRICTION
           REVERSAL_UNMATCHED = :REVERSAL_UNMATCHED
+          SCA_REQUIRED = :SCA_REQUIRED
           SECURITY_VIOLATION = :SECURITY_VIOLATION
           SINGLE_USE_CARD_REATTEMPTED = :SINGLE_USE_CARD_REATTEMPTED
           SUSPECTED_FRAUD = :SUSPECTED_FRAUD
@@ -1390,6 +1392,7 @@ module Lithic
             PROGRAM_SUSPENDED = :PROGRAM_SUSPENDED
             PROGRAM_USAGE_RESTRICTION = :PROGRAM_USAGE_RESTRICTION
             REVERSAL_UNMATCHED = :REVERSAL_UNMATCHED
+            SCA_REQUIRED = :SCA_REQUIRED
             SECURITY_VIOLATION = :SECURITY_VIOLATION
             SINGLE_USE_CARD_REATTEMPTED = :SINGLE_USE_CARD_REATTEMPTED
             SUSPECTED_FRAUD = :SUSPECTED_FRAUD

data/lib/lithic/models/transaction_simulate_authorization_params.rb

@@ -29,6 +29,14 @@ module Lithic
       #   @return [String]
       required :pan, String
 
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
       # @!attribute mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
       #   listed in ISO 18245. Supported merchant category codes can be found
@@ -69,8 +77,10 @@ module Lithic
       optional :merchant_amount, Integer
 
       # @!attribute merchant_currency
-      #   3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
-      #   GBP, EUR and defaults to GBP if another ISO 4217 code is provided
+      #   3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
+      #   when merchant_amount is set, and defaults to GBP in that case. Without
+      #   merchant_amount, the merchant amount uses the billing currency. Permitted values
+      #   are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422
       #
       #   @return [String, nil]
       optional :merchant_currency, String
@@ -89,6 +99,16 @@ module Lithic
       #   @return [String, nil]
       optional :pin, String
 
+      # @!attribute settlement_currency
+      #   3-character alphabetic ISO 4217 currency code for the settlement amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to the value of billing_currency. Only single message
+      #   (financial) authorizations carry a settlement amount, and the value is ignored
+      #   for dual message authorizations
+      #
+      #   @return [String, nil]
+      optional :settlement_currency, String
+
       # @!attribute status
       #   Type of event to simulate.
       #
@@ -110,7 +130,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
       optional :status, enum: -> { Lithic::TransactionSimulateAuthorizationParams::Status }
 
-      # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, settlement_currency: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
       #
@@ -120,6 +140,8 @@ module Lithic
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       #   @param merchant_acceptor_city [String] Merchant acceptor city
@@ -132,12 +154,14 @@ module Lithic
       #
       #   @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
       #
-      #   @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+      #   @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
       #
       #   @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false.
       #
       #   @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
       #
+      #   @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       #   @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate.
       #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]

data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb

@@ -27,6 +27,14 @@ module Lithic
       #   @return [String]
       required :pan, String
 
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
       # @!attribute mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
       #   listed in ISO 18245. Supported merchant category codes can be found
@@ -59,7 +67,7 @@ module Lithic
       #   @return [String, nil]
       optional :merchant_acceptor_state, String
 
-      # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::TransactionSimulateCreditAuthorizationAdviceParams} for more
       #   details.
@@ -70,6 +78,8 @@ module Lithic
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       #   @param merchant_acceptor_city [String] Merchant acceptor city

data/lib/lithic/models/transaction_simulate_return_params.rb

@@ -25,13 +25,36 @@ module Lithic
       #   @return [String]
       required :pan, String
 
-      # @!method initialize(amount:, descriptor:, pan:, request_options: {})
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
+      # @!attribute settlement_currency
+      #   3-character alphabetic ISO 4217 currency code for the settlement amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to the value of billing_currency
+      #
+      #   @return [String, nil]
+      optional :settlement_currency, String
+
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, settlement_currency: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateReturnParams} for more details.
+      #
       #   @param amount [Integer] Amount (in cents) to authorize.
       #
       #   @param descriptor [String] Merchant descriptor.
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
+      #   @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models.rb

@@ -116,6 +116,8 @@ module Lithic
 
   BlockchainRecipientCreateParams = Lithic::Models::BlockchainRecipientCreateParams
 
+  BlockchainRecipientRetrieveParams = Lithic::Models::BlockchainRecipientRetrieveParams
+
   BookTransferCreateParams = Lithic::Models::BookTransferCreateParams
 
   BookTransferListParams = Lithic::Models::BookTransferListParams
@@ -170,6 +172,8 @@ module Lithic
 
   CardListParams = Lithic::Models::CardListParams
 
+  CardPinUpdatedWebhookEvent = Lithic::Models::CardPinUpdatedWebhookEvent
+
   CardProgram = Lithic::Models::CardProgram
 
   CardProgramListParams = Lithic::Models::CardProgramListParams
@@ -475,6 +479,8 @@ module Lithic
 
   PaymentCreateParams = Lithic::Models::PaymentCreateParams
 
+  PaymentCreateStablecoinParams = Lithic::Models::PaymentCreateStablecoinParams
+
   PaymentListParams = Lithic::Models::PaymentListParams
 
   PaymentRetrieveParams = Lithic::Models::PaymentRetrieveParams

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

@@ -22,14 +22,14 @@ module Lithic
           # `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
           # endpoint.
           #
-          # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` /
-          # `CONDITIONAL_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is generally
-          # not supported. In specific cases (i.e. where Lithic has pre-calculated the
-          # requested velocity metrics for historical transactions), a backtest may be
-          # feasible. However, such cases are uncommon and customers should not anticipate
-          # support for velocity backtests under most configurations. If a historical
-          # transaction does not feature the required inputs to evaluate the rule, then it
-          # will not be included in the final backtest report.
+          # Lithic currently supports backtesting for `CONDITIONAL_ACTION` rules.
+          # Backtesting for `VELOCITY_LIMIT` rules is generally not supported. In specific
+          # cases (i.e. where Lithic has pre-calculated the requested velocity metrics for
+          # historical transactions), a backtest may be feasible. However, such cases are
+          # uncommon and customers should not anticipate support for velocity backtests
+          # under most configurations. If a historical transaction does not feature the
+          # required inputs to evaluate the rule, then it will not be included in the final
+          # backtest report.
           #
           # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
           #

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

@@ -11,7 +11,8 @@ module Lithic
         #
         # @overload create(body:, request_options: {})
         #
-        # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
+        # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule] Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::AuthRule]
@@ -47,16 +48,21 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AuthRules::V2UpdateParams} for more details.
+        #
         # Updates a V2 Auth rule's properties
         #
-        # If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`,
-        # `excluded_account_tokens`, or `excluded_business_account_tokens` is provided,
-        # this will replace existing associations with the provided list of entities.
+        # If `entities` is provided, this will replace the rule's existing entities with
+        # the provided `include` and `exclude` lists. To change entities incrementally,
+        # use `PATCH /v2/auth_rules/{auth_rule_token}/entities` instead.
         #
         # @overload update(auth_rule_token, body:, request_options: {})
         #
         # @param auth_rule_token [String]
-        # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
+        #
+        # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule] Replaces the rule's existing entities with the provided `include` and `exclude`
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::AuthRule]
@@ -94,7 +100,7 @@ module Lithic
         #
         # @param page_size [Integer] Page size (for pagination).
         #
-        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
+        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope. When no token is pr
         #
         # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
         #
@@ -144,7 +150,7 @@ module Lithic
         #
         # @param auth_rule_token [String]
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -256,7 +262,7 @@ module Lithic
         # - VelocityLimit Rules calculates the current Velocity Feature data. This
         #   requires a `card_token` or `account_token` matching what the rule is Scoped
         #   to.
-        # - ConditionalBlock Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
+        # - ConditionalAction Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
         #   the rule. This requires a `card_token`
         #
         # @overload retrieve_features(auth_rule_token, account_token: nil, card_token: nil, request_options: {})
@@ -320,6 +326,36 @@ module Lithic
           )
         end
 
+        # Adds entities to and removes entities from a V2 Auth rule's `include` and
+        # `exclude` lists
+        #
+        # To replace all of the rule's entities at once, provide `entities` to
+        # `PATCH /v2/auth_rules/{auth_rule_token}` instead.
+        #
+        # @overload update_entities(auth_rule_token, add: nil, remove: nil, request_options: {})
+        #
+        # @param auth_rule_token [String]
+        #
+        # @param add [Lithic::Models::AuthRules::AuthRuleEntities] Entities to add to the rule's `include` and `exclude` lists
+        #
+        # @param remove [Lithic::Models::AuthRules::AuthRuleEntities] Entities to remove from the rule's `include` and `exclude` lists
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AuthRules::AuthRule]
+        #
+        # @see Lithic::Models::AuthRules::V2UpdateEntitiesParams
+        def update_entities(auth_rule_token, params = {})
+          parsed, options = Lithic::AuthRules::V2UpdateEntitiesParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v2/auth_rules/%1$s/entities", auth_rule_token],
+            body: parsed,
+            model: Lithic::AuthRules::AuthRule,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Lithic::Client]