Merge branch 'main' into release-v0.23.0

Author: alallema

.code-samples.meilisearch.yaml

@@ -623,8 +623,8 @@ get_all_tasks_filtering_1: |-
   client.get_tasks({'indexUid': ['movies']})
 get_all_tasks_filtering_2: |-
   client.get_tasks({
-    'status': ['succeeded', 'failed'],
-    'type': ['documentAdditionOrUpdate']
+    'statuses': ['succeeded', 'failed'],
+    'types': ['documentAdditionOrUpdate']
   })
 get_all_tasks_paginating_1: |-
   client.get_tasks({

README.md

@@ -197,7 +197,7 @@ index.search(
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
+This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
 
 ## 💡 Learn more
 

meilisearch/client.py

@@ -13,7 +13,8 @@
 from meilisearch.config import Config
 from meilisearch.errors import MeiliSearchError
 from meilisearch.index import Index
-from meilisearch.task import get_task, get_tasks, wait_for_task
+from meilisearch.models.task import TaskInfo
+from meilisearch.task import cancel_tasks, delete_tasks, get_task, get_tasks, wait_for_task
 
 
 class Client:
@@ -399,6 +400,27 @@ def create_dump(self) -> dict[str, str]:
         """
         return self.http.post(self.config.paths.dumps)
 
+    def swap_indexes(self, parameters: list[dict[str, list[str]]]) -> TaskInfo:
+        """Swap two indexes.
+
+        Parameters
+        ----------
+        indexes:
+            List of indexes to swap (ex: [{"indexes": ["indexA", "indexB"]}).
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return TaskInfo(**self.http.post(self.config.paths.swap, parameters))
+
     def get_tasks(
         self, parameters: dict[str, Any] | None = None
     ) -> dict[str, list[dict[str, Any]]]:
@@ -407,8 +429,7 @@ def get_tasks(
         Parameters
         ----------
         parameters (optional):
-            parameters accepted by the get tasks route: https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks.
-            `indexUid` should be set as a List.
+            parameters accepted by the get tasks route: https://docs.meilisearch.com/reference/api/tasks.html#get-tasks.
 
         Returns
         -------
@@ -442,6 +463,46 @@ def get_task(self, uid: int) -> dict[str, Any]:
         """
         return get_task(self.config, uid)
 
+    def cancel_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
+        """Cancel a list of enqueued or processing tasks.
+
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the cancel tasks route:https://docs.meilisearch.com/reference/api/tasks.html#cancel-tasks.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return cancel_tasks(self.config, parameters=parameters)
+
+    def delete_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
+        """Delete a list of finished tasks.
+
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the delete tasks route:https://docs.meilisearch.com/reference/api/tasks.html#delete-task.
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return delete_tasks(self.config, parameters=parameters)
+
     def wait_for_task(
         self,
         uid: int,

meilisearch/config.py

@@ -29,6 +29,7 @@ class Paths:
         dumps = "dumps"
         pagination = "pagination"
         faceting = "faceting"
+        swap = "swap-indexes"
 
     def __init__(self, url: str, api_key: str | None = None, timeout: int | None = None) -> None:
         """