Skip to content

Commit 3972792

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(docs): update description for postal codes (#299)
1 parent aff7172 commit 3972792

4 files changed

Lines changed: 30 additions & 28 deletions

File tree

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -809,8 +809,8 @@ private constructor(
809809
fun country(): String = country.getRequired("country")
810810

811811
/**
812-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
813-
* ZIP or nine-digit ZIP+4.
812+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
813+
* a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
814814
*/
815815
fun postalCode(): String = postalCode.getRequired("postal_code")
816816

@@ -833,8 +833,8 @@ private constructor(
833833
@JsonProperty("country") @ExcludeMissing fun _country() = country
834834

835835
/**
836-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
837-
* ZIP or nine-digit ZIP+4.
836+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
837+
* a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
838838
*/
839839
@JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
840840

@@ -955,14 +955,16 @@ private constructor(
955955
fun country(country: JsonField<String>) = apply { this.country = country }
956956

957957
/**
958-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a
959-
* five-digit ZIP or nine-digit ZIP+4.
958+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered
959+
* as a five-digit postal code or nine-digit postal code (ZIP+4) using the format
960+
* 12345-1234.
960961
*/
961962
fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
962963

963964
/**
964-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a
965-
* five-digit ZIP or nine-digit ZIP+4.
965+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered
966+
* as a five-digit postal code or nine-digit postal code (ZIP+4) using the format
967+
* 12345-1234.
966968
*/
967969
@JsonProperty("postal_code")
968970
@ExcludeMissing

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ private constructor(
4848
fun country(): String = country.getRequired("country")
4949

5050
/**
51-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or
52-
* nine-digit ZIP+4.
51+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as a
52+
* five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
5353
*/
5454
fun postalCode(): String = postalCode.getRequired("postal_code")
5555

@@ -75,8 +75,8 @@ private constructor(
7575
@JsonProperty("country") @ExcludeMissing fun _country() = country
7676

7777
/**
78-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or
79-
* nine-digit ZIP+4.
78+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as a
79+
* five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
8080
*/
8181
@JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
8282

@@ -203,14 +203,14 @@ private constructor(
203203
fun country(country: JsonField<String>) = apply { this.country = country }
204204

205205
/**
206-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
207-
* ZIP or nine-digit ZIP+4.
206+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
207+
* a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
208208
*/
209209
fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
210210

211211
/**
212-
* Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
213-
* ZIP or nine-digit ZIP+4.
212+
* Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
213+
* a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
214214
*/
215215
@JsonProperty("postal_code")
216216
@ExcludeMissing

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ private constructor(
4040

4141
/**
4242
* KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not acceptable;
43-
* APO/FPO are acceptable. Only USA addresses are currently supported.
43+
* APO/FPO are acceptable.
4444
*/
4545
fun address(): Address = address.getRequired("address")
4646

@@ -75,7 +75,7 @@ private constructor(
7575

7676
/**
7777
* KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not acceptable;
78-
* APO/FPO are acceptable. Only USA addresses are currently supported.
78+
* APO/FPO are acceptable.
7979
*/
8080
@JsonProperty("address") @ExcludeMissing fun _address() = address
8181

@@ -204,13 +204,13 @@ private constructor(
204204

205205
/**
206206
* KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
207-
* acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
207+
* acceptable; APO/FPO are acceptable.
208208
*/
209209
fun address(address: Address) = address(JsonField.of(address))
210210

211211
/**
212212
* KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
213-
* acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
213+
* acceptable; APO/FPO are acceptable.
214214
*/
215215
@JsonProperty("address")
216216
@ExcludeMissing

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ private constructor(
8181
Optional.ofNullable(phoneNumber.getNullable("phone_number"))
8282

8383
/**
84-
* Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
85-
* "ZIP+4".
84+
* Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit
85+
* postal code (ZIP+4) using the format 12345-1234.
8686
*/
8787
fun postalCode(): String = postalCode.getRequired("postal_code")
8888

@@ -135,8 +135,8 @@ private constructor(
135135
@JsonProperty("phone_number") @ExcludeMissing fun _phoneNumber() = phoneNumber
136136

137137
/**
138-
* Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
139-
* "ZIP+4".
138+
* Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit
139+
* postal code (ZIP+4) using the format 12345-1234.
140140
*/
141141
@JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
142142

@@ -352,14 +352,14 @@ private constructor(
352352
fun phoneNumber(phoneNumber: JsonField<String>) = apply { this.phoneNumber = phoneNumber }
353353

354354
/**
355-
* Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
356-
* "ZIP+4".
355+
* Postal code (formerly zipcode). For US addresses, either five-digit postal code or
356+
* nine-digit postal code (ZIP+4) using the format 12345-1234.
357357
*/
358358
fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
359359

360360
/**
361-
* Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
362-
* "ZIP+4".
361+
* Postal code (formerly zipcode). For US addresses, either five-digit postal code or
362+
* nine-digit postal code (ZIP+4) using the format 12345-1234.
363363
*/
364364
@JsonProperty("postal_code")
365365
@ExcludeMissing

0 commit comments

Comments
 (0)