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

Author: bird-release[bot]

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.41.0
+
+- Add the `workspace` resource: `get()` returns the workspace the credential is scoped to, including its id, name, owning organization's id, and notification and logo settings.
+
 ## 0.40.0
 
 - A `404` from checking or advancing a verification now says that no verification matched the recipient: either none exists for the exact recipient given, or the most recent one is already resolved as verified, expired, or out of attempts. It also says when to create another — create one when the recipient has no verification, or the last one expired or ran out of attempts, and not when the recipient already passed. The error code is unchanged, so match it exactly as before; a `404` is not evidence the recipient failed to verify, so treat your own record of an earlier `success: true` as the outcome.

examples/examples.gen.py

@@ -946,3 +946,8 @@ async def _ex_141() -> None:
         components=[{"type": "body", "parameters": [{"type": "text", "text": "123456"}]}],
     )
     print(msg.id, msg.status)
+
+
+async def _ex_142() -> None:
+    workspace = client.workspace.get()
+    print(workspace.id, workspace.name)

examples/reference/workspace.py

@@ -0,0 +1,15 @@
+"""Example source for the generated workspace method.
+
+Each bird:snippet region is harvested for the docs site + README; the keys match
+the surface catalog (workspace.get). Hand-written and type-checked (pyright
+includes examples/); nothing regenerates over it.
+"""
+
+from bird import Bird
+
+client = Bird()
+
+
+def workspace_get() -> None:
+    workspace = client.workspace.get()
+    print(workspace.id, workspace.name)

scripts/surface_ops.py

@@ -67,6 +67,7 @@
     "/v1/email/domains": {"get", "post"},
     "/v1/email/domains/{domain_id}": {"delete", "get", "patch"},
     "/v1/email/domains/{domain_id}/verify": {"post"},
+    "/v1/workspace": {"get"},
     "/v1/preferences": {"get", "post"},
     "/v1/preferences/{preference_id}": {"delete", "get"},
     "/v1/contacts": {"get", "post"},

src/bird/_client.py

@@ -28,6 +28,7 @@
 from bird.resources.lookup_gen import AsyncLookup, Lookup
 from bird.resources.numbers import AsyncNumbers, Numbers
 from bird.resources.preferences import AsyncPreferences, Preferences
+from bird.resources.workspace_gen import AsyncWorkspaceResource, WorkspaceResource
 from bird.resources.realtime import AsyncRealtime, Realtime
 from bird.resources.sms import AsyncSms, Sms
 from bird.resources.sms_keyword_rules_gen import AsyncSmsKeywordRules, SmsKeywordRules
@@ -182,6 +183,7 @@ def __init__(
         self.lookup = Lookup(self)
         self.numbers = Numbers(self)
         self.preferences = Preferences(self)
+        self.workspace = WorkspaceResource(self)
         self.webhooks = Webhooks(webhook_secret)
         self.realtime = Realtime(self, realtime_key, realtime_secret, realtime_encryption_master_key)
 
@@ -308,6 +310,7 @@ def __init__(
         self.lookup = AsyncLookup(self)
         self.numbers = AsyncNumbers(self)
         self.preferences = AsyncPreferences(self)
+        self.workspace = AsyncWorkspaceResource(self)
         self.webhooks = AsyncWebhooks(webhook_secret)
         self.realtime = AsyncRealtime(self, realtime_key, realtime_secret, realtime_encryption_master_key)
 

src/bird/_generated.py

@@ -225,6 +225,19 @@ class CountryCode(RootModel[str]):
     ]
 
 
+class WorkspaceNotificationEmails(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    operational: Annotated[
+        List[str] | None,
+        Field(
+            description="Addresses for operational notifications about this workspace (sending domain authentication failures, webhook endpoint degradation). When empty, these notifications go to the organization owners. Maximum 10 addresses.",
+            examples=[["alerts@example.com"]],
+        ),
+    ] = None
+
+
 class Timestamps(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -233,6 +246,38 @@ class Timestamps(BaseModel):
     updated_at: Annotated[str, Field(examples=["2026-05-25T16:42:01Z"], min_length=1)]
 
 
+class Workspace(Timestamps):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: Annotated[
+        str,
+        Field(
+            examples=["ws_01krdgeqcxet5s7t44vh8rt9mg"],
+            min_length=1,
+            pattern="^ws_[0-9a-hjkmnp-tv-z]{26}$",
+        ),
+    ]
+    organization_id: Annotated[
+        str,
+        Field(
+            examples=["org_01krdgeqcxet5s7t44vh8rt9mg"],
+            min_length=1,
+            pattern="^org_[0-9a-hjkmnp-tv-z]{26}$",
+        ),
+    ]
+    name: Annotated[str, Field(examples=["Production"], min_length=1)]
+    notification_emails: WorkspaceNotificationEmails
+    logo_url: Annotated[
+        str | None,
+        Field(
+            description="HTTPS URL to the current workspace logo. `null` when unset."
+        ),
+    ] = None
+    created_at: str
+    updated_at: str
+
+
 class RealtimeAppID(RootModel[str]):
     root: Annotated[
         str,

src/bird/_version.py

@@ -1 +1 @@
-__version__ = "0.40.0"
+__version__ = "0.41.0"

src/bird/resources/workspace_gen.py

@@ -0,0 +1,51 @@
+# Code generated by surface-gen; DO NOT EDIT.
+
+from __future__ import annotations
+
+from bird._generated import (
+    Workspace,
+)
+from bird._resource import AsyncResource, Resource
+from bird._types import RequestOptions
+
+
+class WorkspaceResource(Resource):
+    def get(
+        self,
+        *,
+        options: RequestOptions | None = None,
+    ) -> Workspace:
+        """Fetch the current workspace's ID, name, and the ID of the organization owning it. This is the workspace the current credentials are scoped to.
+
+        ```python
+        workspace = client.workspace.get()
+        print(workspace.id, workspace.name)
+        ```
+        """
+        return self._get(
+            "/v1/workspace",
+            {},
+            Workspace,
+            options,
+        )
+
+
+class AsyncWorkspaceResource(AsyncResource):
+    async def get(
+        self,
+        *,
+        options: RequestOptions | None = None,
+    ) -> Workspace:
+        """Fetch the current workspace's ID, name, and the ID of the organization owning it. This is the workspace the current credentials are scoped to.
+
+        ```python
+        workspace = await client.workspace.get()
+        print(workspace.id, workspace.name)
+        ```
+        """
+        return await self._get(
+            "/v1/workspace",
+            {},
+            Workspace,
+            options,
+        )

tests/test_surface_conformance_gen.py

@@ -84,6 +84,7 @@ def test_surface_conformance() -> None:
     assert callable(client.domains.verify)
     assert callable(client.domains.update)
     assert callable(client.domains.delete)
+    assert callable(client.workspace.get)
     assert callable(client.webhooks.unwrap)
     assert callable(client.preferences.list)
     assert callable(client.preferences.get)