broadcast-python 0.1.0__tar.gz → 0.3.0__tar.gz

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/CHANGELOG.md

@@ -2,7 +2,46 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.1.0] - 2026-07-27
+## [Unreleased]
+
+## [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
+- `subscribers.purged` and `subscribers.purge_failed` webhook event types, in
+  `SUBSCRIBER_EVENTS` and `EVENT_TYPES` (now 34). A purge of the whole list
+  sends one of these instead of a `subscriber.deleted` per subscriber.
+- `client.channel_design.get()` for `GET /api/v1/channel/design`: the token
+  channel's brand kit (colours, font and font stack, layout, logo URL, website
+  and social links), fully resolved and read-only. Needs `templates_read`.
+- `client.users` resource for the admin-only Users API: `list`, `get`,
+  `create`, `update`, `deactivate`, `activate`, `delete`,
+  `channel_permissions`, `set_channel_permissions` (PUT, replaces the whole
+  channel record; requires exactly one of `permissions`/`role`/`preset_id`),
+  `remove_channel_permissions`, `bulk_channel_permissions`,
+  `system_permissions`, `update_system_permissions`. Requires an admin API
+  token; sudo users are read-only and sudo access can never be granted
+  through the API. Adds `BaseResource._put`.
+
+## [0.1.0] - 2026-07-28
+
+Published to PyPI as `broadcast-python`; the import module is `broadcast_python`,
+because a package named `broadcast` already occupies that name on PyPI.
+
+Released through PyPI trusted publishing (OIDC) rather than an API token — no
+credential for this package exists anywhere. Verified from the registry: the
+installed artifact imports, ships `py.typed`, exposes all 18 migration
+collections and 32 event types, and computes a webhook signature identical to
+the Ruby, PHP and Node SDKs.
+
 
 First release. Feature parity with `broadcast-ruby` v0.3.0 — the reference
 implementation — verified at **104/104 API operations** by the coverage report

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: broadcast-python
-Version: 0.1.0
+Version: 0.3.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
@@ -26,20 +26,12 @@ Description-Content-Type: text/markdown
 
 Official Python client for [Broadcast](https://sendbroadcast.net), the self-hosted email marketing platform.
 
-Works with any Broadcast instance — self-hosted or SaaS. Covers **104/104 API operations**, verified against the API's generated OpenAPI document.
+Works with any Broadcast instance — self-hosted or SaaS. Covers **117/117 API operations**, verified against the API's generated OpenAPI document.
 
 📖 **[Python SDK documentation](https://sendbroadcast.net/docs/python-sdk)** · [API reference](https://sendbroadcast.net/docs/api-authentication) · [All docs](https://sendbroadcast.net/docs)
 
 Also available: [Ruby](https://github.com/send-broadcast/broadcast-ruby) · [PHP](https://github.com/send-broadcast/broadcast-php) · [Node/TypeScript](https://github.com/send-broadcast/broadcast-node)
 
-> **Not yet on PyPI.** The package is complete and tested but unpublished, so
-> `pip install broadcast-python` will not resolve. Install from the repository
-> until it lands:
->
-> ```bash
-> pip install git+https://github.com/send-broadcast/broadcast-python
-> ```
-
 ## Installation
 
 ```bash
@@ -254,6 +246,19 @@ client.opt_in_forms.duplicate(id, label="Copy")
 
 Reading a segment recounts its members server-side, so `segments.get` is not free.
 
+### Channel design (brand kit)
+
+```python
+kit = client.channel_design.get()
+kit["colors"]["accent"]         # "#2563eb"
+kit["typography"]["font_stack"] # email-safe CSS font stack
+kit["brand"]["logo_url"]        # public URL, or None
+```
+
+Read-only, for the token's own channel, fully resolved (defaults filled in).
+Needs `templates_read`. Block emails built with the drag-and-drop editor inherit
+these values.
+
 ### Email servers
 
 **Credential redaction guard.** The API returns credentials bullet-masked
@@ -268,6 +273,39 @@ client.email_servers.update(id, name="Renamed", smtp_password=server["smtp_passw
 # -> sends only {"name": "Renamed"}, warns about the dropped field
 ```
 
+### Users
+
+Requires an **admin API token**. Sudo users are read-only through this API —
+update, deactivate, activate, delete, and permission writes on one raise
+`AuthorizationError`. Sudo access itself can never be granted through the API.
+
+```python
+client.users.list(status="active", q="ada")
+user = client.users.create(email="ada@example.com", first_name="Ada", last_name="L", password="x")
+client.users.update(user["id"], first_name="Grace")
+client.users.deactivate(user["id"])
+client.users.activate(user["id"])
+client.users.delete(user["id"])
+```
+
+Channel and system permissions:
+
+```python
+client.users.channel_permissions(user["id"])
+
+# PUT replaces the whole channel record -- pass exactly one of
+# permissions, role, or preset_id
+client.users.set_channel_permissions(user["id"], channel_id, role="Editor")
+client.users.set_channel_permissions(user["id"], channel_id, permissions={"subscribers_read": True})
+client.users.remove_channel_permissions(user["id"], channel_id)
+
+# Same rule, applied to several channels at once
+client.users.bulk_channel_permissions(user["id"], [channel_id, other_channel_id], role="Viewer")
+
+client.users.system_permissions(user["id"])
+client.users.update_system_permissions(user["id"], {"user_management": True})
+```
+
 ### Autopilot
 
 ```python
@@ -325,6 +363,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
 ```
 
@@ -370,7 +413,9 @@ 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 32 event names.
+`broadcast_python.EVENT_TYPES` lists all 34 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.
 
 ---
 
@@ -386,11 +431,12 @@ integration requires.
 | Sequences | `sequences_read` -- list, get, list steps | `sequences_write` -- create, update, delete, manage steps, enroll subscribers |
 | Broadcasts | `broadcasts_read` -- list, get, statistics | `broadcasts_write` -- create, update, delete, send, schedule |
 | Segments | `segments_read` -- list, get | `segments_write` -- create, update, delete |
-| Templates | `templates_read` -- list, get | `templates_write` -- create, update, delete |
+| Templates | `templates_read` -- list, get, channel_design.get | `templates_write` -- create, update, delete |
 | Opt-In Forms | `opt_in_forms_read` -- list, get, analytics | `opt_in_forms_write` -- create, update, delete, create_variant, duplicate |
 | Email Servers | `email_servers_read` -- list, get | `email_servers_write` -- create, update, delete, test_connection, copy_to_channel (admin) |
 | Webhook Endpoints | `webhook_endpoints_read` -- list, get, deliveries | `webhook_endpoints_write` -- create, update, delete, test |
 | Autopilot | `autopilot_read` -- list, get, runs | `autopilot_write` -- create, update, delete, activate, pause, deactivate, trigger_run |
+| Users (admin token only) | `users_read` -- list, get, channel_permissions, system_permissions | `users_write` -- create, update, deactivate, activate, delete, permission writes |
 
 ---
 

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/README.md

@@ -2,20 +2,12 @@
 
 Official Python client for [Broadcast](https://sendbroadcast.net), the self-hosted email marketing platform.
 
-Works with any Broadcast instance — self-hosted or SaaS. Covers **104/104 API operations**, verified against the API's generated OpenAPI document.
+Works with any Broadcast instance — self-hosted or SaaS. Covers **117/117 API operations**, verified against the API's generated OpenAPI document.
 
 📖 **[Python SDK documentation](https://sendbroadcast.net/docs/python-sdk)** · [API reference](https://sendbroadcast.net/docs/api-authentication) · [All docs](https://sendbroadcast.net/docs)
 
 Also available: [Ruby](https://github.com/send-broadcast/broadcast-ruby) · [PHP](https://github.com/send-broadcast/broadcast-php) · [Node/TypeScript](https://github.com/send-broadcast/broadcast-node)
 
-> **Not yet on PyPI.** The package is complete and tested but unpublished, so
-> `pip install broadcast-python` will not resolve. Install from the repository
-> until it lands:
->
-> ```bash
-> pip install git+https://github.com/send-broadcast/broadcast-python
-> ```
-
 ## Installation
 
 ```bash
@@ -230,6 +222,19 @@ client.opt_in_forms.duplicate(id, label="Copy")
 
 Reading a segment recounts its members server-side, so `segments.get` is not free.
 
+### Channel design (brand kit)
+
+```python
+kit = client.channel_design.get()
+kit["colors"]["accent"]         # "#2563eb"
+kit["typography"]["font_stack"] # email-safe CSS font stack
+kit["brand"]["logo_url"]        # public URL, or None
+```
+
+Read-only, for the token's own channel, fully resolved (defaults filled in).
+Needs `templates_read`. Block emails built with the drag-and-drop editor inherit
+these values.
+
 ### Email servers
 
 **Credential redaction guard.** The API returns credentials bullet-masked
@@ -244,6 +249,39 @@ client.email_servers.update(id, name="Renamed", smtp_password=server["smtp_passw
 # -> sends only {"name": "Renamed"}, warns about the dropped field
 ```
 
+### Users
+
+Requires an **admin API token**. Sudo users are read-only through this API —
+update, deactivate, activate, delete, and permission writes on one raise
+`AuthorizationError`. Sudo access itself can never be granted through the API.
+
+```python
+client.users.list(status="active", q="ada")
+user = client.users.create(email="ada@example.com", first_name="Ada", last_name="L", password="x")
+client.users.update(user["id"], first_name="Grace")
+client.users.deactivate(user["id"])
+client.users.activate(user["id"])
+client.users.delete(user["id"])
+```
+
+Channel and system permissions:
+
+```python
+client.users.channel_permissions(user["id"])
+
+# PUT replaces the whole channel record -- pass exactly one of
+# permissions, role, or preset_id
+client.users.set_channel_permissions(user["id"], channel_id, role="Editor")
+client.users.set_channel_permissions(user["id"], channel_id, permissions={"subscribers_read": True})
+client.users.remove_channel_permissions(user["id"], channel_id)
+
+# Same rule, applied to several channels at once
+client.users.bulk_channel_permissions(user["id"], [channel_id, other_channel_id], role="Viewer")
+
+client.users.system_permissions(user["id"])
+client.users.update_system_permissions(user["id"], {"user_management": True})
+```
+
 ### Autopilot
 
 ```python
@@ -301,6 +339,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
 ```
 
@@ -346,7 +389,9 @@ 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 32 event names.
+`broadcast_python.EVENT_TYPES` lists all 34 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.
 
 ---
 
@@ -362,11 +407,12 @@ integration requires.
 | Sequences | `sequences_read` -- list, get, list steps | `sequences_write` -- create, update, delete, manage steps, enroll subscribers |
 | Broadcasts | `broadcasts_read` -- list, get, statistics | `broadcasts_write` -- create, update, delete, send, schedule |
 | Segments | `segments_read` -- list, get | `segments_write` -- create, update, delete |
-| Templates | `templates_read` -- list, get | `templates_write` -- create, update, delete |
+| Templates | `templates_read` -- list, get, channel_design.get | `templates_write` -- create, update, delete |
 | Opt-In Forms | `opt_in_forms_read` -- list, get, analytics | `opt_in_forms_write` -- create, update, delete, create_variant, duplicate |
 | Email Servers | `email_servers_read` -- list, get | `email_servers_write` -- create, update, delete, test_connection, copy_to_channel (admin) |
 | Webhook Endpoints | `webhook_endpoints_read` -- list, get, deliveries | `webhook_endpoints_write` -- create, update, delete, test |
 | Autopilot | `autopilot_read` -- list, get, runs | `autopilot_write` -- create, update, delete, activate, pause, deactivate, trigger_run |
+| Users (admin token only) | `users_read` -- list, get, channel_permissions, system_permissions | `users_write` -- create, update, deactivate, activate, delete, permission writes |
 
 ---
 

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "broadcast-python"
-version = "0.1.0"
+version = "0.3.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.1.0 → broadcast_python-0.3.0}/src/broadcast_python/client.py

@@ -5,15 +5,19 @@ from .configuration import Configuration
 from .connection import Connection
 from .resources.autopilots import Autopilots
 from .resources.broadcasts import Broadcasts
+from .resources.channel_design import ChannelDesign
 from .resources.discovery import Discovery
 from .resources.email_servers import EmailServers
+from .resources.global_suppressions import GlobalSuppressions
 from .resources.migration import Migration
 from .resources.opt_in_forms import OptInForms
 from .resources.segments import Segments
 from .resources.sequences import Sequences
 from .resources.subscribers import Subscribers
+from .resources.suppressions import Suppressions
 from .resources.templates import Templates
 from .resources.transactionals import Transactionals
+from .resources.users import Users
 from .resources.webhook_endpoints import WebhookEndpoints
 
 Id = Union[str, int]
@@ -37,14 +41,25 @@ class Broadcast:
         self.broadcasts = Broadcasts(self)
         self.segments = Segments(self)
         self.templates = Templates(self)
+        #: The channel's brand kit (Settings -> Design). Read-only.
+        self.channel_design = ChannelDesign(self)
         self.webhook_endpoints = WebhookEndpoints(self)
         self.transactionals = Transactionals(self)
         self.opt_in_forms = OptInForms(self)
         self.email_servers = EmailServers(self)
         self.autopilots = Autopilots(self)
         self.discovery = Discovery(self)
+        #: The current channel's suppression list (plus ``check``, which
+        #: reads the global list too).
+        self.suppressions = Suppressions(self)
+        #: The installation-wide suppression list. Requires an admin (system)
+        #: API token.
+        self.global_suppressions = GlobalSuppressions(self)
         #: Read-only export endpoints. Requires an admin (system) API token.
         self.migration = Migration(self)
+        #: Installation users and their permissions. Requires an admin
+        #: (system) API token; sudo users are read-only through this API.
+        self.users = Users(self)
 
     # --- Channel scoping (admin/system tokens) ---
 
@@ -97,6 +112,9 @@ class Broadcast:
     def skill(self) -> str:
         return self.discovery.skill()
 
+    def openapi(self) -> str:
+        return self.discovery.openapi()
+
     # --- Internal ---
 
     def request(

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/src/broadcast_python/resources/base.py

@@ -25,6 +25,9 @@ class BaseResource:
     def _patch(self, path: str, body: Optional[Dict[str, Any]] = None) -> Any:
         return self._client.request("PATCH", path, body or {})
 
+    def _put(self, path: str, body: Optional[Dict[str, Any]] = None) -> Any:
+        return self._client.request("PUT", path, body or {})
+
     def _delete(self, path: str, body: Optional[Dict[str, Any]] = None) -> Any:
         return self._client.request("DELETE", path, body)
 

broadcast_python-0.3.0/src/broadcast_python/resources/channel_design.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+from .base import BaseResource
+
+
+class ChannelDesign(BaseResource):
+    """The brand kit of the token's channel (Settings -> Design). Read-only.
+
+    Requires the ``templates_read`` permission: the kit is design metadata for
+    templates. There is no channel argument; the server reads the channel the
+    token resolves to (for an admin token, the one set with ``with_channel`` or
+    ``broadcast_channel_id``).
+    """
+
+    def get(self) -> Any:
+        """The channel's brand kit, fully resolved (defaults filled in).
+
+        Returns ``colors``, ``typography`` (``font`` key and the email-safe
+        ``font_stack``), ``layout`` (``width``, ``radius``), and ``brand``
+        (``logo_url`` as a public URL or None, ``logo_width``, ``website_url``,
+        ``social_links``, ``social_icon_style``). Block emails built with the
+        drag-and-drop editor inherit these values.
+        """
+        return self._get("/api/v1/channel/design")

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/src/broadcast_python/resources/discovery.py

@@ -33,3 +33,17 @@ class Discovery(BaseResource):
         Returns a ``str``, not a dict — this endpoint serves ``text/plain``.
         """
         return self._get("/api/v1/skill", raw=True)
+
+    def openapi(self) -> str:
+        """This installation's own OpenAPI document, as YAML.
+
+        Returns a ``str``, not a dict — this endpoint serves
+        ``application/yaml``.
+
+        The server URL inside the document is rewritten by the installation to
+        the host that served it, so the result feeds a client generator or an
+        API explorer without hand-editing. Preferable to a spec copied from
+        elsewhere: a 2.28 install serves the 2.28 surface, so the document
+        cannot drift from the routes it describes.
+        """
+        return self._get("/api/v1/openapi", raw=True)

broadcast_python-0.3.0/src/broadcast_python/resources/global_suppressions.py

@@ -0,0 +1,40 @@
+"""The installation-wide suppression list.
+
+Addresses on it never receive mail from any channel. All operations require an
+admin (system) API token — a channel token gets a 401.
+
+There is deliberately no ``check`` here: checking is a per-channel question
+(it reads the channel list too), so it lives on ``suppressions``.
+"""
+
+from typing import Any, List
+
+from .base import BaseResource
+
+
+class GlobalSuppressions(BaseResource):
+    def list(self, **params: Any) -> Any:
+        """List global suppressions (250 per page, with ``pagination``
+        metadata; pass ``page``). Optional ``email`` filters by partial
+        match."""
+        return self._get("/api/v1/global_suppressions.json", params)
+
+    def add(self, email: str) -> Any:
+        """Add an address to the global list. Already-suppressed is a success
+        (200 instead of 201)."""
+        return self._post("/api/v1/global_suppressions.json", {"email": email})
+
+    def remove(self, email: str) -> Any:
+        """Remove an address from the global list only. Channels that
+        suppressed the same address on their own account keep their block."""
+        return self._delete("/api/v1/global_suppressions.json", {"email": email})
+
+    def bulk_add(self, emails: List[str]) -> Any:
+        """Add up to 10,000 addresses at once. Idempotent. Returns ``added``,
+        ``already_suppressed``, and ``invalid`` counts."""
+        return self._post("/api/v1/global_suppressions/bulk.json", {"emails": emails})
+
+    def bulk_remove(self, emails: List[str]) -> Any:
+        """Remove up to 10,000 addresses at once. Returns ``removed`` and
+        ``not_found`` counts."""
+        return self._delete("/api/v1/global_suppressions/bulk.json", {"emails": emails})

{broadcast_python-0.1.0 → broadcast_python-0.3.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.3.0/src/broadcast_python/resources/suppressions.py

@@ -0,0 +1,52 @@
+"""The current channel's suppression list.
+
+Addresses on it never receive broadcasts, sequences, or transactionals from
+this channel. The installation-wide list is a separate resource — see
+``global_suppressions`` — but ``check`` reads across both on purpose: it
+answers the question an integration actually asks, "will this address receive
+mail?".
+"""
+
+from typing import Any, List
+
+from .base import BaseResource
+
+
+class Suppressions(BaseResource):
+    def list(self, **params: Any) -> Any:
+        """List the channel's suppressions (250 per page, with ``pagination``
+        metadata; pass ``page``). Optional ``email`` filters by partial,
+        case-insensitive match."""
+        return self._get("/api/v1/suppressions.json", params)
+
+    def add(self, email: str) -> Any:
+        """Add an address to the channel's suppression list.
+
+        Adding an address that is already suppressed is a success (the server
+        answers 200 instead of 201), so callers do not have to check first.
+        """
+        return self._post("/api/v1/suppressions.json", {"email": email})
+
+    def remove(self, email: str) -> Any:
+        """Remove an address from the channel's suppression list. Returns
+        ``removed: False`` (not an error) when the address was not on it.
+        Does not touch the global list."""
+        return self._delete("/api/v1/suppressions.json", {"email": email})
+
+    def bulk_add(self, emails: List[str]) -> Any:
+        """Add up to 10,000 addresses at once. Idempotent: a retried batch
+        cannot duplicate. Returns ``added``, ``already_suppressed``, and
+        ``invalid`` counts."""
+        return self._post("/api/v1/suppressions/bulk.json", {"emails": emails})
+
+    def bulk_remove(self, emails: List[str]) -> Any:
+        """Remove up to 10,000 addresses at once. Returns ``removed`` and
+        ``not_found`` counts."""
+        return self._delete("/api/v1/suppressions/bulk.json", {"emails": emails})
+
+    def check(self, email: str) -> Any:
+        """Will this address receive mail? Reads across both the global and
+        the channel list — a globally blocked address reports
+        ``suppressed: True`` here even though it is absent from the channel's
+        own list. The response's ``scope`` says which list matched."""
+        return self._get("/api/v1/suppressions/check.json", {"email": email})

broadcast_python-0.3.0/src/broadcast_python/resources/users.py

@@ -0,0 +1,115 @@
+from typing import Any, Dict, List, Optional, Union
+
+from .base import BaseResource, compact
+
+Id = Union[str, int]
+
+
+class Users(BaseResource):
+    """Manage installation users and their permissions.
+
+    Every operation here requires an **admin API token** — a channel token
+    gets ``403 {"error": "Admin API token required for user management"}``.
+    Reads need the ``users_read`` scope, writes need ``users_write``.
+
+    Sudo users are **read-only** through this API: update, deactivate,
+    activate, delete, and permission writes on a sudo user all raise
+    ``AuthorizationError`` (403). Sudo access itself can never be granted
+    through the API, whether creating or updating a user or writing system
+    permissions.
+    """
+
+    def list(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        q: Optional[str] = None,
+        status: Optional[str] = None,
+    ) -> Any:
+        """List users. ``q`` searches email/name, ``status`` is ``"active"``
+        or ``"inactive"``."""
+        params = compact({"limit": limit, "offset": offset, "q": q, "status": status})
+        return self._get("/api/v1/users", params)
+
+    def get(self, id: Id) -> Any:  # noqa: A002
+        return self._get("/api/v1/users/{}".format(id))
+
+    def create(self, **attrs: Any) -> Any:
+        """Create a user. Requires either ``password`` or
+        ``send_password_reset=True``."""
+        return self._post("/api/v1/users", {"user": attrs})
+
+    def update(self, id: Id, **attrs: Any) -> Any:  # noqa: A002
+        """Update a user. Raises ``AuthorizationError`` if the user is sudo."""
+        return self._patch("/api/v1/users/{}".format(id), {"user": attrs})
+
+    def deactivate(self, id: Id) -> Any:  # noqa: A002
+        return self._post("/api/v1/users/{}/deactivate".format(id))
+
+    def activate(self, id: Id) -> Any:  # noqa: A002
+        """Reactivate a user. Also clears any account lockout."""
+        return self._post("/api/v1/users/{}/activate".format(id))
+
+    def delete(self, id: Id) -> Any:  # noqa: A002
+        return self._delete("/api/v1/users/{}".format(id))
+
+    def channel_permissions(self, id: Id) -> Any:  # noqa: A002
+        return self._get("/api/v1/users/{}/channel_permissions".format(id))
+
+    def set_channel_permissions(
+        self,
+        id: Id,  # noqa: A002
+        broadcast_channel_id: Id,
+        permissions: Optional[Dict[str, bool]] = None,
+        role: Optional[str] = None,
+        preset_id: Optional[Id] = None,
+    ) -> Any:
+        """Replace the user's whole permission record for one channel.
+
+        This is a PUT: it replaces the record rather than merging into it, so
+        passing ``permissions`` sets any flag not named to ``False``. Pass
+        exactly one of ``permissions``, ``role``, or ``preset_id``.
+        """
+        body = _one_of(permissions=permissions, role=role, preset_id=preset_id)
+        return self._put("/api/v1/users/{}/channel_permissions/{}".format(id, broadcast_channel_id), body)
+
+    def remove_channel_permissions(self, id: Id, broadcast_channel_id: Id) -> Any:  # noqa: A002
+        return self._delete("/api/v1/users/{}/channel_permissions/{}".format(id, broadcast_channel_id))
+
+    def bulk_channel_permissions(
+        self,
+        id: Id,  # noqa: A002
+        broadcast_channel_ids: List[Id],
+        permissions: Optional[Dict[str, bool]] = None,
+        role: Optional[str] = None,
+        preset_id: Optional[Id] = None,
+    ) -> Any:
+        """Apply the same permission record to several channels at once.
+
+        Pass exactly one of ``permissions``, ``role``, or ``preset_id``.
+        Returns ``{"applied": [...], "failed": [...]}`` — a failure on one
+        channel does not roll back the others.
+        """
+        body = _one_of(permissions=permissions, role=role, preset_id=preset_id)
+        body["broadcast_channel_ids"] = broadcast_channel_ids
+        return self._post("/api/v1/users/{}/channel_permissions/bulk".format(id), body)
+
+    def system_permissions(self, id: Id) -> Any:  # noqa: A002
+        return self._get("/api/v1/users/{}/system_permissions".format(id))
+
+    def update_system_permissions(self, id: Id, permissions: Dict[str, bool]) -> Any:  # noqa: A002
+        """Update only the named system permission flags.
+
+        ``sudo_access`` is never present and sending it raises a 422 —
+        sudo can never be granted through the API.
+        """
+        return self._patch("/api/v1/users/{}/system_permissions".format(id), {"permissions": permissions})
+
+
+def _one_of(**kwargs: Any) -> Dict[str, Any]:
+    given = {k: v for k, v in kwargs.items() if v is not None}
+    if len(given) != 1:
+        raise ValueError(
+            "Pass exactly one of {} (got {})".format(", ".join(kwargs.keys()), len(given))
+        )
+    return given

{broadcast_python-0.1.0 → broadcast_python-0.3.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.1.0"
+VERSION = "0.3.0"

{broadcast_python-0.1.0 → broadcast_python-0.3.0}/src/broadcast_python/webhook.py

@@ -30,6 +30,9 @@ SUBSCRIBER_EVENTS = (
     "subscriber.unsubscribed",
     "subscriber.bounced",
     "subscriber.complained",
+    # One event for a whole-list purge, in place of a subscriber.deleted per row
+    "subscribers.purged",
+    "subscribers.purge_failed",
 )
 
 BROADCAST_EVENTS = (