Skip to content

Commit d3e59f5

Browse files
feat(client): update currency data type (#530)
docs: update some descriptions chore(client): deprecate some fields
1 parent ac4d410 commit d3e59f5

35 files changed

Lines changed: 238 additions & 1534 deletions

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ private constructor(
9494
fun authRuleTokens(): Optional<List<String>> =
9595
Optional.ofNullable(authRuleTokens.getNullable("auth_rule_tokens"))
9696

97-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
97+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
9898
fun cardholderCurrency(): Optional<String> =
9999
Optional.ofNullable(cardholderCurrency.getNullable("cardholder_currency"))
100100

@@ -151,7 +151,7 @@ private constructor(
151151
@ExcludeMissing
152152
fun _authRuleTokens(): JsonField<List<String>> = authRuleTokens
153153

154-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
154+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
155155
@JsonProperty("cardholder_currency")
156156
@ExcludeMissing
157157
fun _cardholderCurrency(): JsonField<String> = cardholderCurrency
@@ -340,11 +340,11 @@ private constructor(
340340
}
341341
}
342342

343-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
343+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
344344
fun cardholderCurrency(cardholderCurrency: String) =
345345
cardholderCurrency(JsonField.of(cardholderCurrency))
346346

347-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
347+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
348348
fun cardholderCurrency(cardholderCurrency: JsonField<String>) = apply {
349349
this.cardholderCurrency = cardholderCurrency
350350
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ private constructor(
6363
/** Date and time for when the balance was first created. */
6464
fun created(): OffsetDateTime = created.getRequired("created")
6565

66-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
66+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
6767
fun currency(): String = currency.getRequired("currency")
6868

6969
/** Type of financial account */
@@ -107,7 +107,7 @@ private constructor(
107107
/** Date and time for when the balance was first created. */
108108
@JsonProperty("created") @ExcludeMissing fun _created(): JsonField<OffsetDateTime> = created
109109

110-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
110+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
111111
@JsonProperty("currency") @ExcludeMissing fun _currency(): JsonField<String> = currency
112112

113113
/** Type of financial account */
@@ -242,10 +242,10 @@ private constructor(
242242
/** Date and time for when the balance was first created. */
243243
fun created(created: JsonField<OffsetDateTime>) = apply { this.created = created }
244244

245-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
245+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
246246
fun currency(currency: String) = currency(JsonField.of(currency))
247247

248-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
248+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
249249
fun currency(currency: JsonField<String>) = apply { this.currency = currency }
250250

251251
/** Type of financial account */

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ private constructor(
5858
/** Date and time for when the balance was first created. */
5959
fun created(): OffsetDateTime = created.getRequired("created")
6060

61-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
61+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
6262
fun currency(): String = currency.getRequired("currency")
6363

6464
/** Globally unique identifier for the card that had its balance updated most recently */
@@ -94,7 +94,7 @@ private constructor(
9494
/** Date and time for when the balance was first created. */
9595
@JsonProperty("created") @ExcludeMissing fun _created(): JsonField<OffsetDateTime> = created
9696

97-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
97+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
9898
@JsonProperty("currency") @ExcludeMissing fun _currency(): JsonField<String> = currency
9999

100100
/** Globally unique identifier for the card that had its balance updated most recently */
@@ -217,10 +217,10 @@ private constructor(
217217
/** Date and time for when the balance was first created. */
218218
fun created(created: JsonField<OffsetDateTime>) = apply { this.created = created }
219219

220-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
220+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
221221
fun currency(currency: String) = currency(JsonField.of(currency))
222222

223-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
223+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
224224
fun currency(currency: JsonField<String>) = apply { this.currency = currency }
225225

226226
/** Globally unique identifier for the card that had its balance updated most recently */

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ private constructor(
5050
* the types of goods or services it provides.
5151
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1
5252
* alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
53-
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
53+
* - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the
54+
* transaction.
5455
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
5556
* - `DESCRIPTOR`: Short description of card acceptor.
5657
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to
@@ -90,7 +91,8 @@ private constructor(
9091
* the types of goods or services it provides.
9192
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1
9293
* alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
93-
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
94+
* - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the
95+
* transaction.
9496
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
9597
* - `DESCRIPTOR`: Short description of card acceptor.
9698
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to
@@ -172,7 +174,7 @@ private constructor(
172174
* by the types of goods or services it provides.
173175
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1
174176
* alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
175-
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
177+
* - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the
176178
* transaction.
177179
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
178180
* - `DESCRIPTOR`: Short description of card acceptor.
@@ -209,7 +211,7 @@ private constructor(
209211
* by the types of goods or services it provides.
210212
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1
211213
* alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
212-
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
214+
* - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the
213215
* transaction.
214216
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
215217
* - `DESCRIPTOR`: Short description of card acceptor.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ private constructor(
6363
/** Date and time for when the balance was first created. */
6464
fun created(): OffsetDateTime = created.getRequired("created")
6565

66-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
66+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
6767
fun currency(): String = currency.getRequired("currency")
6868

6969
/** Globally unique identifier for the financial account that holds this balance. */
@@ -107,7 +107,7 @@ private constructor(
107107
/** Date and time for when the balance was first created. */
108108
@JsonProperty("created") @ExcludeMissing fun _created(): JsonField<OffsetDateTime> = created
109109

110-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
110+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
111111
@JsonProperty("currency") @ExcludeMissing fun _currency(): JsonField<String> = currency
112112

113113
/** Globally unique identifier for the financial account that holds this balance. */
@@ -242,10 +242,10 @@ private constructor(
242242
/** Date and time for when the balance was first created. */
243243
fun created(created: JsonField<OffsetDateTime>) = apply { this.created = created }
244244

245-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
245+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
246246
fun currency(currency: String) = currency(JsonField.of(currency))
247247

248-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
248+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
249249
fun currency(currency: JsonField<String>) = apply { this.currency = currency }
250250

251251
/** Globally unique identifier for the financial account that holds this balance. */

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ private constructor(
6262
/** Date and time for when the balance was first created. */
6363
fun created(): OffsetDateTime = created.getRequired("created")
6464

65-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
65+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
6666
fun currency(): String = currency.getRequired("currency")
6767

6868
/**
@@ -104,7 +104,7 @@ private constructor(
104104
/** Date and time for when the balance was first created. */
105105
@JsonProperty("created") @ExcludeMissing fun _created(): JsonField<OffsetDateTime> = created
106106

107-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
107+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
108108
@JsonProperty("currency") @ExcludeMissing fun _currency(): JsonField<String> = currency
109109

110110
/**
@@ -238,10 +238,10 @@ private constructor(
238238
/** Date and time for when the balance was first created. */
239239
fun created(created: JsonField<OffsetDateTime>) = apply { this.created = created }
240240

241-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
241+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
242242
fun currency(currency: String) = currency(JsonField.of(currency))
243243

244-
/** 3-digit alphabetic ISO 4217 code for the local currency of the balance. */
244+
/** 3-character alphabetic ISO 4217 code for the local currency of the balance. */
245245
fun currency(currency: JsonField<String>) = apply { this.currency = currency }
246246

247247
/**

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ private constructor(
7373
/** Date and time when the transfer occurred. UTC time zone. */
7474
fun created(): OffsetDateTime = created.getRequired("created")
7575

76-
/** 3-digit alphabetic ISO 4217 code for the settling currency of the transaction. */
76+
/** 3-character alphabetic ISO 4217 code for the settling currency of the transaction. */
7777
fun currency(): String = currency.getRequired("currency")
7878

7979
/** A list of all financial events that have modified this transfer. */
@@ -134,7 +134,7 @@ private constructor(
134134
/** Date and time when the transfer occurred. UTC time zone. */
135135
@JsonProperty("created") @ExcludeMissing fun _created(): JsonField<OffsetDateTime> = created
136136

137-
/** 3-digit alphabetic ISO 4217 code for the settling currency of the transaction. */
137+
/** 3-character alphabetic ISO 4217 code for the settling currency of the transaction. */
138138
@JsonProperty("currency") @ExcludeMissing fun _currency(): JsonField<String> = currency
139139

140140
/** A list of all financial events that have modified this transfer. */
@@ -291,10 +291,10 @@ private constructor(
291291
/** Date and time when the transfer occurred. UTC time zone. */
292292
fun created(created: JsonField<OffsetDateTime>) = apply { this.created = created }
293293

294-
/** 3-digit alphabetic ISO 4217 code for the settling currency of the transaction. */
294+
/** 3-character alphabetic ISO 4217 code for the settling currency of the transaction. */
295295
fun currency(currency: String) = currency(JsonField.of(currency))
296296

297-
/** 3-digit alphabetic ISO 4217 code for the settling currency of the transaction. */
297+
/** 3-character alphabetic ISO 4217 code for the settling currency of the transaction. */
298298
fun currency(currency: JsonField<String>) = apply { this.currency = currency }
299299

300300
/** A list of all financial events that have modified this transfer. */

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ private constructor(
174174
fun authRuleTokens(): Optional<List<String>> =
175175
Optional.ofNullable(authRuleTokens.getNullable("auth_rule_tokens"))
176176

177-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
177+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
178178
fun cardholderCurrency(): Optional<String> =
179179
Optional.ofNullable(cardholderCurrency.getNullable("cardholder_currency"))
180180

@@ -325,7 +325,7 @@ private constructor(
325325
@ExcludeMissing
326326
fun _authRuleTokens(): JsonField<List<String>> = authRuleTokens
327327

328-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
328+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
329329
@JsonProperty("cardholder_currency")
330330
@ExcludeMissing
331331
fun _cardholderCurrency(): JsonField<String> = cardholderCurrency
@@ -711,11 +711,11 @@ private constructor(
711711
}
712712
}
713713

714-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
714+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
715715
fun cardholderCurrency(cardholderCurrency: String) =
716716
cardholderCurrency(JsonField.of(cardholderCurrency))
717717

718-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
718+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
719719
fun cardholderCurrency(cardholderCurrency: JsonField<String>) = apply {
720720
this.cardholderCurrency = cardholderCurrency
721721
}

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ private constructor(
5858
/** The first digits of the card number that this card program starts with. */
5959
fun panRangeStart(): String = panRangeStart.getRequired("pan_range_start")
6060

61-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
61+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
6262
fun cardholderCurrency(): Optional<String> =
6363
Optional.ofNullable(cardholderCurrency.getNullable("cardholder_currency"))
6464

6565
/**
66-
* List of 3-digit alphabetic ISO 4217 codes for the currencies that the card program supports
67-
* for settlement.
66+
* List of 3-character alphabetic ISO 4217 codes for the currencies that the card program
67+
* supports for settlement.
6868
*/
6969
fun settlementCurrencies(): Optional<List<String>> =
7070
Optional.ofNullable(settlementCurrencies.getNullable("settlement_currencies"))
@@ -88,14 +88,14 @@ private constructor(
8888
@ExcludeMissing
8989
fun _panRangeStart(): JsonField<String> = panRangeStart
9090

91-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
91+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
9292
@JsonProperty("cardholder_currency")
9393
@ExcludeMissing
9494
fun _cardholderCurrency(): JsonField<String> = cardholderCurrency
9595

9696
/**
97-
* List of 3-digit alphabetic ISO 4217 codes for the currencies that the card program supports
98-
* for settlement.
97+
* List of 3-character alphabetic ISO 4217 codes for the currencies that the card program
98+
* supports for settlement.
9999
*/
100100
@JsonProperty("settlement_currencies")
101101
@ExcludeMissing
@@ -197,32 +197,32 @@ private constructor(
197197
this.panRangeStart = panRangeStart
198198
}
199199

200-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
200+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
201201
fun cardholderCurrency(cardholderCurrency: String) =
202202
cardholderCurrency(JsonField.of(cardholderCurrency))
203203

204-
/** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
204+
/** 3-character alphabetic ISO 4217 code for the currency of the cardholder. */
205205
fun cardholderCurrency(cardholderCurrency: JsonField<String>) = apply {
206206
this.cardholderCurrency = cardholderCurrency
207207
}
208208

209209
/**
210-
* List of 3-digit alphabetic ISO 4217 codes for the currencies that the card program
210+
* List of 3-character alphabetic ISO 4217 codes for the currencies that the card program
211211
* supports for settlement.
212212
*/
213213
fun settlementCurrencies(settlementCurrencies: List<String>) =
214214
settlementCurrencies(JsonField.of(settlementCurrencies))
215215

216216
/**
217-
* List of 3-digit alphabetic ISO 4217 codes for the currencies that the card program
217+
* List of 3-character alphabetic ISO 4217 codes for the currencies that the card program
218218
* supports for settlement.
219219
*/
220220
fun settlementCurrencies(settlementCurrencies: JsonField<List<String>>) = apply {
221221
this.settlementCurrencies = settlementCurrencies.map { it.toMutableList() }
222222
}
223223

224224
/**
225-
* List of 3-digit alphabetic ISO 4217 codes for the currencies that the card program
225+
* List of 3-character alphabetic ISO 4217 codes for the currencies that the card program
226226
* supports for settlement.
227227
*/
228228
fun addSettlementCurrency(settlementCurrency: String) = apply {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import com.lithic.api.errors.LithicInvalidDataException
1515
* types of goods or services it provides.
1616
* - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3
1717
* country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
18-
* - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the transaction.
18+
* - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the transaction.
1919
* - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).
2020
* - `DESCRIPTOR`: Short description of card acceptor.
2121
* - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the

0 commit comments

Comments
 (0)