updates javadocs, adds SentMessageStatus

Author: sdiakovskyi-gd

src/main/java/com/mailjet/client/transactional/SendContact.java

@@ -4,7 +4,7 @@ public class SendContact {
     /**
      * Represents an object with email and name (optional) that can be used as To, Cc, Bcc, From etc
      * @param email email address
-     * @param name the display name of the person (Will be displayed in email like NAME < EMAIL >
+     * @param name the display name of the person (Will be displayed in email like {@code NAME <EMAIL>}
      */
     public SendContact(String email, String name) {
         this(email);

src/main/java/com/mailjet/client/transactional/response/EmailResult.java

@@ -16,6 +16,7 @@ public class EmailResult {
 
     /**
      * Unique numeric ID of this message.
+     * With this ID, you can get the message information through /messages/ API endpoint
      */
     private long messageID;
 

src/main/java/com/mailjet/client/transactional/response/MessageResult.java

@@ -9,16 +9,14 @@ public class MessageResult {
 
     /**
      * Indicates the sending status of the message.
-     * Possible values:
-     * success
-     * error
      */
-    private String status;
+    private SentMessageStatus status;
 
     /**
      * List containing information about any errors with the processing of this message.
-     * Will be displayed only if processing errors occur.
+     * Will be filled in only if processing errors occur.
      * Each error will generate a separate error object with the below properties.
+     * null if the message sent successfully
      */
     private SendEmailError[] errors;
 

src/main/java/com/mailjet/client/transactional/response/SentMessageStatus.java

@@ -0,0 +1,11 @@
+package com.mailjet.client.transactional.response;
+
+import com.google.gson.annotations.SerializedName;
+
+public enum SentMessageStatus {
+    @SerializedName("success")
+    SUCCESS,
+
+    @SerializedName("error")
+    ERROR
+}

src/test/java/com/mailjet/client/TransactionalEmailBuilderIT.java

@@ -3,7 +3,9 @@
 import com.mailjet.client.errors.MailjetException;
 import com.mailjet.client.transactional.*;
 import com.mailjet.client.transactional.response.MessageResult;
+import com.mailjet.client.transactional.response.SendEmailError;
 import com.mailjet.client.transactional.response.SendEmailsResponse;
+import com.mailjet.client.transactional.response.SentMessageStatus;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
@@ -56,7 +58,7 @@ public void SendEmailsRequest_SendsMessage() throws MailjetException, IOExceptio
 
         MessageResult messageResult = response.getMessages()[0];
 
-        Assert.assertEquals("success", messageResult.getStatus());
+        Assert.assertEquals(SentMessageStatus.SUCCESS, messageResult.getStatus());
         Assert.assertEquals("custom-id-value", messageResult.getCustomID());
     }
 
@@ -84,10 +86,12 @@ public void SendEmailsRequest_InvalidToField_ReturnsAnError() throws MailjetExce
 
         MessageResult messageResult = response.getMessages()[0];
 
-        Assert.assertEquals("error", messageResult.getStatus());
-        Assert.assertEquals("mj-0013", messageResult.getErrors()[0].getErrorCode());
-        Assert.assertEquals(400, messageResult.getErrors()[0].getStatusCode());
-        Assert.assertEquals("\"invalid-email\" is an invalid email address.", messageResult.getErrors()[0].getErrorMessage());
-        Assert.assertEquals("To[0].Email", messageResult.getErrors()[0].getErrorRelatedTo()[0]);
+        Assert.assertEquals(SentMessageStatus.ERROR, messageResult.getStatus());
+        SendEmailError error = messageResult.getErrors()[0];
+
+        Assert.assertEquals("mj-0013", error.getErrorCode());
+        Assert.assertEquals(400, error.getStatusCode());
+        Assert.assertEquals("\"invalid-email\" is an invalid email address.", error.getErrorMessage());
+        Assert.assertEquals("To[0].Email", error.getErrorRelatedTo()[0]);
     }
 }