feat(api): support scheduled message delivery (#43)

Author: bjarn

src/main/java/co/lettermint/api/ApiClient.java

@@ -137,6 +137,14 @@ public MessageData retrieve(String messageId) {
             return client.get("/messages/" + segment(messageId), MessageData.class);
         }
 
+        public RescheduleMessageResponse reschedule(String messageId, RescheduleMessageRequest payload) {
+            return client.patch("/messages/" + segment(messageId), payload, RescheduleMessageResponse.class);
+        }
+
+        public RescheduleMessageResponse cancel(String messageId) {
+            return client.post("/messages/" + segment(messageId) + "/cancel", null, RescheduleMessageResponse.class);
+        }
+
         public MessageEventsResponse events(String messageId) {
             return events(messageId, null);
         }

src/main/java/co/lettermint/client/LettermintClient.java

@@ -111,6 +111,10 @@ public <T> T put(String path, Object payload, Class<T> responseClass) {
         return request("PUT", url(path, null), payload, responseClass, null, null);
     }
 
+    public <T> T patch(String path, Object payload, Class<T> responseClass) {
+        return request("PATCH", url(path, null), payload, responseClass, null, null);
+    }
+
     public <T> T delete(String path, Class<T> responseClass) {
         return request("DELETE", url(path, null), null, responseClass, null, null);
     }
@@ -148,6 +152,8 @@ private <T> T request(String method, String requestUrl, Object payload, Class<T>
             requestBuilder.post(body != null ? body : RequestBody.create(new byte[0], JSON));
         } else if ("PUT".equals(method)) {
             requestBuilder.put(body != null ? body : RequestBody.create(new byte[0], JSON));
+        } else if ("PATCH".equals(method)) {
+            requestBuilder.patch(body != null ? body : RequestBody.create(new byte[0], JSON));
         } else if ("DELETE".equals(method)) {
             requestBuilder.delete();
         } else {

src/main/java/co/lettermint/endpoints/EmailEndpoint.java

@@ -20,6 +20,7 @@ public class EmailEndpoint extends Endpoint {
     private List<String> bcc;
     private List<String> replyTo;
     private String subject;
+    private String scheduledAt;
     private String html;
     private String text;
     private Map<String, String> headers;
@@ -46,6 +47,7 @@ private void reset() {
         this.bcc = new ArrayList<>();
         this.replyTo = new ArrayList<>();
         this.subject = null;
+        this.scheduledAt = null;
         this.html = null;
         this.text = null;
         this.headers = new LinkedHashMap<>();
@@ -107,6 +109,12 @@ public EmailEndpoint subject(String subject) {
         return this;
     }
 
+    /** Set the requested delivery time for the email. */
+    public EmailEndpoint scheduledAt(String scheduledAt) {
+        this.scheduledAt = scheduledAt;
+        return this;
+    }
+
     /**
      * Set the HTML content of the email.
      */
@@ -296,6 +304,10 @@ private Map<String, Object> buildPayload() {
             payload.put("subject", subject);
         }
 
+        if (scheduledAt != null) {
+            payload.put("scheduled_at", scheduledAt);
+        }
+
         if (html != null) {
             payload.put("html", html);
         }

src/main/java/co/lettermint/models/api/MessageData.java

@@ -19,6 +19,9 @@ public class MessageData {
     @JsonProperty("status_changed_at")
     public String statusChangedAt;
 
+    @JsonProperty("scheduled_at")
+    public String scheduledAt;
+
     @JsonProperty("tag")
     public String tag;
 

src/main/java/co/lettermint/models/api/MessageEventType.java

@@ -1,6 +1,10 @@
 package co.lettermint.models.api;
 
 public final class MessageEventType {
+    public static final String SCHEDULED = "scheduled";
+    public static final String RESCHEDULED = "rescheduled";
+    public static final String CANCELED = "canceled";
+    public static final String RELEASED = "released";
     public static final String QUEUED = "queued";
     public static final String PROCESSED = "processed";
     public static final String SUPPRESSED = "suppressed";

src/main/java/co/lettermint/models/api/MessageListData.java

@@ -16,6 +16,9 @@ public class MessageListData {
     @JsonProperty("status")
     public String status;
 
+    @JsonProperty("scheduled_at")
+    public String scheduledAt;
+
     @JsonProperty("spam_score")
     public Double spamScore;
 

src/main/java/co/lettermint/models/api/MessageStatus.java

@@ -1,6 +1,7 @@
 package co.lettermint.models.api;
 
 public final class MessageStatus {
+    public static final String SCHEDULED = "scheduled";
     public static final String PENDING = "pending";
     public static final String QUEUED = "queued";
     public static final String SUPPRESSED = "suppressed";
@@ -15,6 +16,7 @@ public final class MessageStatus {
     public static final String BLOCKED = "blocked";
     public static final String POLICYREJECTED = "policy_rejected";
     public static final String UNSUBSCRIBED = "unsubscribed";
+    public static final String CANCELED = "canceled";
 
     private MessageStatus() {}
 }

src/main/java/co/lettermint/models/api/RescheduleMessageRequest.java

@@ -0,0 +1,10 @@
+package co.lettermint.models.api;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class RescheduleMessageRequest {
+    @JsonProperty("scheduled_at")
+    public String scheduledAt;
+}

src/main/java/co/lettermint/models/api/RescheduleMessageResponse.java

@@ -0,0 +1,16 @@
+package co.lettermint.models.api;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class RescheduleMessageResponse {
+    @JsonProperty("message_id")
+    public String messageId;
+
+    @JsonProperty("status")
+    public String status;
+
+    @JsonProperty("scheduled_at")
+    public String scheduledAt;
+}

src/main/java/co/lettermint/models/api/SendMailRequest.java

@@ -28,6 +28,9 @@ public class SendMailRequest {
     @JsonProperty("subject")
     public String subject;
 
+    @JsonProperty("scheduled_at")
+    public String scheduledAt;
+
     @JsonProperty("headers")
     public Map<String, String> headers;