broadcast-python 0.2.0__tar.gz → 0.4.0__tar.gz

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+
+## [0.4.0] - 2026-10-06
+
+### Added
+
+- `client.topics` for `/api/v1/topics` (subscriber topics): `list`, `get`,
+  `create`, `update`, `delete`. Topics use the subscriber permissions.
+  Broadcasts and sequences accept `topic_id`.
+- `subscribers.update(email, custom_data_mode="merge", ...)`: change only the
+  custom_data keys sent; `None` deletes a key. The default stays replace.
+- `subscriber.preferences_updated` webhook event type, in `SUBSCRIBER_EVENTS`
+  and `EVENT_TYPES` (now 35).
+
+## [0.3.0] - 2026-10-03
+
+### Added
+
+- `client.migration.unsubscribed_emails()` for
+  `GET /api/migration/v1/unsubscribed_emails`, the channel's own suppression
+  list; `each_record("unsubscribed_emails")` pages it. `suppressions` returns
+  only the global suppression list, so an export needs both.
+
 ## [0.2.0] - 2026-09-25
 
 ### Added

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: broadcast-python
-Version: 0.2.0
+Version: 0.4.0
 Summary: Python client for the Broadcast email platform. Subscribers, sequences, broadcasts, segments, templates, autopilot, webhooks, and transactional email.
 Project-URL: Homepage, https://sendbroadcast.net
 Project-URL: Repository, https://github.com/send-broadcast/broadcast-python
@@ -246,6 +246,32 @@ client.opt_in_forms.duplicate(id, label="Copy")
 
 Reading a segment recounts its members server-side, so `segments.get` is not free.
 
+### Topics
+
+A topic is one kind of email subscribers opt in to or out of (webinars, offers).
+Its value lives in a top-level `custom_data` key (`True`, `False`, or no value)
+or in a tag. `unset_receives` decides, at send time, whether a subscriber with no
+value receives it; Broadcast never writes a default. Topics use the subscriber
+permissions.
+
+```python
+topic = client.topics.create(name="Webinars", custom_data_key="sub_webinars")
+client.topics.create(name="News", storage="tag", tag_name="news")
+client.topics.list()
+client.topics.update(topic["id"], unset_receives=False)
+client.topics.delete(topic["id"])  # 422 while a broadcast or sequence uses it
+
+# Send to a topic: (segments) AND topic
+client.broadcasts.create(subject="Webinar", body="...", segment_ids=[2], topic_id=topic["id"])
+
+# Change only the keys you send (None deletes a key); the default replaces custom_data
+client.subscribers.update("jane@example.com", custom_data={"sub_webinars": False}, custom_data_mode="merge")
+```
+
+The subscriber JSON has `topics`: each topic's stored value (`True`, `False`, or
+`None`). Topic changes fire `subscriber.preferences_updated` as well as
+`subscriber.updated`.
+
 ### Channel design (brand kit)
 
 ```python
@@ -363,6 +389,11 @@ client.migration.manifest()
 for sub in client.migration.each_record("subscribers"):
     ...   # auto-pages; advances by the limit the server actually applied
 
+# Suppressed addresses live in two lists; export both:
+# suppressions = global suppression list, unsubscribed_emails = the channel's own
+for row in client.migration.each_record("unsubscribed_emails"):
+    ...   # {"id", "email", "broadcast_channel_id", "created_at", "updated_at"}
+
 data = client.migration.download_file_asset(id)   # bytes
 ```
 
@@ -408,7 +439,7 @@ every rejection rather than distinguishing them.
 Pass the **raw** request body. Re-serialising a parsed dict changes the bytes
 and verification will fail.
 
-`broadcast_python.EVENT_TYPES` lists all 34 event names. `SUBSCRIBER_EVENTS`
+`broadcast_python.EVENT_TYPES` lists all 35 event names. `SUBSCRIBER_EVENTS`
 includes `subscribers.purged` and `subscribers.purge_failed`: a purge of the
 whole list sends one of these instead of a `subscriber.deleted` per subscriber.
 

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/README.md

@@ -222,6 +222,32 @@ client.opt_in_forms.duplicate(id, label="Copy")
 
 Reading a segment recounts its members server-side, so `segments.get` is not free.
 
+### Topics
+
+A topic is one kind of email subscribers opt in to or out of (webinars, offers).
+Its value lives in a top-level `custom_data` key (`True`, `False`, or no value)
+or in a tag. `unset_receives` decides, at send time, whether a subscriber with no
+value receives it; Broadcast never writes a default. Topics use the subscriber
+permissions.
+
+```python
+topic = client.topics.create(name="Webinars", custom_data_key="sub_webinars")
+client.topics.create(name="News", storage="tag", tag_name="news")
+client.topics.list()
+client.topics.update(topic["id"], unset_receives=False)
+client.topics.delete(topic["id"])  # 422 while a broadcast or sequence uses it
+
+# Send to a topic: (segments) AND topic
+client.broadcasts.create(subject="Webinar", body="...", segment_ids=[2], topic_id=topic["id"])
+
+# Change only the keys you send (None deletes a key); the default replaces custom_data
+client.subscribers.update("jane@example.com", custom_data={"sub_webinars": False}, custom_data_mode="merge")
+```
+
+The subscriber JSON has `topics`: each topic's stored value (`True`, `False`, or
+`None`). Topic changes fire `subscriber.preferences_updated` as well as
+`subscriber.updated`.
+
 ### Channel design (brand kit)
 
 ```python
@@ -339,6 +365,11 @@ client.migration.manifest()
 for sub in client.migration.each_record("subscribers"):
     ...   # auto-pages; advances by the limit the server actually applied
 
+# Suppressed addresses live in two lists; export both:
+# suppressions = global suppression list, unsubscribed_emails = the channel's own
+for row in client.migration.each_record("unsubscribed_emails"):
+    ...   # {"id", "email", "broadcast_channel_id", "created_at", "updated_at"}
+
 data = client.migration.download_file_asset(id)   # bytes
 ```
 
@@ -384,7 +415,7 @@ every rejection rather than distinguishing them.
 Pass the **raw** request body. Re-serialising a parsed dict changes the bytes
 and verification will fail.
 
-`broadcast_python.EVENT_TYPES` lists all 34 event names. `SUBSCRIBER_EVENTS`
+`broadcast_python.EVENT_TYPES` lists all 35 event names. `SUBSCRIBER_EVENTS`
 includes `subscribers.purged` and `subscribers.purge_failed`: a purge of the
 whole list sends one of these instead of a `subscriber.deleted` per subscriber.
 

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "broadcast-python"
-version = "0.2.0"
+version = "0.4.0"
 description = "Python client for the Broadcast email platform. Subscribers, sequences, broadcasts, segments, templates, autopilot, webhooks, and transactional email."
 readme = "README.md"
 requires-python = ">=3.9"

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/src/broadcast_python/client.py

@@ -16,6 +16,7 @@ from .resources.sequences import Sequences
 from .resources.subscribers import Subscribers
 from .resources.suppressions import Suppressions
 from .resources.templates import Templates
+from .resources.topics import Topics
 from .resources.transactionals import Transactionals
 from .resources.users import Users
 from .resources.webhook_endpoints import WebhookEndpoints
@@ -40,6 +41,7 @@ class Broadcast:
         self.sequences = Sequences(self)
         self.broadcasts = Broadcasts(self)
         self.segments = Segments(self)
+        self.topics = Topics(self)
         self.templates = Templates(self)
         #: The channel's brand kit (Settings -> Design). Read-only.
         self.channel_design = ChannelDesign(self)

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/src/broadcast_python/resources/migration.py

@@ -35,6 +35,7 @@ COLLECTIONS = (
     "webhook_endpoints",
     "tokens",
     "suppressions",
+    "unsubscribed_emails",
     "tags",
     "users",
     "link_redirects",
@@ -106,7 +107,7 @@ def _make_collection_method(name: str):
     return method
 
 
-# Generated rather than hand-written: 18 near-identical methods invite the kind
+# Generated rather than hand-written: 19 near-identical methods invite the kind
 # of copy-paste drift this whole SDK family exists to prevent. Declared in
 # .api-coverage.yml so the coverage report still counts them.
 for _collection in COLLECTIONS:

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/src/broadcast_python/resources/subscribers.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from .base import BaseResource
 
@@ -46,8 +46,13 @@ class Subscribers(BaseResource):
 
         return self._post("/api/v1/subscribers.json", payload)
 
-    def update(self, email: str, **attrs: Any) -> Any:
-        return self._patch("/api/v1/subscribers.json", {"email": email, "subscriber": attrs})
+    def update(self, email: str, custom_data_mode: Optional[str] = None, **attrs: Any) -> Any:
+        """custom_data_mode: "replace" (the API default) stores custom_data as sent;
+        "merge" changes only the keys sent, and a None value deletes that key."""
+        payload: Dict[str, Any] = {"email": email, "subscriber": attrs}
+        if custom_data_mode:
+            payload["custom_data_mode"] = custom_data_mode
+        return self._patch("/api/v1/subscribers.json", payload)
 
     def add_tags(self, email: str, tags: List[str]) -> Any:
         return self._post("/api/v1/subscribers/add_tag.json", {"email": email, "tags": tags})

broadcast_python-0.4.0/src/broadcast_python/resources/topics.py

@@ -0,0 +1,29 @@
+from typing import Any, Union
+
+from .base import BaseResource
+
+Id = Union[str, int]
+
+
+class Topics(BaseResource):
+    """Subscriber topics: kinds of email subscribers opt in to or out of.
+
+    A topic reads a top-level custom_data key (true, false, or no value) or a
+    tag. Topics use the token's subscriber permissions.
+    """
+
+    def list(self, **params: Any) -> Any:
+        return self._get("/api/v1/topics.json", params)
+
+    def get(self, id: Id) -> Any:  # noqa: A002
+        return self._get("/api/v1/topics/{}.json".format(id), {})
+
+    def create(self, **attrs: Any) -> Any:
+        return self._post("/api/v1/topics", {"topic": attrs})
+
+    def update(self, id: Id, **attrs: Any) -> Any:  # noqa: A002
+        return self._patch("/api/v1/topics/{}".format(id), {"topic": attrs})
+
+    def delete(self, id: Id) -> Any:  # noqa: A002
+        """Refused (422) while a broadcast or sequence uses the topic."""
+        return self._delete("/api/v1/topics/{}".format(id))

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/src/broadcast_python/version.py

@@ -1,3 +1,3 @@
 # Kept in sync with pyproject.toml by tests/test_package.py — a User-Agent that
 # lies about its version misattributes server-side client analytics.
-VERSION = "0.2.0"
+VERSION = "0.4.0"

{broadcast_python-0.2.0 → broadcast_python-0.4.0}/src/broadcast_python/webhook.py

@@ -25,6 +25,7 @@ EMAIL_EVENTS = (
 SUBSCRIBER_EVENTS = (
     "subscriber.created",
     "subscriber.updated",
+    "subscriber.preferences_updated",
     "subscriber.deleted",
     "subscriber.subscribed",
     "subscriber.unsubscribed",