Javadoc improvements (#1556)

* Add javadoc

* Remove unused

Author: gcatanese

src/main/java/com/adyen/constants/ErrorTypeCodes.java

@@ -30,11 +30,22 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-/** NotificationRequest model class */
+/**
+ * NotificationRequest model class
+ * This class represents the payload of the Adyen webhooks related to Payments
+ **/
 public class NotificationRequest {
+
+  /**
+   * True when the event happened on the 'live' environment, false when it happened on 'test'
+   */
   @SerializedName("live")
   private String live = null;
 
+  /**
+   * List of NotificationRequestItem that includes only one NotificationRequestItem
+   * Developers should always fetch the first (and only) NotificationRequestItem
+   */
   @SerializedName("notificationItems")
   private List<NotificationRequestItemContainer> notificationItemContainers = null;
 

src/main/java/com/adyen/model/notification/NotificationRequest.java

@@ -20,7 +20,10 @@
 import java.util.List;
 import java.util.Map;
 
-/** NotificationRequestItem model class */
+/**
+ * NotificationRequestItem model class
+ * This class represents the NotificationRequestItem object that includes the information about the webhook event.
+ **/
 public class NotificationRequestItem {
 
   // Standard Event codes
@@ -74,18 +77,33 @@ public class NotificationRequestItem {
   public static final String EVENT_CODE_MANUAL_REVIEW_ACCEPT = "MANUAL_REVIEW_ACCEPT";
   public static final String EVENT_CODE_MANUAL_REVIEW_REJECT = "MANUAL_REVIEW_REJECT";
 
+  /**
+   * The payment amount. For HTTP POST notifications, currency and value are returned as URL parameters.
+   */
   @SerializedName("amount")
   private Amount amount = null;
 
+  /**
+   * The type of event the notification item is for.
+   */
   @SerializedName("eventCode")
   private String eventCode = null;
 
+  /**
+   * The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD
+   */
   @SerializedName("eventDate")
   private Date eventDate = null;
 
+  /**
+   * The merchant account identifier used in the transaction the notification item is for.
+   */
   @SerializedName("merchantAccountCode")
   private String merchantAccountCode = null;
 
+  /**
+   * Your reference to uniquely identify the payment.
+   */
   @SerializedName("merchantReference")
   private String merchantReference = null;
 
@@ -95,21 +113,42 @@ public class NotificationRequestItem {
   @SerializedName("originalPsp")
   private String originalPsp = null;
 
+  /**
+   * Adyen's 16-character unique reference associated with the transaction or request.
+   * This value is globally unique. Use it when communicating with us about this request.
+   */
   @SerializedName("pspReference")
   private String pspReference = null;
 
+  /**
+   * If success = true and paymentMethod = visa, mc, or amex then this field contains the following details:
+   * Authorisation code, last 4 digits of the card, card expiry date. In case of failure, this contains information
+   * about the authorisation failure
+   */
   @SerializedName("reason")
   private String reason = null;
 
+  /**
+   * If true: The payment request was successful. If false: The payment request failed. Check the reason field for failure information.
+   */
   @SerializedName("success")
   private boolean success;
 
+  /**
+   * The payment method used in the transaction.
+   */
   @SerializedName("paymentMethod")
   private String paymentMethod;
 
+  /**
+   * The operations indicate the supported follow-up actions concerning the payment.
+   */
   @SerializedName("operations")
   private List<String> operations;
 
+  /**
+   * This object is a generic container that can hold extra fields.
+   */
   @SerializedName("additionalData")
   private Map<String, String> additionalData = null;
 

src/main/java/com/adyen/model/notification/NotificationRequestItem.java

@@ -24,13 +24,16 @@
 import com.google.gson.annotations.SerializedName;
 import java.util.Objects;
 
-/** Terminal API Request */
+/**
+ * TerminalAPIRequest model class
+ * This class represents the payload of the Adyen webhooks related to the Terminal API
+ **/
 public class TerminalAPIRequest {
   @SerializedName("SaleToPOIRequest")
   private SaleToPOIRequest saleToPOIRequest;
 
   /**
-   * Gets sale to POI request.
+   * Gets saleToPOIRequest.
    *
    * @return the sale to POI request
    */
@@ -39,7 +42,7 @@ public SaleToPOIRequest getSaleToPOIRequest() {
   }
 
   /**
-   * Sets sale to POI request.
+   * Sets saleToPOIRequest.
    *
    * @param saleToPOIRequest the sale to POI request
    */

src/main/java/com/adyen/model/terminal/TerminalAPIRequest.java

@@ -28,24 +28,51 @@
 import com.google.gson.reflect.TypeToken;
 import java.io.IOException;
 
-/** Notification converter */
+
+/**
+ * Handler for Adyen webhooks.
+ * It provides methods to parse incoming JSON webhook payloads into Java objects.
+ */
 public class WebhookHandler {
-  private static final Gson GSON = new Gson();
   private final Gson terminalGson;
 
+  /**
+   * Initializes a new instance of the {@link WebhookHandler}.
+   */
   public WebhookHandler() {
     terminalGson = TerminalAPIGsonBuilder.create();
   }
 
+  /**
+   * Deserializes a JSON string into a {@link NotificationRequest} object.
+   * This method uses Gson for deserialization.
+   *
+   * @param json The JSON string to deserialize.
+   * @return The deserialized {@link NotificationRequest}.
+   * @throws IOException if the JSON string cannot be deserialized.
+   */
   public NotificationRequest handleNotificationJson(String json) throws IOException {
     return NotificationRequest.fromJson(json);
   }
 
+  /**
+   * Deserializes a JSON string into a {@link NotificationRequest} object using Jackson.
+   *
+   * @param json The JSON string to deserialize.
+   * @return The deserialized {@link NotificationRequest}.
+   * @throws IOException if the JSON string cannot be deserialized.
+   */
   public NotificationRequest handleNotificationJsonJackson(String json) throws IOException {
     return JSON.getMapper().readValue(json, NotificationRequest.class);
   }
 
-  // Note that terminal notifications are structured as TerminalAPIRequest objects
+  /**
+   * Deserializes a terminal notification JSON string into a {@link TerminalAPIRequest} object.
+   * Note that terminal notifications are structured as {@link TerminalAPIRequest} objects.
+   *
+   * @param json The JSON string to deserialize.
+   * @return The deserialized {@link TerminalAPIRequest}.
+   */
   public TerminalAPIRequest handleTerminalNotificationJson(String json) {
     return terminalGson.fromJson(json, new TypeToken<TerminalAPIRequest>() {}.getType());
   }