chore(docs): update description for postal codes (#299)

lithic-com · Sep 6, 2024 · 3972792 · 3972792
1 parent aff7172
commit 3972792
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 28 deletions.
diff --git a/lithic-java-core/src/main/kotlin/com/lithic/api/models/Account.kt b/lithic-java-core/src/main/kotlin/com/lithic/api/models/Account.kt
@@ -809,8 +809,8 @@ private constructor(
         fun country(): String = country.getRequired("country")
 
         /**
-         * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
-         * ZIP or nine-digit ZIP+4.
+         * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
+         * a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         fun postalCode(): String = postalCode.getRequired("postal_code")
 
@@ -833,8 +833,8 @@ private constructor(
         @JsonProperty("country") @ExcludeMissing fun _country() = country
 
         /**
-         * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
-         * ZIP or nine-digit ZIP+4.
+         * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
+         * a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         @JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
 
@@ -955,14 +955,16 @@ private constructor(
             fun country(country: JsonField<String>) = apply { this.country = country }
 
             /**
-             * Valid postal code. Only USA ZIP codes are currently supported, entered as a
-             * five-digit ZIP or nine-digit ZIP+4.
+             * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered
+             * as a five-digit postal code or nine-digit postal code (ZIP+4) using the format
+             * 12345-1234.
              */
             fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
 
             /**
-             * Valid postal code. Only USA ZIP codes are currently supported, entered as a
-             * five-digit ZIP or nine-digit ZIP+4.
+             * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered
+             * as a five-digit postal code or nine-digit postal code (ZIP+4) using the format
+             * 12345-1234.
              */
             @JsonProperty("postal_code")
             @ExcludeMissing

diff --git a/lithic-java-core/src/main/kotlin/com/lithic/api/models/Address.kt b/lithic-java-core/src/main/kotlin/com/lithic/api/models/Address.kt
@@ -48,8 +48,8 @@ private constructor(
     fun country(): String = country.getRequired("country")
 
     /**
-     * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or
-     * nine-digit ZIP+4.
+     * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as a
+     * five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
      */
     fun postalCode(): String = postalCode.getRequired("postal_code")
 
@@ -75,8 +75,8 @@ private constructor(
     @JsonProperty("country") @ExcludeMissing fun _country() = country
 
     /**
-     * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or
-     * nine-digit ZIP+4.
+     * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as a
+     * five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
      */
     @JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
 
@@ -203,14 +203,14 @@ private constructor(
         fun country(country: JsonField<String>) = apply { this.country = country }
 
         /**
-         * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
-         * ZIP or nine-digit ZIP+4.
+         * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
+         * a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
 
         /**
-         * Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit
-         * ZIP or nine-digit ZIP+4.
+         * Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as
+         * a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         @JsonProperty("postal_code")
         @ExcludeMissing

diff --git a/lithic-java-core/src/main/kotlin/com/lithic/api/models/KycExempt.kt b/lithic-java-core/src/main/kotlin/com/lithic/api/models/KycExempt.kt
@@ -40,7 +40,7 @@ private constructor(
 
     /**
      * KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not acceptable;
-     * APO/FPO are acceptable. Only USA addresses are currently supported.
+     * APO/FPO are acceptable.
      */
     fun address(): Address = address.getRequired("address")
 
@@ -75,7 +75,7 @@ private constructor(
 
     /**
      * KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not acceptable;
-     * APO/FPO are acceptable. Only USA addresses are currently supported.
+     * APO/FPO are acceptable.
      */
     @JsonProperty("address") @ExcludeMissing fun _address() = address
 
@@ -204,13 +204,13 @@ private constructor(
 
         /**
          * KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
-         * acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+         * acceptable; APO/FPO are acceptable.
          */
         fun address(address: Address) = address(JsonField.of(address))
 
         /**
          * KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
-         * acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+         * acceptable; APO/FPO are acceptable.
          */
         @JsonProperty("address")
         @ExcludeMissing

diff --git a/lithic-java-core/src/main/kotlin/com/lithic/api/models/ShippingAddress.kt b/lithic-java-core/src/main/kotlin/com/lithic/api/models/ShippingAddress.kt
@@ -81,8 +81,8 @@ private constructor(
         Optional.ofNullable(phoneNumber.getNullable("phone_number"))
 
     /**
-     * Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
-     * "ZIP+4".
+     * Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit
+     * postal code (ZIP+4) using the format 12345-1234.
      */
     fun postalCode(): String = postalCode.getRequired("postal_code")
 
@@ -135,8 +135,8 @@ private constructor(
     @JsonProperty("phone_number") @ExcludeMissing fun _phoneNumber() = phoneNumber
 
     /**
-     * Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
-     * "ZIP+4".
+     * Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit
+     * postal code (ZIP+4) using the format 12345-1234.
      */
     @JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
 
@@ -352,14 +352,14 @@ private constructor(
         fun phoneNumber(phoneNumber: JsonField<String>) = apply { this.phoneNumber = phoneNumber }
 
         /**
-         * Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
-         * "ZIP+4".
+         * Postal code (formerly zipcode). For US addresses, either five-digit postal code or
+         * nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
 
         /**
-         * Postal code (formerly zipcode). For US addresses, either five-digit zipcode or nine-digit
-         * "ZIP+4".
+         * Postal code (formerly zipcode). For US addresses, either five-digit postal code or
+         * nine-digit postal code (ZIP+4) using the format 12345-1234.
          */
         @JsonProperty("postal_code")
         @ExcludeMissing