meilisearch-python-sdk 4.10.0__py3-none-any.whl → 4.11.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -36,6 +36,7 @@ from meilisearch_python_sdk.models.search import (
 from meilisearch_python_sdk.models.settings import MeilisearchSettings
 from meilisearch_python_sdk.models.task import TaskInfo, TaskResult, TaskStatus
 from meilisearch_python_sdk.models.version import Version
+from meilisearch_python_sdk.models.webhook import Webhook, WebhookCreate, Webhooks, WebhookUpdate
 from meilisearch_python_sdk.plugins import AsyncIndexPlugins, IndexPlugins
 from meilisearch_python_sdk.types import JsonDict
 
@@ -252,6 +253,124 @@ class AsyncClient(BaseClient):
 
         return Network(**response.json())
 
+    async def get_webhooks(self) -> Webhooks:
+        """Get all webhooks.
+
+        Returns:
+            An instance of Webhooks containing all configured webhooks.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhooks = await client.get_webhooks()
+        """
+        response = await self._http_requests.get("webhooks")
+
+        return Webhooks(**response.json())
+
+    async def get_webhook(self, uuid: str) -> Webhook:
+        """Get a specific webhook by UUID.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            An instance of Webhook containing the webhook information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook = await client.get_webhook("abc-123")
+        """
+        response = await self._http_requests.get(f"webhooks/{uuid}")
+
+        return Webhook(**response.json())
+
+    async def create_webhook(self, webhook: WebhookCreate) -> Webhook:
+        """Create a new webhook.
+
+        Args:
+            webhook: The webhook configuration to create.
+
+        Returns:
+            The created webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> from meilisearch_python_sdk.models.webhook import WebhookCreate
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook_config = WebhookCreate(
+            >>>         url="https://example.com/webhook",
+            >>>         headers={"Authorization": "Bearer token"}
+            >>>     )
+            >>>     webhook = await client.create_webhook(webhook_config)
+        """
+        response = await self._http_requests.post(
+            "webhooks", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    async def update_webhook(self, *, uuid: str, webhook: WebhookUpdate) -> Webhook:
+        """Update an existing webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+            webhook: The webhook configuration updates.
+
+        Returns:
+            The updated webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> from meilisearch_python_sdk.models.webhook import WebhookUpdate
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     webhook_update = WebhookUpdate(url="https://example.com/new-webhook")
+            >>>     webhook = await client.update_webhook("abc-123", webhook_update)
+        """
+        response = await self._http_requests.patch(
+            f"webhooks/{uuid}", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    async def delete_webhook(self, uuid: str) -> int:
+        """Delete a webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            The Response status code. 204 signifies a successful delete.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     await client.delete_webhook("abc-123")
+        """
+        response = await self._http_requests.delete(f"webhooks/{uuid}")
+        return response.status_code
+
     async def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 
@@ -1229,6 +1348,124 @@ class Client(BaseClient):
 
         return Network(**response.json())
 
+    def get_webhooks(self) -> Webhooks:
+        """Get all webhooks.
+
+        Returns:
+            An instance of Webhooks containing all configured webhooks.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhooks = client.get_webhooks()
+        """
+        response = self._http_requests.get("webhooks")
+
+        return Webhooks(**response.json())
+
+    def get_webhook(self, uuid: str) -> Webhook:
+        """Get a specific webhook by UUID.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            An instance of Webhook containing the webhook information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook = client.get_webhook("abc-123")
+        """
+        response = self._http_requests.get(f"webhooks/{uuid}")
+
+        return Webhook(**response.json())
+
+    def create_webhook(self, webhook: WebhookCreate) -> Webhook:
+        """Create a new webhook.
+
+        Args:
+            webhook: The webhook configuration to create.
+
+        Returns:
+            The created webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> from meilisearch_python_sdk.models.webhook import WebhookCreate
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook_config = WebhookCreate(
+            >>>     url="https://example.com/webhook",
+            >>>     headers={"Authorization": "Bearer token"}
+            >>> )
+            >>> webhook = client.create_webhook(webhook_config)
+        """
+        response = self._http_requests.post(
+            "webhooks", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    def update_webhook(self, *, uuid: str, webhook: WebhookUpdate) -> Webhook:
+        """Update an existing webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+            webhook: The webhook configuration updates.
+
+        Returns:
+            The updated webhook.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> from meilisearch_python_sdk.models.webhook import WebhookUpdate
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> webhook_update = WebhookUpdate(url="https://example.com/new-webhook")
+            >>> webhook = client.update_webhook("abc-123", webhook_update)
+        """
+        response = self._http_requests.patch(
+            f"webhooks/{uuid}", webhook.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Webhook(**response.json())
+
+    def delete_webhook(self, uuid: str) -> int:
+        """Delete a webhook.
+
+        Args:
+            uuid: The webhook's unique identifier.
+
+        Returns:
+            The Response status code. 204 signifies a successful delete.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> client.delete_webhook("abc-123")
+        """
+        response = self._http_requests.delete(f"webhooks/{uuid}")
+        return response.status_code
+
     def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "4.10.0"
+VERSION = "4.11.0"

meilisearch_python_sdk/index.py

@@ -3593,7 +3593,7 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    async def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
+    async def get_filterable_attributes(self) -> list[str | FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
@@ -3616,22 +3616,22 @@ class AsyncIndex(_BaseIndex):
 
         response_json = response.json()
 
-        if isinstance(response_json[0], str):
-            return response_json
-
-        filterable_attributes = []
+        filterable_attributes: list[str | FilterableAttributes] = []
         for r in response_json:
-            filterable_attributes.append(
-                FilterableAttributes(
-                    attribute_patterns=r["attributePatterns"],
-                    features=FilterableAttributeFeatures(**r["features"]),
+            if isinstance(r, str):
+                filterable_attributes.append(r)
+            else:
+                filterable_attributes.append(
+                    FilterableAttributes(
+                        attribute_patterns=r["attributePatterns"],
+                        features=FilterableAttributeFeatures(**r["features"]),
+                    )
                 )
-            )
 
         return filterable_attributes
 
     async def update_filterable_attributes(
-        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
+        self, body: list[str | FilterableAttributes], *, compress: bool = False
     ) -> TaskInfo:
         """Update filterable attributes of the index.
 
@@ -7224,7 +7224,7 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
+    def get_filterable_attributes(self) -> list[str | FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
@@ -7247,22 +7247,22 @@ class Index(_BaseIndex):
 
         response_json = response.json()
 
-        if isinstance(response_json[0], str):
-            return response_json
-
-        filterable_attributes = []
+        filterable_attributes: list[str | FilterableAttributes] = []
         for r in response_json:
-            filterable_attributes.append(
-                FilterableAttributes(
-                    attribute_patterns=r["attributePatterns"],
-                    features=FilterableAttributeFeatures(**r["features"]),
+            if isinstance(r, str):
+                filterable_attributes.append(r)
+            else:
+                filterable_attributes.append(
+                    FilterableAttributes(
+                        attribute_patterns=r["attributePatterns"],
+                        features=FilterableAttributeFeatures(**r["features"]),
+                    )
                 )
-            )
 
         return filterable_attributes
 
     def update_filterable_attributes(
-        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
+        self, body: list[str | FilterableAttributes], *, compress: bool = False
     ) -> TaskInfo:
         """Update filterable attributes of the index.
 

meilisearch_python_sdk/models/settings.py

@@ -167,7 +167,7 @@ class MeilisearchSettings(CamelBase):
     synonyms: JsonDict | None = None
     stop_words: list[str] | None = None
     ranking_rules: list[str] | None = None
-    filterable_attributes: list[str] | list[FilterableAttributes] | None = None
+    filterable_attributes: list[str | FilterableAttributes] | None = None
     distinct_attribute: str | None = None
     searchable_attributes: list[str] | None = None
     displayed_attributes: list[str] | None = None

meilisearch_python_sdk/models/webhook.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from camel_converter.pydantic_base import CamelBase
+
+
+class Webhook(CamelBase):
+    uuid: str
+    url: str
+    headers: dict[str, str] | None = None
+    is_editable: bool
+
+
+class Webhooks(CamelBase):
+    results: list[Webhook]
+
+
+class WebhookCreate(CamelBase):
+    url: str
+    headers: dict[str, str] | None = None
+
+
+class WebhookUpdate(CamelBase):
+    url: str | None = None
+    headers: dict[str, str] | None = None

{meilisearch_python_sdk-4.10.0.dist-info → meilisearch_python_sdk-4.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.10.0
+Version: 4.11.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk

{meilisearch_python_sdk-4.10.0.dist-info → meilisearch_python_sdk-4.11.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
 meilisearch_python_sdk/_batch.py,sha256=Hbt-M8Lt8ZDZqcKToUMzUd5zvT-gku709er4pRlvXWk,5065
-meilisearch_python_sdk/_client.py,sha256=wwSNx0pKkVz3tMYw_Zk04C5DmjrqxjP0Hi6iD3l9RAI,81729
+meilisearch_python_sdk/_client.py,sha256=HA0FdvsVGAHhUt6mVB-sK03bIzVivN7ProcimeQdgjQ,90624
 meilisearch_python_sdk/_http_requests.py,sha256=O3M3n-t1jAKwccWowPbk-HPD3ExtHq8a3XhnZT5facs,6746
 meilisearch_python_sdk/_task.py,sha256=QgVcqMlZdURRS_oYpB_bTBa5dvT3Sp_-O0-s6TqAxHk,12485
 meilisearch_python_sdk/_utils.py,sha256=NoCDxJPhjABeuSxFTNCih585UDWdXEUBD_FvdgtScQw,1539
-meilisearch_python_sdk/_version.py,sha256=NzVhpOSZyYUYSW4PUD6no8sHaIfvdmRhQGP6pe-HgrM,19
+meilisearch_python_sdk/_version.py,sha256=P-An9BGfasfrCKgh22bKMbdgfN7f7BM-eGimBxENmes,19
 meilisearch_python_sdk/decorators.py,sha256=njMn40P-qOzKGGQLCDpsBKWyj2ai10s4XG4IUBSHoD4,8674
 meilisearch_python_sdk/errors.py,sha256=RNNHXtXLBiCVZaLM2MeKKs9RbRuE-SLRttiPeVAEXgA,2133
-meilisearch_python_sdk/index.py,sha256=1hKuVPQPH1bpQ_3DrnihpypMZk5ZZok0-pU3RjO0Sfo,349340
+meilisearch_python_sdk/index.py,sha256=XxUgfOBUo6ClayI94I0AljGW4obam5hBIHeAz7d8f4Q,349474
 meilisearch_python_sdk/json_handler.py,sha256=c1rGKzYlE0dGfLygQjPqVUNfQkN1JvafBGmIx31JW8g,2044
 meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,10 +19,11 @@ meilisearch_python_sdk/models/documents.py,sha256=eT3FHrPND-g2IzNRyOHQApTTJ1WbFc
 meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
 meilisearch_python_sdk/models/index.py,sha256=WLQOi3_HChko134FkRU1H3_cJjhHJCFclcx4oDBlqHU,1228
 meilisearch_python_sdk/models/search.py,sha256=U3ph1GW9Xkbw33pIlGDa7rlTGsdvqahjRJjPxUou8n8,3581
-meilisearch_python_sdk/models/settings.py,sha256=3UdJWbrXfTrwvzu3Gq-aY1fDmAejysSz7yRQ-7yXCwQ,5736
+meilisearch_python_sdk/models/settings.py,sha256=eh0xnro4D_sj8ck2nifa3tBdf2_7RcZlAY_zQhfsY0s,5730
 meilisearch_python_sdk/models/task.py,sha256=JVYF46ylD-XwqVVNq2offhLOkljaGxPyRVuF6PwLOBU,2174
 meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
-meilisearch_python_sdk-4.10.0.dist-info/METADATA,sha256=F4EJvoyqdCCc8QkggKdoO2UF7PrExHLqGOXwjthh9IA,9764
-meilisearch_python_sdk-4.10.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-4.10.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-4.10.0.dist-info/RECORD,,
+meilisearch_python_sdk/models/webhook.py,sha256=zSkEJJdEflinW3_seJTLQ_ZWs4w-pjTD3SS1ZawC32k,455
+meilisearch_python_sdk-4.11.0.dist-info/METADATA,sha256=PygEoNhWOtRVqDTIRr5SXzoz0aezlr_g7fSBwaJ1Mu4,9764
+meilisearch_python_sdk-4.11.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-4.11.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-4.11.0.dist-info/RECORD,,