feat: deserialize alternative format errors

Justintime50 · Justintime50 · commit 94365cf348f5 · 2025-02-25T10:49:36.000-07:00
diff --git a/src/main/java/com/easypost/exception/API/BadRequestError.java b/src/main/java/com/easypost/exception/API/BadRequestError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class BadRequestError extends APIException {
@@ -14,7 +12,7 @@ public class BadRequestError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public BadRequestError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public BadRequestError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/ForbiddenError.java b/src/main/java/com/easypost/exception/API/ForbiddenError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class ForbiddenError extends APIException {
@@ -14,7 +12,7 @@ public class ForbiddenError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public ForbiddenError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public ForbiddenError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/GatewayTimeoutError.java b/src/main/java/com/easypost/exception/API/GatewayTimeoutError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class GatewayTimeoutError extends APIException {
@@ -14,7 +12,7 @@ public class GatewayTimeoutError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public GatewayTimeoutError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public GatewayTimeoutError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/InternalServerError.java b/src/main/java/com/easypost/exception/API/InternalServerError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class InternalServerError extends APIException {
@@ -14,7 +12,7 @@ public class InternalServerError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public InternalServerError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public InternalServerError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/InvalidRequestError.java b/src/main/java/com/easypost/exception/API/InvalidRequestError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class InvalidRequestError extends APIException {
@@ -14,7 +12,7 @@ public class InvalidRequestError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public InvalidRequestError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public InvalidRequestError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/MethodNotAllowedError.java b/src/main/java/com/easypost/exception/API/MethodNotAllowedError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class MethodNotAllowedError extends APIException {
@@ -14,7 +12,7 @@ public class MethodNotAllowedError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public MethodNotAllowedError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public MethodNotAllowedError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/NotFoundError.java b/src/main/java/com/easypost/exception/API/NotFoundError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class NotFoundError extends APIException {
@@ -14,7 +12,7 @@ public class NotFoundError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public NotFoundError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public NotFoundError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/PaymentError.java b/src/main/java/com/easypost/exception/API/PaymentError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class PaymentError extends APIException {
@@ -14,7 +12,7 @@ public class PaymentError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public PaymentError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public PaymentError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/RateLimitError.java b/src/main/java/com/easypost/exception/API/RateLimitError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class RateLimitError extends APIException {
@@ -14,7 +12,7 @@ public class RateLimitError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public RateLimitError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public RateLimitError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/RedirectError.java b/src/main/java/com/easypost/exception/API/RedirectError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class RedirectError extends APIException {
@@ -14,7 +12,7 @@ public class RedirectError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public RedirectError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public RedirectError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/ServiceUnavailableError.java b/src/main/java/com/easypost/exception/API/ServiceUnavailableError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class ServiceUnavailableError extends APIException {
@@ -14,7 +12,7 @@ public class ServiceUnavailableError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public ServiceUnavailableError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public ServiceUnavailableError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/TimeoutError.java b/src/main/java/com/easypost/exception/API/TimeoutError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class TimeoutError extends APIException {
@@ -14,7 +12,7 @@ public class TimeoutError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public TimeoutError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public TimeoutError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/UnauthorizedError.java b/src/main/java/com/easypost/exception/API/UnauthorizedError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class UnauthorizedError extends APIException {
@@ -14,7 +12,7 @@ public class UnauthorizedError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public UnauthorizedError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public UnauthorizedError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/API/UnknownApiError.java b/src/main/java/com/easypost/exception/API/UnknownApiError.java
@@ -1,8 +1,6 @@
 package com.easypost.exception.API;
 
-import java.util.List;
-
-import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.exception.APIException;
 
 public class UnknownApiError extends APIException {
@@ -14,7 +12,7 @@ public class UnknownApiError extends APIException {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public UnknownApiError(final String message, final String code, final int statusCode, List<Error> errors) {
+    public UnknownApiError(final String message, final String code, final int statusCode, FieldErrorOrStringList errors) {
         super(message, code, statusCode, errors);
     }
 }
diff --git a/src/main/java/com/easypost/exception/APIException.java b/src/main/java/com/easypost/exception/APIException.java
@@ -1,23 +1,14 @@
-/**
- * APIException.java
- * This file is a part of EasyPost API SDK.
- * (c) 2022 EasyPost
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 package com.easypost.exception;
 
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.model.Error;
 
-import java.util.List;
-
 public class APIException extends EasyPostException {
     private static final long serialVersionUID = 1L;
     private final String code;
     private final Integer statusCode;
     private final String message;
-    private final List<Error> errors;
+    private final FieldErrorOrStringList errors;
 
     /**
      * APIException constructor.
@@ -46,7 +37,7 @@ public APIException(final String message, final Throwable ex) {
      * @param statusCode the exception status code
      * @param errors     the errors array
      */
-    public APIException(final String message, final String code, final int statusCode, final List<Error> errors) {
+    public APIException(final String message, final String code, final int statusCode, final FieldErrorOrStringList errors) {
         this(message, code, statusCode, errors, null);
     }
 
@@ -60,7 +51,7 @@ public APIException(final String message, final String code, final int statusCod
      * @param ex         the exception cause
      */
     public APIException(final String message, final String code, final Integer statusCode,
-        final List<Error> errors, final Throwable ex) {
+        final FieldErrorOrStringList errors, final Throwable ex) {
         super(message);
         this.code = code;
         this.statusCode = statusCode;
@@ -101,7 +92,7 @@ public String getMessage() {
      *
      * @return errors of the exception
      */
-    public List<Error> getErrors() {
+    public FieldErrorOrStringList getErrors() {
         return errors;
     }
 }
diff --git a/src/main/java/com/easypost/exception/EasyPostException.java b/src/main/java/com/easypost/exception/EasyPostException.java
@@ -1,11 +1,3 @@
-/**
- * EasyPostException.java
- * This file is a part of EasyPost API SDK.
- * (c) 2022 EasyPost
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 package com.easypost.exception;
 
 public class EasyPostException extends Exception {
diff --git a/src/main/java/com/easypost/http/EasyPostResponse.java b/src/main/java/com/easypost/http/EasyPostResponse.java
@@ -1,11 +1,3 @@
-/**
- * EasyPostResponse.java
- * This file is a part of EasyPost API SDK.
- * (c) 2022 EasyPost
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 package com.easypost.http;
 
 import lombok.Getter;
diff --git a/src/main/java/com/easypost/http/Requestor.java b/src/main/java/com/easypost/http/Requestor.java
@@ -1,11 +1,3 @@
-/**
- * EasyPostResource.java
- * This file is a part of EasyPost API SDK.
- * (c) 2022 EasyPost
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 package com.easypost.http;
 
 import com.easypost.Constants;
@@ -32,6 +24,7 @@
 import com.easypost.hooks.ResponseHookResponses;
 import com.easypost.model.EasyPostResource;
 import com.easypost.model.Error;
+import com.easypost.model.FieldErrorOrStringList;
 import com.easypost.service.EasyPostClient;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
@@ -653,7 +646,7 @@ protected static void handleAPIError(String rBody, final int rCode)
         Error error = Constants.Http.GSON.fromJson(rBody, Error.class);
         String errorMessage = error.getMessage();
         String errorCode = error.getCode();
-        List<Error> errors = error.getErrors();
+        FieldErrorOrStringList errors = error.getErrors();
 
         if (rCode >= Constants.ErrorCodes.REDIRECT_CODE_BEGIN && rCode <= Constants.ErrorCodes.REDIRECT_CODE_END) {
             throw new RedirectError(errorMessage, errorCode, rCode, errors);
diff --git a/src/main/java/com/easypost/model/EasyPostResource.java b/src/main/java/com/easypost/model/EasyPostResource.java
@@ -1,11 +1,3 @@
-/**
- * EasyPostResource.java
- * This file is a part of EasyPost API SDK.
- * (c) 2022 EasyPost
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 package com.easypost.model;
 
 import java.util.Date;
diff --git a/src/main/java/com/easypost/model/Error.java b/src/main/java/com/easypost/model/Error.java
diff --git a/src/main/java/com/easypost/model/FieldError.java b/src/main/java/com/easypost/model/FieldError.java
diff --git a/src/main/java/com/easypost/model/FieldErrorOrStringList.java b/src/main/java/com/easypost/model/FieldErrorOrStringList.java
diff --git a/src/test/cassettes/error/error_alternative_format.json b/src/test/cassettes/error/error_alternative_format.json
diff --git a/src/test/java/com/easypost/ErrorTest.java b/src/test/java/com/easypost/ErrorTest.java
