Release v0.8.4 (sdk-python/v0.8.4)

Author: bird-release[bot]

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.8.4
+
+- **Breaking:** the contact list free-text filter is now `q` (was `search`), matching the API's renamed query parameter. Update `client.contacts.list(search=...)` to `client.contacts.list(q=...)`.
+
 ## 0.8.3
 
 - Received messages and the `email.received` event now carry `authentication` (`pass`/`fail`/`unknown`), a single summary of sender authentication; treat `unknown` as not verified. The `spf_pass`/`dkim_pass`/`dmarc_pass` fields remain. Additive; no breaking change.

examples/examples.gen.py

@@ -115,7 +115,7 @@ async def _ex_19() -> None:
 
 
 async def _ex_20() -> None:
-    for contact in client.contacts.list(search="acme.com"):
+    for contact in client.contacts.list(q="acme.com"):
         print(contact.id, contact.email)
 
 

src/bird/_types.py

@@ -205,7 +205,7 @@ class ContactListParams(TypedDict, total=False):
 
     email: str
     external_id: str
-    search: str
+    q: str
     limit: int
     starting_after: str
     ending_before: str

src/bird/_version.py

@@ -1 +1 @@
-__version__ = "0.8.3"
+__version__ = "0.8.4"

src/bird/resources/contacts.py

@@ -192,7 +192,7 @@ def list(
         *,
         email: str | None = None,
         external_id: str | None = None,
-        search: str | None = None,
+        q: str | None = None,
         limit: int | None = None,
         starting_after: str | None = None,
         ending_before: str | None = None,
@@ -202,12 +202,12 @@ def list(
         up by exact ``email`` or ``external_id``, or search by email substring.
 
         ```python
-        for contact in client.contacts.list(search="acme.com"):
+        for contact in client.contacts.list(q="acme.com"):
             print(contact.id, contact.email)
         ```
         """
         query = _list_query({
-            "email": email, "external_id": external_id, "search": search,
+            "email": email, "external_id": external_id, "q": q,
             "limit": limit, "starting_after": starting_after, "ending_before": ending_before,
         })
         return SyncPage(self._client, _PATH, query, Contact, options)
@@ -286,15 +286,15 @@ def list(
         *,
         email: str | None = None,
         external_id: str | None = None,
-        search: str | None = None,
+        q: str | None = None,
         limit: int | None = None,
         starting_after: str | None = None,
         ending_before: str | None = None,
         options: RequestOptions | None = None,
     ) -> AsyncPage[Contact]:
         """List contacts, newest first; ``async for`` over the page to auto-paginate."""
         query = _list_query({
-            "email": email, "external_id": external_id, "search": search,
+            "email": email, "external_id": external_id, "q": q,
             "limit": limit, "starting_after": starting_after, "ending_before": ending_before,
         })
         return AsyncPage(self._client, _PATH, query, Contact, options)