blueticks 3.2.0__tar.gz → 3.3.0__tar.gz

{blueticks-3.2.0/src/blueticks.egg-info → blueticks-3.3.0}/PKG-INFO

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

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks/_client.py

@@ -69,6 +69,7 @@ class Blueticks:
         from blueticks.resources.engines import EnginesResource
         from blueticks.resources.groups import GroupsResource
         from blueticks.resources.messages import MessagesResource
+        from blueticks.resources.scheduled_messages import ScheduledMessagesResource
         from blueticks.resources.utils import UtilsResource
         from blueticks.resources.webhooks import WebhooksResource
 
@@ -80,6 +81,7 @@ class Blueticks:
         self.engines = EnginesResource(self)
         self.groups = GroupsResource(self)
         self.messages = MessagesResource(self)
+        self.scheduled_messages = ScheduledMessagesResource(self)
         self.utils = UtilsResource(self)
         self.webhooks = WebhooksResource(self)
 

blueticks-3.3.0/src/blueticks/_version.py

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

blueticks-3.3.0/src/blueticks/resources/__init__.py

@@ -0,0 +1,27 @@
+from blueticks.resources.account import AccountResource
+from blueticks.resources.audiences import AudiencesResource
+from blueticks.resources.campaigns import CampaignsResource
+from blueticks.resources.chats import ChatsResource
+from blueticks.resources.contacts import ContactsResource
+from blueticks.resources.engines import EnginesResource
+from blueticks.resources.groups import GroupsResource
+from blueticks.resources.messages import MessagesResource
+from blueticks.resources.ping import PingResource
+from blueticks.resources.scheduled_messages import ScheduledMessagesResource
+from blueticks.resources.utils import UtilsResource
+from blueticks.resources.webhooks import WebhooksResource
+
+__all__ = [
+    "AccountResource",
+    "AudiencesResource",
+    "CampaignsResource",
+    "ChatsResource",
+    "ContactsResource",
+    "EnginesResource",
+    "GroupsResource",
+    "MessagesResource",
+    "PingResource",
+    "ScheduledMessagesResource",
+    "UtilsResource",
+    "WebhooksResource",
+]

blueticks-3.3.0/src/blueticks/resources/scheduled_messages.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from typing import Any
+
+from blueticks._base_resource import BaseResource
+from blueticks.types.page import Page
+from blueticks.types.scheduled_messages import ScheduledMessage
+
+
+class ScheduledMessagesResource(BaseResource):
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> Page[ScheduledMessage]:
+        """List scheduled messages.
+
+        Retrieves a list of all resources from the service.
+        """
+        params: dict[str, Any] = {}
+        if limit is not None:
+            params["limit"] = limit
+        if cursor is not None:
+            params["cursor"] = cursor
+        data = self._client._request("GET", "/v1/scheduled-messages", params=params or None)
+        return Page[ScheduledMessage].model_validate(data)
+
+    def retrieve(self, scheduled_message_id: str) -> ScheduledMessage:
+        """Get scheduled message.
+
+        Retrieves a single resource with the given id from the service.
+        """
+        data = self._client._request("GET", f"/v1/scheduled-messages/{scheduled_message_id}")
+        return ScheduledMessage.model_validate(data)
+
+    def update(
+        self,
+        scheduled_message_id: str,
+        *,
+        text: str | None = None,
+        media_url: str | None = None,
+        media_caption: str | None = None,
+        send_at: str | None = None,
+    ) -> ScheduledMessage:
+        """Update scheduled message.
+
+        Updates the resource identified by id using data.
+        """
+        body: dict[str, Any] = {}
+        if text is not None:
+            body["text"] = text
+        if media_url is not None:
+            body["media_url"] = media_url
+        if media_caption is not None:
+            body["media_caption"] = media_caption
+        if send_at is not None:
+            body["send_at"] = send_at
+        data = self._client._request(
+            "PATCH", f"/v1/scheduled-messages/{scheduled_message_id}", body=body
+        )
+        return ScheduledMessage.model_validate(data)
+
+    def delete(self, scheduled_message_id: str) -> None:
+        """Cancel scheduled message.
+
+        Removes the resource with id.
+        """
+        self._client._request("DELETE", f"/v1/scheduled-messages/{scheduled_message_id}")
+        return None

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks/types/__init__.py

@@ -1,9 +1,11 @@
 from blueticks.types.account import Account
 from blueticks.types.audiences import AppendContactsResult, Audience, Contact
 from blueticks.types.campaigns import Campaign
+from blueticks.types.groups import Group, GroupParticipant
 from blueticks.types.messages import Message
 from blueticks.types.page import Page
 from blueticks.types.ping import Ping
+from blueticks.types.scheduled_messages import ScheduledMessage
 from blueticks.types.webhooks import Webhook, WebhookCreateResult, WebhookEvent
 
 __all__ = [
@@ -12,9 +14,12 @@ __all__ = [
     "Audience",
     "Campaign",
     "Contact",
+    "Group",
+    "GroupParticipant",
     "Message",
     "Page",
     "Ping",
+    "ScheduledMessage",
     "Webhook",
     "WebhookCreateResult",
     "WebhookEvent",

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks/types/chats.py

@@ -70,6 +70,7 @@ class ChatMessage(BaseModel):
 MediaUnavailableReason = Literal[
     "expired",
     "fetching",
+    "awaiting_sender",
     "error",
     "no_media",
 ]
@@ -87,4 +88,21 @@ class ChatMedia(BaseModel):
     # genuine original from the sender.
     original_quality: Optional[bool] = None  # noqa: UP045
     # Reason the bytes couldn't be retrieved. None/absent on success.
-    media_unavailable: Optional[MediaUnavailableReason] = None  # noqa: UP045
+    # "expired" = WA aged the file out of CDN retention. "fetching" = WA is
+    # mid-download from its CDN — transient, retry in a few seconds.
+    # "awaiting_sender" = WA's CDN doesn't have the file but has asked the
+    # sender's device to reupload it; only completes when the sender's
+    # WhatsApp client is open and online. "error" = unexpected failure.
+    # "no_media" = the message is text-only/revoked/location/vcard.
+    media_unavailable: Optional[MediaUnavailableReason] = Field(  # noqa: UP045
+        default=None,
+        description=(
+            "Set when the bytes could not be downloaded or never existed. "
+            '"expired" = WA aged the file out of CDN retention. '
+            '"fetching" = WA is mid-download from its CDN — transient, retry in a few seconds. '
+            "\"awaiting_sender\" = WA's CDN does not have the file but has asked the sender's "
+            "device to reupload it; only completes when the sender's WhatsApp client is open and "
+            'online. "error" = unexpected failure. "no_media" = the message is text-only / revoked '
+            "/ location / vcard."
+        ),
+    )

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks/types/groups.py

@@ -6,6 +6,15 @@ from typing import Optional  # noqa: UP045
 from pydantic import BaseModel, ConfigDict
 
 
+class GroupParticipant(BaseModel):
+    model_config = ConfigDict(extra="ignore")
+
+    chat_id: str
+    is_admin: bool
+    is_super_admin: bool
+    name: Optional[str] = None  # noqa: UP045
+
+
 class Group(BaseModel):
     model_config = ConfigDict(extra="ignore")
 
@@ -14,6 +23,8 @@ class Group(BaseModel):
     description: Optional[str] = None  # noqa: UP045
     owner: Optional[str] = None  # noqa: UP045
     created_at: Optional[str] = None  # noqa: UP045
+    last_message_at: Optional[str] = None  # noqa: UP045
     participant_count: Optional[int] = None  # noqa: UP045
     announce: Optional[bool] = None  # noqa: UP045
     restrict: Optional[bool] = None  # noqa: UP045
+    participants: Optional[list[GroupParticipant]] = None  # noqa: UP045

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks/types/messages.py

@@ -5,7 +5,7 @@ from typing import Literal, Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
-MessageStatus = Literal["scheduled", "queued", "sending", "delivered", "failed"]
+MessageStatus = Literal["scheduled", "queued", "sending", "delivered", "read", "failed"]
 
 
 class Message(BaseModel):

blueticks-3.3.0/src/blueticks/types/scheduled_messages.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+# ruff: noqa: UP045  # Pydantic field annotations need Optional[T] for Python 3.9 (see CLAUDE.md)
+from typing import Optional  # noqa: UP045
+
+from pydantic import BaseModel, ConfigDict
+
+
+class ScheduledMessage(BaseModel):
+    """A message queued for future delivery via /v1/scheduled-messages."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str
+    to: Optional[str] = None  # noqa: UP045
+    text: Optional[str] = None  # noqa: UP045
+    media_url: Optional[str] = None  # noqa: UP045
+    media_caption: Optional[str] = None  # noqa: UP045
+    media_filename: Optional[str] = None  # noqa: UP045
+    media_mime_type: Optional[str] = None  # noqa: UP045
+    send_at: Optional[str] = None  # noqa: UP045
+    status: Optional[str] = None  # noqa: UP045
+    is_recurring: bool
+    recurrence_rule: Optional[str] = None  # noqa: UP045
+    created_at: Optional[str] = None  # noqa: UP045
+    updated_at: Optional[str] = None  # noqa: UP045

{blueticks-3.2.0 → blueticks-3.3.0/src/blueticks.egg-info}/PKG-INFO

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

{blueticks-3.2.0 → blueticks-3.3.0}/src/blueticks.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/blueticks/resources/engines.py
 src/blueticks/resources/groups.py
 src/blueticks/resources/messages.py
 src/blueticks/resources/ping.py
+src/blueticks/resources/scheduled_messages.py
 src/blueticks/resources/utils.py
 src/blueticks/resources/webhooks.py
 src/blueticks/types/__init__.py
@@ -37,6 +38,7 @@ src/blueticks/types/groups.py
 src/blueticks/types/messages.py
 src/blueticks/types/page.py
 src/blueticks/types/ping.py
+src/blueticks/types/scheduled_messages.py
 src/blueticks/types/utils.py
 src/blueticks/types/webhooks.py
 tests/test_account.py
@@ -46,6 +48,7 @@ tests/test_client.py
 tests/test_errors.py
 tests/test_messages.py
 tests/test_ping.py
+tests/test_scheduled_messages.py
 tests/test_transport.py
 tests/test_types.py
 tests/test_webhook_verify.py

blueticks-3.3.0/tests/test_scheduled_messages.py

@@ -0,0 +1,155 @@
+from __future__ import annotations
+
+import json
+
+import httpx
+import pytest
+from pydantic import ValidationError
+
+from blueticks import AuthenticationError
+from blueticks.types.page import Page
+from blueticks.types.scheduled_messages import ScheduledMessage
+
+
+def _scheduled(sid: str = "sched_1", **overrides) -> dict:
+    data = {
+        "id": sid,
+        "to": "+12025550100",
+        "text": "hello future",
+        "media_url": None,
+        "media_caption": None,
+        "media_filename": None,
+        "media_mime_type": None,
+        "send_at": "2026-06-01T09:00:00Z",
+        "status": "pending",
+        "is_recurring": False,
+        "recurrence_rule": None,
+        "created_at": "2026-04-23T00:00:00Z",
+        "updated_at": "2026-04-23T00:00:00Z",
+    }
+    data.update(overrides)
+    return data
+
+
+def test_list_scheduled_messages(mock_client) -> None:
+    def handler(req: httpx.Request) -> httpx.Response:
+        assert req.method == "GET"
+        assert req.url.path == "/v1/scheduled-messages"
+        return httpx.Response(
+            200,
+            content=json.dumps(
+                {
+                    "data": [_scheduled("sched_1"), _scheduled("sched_2", is_recurring=True)],
+                    "has_more": False,
+                    "next_cursor": None,
+                }
+            ).encode(),
+            headers={"content-type": "application/json"},
+        )
+
+    with mock_client(handler) as client:
+        page = client.scheduled_messages.list()
+    assert isinstance(page, Page)
+    assert len(page.data) == 2
+    assert page.data[0].id == "sched_1"
+    assert page.data[1].is_recurring is True
+    assert page.has_more is False
+
+
+def test_list_scheduled_messages_passes_pagination_params(mock_client) -> None:
+    seen_params: dict = {}
+
+    def handler(req: httpx.Request) -> httpx.Response:
+        seen_params.update(dict(req.url.params))
+        return httpx.Response(
+            200,
+            content=json.dumps({"data": [], "has_more": True, "next_cursor": "cur_next"}).encode(),
+            headers={"content-type": "application/json"},
+        )
+
+    with mock_client(handler) as client:
+        page = client.scheduled_messages.list(limit=25, cursor="cur_abc")
+    assert seen_params == {"limit": "25", "cursor": "cur_abc"}
+    assert page.next_cursor == "cur_next"
+
+
+def test_retrieve_scheduled_message(mock_client) -> None:
+    def handler(req: httpx.Request) -> httpx.Response:
+        assert req.method == "GET"
+        assert req.url.path == "/v1/scheduled-messages/sched_1"
+        return httpx.Response(
+            200,
+            content=json.dumps(_scheduled("sched_1", text="reminder")).encode(),
+            headers={"content-type": "application/json"},
+        )
+
+    with mock_client(handler) as client:
+        result = client.scheduled_messages.retrieve("sched_1")
+    assert isinstance(result, ScheduledMessage)
+    assert result.id == "sched_1"
+    assert result.text == "reminder"
+
+
+def test_update_scheduled_message(mock_client) -> None:
+    body_seen: dict = {}
+
+    def handler(req: httpx.Request) -> httpx.Response:
+        body_seen.update(json.loads(req.content))
+        assert req.method == "PATCH"
+        assert req.url.path == "/v1/scheduled-messages/sched_1"
+        return httpx.Response(
+            200,
+            content=json.dumps(_scheduled("sched_1", text="updated")).encode(),
+            headers={"content-type": "application/json"},
+        )
+
+    with mock_client(handler) as client:
+        result = client.scheduled_messages.update(
+            "sched_1",
+            text="updated",
+            send_at="2026-07-01T09:00:00Z",
+        )
+    assert result.text == "updated"
+    assert body_seen == {"text": "updated", "send_at": "2026-07-01T09:00:00Z"}
+
+
+def test_delete_scheduled_message_returns_none(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)
+
+    with mock_client(handler) as client:
+        assert client.scheduled_messages.delete("sched_1") is None
+
+
+def test_scheduled_messages_propagates_authentication_error(mock_client) -> None:
+    def handler(_req: httpx.Request) -> httpx.Response:
+        body = {
+            "error": {
+                "code": "authentication_required",
+                "message": "bad key",
+                "request_id": "req_z",
+            }
+        }
+        return httpx.Response(
+            401,
+            content=json.dumps(body).encode(),
+            headers={"content-type": "application/json"},
+        )
+
+    with mock_client(handler) as client:
+        with pytest.raises(AuthenticationError) as info:
+            client.scheduled_messages.retrieve("sched_1")
+    assert info.value.code == "authentication_required"
+    assert info.value.message == "bad key"
+    assert info.value.request_id == "req_z"
+
+
+def test_scheduled_messages_missing_required_field_raises_validation_error(mock_client) -> None:
+    def handler(_req: httpx.Request) -> httpx.Response:
+        return httpx.Response(200, content=b"{}", headers={"content-type": "application/json"})
+
+    with mock_client(handler) as client:
+        with pytest.raises(ValidationError):
+            client.scheduled_messages.retrieve("sched_1")

blueticks-3.2.0/src/blueticks/_version.py

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

blueticks-3.2.0/src/blueticks/resources/__init__.py

@@ -1,4 +0,0 @@
-from blueticks.resources.account import AccountResource
-from blueticks.resources.ping import PingResource
-
-__all__ = ["AccountResource", "PingResource"]