fix: SmartRate namings

Justintime50 · Justintime50 · commit 12aa35016772 · 2025-04-29T13:33:08.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,12 +20,16 @@ See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-7x-to-80) for more detai
   - Added an explicit `AddressVerificationFieldError` model
   - The `BetaPaymentRefund` now uses a list of `FieldError` instead of `Error` for the `errors` field
 - Removes deprecated functions
-  - `TimeInTransit.getSmartRateAccuracy` (use `TimeInTransit.getSmartrateAccuracy` instead)
   - `paymentMethod.all` (use `billing.retrievePaymentMethods` instead)
-  - `shipment.getSmartrates` (use `shipment.smartrates` instead)
-  - String overload for `shipment.lowestSmartRate`, 3rd param requires a valid `SmartrateAccuracy`
   - `user.apiKeys` (use `apiKey.retrieveApiKeysForUser` instead)
-  - `utilities.getLowestSmartRate` (use `utilities.findLowestSmartrate` instead)
+- Replaces deprecated functions
+  - `shipment.lowestSmartRate` (3rd param expects a valid `SmartRateAccuracy`)
+  - `utilities.findLowestSmartRate` (3rd param expects a valid `SmartRateAccuracy`)
+- Renames
+  - `SmartrateAccuracy` is now `SmartRateAccuracy`
+  - `SmartrateCollection` is now `SmartRateCollection`
+  - `shipment.smartrates` is now `shipment.smartRates`
+  - `TimeInTransit.getBySmartrateAccuracy` is now `TimeInTransit.getSmartRateAccuracy`
 - Bumps dependencies
 
 ## v7.4.4 (2025-01-03)
diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md
@@ -33,14 +33,19 @@ See the `CHANGELOG` for more details.
 
 *Likelihood of Impact: **Medium***
 
-The following deprecated functions have been removed:
-
-- `TimeInTransit.getSmartRateAccuracy` (use `TimeInTransit.getSmartrateAccuracy` instead)
-- `paymentMethod.all` (use `billing.retrievePaymentMethods` instead)
-- `shipment.getSmartrates` (use `shipment.smartrates` instead)
-- String overload for `shipment.lowestSmartRate`, 3rd param requires a valid `SmartrateAccuracy`
-- `user.apiKeys` (use `apiKey.retrieveApiKeysForUser` instead)
-- `utilities.getLowestSmartRate` (use `utilities.findLowestSmartrate` instead)
+The following functions have changed:
+
+- Removed deprecated functions
+  - `paymentMethod.all` (use `billing.retrievePaymentMethods` instead)
+  - `user.apiKeys` (use `apiKey.retrieveApiKeysForUser` instead)
+- Changed deprecated functions
+  - `shipment.lowestSmartRate` (3rd param expects a valid `SmartRateAccuracy`)
+  - `utilities.findLowestSmartRate` (3rd param expects a valid `SmartRateAccuracy`)
+- Renames
+  - `SmartrateAccuracy` is now `SmartRateAccuracy`
+  - `SmartrateCollection` is now `SmartRateCollection`
+  - `shipment.smartrates` is now `shipment.smartRates`
+  - `TimeInTransit.getBySmartrateAccuracy` is now `TimeInTransit.getSmartRateAccuracy`
 
 ## Upgrading from 6.x to 7.0
 
diff --git a/src/main/java/com/easypost/Constants.java b/src/main/java/com/easypost/Constants.java
@@ -5,8 +5,8 @@
 import com.easypost.model.AddressVerification;
 import com.easypost.model.AddressVerificationDeserializer;
 import com.easypost.model.ErrorDeserializer;
-import com.easypost.model.SmartrateCollection;
-import com.easypost.model.SmartrateCollectionDeserializer;
+import com.easypost.model.SmartRateCollection;
+import com.easypost.model.SmartRateCollectionDeserializer;
 import com.easypost.model.StatelessRate;
 import com.easypost.model.StatelessRateDeserializer;
 import com.easypost.model.Webhook;
@@ -24,21 +24,17 @@ public abstract class Constants {
     public static final String EASYPOST_SUPPORT_EMAIL = "support@easypost.com";
 
     public abstract static class ErrorMessages {
-        public static final String EXTERNAL_API_CALL_FAILED =
-                "Could not send card details to %s, please try again later";
+        public static final String EXTERNAL_API_CALL_FAILED = "Could not send card details to %s, please try again later";
         public static final String ENCODED_ERROR = "Encode error for %s";
         public static final String INVALID_API_KEY_TYPE = "Invalid API key type.";
         public static final String INVALID_PARAMETER = "Invalid parameter: %s.";
-        public static final String INVALID_PAYMENT =
-                "The chosen payment method is not a credit card. Please try again.";
+        public static final String INVALID_PAYMENT = "The chosen payment method is not a credit card. Please try again.";
         public static final String INVALID_WEBHOOK_SIGNATURE = "Webhook does not contain a valid HMAC signature.";
         public static final String MISSING_REQUIRED_PARAMETER = "Missing required parameter: %s.";
         public static final String NO_OBJECT_FOUND = "No %s found.";
-        public static final String NO_PAYMENT_METHODS =
-                "No payment methods are set up. Please add a payment method and try again.";
+        public static final String NO_PAYMENT_METHODS = "No payment methods are set up. Please add a payment method and try again.";
         public static final String API_DID_NOT_RETURN_ERROR_DETAILS = "API did not return error details.";
-        public static final String WEBHOOK_DOES_NOT_MATCH =
-                "Webhook received did not originate from EasyPost or had a webhook secret mismatch.";
+        public static final String WEBHOOK_DOES_NOT_MATCH = "Webhook received did not originate from EasyPost or had a webhook secret mismatch.";
 
         public static final String NO_MORE_PAGES_TO_RETRIEVE = "There are no more pages to retrieve.";
     }
@@ -62,16 +58,13 @@ public abstract static class ErrorCodes {
 
     public abstract static class CarrierAccountTypes {
         public static final List<String> CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_WORKFLOW = ImmutableList.of(
-            "FedexAccount", "FedexSmartpostAccount"
-        );
+                "FedexAccount", "FedexSmartpostAccount");
 
         public static final List<String> UPS_OAUTH_CARRIER_ACCOUNT_TYPES = ImmutableList.of(
-            "UpsAccount", "UpsMailInnovationsAccount", "UpsSurepostAccount"
-        );
+                "UpsAccount", "UpsMailInnovationsAccount", "UpsSurepostAccount");
 
         public static final List<String> CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_OAUTH = ImmutableList.of(
-            "AmazonShippingAccount"
-        );
+                "AmazonShippingAccount");
     }
 
     public abstract static class Http {
@@ -83,7 +76,7 @@ public abstract static class Http {
         public static final Gson GSON = new GsonBuilder()
                 .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
                 .registerTypeAdapter(HashMap.class, new HashMapSerializer())
-                .registerTypeAdapter(SmartrateCollection.class, new SmartrateCollectionDeserializer())
+                .registerTypeAdapter(SmartRateCollection.class, new SmartRateCollectionDeserializer())
                 .registerTypeAdapter(APIException.class, new ErrorDeserializer())
                 .registerTypeAdapter(AddressVerification.class, new AddressVerificationDeserializer())
                 .registerTypeAdapter(StatelessRate[].class, new StatelessRateDeserializer())
diff --git a/src/main/java/com/easypost/model/AddressVerificationDeserializer.java b/src/main/java/com/easypost/model/AddressVerificationDeserializer.java
@@ -18,11 +18,12 @@ public final class AddressVerificationDeserializer implements JsonDeserializer<A
      * @param typeOfT Type of the object to deserialize.
      * @param context Deserialization context.
      * @return Deserialized AddressVerification object.
-     * @throws JsonParseException if the JSON object is not a valid SmartrateCollection.
+     * @throws JsonParseException if the JSON object is not a valid
+     *                            SmartRateCollection.
      */
     @Override
     public AddressVerification deserialize(final JsonElement json, final Type typeOfT,
-    final JsonDeserializationContext context) throws JsonParseException {
+            final JsonDeserializationContext context) throws JsonParseException {
         JsonObject jo = json.getAsJsonObject();
 
         AddressVerification addressVerification = new AddressVerification();
diff --git a/src/main/java/com/easypost/model/ErrorDeserializer.java b/src/main/java/com/easypost/model/ErrorDeserializer.java
@@ -16,10 +16,11 @@
 
 public final class ErrorDeserializer implements JsonDeserializer<APIException> {
     /**
-     * Recursively traverse an error JSON element and its sub-element(s), and extracts all
+     * Recursively traverse an error JSON element and its sub-element(s), and
+     * extracts all
      * error string values found into the specified string list.
      *
-     * @param element the JSON element to traverse
+     * @param element      the JSON element to traverse
      * @param messagesList the list of strings to append found values to
      */
     private void traverseJsonElement(JsonElement element, ArrayList<String> messagesList) {
@@ -45,11 +46,12 @@ private void traverseJsonElement(JsonElement element, ArrayList<String> messages
      * @param typeOfT Type of the object to deserialize.
      * @param context Deserialization context.
      * @return Deserialized APIException object.
-     * @throws JsonParseException if the JSON object is not a valid SmartrateCollection.
+     * @throws JsonParseException if the JSON object is not a valid
+     *                            SmartRateCollection.
      */
     @Override
     public APIException deserialize(final JsonElement json, final Type typeOfT,
-                                       final JsonDeserializationContext context) throws JsonParseException {
+            final JsonDeserializationContext context) throws JsonParseException {
         JsonObject jo = json.getAsJsonObject();
 
         String message = null;
@@ -83,7 +85,6 @@ public APIException deserialize(final JsonElement json, final Type typeOfT,
         }
 
         JsonElement errorsAsJson = errorData.get("errors");
-        List<Object> errorList = new ArrayList<>();
         if (errorsAsJson != null) {
             JsonArray errorsAsArray = errorsAsJson.getAsJsonArray();
             for (JsonElement errorAsJson : errorsAsArray) {
@@ -106,13 +107,13 @@ public APIException deserialize(final JsonElement json, final Type typeOfT,
                         fieldError.setSuggestion(suggestion.getAsString());
                     }
 
-                    errorList.add(fieldError);
+                    errors.add(fieldError);
                 } else {
-                    errorList.add(errorAsJson.getAsString());
+                    errors.add(errorAsJson.getAsString());
                 }
             }
         }
 
-        return new APIException(message, code, errorList);
+        return new APIException(message, code, errors);
     }
 }
diff --git a/src/main/java/com/easypost/model/SmartRateAccuracy.java b/src/main/java/com/easypost/model/SmartRateAccuracy.java
@@ -6,7 +6,7 @@
 import lombok.Getter;
 
 @Getter
-public enum SmartrateAccuracy {
+public enum SmartRateAccuracy {
     Percentile50("percentile_50"),
     Percentile75("percentile_75"),
     Percentile85("percentile_85"),
@@ -22,7 +22,7 @@ public enum SmartrateAccuracy {
      *
      * @param keyName the internal key name
      */
-    SmartrateAccuracy(String keyName) {
+    SmartRateAccuracy(String keyName) {
         this.keyName = keyName;
     }
 
@@ -33,8 +33,8 @@ public enum SmartrateAccuracy {
      * @return the enum value
      * @throws EasyPostException if the key name is not found
      */
-    public static SmartrateAccuracy getByKeyName(String keyName) throws EasyPostException {
-        for (SmartrateAccuracy smartrateAccuracy : values()) {
+    public static SmartRateAccuracy getByKeyName(String keyName) throws EasyPostException {
+        for (SmartRateAccuracy smartrateAccuracy : values()) {
             if (smartrateAccuracy.getKeyName().equals(keyName)) {
                 return smartrateAccuracy;
             }
diff --git a/src/main/java/com/easypost/model/SmartRateCollection.java b/src/main/java/com/easypost/model/SmartRateCollection.java
@@ -0,0 +1,51 @@
+package com.easypost.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public final class SmartRateCollection {
+    private List<SmartRate> smartRates;
+
+    /**
+     * Get this SmartRateCollection's Smartrate objects.
+     *
+     * @return List of Smartrate objects.
+     */
+    public List<SmartRate> getSmartRates() {
+        return this.smartRates;
+    }
+
+    /**
+     * Set this SmartRateCollection's Smartrate objects.
+     *
+     * @param smartRates List of Smartrate objects.
+     */
+    public void setSmartrates(final List<SmartRate> smartRates) {
+        this.smartRates = smartRates;
+    }
+
+    /**
+     * Constructor.
+     */
+    public SmartRateCollection() {
+        this.smartRates = new ArrayList<SmartRate>();
+    }
+
+    /**
+     * Create a SmartRateCollection from a list of rates.
+     *
+     * @param smartRates List of Smartrate objects
+     */
+    public SmartRateCollection(final List<SmartRate> smartRates) {
+        setSmartrates(smartRates);
+    }
+
+    /**
+     * Add a SmartRate object to this SmartRateCollection.
+     *
+     * @param rate Rate object
+     */
+    public void addRate(final SmartRate rate) {
+        smartRates.add(rate);
+    }
+}
diff --git a/src/main/java/com/easypost/model/SmartRateCollectionDeserializer.java b/src/main/java/com/easypost/model/SmartRateCollectionDeserializer.java
@@ -8,27 +8,29 @@
 
 import java.lang.reflect.Type;
 
-public final class SmartrateCollectionDeserializer implements JsonDeserializer<SmartrateCollection> {
+public final class SmartRateCollectionDeserializer implements JsonDeserializer<SmartRateCollection> {
     /**
-     * Deserialize a SmartrateCollection from a JSON object.
+     * Deserialize a SmartRateCollection from a JSON object.
      *
      * @param json    JSON object to deserialize.
      * @param typeOfT Type of the object to deserialize.
      * @param context Deserialization context.
-     * @return Deserialized SmartrateCollection object.
-     * @throws JsonParseException if the JSON object is not a valid SmartrateCollection.
+     * @return Deserialized SmartRateCollection object.
+     * @throws JsonParseException if the JSON object is not a valid
+     *                            SmartRateCollection.
      */
     @Override
-    public SmartrateCollection deserialize(final JsonElement json, final Type typeOfT,
-                                           final JsonDeserializationContext context) throws JsonParseException {
-        SmartrateCollection smartrateCollection = new SmartrateCollection();
+    public SmartRateCollection deserialize(final JsonElement json, final Type typeOfT,
+            final JsonDeserializationContext context) throws JsonParseException {
+        SmartRateCollection smartrateCollection = new SmartRateCollection();
 
         JsonObject jo = (JsonObject) json;
         JsonElement results = jo.get("result");
 
         if (results == null || !results.isJsonArray()) {
             return smartrateCollection;
-            // return empty collection if "results" key does not exist or corresponding value is not an array
+            // return empty collection if "results" key does not exist or corresponding
+            // value is not an array
         }
         // the JsonDeserializationContext should have access to the other type adapters,
         // so we can tap into the RateDeserializer from here
diff --git a/src/main/java/com/easypost/model/SmartrateCollection.java b/src/main/java/com/easypost/model/SmartrateCollection.java
diff --git a/src/main/java/com/easypost/model/TimeInTransit.java b/src/main/java/com/easypost/model/TimeInTransit.java
@@ -27,11 +27,11 @@ public final class TimeInTransit {
     /**
      * Get the delivery accuracy of a specific percentile of this TimeInTransit.
      *
-     * @param accuracy the SmartrateAccuracy to find the corresponding accuracy for
+     * @param accuracy the SmartRateAccuracy to find the corresponding accuracy for
      * @return the delivery accuracy of the specified percentile
      * @throws EasyPostException when the percentile is not valid
      */
-    public int getBySmartrateAccuracy(SmartrateAccuracy accuracy) throws EasyPostException {
+    public int getSmartRateAccuracy(SmartRateAccuracy accuracy) throws EasyPostException {
         switch (accuracy) {
             case Percentile50:
                 return this.percentile50;
diff --git a/src/main/java/com/easypost/service/ShipmentService.java b/src/main/java/com/easypost/service/ShipmentService.java
diff --git a/src/main/java/com/easypost/utils/Utilities.java b/src/main/java/com/easypost/utils/Utilities.java
diff --git a/src/test/java/com/easypost/ShipmentTest.java b/src/test/java/com/easypost/ShipmentTest.java
