blueticks 3.3.1__tar.gz → 3.3.2__tar.gz

{blueticks-3.3.1/src/blueticks.egg-info → blueticks-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blueticks
-Version: 3.3.1
+Version: 3.3.2
 Summary: Official Python client for the Blueticks API.
 Author-email: Blueticks <support@blueticks.co>
 License: MIT License

blueticks-3.3.2/src/blueticks/_version.py

@@ -0,0 +1 @@
+__version__ = "3.3.2"

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/resources/audiences.py

@@ -4,6 +4,7 @@ import builtins
 from typing import Any
 
 from blueticks._base_resource import BaseResource
+from blueticks.types._deleted_resource import DeletedResource
 from blueticks.types.audiences import AppendContactsResult, Audience, Contact
 from blueticks.types.page import Page
 
@@ -47,9 +48,14 @@ class AudiencesResource(BaseResource):
         data = self._client._request("PATCH", f"/v1/audiences/{audience_id}", body={"name": name})
         return Audience.model_validate(data)
 
-    def delete(self, audience_id: str) -> None:
-        self._client._request("DELETE", f"/v1/audiences/{audience_id}")
-        return None
+    def delete(self, audience_id: str) -> DeletedResource:
+        """Delete audience.
+
+        Soft-delete an audience. 409 if it`s referenced by an active campaign.
+        Returns the deleted ref. Requires ``audiences:write``.
+        """
+        data = self._client._request("DELETE", f"/v1/audiences/{audience_id}")
+        return DeletedResource.model_validate(data)
 
     def append_contacts(
         self,

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/resources/chats.py

@@ -120,7 +120,10 @@ class ChatsResource(BaseResource):
         return MessageAck.model_validate(data)
 
     def react(self, chat_id: str, key: str, *, emoji: str) -> OkResponse:
-        """Add or clear an emoji reaction on a message."""
+        """Add or clear an emoji reaction on a message.
+
+        Pass an empty string for ``emoji`` to clear an existing reaction.
+        """
         data = self._client._request(
             "POST",
             f"/v1/chats/{chat_id}/messages/{key}/reactions",

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/resources/scheduled_messages.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from typing import Any
 
 from blueticks._base_resource import BaseResource
+from blueticks.types._deleted_resource import DeletedResource
 from blueticks.types.page import Page
 from blueticks.types.scheduled_messages import ScheduledMessage
 
@@ -61,10 +62,12 @@ class ScheduledMessagesResource(BaseResource):
         )
         return ScheduledMessage.model_validate(data)
 
-    def delete(self, scheduled_message_id: str) -> None:
+    def delete(self, scheduled_message_id: str) -> DeletedResource:
         """Cancel scheduled message.
 
-        Removes the resource with id.
+        Cancel a queued scheduled message before it fires. Soft-deletes the row
+        (still queryable in audit logs). Returns the deleted ref. Requires
+        ``messages:write``.
         """
-        self._client._request("DELETE", f"/v1/scheduled-messages/{scheduled_message_id}")
-        return None
+        data = self._client._request("DELETE", f"/v1/scheduled-messages/{scheduled_message_id}")
+        return DeletedResource.model_validate(data)

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/resources/webhooks.py

@@ -4,6 +4,7 @@ import builtins
 from typing import Any
 
 from blueticks._base_resource import BaseResource
+from blueticks.types._deleted_resource import DeletedResource
 from blueticks.types.page import Page
 from blueticks.types.webhooks import Webhook, WebhookCreateResult
 
@@ -66,9 +67,14 @@ class WebhooksResource(BaseResource):
         data = self._client._request("PATCH", f"/v1/webhooks/{webhook_id}", body=body)
         return Webhook.model_validate(data)
 
-    def delete(self, webhook_id: str) -> None:
-        self._client._request("DELETE", f"/v1/webhooks/{webhook_id}")
-        return None
+    def delete(self, webhook_id: str) -> DeletedResource:
+        """Delete webhook.
+
+        Delete a webhook subscription. Returns the deleted ref. Requires
+        ``webhooks:write``.
+        """
+        data = self._client._request("DELETE", f"/v1/webhooks/{webhook_id}")
+        return DeletedResource.model_validate(data)
 
     def rotate_secret(self, webhook_id: str) -> WebhookCreateResult:
         data = self._client._request("POST", f"/v1/webhooks/{webhook_id}/rotate-secret")

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/types/__init__.py

@@ -1,7 +1,9 @@
+from blueticks.types._deleted_resource import DeletedResource
 from blueticks.types.account import Account
 from blueticks.types.audiences import AppendContactsResult, Audience, Contact
 from blueticks.types.campaigns import Campaign
 from blueticks.types.chats import (
+    BatchMessageAckEntry,
     BatchMessageAcksResponse,
     Chat,
     ChatMedia,
@@ -24,6 +26,7 @@ __all__ = [
     "Account",
     "AppendContactsResult",
     "Audience",
+    "BatchMessageAckEntry",
     "BatchMessageAcksResponse",
     "Campaign",
     "Chat",
@@ -31,6 +34,7 @@ __all__ = [
     "ChatMessage",
     "ChatRef",
     "Contact",
+    "DeletedResource",
     "Group",
     "GroupParticipant",
     "LoadOlderMessagesResponse",

blueticks-3.3.2/src/blueticks/types/_deleted_resource.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DeletedResource(BaseModel):
+    """Response envelope returned by DELETE endpoints.
+
+    Returned by:
+    - DELETE /v1/audiences/{id}
+    - DELETE /v1/scheduled-messages/{id}
+    - DELETE /v1/webhooks/{id}
+    """
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str
+    deleted: Literal[True]

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks/types/chats.py

@@ -154,10 +154,22 @@ class MediaUrlResponse(BaseModel):
     url: Optional[str] = None  # noqa: UP045
 
 
+class BatchMessageAckEntry(BaseModel):
+    """One entry in :class:`BatchMessageAcksResponse.data`.
+
+    `ack` codes: -1=error, 0=pending, 1=server, 2=device, 3=read, 4=played;
+    `None` when the engine has not yet returned a status for this key.
+    """
+
+    model_config = ConfigDict(extra="ignore")
+
+    key: str
+    ack: Optional[int] = None  # noqa: UP045
+
+
 class BatchMessageAcksResponse(BaseModel):
     """Response from POST /v1/chats/message_acks."""
 
     model_config = ConfigDict(extra="ignore")
 
-    # Each item is a free-form ack record (additionalProperties: true).
-    data: list[dict[str, object]]
+    data: list[BatchMessageAckEntry]

{blueticks-3.3.1 → blueticks-3.3.2/src/blueticks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blueticks
-Version: 3.3.1
+Version: 3.3.2
 Summary: Official Python client for the Blueticks API.
 Author-email: Blueticks <support@blueticks.co>
 License: MIT License

{blueticks-3.3.1 → blueticks-3.3.2}/src/blueticks.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ src/blueticks/resources/scheduled_messages.py
 src/blueticks/resources/utils.py
 src/blueticks/resources/webhooks.py
 src/blueticks/types/__init__.py
+src/blueticks/types/_deleted_resource.py
 src/blueticks/types/account.py
 src/blueticks/types/audiences.py
 src/blueticks/types/campaigns.py

{blueticks-3.3.1 → blueticks-3.3.2}/tests/test_audiences.py

@@ -99,10 +99,12 @@ def test_delete_audience():
     def handler(req: httpx.Request) -> httpx.Response:
         assert req.method == "DELETE"
         assert req.url.path == "/v1/audiences/aud_1"
-        return httpx.Response(204)
+        return httpx.Response(200, json={"id": "aud_1", "deleted": True})
 
     client = Blueticks(api_key="bt_live_test", _http_transport=httpx.MockTransport(handler))
-    assert client.audiences.delete("aud_1") is None
+    result = client.audiences.delete("aud_1")
+    assert result.id == "aud_1"
+    assert result.deleted is True
 
 
 def test_append_contacts():

{blueticks-3.3.1 → blueticks-3.3.2}/tests/test_chats.py

@@ -225,13 +225,22 @@ def test_batch_message_acks_returns_typed_model():
         assert req.url.path == "/v1/chats/message_acks"
         return httpx.Response(
             200,
-            json={"data": [{"key": "msg_a", "ack": 3}, {"key": "msg_b", "ack": 1}]},
+            json={
+                "data": [
+                    {"key": "msg_a", "ack": 3},
+                    {"key": "msg_b", "ack": 1},
+                    {"key": "msg_c", "ack": None},
+                ]
+            },
         )
 
-    result = _client(handler).chats.batch_message_acks(message_keys=["msg_a", "msg_b"])
+    result = _client(handler).chats.batch_message_acks(message_keys=["msg_a", "msg_b", "msg_c"])
     assert isinstance(result, BatchMessageAcksResponse)
-    assert body_seen == {"message_keys": ["msg_a", "msg_b"]}
-    assert result.data[0]["ack"] == 3
+    assert body_seen == {"message_keys": ["msg_a", "msg_b", "msg_c"]}
+    assert result.data[0].key == "msg_a"
+    assert result.data[0].ack == 3
+    assert result.data[1].ack == 1
+    assert result.data[2].ack is None
 
 
 def test_chats_get_raises_authentication_error_on_401():

{blueticks-3.3.1 → blueticks-3.3.2}/tests/test_scheduled_messages.py

@@ -113,14 +113,20 @@ def test_update_scheduled_message(mock_client) -> None:
     assert body_seen == {"text": "updated", "send_at": "2026-07-01T09:00:00Z"}
 
 
-def test_delete_scheduled_message_returns_none(mock_client) -> None:
+def test_delete_scheduled_message_returns_typed_ref(mock_client) -> None:
     def handler(req: httpx.Request) -> httpx.Response:
         assert req.method == "DELETE"
         assert req.url.path == "/v1/scheduled-messages/sched_1"
-        return httpx.Response(204)
+        return httpx.Response(
+            200,
+            content=json.dumps({"id": "sched_1", "deleted": True}).encode(),
+            headers={"content-type": "application/json"},
+        )
 
     with mock_client(handler) as client:
-        assert client.scheduled_messages.delete("sched_1") is None
+        result = client.scheduled_messages.delete("sched_1")
+    assert result.id == "sched_1"
+    assert result.deleted is True
 
 
 def test_scheduled_messages_propagates_authentication_error(mock_client) -> None:

{blueticks-3.3.1 → blueticks-3.3.2}/tests/test_webhooks_resource.py

@@ -90,14 +90,16 @@ def test_update_webhook():
     assert body_seen == {"status": "disabled"}
 
 
-def test_delete_webhook_returns_none():
+def test_delete_webhook_returns_typed_ref():
     def handler(req: httpx.Request) -> httpx.Response:
         assert req.method == "DELETE"
         assert req.url.path == "/v1/webhooks/wh_1"
-        return httpx.Response(204)
+        return httpx.Response(200, json={"id": "wh_1", "deleted": True})
 
     client = Blueticks(api_key="bt_live_test", _http_transport=httpx.MockTransport(handler))
-    assert client.webhooks.delete("wh_1") is None
+    result = client.webhooks.delete("wh_1")
+    assert result.id == "wh_1"
+    assert result.deleted is True
 
 
 def test_rotate_secret_returns_new_secret():

blueticks-3.3.1/src/blueticks/_version.py

@@ -1 +0,0 @@
-__version__ = "3.3.1"