From 5bc0c7c1485c620aeac0c22d276e073f7c8ca9bb Mon Sep 17 00:00:00 2001 From: Jean-Pierre Portier Date: Mon, 20 Jan 2025 15:01:25 +0100 Subject: [PATCH] doc (Mailgun): Mailgun's javadoc --- .../sdk/domains/mailgun/MailgunService.java | 3 +-- .../mailgun/api/v1/MailgunService.java | 7 +++++-- .../domains/mailgun/api/v1/package-info.java | 7 +++++++ .../v1/emails/request/SendEmailRequest.java | 6 ++++++ .../v1/emails/request/package-info.java | 6 ++++++ .../v1/emails/response/package-info.java | 6 ++++++ .../sdk/domains/mailgun/package-info.java | 10 +++++----- .../domains/mailgun/api/v1/EmailsService.java | 19 +++++++++++++------ .../v1/emails/request/OverrideProperties.java | 6 +++++- .../SendEmailHtmlInTemplateRequest.java | 5 ++++- .../request/SendEmailHtmlInlineRequest.java | 2 +- .../emails/request/SendMimeEmailRequest.java | 5 ++++- .../v1/emails/request/TemplateProperties.java | 5 ++++- pom.xml | 9 +++++++++ 14 files changed, 76 insertions(+), 20 deletions(-) create mode 100644 client/src/main/com/sinch/sdk/domains/mailgun/api/v1/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/response/package-info.java diff --git a/client/src/main/com/sinch/sdk/domains/mailgun/MailgunService.java b/client/src/main/com/sinch/sdk/domains/mailgun/MailgunService.java index 6eabcc8d8..89595cb32 100644 --- 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 https://documentation.mailgun.com/docs/mailgun + * href="https://documentation.mailgun.com/docs/mailgun/user-manual/get-started">https://documentation.mailgun.com/docs/mailgun/user-manual/get-started/ * @since __TO_BE_DEFINED__ */ public interface MailgunService { @@ -13,7 +13,6 @@ public interface MailgunService { * Mailgun Service V1 * * @return V1 service instance for project - * @see __TO_BE_DEFINED__ * @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 index ccbfc89b1..b9920530e 100644 --- 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 __TO_BE_DEFINED__ + * @see https://documentation.mailgun.com/docs/mailgun * @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 Messages + * API documentation */ 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 new file mode 100644 index 000000000..2554fe720 --- /dev/null +++ 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 Mailgun + * @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 index 9352023fb..a9812db69 100644 --- 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 new file mode 100644 index 000000000..ee4ebd10e --- /dev/null +++ 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 new file mode 100644 index 000000000..0cb9146ad --- /dev/null +++ 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 index 72e861bcb..c2c30bb98 100644 --- 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 * - *

The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS, - * WhatsApp, Viber Business, Facebook Messenger and other popular channels. + *

The Mailgun API is part of the Sinch family and enables you to send, track, and receive email + * effortlessly * * @see https://developers.sinch.com/docs/conversation - * @since 1.3 + * href="https://documentation.mailgun.com/docs/mailgun">https://documentation.mailgun.com/docs/mailgun + * @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 index 698b5ac7c..4ec99fefc 100644 --- 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's - * region. e.g. ... The storage - * hosts are `storage-us-east4.api.mailgun.net`, - * `storage-us-west1.api.mailgun.net`, and - * `storage-europe-west1.api.mailgun.net`. + * domain queue. + * + *

This endpoint must be called on the storage API host and in the domain's region. e.g. + * https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes. + * + *

The storage hosts are + * + *

* * @param domainName The name of the domain you want to delete envelope from (required) * @param storageURL (required) diff --git a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/OverrideProperties.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/OverrideProperties.java index 92558a3ca..1a834a675 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/OverrideProperties.java +++ b/openapi-contracts/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 Passing + * Sending Options + */ public interface OverrideProperties { /** diff --git a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInTemplateRequest.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInTemplateRequest.java index b6660380d..d23ac88f0 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInTemplateRequest.java +++ b/openapi-contracts/src/main/com/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 Templates + */ public interface SendEmailHtmlInTemplateRequest extends SendEmailRequest { /** diff --git a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInlineRequest.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInlineRequest.java index 011490c80..c0ce77dc2 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendEmailHtmlInlineRequest.java +++ b/openapi-contracts/src/main/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/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendMimeEmailRequest.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendMimeEmailRequest.java index ce365a91f..dfe1d19c3 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/SendMimeEmailRequest.java +++ b/openapi-contracts/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/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/TemplateProperties.java b/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/TemplateProperties.java index afb64b3a8..81d330b55 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/mailgun/models/v1/emails/request/TemplateProperties.java +++ b/openapi-contracts/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 & variables + */ public interface TemplateProperties { /** diff --git a/pom.xml b/pom.xml index 73ec18153..b783b0c11 100644 --- 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 @@ **/*Impl.java **/BuildersDelegation.java **/*Mapper.java + + **/mailgun/models/v1/response/GenericResponse.java + com/sinch/sdk/domains/verification/models/*.java com/sinch/sdk/domains/verification/VerificationsService.java @@ -203,6 +208,10 @@ Conversation com.sinch.sdk.domains.conversation* + + Mailgun + com.sinch.sdk.domains.mailgun* + Numbers com.sinch.sdk.domains.numbers*