docs(api): clarify simulate_clearing supports multiple calls in transactions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 214
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-9e397c65ffb81e2928b8ecf979769a79131ae6058b6fb373a5e930dc8a168732.yml
-openapi_spec_hash: 93aea3855d2d1c390107d223762aa818
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-1514911f233cb8bf0d6752c45bfa53a61b8f9b8ff215a4ea94a95f9505911000.yml
+openapi_spec_hash: 9820a9c9a4ff778c627041eb53fd4ee5
 config_hash: 5bb913c05ebeb301ec925b16e75bb251

lib/lithic/models/transaction_simulate_clearing_params.rb

@@ -20,9 +20,10 @@ class TransactionSimulateClearingParams < Lithic::Internal::Type::BaseModel
       #   example, entering 100 in this field will result in a -100 amount in the
       #   transaction, if the original authorization is a credit authorization.
       #
-      #   If `amount` is not set, the full amount of the transaction will be cleared.
-      #   Transactions that have already cleared, either partially or fully, cannot be
-      #   cleared again using this endpoint.
+      #   If `amount` is not set, the full amount of the transaction will be cleared. This
+      #   endpoint may be called multiple times against the same authorization to simulate
+      #   a multiple-completion scenario, with each call creating a separate clearing
+      #   event.
       #
       #   @return [Integer, nil]
       optional :amount, Integer

lib/lithic/resources/transactions.rb

@@ -210,9 +210,10 @@ def simulate_authorization_advice(params)
       # Clears an existing authorization, either debit or credit. After this event, the
       # transaction transitions from `PENDING` to `SETTLED` status.
       #
-      # If `amount` is not set, the full amount of the transaction will be cleared.
-      # Transactions that have already cleared, either partially or fully, cannot be
-      # cleared again using this endpoint.
+      # If `amount` is not set, the full amount of the transaction will be cleared. This
+      # endpoint may be called multiple times against the same authorization to simulate
+      # a multiple-completion scenario, with each call creating a separate clearing
+      # event.
       #
       # @overload simulate_clearing(token:, amount: nil, request_options: {})
       #

rbi/lithic/models/transaction_simulate_clearing_params.rbi

@@ -24,9 +24,10 @@ module Lithic
       # example, entering 100 in this field will result in a -100 amount in the
       # transaction, if the original authorization is a credit authorization.
       #
-      # If `amount` is not set, the full amount of the transaction will be cleared.
-      # Transactions that have already cleared, either partially or fully, cannot be
-      # cleared again using this endpoint.
+      # If `amount` is not set, the full amount of the transaction will be cleared. This
+      # endpoint may be called multiple times against the same authorization to simulate
+      # a multiple-completion scenario, with each call creating a separate clearing
+      # event.
       sig { returns(T.nilable(Integer)) }
       attr_reader :amount
 
@@ -49,9 +50,10 @@ module Lithic
         # example, entering 100 in this field will result in a -100 amount in the
         # transaction, if the original authorization is a credit authorization.
         #
-        # If `amount` is not set, the full amount of the transaction will be cleared.
-        # Transactions that have already cleared, either partially or fully, cannot be
-        # cleared again using this endpoint.
+        # If `amount` is not set, the full amount of the transaction will be cleared. This
+        # endpoint may be called multiple times against the same authorization to simulate
+        # a multiple-completion scenario, with each call creating a separate clearing
+        # event.
         amount: nil,
         request_options: {}
       )

rbi/lithic/resources/transactions.rbi

@@ -208,9 +208,10 @@ module Lithic
       # Clears an existing authorization, either debit or credit. After this event, the
       # transaction transitions from `PENDING` to `SETTLED` status.
       #
-      # If `amount` is not set, the full amount of the transaction will be cleared.
-      # Transactions that have already cleared, either partially or fully, cannot be
-      # cleared again using this endpoint.
+      # If `amount` is not set, the full amount of the transaction will be cleared. This
+      # endpoint may be called multiple times against the same authorization to simulate
+      # a multiple-completion scenario, with each call creating a separate clearing
+      # event.
       sig do
         params(
           token: String,
@@ -227,9 +228,10 @@ module Lithic
         # example, entering 100 in this field will result in a -100 amount in the
         # transaction, if the original authorization is a credit authorization.
         #
-        # If `amount` is not set, the full amount of the transaction will be cleared.
-        # Transactions that have already cleared, either partially or fully, cannot be
-        # cleared again using this endpoint.
+        # If `amount` is not set, the full amount of the transaction will be cleared. This
+        # endpoint may be called multiple times against the same authorization to simulate
+        # a multiple-completion scenario, with each call creating a separate clearing
+        # event.
         amount: nil,
         request_options: {}
       )