Merge pull request #359 from EasyPost/SHPE-484_verify_carrier

feat: add verify_carrier address param

Author: Justintime50

CHANGELOG.md

@@ -1,9 +1,10 @@
 # CHANGELOG
 
-## Next Release
+## v8.3.0 (2025-11-10)
 
 - Adds support for `UspsShipAccount`
 - Adds `tracker.retrieveBatch` function
+- Adds `verify_carrier` address param
 
 ## v8.2.0 (2025-06-18)
 

README.md

@@ -16,7 +16,7 @@ Add this to your project's POM:
 <dependency>
   <groupId>com.easypost</groupId>
   <artifactId>easypost-api-client</artifactId>
-  <version>8.2.0</version>
+  <version>8.3.0</version>
 </dependency>
 ```
 
@@ -25,7 +25,7 @@ Add this to your project's POM:
 Add this to your project's build file:
 
 ```groovy
-implementation "com.easypost:easypost-api-client:8.2.0"
+implementation "com.easypost:easypost-api-client:8.3.0"
 ```
 
 **NOTE:** [Google Gson](http://code.google.com/p/google-gson/) is required.

VERSION

@@ -1 +1 @@
-8.2.0
+8.3.0

pom.xml

@@ -6,7 +6,7 @@
     <groupId>com.easypost</groupId>
     <artifactId>easypost-api-client</artifactId>
 
-    <version>8.2.0</version>
+    <version>8.3.0</version>
     <packaging>jar</packaging>
 
     <name>com.easypost:easypost-api-client</name>

src/main/java/com/easypost/service/AddressService.java

@@ -43,6 +43,10 @@ public Address create(final Map<String, Object> params) throws EasyPostException
             wrappedParams.put("verify_strict", params.remove("verify_strict"));
         }
 
+        if (params.containsKey("verify_carrier")) {
+            wrappedParams.put("verify_carrier", params.remove("verify_carrier"));
+        }
+
         wrappedParams.put("address", params);
 
         String endpoint = "addresses";
@@ -113,6 +117,11 @@ public AddressCollection apply(Map<String, Object> parameters) {
      */
     public Address createAndVerify(final Map<String, Object> params) throws EasyPostException {
         Map<String, Object> wrappedParams = new HashMap<String, Object>();
+
+        if (params.containsKey("verify_carrier")) {
+            wrappedParams.put("verify_carrier", params.remove("verify_carrier"));
+        }
+
         wrappedParams.put("address", params);
 
         String endpoint = "addresses/create_and_verify";

src/test/cassettes/address/create_and_verify_carrier.json

@@ -278,11 +278,73 @@ public void testVerify() throws EasyPostException {
     @Test
     public void testInvalidAddressCreation() throws EasyPostException {
         vcr.setUpTest("error_address_creation");
+        Map<String, Object> params = new HashMap<>();
         InvalidRequestError exception =
-                assertThrows(InvalidRequestError.class, () -> vcr.client.address.createAndVerify(null));
+                assertThrows(InvalidRequestError.class, () -> vcr.client.address.createAndVerify(params));
 
         assertEquals("PARAMETER.REQUIRED", exception.getCode());
         assertEquals(422, exception.getStatusCode());
         assertEquals("Missing required parameter.", exception.getMessage());
     }
+
+    /**
+     * Test creating an address with the verify_carrier param.
+     * We purposefully pass in slightly incorrect data to get the corrected address
+     * back once verified.
+     *
+     * @throws EasyPostException when the request fails.
+     */
+    @Test
+    public void testCreateVerifyCarrier() throws EasyPostException {
+        vcr.setUpTest("create_verify_carrier");
+
+        Map<String, Object> addressData = Fixtures.incorrectAddress();
+
+        addressData.put("verify", true);
+        addressData.put("verify_carrier", "UPS");
+        Address address = vcr.client.address.create(addressData);
+
+        assertInstanceOf(Address.class, address);
+
+        AddressVerificationFieldError addressVerificationFieldErrorGetDelivery = address.getVerifications()
+            .getDelivery()
+            .getErrors()
+            .get(0);
+        AddressVerificationFieldError addressVerificationFieldErrorZip4 = address.getVerifications()
+            .getZip4()
+            .getErrors()
+            .get(0);
+        assertEquals("Address not found", addressVerificationFieldErrorGetDelivery.getMessage());
+        assertEquals("Address not found", addressVerificationFieldErrorZip4.getMessage());
+    }
+
+    /**
+     * Test creating and verifying an address with the verify_carrier param.
+     * We purposefully pass in slightly incorrect data to get the corrected address
+     * back once verified.
+     *
+     * @throws EasyPostException when the request fails.
+     */
+    @Test
+    public void testCreateAndVerifyCarrier() throws EasyPostException {
+        vcr.setUpTest("create_and_verify_carrier");
+
+        Map<String, Object> addressData = Fixtures.incorrectAddress();
+
+        addressData.put("verify_carrier", "UPS");
+        Address address = vcr.client.address.createAndVerify(addressData);
+
+        assertInstanceOf(Address.class, address);
+
+        AddressVerificationFieldError addressVerificationFieldErrorGetDelivery = address.getVerifications()
+            .getDelivery()
+            .getErrors()
+            .get(0);
+        AddressVerificationFieldError addressVerificationFieldErrorZip4 = address.getVerifications()
+            .getZip4()
+            .getErrors()
+            .get(0);
+        assertEquals("Address not found", addressVerificationFieldErrorGetDelivery.getMessage());
+        assertEquals("Address not found", addressVerificationFieldErrorZip4.getMessage());
+    }
 }