release: 4.4.0

.github/workflows/ci.yml

@@ -61,14 +61,18 @@ jobs:
         run: rye build
 
       - name: Get GitHub OIDC Token
-        if: github.repository == 'stainless-sdks/beeper-desktop-api-python'
+        if: |-
+          github.repository == 'stainless-sdks/beeper-desktop-api-python' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         id: github-oidc
         uses: actions/github-script@v8
         with:
           script: core.setOutput('github_token', await core.getIDToken());
 
       - name: Upload tarball
-        if: github.repository == 'stainless-sdks/beeper-desktop-api-python'
+        if: |-
+          github.repository == 'stainless-sdks/beeper-desktop-api-python' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         env:
           URL: https://pkg.stainless.com/s
           AUTH: ${{ steps.github-oidc.outputs.github_token }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.3.0"
+  ".": "4.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 23
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-4acef56b00be513f305543096fdd407e6947f0a5ad268ab2e627ff30b37a75db.yml
-openapi_spec_hash: e876d796b6c25f18577f6be3944bf7d9
-config_hash: 659111d4e28efa599b5f800619ed79c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-5a8ac7b545c48dc892e5c680303e305254921554dabee848e40a808659dbcf1e.yml
+openapi_spec_hash: 0103975601aac1445d3a4ef418c5d17a
+config_hash: aa49273410d42fb96c5515dbce1f182f

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 4.4.0 (2026-03-06)
+
+Full Changelog: [v4.3.0...v4.4.0](https://github.com/beeper/desktop-api-python/compare/v4.3.0...v4.4.0)
+
+### Features
+
+* **api:** api update ([770a8e2](https://github.com/beeper/desktop-api-python/commit/770a8e2a6fc4d96dae58b3b787d55072faf63e34))
+
+
+### Chores
+
+* **ci:** skip uploading artifacts on stainless-internal branches ([3f5692e](https://github.com/beeper/desktop-api-python/commit/3f5692eb199bd02db1359e8131c8774eee7fabcf))
+* configure new SDK language ([8b9d76c](https://github.com/beeper/desktop-api-python/commit/8b9d76c76fe4e3ae99d85429f20d9b782bea2520))
+* configure new SDK language ([a54d51a](https://github.com/beeper/desktop-api-python/commit/a54d51a23c31d38e124dc263f748f6ada2f2409c))
+* **internal:** add request options to SSE classes ([fcf96d3](https://github.com/beeper/desktop-api-python/commit/fcf96d3c4f3bdbec2cd1b88745cdbbc48e864be2))
+* **internal:** codegen related update ([a6b8aac](https://github.com/beeper/desktop-api-python/commit/a6b8aac8430c698cd1a73bab2cd257c9cf553df6))
+* **internal:** make `test_proxy_environment_variables` more resilient ([2420dd3](https://github.com/beeper/desktop-api-python/commit/2420dd3d3de95350f142acaf7fb923fd292af59e))
+* **internal:** make `test_proxy_environment_variables` more resilient to env ([1ad2ddf](https://github.com/beeper/desktop-api-python/commit/1ad2ddfe678d2a495d69e45d7a1a8f0856af4211))
+* **test:** do not count install time for mock server timeout ([352dc26](https://github.com/beeper/desktop-api-python/commit/352dc26df496dac34b88c8d410a3d5761fad7cde))
+* update placeholder string ([f9883db](https://github.com/beeper/desktop-api-python/commit/f9883db325ccb453c60affa4218f2b257c4d41d8))
+* update SDK settings ([5df69bf](https://github.com/beeper/desktop-api-python/commit/5df69bf22554340ee0fd0c694fb755c80907ee22))
+
 ## 4.3.0 (2026-02-20)
 
 Full Changelog: [v4.2.0...v4.3.0](https://github.com/beeper/desktop-api-python/compare/v4.2.0...v4.3.0)

README.md

@@ -11,8 +11,8 @@ and offers both synchronous and asynchronous clients powered by [httpx](https://
 
 Use the Beeper Desktop MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
 
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40beeper%2Fdesktop-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBiZWVwZXIvZGVza3RvcC1tY3AiXSwiZW52Ijp7IkJFRVBFUl9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4ifX0)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40beeper%2Fdesktop-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40beeper%2Fdesktop-mcp%22%5D%2C%22env%22%3A%7B%22BEEPER_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%7D%7D)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40beeper%2Fdesktop-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBiZWVwZXIvZGVza3RvcC1hcGktbWNwIl0sImVudiI6eyJCRUVQRVJfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIn19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40beeper%2Fdesktop-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40beeper%2Fdesktop-api-mcp%22%5D%2C%22env%22%3A%7B%22BEEPER_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%7D%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -23,24 +23,18 @@ The REST API documentation can be found on [developers.beeper.com](https://devel
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://git@github.com/beeper/desktop-api-python.git
+# install from PyPI
+pip install beeper_desktop_api
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install beeper_desktop_api`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-import os
 from beeper_desktop_api import BeeperDesktop
 
-client = BeeperDesktop(
-    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
-)
+client = BeeperDesktop()
 
 page = client.chats.search(
     include_muted=True,
@@ -60,13 +54,10 @@ so that your Access Token is not stored in source control.
 Simply import `AsyncBeeperDesktop` instead of `BeeperDesktop` and use `await` with each API call:
 
 ```python
-import os
 import asyncio
 from beeper_desktop_api import AsyncBeeperDesktop
 
-client = AsyncBeeperDesktop(
-    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
-)
+client = AsyncBeeperDesktop()
 
 
 async def main() -> None:
@@ -90,24 +81,20 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'beeper_desktop_api[aiohttp] @ git+ssh://git@github.com/beeper/desktop-api-python.git'
+# install from PyPI
+pip install beeper_desktop_api[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
-import os
 import asyncio
 from beeper_desktop_api import DefaultAioHttpClient
 from beeper_desktop_api import AsyncBeeperDesktop
 
 
 async def main() -> None:
     async with AsyncBeeperDesktop(
-        access_token=os.environ.get(
-            "BEEPER_ACCESS_TOKEN"
-        ),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
         page = await client.chats.search(

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "beeper_desktop_api"
-version = "4.3.0"
+version = "4.4.0"
 description = "The official Python library for the beeperdesktop API"
 dynamic = ["readme"]
 license = "MIT"

scripts/mock

@@ -21,11 +21,22 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
+  # Pre-install the package so the download doesn't eat into the startup timeout
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism --version
+
   npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
-  # Wait for server to come online
+  # Wait for server to come online (max 30s)
   echo -n "Waiting for server"
+  attempts=0
   while ! grep -q "✖  fatal\|Prism is listening" ".prism.log" ; do
+    attempts=$((attempts + 1))
+    if [ "$attempts" -ge 300 ]; then
+      echo
+      echo "Timed out waiting for Prism server to start"
+      cat .prism.log
+      exit 1
+    fi
     echo -n "."
     sleep 0.1
   done

src/beeper_desktop_api/_client.py

@@ -154,6 +154,7 @@ def assets(self) -> AssetsResource:
 
     @cached_property
     def info(self) -> InfoResource:
+        """Control the Beeper Desktop application"""
         from .resources.info import InfoResource
 
         return InfoResource(self)
@@ -448,6 +449,7 @@ def assets(self) -> AsyncAssetsResource:
 
     @cached_property
     def info(self) -> AsyncInfoResource:
+        """Control the Beeper Desktop application"""
         from .resources.info import AsyncInfoResource
 
         return AsyncInfoResource(self)
@@ -700,6 +702,7 @@ def assets(self) -> assets.AssetsResourceWithRawResponse:
 
     @cached_property
     def info(self) -> info.InfoResourceWithRawResponse:
+        """Control the Beeper Desktop application"""
         from .resources.info import InfoResourceWithRawResponse
 
         return InfoResourceWithRawResponse(self._client.info)
@@ -748,6 +751,7 @@ def assets(self) -> assets.AsyncAssetsResourceWithRawResponse:
 
     @cached_property
     def info(self) -> info.AsyncInfoResourceWithRawResponse:
+        """Control the Beeper Desktop application"""
         from .resources.info import AsyncInfoResourceWithRawResponse
 
         return AsyncInfoResourceWithRawResponse(self._client.info)
@@ -796,6 +800,7 @@ def assets(self) -> assets.AssetsResourceWithStreamingResponse:
 
     @cached_property
     def info(self) -> info.InfoResourceWithStreamingResponse:
+        """Control the Beeper Desktop application"""
         from .resources.info import InfoResourceWithStreamingResponse
 
         return InfoResourceWithStreamingResponse(self._client.info)
@@ -844,6 +849,7 @@ def assets(self) -> assets.AsyncAssetsResourceWithStreamingResponse:
 
     @cached_property
     def info(self) -> info.AsyncInfoResourceWithStreamingResponse:
+        """Control the Beeper Desktop application"""
         from .resources.info import AsyncInfoResourceWithStreamingResponse
 
         return AsyncInfoResourceWithStreamingResponse(self._client.info)

src/beeper_desktop_api/_response.py

@@ -152,6 +152,7 @@ def _parse(self, *, to: type[_T] | None = None) -> R | _T:
                         ),
                         response=self.http_response,
                         client=cast(Any, self._client),
+                        options=self._options,
                     ),
                 )
 
@@ -162,6 +163,7 @@ def _parse(self, *, to: type[_T] | None = None) -> R | _T:
                         cast_to=extract_stream_chunk_type(self._stream_cls),
                         response=self.http_response,
                         client=cast(Any, self._client),
+                        options=self._options,
                     ),
                 )
 
@@ -175,6 +177,7 @@ def _parse(self, *, to: type[_T] | None = None) -> R | _T:
                     cast_to=cast_to,
                     response=self.http_response,
                     client=cast(Any, self._client),
+                    options=self._options,
                 ),
             )
 

src/beeper_desktop_api/_streaming.py

@@ -4,7 +4,7 @@
 import json
 import inspect
 from types import TracebackType
-from typing import TYPE_CHECKING, Any, Generic, TypeVar, Iterator, AsyncIterator, cast
+from typing import TYPE_CHECKING, Any, Generic, TypeVar, Iterator, Optional, AsyncIterator, cast
 from typing_extensions import Self, Protocol, TypeGuard, override, get_origin, runtime_checkable
 
 import httpx
@@ -13,6 +13,7 @@
 
 if TYPE_CHECKING:
     from ._client import BeeperDesktop, AsyncBeeperDesktop
+    from ._models import FinalRequestOptions
 
 
 _T = TypeVar("_T")
@@ -22,7 +23,7 @@ class Stream(Generic[_T]):
     """Provides the core interface to iterate over a synchronous stream response."""
 
     response: httpx.Response
-
+    _options: Optional[FinalRequestOptions] = None
     _decoder: SSEBytesDecoder
 
     def __init__(
@@ -31,10 +32,12 @@ def __init__(
         cast_to: type[_T],
         response: httpx.Response,
         client: BeeperDesktop,
+        options: Optional[FinalRequestOptions] = None,
     ) -> None:
         self.response = response
         self._cast_to = cast_to
         self._client = client
+        self._options = options
         self._decoder = client._make_sse_decoder()
         self._iterator = self.__stream__()
 
@@ -85,7 +88,7 @@ class AsyncStream(Generic[_T]):
     """Provides the core interface to iterate over an asynchronous stream response."""
 
     response: httpx.Response
-
+    _options: Optional[FinalRequestOptions] = None
     _decoder: SSEDecoder | SSEBytesDecoder
 
     def __init__(
@@ -94,10 +97,12 @@ def __init__(
         cast_to: type[_T],
         response: httpx.Response,
         client: AsyncBeeperDesktop,
+        options: Optional[FinalRequestOptions] = None,
     ) -> None:
         self.response = response
         self._cast_to = cast_to
         self._client = client
+        self._options = options
         self._decoder = client._make_sse_decoder()
         self._iterator = self.__stream__()
 

src/beeper_desktop_api/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "beeper_desktop_api"
-__version__ = "4.3.0"  # x-release-please-version
+__version__ = "4.4.0"  # x-release-please-version

src/beeper_desktop_api/resources/info.py

@@ -20,6 +20,8 @@
 
 
 class InfoResource(SyncAPIResource):
+    """Control the Beeper Desktop application"""
+
     @cached_property
     def with_raw_response(self) -> InfoResourceWithRawResponse:
         """
@@ -63,6 +65,8 @@ def retrieve(
 
 
 class AsyncInfoResource(AsyncAPIResource):
+    """Control the Beeper Desktop application"""
+
     @cached_property
     def with_raw_response(self) -> AsyncInfoResourceWithRawResponse:
         """