docs(types): clarify event_tokens and transaction_token fields in SettlementDetail

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 191
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-0572da655d188e23459f2115b03b27040b4c4d3b47e4a86510803892d0d1b0aa.yml
-openapi_spec_hash: b615a0eb16502b4de874f9ae28491894
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-a46ebb10f6bb217a591206f0574450c324f108dbd32a2d62727cd8186d85e94f.yml
+openapi_spec_hash: f320c173152f74b0799166b6ef5b82cd
 config_hash: ac8326134e692f3f3bdec82396bbec80

lib/lithic/models/settlement_detail.rb

@@ -49,7 +49,8 @@ class SettlementDetail < Lithic::Internal::Type::BaseModel
       required :disputes_gross_amount, Integer
 
       # @!attribute event_tokens
-      #   Globally unique identifiers denoting the Events associated with this settlement.
+      #   Array of globally unique identifiers for the financial events that comprise this
+      #   settlement. Use these tokens to access detailed event-level information.
       #
       #   @return [Array<String>]
       required :event_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -106,7 +107,12 @@ class SettlementDetail < Lithic::Internal::Type::BaseModel
       required :settlement_date, String
 
       # @!attribute transaction_token
-      #   Globally unique identifier denoting the associated Transaction object.
+      #   Globally unique identifier denoting the associated transaction. For settlement
+      #   records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a
+      #   card transaction token. For settlement records with type `CHARGEBACK`,
+      #   `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or `COLLABORATION`, this
+      #   references the dispute transaction token. May be null for certain settlement
+      #   types.
       #
       #   @return [String]
       required :transaction_token, String
@@ -154,7 +160,7 @@ class SettlementDetail < Lithic::Internal::Type::BaseModel
       #
       #   @param disputes_gross_amount [Integer] The total gross amount of disputes settlements.
       #
-      #   @param event_tokens [Array<String>] Globally unique identifiers denoting the Events associated with this settlement.
+      #   @param event_tokens [Array<String>] Array of globally unique identifiers for the financial events that comprise this
       #
       #   @param institution [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
       #
@@ -172,7 +178,7 @@ class SettlementDetail < Lithic::Internal::Type::BaseModel
       #
       #   @param settlement_date [String] Date of when money movement is triggered for the transaction. One exception appl
       #
-      #   @param transaction_token [String] Globally unique identifier denoting the associated Transaction object.
+      #   @param transaction_token [String] Globally unique identifier denoting the associated transaction. For settlement r
       #
       #   @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
       #

rbi/lithic/models/settlement_detail.rbi

@@ -39,7 +39,8 @@ module Lithic
       sig { returns(Integer) }
       attr_accessor :disputes_gross_amount
 
-      # Globally unique identifiers denoting the Events associated with this settlement.
+      # Array of globally unique identifiers for the financial events that comprise this
+      # settlement. Use these tokens to access detailed event-level information.
       sig { returns(T::Array[String]) }
       attr_accessor :event_tokens
 
@@ -85,7 +86,12 @@ module Lithic
       sig { returns(String) }
       attr_accessor :settlement_date
 
-      # Globally unique identifier denoting the associated Transaction object.
+      # Globally unique identifier denoting the associated transaction. For settlement
+      # records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a
+      # card transaction token. For settlement records with type `CHARGEBACK`,
+      # `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or `COLLABORATION`, this
+      # references the dispute transaction token. May be null for certain settlement
+      # types.
       sig { returns(String) }
       attr_accessor :transaction_token
 
@@ -153,7 +159,8 @@ module Lithic
         currency:,
         # The total gross amount of disputes settlements.
         disputes_gross_amount:,
-        # Globally unique identifiers denoting the Events associated with this settlement.
+        # Array of globally unique identifiers for the financial events that comprise this
+        # settlement. Use these tokens to access detailed event-level information.
         event_tokens:,
         # The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
         # for Visa).
@@ -174,7 +181,12 @@ module Lithic
         # applies - for Mastercard dual message settlement, this is the settlement
         # advisement date, which is distinct from the date of money movement.
         settlement_date:,
-        # Globally unique identifier denoting the associated Transaction object.
+        # Globally unique identifier denoting the associated transaction. For settlement
+        # records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a
+        # card transaction token. For settlement records with type `CHARGEBACK`,
+        # `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or `COLLABORATION`, this
+        # references the dispute transaction token. May be null for certain settlement
+        # types.
         transaction_token:,
         # The total amount of settlement impacting transactions (excluding interchange,
         # fees, and disputes).