Skip to content

Commit 1ccf96d

Browse files
docs(api): improve event_tokens and transaction_token field docs in SettlementDetail
1 parent 793c2b6 commit 1ccf96d

2 files changed

Lines changed: 20 additions & 6 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 191
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-0572da655d188e23459f2115b03b27040b4c4d3b47e4a86510803892d0d1b0aa.yml
3-
openapi_spec_hash: b615a0eb16502b4de874f9ae28491894
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-a46ebb10f6bb217a591206f0574450c324f108dbd32a2d62727cd8186d85e94f.yml
3+
openapi_spec_hash: f320c173152f74b0799166b6ef5b82cd
44
config_hash: ac8326134e692f3f3bdec82396bbec80

lithic-java-core/src/main/kotlin/com/lithic/api/models/SettlementDetail.kt

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,8 @@ private constructor(
186186
fun disputesGrossAmount(): Long = disputesGrossAmount.getRequired("disputes_gross_amount")
187187

188188
/**
189-
* Globally unique identifiers denoting the Events associated with this settlement.
189+
* Array of globally unique identifiers for the financial events that comprise this settlement.
190+
* Use these tokens to access detailed event-level information.
190191
*
191192
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
192193
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -262,7 +263,11 @@ private constructor(
262263
fun settlementDate(): String = settlementDate.getRequired("settlement_date")
263264

264265
/**
265-
* Globally unique identifier denoting the associated Transaction object.
266+
* Globally unique identifier denoting the associated transaction. For settlement records with
267+
* type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a card transaction token.
268+
* For settlement records with type `CHARGEBACK`, `REPRESENTMENT`, `PREARBITRATION`,
269+
* `ARBITRATION`, or `COLLABORATION`, this references the dispute transaction token. May be null
270+
* for certain settlement types.
266271
*
267272
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
268273
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -676,7 +681,10 @@ private constructor(
676681
this.disputesGrossAmount = disputesGrossAmount
677682
}
678683

679-
/** Globally unique identifiers denoting the Events associated with this settlement. */
684+
/**
685+
* Array of globally unique identifiers for the financial events that comprise this
686+
* settlement. Use these tokens to access detailed event-level information.
687+
*/
680688
fun eventTokens(eventTokens: List<String>) = eventTokens(JsonField.of(eventTokens))
681689

682690
/**
@@ -818,7 +826,13 @@ private constructor(
818826
this.settlementDate = settlementDate
819827
}
820828

821-
/** Globally unique identifier denoting the associated Transaction object. */
829+
/**
830+
* Globally unique identifier denoting the associated transaction. For settlement records
831+
* with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a card transaction
832+
* token. For settlement records with type `CHARGEBACK`, `REPRESENTMENT`, `PREARBITRATION`,
833+
* `ARBITRATION`, or `COLLABORATION`, this references the dispute transaction token. May be
834+
* null for certain settlement types.
835+
*/
822836
fun transactionToken(transactionToken: String) =
823837
transactionToken(JsonField.of(transactionToken))
824838

0 commit comments

Comments
 (0)