broadcast-python 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

broadcast_python/__init__.py

@@ -28,6 +28,7 @@ from .errors import (
 )
 from .resources.email_servers import REDACTED_FIELDS
 from .resources.migration import COLLECTIONS
+from .resources.opt_in_forms import TRIGGER_FREQUENCIES
 from .resources.transactionals import MAX_IDEMPOTENCY_KEY_LENGTH
 from .response import RateLimit, Response, Warning_
 from .version import VERSION
@@ -42,6 +43,7 @@ __all__ = [
     "EVENT_TYPES",
     "MAX_IDEMPOTENCY_KEY_LENGTH",
     "REDACTED_FIELDS",
+    "TRIGGER_FREQUENCIES",
     "VERSION",
     "WARNINGS_MODES",
     "APIError",

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/resources/autopilots.py

@@ -36,7 +36,8 @@ class Autopilots(BaseResource):
         write-only. Scheduling takes ``schedule_frequency`` (daily, weekly,
         biweekly, monthly), ``schedule_day_of_week``, ``schedule_day_of_month``,
         ``schedule_time``, ``schedule_timezone``. ``segment_ids`` restricts the
-        newsletter's audience.
+        newsletter's audience; ``excluded_segment_ids`` lists segments its
+        drafts never reach.
         """
         return self._post("/api/v1/autopilots", {"autopilot": attrs})
 

broadcast_python/resources/opt_in_forms.py

@@ -5,6 +5,12 @@ from .base import BaseResource, compact
 
 Id = Union[str, int]
 
+#: The words ``trigger_settings["frequency"]`` accepts: how often the same
+#: visitor sees a popup. ``always`` and ``every_visit`` mean the same. The server
+#: refuses any other word with 422 (:class:`ValidationError`); the client does
+#: not check, so an older server is never refused a word it would take.
+TRIGGER_FREQUENCIES = ("always", "every_visit", "once_per_session", "once_per_day", "once_per_week", "once")
+
 
 class OptInForms(BaseResource):
     def list(self, **params: Any) -> Any:
@@ -23,6 +29,9 @@ class OptInForms(BaseResource):
         Nested settings dicts (``theme_settings``, ``automation_settings``,
         ``security_settings``, ``trigger_settings``, ``widget_settings``) and
         the block arrays are passed through verbatim.
+        ``trigger_settings["frequency"]`` must be one of
+        :data:`TRIGGER_FREQUENCIES`; any other word raises
+        :class:`ValidationError` (422).
         """
         return self._post("/api/v1/opt_in_forms", {"opt_in_form": attrs})
 

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
 
@@ -33,7 +33,11 @@ class Subscribers(BaseResource):
         timestamp when migrating an already-confirmed list off another provider.
         It is ignored (with a warning) on update.
 
-        ``unsubscribed_at`` is never settable here; use :meth:`unsubscribe`.
+        ``unsubscribed_at`` (any token, create only, ISO 8601) stores the
+        subscriber as unsubscribed in the same request, for migrating a list
+        with its opt-outs intact: no confirmation email, 422 if it is in the
+        future or sent with ``is_active=True``. To unsubscribe an existing
+        subscriber, use :meth:`unsubscribe`.
         """
         double_opt_in = attrs.pop("double_opt_in", None)
         confirmation_template_id = attrs.pop("confirmation_template_id", None)
@@ -46,8 +50,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/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/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.3.0"
+VERSION = "0.5.0"

broadcast_python/webhook.py

@@ -15,6 +15,7 @@ EMAIL_EVENTS = (
     "email.sent",
     "email.delivered",
     "email.delivery_delayed",
+    "email.send_delayed",
     "email.complained",
     "email.bounced",
     "email.opened",
@@ -25,6 +26,7 @@ EMAIL_EVENTS = (
 SUBSCRIBER_EVENTS = (
     "subscriber.created",
     "subscriber.updated",
+    "subscriber.preferences_updated",
     "subscriber.deleted",
     "subscriber.subscribed",
     "subscriber.unsubscribed",
@@ -44,6 +46,7 @@ BROADCAST_EVENTS = (
     "broadcast.partial_failure",
     "broadcast.aborted",
     "broadcast.paused",
+    "broadcast.batch_completed",
 )
 
 SEQUENCE_EVENTS = (

{broadcast_python-0.3.0.dist-info → broadcast_python-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: broadcast-python
-Version: 0.3.0
+Version: 0.5.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
@@ -240,12 +240,46 @@ client.sequences.move_step(id, step_id, under_id)
 client.segments.create(name="VIPs")
 client.templates.create(label="Welcome", subject="Hi", body="...")
 client.opt_in_forms.analytics(id, start_date=date(2026, 1, 1))
+# How often the same visitor sees a popup: one of TRIGGER_FREQUENCIES, or ValidationError (422).
+client.opt_in_forms.update(id, trigger_settings={"frequency": "once_per_day"})
 client.opt_in_forms.create_variant(id, name="B", weight=50)
 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"])
+
+# Send to everyone except a segment (also on sequences and autopilots)
+client.broadcasts.create(subject="Offer", body="...", excluded_segment_ids=[competitors["id"]])
+
+# Migrate someone who already unsubscribed, in one request
+client.subscribers.create(email="opted-out@example.com", unsubscribed_at="2025-03-14T09:30:00Z")
+
+# 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
@@ -413,7 +447,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 37 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.3.0.dist-info → broadcast_python-0.5.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
-broadcast_python/__init__.py,sha256=_mzCFewxAEutE4fJ7hRPpaHuQwXpliHt5BNRE-J80TY,1632
-broadcast_python/client.py,sha256=9aS5Jhq06Um-nM0s9idUM2Cs_LkmJVG8THHqiHESbpA,5471
+broadcast_python/__init__.py,sha256=ZDjU3aAHHMONoEKnAPZpralqN1a3Z3Ddv73mkQWt4U0,1715
+broadcast_python/client.py,sha256=Sd_8vA0lFCl9Da3luwC10k9cGaREyK-AwotFXE4kb4c,5543
 broadcast_python/configuration.py,sha256=kXheoYhwRJo6STIL9Wmhl_MOEdWfaV3CBETEh1SbEcI,3961
 broadcast_python/connection.py,sha256=cAXyfwJ1pdleLm7S9fr1FUk5nqkdOTdav6dGZGJ0GfU,14064
 broadcast_python/errors.py,sha256=NFJ69Oy_FtYZ3-BEq8Q1m5wLqcufRZLPDYuJlgBfGpc,1993
 broadcast_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 broadcast_python/response.py,sha256=fIBzxi4a2Sc7sNSOb2_t85Y3Opdet89uNbHM5CX3YXw,5511
-broadcast_python/version.py,sha256=KdCknBvn0jI4v3L3k7hqoskHFgSkhHBXAZlj1VJlqFs,169
-broadcast_python/webhook.py,sha256=eLSxUkZ75dqEMoKfjLiG6SAVSVmxa0TQlhPl9MwZKaM,3679
+broadcast_python/version.py,sha256=Zz7Z0-OMagmQ4tVooxvKzJdH4Lhpwhuk1QkOMHsYGHY,169
+broadcast_python/webhook.py,sha256=2OtgY4IqKcf73hyUcCwZWpS_VURPjU2ZOgizl8Wz3Dg,3776
 broadcast_python/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-broadcast_python/resources/autopilots.py,sha256=yDXs7lPi2tqJwPEi_e156jRFQIkVamsdvYGiHax_7HM,3416
+broadcast_python/resources/autopilots.py,sha256=PVOetU4DwF5ISZKuvN1UYr5a6hnwiWJLt1AcAo6wMbc,3488
 broadcast_python/resources/base.py,sha256=-_uG_bAy_sz2oGHe2GQ64zRcpef6WZdMe4oHGJYFqEw,1632
 broadcast_python/resources/broadcasts.py,sha256=VuYkKJ3d3mcaShXciMqAPHH-OT8px559VeXNltqkx3A,1954
 broadcast_python/resources/channel_design.py,sha256=4xiJMGkiBjbCH35LQi_2DqrZV8n5mi6XXhzJf6sGpLM,970
@@ -16,16 +16,17 @@ broadcast_python/resources/discovery.py,sha256=B0BKq9hpRwd9gN4MWoPArz2dli4bQLZs9
 broadcast_python/resources/email_servers.py,sha256=1_ZJEPwVjFi5rN6S_0n7WfFfmF5y3JDIcW0Ixak0Z24,2830
 broadcast_python/resources/global_suppressions.py,sha256=5Nghq0AfQYLPEL_IAc_tmwGfovA5jpLmdw8yUxg6HpA,1730
 broadcast_python/resources/migration.py,sha256=EvqUvn254Tr_mMVM7Ki3MZb0o0c8_PO4ZUo-lHnvBTA,4126
-broadcast_python/resources/opt_in_forms.py,sha256=ScoEKXejT27UfTL8iGxlsADO6g5Q-4xCpWOFtmM6q2E,2509
+broadcast_python/resources/opt_in_forms.py,sha256=271hVuzmS1Cda9cT0UZLkeuUaYH1kJZYw-NpUV_g1pE,3083
 broadcast_python/resources/segments.py,sha256=ZfUJxiWPhERWzkzuRGVu09uWqbwyUbdr3NsKOEeuW8o,857
 broadcast_python/resources/sequences.py,sha256=9IuKw13e_LYZMLZiBYrr0b-BPhAAAucdt8DUjQvbP80,2467
-broadcast_python/resources/subscribers.py,sha256=DtUnHs1rj3LF7KACQRQFB-ofgAHl1WTiLluL4W7xbfw,3168
+broadcast_python/resources/subscribers.py,sha256=OMcdlfDMgs-gUXIYGLhw3IoRQbBlChFT6EcJOJ2FeVE,3786
 broadcast_python/resources/suppressions.py,sha256=3IHMkWHgU3ArxcDeMSzPDFWL1Ngag2-m04XNll31C8c,2354
 broadcast_python/resources/templates.py,sha256=FP0KcP61KkfrRID1XeAQ8hRxxRyxBzt404nXmnBqXNY,1262
+broadcast_python/resources/topics.py,sha256=jgspk04PgpxzGpehP9DO_AjKk361pgsbaYFR_BixLLs,980
 broadcast_python/resources/transactionals.py,sha256=iwe9aTHKpeEMtDxd_S2TVzdUVm5Phno-Vinrxu9bn6w,2940
 broadcast_python/resources/users.py,sha256=25gPmWLI1rqQnS9gCOi_2esUjdz_e0Zfi7_7Y2x91mg,4813
 broadcast_python/resources/webhook_endpoints.py,sha256=Llkry10QT3JavkmKok3IAayYKM1PD1-iI51YhW3RbpE,1180
-broadcast_python-0.3.0.dist-info/METADATA,sha256=_RQETsQSRATzNJeBxgc0-hXDXBSMIG4MeXpJj-LdCNU,19646
-broadcast_python-0.3.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-broadcast_python-0.3.0.dist-info/licenses/LICENSE,sha256=cnoPKJuOFIyR8mBe7kmEcUQelniJaujjGl21QWqzlKE,1067
-broadcast_python-0.3.0.dist-info/RECORD,,
+broadcast_python-0.5.0.dist-info/METADATA,sha256=KSQA5BbjGD95C8czXbEiACxNCXbPzvGWqIcH4XAo_SA,21319
+broadcast_python-0.5.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+broadcast_python-0.5.0.dist-info/licenses/LICENSE,sha256=cnoPKJuOFIyR8mBe7kmEcUQelniJaujjGl21QWqzlKE,1067
+broadcast_python-0.5.0.dist-info/RECORD,,