Merge pull request #192 from sinch/DEVEXP-621-javadoc

Mailgun's javadoc
sinch · Jan 21, 2025 · 2918854 · 2918854
2 parents 8858761 + 5bc0c7c
commit 2918854
Show file tree

Hide file tree

Showing 14 changed files with 76 additions and 20 deletions.
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/MailgunService.java b/client/src/main/com/sinch/sdk/domains/mailgun/MailgunService.java
@@ -4,7 +4,7 @@
  * Mailgun Service
  *
  * @see <a
- *     href="https://documentation.mailgun.com/docs/mailgun/">https://documentation.mailgun.com/docs/mailgun</a>
+ *     href="https://documentation.mailgun.com/docs/mailgun/user-manual/get-started">https://documentation.mailgun.com/docs/mailgun/user-manual/get-started/</a>
  * @since __TO_BE_DEFINED__
  */
 public interface MailgunService {
@@ -13,7 +13,6 @@ public interface MailgunService {
    * Mailgun Service V1
    *
    * @return V1 service instance for project
-   * @see <a href="__TO_BE_DEFINED__">__TO_BE_DEFINED__</a>
    * @since __TO_BE_DEFINED__
    */
   com.sinch.sdk.domains.mailgun.api.v1.MailgunService v1();

diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/api/v1/MailgunService.java b/client/src/main/com/sinch/sdk/domains/mailgun/api/v1/MailgunService.java
@@ -3,7 +3,8 @@
 /**
  * Mailgun Service V1
  *
- * @see <a href="__TO_BE_DEFINED__">__TO_BE_DEFINED__</a>
+ * @see <a
+ *     href="https://documentation.mailgun.com/docs/mailgun">https://documentation.mailgun.com/docs/mailgun</a>
  * @since __TO_BE_DEFINED__
  */
 public interface MailgunService {
@@ -12,7 +13,9 @@ public interface MailgunService {
    * Emails Service instance
    *
    * @return service instance for project
-   * @since __TO_BE_DEFINED__
+   * @see <a
+   *     href="https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Messages/">Messages
+   *     API documentation</a>
    */
   EmailsService emails();
 }
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/api/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/mailgun/api/v1/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Mailgun API interface for V1 endpoints
+ *
+ * @see <a href="https://documentation.mailgun.com/docs/mailgun/api-reference">Mailgun</a>
+ * @since __TO_BE_DEFINED__
+ */
+package com.sinch.sdk.domains.mailgun.api.v1;
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailRequest.java b/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailRequest.java
@@ -1,3 +1,9 @@
 package com.sinch.sdk.domains.mailgun.models.v1.emails.request;
 
+/**
+ * Base class for all classes supported by SendEmail
+ *
+ * @see com.sinch.sdk.domains.mailgun.api.v1.EmailsService#sendEmail(String, SendEmailRequest)
+ * @since __TO_BE_DEFINED__
+ */
 public interface SendEmailRequest {}
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/package-info.java b/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Mailgun emails API requests related models
+ *
+ * @since __TO_BE_DEFINED__
+ */
+package com.sinch.sdk.domains.mailgun.models.v1.emails.request;
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/response/package-info.java b/client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/response/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Mailgun emails API response related models
+ *
+ * @since __TO_BE_DEFINED__
+ */
+package com.sinch.sdk.domains.mailgun.models.v1.emails.response;
diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/package-info.java b/client/src/main/com/sinch/sdk/domains/mailgun/package-info.java
@@ -1,11 +1,11 @@
 /**
- * Conversation API interface
+ * Mailgun API interface
  *
- * <p>The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS,
- * WhatsApp, Viber Business, Facebook Messenger and other popular channels.
+ * <p>The Mailgun API is part of the Sinch family and enables you to send, track, and receive email
+ * effortlessly
  *
  * @see <a
- *     href="https://developers.sinch.com/docs/conversation">https://developers.sinch.com/docs/conversation</a>
- * @since 1.3
+ *     href="https://documentation.mailgun.com/docs/mailgun">https://documentation.mailgun.com/docs/mailgun</a>
+ * @since __TO_BE_DEFINED__
  */
 package com.sinch.sdk.domains.mailgun;
diff --git a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/api/v1/EmailsService.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/api/v1/EmailsService.java
@@ -17,6 +17,7 @@
 import com.sinch.sdk.domains.mailgun.models.v1.emails.response.SendEmailResponse;
 import com.sinch.sdk.domains.mailgun.models.v1.emails.response.SendingQueuesStatusResponse;
 
+/** Emails Service */
 public interface EmailsService {
 
   /**
@@ -67,12 +68,18 @@ SendEmailResponse sendMimeEmail(String domainName, SendMimeEmailRequest requestP
 
   /**
    * Delete scheduled and undelivered mail Deletes all scheduled and undelivered mail from the
-   * domain queue. This endpoint must be called on the storage API host and in the domain&#39;s
-   * region. e.g. <a
-   * href="https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes">...</a> The storage
-   * hosts are &#x60;storage-us-east4.api.mailgun.net&#x60;,
-   * &#x60;storage-us-west1.api.mailgun.net&#x60;, and
-   * &#x60;storage-europe-west1.api.mailgun.net&#x60;.
+   * domain queue.
+   *
+   * <p>This endpoint must be called on the storage API host and in the domain&#39;s region. e.g.
+   * <code>https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes</code>.
+   *
+   * <p>The storage hosts are
+   *
+   * <ul>
+   *   <li><code>storage-us-east4.api.mailgun.net</code>
+   *   <li><code>storage-us-west1.api.mailgun.net</code>
+   *   <li><code>storage-europe-west1.api.mailgun.net</code>
+   * </ul>
    *
    * @param domainName The name of the domain you want to delete envelope from (required)
    * @param storageURL (required)

diff --git a/...s/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/OverrideProperties.java b/...s/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/OverrideProperties.java
@@ -13,7 +13,11 @@
 import java.time.Instant;
 import java.util.List;
 
-/** OverrideProperties */
+/**
+ * Per-message basis overload parameters. See <a
+ * href="https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/#passing-sending-options">Passing
+ * Sending Options</a>
+ */
 public interface OverrideProperties {
 
   /**

diff --git a/...om/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInTemplateRequest.java b/...om/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInTemplateRequest.java
@@ -16,7 +16,10 @@
 import java.util.List;
 import java.util.Map;
 
-/** SendEmailHtmlInTemplateRequest */
+/**
+ * Sending email message request. Use to send with HTML content built from template. See <a
+ * href="https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/#templates">Templates</a>
+ */
 public interface SendEmailHtmlInTemplateRequest extends SendEmailRequest {
 
   /**

diff --git a/...in/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInlineRequest.java b/...in/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInlineRequest.java
@@ -16,7 +16,7 @@
 import java.util.List;
 import java.util.Map;
 
-/** SendEmailHtmlInlineRequest */
+/** Sending email message request. Use to send with HTML content inline within message. */
 public interface SendEmailHtmlInlineRequest extends SendEmailRequest {
 
   /**

diff --git a/...src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendMimeEmailRequest.java b/...src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendMimeEmailRequest.java
@@ -16,7 +16,10 @@
 import java.util.List;
 import java.util.Map;
 
-/** SendMimeEmailRequest */
+/**
+ * Sending email message request. Build a MIME string yourself using a MIME library for your
+ * programming language and submit it to Mailgun.
+ */
 public interface SendMimeEmailRequest {
 
   /**

diff --git a/...s/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/TemplateProperties.java b/...s/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/TemplateProperties.java
@@ -12,7 +12,10 @@
 
 import java.util.Map;
 
-/** TemplateProperties */
+/**
+ * Template's related properties. Define template's related information &amp; <a
+ * href="https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/#template-variables">variables</a>
+ */
 public interface TemplateProperties {
 
   /**

diff --git a/pom.xml b/pom.xml
@@ -126,6 +126,8 @@
                             com.sinch.sdk.auth*;
                             com.sinch.sdk.core.http;
                             com.sinch.sdk.core.http.*;
+                            com.sinch.sdk.core.databind:
+                            com.sinch.sdk.core.databind.**;
                             com.sinch.sdk.core.utils.databind;
                             com.sinch.sdk.http;
                             com.sinch.sdk.pagination.Page*;
@@ -151,6 +153,9 @@
                             <sourceFileExclude>**/*Impl.java</sourceFileExclude>
                             <sourceFileExclude>**/BuildersDelegation.java</sourceFileExclude>
                             <sourceFileExclude>**/*Mapper.java</sourceFileExclude>
+
+                            <sourceFileExclude>**/mailgun/models/v1/response/GenericResponse.java</sourceFileExclude>
+
                             <!-- Transition period -->
                             <sourceFileExclude>com/sinch/sdk/domains/verification/models/*.java</sourceFileExclude>
                             <sourceFileExclude>com/sinch/sdk/domains/verification/VerificationsService.java</sourceFileExclude>
@@ -203,6 +208,10 @@
                                 <title>Conversation</title>
                                 <packages>com.sinch.sdk.domains.conversation*</packages>
                             </group>
+                            <group>
+                                <title>Mailgun</title>
+                                <packages>com.sinch.sdk.domains.mailgun*</packages>
+                            </group>
                             <group>
                                 <title>Numbers</title>
                                 <packages>com.sinch.sdk.domains.numbers*</packages>