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

feat: 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)
 

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "easypost/easypost-php",
   "description": "EasyPost Shipping API Client Library for PHP",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "keywords": [
     "shipping",
     "api",

lib/EasyPost/Constant/Constants.php

@@ -11,7 +11,7 @@ abstract class Constants
     const BETA_API_VERSION = 'beta';
 
     // Library constants
-    const LIBRARY_VERSION = '8.2.0';
+    const LIBRARY_VERSION = '8.3.0';
     const SUPPORT_EMAIL = 'support@easypost.com';
 
     // Validation

lib/EasyPost/Service/AddressService.php

@@ -66,6 +66,12 @@ public function create(mixed $params = null): mixed
             $wrappedParams['verify_strict'] = $verifyStrict;
         }
 
+        if (isset($params['verify_carrier'])) {
+            $verifyCarrier = $params['verify_carrier'];
+            unset($params['verify_carrier']);
+            $wrappedParams['verify_carrier'] = $verifyCarrier;
+        }
+
         $wrappedParams['address'] = $params;
 
         return self::createResource(self::serviceModelClassName(self::class), $wrappedParams);
@@ -79,10 +85,18 @@ public function create(mixed $params = null): mixed
      */
     public function createAndVerify(mixed $params = null): mixed
     {
-        $params = InternalUtil::wrapParams($params, 'address');
+        $wrappedParams = [];
+
+        if (isset($params['verify_carrier'])) {
+            $verifyCarrier = $params['verify_carrier'];
+            unset($params['verify_carrier']);
+            $wrappedParams['verify_carrier'] = $verifyCarrier;
+        }
+
+        $wrappedParams['address'] = $params;
 
         $url = self::classUrl(self::serviceModelClassName(self::class));
-        $response = Requestor::request($this->client, 'post', $url . '/create_and_verify', $params);
+        $response = Requestor::request($this->client, 'post', $url . '/create_and_verify', $wrappedParams);
 
         return InternalUtil::convertToEasyPostObject($this->client, $response['address']);
     }

test/EasyPost/AddressTest.php

@@ -233,4 +233,45 @@ public function testVerifyInvalid(): void
             $this->assertEquals('Unable to verify address.', $error->getMessage());
         }
     }
+
+    /**
+     * Test creating a verified address with verify_carrier.
+     *
+     * We purposefully pass in slightly incorrect data to get the corrected address back once verified.
+     */
+    public function testCreateVerifyCarrier(): void
+    {
+        TestUtil::setupCassette('addresses/createVerifyCarrier.yml');
+
+        $addressData = Fixture::incorrectAddress();
+
+        $addressData['verify'] = true;
+        $addressData['verify_carrier'] = 'UPS';
+        $address = self::$client->address->create($addressData);
+
+        $this->assertInstanceOf(Address::class, $address);
+
+        $this->assertEquals('Address not found', $address->verifications->delivery->errors[0]->message);
+        $this->assertEquals('Address not found', $address->verifications->zip4->errors[0]->message);
+    }
+
+    /**
+     * Test creating a verified address with verify_carrier.
+     *
+     * We purposefully pass in slightly incorrect data to get the corrected address back once verified.
+     */
+    public function testCreateAndVerifyCarrier(): void
+    {
+        TestUtil::setupCassette('addresses/createAndVerifyCarrier.yml');
+
+        $addressData = Fixture::incorrectAddress();
+
+        $addressData['verify_carrier'] = 'UPS';
+        $address = self::$client->address->createAndVerify($addressData);
+
+        $this->assertInstanceOf(Address::class, $address);
+
+        $this->assertEquals('Address not found', $address->verifications->delivery->errors[0]->message);
+        $this->assertEquals('Address not found', $address->verifications->zip4->errors[0]->message);
+    }
 }