feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 24
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper/beeper-desktop-api-8b89ffbfeb39b4186328fefd81f7dab1d28c786012201feb8035c7f920c4fbae.yml
-openapi_spec_hash: de40e013fcc83fa44d5c51ddecb543c0
-config_hash: 08b781db5f1857ed601d1b2f4b6b45d9
+configured_endpoints: 30
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper/beeper-desktop-api-c08c14bb754b4cb0e02b21fabb680469368286be339dec0aaa8c69d04a1f021a.yml
+openapi_spec_hash: a10246aaf7cdc33b682fc245bd5f893b
+config_hash: 72f9d43b9b51a5da912e9f3730e53ae2

README.md

@@ -43,6 +43,7 @@ client = BeeperDesktop(
 )
 
 page = client.chats.search(
+    account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
     include_muted=True,
     limit=3,
     type="single",
@@ -71,6 +72,7 @@ client = AsyncBeeperDesktop(
 
 async def main() -> None:
     page = await client.chats.search(
+        account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
         include_muted=True,
         limit=3,
         type="single",
@@ -111,6 +113,7 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         page = await client.chats.search(
+            account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
             include_muted=True,
             limit=3,
             type="single",
@@ -144,9 +147,9 @@ client = BeeperDesktop()
 all_messages = []
 # Automatically fetches more pages as needed.
 for message in client.messages.search(
-    account_ids=["local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"],
+    account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
     limit=10,
-    query="deployment",
+    query="oauth",
 ):
     # Do something with message here
     all_messages.append(message)
@@ -166,9 +169,9 @@ async def main() -> None:
     all_messages = []
     # Iterate through items across all pages, issuing requests as needed.
     async for message in client.messages.search(
-        account_ids=["local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"],
+        account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
         limit=10,
-        query="deployment",
+        query="oauth",
     ):
         all_messages.append(message)
     print(all_messages)
@@ -181,9 +184,9 @@ Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get
 
 ```python
 first_page = await client.messages.search(
-    account_ids=["local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"],
+    account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
     limit=10,
-    query="deployment",
+    query="oauth",
 )
 if first_page.has_next_page():
     print(f"will fetch next page using these details: {first_page.next_page_info()}")
@@ -197,9 +200,9 @@ Or just work directly with the returned data:
 
 ```python
 first_page = await client.messages.search(
-    account_ids=["local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"],
+    account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"],
     limit=10,
-    query="deployment",
+    query="oauth",
 )
 
 print(f"next page cursor: {first_page.oldest_cursor}")  # => "next page cursor: ..."
@@ -218,11 +221,11 @@ from beeper_desktop_api import BeeperDesktop
 
 client = BeeperDesktop()
 
-response = client.chats.start(
-    account_id="accountID",
-    user={},
+chat = client.chats.update(
+    chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com",
+    draft={"text": "text"},
 )
-print(response.user)
+print(chat.draft)
 ```
 
 ## File uploads

api.md

@@ -54,10 +54,14 @@ Methods:
 
 - <code title="post /v1/chats">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">create</a>(\*\*<a href="src/beeper_desktop_api/types/chat_create_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat_create_response.py">ChatCreateResponse</a></code>
 - <code title="get /v1/chats/{chatID}">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">retrieve</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/chat_retrieve_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat.py">Chat</a></code>
+- <code title="patch /v1/chats/{chatID}">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">update</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/chat_update_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat.py">Chat</a></code>
 - <code title="get /v1/chats">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">list</a>(\*\*<a href="src/beeper_desktop_api/types/chat_list_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat_list_response.py">SyncCursorNoLimit[ChatListResponse]</a></code>
 - <code title="post /v1/chats/{chatID}/archive">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">archive</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/chat_archive_params.py">params</a>) -> None</code>
+- <code title="post /v1/chats/{chatID}/read">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">mark_read</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/chat_mark_read_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat.py">Chat</a></code>
+- <code title="post /v1/chats/{chatID}/unread">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">mark_unread</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/chat_mark_unread_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat.py">Chat</a></code>
+- <code title="post /v1/chats/{chatID}/notify-anyway">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">notify_anyway</a>(chat_id) -> <a href="./src/beeper_desktop_api/types/chat.py">Chat</a></code>
 - <code title="get /v1/chats/search">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">search</a>(\*\*<a href="src/beeper_desktop_api/types/chat_search_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat.py">SyncCursorSearch[Chat]</a></code>
-- <code title="post /v1/chats.start">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">start</a>(\*\*<a href="src/beeper_desktop_api/types/chat_start_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat_start_response.py">ChatStartResponse</a></code>
+- <code title="post /v1/chats/start">client.chats.<a href="./src/beeper_desktop_api/resources/chats/chats.py">start</a>(\*\*<a href="src/beeper_desktop_api/types/chat_start_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chat_start_response.py">ChatStartResponse</a></code>
 
 ## Reminders
 
@@ -78,7 +82,7 @@ from beeper_desktop_api.types.chats.messages import ReactionDeleteResponse, Reac
 
 Methods:
 
-- <code title="delete /v1/chats/{chatID}/messages/{messageID}/reactions">client.chats.messages.reactions.<a href="./src/beeper_desktop_api/resources/chats/messages/reactions.py">delete</a>(message_id, \*, chat_id, \*\*<a href="src/beeper_desktop_api/types/chats/messages/reaction_delete_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chats/messages/reaction_delete_response.py">ReactionDeleteResponse</a></code>
+- <code title="delete /v1/chats/{chatID}/messages/{messageID}/reactions/{reactionKey}">client.chats.messages.reactions.<a href="./src/beeper_desktop_api/resources/chats/messages/reactions.py">delete</a>(reaction_key, \*, chat_id, message_id) -> <a href="./src/beeper_desktop_api/types/chats/messages/reaction_delete_response.py">ReactionDeleteResponse</a></code>
 - <code title="post /v1/chats/{chatID}/messages/{messageID}/reactions">client.chats.messages.reactions.<a href="./src/beeper_desktop_api/resources/chats/messages/reactions.py">add</a>(message_id, \*, chat_id, \*\*<a href="src/beeper_desktop_api/types/chats/messages/reaction_add_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/chats/messages/reaction_add_response.py">ReactionAddResponse</a></code>
 
 # Messages
@@ -91,8 +95,10 @@ from beeper_desktop_api.types import MessageUpdateResponse, MessageSendResponse
 
 Methods:
 
+- <code title="get /v1/chats/{chatID}/messages/{messageID}">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">retrieve</a>(message_id, \*, chat_id) -> <a href="./src/beeper_desktop_api/types/shared/message.py">Message</a></code>
 - <code title="put /v1/chats/{chatID}/messages/{messageID}">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">update</a>(message_id, \*, chat_id, \*\*<a href="src/beeper_desktop_api/types/message_update_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/message_update_response.py">MessageUpdateResponse</a></code>
 - <code title="get /v1/chats/{chatID}/messages">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">list</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/message_list_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/shared/message.py">SyncCursorNoLimit[Message]</a></code>
+- <code title="delete /v1/chats/{chatID}/messages/{messageID}">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">delete</a>(message_id, \*, chat_id, \*\*<a href="src/beeper_desktop_api/types/message_delete_params.py">params</a>) -> None</code>
 - <code title="get /v1/messages/search">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">search</a>(\*\*<a href="src/beeper_desktop_api/types/message_search_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/shared/message.py">SyncCursorSearch[Message]</a></code>
 - <code title="post /v1/chats/{chatID}/messages">client.messages.<a href="./src/beeper_desktop_api/resources/messages.py">send</a>(chat_id, \*\*<a href="src/beeper_desktop_api/types/message_send_params.py">params</a>) -> <a href="./src/beeper_desktop_api/types/message_send_response.py">MessageSendResponse</a></code>
 

src/beeper_desktop_api/_client.py

@@ -165,7 +165,10 @@ def assets(self) -> AssetsResource:
 
     @cached_property
     def info(self) -> InfoResource:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import InfoResource
 
         return InfoResource(self)
@@ -270,15 +273,15 @@ def focus(
     ) -> FocusResponse:
         """
         Focus Beeper Desktop and optionally navigate to a specific chat, message, or
-        pre-fill draft text and attachment.
+        pre-fill plain text and an image path.
 
         Args:
           chat_id: Optional Beeper chat ID (or local chat ID) to focus after opening the app. If
               omitted, only opens/focuses the app.
 
-          draft_attachment_path: Optional draft attachment path to populate in the message input field.
+          draft_attachment_path: Optional image path to populate in the message input field.
 
-          draft_text: Optional draft text to populate in the message input field.
+          draft_text: Optional plain text to populate in the message input field.
 
           message_id: Optional message ID. Jumps to that message in the chat when opening.
 
@@ -474,7 +477,10 @@ def assets(self) -> AsyncAssetsResource:
 
     @cached_property
     def info(self) -> AsyncInfoResource:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import AsyncInfoResource
 
         return AsyncInfoResource(self)
@@ -579,15 +585,15 @@ async def focus(
     ) -> FocusResponse:
         """
         Focus Beeper Desktop and optionally navigate to a specific chat, message, or
-        pre-fill draft text and attachment.
+        pre-fill plain text and an image path.
 
         Args:
           chat_id: Optional Beeper chat ID (or local chat ID) to focus after opening the app. If
               omitted, only opens/focuses the app.
 
-          draft_attachment_path: Optional draft attachment path to populate in the message input field.
+          draft_attachment_path: Optional image path to populate in the message input field.
 
-          draft_text: Optional draft text to populate in the message input field.
+          draft_text: Optional plain text to populate in the message input field.
 
           message_id: Optional message ID. Jumps to that message in the chat when opening.
 
@@ -732,7 +738,10 @@ def assets(self) -> assets.AssetsResourceWithRawResponse:
 
     @cached_property
     def info(self) -> info.InfoResourceWithRawResponse:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import InfoResourceWithRawResponse
 
         return InfoResourceWithRawResponse(self._client.info)
@@ -781,7 +790,10 @@ def assets(self) -> assets.AsyncAssetsResourceWithRawResponse:
 
     @cached_property
     def info(self) -> info.AsyncInfoResourceWithRawResponse:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import AsyncInfoResourceWithRawResponse
 
         return AsyncInfoResourceWithRawResponse(self._client.info)
@@ -830,7 +842,10 @@ def assets(self) -> assets.AssetsResourceWithStreamingResponse:
 
     @cached_property
     def info(self) -> info.InfoResourceWithStreamingResponse:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import InfoResourceWithStreamingResponse
 
         return InfoResourceWithStreamingResponse(self._client.info)
@@ -879,7 +894,10 @@ def assets(self) -> assets.AsyncAssetsResourceWithStreamingResponse:
 
     @cached_property
     def info(self) -> info.AsyncInfoResourceWithStreamingResponse:
-        """Control the Beeper Desktop application"""
+        """Server discovery and capability metadata.
+
+        Use /v1/info before authentication setup.
+        """
         from .resources.info import AsyncInfoResourceWithStreamingResponse
 
         return AsyncInfoResourceWithStreamingResponse(self._client.info)

src/beeper_desktop_api/resources/accounts/accounts.py

@@ -65,8 +65,8 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AccountListResponse:
         """
-        Lists chat accounts across networks (WhatsApp, Telegram, Twitter/X, etc.)
-        actively connected to this Beeper Desktop instance
+        List Chat Accounts connected to this Beeper Desktop instance, including bridge
+        metadata and network identity.
         """
         return self._get(
             "/v1/accounts",
@@ -115,8 +115,8 @@ async def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AccountListResponse:
         """
-        Lists chat accounts across networks (WhatsApp, Telegram, Twitter/X, etc.)
-        actively connected to this Beeper Desktop instance
+        List Chat Accounts connected to this Beeper Desktop instance, including bridge
+        metadata and network identity.
         """
         return await self._get(
             "/v1/accounts",

src/beeper_desktop_api/resources/assets.py

@@ -68,11 +68,11 @@ def download(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AssetDownloadResponse:
         """
-        Download a Matrix asset using its mxc:// or localmxc:// URL to the device
-        running Beeper Desktop and return the local file URL.
+        Download a Matrix file using its mxc:// or localmxc:// URL to the device running
+        Beeper Desktop and return the local file URL.
 
         Args:
-          url: Matrix content URL (mxc:// or localmxc://) for the asset to download.
+          url: Matrix content URL (mxc:// or localmxc://) for the file to download.
 
           extra_headers: Send extra headers
 
@@ -108,7 +108,7 @@ def serve(
         not cached. Supports Range requests for seeking in large files.
 
         Args:
-          url: Asset URL to serve. Accepts mxc://, localmxc://, or file:// URLs.
+          url: File URL to serve. Accepts mxc://, localmxc://, or file:// URLs.
 
           extra_headers: Send extra headers
 
@@ -147,7 +147,8 @@ def upload(
         """Upload a file to a temporary location using multipart/form-data.
 
         Returns an
-        uploadID that can be referenced when sending messages with attachments.
+        uploadID that can be referenced when sending a message or materializing a draft
+        attachment.
 
         Args:
           file: The file to upload (max 500 MB).
@@ -203,8 +204,8 @@ def upload_base64(
         """Upload a file using a JSON body with base64-encoded content.
 
         Returns an uploadID
-        that can be referenced when sending messages with attachments. Alternative to
-        the multipart upload endpoint.
+        that can be referenced when sending a message or materializing a draft
+        attachment. Alternative to the multipart upload endpoint.
 
         Args:
           content: Base64-encoded file content (max ~500MB decoded)
@@ -272,11 +273,11 @@ async def download(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AssetDownloadResponse:
         """
-        Download a Matrix asset using its mxc:// or localmxc:// URL to the device
-        running Beeper Desktop and return the local file URL.
+        Download a Matrix file using its mxc:// or localmxc:// URL to the device running
+        Beeper Desktop and return the local file URL.
 
         Args:
-          url: Matrix content URL (mxc:// or localmxc://) for the asset to download.
+          url: Matrix content URL (mxc:// or localmxc://) for the file to download.
 
           extra_headers: Send extra headers
 
@@ -312,7 +313,7 @@ async def serve(
         not cached. Supports Range requests for seeking in large files.
 
         Args:
-          url: Asset URL to serve. Accepts mxc://, localmxc://, or file:// URLs.
+          url: File URL to serve. Accepts mxc://, localmxc://, or file:// URLs.
 
           extra_headers: Send extra headers
 
@@ -351,7 +352,8 @@ async def upload(
         """Upload a file to a temporary location using multipart/form-data.
 
         Returns an
-        uploadID that can be referenced when sending messages with attachments.
+        uploadID that can be referenced when sending a message or materializing a draft
+        attachment.
 
         Args:
           file: The file to upload (max 500 MB).
@@ -407,8 +409,8 @@ async def upload_base64(
         """Upload a file using a JSON body with base64-encoded content.
 
         Returns an uploadID
-        that can be referenced when sending messages with attachments. Alternative to
-        the multipart upload endpoint.
+        that can be referenced when sending a message or materializing a draft
+        attachment. Alternative to the multipart upload endpoint.
 
         Args:
           content: Base64-encoded file content (max ~500MB decoded)