broadcast-python 0.6.0__tar.gz → 0.8.0__tar.gz

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.8.0] - 2026-11-07
+
+### Removed
+
+- **Breaking:** `client.migration` and the `COLLECTIONS` export: `manifest`,
+  the 19 export collections, `each_record` and `download_file_asset`.
+  Broadcast 3 removes the `/api/migration/v1` export API. A server before 3.0
+  still serves it; stay on 0.7.x to keep using it.
+
+## [0.7.0] - 2026-10-17
+
+### Added
+
+- `TRIGGER_FREQUENCIES` includes `once_per_days` (Broadcast 2.49): the popup shows
+  again after `trigger_settings.frequency_cookie_days` days, a whole number, 1 or
+  more; blank means 30. The client still sends any word as it is, so nothing
+  changes for a server before 2.49, which refuses the word with 422.
+
 ## [0.6.0] - 2026-10-16
 
 ### Added

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: broadcast-python
-Version: 0.6.0
+Version: 0.8.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
@@ -242,6 +242,8 @@ 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"})
+# Every N days (Broadcast 2.49 and later): frequency_cookie_days is a whole number, 1 or more; blank means 30.
+client.opt_in_forms.update(id, trigger_settings={"frequency": "once_per_days", "frequency_cookie_days": 7})
 client.opt_in_forms.create_variant(id, name="B", weight=50)
 client.opt_in_forms.duplicate(id, label="Copy")
 ```
@@ -463,30 +465,6 @@ client.prime()    # full capability manifest
 client.skill()    # plain-text agent skill manifest (a str)
 ```
 
-### Migration / export
-
-Read-only. **Admin tokens only**, and every call needs a `broadcast_channel_id`.
-
-```python
-client = Broadcast(..., broadcast_channel_id=42)
-
-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
-```
-
-On a demo instance this entire API returns **403 for every request**, valid
-token or not — deliberately, so a public demo cannot be used as a token oracle.
-It surfaces as `AuthorizationError`.
-
 ---
 
 ## Channel Scoping
@@ -569,9 +547,6 @@ The token is valid but lacks the permission for that call. Check the table
 above, then re-issue the key with the resource enabled — permissions are fixed
 at creation.
 
-On a demo instance, the entire migration API returns 403 for every request,
-valid token or not.
-
 ### `ValidationError` (422) on a repeated send
 
 If you reused an `idempotency_key` with a *different* payload, the API rejects

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/README.md

@@ -218,6 +218,8 @@ 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"})
+# Every N days (Broadcast 2.49 and later): frequency_cookie_days is a whole number, 1 or more; blank means 30.
+client.opt_in_forms.update(id, trigger_settings={"frequency": "once_per_days", "frequency_cookie_days": 7})
 client.opt_in_forms.create_variant(id, name="B", weight=50)
 client.opt_in_forms.duplicate(id, label="Copy")
 ```
@@ -439,30 +441,6 @@ client.prime()    # full capability manifest
 client.skill()    # plain-text agent skill manifest (a str)
 ```
 
-### Migration / export
-
-Read-only. **Admin tokens only**, and every call needs a `broadcast_channel_id`.
-
-```python
-client = Broadcast(..., broadcast_channel_id=42)
-
-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
-```
-
-On a demo instance this entire API returns **403 for every request**, valid
-token or not — deliberately, so a public demo cannot be used as a token oracle.
-It surfaces as `AuthorizationError`.
-
 ---
 
 ## Channel Scoping
@@ -545,9 +523,6 @@ The token is valid but lacks the permission for that call. Check the table
 above, then re-issue the key with the resource enabled — permissions are fixed
 at creation.
 
-On a demo instance, the entire migration API returns 403 for every request,
-valid token or not.
-
 ### `ValidationError` (422) on a repeated send
 
 If you reused an `idempotency_key` with a *different* payload, the API rejects

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "broadcast-python"
-version = "0.6.0"
+version = "0.8.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.6.0 → broadcast_python-0.8.0}/src/broadcast_python/__init__.py

@@ -27,7 +27,6 @@ from .errors import (
     WarningError,
 )
 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_
@@ -37,7 +36,6 @@ from .webhook import EVENT_TYPES
 __version__ = VERSION
 
 __all__ = [
-    "COLLECTIONS",
     "ENV_HOST",
     "ENV_TOKEN",
     "EVENT_TYPES",

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/src/broadcast_python/client.py

@@ -11,7 +11,6 @@ from .resources.discovery import Discovery
 from .resources.email_servers import EmailServers
 from .resources.file_assets import FileAssets
 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
@@ -65,7 +64,6 @@ class Broadcast:
         #: 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)

{broadcast_python-0.6.0 → broadcast_python-0.8.0}/src/broadcast_python/resources/opt_in_forms.py

@@ -9,7 +9,18 @@ Id = Union[str, int]
 #: 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")
+#: ``once_per_days`` (Broadcast 2.49 and later) shows the popup again after
+#: ``trigger_settings["frequency_cookie_days"]`` days: a whole number, 1 or
+#: more; blank means 30.
+TRIGGER_FREQUENCIES = (
+    "always",
+    "every_visit",
+    "once_per_session",
+    "once_per_day",
+    "once_per_week",
+    "once",
+    "once_per_days",
+)
 
 
 class OptInForms(BaseResource):

{broadcast_python-0.6.0 → broadcast_python-0.8.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.6.0"
+VERSION = "0.8.0"

broadcast_python-0.6.0/src/broadcast_python/resources/migration.py

@@ -1,114 +0,0 @@
-"""Read-only export endpoints under ``/api/migration/v1``.
-
-Two things differ from the v1 API:
-
-1. **Admin tokens only.** Channel-scoped tokens are rejected outright.
-2. **broadcast_channel_id is required on every call.** Set it once via
-   ``Broadcast(broadcast_channel_id=...)`` or ``client.with_channel(id)`` and it
-   is attached automatically; otherwise pass it per call.
-
-On a demo instance (``DEMO_MODE``) this entire API returns 403 for every
-request, valid token or not, so a public demo cannot be used as a token oracle.
-That surfaces here as :class:`AuthorizationError`.
-
-Every list endpoint pages with ``limit`` (1..250, default 250) and ``offset``,
-returning ``{"data": [...], "pagination": {...}}``.
-"""
-
-from typing import Any, Iterator, Union
-
-from .base import BaseResource
-
-Id = Union[str, int]
-
-#: Endpoints that are a plain paginated list of the channel's records.
-COLLECTIONS = (
-    "channels",
-    "subscribers",
-    "templates",
-    "segments",
-    "sequences",
-    "email_servers",
-    "opt_in_forms",
-    "broadcasts",
-    "outbound_receipts",
-    "webhook_endpoints",
-    "tokens",
-    "suppressions",
-    "unsubscribed_emails",
-    "tags",
-    "users",
-    "link_redirects",
-    "link_clicks",
-    "subscriber_histories",
-    "file_assets",
-)
-
-
-class Migration(BaseResource):
-    def manifest(self, **params: Any) -> Any:
-        """Export summary: format version, channel identity, per-resource counts,
-        and recent-history totals. Call this first to size an export.
-
-        ``days_history`` windows the time-bounded counts; the server clamps to 1..365.
-        """
-        return self._get("/api/migration/v1/manifest", params)
-
-    def download_file_asset(self, id: Id, **params: Any) -> bytes:  # noqa: A002
-        """Binary contents of a stored file asset — bytes, not JSON."""
-        return self._get("/api/migration/v1/file_assets/{}/download".format(id), params, raw=True)
-
-    def each_record(self, collection: str, limit: int = 250, **params: Any) -> Iterator[Any]:
-        """Page through a collection, yielding each record.
-
-            for sub in client.migration.each_record("subscribers"):
-                ...
-
-        Stops when the server reports ``has_more: False``, and advances by the
-        limit the server actually applied rather than the one requested — the
-        server clamps to 250, so trusting the request would skip records.
-        """
-        offset = 0
-        while True:
-            page = getattr(self, collection)(limit=limit, offset=offset, **params)
-            records = page.get("data") or []
-            yield from records
-
-            pagination = page.get("pagination") or {}
-            if not pagination.get("has_more"):
-                return
-
-            # `pagination.get("limit") or len(records)` would be wrong: Python's
-            # `or` falls back on any falsy value, so a server-reported limit of
-            # 0 would become len(records) and the loop would never terminate.
-            # Ruby's `||` only falls back on nil, which is why the reference
-            # implementation can spell it that way and this one cannot.
-            advanced = pagination.get("limit")
-            if advanced is None:
-                advanced = len(records)
-
-            try:
-                advanced = int(advanced)
-            except (TypeError, ValueError):
-                return
-            if advanced <= 0:
-                return
-
-            offset += advanced
-
-
-def _make_collection_method(name: str):
-    def method(self, **params: Any) -> Any:
-        return self._get("/api/migration/v1/{}".format(name), params)
-
-    method.__name__ = name
-    method.__qualname__ = "Migration.{}".format(name)
-    method.__doc__ = "Paginated export of the channel's {}.".format(name.replace("_", " "))
-    return method
-
-
-# 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:
-    setattr(Migration, _collection, _make_collection_method(_collection))