Add methods for Facet Search settings requests

Author: thicolares

.code-samples.meilisearch.yaml

@@ -634,6 +634,12 @@ update_pagination_settings_1: |-
   client.index('books').update_pagination_settings({'maxTotalHits': 100})
 reset_pagination_settings_1: |-
   client.index('books').reset_pagination_settings()
+get_facet_search_settings_1: |-
+  client.index('books').get_facet_search_settings()
+update_facet_search_settings_1: |-
+  client.index('books').update_facet_search_settings(False)
+reset_facet_search_settings_1: |-
+  client.index('books').reset_facet_search_settings()
 get_faceting_settings_1: |-
   client.index('books').get_faceting_settings()
 update_faceting_settings_1: |-

meilisearch/index.py

@@ -1628,6 +1628,57 @@ def reset_pagination_settings(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    def get_facet_search_settings(self) -> bool:
+        """Get the facet search settings of an index.
+
+        Returns
+        -------
+        bool:
+            True if facet search is enabled, False if disabled.
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+
+        return self.http.get(self.__settings_url_for(self.config.paths.facet_search))
+
+    def update_facet_search_settings(self, body: Union[bool, None]) -> TaskInfo:
+        """Update the facet search settings of the index.
+
+        Parameters
+        ----------
+        body: bool
+            True to enable facet search, False to disable it.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        task = self.http.put(self.__settings_url_for(self.config.paths.facet_search), body=body)
+
+        return TaskInfo(**task)
+
+    def reset_facet_search_settings(self) -> TaskInfo:
+        """Reset facet search settings of the index to default values.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks
+        """
+        task = self.http.delete(self.__settings_url_for(self.config.paths.facet_search))
+        
+        return TaskInfo(**task)
+
     def get_faceting_settings(self) -> Faceting:
         """Get the faceting settings of an index.
 
@@ -1641,7 +1692,6 @@ def get_faceting_settings(self) -> Faceting:
         MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
         """
-
         faceting = self.http.get(self.__settings_url_for(self.config.paths.faceting))
 
         return Faceting(**faceting)

tests/settings/test_settings_facet_search.py

@@ -0,0 +1,38 @@
+DEFAULT_FACET_SEARCH_SETTINGS_STATUS = True
+ENABLED_FACET_SEARCH_SETTINGS_STATUS = True
+DISABLED_FACET_SEARCH_SETTINGS_STATUS = False
+
+
+def test_get_facet_search_settings(empty_index):
+    response = empty_index().get_facet_search_settings()
+
+    assert DEFAULT_FACET_SEARCH_SETTINGS_STATUS == response
+
+
+def test_update_facet_search_settings(empty_index):
+    index = empty_index()
+
+    response = index.update_facet_search_settings(DISABLED_FACET_SEARCH_SETTINGS_STATUS)
+    index.wait_for_task(response.task_uid)
+    response = index.get_facet_search_settings()
+    assert DISABLED_FACET_SEARCH_SETTINGS_STATUS == response
+
+    response = index.update_facet_search_settings(ENABLED_FACET_SEARCH_SETTINGS_STATUS)
+    index.wait_for_task(response.task_uid)
+    response = index.get_facet_search_settings()
+    assert ENABLED_FACET_SEARCH_SETTINGS_STATUS == response
+
+
+def test_reset_facet_search_settings(empty_index):
+    index = empty_index()
+
+    response = index.update_facet_search_settings(DISABLED_FACET_SEARCH_SETTINGS_STATUS)
+    index.wait_for_task(response.task_uid)
+    response = index.get_facet_search_settings()
+    assert DISABLED_FACET_SEARCH_SETTINGS_STATUS == response
+    assert DEFAULT_FACET_SEARCH_SETTINGS_STATUS != response
+
+    response = index.reset_facet_search_settings()
+    index.wait_for_task(response.task_uid)
+    response = index.get_facet_search_settings()
+    assert DEFAULT_FACET_SEARCH_SETTINGS_STATUS == response