feat(api): add network, bridge fields to accounts

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 23
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-5a8ac7b545c48dc892e5c680303e305254921554dabee848e40a808659dbcf1e.yml
-openapi_spec_hash: 0103975601aac1445d3a4ef418c5d17a
-config_hash: 7d85c0b454fc78a59db6474c5c4d73c6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-611aa7641fbca8cf31d626bf86f9efd3c2b92778e897ebbb25c6ea44185ed1ed.yml
+openapi_spec_hash: d6c0a1776048dab04f6c5625c9893c9c
+config_hash: 39ed0717b5f415499aaace2468346e1a

README.md

@@ -7,8 +7,6 @@ The Beeper Desktop Python library provides convenient access to the Beeper Deskt
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
-It is generated with [Stainless](https://www.stainless.com/).
-
 ## MCP Server
 
 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.
@@ -25,18 +23,24 @@ The REST API documentation can be found on [developers.beeper.com](https://devel
 ## Installation
 
 ```sh
-# install from PyPI
-pip install beeper_desktop_api
+# install from the production repo
+pip install git+ssh://git@github.com/beeper/desktop-api-python.git
 ```
 
+> [!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()
+client = BeeperDesktop(
+    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
+)
 
 page = client.chats.search(
     include_muted=True,
@@ -56,10 +60,13 @@ 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()
+client = AsyncBeeperDesktop(
+    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
+)
 
 
 async def main() -> None:
@@ -83,20 +90,24 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from PyPI
-pip install beeper_desktop_api[aiohttp]
+# install from the production repo
+pip install 'beeper_desktop_api[aiohttp] @ git+ssh://git@github.com/beeper/desktop-api-python.git'
 ```
 
 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(
@@ -207,11 +218,10 @@ from beeper_desktop_api import BeeperDesktop
 
 client = BeeperDesktop()
 
-chat = client.chats.create(
-    account_id="accountID",
-    user={},
+client.chats.reminders.create(
+    chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com",
+    reminder={"remind_at_ms": 0},
 )
-print(chat.user)
 ```
 
 ## File uploads

src/beeper_desktop_api/resources/chats/chats.py

@@ -79,14 +79,7 @@ def with_streaming_response(self) -> ChatsResourceWithStreamingResponse:
     def create(
         self,
         *,
-        account_id: str,
-        allow_invite: bool | Omit = omit,
-        message_text: str | Omit = omit,
-        mode: Literal["create", "start"] | Omit = omit,
-        participant_ids: SequenceNotStr[str] | Omit = omit,
-        title: str | Omit = omit,
-        type: Literal["single", "group"] | Omit = omit,
-        user: chat_create_params.User | Omit = omit,
+        params: chat_create_params.Params | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -99,26 +92,6 @@ def create(
         user data (mode='start').
 
         Args:
-          account_id: Account to create or start the chat on.
-
-          allow_invite: Whether invite-based DM creation is allowed when required by the platform. Used
-              for mode='start'.
-
-          message_text: Optional first message content if the platform requires it to create the chat.
-
-          mode: Operation mode. Defaults to 'create' when omitted.
-
-          participant_ids: Required when mode='create'. User IDs to include in the new chat.
-
-          title: Optional title for group chats when mode='create'; ignored for single chats on
-              most platforms.
-
-          type: Required when mode='create'. 'single' requires exactly one participantID;
-              'group' supports multiple participants and optional title.
-
-          user: Required when mode='start'. Merged user-like contact payload used to resolve the
-              best identifier.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -129,19 +102,7 @@ def create(
         """
         return self._post(
             "/v1/chats",
-            body=maybe_transform(
-                {
-                    "account_id": account_id,
-                    "allow_invite": allow_invite,
-                    "message_text": message_text,
-                    "mode": mode,
-                    "participant_ids": participant_ids,
-                    "title": title,
-                    "type": type,
-                    "user": user,
-                },
-                chat_create_params.ChatCreateParams,
-            ),
+            body=maybe_transform(params, chat_create_params.ChatCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -422,14 +383,7 @@ def with_streaming_response(self) -> AsyncChatsResourceWithStreamingResponse:
     async def create(
         self,
         *,
-        account_id: str,
-        allow_invite: bool | Omit = omit,
-        message_text: str | Omit = omit,
-        mode: Literal["create", "start"] | Omit = omit,
-        participant_ids: SequenceNotStr[str] | Omit = omit,
-        title: str | Omit = omit,
-        type: Literal["single", "group"] | Omit = omit,
-        user: chat_create_params.User | Omit = omit,
+        params: chat_create_params.Params | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -442,26 +396,6 @@ async def create(
         user data (mode='start').
 
         Args:
-          account_id: Account to create or start the chat on.
-
-          allow_invite: Whether invite-based DM creation is allowed when required by the platform. Used
-              for mode='start'.
-
-          message_text: Optional first message content if the platform requires it to create the chat.
-
-          mode: Operation mode. Defaults to 'create' when omitted.
-
-          participant_ids: Required when mode='create'. User IDs to include in the new chat.
-
-          title: Optional title for group chats when mode='create'; ignored for single chats on
-              most platforms.
-
-          type: Required when mode='create'. 'single' requires exactly one participantID;
-              'group' supports multiple participants and optional title.
-
-          user: Required when mode='start'. Merged user-like contact payload used to resolve the
-              best identifier.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -472,19 +406,7 @@ async def create(
         """
         return await self._post(
             "/v1/chats",
-            body=await async_maybe_transform(
-                {
-                    "account_id": account_id,
-                    "allow_invite": allow_invite,
-                    "message_text": message_text,
-                    "mode": mode,
-                    "participant_ids": participant_ids,
-                    "title": title,
-                    "type": type,
-                    "user": user,
-                },
-                chat_create_params.ChatCreateParams,
-            ),
+            body=await async_maybe_transform(params, chat_create_params.ChatCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/beeper_desktop_api/types/account.py

@@ -1,11 +1,26 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing_extensions import Literal
+
 from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
 from .shared.user import User
 
-__all__ = ["Account"]
+__all__ = ["Account", "Bridge"]
+
+
+class Bridge(BaseModel):
+    """Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+."""
+
+    id: str
+    """Bridge instance identifier."""
+
+    provider: Literal["cloud", "self-hosted", "local", "platform-sdk"]
+    """Bridge provider for the account."""
+
+    type: str
+    """Bridge type."""
 
 
 class Account(BaseModel):
@@ -14,5 +29,11 @@ class Account(BaseModel):
     account_id: str = FieldInfo(alias="accountID")
     """Chat account added to Beeper. Use this to route account-scoped actions."""
 
+    bridge: Bridge
+    """Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+."""
+
+    network: str
+    """Human-friendly network name for the account."""
+
     user: User
     """User the account belongs to."""

src/beeper_desktop_api/types/chat_create_params.py

@@ -2,18 +2,48 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing import Union
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
-__all__ = ["ChatCreateParams", "User"]
+__all__ = ["ChatCreateParams", "Params", "ParamsUnionMember0", "ParamsUnionMember0User", "ParamsUnionMember1"]
 
 
 class ChatCreateParams(TypedDict, total=False):
+    params: Params
+
+
+class ParamsUnionMember0User(TypedDict, total=False):
+    """Merged user-like contact payload used to resolve the best identifier."""
+
+    id: str
+    """Known user ID when available."""
+
+    email: str
+    """Email candidate."""
+
+    full_name: Annotated[str, PropertyInfo(alias="fullName")]
+    """Display name hint used for ranking only."""
+
+    phone_number: Annotated[str, PropertyInfo(alias="phoneNumber")]
+    """Phone number candidate (E.164 preferred)."""
+
+    username: str
+    """Username/handle candidate."""
+
+
+class ParamsUnionMember0(TypedDict, total=False):
     account_id: Required[Annotated[str, PropertyInfo(alias="accountID")]]
     """Account to create or start the chat on."""
 
+    mode: Required[Literal["start"]]
+    """Operation mode. Use 'start' to resolve a user/contact and start a direct chat."""
+
+    user: Required[ParamsUnionMember0User]
+    """Merged user-like contact payload used to resolve the best identifier."""
+
     allow_invite: Annotated[bool, PropertyInfo(alias="allowInvite")]
     """Whether invite-based DM creation is allowed when required by the platform.
 
@@ -23,49 +53,28 @@ class ChatCreateParams(TypedDict, total=False):
     message_text: Annotated[str, PropertyInfo(alias="messageText")]
     """Optional first message content if the platform requires it to create the chat."""
 
-    mode: Literal["create", "start"]
-    """Operation mode. Defaults to 'create' when omitted."""
-
-    participant_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="participantIDs")]
-    """Required when mode='create'. User IDs to include in the new chat."""
 
-    title: str
-    """
-    Optional title for group chats when mode='create'; ignored for single chats on
-    most platforms.
-    """
+class ParamsUnionMember1(TypedDict, total=False):
+    account_id: Required[Annotated[str, PropertyInfo(alias="accountID")]]
+    """Account to create or start the chat on."""
 
-    type: Literal["single", "group"]
-    """Required when mode='create'.
+    participant_ids: Required[Annotated[SequenceNotStr[str], PropertyInfo(alias="participantIDs")]]
+    """User IDs to include in the new chat."""
 
+    type: Required[Literal["single", "group"]]
+    """
     'single' requires exactly one participantID; 'group' supports multiple
     participants and optional title.
     """
 
-    user: User
-    """Required when mode='start'.
-
-    Merged user-like contact payload used to resolve the best identifier.
-    """
-
-
-class User(TypedDict, total=False):
-    """Required when mode='start'.
-
-    Merged user-like contact payload used to resolve the best identifier.
-    """
-
-    id: str
-    """Known user ID when available."""
+    message_text: Annotated[str, PropertyInfo(alias="messageText")]
+    """Optional first message content if the platform requires it to create the chat."""
 
-    email: str
-    """Email candidate."""
+    mode: Literal["create"]
+    """Operation mode. Defaults to 'create' when omitted."""
 
-    full_name: Annotated[str, PropertyInfo(alias="fullName")]
-    """Display name hint used for ranking only."""
+    title: str
+    """Optional title for group chats; ignored for single chats on most platforms."""
 
-    phone_number: Annotated[str, PropertyInfo(alias="phoneNumber")]
-    """Phone number candidate (E.164 preferred)."""
 
-    username: str
-    """Username/handle candidate."""
+Params: TypeAlias = Union[ParamsUnionMember0, ParamsUnionMember1]