blueticks 3.2.0__tar.gz → 3.3.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {blueticks-3.2.0/src/blueticks.egg-info → blueticks-3.3.1}/PKG-INFO +1 -1
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/_client.py +2 -0
- blueticks-3.3.1/src/blueticks/_version.py +1 -0
- blueticks-3.3.1/src/blueticks/resources/__init__.py +27 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/chats.py +35 -15
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/groups.py +22 -15
- blueticks-3.3.1/src/blueticks/resources/scheduled_messages.py +70 -0
- blueticks-3.3.1/src/blueticks/types/__init__.py +48 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/chats.py +74 -1
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/groups.py +11 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/messages.py +1 -1
- blueticks-3.3.1/src/blueticks/types/scheduled_messages.py +26 -0
- {blueticks-3.2.0 → blueticks-3.3.1/src/blueticks.egg-info}/PKG-INFO +1 -1
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks.egg-info/SOURCES.txt +5 -0
- blueticks-3.3.1/tests/test_chats.py +261 -0
- blueticks-3.3.1/tests/test_groups.py +175 -0
- blueticks-3.3.1/tests/test_scheduled_messages.py +155 -0
- blueticks-3.2.0/src/blueticks/_version.py +0 -1
- blueticks-3.2.0/src/blueticks/resources/__init__.py +0 -4
- blueticks-3.2.0/src/blueticks/types/__init__.py +0 -21
- {blueticks-3.2.0 → blueticks-3.3.1}/LICENSE +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/README.md +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/pyproject.toml +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/setup.cfg +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/__init__.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/_base_resource.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/_errors.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/_transport.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/py.typed +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/account.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/audiences.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/campaigns.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/contacts.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/engines.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/messages.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/ping.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/utils.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/resources/webhooks.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/account.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/audiences.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/campaigns.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/contacts.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/engines.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/page.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/ping.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/utils.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/types/webhooks.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks/webhooks.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks.egg-info/dependency_links.txt +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks.egg-info/requires.txt +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/src/blueticks.egg-info/top_level.txt +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_account.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_audiences.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_campaigns.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_client.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_errors.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_messages.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_ping.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_transport.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_types.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_webhook_verify.py +0 -0
- {blueticks-3.2.0 → blueticks-3.3.1}/tests/test_webhooks_resource.py +0 -0
|
@@ -69,6 +69,7 @@ class Blueticks:
|
|
|
69
69
|
from blueticks.resources.engines import EnginesResource
|
|
70
70
|
from blueticks.resources.groups import GroupsResource
|
|
71
71
|
from blueticks.resources.messages import MessagesResource
|
|
72
|
+
from blueticks.resources.scheduled_messages import ScheduledMessagesResource
|
|
72
73
|
from blueticks.resources.utils import UtilsResource
|
|
73
74
|
from blueticks.resources.webhooks import WebhooksResource
|
|
74
75
|
|
|
@@ -80,6 +81,7 @@ class Blueticks:
|
|
|
80
81
|
self.engines = EnginesResource(self)
|
|
81
82
|
self.groups = GroupsResource(self)
|
|
82
83
|
self.messages = MessagesResource(self)
|
|
84
|
+
self.scheduled_messages = ScheduledMessagesResource(self)
|
|
83
85
|
self.utils = UtilsResource(self)
|
|
84
86
|
self.webhooks = WebhooksResource(self)
|
|
85
87
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "3.3.1"
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
from blueticks.resources.account import AccountResource
|
|
2
|
+
from blueticks.resources.audiences import AudiencesResource
|
|
3
|
+
from blueticks.resources.campaigns import CampaignsResource
|
|
4
|
+
from blueticks.resources.chats import ChatsResource
|
|
5
|
+
from blueticks.resources.contacts import ContactsResource
|
|
6
|
+
from blueticks.resources.engines import EnginesResource
|
|
7
|
+
from blueticks.resources.groups import GroupsResource
|
|
8
|
+
from blueticks.resources.messages import MessagesResource
|
|
9
|
+
from blueticks.resources.ping import PingResource
|
|
10
|
+
from blueticks.resources.scheduled_messages import ScheduledMessagesResource
|
|
11
|
+
from blueticks.resources.utils import UtilsResource
|
|
12
|
+
from blueticks.resources.webhooks import WebhooksResource
|
|
13
|
+
|
|
14
|
+
__all__ = [
|
|
15
|
+
"AccountResource",
|
|
16
|
+
"AudiencesResource",
|
|
17
|
+
"CampaignsResource",
|
|
18
|
+
"ChatsResource",
|
|
19
|
+
"ContactsResource",
|
|
20
|
+
"EnginesResource",
|
|
21
|
+
"GroupsResource",
|
|
22
|
+
"MessagesResource",
|
|
23
|
+
"PingResource",
|
|
24
|
+
"ScheduledMessagesResource",
|
|
25
|
+
"UtilsResource",
|
|
26
|
+
"WebhooksResource",
|
|
27
|
+
]
|
|
@@ -1,9 +1,22 @@
|
|
|
1
1
|
from __future__ import annotations
|
|
2
2
|
|
|
3
|
+
from collections.abc import Sequence # avoids shadowing by `ChatsResource.list`
|
|
3
4
|
from typing import Any
|
|
4
5
|
|
|
5
6
|
from blueticks._base_resource import BaseResource
|
|
6
|
-
from blueticks.types.chats import
|
|
7
|
+
from blueticks.types.chats import (
|
|
8
|
+
BatchMessageAcksResponse,
|
|
9
|
+
Chat,
|
|
10
|
+
ChatMedia,
|
|
11
|
+
ChatMessage,
|
|
12
|
+
ChatRef,
|
|
13
|
+
LoadOlderMessagesResponse,
|
|
14
|
+
MediaUrlResponse,
|
|
15
|
+
MessageAck,
|
|
16
|
+
MessageType,
|
|
17
|
+
OkResponse,
|
|
18
|
+
Participant,
|
|
19
|
+
)
|
|
7
20
|
from blueticks.types.page import Page
|
|
8
21
|
|
|
9
22
|
|
|
@@ -49,13 +62,15 @@ class ChatsResource(BaseResource):
|
|
|
49
62
|
)
|
|
50
63
|
return Page[Participant].model_validate(data)
|
|
51
64
|
|
|
52
|
-
def mark_read(self, chat_id: str) ->
|
|
65
|
+
def mark_read(self, chat_id: str) -> OkResponse:
|
|
53
66
|
"""Mark a chat as read (sends read receipts if enabled)."""
|
|
54
|
-
|
|
67
|
+
data = self._client._request("POST", f"/v1/chats/{chat_id}/mark_read")
|
|
68
|
+
return OkResponse.model_validate(data)
|
|
55
69
|
|
|
56
|
-
def open(self, chat_id: str) ->
|
|
70
|
+
def open(self, chat_id: str) -> ChatRef:
|
|
57
71
|
"""Open a chat on the engine (useful for UI-assisted workflows)."""
|
|
58
|
-
|
|
72
|
+
data = self._client._request("POST", f"/v1/chats/{chat_id}/open")
|
|
73
|
+
return ChatRef.model_validate(data)
|
|
59
74
|
|
|
60
75
|
def list_messages(
|
|
61
76
|
self,
|
|
@@ -99,35 +114,40 @@ class ChatsResource(BaseResource):
|
|
|
99
114
|
data = self._client._request("GET", f"/v1/chats/{chat_id}/messages/{key}")
|
|
100
115
|
return ChatMessage.model_validate(data)
|
|
101
116
|
|
|
102
|
-
def get_message_ack(self, chat_id: str, key: str) ->
|
|
117
|
+
def get_message_ack(self, chat_id: str, key: str) -> MessageAck:
|
|
103
118
|
"""Fetch ACK state for a single message."""
|
|
104
|
-
|
|
119
|
+
data = self._client._request("GET", f"/v1/chats/{chat_id}/messages/{key}/ack")
|
|
120
|
+
return MessageAck.model_validate(data)
|
|
105
121
|
|
|
106
|
-
def react(self, chat_id: str, key: str, *, emoji: str) ->
|
|
122
|
+
def react(self, chat_id: str, key: str, *, emoji: str) -> OkResponse:
|
|
107
123
|
"""Add or clear an emoji reaction on a message."""
|
|
108
|
-
|
|
124
|
+
data = self._client._request(
|
|
109
125
|
"POST",
|
|
110
126
|
f"/v1/chats/{chat_id}/messages/{key}/reactions",
|
|
111
127
|
body={"emoji": emoji},
|
|
112
128
|
)
|
|
129
|
+
return OkResponse.model_validate(data)
|
|
113
130
|
|
|
114
|
-
def load_older_messages(self, chat_id: str) ->
|
|
131
|
+
def load_older_messages(self, chat_id: str) -> LoadOlderMessagesResponse:
|
|
115
132
|
"""Pull older messages from the phone into the engine's local store."""
|
|
116
|
-
|
|
133
|
+
data = self._client._request("POST", f"/v1/chats/{chat_id}/messages/load_older")
|
|
134
|
+
return LoadOlderMessagesResponse.model_validate(data)
|
|
117
135
|
|
|
118
136
|
def get_media(self, chat_id: str, key: str) -> ChatMedia:
|
|
119
137
|
"""Download message media (may be returned as base64)."""
|
|
120
138
|
data = self._client._request("GET", f"/v1/chats/{chat_id}/messages/{key}/media")
|
|
121
139
|
return ChatMedia.model_validate(data)
|
|
122
140
|
|
|
123
|
-
def get_media_url(self, chat_id: str, key: str) ->
|
|
141
|
+
def get_media_url(self, chat_id: str, key: str) -> MediaUrlResponse:
|
|
124
142
|
"""Get a short-lived URL for message media, if available."""
|
|
125
|
-
|
|
143
|
+
data = self._client._request("GET", f"/v1/chats/{chat_id}/messages/{key}/media_url")
|
|
144
|
+
return MediaUrlResponse.model_validate(data)
|
|
126
145
|
|
|
127
|
-
def batch_message_acks(self, *, message_keys:
|
|
146
|
+
def batch_message_acks(self, *, message_keys: Sequence[str]) -> BatchMessageAcksResponse:
|
|
128
147
|
"""Batch-fetch ACK data for up to 200 message keys at once."""
|
|
129
|
-
|
|
148
|
+
data = self._client._request(
|
|
130
149
|
"POST",
|
|
131
150
|
"/v1/chats/message_acks",
|
|
132
151
|
body={"message_keys": message_keys},
|
|
133
152
|
)
|
|
153
|
+
return BatchMessageAcksResponse.model_validate(data)
|
|
@@ -25,32 +25,37 @@ class GroupsResource(BaseResource):
|
|
|
25
25
|
*,
|
|
26
26
|
name: str | None = None,
|
|
27
27
|
settings: dict[str, bool] | None = None,
|
|
28
|
-
) ->
|
|
28
|
+
) -> Group:
|
|
29
29
|
"""Rename the group and/or update admin-only settings."""
|
|
30
30
|
body: dict[str, Any] = {}
|
|
31
31
|
if name is not None:
|
|
32
32
|
body["name"] = name
|
|
33
33
|
if settings is not None:
|
|
34
34
|
body["settings"] = settings
|
|
35
|
-
|
|
35
|
+
data = self._client._request("PATCH", f"/v1/groups/{group_id}", body=body)
|
|
36
|
+
return Group.model_validate(data)
|
|
36
37
|
|
|
37
|
-
def add_member(self, group_id: str, *, chat_id: str) ->
|
|
38
|
+
def add_member(self, group_id: str, *, chat_id: str) -> Group:
|
|
38
39
|
"""Invite a contact to the group."""
|
|
39
|
-
|
|
40
|
+
data = self._client._request(
|
|
40
41
|
"POST", f"/v1/groups/{group_id}/members", body={"chat_id": chat_id}
|
|
41
42
|
)
|
|
43
|
+
return Group.model_validate(data)
|
|
42
44
|
|
|
43
|
-
def remove_member(self, group_id: str, chat_id: str) ->
|
|
45
|
+
def remove_member(self, group_id: str, chat_id: str) -> Group:
|
|
44
46
|
"""Remove a participant from the group."""
|
|
45
|
-
|
|
47
|
+
data = self._client._request("DELETE", f"/v1/groups/{group_id}/members/{chat_id}")
|
|
48
|
+
return Group.model_validate(data)
|
|
46
49
|
|
|
47
|
-
def promote_admin(self, group_id: str, chat_id: str) ->
|
|
50
|
+
def promote_admin(self, group_id: str, chat_id: str) -> Group:
|
|
48
51
|
"""Grant admin rights to a participant."""
|
|
49
|
-
|
|
52
|
+
data = self._client._request("POST", f"/v1/groups/{group_id}/members/{chat_id}/admin")
|
|
53
|
+
return Group.model_validate(data)
|
|
50
54
|
|
|
51
|
-
def demote_admin(self, group_id: str, chat_id: str) ->
|
|
55
|
+
def demote_admin(self, group_id: str, chat_id: str) -> Group:
|
|
52
56
|
"""Revoke admin rights from a participant."""
|
|
53
|
-
|
|
57
|
+
data = self._client._request("DELETE", f"/v1/groups/{group_id}/members/{chat_id}/admin")
|
|
58
|
+
return Group.model_validate(data)
|
|
54
59
|
|
|
55
60
|
def set_picture(
|
|
56
61
|
self,
|
|
@@ -59,15 +64,17 @@ class GroupsResource(BaseResource):
|
|
|
59
64
|
file_data_url: str,
|
|
60
65
|
file_name: str | None = None,
|
|
61
66
|
file_mime_type: str | None = None,
|
|
62
|
-
) ->
|
|
67
|
+
) -> Group:
|
|
63
68
|
"""Upload a new group avatar (base64 data URL)."""
|
|
64
69
|
body: dict[str, Any] = {"file_data_url": file_data_url}
|
|
65
70
|
if file_name is not None:
|
|
66
71
|
body["file_name"] = file_name
|
|
67
72
|
if file_mime_type is not None:
|
|
68
73
|
body["file_mime_type"] = file_mime_type
|
|
69
|
-
|
|
74
|
+
data = self._client._request("PUT", f"/v1/groups/{group_id}/picture", body=body)
|
|
75
|
+
return Group.model_validate(data)
|
|
70
76
|
|
|
71
|
-
def leave(self, group_id: str) ->
|
|
72
|
-
"""Leave the group (as the authenticated user)."""
|
|
73
|
-
|
|
77
|
+
def leave(self, group_id: str) -> None:
|
|
78
|
+
"""Leave the group (as the authenticated user). Returns 204 No Content."""
|
|
79
|
+
self._client._request("DELETE", f"/v1/groups/{group_id}/members/me")
|
|
80
|
+
return None
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any
|
|
4
|
+
|
|
5
|
+
from blueticks._base_resource import BaseResource
|
|
6
|
+
from blueticks.types.page import Page
|
|
7
|
+
from blueticks.types.scheduled_messages import ScheduledMessage
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class ScheduledMessagesResource(BaseResource):
|
|
11
|
+
def list(
|
|
12
|
+
self,
|
|
13
|
+
*,
|
|
14
|
+
limit: int | None = None,
|
|
15
|
+
cursor: str | None = None,
|
|
16
|
+
) -> Page[ScheduledMessage]:
|
|
17
|
+
"""List scheduled messages.
|
|
18
|
+
|
|
19
|
+
Retrieves a list of all resources from the service.
|
|
20
|
+
"""
|
|
21
|
+
params: dict[str, Any] = {}
|
|
22
|
+
if limit is not None:
|
|
23
|
+
params["limit"] = limit
|
|
24
|
+
if cursor is not None:
|
|
25
|
+
params["cursor"] = cursor
|
|
26
|
+
data = self._client._request("GET", "/v1/scheduled-messages", params=params or None)
|
|
27
|
+
return Page[ScheduledMessage].model_validate(data)
|
|
28
|
+
|
|
29
|
+
def retrieve(self, scheduled_message_id: str) -> ScheduledMessage:
|
|
30
|
+
"""Get scheduled message.
|
|
31
|
+
|
|
32
|
+
Retrieves a single resource with the given id from the service.
|
|
33
|
+
"""
|
|
34
|
+
data = self._client._request("GET", f"/v1/scheduled-messages/{scheduled_message_id}")
|
|
35
|
+
return ScheduledMessage.model_validate(data)
|
|
36
|
+
|
|
37
|
+
def update(
|
|
38
|
+
self,
|
|
39
|
+
scheduled_message_id: str,
|
|
40
|
+
*,
|
|
41
|
+
text: str | None = None,
|
|
42
|
+
media_url: str | None = None,
|
|
43
|
+
media_caption: str | None = None,
|
|
44
|
+
send_at: str | None = None,
|
|
45
|
+
) -> ScheduledMessage:
|
|
46
|
+
"""Update scheduled message.
|
|
47
|
+
|
|
48
|
+
Updates the resource identified by id using data.
|
|
49
|
+
"""
|
|
50
|
+
body: dict[str, Any] = {}
|
|
51
|
+
if text is not None:
|
|
52
|
+
body["text"] = text
|
|
53
|
+
if media_url is not None:
|
|
54
|
+
body["media_url"] = media_url
|
|
55
|
+
if media_caption is not None:
|
|
56
|
+
body["media_caption"] = media_caption
|
|
57
|
+
if send_at is not None:
|
|
58
|
+
body["send_at"] = send_at
|
|
59
|
+
data = self._client._request(
|
|
60
|
+
"PATCH", f"/v1/scheduled-messages/{scheduled_message_id}", body=body
|
|
61
|
+
)
|
|
62
|
+
return ScheduledMessage.model_validate(data)
|
|
63
|
+
|
|
64
|
+
def delete(self, scheduled_message_id: str) -> None:
|
|
65
|
+
"""Cancel scheduled message.
|
|
66
|
+
|
|
67
|
+
Removes the resource with id.
|
|
68
|
+
"""
|
|
69
|
+
self._client._request("DELETE", f"/v1/scheduled-messages/{scheduled_message_id}")
|
|
70
|
+
return None
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
from blueticks.types.account import Account
|
|
2
|
+
from blueticks.types.audiences import AppendContactsResult, Audience, Contact
|
|
3
|
+
from blueticks.types.campaigns import Campaign
|
|
4
|
+
from blueticks.types.chats import (
|
|
5
|
+
BatchMessageAcksResponse,
|
|
6
|
+
Chat,
|
|
7
|
+
ChatMedia,
|
|
8
|
+
ChatMessage,
|
|
9
|
+
ChatRef,
|
|
10
|
+
LoadOlderMessagesResponse,
|
|
11
|
+
MediaUrlResponse,
|
|
12
|
+
MessageAck,
|
|
13
|
+
OkResponse,
|
|
14
|
+
Participant,
|
|
15
|
+
)
|
|
16
|
+
from blueticks.types.groups import Group, GroupParticipant
|
|
17
|
+
from blueticks.types.messages import Message
|
|
18
|
+
from blueticks.types.page import Page
|
|
19
|
+
from blueticks.types.ping import Ping
|
|
20
|
+
from blueticks.types.scheduled_messages import ScheduledMessage
|
|
21
|
+
from blueticks.types.webhooks import Webhook, WebhookCreateResult, WebhookEvent
|
|
22
|
+
|
|
23
|
+
__all__ = [
|
|
24
|
+
"Account",
|
|
25
|
+
"AppendContactsResult",
|
|
26
|
+
"Audience",
|
|
27
|
+
"BatchMessageAcksResponse",
|
|
28
|
+
"Campaign",
|
|
29
|
+
"Chat",
|
|
30
|
+
"ChatMedia",
|
|
31
|
+
"ChatMessage",
|
|
32
|
+
"ChatRef",
|
|
33
|
+
"Contact",
|
|
34
|
+
"Group",
|
|
35
|
+
"GroupParticipant",
|
|
36
|
+
"LoadOlderMessagesResponse",
|
|
37
|
+
"MediaUrlResponse",
|
|
38
|
+
"Message",
|
|
39
|
+
"MessageAck",
|
|
40
|
+
"OkResponse",
|
|
41
|
+
"Page",
|
|
42
|
+
"Participant",
|
|
43
|
+
"Ping",
|
|
44
|
+
"ScheduledMessage",
|
|
45
|
+
"Webhook",
|
|
46
|
+
"WebhookCreateResult",
|
|
47
|
+
"WebhookEvent",
|
|
48
|
+
]
|
|
@@ -70,6 +70,7 @@ class ChatMessage(BaseModel):
|
|
|
70
70
|
MediaUnavailableReason = Literal[
|
|
71
71
|
"expired",
|
|
72
72
|
"fetching",
|
|
73
|
+
"awaiting_sender",
|
|
73
74
|
"error",
|
|
74
75
|
"no_media",
|
|
75
76
|
]
|
|
@@ -87,4 +88,76 @@ class ChatMedia(BaseModel):
|
|
|
87
88
|
# genuine original from the sender.
|
|
88
89
|
original_quality: Optional[bool] = None # noqa: UP045
|
|
89
90
|
# Reason the bytes couldn't be retrieved. None/absent on success.
|
|
90
|
-
|
|
91
|
+
# "expired" = WA aged the file out of CDN retention. "fetching" = WA is
|
|
92
|
+
# mid-download from its CDN — transient, retry in a few seconds.
|
|
93
|
+
# "awaiting_sender" = WA's CDN doesn't have the file but has asked the
|
|
94
|
+
# sender's device to reupload it; only completes when the sender's
|
|
95
|
+
# WhatsApp client is open and online. "error" = unexpected failure.
|
|
96
|
+
# "no_media" = the message is text-only/revoked/location/vcard.
|
|
97
|
+
media_unavailable: Optional[MediaUnavailableReason] = Field( # noqa: UP045
|
|
98
|
+
default=None,
|
|
99
|
+
description=(
|
|
100
|
+
"Set when the bytes could not be downloaded or never existed. "
|
|
101
|
+
'"expired" = WA aged the file out of CDN retention. '
|
|
102
|
+
'"fetching" = WA is mid-download from its CDN — transient, retry in a few seconds. '
|
|
103
|
+
"\"awaiting_sender\" = WA's CDN does not have the file but has asked the sender's "
|
|
104
|
+
"device to reupload it; only completes when the sender's WhatsApp client is open and "
|
|
105
|
+
'online. "error" = unexpected failure. "no_media" = the message is text-only / revoked '
|
|
106
|
+
"/ location / vcard."
|
|
107
|
+
),
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
class OkResponse(BaseModel):
|
|
112
|
+
"""Generic ok envelope returned by mark_read and react endpoints."""
|
|
113
|
+
|
|
114
|
+
model_config = ConfigDict(extra="ignore")
|
|
115
|
+
|
|
116
|
+
ok: Literal[True]
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
class ChatRef(BaseModel):
|
|
120
|
+
"""Response from POST /v1/chats/{chat_id}/open."""
|
|
121
|
+
|
|
122
|
+
model_config = ConfigDict(extra="ignore")
|
|
123
|
+
|
|
124
|
+
chat_id: str
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
class MessageAck(BaseModel):
|
|
128
|
+
"""Response from GET /v1/chats/{chat_id}/messages/{key}/ack.
|
|
129
|
+
|
|
130
|
+
`ack` codes: -1=error, 0=pending, 1=server, 2=device, 3=read, 4=played;
|
|
131
|
+
None when no engine response.
|
|
132
|
+
"""
|
|
133
|
+
|
|
134
|
+
model_config = ConfigDict(extra="ignore")
|
|
135
|
+
|
|
136
|
+
ack: Optional[int] = None # noqa: UP045
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
class LoadOlderMessagesResponse(BaseModel):
|
|
140
|
+
"""Response from POST /v1/chats/{chat_id}/messages/load_older."""
|
|
141
|
+
|
|
142
|
+
model_config = ConfigDict(extra="ignore")
|
|
143
|
+
|
|
144
|
+
total_messages: Optional[int] = None # noqa: UP045
|
|
145
|
+
added: Optional[int] = None # noqa: UP045
|
|
146
|
+
can_load_more: bool
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
class MediaUrlResponse(BaseModel):
|
|
150
|
+
"""Response from GET /v1/chats/{chat_id}/messages/{key}/media_url."""
|
|
151
|
+
|
|
152
|
+
model_config = ConfigDict(extra="ignore")
|
|
153
|
+
|
|
154
|
+
url: Optional[str] = None # noqa: UP045
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
class BatchMessageAcksResponse(BaseModel):
|
|
158
|
+
"""Response from POST /v1/chats/message_acks."""
|
|
159
|
+
|
|
160
|
+
model_config = ConfigDict(extra="ignore")
|
|
161
|
+
|
|
162
|
+
# Each item is a free-form ack record (additionalProperties: true).
|
|
163
|
+
data: list[dict[str, object]]
|
|
@@ -6,6 +6,15 @@ from typing import Optional # noqa: UP045
|
|
|
6
6
|
from pydantic import BaseModel, ConfigDict
|
|
7
7
|
|
|
8
8
|
|
|
9
|
+
class GroupParticipant(BaseModel):
|
|
10
|
+
model_config = ConfigDict(extra="ignore")
|
|
11
|
+
|
|
12
|
+
chat_id: str
|
|
13
|
+
is_admin: bool
|
|
14
|
+
is_super_admin: bool
|
|
15
|
+
name: Optional[str] = None # noqa: UP045
|
|
16
|
+
|
|
17
|
+
|
|
9
18
|
class Group(BaseModel):
|
|
10
19
|
model_config = ConfigDict(extra="ignore")
|
|
11
20
|
|
|
@@ -14,6 +23,8 @@ class Group(BaseModel):
|
|
|
14
23
|
description: Optional[str] = None # noqa: UP045
|
|
15
24
|
owner: Optional[str] = None # noqa: UP045
|
|
16
25
|
created_at: Optional[str] = None # noqa: UP045
|
|
26
|
+
last_message_at: Optional[str] = None # noqa: UP045
|
|
17
27
|
participant_count: Optional[int] = None # noqa: UP045
|
|
18
28
|
announce: Optional[bool] = None # noqa: UP045
|
|
19
29
|
restrict: Optional[bool] = None # noqa: UP045
|
|
30
|
+
participants: Optional[list[GroupParticipant]] = None # noqa: UP045
|
|
@@ -5,7 +5,7 @@ from typing import Literal, Optional
|
|
|
5
5
|
|
|
6
6
|
from pydantic import BaseModel, ConfigDict, Field
|
|
7
7
|
|
|
8
|
-
MessageStatus = Literal["scheduled", "queued", "sending", "delivered", "failed"]
|
|
8
|
+
MessageStatus = Literal["scheduled", "queued", "sending", "delivered", "read", "failed"]
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
class Message(BaseModel):
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
# ruff: noqa: UP045 # Pydantic field annotations need Optional[T] for Python 3.9 (see CLAUDE.md)
|
|
4
|
+
from typing import Optional # noqa: UP045
|
|
5
|
+
|
|
6
|
+
from pydantic import BaseModel, ConfigDict
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class ScheduledMessage(BaseModel):
|
|
10
|
+
"""A message queued for future delivery via /v1/scheduled-messages."""
|
|
11
|
+
|
|
12
|
+
model_config = ConfigDict(extra="ignore")
|
|
13
|
+
|
|
14
|
+
id: str
|
|
15
|
+
to: Optional[str] = None # noqa: UP045
|
|
16
|
+
text: Optional[str] = None # noqa: UP045
|
|
17
|
+
media_url: Optional[str] = None # noqa: UP045
|
|
18
|
+
media_caption: Optional[str] = None # noqa: UP045
|
|
19
|
+
media_filename: Optional[str] = None # noqa: UP045
|
|
20
|
+
media_mime_type: Optional[str] = None # noqa: UP045
|
|
21
|
+
send_at: Optional[str] = None # noqa: UP045
|
|
22
|
+
status: Optional[str] = None # noqa: UP045
|
|
23
|
+
is_recurring: bool
|
|
24
|
+
recurrence_rule: Optional[str] = None # noqa: UP045
|
|
25
|
+
created_at: Optional[str] = None # noqa: UP045
|
|
26
|
+
updated_at: Optional[str] = None # noqa: UP045
|
|
@@ -24,6 +24,7 @@ src/blueticks/resources/engines.py
|
|
|
24
24
|
src/blueticks/resources/groups.py
|
|
25
25
|
src/blueticks/resources/messages.py
|
|
26
26
|
src/blueticks/resources/ping.py
|
|
27
|
+
src/blueticks/resources/scheduled_messages.py
|
|
27
28
|
src/blueticks/resources/utils.py
|
|
28
29
|
src/blueticks/resources/webhooks.py
|
|
29
30
|
src/blueticks/types/__init__.py
|
|
@@ -37,15 +38,19 @@ src/blueticks/types/groups.py
|
|
|
37
38
|
src/blueticks/types/messages.py
|
|
38
39
|
src/blueticks/types/page.py
|
|
39
40
|
src/blueticks/types/ping.py
|
|
41
|
+
src/blueticks/types/scheduled_messages.py
|
|
40
42
|
src/blueticks/types/utils.py
|
|
41
43
|
src/blueticks/types/webhooks.py
|
|
42
44
|
tests/test_account.py
|
|
43
45
|
tests/test_audiences.py
|
|
44
46
|
tests/test_campaigns.py
|
|
47
|
+
tests/test_chats.py
|
|
45
48
|
tests/test_client.py
|
|
46
49
|
tests/test_errors.py
|
|
50
|
+
tests/test_groups.py
|
|
47
51
|
tests/test_messages.py
|
|
48
52
|
tests/test_ping.py
|
|
53
|
+
tests/test_scheduled_messages.py
|
|
49
54
|
tests/test_transport.py
|
|
50
55
|
tests/test_types.py
|
|
51
56
|
tests/test_webhook_verify.py
|