refactor

Author: ma1581

src/main/java/com/meilisearch/sdk/Client.java

@@ -8,7 +8,8 @@
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.json.JsonHandler;
 import com.meilisearch.sdk.model.*;
-import com.meilisearch.sdk.model.batch_dto.Batch;
+import com.meilisearch.sdk.model.batch.req.BatchesQuery;
+import com.meilisearch.sdk.model.batch.res.Batch;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;

src/main/java/com/meilisearch/sdk/TasksHandler.java

@@ -4,7 +4,8 @@
 import com.meilisearch.sdk.exceptions.MeilisearchTimeoutException;
 import com.meilisearch.sdk.http.URLBuilder;
 import com.meilisearch.sdk.model.*;
-import com.meilisearch.sdk.model.batch_dto.Batch;
+import com.meilisearch.sdk.model.batch.req.BatchesQuery;
+import com.meilisearch.sdk.model.batch.res.Batch;
 import java.util.Date;
 
 /**
@@ -161,7 +162,7 @@ void waitForTask(int taskUid, int timeoutInMs, int intervalInMs) throws Meilisea
     }
 
     /**
-     * Retrieves a batch by its unique identifier.
+     * Retrieves a batch by uid.
      *
      * @param uid The unique identifier of the batch.
      * @return The Batch object corresponding to the given uid.
@@ -175,7 +176,7 @@ public Batch getBatch(int uid) {
      * Retrieves all batches based on the provided query parameters.
      *
      * @param batchesQuery An instance of BatchesQuery containing filtering criteria.
-     * @return A CursorResults object containing a list of Batch objects.
+     * @return A CursorResults object containing a paginated list of Batch objects.
      */
     public CursorResults<Batch> getAllBatches(BatchesQuery batchesQuery) {
         String urlPath = batchPath().addQuery(batchesQuery.toQuery()).getURL();
@@ -187,11 +188,7 @@ private URLBuilder tasksPath() {
         return new URLBuilder("/tasks");
     }
 
-    /**
-     * Constructs a URLBuilder instance for the "/batches" API endpoint.
-     *
-     * @return A URLBuilder object initialized with the "/batches" path.
-     */
+    /** Constructs a URLBuilder instance for the "/batches" API endpoint. */
     private URLBuilder batchPath() {
         return new URLBuilder("/batches");
     }

src/main/java/com/meilisearch/sdk/enums/OperationType.java

@@ -0,0 +1,46 @@
+package com.meilisearch.sdk.enums;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * Enum for Operation Type
+ *
+ * @see <a href="https://www.meilisearch.com/docs/reference/api/tasks#type">API specification</a>
+ */
+public enum OperationType {
+    @SerializedName("indexCreation")
+    INDEX_CREATION("indexCreation"),
+    @SerializedName("indexUpdate")
+    INDEX_UPDATE("indexUpdate"),
+    @SerializedName("indexDeletion")
+    INDEX_DELETE("indexDeletion"),
+    @SerializedName("indexSwap")
+    INDEX_SWAP("indexSwap"),
+    @SerializedName("documentAdditionOrUpdate")
+    DOCUMENT_UPSERT("documentAdditionOrUpdate"),
+    @SerializedName("documentDeletion")
+    DOCUMENT_DELETE("documentDeletion"),
+    @SerializedName("settingsUpdate")
+    SETTINGS_UPDATE("settingsUpdate"),
+    @SerializedName("dumpCreation")
+    DUMP_CREATE("dumpCreation"),
+    @SerializedName("taskCancelation")
+    TASK_CANCEL("taskCancelation"),
+    @SerializedName("taskDeletion")
+    TASK_DELETE("taskDeletion"),
+    @SerializedName("snapshotCreation")
+    SNAPSHOT_CREATE("snapshotCreation");
+
+    public final String operationType;
+
+    OperationType(String operationType) {
+        this.operationType = operationType;
+    }
+
+    @JsonValue
+    @Override
+    public String toString() {
+        return this.operationType;
+    }
+}

src/main/java/com/meilisearch/sdk/model/BatchResults.java

@@ -3,6 +3,12 @@
 import java.util.List;
 import lombok.Data;
 
+/**
+ * Data structure paginated response Currently used in : Batches.
+ *
+ * @see <a href="https://www.meilisearch.com/docs/reference/api/batches#response">API
+ *     specification</a>
+ */
 @Data
 public class CursorResults<T> {
     private List<T> results;

src/main/java/com/meilisearch/sdk/model/CursorResults.java

@@ -1,10 +1,16 @@
-package com.meilisearch.sdk.model;
+package com.meilisearch.sdk.model.batch.req;
 
 import com.meilisearch.sdk.http.URLBuilder;
 import java.util.Date;
 import lombok.Data;
 import lombok.experimental.Accessors;
 
+/**
+ * Data structure of a query parameter for batches route
+ *
+ * @see <a href="https://www.meilisearch.com/docs/reference/api/batches#query-parameters">API
+ *     specification</a>
+ */
 @Data
 @Accessors(chain = true)
 public class BatchesQuery {

src/main/java/com/meilisearch/sdk/model/BatchesQuery.java renamed to src/main/java/com/meilisearch/sdk/model/batch/req/BatchesQuery.java

@@ -0,0 +1,21 @@
+package com.meilisearch.sdk.model.batch.res;
+
+import com.meilisearch.sdk.model.TaskDetails;
+import lombok.Data;
+
+/**
+ * Data structure of the batch object response
+ *
+ * @see <a href="https://www.meilisearch.com/docs/reference/api/batches#batch-object">API
+ *     specification</a>
+ */
+@Data
+public class Batch {
+    private int uid = 0;
+    private TaskDetails details;
+    private BatchProgress progress;
+    private StatDetails stats;
+    private String startedAt;
+    private String finishedAt;
+    private String duration;
+}

src/main/java/com/meilisearch/sdk/model/batch/res/Batch.java

@@ -0,0 +1,10 @@
+package com.meilisearch.sdk.model.batch.res;
+
+import java.util.List;
+import lombok.Data;
+
+@Data
+class BatchProgress {
+    private List<StepDetails> steps;
+    private int percentage;
+}

src/main/java/com/meilisearch/sdk/model/batch/res/BatchProgress.java

@@ -0,0 +1,14 @@
+package com.meilisearch.sdk.model.batch.res;
+
+import com.meilisearch.sdk.enums.OperationType;
+import com.meilisearch.sdk.model.TaskStatus;
+import java.util.Map;
+import lombok.Data;
+
+@Data
+public class StatDetails {
+    private int totalNbTasks;
+    private Map<TaskStatus, Integer> status;
+    private Map<OperationType, Integer> types;
+    private Map<String, Integer> indexUids;
+}

src/main/java/com/meilisearch/sdk/model/batch/res/StatDetails.java

@@ -0,0 +1,10 @@
+package com.meilisearch.sdk.model.batch.res;
+
+import lombok.Data;
+
+@Data
+class StepDetails {
+    private String currentStep;
+    private int finished;
+    private int total;
+}