Added Log API

Author: mdmytrash

CHANGELOG.md

@@ -5,6 +5,11 @@ All _notable_ changes to this project will be documented in this file.
 The format is based on _[Keep a Changelog][keepachangelog]_, and this project
 adheres to _[Semantic Versioning][semver]_.
 
+## [2.1.0] (released: 2025-08-26)
+### Updated
+- Added Log API
+- Updated unit tests
+
 ## [2.0.0] (released: 2025-06-11)
 ### Updated
 - Added unit tests and updated existing
@@ -91,6 +96,7 @@ adheres to _[Semantic Versioning][semver]_.
 - Import a list of complaints from CSV file API
 - Add Import a list of bounces from CSV file API
 
+[2.1.0]: https://github.com/mailgun/mailgun-java/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/mailgun/mailgun-java/compare/v1.1.6...v2.0.0
 [1.1.6]: https://github.com/mailgun/mailgun-java/compare/v1.1.5...v1.1.6
 [1.1.5]: https://github.com/mailgun/mailgun-java/compare/v1.1.4...v1.1.5

README.md

@@ -76,7 +76,7 @@ Add the following to your `pom.xml`:
   <dependency>
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>2.0.0</version>
+    <version>2.1.0</version>
   </dependency>
   ...
 </dependencies>
@@ -85,7 +85,7 @@ Add the following to your `pom.xml`:
 Gradle Groovy DSL .
 
 ```xml
-implementation 'com.mailgun:mailgun-java:2.0.0'
+implementation 'com.mailgun:mailgun-java:2.1.0'
 ```
 
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>2.0.0</version>
+    <version>2.1.0</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>
@@ -97,6 +97,12 @@
             <version>${slf4j.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.skyscreamer</groupId>
+            <artifactId>jsonassert</artifactId>
+            <version>1.5.0</version>
+        </dependency>
+
         <!-- TESTS -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>

src/main/java/com/mailgun/api/v1/MailgunLogsApi.java

@@ -0,0 +1,45 @@
+package com.mailgun.api.v1;
+
+import com.mailgun.api.MailgunApi;
+import com.mailgun.enums.ApiVersion;
+import com.mailgun.model.logs.LogsRequest;
+import com.mailgun.model.logs.LogsResponse;
+
+import feign.Headers;
+import feign.RequestLine;
+
+/**
+ * <p>
+ * This API endpoint is logs service.
+ * </p>
+ * <p>
+ * Mailgun keeps track of every inbound and outbound message event and stores this log data.
+ * This data can be queried and filtered to provide insights into the health of your email infrastructure.
+ * </p>
+ *
+ * @see <a href="https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs">Work with Logs</a>
+ */
+@Headers({"Accept: application/json", "Content-Type: application/json"})
+public interface MailgunLogsApi extends MailgunApi {
+
+    static ApiVersion getApiVersion() {
+        return ApiVersion.V_1;
+    }
+
+    /**
+     * <p>
+     * Gets filtered logs for an account.
+     * </p>
+     * <p>
+     * Returns a collection of logs and aggregated statistics about your email activities.
+     * The response contains a paginated collection of individual records and a metrics object
+     * with aggregated statistics for events specified in the request.
+     * </p>
+     *
+     * @param logsRequest {@link LogsRequest} Request parameters to filter the logs
+     * @return {@link LogsResponse} Response containing logs and aggregated statistics
+     */
+    @RequestLine("POST /analytics/logs")
+    LogsResponse getLogs(LogsRequest logsRequest);
+
+}

src/main/java/com/mailgun/model/metrics/MetricsFilter.java renamed to src/main/java/com/mailgun/model/Filter.java

@@ -1,4 +1,4 @@
-package com.mailgun.model.metrics;
+package com.mailgun.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -11,16 +11,14 @@
 
 /**
  * <p>
- * Metric filter.
+ * Filter.
  * </p>
- *
- * @see <a href="https://documentation.mailgun.com/en/latest/api-stats.html#metrics">Metrics</a>
  */
 @Value
 @Builder
 @Jacksonized
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class MetricsFilter {
+public class Filter {
 
     /**
      * <p>

src/main/java/com/mailgun/model/metrics/FilterItem.java renamed to src/main/java/com/mailgun/model/FilterItem.java

@@ -1,4 +1,4 @@
-package com.mailgun.model.metrics;
+package com.mailgun.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 

src/main/java/com/mailgun/model/Paging.java

@@ -45,4 +45,11 @@ public class Paging {
      */
     String previous;
 
+    /**
+     * <p>
+     * Total number of items
+     * </p>
+     */
+    Long total;
+
 }

src/main/java/com/mailgun/model/logs/ItemAccount.java

@@ -0,0 +1,26 @@
+package com.mailgun.model.logs;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import lombok.Builder;
+import lombok.Value;
+import lombok.extern.jackson.Jacksonized;
+
+/**
+ * <p>
+ * Account information in logs response.
+ * </p>
+ * @see <a href="https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs#logs/post-v1-analytics-logs/t=response&c=200&path=items/account">Iteam account</a>
+ */
+@Value
+@Builder
+@Jacksonized
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ItemAccount {
+
+    String id;
+
+    @JsonProperty("parent-id")
+    String parentId;
+}

src/main/java/com/mailgun/model/logs/ItemCampaign.java

@@ -0,0 +1,25 @@
+package com.mailgun.model.logs;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+import lombok.Builder;
+import lombok.Value;
+import lombok.extern.jackson.Jacksonized;
+
+/**
+ * <p>
+ * Logs pagination.
+ * </p>
+ *
+ * @see <a href="https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs#logs/post-v1-analytics-logs/t=response&c=200&path=items/campaigns">Logs item campaigns</a>
+ */
+@Value
+@Builder
+@Jacksonized
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ItemCampaign {
+
+    String id;
+
+    String name;
+}

src/main/java/com/mailgun/model/logs/ItemClientInfo.java

@@ -0,0 +1,40 @@
+package com.mailgun.model.logs;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import lombok.Builder;
+import lombok.Value;
+import lombok.extern.jackson.Jacksonized;
+
+/**
+ * <p>
+ * Client information in logs response.
+ * </p>
+ *
+ * @see <a href="https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs#logs/post-v1-analytics-logs/t=response&c=200&path=items/client-info">Logs client info</a>
+ */
+@Value
+@Builder
+@Jacksonized
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ItemClientInfo {
+
+    @JsonProperty("client-name")
+    String clientName;
+
+    @JsonProperty("client-os")
+    String clientOs;
+
+    @JsonProperty("client-type")
+    String clientType;
+
+    @JsonProperty("device-type")
+    String deviceType;
+
+    @JsonProperty("user-agent")
+    String userAgent;
+
+    String ip;
+    String bot;
+}