lithic 0.21.0 → 0.22.0

data/rbi/lithic/models/transaction_simulate_return_params.rbi

@@ -26,11 +26,31 @@ module Lithic
       sig { returns(String) }
       attr_accessor :pan
 
+      # 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
+      sig { returns(T.nilable(String)) }
+      attr_reader :billing_currency
+
+      sig { params(billing_currency: String).void }
+      attr_writer :billing_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
+      sig { returns(T.nilable(String)) }
+      attr_reader :settlement_currency
+
+      sig { params(settlement_currency: String).void }
+      attr_writer :settlement_currency
+
       sig do
         params(
           amount: Integer,
           descriptor: String,
           pan: String,
+          billing_currency: String,
+          settlement_currency: String,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -41,6 +61,14 @@ module Lithic
         descriptor:,
         # Sixteen digit card number.
         pan:,
+        # 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
+        billing_currency: nil,
+        # 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
+        settlement_currency: nil,
         request_options: {}
       )
       end
@@ -51,6 +79,8 @@ module Lithic
             amount: Integer,
             descriptor: String,
             pan: String,
+            billing_currency: String,
+            settlement_currency: String,
             request_options: Lithic::RequestOptions
           }
         )

data/rbi/lithic/resources/account_holders/entities.rbi

@@ -28,7 +28,8 @@ module Lithic
           # Globally unique identifier for the account holder.
           account_holder_token,
           # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          # and KYC workflows.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,

data/rbi/lithic/resources/auth_rules/v2/backtests.rbi

@@ -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.
           sig do
             params(
               auth_rule_token: String,

data/rbi/lithic/resources/auth_rules/v2.rbi

@@ -12,6 +12,7 @@ module Lithic
           params(
             body:
               T.any(
+                Lithic::AuthRules::V2CreateParams::Body::Rule::OrHash,
                 Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::OrHash,
                 Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::OrHash,
                 Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::OrHash
@@ -19,7 +20,11 @@ module Lithic
             request_options: Lithic::RequestOptions::OrHash
           ).returns(Lithic::AuthRules::AuthRule)
         end
-        def create(body:, request_options: {})
+        def create(
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+          body:,
+          request_options: {}
+        )
         end
 
         # Fetches a V2 Auth rule by its token
@@ -34,14 +39,15 @@ module Lithic
 
         # 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.
         sig do
           params(
             auth_rule_token: String,
             body:
               T.any(
+                Lithic::AuthRules::V2UpdateParams::Body::Rule::OrHash,
                 Lithic::AuthRules::V2UpdateParams::Body::AccountLevelRule::OrHash,
                 Lithic::AuthRules::V2UpdateParams::Body::CardLevelRule::OrHash,
                 Lithic::AuthRules::V2UpdateParams::Body::ProgramLevelRule::OrHash
@@ -49,7 +55,13 @@ module Lithic
             request_options: Lithic::RequestOptions::OrHash
           ).returns(Lithic::AuthRules::AuthRule)
         end
-        def update(auth_rule_token, body:, request_options: {})
+        def update(
+          auth_rule_token,
+          # Replaces the rule's existing entities with the provided `include` and `exclude`
+          # lists. A missing list is treated as empty, so `include` must always be provided.
+          body:,
+          request_options: {}
+        )
         end
 
         # Lists V2 Auth rules
@@ -86,7 +98,8 @@ module Lithic
           event_streams: nil,
           # Page size (for pagination).
           page_size: nil,
-          # Only return Auth Rules that are bound to the provided scope.
+          # Only return Auth Rules that are bound to the provided scope. When no token is
+          # provided, `CARD` also returns Auth Rules that include a `CARD_TAG` entity.
           scope: nil,
           # A cursor representing an item's token after which a page of results should
           # begin. Used to retrieve the next page of results after this item.
@@ -115,7 +128,6 @@ module Lithic
             parameters:
               T.nilable(
                 T.any(
-                  Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                   Lithic::AuthRules::VelocityLimitParams::OrHash,
                   Lithic::AuthRules::MerchantLockParameters::OrHash,
                   Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
@@ -218,7 +230,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`
         sig do
           params(
@@ -267,6 +279,29 @@ 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.
+        sig do
+          params(
+            auth_rule_token: String,
+            add: Lithic::AuthRules::AuthRuleEntities::OrHash,
+            remove: Lithic::AuthRules::AuthRuleEntities::OrHash,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::AuthRules::AuthRule)
+        end
+        def update_entities(
+          auth_rule_token,
+          # Entities to add to the rule's `include` and `exclude` lists
+          add: nil,
+          # Entities to remove from the rule's `include` and `exclude` lists
+          remove: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Lithic::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/lithic/resources/cards.rbi

@@ -34,6 +34,7 @@ module Lithic
           spend_limit: Integer,
           spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
           state: Lithic::CardCreateParams::State::OrSymbol,
+          tags: T::Hash[Symbol, String],
           idempotency_key: String,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(Lithic::Card)
@@ -184,6 +185,10 @@ module Lithic
         # - `PAUSED` - Card will decline authorizations, but can be resumed at a later
         #   time.
         state: nil,
+        # Body param: Key-value pairs to tag the card with. A replacement card does not
+        # inherit tags from the card it replaces. A card can have at most 50 tags, with
+        # keys up to 40 characters and values up to 500 characters
+        tags: nil,
         # Header param: Idempotency key for the request
         idempotency_key: nil,
         request_options: {}
@@ -218,6 +223,7 @@ module Lithic
           spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
           state: Lithic::CardUpdateParams::State::OrSymbol,
           substatus: Lithic::CardUpdateParams::Substatus::OrSymbol,
+          tags: T::Hash[Symbol, T.nilable(String)],
           request_options: Lithic::RequestOptions::OrHash
         ).returns(Lithic::Card)
       end
@@ -298,6 +304,11 @@ module Lithic
         # - `OTHER` - The reason for the status does not fall into any of the above
         #   categories. A comment should be provided to specify the reason.
         substatus: nil,
+        # Key-value pairs to merge into the card's tags. Supplied keys are added or
+        # overwritten, a key with a `null` value is removed, and omitted keys remain
+        # unchanged. A card can have at most 50 tags, with keys up to 40 characters and
+        # values up to 500 characters
+        tags: nil,
         request_options: {}
       )
       end

data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class InstallmentPlans
+        class Statements
+          # Get a specific statement snapshot for a given installment plan.
+          sig do
+            params(
+              statement_token: String,
+              financial_account_token: String,
+              installment_plan_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(
+              Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement
+            )
+          end
+          def retrieve(
+            # Globally unique identifier for statement.
+            statement_token,
+            # Globally unique identifier for financial account.
+            financial_account_token:,
+            # Globally unique identifier for installment plan.
+            installment_plan_token:,
+            request_options: {}
+          )
+          end
+
+          # List the statement snapshots for a given installment plan.
+          sig do
+            params(
+              installment_plan_token: String,
+              financial_account_token: String,
+              begin_: Date,
+              end_: Date,
+              ending_before: String,
+              page_size: Integer,
+              starting_after: String,
+              state:
+                T.nilable(
+                  Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State::OrSymbol
+                ),
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(
+              Lithic::Internal::CursorPage[
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement
+              ]
+            )
+          end
+          def list(
+            # Path param: Globally unique identifier for installment plan.
+            installment_plan_token,
+            # Path param: Globally unique identifier for financial account.
+            financial_account_token:,
+            # Query param: Date string in RFC 3339 format. Only entries created after the
+            # specified date will be included.
+            begin_: nil,
+            # Query param: Date string in RFC 3339 format. Only entries created before the
+            # specified date will be included.
+            end_: nil,
+            # Query param: A cursor representing an item's token before which a page of
+            # results should end. Used to retrieve the previous page of results before this
+            # item.
+            ending_before: nil,
+            # Query param: Page size (for pagination).
+            page_size: nil,
+            # Query param: A cursor representing an item's token after which a page of results
+            # should begin. Used to retrieve the next page of results after this item.
+            starting_after: nil,
+            # Query param: Only snapshots in which the plan was in this state will be
+            # included.
+            state: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Lithic::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/financial_accounts/installment_plans.rbi

@@ -4,6 +4,13 @@ module Lithic
   module Resources
     class FinancialAccounts
       class InstallmentPlans
+        sig do
+          returns(
+            Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements
+          )
+        end
+        attr_reader :statements
+
         # Get a specific installment plan for a given financial account.
         sig do
           params(

data/rbi/lithic/resources/transactions.rbi

@@ -113,6 +113,7 @@ module Lithic
           amount: Integer,
           descriptor: String,
           pan: String,
+          billing_currency: String,
           mcc: String,
           merchant_acceptor_city: String,
           merchant_acceptor_country: String,
@@ -122,6 +123,7 @@ module Lithic
           merchant_currency: String,
           partial_approval_capable: T::Boolean,
           pin: String,
+          settlement_currency: String,
           status:
             Lithic::TransactionSimulateAuthorizationParams::Status::OrSymbol,
           request_options: Lithic::RequestOptions::OrHash
@@ -138,6 +140,10 @@ module Lithic
         descriptor:,
         # Sixteen digit card number.
         pan:,
+        # 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
+        billing_currency: nil,
         # Merchant category code for the transaction to be simulated. A four-digit number
         # listed in ISO 18245. Supported merchant category codes can be found
         # [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
@@ -153,8 +159,10 @@ module Lithic
         # Amount of the transaction to be simulated in currency specified in
         # merchant_currency, including any acquirer fees.
         merchant_amount: nil,
-        # 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
         merchant_currency: nil,
         # Set to true if the terminal is capable of partial approval otherwise false.
         # Partial approval is when part of a transaction is approved and another payment
@@ -162,6 +170,12 @@ module Lithic
         partial_approval_capable: nil,
         # Simulate entering a PIN. If omitted, PIN check will not be performed.
         pin: nil,
+        # 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
+        settlement_currency: nil,
         # Type of event to simulate.
         #
         # - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
@@ -244,6 +258,7 @@ module Lithic
           amount: Integer,
           descriptor: String,
           pan: String,
+          billing_currency: String,
           mcc: String,
           merchant_acceptor_city: String,
           merchant_acceptor_country: String,
@@ -263,6 +278,10 @@ module Lithic
         descriptor:,
         # Sixteen digit card number.
         pan:,
+        # 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
+        billing_currency: nil,
         # Merchant category code for the transaction to be simulated. A four-digit number
         # listed in ISO 18245. Supported merchant category codes can be found
         # [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
@@ -287,6 +306,8 @@ module Lithic
           amount: Integer,
           descriptor: String,
           pan: String,
+          billing_currency: String,
+          settlement_currency: String,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(Lithic::Models::TransactionSimulateReturnResponse)
       end
@@ -297,6 +318,14 @@ module Lithic
         descriptor:,
         # Sixteen digit card number.
         pan:,
+        # 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
+        billing_currency: nil,
+        # 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
+        settlement_currency: nil,
         request_options: {}
       )
       end

data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs

@@ -223,9 +223,9 @@ module Lithic
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
 
         class Address < Lithic::Internal::Type::BaseModel
@@ -235,30 +235,30 @@ module Lithic
 
           attr_accessor country: String
 
-          attr_accessor postal_code: String
-
-          attr_accessor state: String
-
           attr_reader address2: String?
 
           def address2=: (String) -> String
 
+          attr_accessor postal_code: String?
+
+          attr_accessor state: String?
+
           def initialize: (
             address1: String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            ?address2: String
+            ?address2: String,
+            ?postal_code: String?,
+            ?state: String?
           ) -> void
 
           def to_hash: -> {
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
         end
       end
@@ -325,9 +325,9 @@ module Lithic
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
 
         class Address < Lithic::Internal::Type::BaseModel
@@ -337,30 +337,30 @@ module Lithic
 
           attr_accessor country: String
 
-          attr_accessor postal_code: String
-
-          attr_accessor state: String
-
           attr_reader address2: String?
 
           def address2=: (String) -> String
 
+          attr_accessor postal_code: String?
+
+          attr_accessor state: String?
+
           def initialize: (
             address1: String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            ?address2: String
+            ?address2: String,
+            ?postal_code: String?,
+            ?state: String?
           ) -> void
 
           def to_hash: -> {
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
         end
       end
@@ -438,9 +438,9 @@ module Lithic
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
 
         class Address < Lithic::Internal::Type::BaseModel
@@ -450,30 +450,30 @@ module Lithic
 
           attr_accessor country: String
 
-          attr_accessor postal_code: String
-
-          attr_accessor state: String
-
           attr_reader address2: String?
 
           def address2=: (String) -> String
 
+          attr_accessor postal_code: String?
+
+          attr_accessor state: String?
+
           def initialize: (
             address1: String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            ?address2: String
+            ?address2: String,
+            ?postal_code: String?,
+            ?state: String?
           ) -> void
 
           def to_hash: -> {
             :address1 => String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            :address2 => String
+            :address2 => String,
+            postal_code: String?,
+            state: String?
           }
         end
       end