meilisearch-python-sdk 4.10.1__tar.gz → 4.11.0__tar.gz

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-4.11.0}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.1
+    rev: v1.18.2
     hooks:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.0
+    rev: v0.13.2
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-4.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.10.1
+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.1 → meilisearch_python_sdk-4.11.0}/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-4.11.0/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "4.11.0"

meilisearch_python_sdk-4.11.0/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.1 → meilisearch_python_sdk-4.11.0}/pyproject.toml

@@ -41,15 +41,15 @@ all = ["orjson", "ujson"]
 [dependency-groups]
 dev = [
   "mkdocs==1.6.1",
-  "mkdocs-material==9.6.20",
-  "mkdocstrings[python]==0.30.0",
+  "mkdocs-material==9.6.21",
+  "mkdocstrings[python]==0.30.1",
   "mypy[faster-cache]==1.18.2",
   "pre-commit==4.3.0",
   "pytest==8.4.2",
   "pytest-cov==7.0.0",
   "pytest-asyncio==1.2.0",
   "pytest-xdist==3.8.0",
-  "ruff==0.13.1",
+  "ruff==0.13.3",
   "types-aiofiles==24.1.0.20250822",
   "typing-extensions==4.15.0",
   "types-ujson==5.10.0.20250822",

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-4.11.0}/tests/conftest.py

@@ -18,6 +18,7 @@ from httpx import AsyncClient as HttpxAsyncClient
 
 from meilisearch_python_sdk import AsyncClient, Client
 from meilisearch_python_sdk._task import async_wait_for_task, wait_for_task
+from meilisearch_python_sdk.errors import MeilisearchApiError
 from meilisearch_python_sdk.json_handler import OrjsonHandler, UjsonHandler
 from meilisearch_python_sdk.models.settings import (
     Embedders,
@@ -29,6 +30,7 @@ from meilisearch_python_sdk.models.settings import (
     TypoTolerance,
     UserProvidedEmbedder,
 )
+from meilisearch_python_sdk.models.webhook import WebhookCreate
 
 MASTER_KEY = "masterKey"
 
@@ -353,3 +355,17 @@ def new_settings_localized():
             LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
         ],
     )
+
+
+@pytest.fixture
+def webhook(client):
+    webhook_config = WebhookCreate(url="https://example.com/webhook")
+    webhook = client.create_webhook(webhook_config)
+
+    yield webhook
+
+    try:
+        client.delete_webhook(webhook.uuid)
+    except MeilisearchApiError as e:
+        if "webhook_not_found" in str(e):
+            pass

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-4.11.0}/tests/test_async_client.py

@@ -25,6 +25,7 @@ from meilisearch_python_sdk.errors import (
 from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate, Network
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.version import Version
+from meilisearch_python_sdk.models.webhook import WebhookCreate, WebhookUpdate
 from meilisearch_python_sdk.types import JsonDict
 
 
@@ -1085,3 +1086,48 @@ async def test_add_or_update_networks(async_client):
     assert len(response.remotes) >= 2
     assert "remote_1" in response.remotes
     assert "remote_2" in response.remotes
+
+
+async def test_get_webhooks(async_client, webhook):
+    response = await async_client.get_webhooks()
+
+    assert response.results is not None
+    assert webhook in response.results
+
+
+async def test_create_webhook(async_client):
+    webhook_config = WebhookCreate(
+        url="https://example.com/webhook", headers={"Authorization": "Bearer token"}
+    )
+    webhook = await async_client.create_webhook(webhook_config)
+
+    try:
+        assert webhook.uuid is not None
+        assert webhook.url == "https://example.com/webhook"
+        assert webhook.headers == {"Authorization": "Bearer token"}
+        assert webhook.is_editable is True
+    finally:
+        await async_client.delete_webhook(webhook.uuid)
+
+
+async def test_get_webhook(async_client, webhook):
+    result = await async_client.get_webhook(webhook.uuid)
+
+    assert result.uuid == webhook.uuid
+    assert result.url == webhook.url
+    assert result.is_editable == webhook.is_editable
+
+
+async def test_update_webhook(async_client, webhook):
+    update = WebhookUpdate(url="https://example.com/new-webhook", headers={"X-Custom": "value"})
+    updated = await async_client.update_webhook(uuid=webhook.uuid, webhook=update)
+
+    assert updated.uuid == webhook.uuid
+    assert updated.url == "https://example.com/new-webhook"
+    assert updated.headers == {"X-Custom": "value"}
+
+
+async def test_delete_webhook(async_client, webhook):
+    status_code = await async_client.delete_webhook(webhook.uuid)
+
+    assert status_code == 204

{meilisearch_python_sdk-4.10.1 → meilisearch_python_sdk-4.11.0}/tests/test_client.py

@@ -22,6 +22,7 @@ from meilisearch_python_sdk.errors import (
 from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate, Network
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.version import Version
+from meilisearch_python_sdk.models.webhook import WebhookCreate, WebhookUpdate
 from meilisearch_python_sdk.types import JsonDict
 
 
@@ -1066,3 +1067,48 @@ def test_add_or_update_networks(client):
     assert len(response.remotes) >= 2
     assert "remote_1" in response.remotes
     assert "remote_2" in response.remotes
+
+
+def test_get_webhooks(client, webhook):
+    response = client.get_webhooks()
+
+    assert response.results is not None
+    assert webhook in response.results
+
+
+def test_create_webhook(client):
+    webhook_config = WebhookCreate(
+        url="https://example.com/webhook", headers={"Authorization": "Bearer token"}
+    )
+    webhook = client.create_webhook(webhook_config)
+
+    try:
+        assert webhook.uuid is not None
+        assert webhook.url == "https://example.com/webhook"
+        assert webhook.headers == {"Authorization": "Bearer token"}
+        assert webhook.is_editable is True
+    finally:
+        client.delete_webhook(webhook.uuid)
+
+
+def test_get_webhook(client, webhook):
+    result = client.get_webhook(webhook.uuid)
+
+    assert result.uuid == webhook.uuid
+    assert result.url == webhook.url
+    assert result.is_editable == webhook.is_editable
+
+
+def test_update_webhook(client, webhook):
+    update = WebhookUpdate(url="https://example.com/new-webhook", headers={"X-Custom": "value"})
+    updated = client.update_webhook(uuid=webhook.uuid, webhook=update)
+
+    assert updated.uuid == webhook.uuid
+    assert updated.url == "https://example.com/new-webhook"
+    assert updated.headers == {"X-Custom": "value"}
+
+
+def test_delete_webhook(client, webhook):
+    status_code = client.delete_webhook(webhook.uuid)
+
+    assert status_code == 204