Implemented Email Templates API

examples/java/io/mailtrap/examples/emailtemplates/EmailTemplates.java

@@ -0,0 +1,73 @@
+package io.mailtrap.examples.emailtemplates;
+
+import io.mailtrap.config.MailtrapConfig;
+import io.mailtrap.factory.MailtrapClientFactory;
+import io.mailtrap.model.request.emailtemplates.CreateEmailTemplateRequest;
+import io.mailtrap.model.request.emailtemplates.EmailTemplate;
+import io.mailtrap.model.request.emailtemplates.UpdateEmailTemplateRequest;
+import io.mailtrap.model.response.emailtemplates.EmailTemplateResponse;
+
+import java.util.List;
+
+public class EmailTemplates {
+
+  private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
+  private static final long ACCOUNT_ID = 1L;
+  private static final String EMAIL_TEMPLATE_NAME = "My Email Template";
+  private static final String EMAIL_TEMPLATE_CATEGORY = "Promotion";
+  private static final String EMAIL_TEMPLATE_SUBJECT = "Promotion Template subject";
+  private static final String EMAIL_TEMPLATE_BODY_TEXT = "Promotion Text body";
+  private static final String EMAIL_TEMPLATE_BODY_HTML = "<div>Promotion body</div>";
+  private static final String UPDATED_EMAIL_TEMPLATE_NAME = "My Updated Email Template";
+
+  public static void main(String[] args) {
+    final var config = new MailtrapConfig.Builder()
+        .token(TOKEN)
+        .build();
+
+    new EmailTemplate(EMAIL_TEMPLATE_NAME, EMAIL_TEMPLATE_CATEGORY, EMAIL_TEMPLATE_SUBJECT, EMAIL_TEMPLATE_BODY_TEXT, EMAIL_TEMPLATE_BODY_HTML);
+
+    final var client = MailtrapClientFactory.createMailtrapClient(config);
+
+    final var createRequest = new CreateEmailTemplateRequest(
+        new EmailTemplate(
+            EMAIL_TEMPLATE_NAME,
+            EMAIL_TEMPLATE_CATEGORY,
+            EMAIL_TEMPLATE_SUBJECT,
+            EMAIL_TEMPLATE_BODY_TEXT,
+            EMAIL_TEMPLATE_BODY_HTML
+        ));
+
+    final var createdEmailTemplate = client.emailTemplatesApi().emailTemplates()
+        .createEmailTemplate(ACCOUNT_ID, createRequest);
+
+    System.out.println(createdEmailTemplate);
+
+    final var allTemplates = client.emailTemplatesApi().emailTemplates()
+        .getAllTemplates(ACCOUNT_ID);
+
+    System.out.println(allTemplates);
+
+    final var emailTemplate = client.emailTemplatesApi().emailTemplates()
+        .getEmailTemplate(ACCOUNT_ID, createdEmailTemplate.getId());
+
+    System.out.println(emailTemplate);
+
+    final var updateRequest = new UpdateEmailTemplateRequest(
+        new EmailTemplate(
+            UPDATED_EMAIL_TEMPLATE_NAME,
+            EMAIL_TEMPLATE_CATEGORY,
+            EMAIL_TEMPLATE_SUBJECT,
+            EMAIL_TEMPLATE_BODY_TEXT,
+            EMAIL_TEMPLATE_BODY_HTML
+        ));
+
+    final var updatedEmailTemplate = client.emailTemplatesApi().emailTemplates()
+        .updateEmailTemplate(ACCOUNT_ID, createdEmailTemplate.getId(), updateRequest);
+
+    System.out.println(updatedEmailTemplate);
+
+    client.emailTemplatesApi().emailTemplates()
+        .deleteEmailTemplate(ACCOUNT_ID, updatedEmailTemplate.getId());
+  }
+}

src/main/java/io/mailtrap/api/emailtemplates/EmailTemplates.java

@@ -0,0 +1,55 @@
+package io.mailtrap.api.emailtemplates;
+
+import io.mailtrap.model.request.emailtemplates.CreateEmailTemplateRequest;
+import io.mailtrap.model.request.emailtemplates.UpdateEmailTemplateRequest;
+import io.mailtrap.model.response.emailtemplates.EmailTemplateResponse;
+
+import java.util.List;
+
+public interface EmailTemplates {
+
+  /**
+   * Get all email templates existing in your account
+   *
+   * @param accountId unique account ID
+   * @return list of existing email templates
+   */
+  List<EmailTemplateResponse> getAllTemplates(long accountId);
+
+  /**
+   * Create a new email template
+   *
+   * @param accountId unique account ID
+   * @param request   email template create payload
+   * @return created email template
+   */
+  EmailTemplateResponse createEmailTemplate(long accountId, CreateEmailTemplateRequest request);
+
+  /**
+   * Get an email template by ID
+   *
+   * @param accountId       unique account ID
+   * @param emailTemplateId unique email template ID
+   * @return email template attributes
+   */
+  EmailTemplateResponse getEmailTemplate(long accountId, long emailTemplateId);
+
+  /**
+   * Update an email template
+   *
+   * @param accountId       unique account ID
+   * @param emailTemplateId unique email template ID
+   * @param request         email template update payload
+   * @return updated email template
+   */
+  EmailTemplateResponse updateEmailTemplate(long accountId, long emailTemplateId, UpdateEmailTemplateRequest request);
+
+  /**
+   * Delete an email template
+   *
+   * @param accountId       unique account ID
+   * @param emailTemplateId unique email template ID
+   */
+  void deleteEmailTemplate(long accountId, long emailTemplateId);
+
+}

src/main/java/io/mailtrap/api/emailtemplates/EmailTemplatesImpl.java

@@ -0,0 +1,76 @@
+package io.mailtrap.api.emailtemplates;
+
+import io.mailtrap.Constants;
+import io.mailtrap.CustomValidator;
+import io.mailtrap.api.apiresource.ApiResourceWithValidation;
+import io.mailtrap.config.MailtrapConfig;
+import io.mailtrap.http.RequestData;
+import io.mailtrap.model.request.emailtemplates.CreateEmailTemplateRequest;
+import io.mailtrap.model.request.emailtemplates.UpdateEmailTemplateRequest;
+import io.mailtrap.model.response.emailtemplates.EmailTemplateResponse;
+
+import java.util.List;
+
+public class EmailTemplatesImpl extends ApiResourceWithValidation implements EmailTemplates {
+
+  public EmailTemplatesImpl(MailtrapConfig config, CustomValidator customValidator) {
+    super(config, customValidator);
+    this.apiHost = Constants.GENERAL_HOST;
+  }
+
+  @Override
+  public List<EmailTemplateResponse> getAllTemplates(long accountId) {
+    return
+        httpClient.getList(
+            String.format(apiHost + "/api/accounts/%d/email_templates", accountId),
+            new RequestData(),
+            EmailTemplateResponse.class
+        );
+  }
+
+  @Override
+  public EmailTemplateResponse createEmailTemplate(long accountId, CreateEmailTemplateRequest request) {
+    validateRequestBodyAndThrowException(request);
+
+    return
+        httpClient.post(
+            String.format(apiHost + "/api/accounts/%d/email_templates", accountId),
+            request,
+            new RequestData(),
+            EmailTemplateResponse.class
+        );
+  }
+
+  @Override
+  public EmailTemplateResponse getEmailTemplate(long accountId, long emailTemplateId) {
+    return
+        httpClient.get(
+            String.format(apiHost + "/api/accounts/%d/email_templates/%d", accountId, emailTemplateId),
+            new RequestData(),
+            EmailTemplateResponse.class
+        );
+  }
+
+  @Override
+  public EmailTemplateResponse updateEmailTemplate(long accountId, long emailTemplateId, UpdateEmailTemplateRequest request) {
+    validateRequestBodyAndThrowException(request);
+
+    return
+        httpClient.patch(
+            String.format(apiHost + "/api/accounts/%d/email_templates/%d", accountId, emailTemplateId),
+            request,
+            new RequestData(),
+            EmailTemplateResponse.class
+        );
+  }
+
+  @Override
+  public void deleteEmailTemplate(long accountId, long emailTemplateId) {
+    httpClient
+        .delete(
+            String.format(apiHost + "/api/accounts/%d/email_templates/%d", accountId, emailTemplateId),
+            new RequestData(),
+            Void.class
+        );
+  }
+}

src/main/java/io/mailtrap/client/MailtrapClient.java

@@ -48,6 +48,12 @@ public class MailtrapClient {
     @Getter
     private final MailtrapContactsApi contactsApi;
 
+    /**
+     * API for Mailtrap.io Email Templates management functionality
+     */
+    @Getter
+    private final MailtrapEmailTemplatesApi emailTemplatesApi;
+
     /**
      * Utility class which holds sending context (which API to use: Email Sending API, Bulk Sending API or
      * Email Testing API, inbox id for Email Testing API) to make it possible to perform send directly from MailtrapClient

src/main/java/io/mailtrap/client/api/MailtrapEmailTemplatesApi.java

@@ -0,0 +1,13 @@
+package io.mailtrap.client.api;
+
+import io.mailtrap.api.emailtemplates.EmailTemplates;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+
+@Getter
+@Accessors(fluent = true)
+@RequiredArgsConstructor
+public class MailtrapEmailTemplatesApi {
+  private final EmailTemplates emailTemplates;
+}

src/main/java/io/mailtrap/factory/MailtrapClientFactory.java

@@ -10,6 +10,7 @@
 import io.mailtrap.api.contactimports.ContactImportsImpl;
 import io.mailtrap.api.contactlists.ContactListsImpl;
 import io.mailtrap.api.contacts.ContactsImpl;
+import io.mailtrap.api.emailtemplates.EmailTemplatesImpl;
 import io.mailtrap.api.inboxes.InboxesImpl;
 import io.mailtrap.api.messages.MessagesImpl;
 import io.mailtrap.api.permissions.PermissionsImpl;
@@ -47,10 +48,11 @@ public static MailtrapClient createMailtrapClient(MailtrapConfig config) {
         final var bulkSendingApi = createBulkSendingApi(config, customValidator);
         final var generalApi = createGeneralApi(config);
         final var contactsApi = createContactsApi(config, customValidator);
+        final var emailTemplatesApi = createEmailTemplatesApi(config, customValidator);
 
         final var sendingContextHolder = configureSendingContext(config);
 
-        return new MailtrapClient(sendingApi, testingApi, bulkSendingApi, generalApi, contactsApi, sendingContextHolder);
+        return new MailtrapClient(sendingApi, testingApi, bulkSendingApi, generalApi, contactsApi, emailTemplatesApi, sendingContextHolder);
     }
 
     private static MailtrapContactsApi createContactsApi(MailtrapConfig config, CustomValidator customValidator) {
@@ -95,6 +97,12 @@ private static MailtrapBulkSendingApi createBulkSendingApi(MailtrapConfig config
         return new MailtrapBulkSendingApi(emails);
     }
 
+    private static MailtrapEmailTemplatesApi createEmailTemplatesApi(MailtrapConfig config, CustomValidator customValidator) {
+        final var emailTemplates = new EmailTemplatesImpl(config, customValidator);
+
+        return new MailtrapEmailTemplatesApi(emailTemplates);
+    }
+
     private static SendingContextHolder configureSendingContext(MailtrapConfig config) {
 
         return SendingContextHolder.builder()

src/main/java/io/mailtrap/model/request/emailtemplates/CreateEmailTemplateRequest.java

@@ -0,0 +1,19 @@
+package io.mailtrap.model.request.emailtemplates;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.mailtrap.model.AbstractModel;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class CreateEmailTemplateRequest extends AbstractModel {
+
+  @Valid
+  @NotNull
+  @JsonProperty("email_template")
+  private EmailTemplate emailTemplate;
+
+}

src/main/java/io/mailtrap/model/request/emailtemplates/EmailTemplate.java

@@ -0,0 +1,33 @@
+package io.mailtrap.model.request.emailtemplates;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
+@Data
+@AllArgsConstructor
+public class EmailTemplate {
+
+  @NotNull
+  @Size(min = 1, max = 255)
+  private String name;
+
+  @NotNull
+  @Size(min = 1, max = 255)
+  private String category;
+
+  @NotNull
+  @Size(min = 1, max = 255)
+  private String subject;
+
+  @Size(max = 10_000_000)
+  @JsonProperty("body_text")
+  private String bodyText;
+
+  @Size(max = 10_000_000)
+  @JsonProperty("body_html")
+  private String bodyHtml;
+
+}

src/main/java/io/mailtrap/model/request/emailtemplates/UpdateEmailTemplateRequest.java

@@ -0,0 +1,21 @@
+package io.mailtrap.model.request.emailtemplates;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.mailtrap.model.AbstractModel;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class UpdateEmailTemplateRequest extends AbstractModel {
+
+  @Valid
+  @NotNull
+  @JsonProperty("email_template")
+  private EmailTemplate emailTemplate;
+
+}

src/main/java/io/mailtrap/model/request/inboxes/CreateInboxRequest.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.mailtrap.model.AbstractModel;
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.Size;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @AllArgsConstructor
 public class CreateInboxRequest extends AbstractModel {
 
+    @Valid
     @JsonProperty("inbox")
     private InboxCreateData inboxCreateData;
 

src/main/java/io/mailtrap/model/request/inboxes/UpdateInboxRequest.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.mailtrap.model.AbstractModel;
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.Size;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @AllArgsConstructor
 public class UpdateInboxRequest extends AbstractModel {
 
+    @Valid
     @JsonProperty("inbox")
     private InboxUpdateData inboxUpdateData;