diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000..ff261ba --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,9 @@ +ARG VARIANT="3.9" +FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} + +USER vscode + +RUN curl -sSf https://rye.astral.sh/get | RYE_VERSION="0.44.0" RYE_INSTALL_OPTION="--yes" bash +ENV PATH=/home/vscode/.rye/shims:$PATH + +RUN echo "[[ -d .venv ]] && source .venv/bin/activate || export PATH=\$PATH" >> /home/vscode/.bashrc diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..c17fdc1 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,43 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/debian +{ + "name": "Debian", + "build": { + "dockerfile": "Dockerfile", + "context": ".." + }, + + "postStartCommand": "rye sync --all-features", + + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python" + ], + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "python.pythonPath": ".venv/bin/python", + "python.defaultInterpreterPath": ".venv/bin/python", + "python.typeChecking": "basic", + "terminal.integrated.env.linux": { + "PATH": "/home/vscode/.rye/shims:${env:PATH}" + } + } + } + }, + "features": { + "ghcr.io/devcontainers/features/node:1": {} + } + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ed91b37 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,104 @@ +name: CI +on: + push: + branches: + - '**' + - '!integrated/**' + - '!stl-preview-head/**' + - '!stl-preview-base/**' + - '!generated' + - '!codegen/**' + - 'codegen/stl/**' + pull_request: + branches-ignore: + - 'stl-preview-head/**' + - 'stl-preview-base/**' + +jobs: + lint: + timeout-minutes: 10 + name: lint + runs-on: ${{ github.repository == 'stainless-sdks/beeper-desktop-api-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Install Rye + run: | + curl -sSf https://rye.astral.sh/get | bash + echo "$HOME/.rye/shims" >> $GITHUB_PATH + env: + RYE_VERSION: '0.44.0' + RYE_INSTALL_OPTION: '--yes' + + - name: Install dependencies + run: rye sync --all-features + + - name: Run lints + run: ./scripts/lint + + build: + if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') + timeout-minutes: 10 + name: build + permissions: + contents: read + id-token: write + runs-on: ${{ github.repository == 'stainless-sdks/beeper-desktop-api-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Install Rye + run: | + curl -sSf https://rye.astral.sh/get | bash + echo "$HOME/.rye/shims" >> $GITHUB_PATH + env: + RYE_VERSION: '0.44.0' + RYE_INSTALL_OPTION: '--yes' + + - name: Install dependencies + run: rye sync --all-features + + - name: Run build + run: rye build + + - name: Get GitHub OIDC Token + if: |- + github.repository == 'stainless-sdks/beeper-desktop-api-python' && + !startsWith(github.ref, 'refs/heads/stl/') + id: github-oidc + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 + with: + script: core.setOutput('github_token', await core.getIDToken()); + + - name: Upload tarball + 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 }} + SHA: ${{ github.sha }} + run: ./scripts/utils/upload-artifact.sh + + test: + timeout-minutes: 10 + name: test + runs-on: ${{ github.repository == 'stainless-sdks/beeper-desktop-api-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Install Rye + run: | + curl -sSf https://rye.astral.sh/get | bash + echo "$HOME/.rye/shims" >> $GITHUB_PATH + env: + RYE_VERSION: '0.44.0' + RYE_INSTALL_OPTION: '--yes' + + - name: Bootstrap + run: ./scripts/bootstrap + + - name: Run tests + run: ./scripts/test diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml new file mode 100644 index 0000000..4954ee6 --- /dev/null +++ b/.github/workflows/publish-pypi.yml @@ -0,0 +1,31 @@ +# This workflow is triggered when a GitHub release is created. +# It can also be run manually to re-publish to PyPI in case it failed for some reason. +# You can run this workflow by navigating to https://www.github.com/beeper/desktop-api-python/actions/workflows/publish-pypi.yml +name: Publish PyPI +on: + workflow_dispatch: + + release: + types: [published] + +jobs: + publish: + name: publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Install Rye + run: | + curl -sSf https://rye.astral.sh/get | bash + echo "$HOME/.rye/shims" >> $GITHUB_PATH + env: + RYE_VERSION: '0.44.0' + RYE_INSTALL_OPTION: '--yes' + + - name: Publish to PyPI + run: | + bash ./bin/publish-pypi + env: + PYPI_TOKEN: ${{ secrets.BEEPER_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 0000000..0fe0ce0 --- /dev/null +++ b/.github/workflows/release-doctor.yml @@ -0,0 +1,21 @@ +name: Release Doctor +on: + pull_request: + branches: + - main + workflow_dispatch: + +jobs: + release_doctor: + name: release doctor + runs-on: ubuntu-latest + if: github.repository == 'beeper/desktop-api-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Check release environment + run: | + bash ./bin/check-release-environment + env: + PYPI_TOKEN: ${{ secrets.BEEPER_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3824f4c --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +.prism.log +.stdy.log +_dev + +__pycache__ +.mypy_cache + +dist + +.venv +.idea + +.env +.envrc +codegen.log +Brewfile.lock.json diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..43077b2 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.9.18 diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..8e76abb --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "5.0.0" +} \ No newline at end of file diff --git a/.stats.yml b/.stats.yml new file mode 100644 index 0000000..3e06ccc --- /dev/null +++ b/.stats.yml @@ -0,0 +1,4 @@ +configured_endpoints: 56 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper/beeper-desktop-api-baac187842e51587134950c59c4d746bfcb59239f01919ed83b92c24c47d98f4.yml +openapi_spec_hash: 9de80d05f7562b7ecd07c466f0fdf58b +config_hash: a8a4a8b869ccd5976fd4107e67d2ecae diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..5b01030 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "python.analysis.importFormat": "relative", +} diff --git a/Brewfile b/Brewfile new file mode 100644 index 0000000..492ca37 --- /dev/null +++ b/Brewfile @@ -0,0 +1,2 @@ +brew "rye" + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f303ab9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,127 @@ +## Setting up the environment + +### With Rye + +We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run: + +```sh +$ ./scripts/bootstrap +``` + +Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run: + +```sh +$ rye sync --all-features +``` + +You can then run scripts using `rye run python script.py` or by activating the virtual environment: + +```sh +# Activate the virtual environment - https://docs.python.org/3/library/venv.html#how-venvs-work +$ source .venv/bin/activate + +# now you can omit the `rye run` prefix +$ python script.py +``` + +### Without Rye + +Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command: + +```sh +$ pip install -r requirements-dev.lock +``` + +## Modifying/Adding code + +Most of the SDK is generated code. Modifications to code will be persisted between generations, but may +result in merge conflicts between manual patches and changes from the generator. The generator will never +modify the contents of the `src/beeper_desktop_api/lib/` and `examples/` directories. + +## Adding and running examples + +All files in the `examples/` directory are not modified by the generator and can be freely edited or added to. + +```py +# add an example to examples/.py + +#!/usr/bin/env -S rye run python +… +``` + +```sh +$ chmod +x examples/.py +# run the example against your api +$ ./examples/.py +``` + +## Using the repository from source + +If you’d like to use the repository from source, you can either install from git or link to a cloned repository: + +To install via git: + +```sh +$ pip install git+ssh://git@github.com/beeper/desktop-api-python.git +``` + +Alternatively, you can build from source and install the wheel file: + +Building this package will create two files in the `dist/` directory, a `.tar.gz` containing the source files and a `.whl` that can be used to install the package efficiently. + +To create a distributable version of the library, all you have to do is run this command: + +```sh +$ rye build +# or +$ python -m build +``` + +Then to install: + +```sh +$ pip install ./path-to-wheel-file.whl +``` + +## Running tests + +Most tests require you to [set up a mock server](https://github.com/dgellow/steady) against the OpenAPI spec to run the tests. + +```sh +$ ./scripts/mock +``` + +```sh +$ ./scripts/test +``` + +## Linting and formatting + +This repository uses [ruff](https://github.com/astral-sh/ruff) and +[black](https://github.com/psf/black) to format the code in the repository. + +To lint: + +```sh +$ ./scripts/lint +``` + +To format and fix all ruff issues automatically: + +```sh +$ ./scripts/format +``` + +## Publishing and releases + +Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If +the changes aren't made through the automated pipeline, you may want to make releases manually. + +### Publish with a GitHub workflow + +You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/beeper/desktop-api-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up. + +### Publish manually + +If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on +the environment. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..76a908d --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2026 beeperdesktop + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 98a44fc..645fd65 100644 --- a/README.md +++ b/README.md @@ -1 +1,503 @@ -# beeper-desktop-api-python \ No newline at end of file +# Beeper Desktop Python API library + + +[![PyPI version](https://img.shields.io/pypi/v/beeper_desktop_api.svg?label=pypi%20(stable))](https://pypi.org/project/beeper_desktop_api/) + +The Beeper Desktop Python library provides convenient access to the Beeper Desktop REST API from any Python 3.9+ +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). + +## 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. + +[![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) + +> Note: You may need to set environment variables in your MCP client. + +## Documentation + +The REST API documentation can be found on [developers.beeper.com](https://developers.beeper.com/desktop-api/). The full API of this library can be found in [api.md](api.md). + +## Installation + +```sh +# 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( + access_token=os.environ.get("BEEPER_ACCESS_TOKEN"), # This is the default and can be omitted +) + +page = client.chats.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + include_muted=True, + limit=3, + type="single", +) +print(page.items) +``` + +While you can provide a `access_token` keyword argument, +we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/) +to add `BEEPER_ACCESS_TOKEN="My Access Token"` to your `.env` file +so that your Access Token is not stored in source control. + +## Async usage + +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 +) + + +async def main() -> None: + page = await client.chats.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + include_muted=True, + limit=3, + type="single", + ) + print(page.items) + + +asyncio.run(main()) +``` + +Functionality between the synchronous and asynchronous clients is otherwise identical. + +### With aiohttp + +By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend. + +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' +``` + +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( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + include_muted=True, + limit=3, + type="single", + ) + print(page.items) + + +asyncio.run(main()) +``` + +## Using types + +Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like: + +- Serializing back into JSON, `model.to_json()` +- Converting to a dictionary, `model.to_dict()` + +Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`. + +## Pagination + +List methods in the Beeper Desktop API are paginated. + +This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually: + +```python +from beeper_desktop_api import BeeperDesktop + +client = BeeperDesktop() + +all_messages = [] +# Automatically fetches more pages as needed. +for message in client.messages.search( + account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + limit=10, + query="oauth", +): + # Do something with message here + all_messages.append(message) +print(all_messages) +``` + +Or, asynchronously: + +```python +import asyncio +from beeper_desktop_api import AsyncBeeperDesktop + +client = AsyncBeeperDesktop() + + +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=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + limit=10, + query="oauth", + ): + all_messages.append(message) + print(all_messages) + + +asyncio.run(main()) +``` + +Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages: + +```python +first_page = await client.messages.search( + account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + limit=10, + query="oauth", +) +if first_page.has_next_page(): + print(f"will fetch next page using these details: {first_page.next_page_info()}") + next_page = await first_page.get_next_page() + print(f"number of items we just fetched: {len(next_page.items)}") + +# Remove `await` for non-async usage. +``` + +Or just work directly with the returned data: + +```python +first_page = await client.messages.search( + account_ids=["discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + limit=10, + query="oauth", +) + +print(f"next page cursor: {first_page.oldest_cursor}") # => "next page cursor: ..." +for message in first_page.items: + print(message.id) + +# Remove `await` for non-async usage. +``` + +## Nested params + +Nested parameters are dictionaries, typed using `TypedDict`, for example: + +```python +from beeper_desktop_api import BeeperDesktop + +client = BeeperDesktop() + +chat = client.chats.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + draft={"text": "text"}, +) +print(chat.draft) +``` + +## File uploads + +Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`. + +```python +from pathlib import Path +from beeper_desktop_api import BeeperDesktop + +client = BeeperDesktop() + +client.assets.upload( + file=Path("/path/to/file"), +) +``` + +The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically. + +## Handling errors + +When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `beeper_desktop_api.APIConnectionError` is raised. + +When the API returns a non-success status code (that is, 4xx or 5xx +response), a subclass of `beeper_desktop_api.APIStatusError` is raised, containing `status_code` and `response` properties. + +All errors inherit from `beeper_desktop_api.APIError`. + +```python +import beeper_desktop_api +from beeper_desktop_api import BeeperDesktop + +client = BeeperDesktop() + +try: + client.accounts.list() +except beeper_desktop_api.APIConnectionError as e: + print("The server could not be reached") + print(e.__cause__) # an underlying Exception, likely raised within httpx. +except beeper_desktop_api.RateLimitError as e: + print("A 429 status code was received; we should back off a bit.") +except beeper_desktop_api.APIStatusError as e: + print("Another non-200-range status code was received") + print(e.status_code) + print(e.response) +``` + +Error codes are as follows: + +| Status Code | Error Type | +| ----------- | -------------------------- | +| 400 | `BadRequestError` | +| 401 | `AuthenticationError` | +| 403 | `PermissionDeniedError` | +| 404 | `NotFoundError` | +| 422 | `UnprocessableEntityError` | +| 429 | `RateLimitError` | +| >=500 | `InternalServerError` | +| N/A | `APIConnectionError` | + +### Retries + +Certain errors are automatically retried 2 times by default, with a short exponential backoff. +Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, +429 Rate Limit, and >=500 Internal errors are all retried by default. + +You can use the `max_retries` option to configure or disable retry settings: + +```python +from beeper_desktop_api import BeeperDesktop + +# Configure the default for all requests: +client = BeeperDesktop( + # default is 2 + max_retries=0, +) + +# Or, configure per-request: +client.with_options(max_retries=5).accounts.list() +``` + +### Timeouts + +By default requests time out after 30 seconds. You can configure this with a `timeout` option, +which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object: + +```python +from beeper_desktop_api import BeeperDesktop + +# Configure the default for all requests: +client = BeeperDesktop( + # 20 seconds (default is 30 seconds) + timeout=20.0, +) + +# More granular control: +client = BeeperDesktop( + timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0), +) + +# Override per-request: +client.with_options(timeout=5.0).accounts.list() +``` + +On timeout, an `APITimeoutError` is thrown. + +Note that requests that time out are [retried twice by default](#retries). + +## Advanced + +### Logging + +We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module. + +You can enable logging by setting the environment variable `BEEPER_LOG` to `info`. + +```shell +$ export BEEPER_LOG=info +``` + +Or to `debug` for more verbose logging. + +### How to tell whether `None` means `null` or missing + +In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`: + +```py +if response.my_field is None: + if 'my_field' not in response.model_fields_set: + print('Got json like {}, without a "my_field" key present at all.') + else: + print('Got json like {"my_field": null}.') +``` + +### Accessing raw response data (e.g. headers) + +The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g., + +```py +from beeper_desktop_api import BeeperDesktop + +client = BeeperDesktop() +response = client.accounts.with_raw_response.list() +print(response.headers.get('X-My-Header')) + +account = response.parse() # get the object that `accounts.list()` would have returned +print(account) +``` + +These methods return an [`APIResponse`](https://github.com/beeper/desktop-api-python/tree/main/src/beeper_desktop_api/_response.py) object. + +The async client returns an [`AsyncAPIResponse`](https://github.com/beeper/desktop-api-python/tree/main/src/beeper_desktop_api/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. + +#### `.with_streaming_response` + +The above interface eagerly reads the full response body when you make the request, which may not always be what you want. + +To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods. + +```python +with client.accounts.with_streaming_response.list() as response: + print(response.headers.get("X-My-Header")) + + for line in response.iter_lines(): + print(line) +``` + +The context manager is required so that the response will reliably be closed. + +### Making custom/undocumented requests + +This library is typed for convenient access to the documented API. + +If you need to access undocumented endpoints, params, or response properties, the library can still be used. + +#### Undocumented endpoints + +To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other +http verbs. Options on the client will be respected (such as retries) when making this request. + +```py +import httpx + +response = client.post( + "/foo", + cast_to=httpx.Response, + body={"my_param": True}, +) + +print(response.headers.get("x-foo")) +``` + +#### Undocumented request params + +If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request +options. + +#### Undocumented response properties + +To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You +can also get all the extra fields on the Pydantic model as a dict with +[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra). + +### Configuring the HTTP client + +You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including: + +- Support for [proxies](https://www.python-httpx.org/advanced/proxies/) +- Custom [transports](https://www.python-httpx.org/advanced/transports/) +- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality + +```python +import httpx +from beeper_desktop_api import BeeperDesktop, DefaultHttpxClient + +client = BeeperDesktop( + # Or use the `BEEPER_BASE_URL` env var + base_url="http://my.test.server.example.com:8083", + http_client=DefaultHttpxClient( + proxy="http://my.test.proxy.example.com", + transport=httpx.HTTPTransport(local_address="0.0.0.0"), + ), +) +``` + +You can also customize the client on a per-request basis by using `with_options()`: + +```python +client.with_options(http_client=DefaultHttpxClient(...)) +``` + +### Managing HTTP resources + +By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting. + +```py +from beeper_desktop_api import BeeperDesktop + +with BeeperDesktop() as client: + # make requests here + ... + +# HTTP client is now closed +``` + +## Versioning + +This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions: + +1. Changes that only affect static types, without breaking runtime behavior. +2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_ +3. Changes that we do not expect to impact the vast majority of users in practice. + +We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. + +We are keen for your feedback; please open an [issue](https://www.github.com/beeper/desktop-api-python/issues) with questions, bugs, or suggestions. + +### Determining the installed version + +If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version. + +You can determine the version that is being used at runtime with: + +```py +import beeper_desktop_api +print(beeper_desktop_api.__version__) +``` + +## Requirements + +Python 3.9 or higher. + +## Contributing + +See [the contributing documentation](./CONTRIBUTING.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..60d38a6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,27 @@ +# Security Policy + +## Reporting Security Issues + +This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken. + +To report a security issue, please contact the Stainless team at security@stainless.com. + +## Responsible Disclosure + +We appreciate the efforts of security researchers and individuals who help us maintain the security of +SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible +disclosure practices by allowing us a reasonable amount of time to investigate and address the issue +before making any information public. + +## Reporting Non-SDK Related Security Issues + +If you encounter security issues that are not directly related to SDKs but pertain to the services +or products provided by Beeper Desktop, please follow the respective company's security reporting guidelines. + +### Beeper Desktop Terms and Policies + +Please contact security@beeper.com for any questions or concerns regarding the security of our services. + +--- + +Thank you for helping us keep the SDKs and systems they interact with secure. diff --git a/api.md b/api.md new file mode 100644 index 0000000..561079d --- /dev/null +++ b/api.md @@ -0,0 +1,316 @@ +# Shared Types + +```python +from beeper_desktop_api.types import ( + APIError, + AppStateSnapshot, + Attachment, + Error, + Message, + Reaction, + User, +) +``` + +# BeeperDesktop + +Types: + +```python +from beeper_desktop_api.types import FocusResponse, SearchResponse +``` + +Methods: + +- client.focus(\*\*params) -> FocusResponse +- client.search(\*\*params) -> SearchResponse + +# Accounts + +Types: + +```python +from beeper_desktop_api.types import ( + Account, + AccountBridge, + AccountRetrieveResponse, + AccountListResponse, +) +``` + +Methods: + +- client.accounts.retrieve(account_id) -> AccountRetrieveResponse +- client.accounts.list() -> AccountListResponse + +## Contacts + +Types: + +```python +from beeper_desktop_api.types.accounts import ContactSearchResponse +``` + +Methods: + +- client.accounts.contacts.list(account_id, \*\*params) -> SyncCursorSearch[User] +- client.accounts.contacts.search(account_id, \*\*params) -> ContactSearchResponse + +# Bridges + +Types: + +```python +from beeper_desktop_api.types import ( + Bridge, + CookieField, + DisappearingTimerCapability, + GroupFieldCapability, + GroupTypeCapabilities, + LoginFlow, + LoginInputField, + LoginSession, + ProvisioningCapabilities, + ResolveIdentifierCapabilities, + BridgeRetrieveResponse, + BridgeListResponse, +) +``` + +Methods: + +- client.bridges.retrieve(bridge_id) -> BridgeRetrieveResponse +- client.bridges.list() -> BridgeListResponse +- client.bridges.retrieve_capabilities(bridge_id) -> ProvisioningCapabilities + +## LoginFlows + +Types: + +```python +from beeper_desktop_api.types.bridges import LoginFlowListResponse +``` + +Methods: + +- client.bridges.login_flows.list(bridge_id) -> LoginFlowListResponse + +## LoginSessions + +Types: + +```python +from beeper_desktop_api.types.bridges import LoginSessionCancelResponse +``` + +Methods: + +- client.bridges.login_sessions.create(bridge_id, \*\*params) -> LoginSession +- client.bridges.login_sessions.retrieve(login_session_id, \*, bridge_id) -> LoginSession +- client.bridges.login_sessions.cancel(login_session_id, \*, bridge_id) -> LoginSessionCancelResponse + +### Steps + +Methods: + +- client.bridges.login_sessions.steps.submit(step_id, \*, bridge_id, login_session_id, \*\*params) -> LoginSession + +# Chats + +Types: + +```python +from beeper_desktop_api.types import Chat, ChatCreateResponse, ChatListResponse, ChatStartResponse +``` + +Methods: + +- client.chats.create(\*\*params) -> ChatCreateResponse +- client.chats.retrieve(chat_id, \*\*params) -> Chat +- client.chats.update(chat_id, \*\*params) -> Chat +- client.chats.list(\*\*params) -> SyncCursorNoLimit[ChatListResponse] +- client.chats.archive(chat_id, \*\*params) -> None +- client.chats.mark_read(chat_id, \*\*params) -> Chat +- client.chats.mark_unread(chat_id, \*\*params) -> Chat +- client.chats.notify_anyway(chat_id) -> Chat +- client.chats.search(\*\*params) -> SyncCursorSearch[Chat] +- client.chats.start(\*\*params) -> ChatStartResponse + +## Reminders + +Methods: + +- client.chats.reminders.create(chat_id, \*\*params) -> None +- client.chats.reminders.delete(chat_id) -> None + +## Messages + +### Reactions + +Types: + +```python +from beeper_desktop_api.types.chats.messages import ReactionDeleteResponse, ReactionAddResponse +``` + +Methods: + +- client.chats.messages.reactions.delete(reaction_key, \*, chat_id, message_id) -> ReactionDeleteResponse +- client.chats.messages.reactions.add(message_id, \*, chat_id, \*\*params) -> ReactionAddResponse + +# Messages + +Types: + +```python +from beeper_desktop_api.types import MessageUpdateResponse, MessageSendResponse +``` + +Methods: + +- client.messages.retrieve(message_id, \*, chat_id) -> Message +- client.messages.update(message_id, \*, chat_id, \*\*params) -> MessageUpdateResponse +- client.messages.list(chat_id, \*\*params) -> SyncCursorNoLimit[Message] +- client.messages.delete(message_id, \*, chat_id, \*\*params) -> None +- client.messages.search(\*\*params) -> SyncCursorSearch[Message] +- client.messages.send(chat_id, \*\*params) -> MessageSendResponse + +# Assets + +Types: + +```python +from beeper_desktop_api.types import ( + AssetDownloadResponse, + AssetUploadResponse, + AssetUploadBase64Response, +) +``` + +Methods: + +- client.assets.download(\*\*params) -> AssetDownloadResponse +- client.assets.serve(\*\*params) -> BinaryAPIResponse +- client.assets.upload(\*\*params) -> AssetUploadResponse +- client.assets.upload_base64(\*\*params) -> AssetUploadBase64Response + +# Info + +Types: + +```python +from beeper_desktop_api.types import InfoRetrieveResponse +``` + +Methods: + +- client.info.retrieve() -> InfoRetrieveResponse + +# App + +Types: + +```python +from beeper_desktop_api.types import Verification, AppSessionResponse +``` + +Methods: + +- client.app.session() -> AppSessionResponse + +## Login + +Types: + +```python +from beeper_desktop_api.types.app import ( + LoginRegisterResponse, + LoginResponseResponse, + LoginStartResponse, +) +``` + +Methods: + +- client.app.login.email(\*\*params) -> None +- client.app.login.register(\*\*params) -> LoginRegisterResponse +- client.app.login.response(\*\*params) -> LoginResponseResponse +- client.app.login.start() -> LoginStartResponse + +### Verification + +#### RecoveryKey + +Types: + +```python +from beeper_desktop_api.types.app.login.verification import RecoveryKeyVerifyResponse +``` + +Methods: + +- client.app.login.verification.recovery_key.verify(\*\*params) -> RecoveryKeyVerifyResponse + +##### Reset + +Types: + +```python +from beeper_desktop_api.types.app.login.verification.recovery_key import ( + ResetCreateResponse, + ResetConfirmResponse, +) +``` + +Methods: + +- client.app.login.verification.recovery_key.reset.create(\*\*params) -> ResetCreateResponse +- client.app.login.verification.recovery_key.reset.confirm(\*\*params) -> ResetConfirmResponse + +## Verifications + +Types: + +```python +from beeper_desktop_api.types.app import ( + VerificationCreateResponse, + VerificationRetrieveResponse, + VerificationListResponse, + VerificationAcceptResponse, + VerificationCancelResponse, +) +``` + +Methods: + +- client.app.verifications.create(\*\*params) -> VerificationCreateResponse +- client.app.verifications.retrieve(verification_id) -> VerificationRetrieveResponse +- client.app.verifications.list() -> VerificationListResponse +- client.app.verifications.accept(verification_id) -> VerificationAcceptResponse +- client.app.verifications.cancel(verification_id, \*\*params) -> VerificationCancelResponse + +### Qr + +Types: + +```python +from beeper_desktop_api.types.app.verifications import QrConfirmScannedResponse, QrScanResponse +``` + +Methods: + +- client.app.verifications.qr.confirm_scanned(verification_id) -> QrConfirmScannedResponse +- client.app.verifications.qr.scan(\*\*params) -> QrScanResponse + +### SAS + +Types: + +```python +from beeper_desktop_api.types.app.verifications import SASConfirmResponse, SASStartResponse +``` + +Methods: + +- client.app.verifications.sas.confirm(verification_id) -> SASConfirmResponse +- client.app.verifications.sas.start(verification_id) -> SASStartResponse diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 0000000..b845b0f --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${PYPI_TOKEN}" ]; then + errors+=("The PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.") +fi + +lenErrors=${#errors[@]} + +if [[ lenErrors -gt 0 ]]; then + echo -e "Found the following errors in the release environment:\n" + + for error in "${errors[@]}"; do + echo -e "- $error\n" + done + + exit 1 +fi + +echo "The environment is ready to push releases!" diff --git a/bin/publish-pypi b/bin/publish-pypi new file mode 100644 index 0000000..826054e --- /dev/null +++ b/bin/publish-pypi @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +set -eux +mkdir -p dist +rye build --clean +rye publish --yes --token=$PYPI_TOKEN diff --git a/examples/.keep b/examples/.keep new file mode 100644 index 0000000..d8c73e9 --- /dev/null +++ b/examples/.keep @@ -0,0 +1,4 @@ +File generated from our OpenAPI spec by Stainless. + +This directory can be used to store example files demonstrating usage of this SDK. +It is ignored by Stainless code generation and its content (other than this keep file) won't be touched. \ No newline at end of file diff --git a/noxfile.py b/noxfile.py new file mode 100644 index 0000000..53bca7f --- /dev/null +++ b/noxfile.py @@ -0,0 +1,9 @@ +import nox + + +@nox.session(reuse_venv=True, name="test-pydantic-v1") +def test_pydantic_v1(session: nox.Session) -> None: + session.install("-r", "requirements-dev.lock") + session.install("pydantic<2") + + session.run("pytest", "--showlocals", "--ignore=tests/functional", *session.posargs) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..83d327e --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,269 @@ +[project] +name = "beeper_desktop_api" +version = "5.0.0" +description = "The official Python library for the beeperdesktop API" +dynamic = ["readme"] +license = "MIT" +authors = [ +{ name = "Beeper Desktop", email = "help@beeper.com" }, +] + +dependencies = [ + "httpx>=0.23.0, <1", + "pydantic>=1.9.0, <3", + "typing-extensions>=4.14, <5", + "anyio>=3.5.0, <5", + "distro>=1.7.0, <2", + "sniffio", +] + +requires-python = ">= 3.9" +classifiers = [ + "Typing :: Typed", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", + "Operating System :: OS Independent", + "Operating System :: POSIX", + "Operating System :: MacOS", + "Operating System :: POSIX :: Linux", + "Operating System :: Microsoft :: Windows", + "Topic :: Software Development :: Libraries :: Python Modules", + "License :: OSI Approved :: MIT License" +] + +[project.urls] +Homepage = "https://github.com/beeper/desktop-api-python" +Repository = "https://github.com/beeper/desktop-api-python" + +[project.optional-dependencies] +aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"] + +[tool.rye] +managed = true +# version pins are in requirements-dev.lock +dev-dependencies = [ + "pyright==1.1.399", + "mypy==1.17", + "respx", + "pytest", + "pytest-asyncio", + "ruff", + "time-machine", + "nox", + "dirty-equals>=0.6.0", + "importlib-metadata>=6.7.0", + "rich>=13.7.1", + "pytest-xdist>=3.6.1", +] + +[tool.rye.scripts] +format = { chain = [ + "format:ruff", + "format:docs", + "fix:ruff", + # run formatting again to fix any inconsistencies when imports are stripped + "format:ruff", +]} +"format:docs" = "bash -c 'python scripts/utils/ruffen-docs.py README.md $(find . -type f -name api.md)'" +"format:ruff" = "ruff format" + +"lint" = { chain = [ + "check:ruff", + "typecheck", + "check:importable", +]} +"check:ruff" = "ruff check ." +"fix:ruff" = "ruff check --fix ." + +"check:importable" = "python -c 'import beeper_desktop_api'" + +typecheck = { chain = [ + "typecheck:pyright", + "typecheck:mypy" +]} +"typecheck:pyright" = "pyright" +"typecheck:verify-types" = "pyright --verifytypes beeper_desktop_api --ignoreexternal" +"typecheck:mypy" = "mypy ." + +[build-system] +requires = ["hatchling==1.26.3", "hatch-fancy-pypi-readme"] +build-backend = "hatchling.build" + +[tool.hatch.build] +include = [ + "src/*" +] + +[tool.hatch.build.targets.wheel] +packages = ["src/beeper_desktop_api"] + +[tool.hatch.build.targets.sdist] +# Basically everything except hidden files/directories (such as .github, .devcontainers, .python-version, etc) +include = [ + "/*.toml", + "/*.json", + "/*.lock", + "/*.md", + "/mypy.ini", + "/noxfile.py", + "bin/*", + "examples/*", + "src/*", + "tests/*", +] + +[tool.hatch.metadata.hooks.fancy-pypi-readme] +content-type = "text/markdown" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] +# replace relative links with absolute links +pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)' +replacement = '[\1](https://github.com/beeper/desktop-api-python/tree/main/\g<2>)' + +[tool.pytest.ini_options] +testpaths = ["tests"] +addopts = "--tb=short -n auto" +xfail_strict = true +asyncio_mode = "auto" +asyncio_default_fixture_loop_scope = "session" +filterwarnings = [ + "error" +] + +[tool.pyright] +# this enables practically every flag given by pyright. +# there are a couple of flags that are still disabled by +# default in strict mode as they are experimental and niche. +typeCheckingMode = "strict" +pythonVersion = "3.9" + +exclude = [ + "_dev", + ".venv", + ".nox", + ".git", +] + +reportImplicitOverride = true +reportOverlappingOverload = false + +reportImportCycles = false +reportPrivateUsage = false + +[tool.mypy] +pretty = true +show_error_codes = true + +# Exclude _files.py because mypy isn't smart enough to apply +# the correct type narrowing and as this is an internal module +# it's fine to just use Pyright. +# +# We also exclude our `tests` as mypy doesn't always infer +# types correctly and Pyright will still catch any type errors. +exclude = ["src/beeper_desktop_api/_files.py", "_dev/.*.py", "tests/.*"] + +strict_equality = true +implicit_reexport = true +check_untyped_defs = true +no_implicit_optional = true + +warn_return_any = true +warn_unreachable = true +warn_unused_configs = true + +# Turn these options off as it could cause conflicts +# with the Pyright options. +warn_unused_ignores = false +warn_redundant_casts = false + +disallow_any_generics = true +disallow_untyped_defs = true +disallow_untyped_calls = true +disallow_subclassing_any = true +disallow_incomplete_defs = true +disallow_untyped_decorators = true +cache_fine_grained = true + +# By default, mypy reports an error if you assign a value to the result +# of a function call that doesn't return anything. We do this in our test +# cases: +# ``` +# result = ... +# assert result is None +# ``` +# Changing this codegen to make mypy happy would increase complexity +# and would not be worth it. +disable_error_code = "func-returns-value,overload-cannot-match" + +# https://github.com/python/mypy/issues/12162 +[[tool.mypy.overrides]] +module = "black.files.*" +ignore_errors = true +ignore_missing_imports = true + + +[tool.ruff] +line-length = 120 +output-format = "grouped" +target-version = "py38" + +[tool.ruff.format] +docstring-code-format = true + +[tool.ruff.lint] +select = [ + # isort + "I", + # bugbear rules + "B", + # remove unused imports + "F401", + # check for missing future annotations + "FA102", + # bare except statements + "E722", + # unused arguments + "ARG", + # print statements + "T201", + "T203", + # misuse of typing.TYPE_CHECKING + "TC004", + # import rules + "TID251", +] +ignore = [ + # mutable defaults + "B006", +] +unfixable = [ + # disable auto fix for print statements + "T201", + "T203", +] + +extend-safe-fixes = ["FA102"] + +[tool.ruff.lint.flake8-tidy-imports.banned-api] +"functools.lru_cache".msg = "This function does not retain type information for the wrapped function's arguments; The `lru_cache` function from `_utils` should be used instead" + +[tool.ruff.lint.isort] +length-sort = true +length-sort-straight = true +combine-as-imports = true +extra-standard-library = ["typing_extensions"] +known-first-party = ["beeper_desktop_api", "tests"] + +[tool.ruff.lint.per-file-ignores] +"bin/**.py" = ["T201", "T203"] +"scripts/**.py" = ["T201", "T203"] +"tests/**.py" = ["T201", "T203"] +"examples/**.py" = ["T201", "T203"] diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 0000000..fd672c1 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,66 @@ +{ + "packages": { + ".": {} + }, + "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", + "include-v-in-tag": true, + "include-component-in-tag": false, + "versioning": "prerelease", + "prerelease": true, + "bump-minor-pre-major": true, + "bump-patch-for-minor-pre-major": false, + "pull-request-header": "Automated Release PR", + "pull-request-title-pattern": "release: ${version}", + "changelog-sections": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "perf", + "section": "Performance Improvements" + }, + { + "type": "revert", + "section": "Reverts" + }, + { + "type": "chore", + "section": "Chores" + }, + { + "type": "docs", + "section": "Documentation" + }, + { + "type": "style", + "section": "Styles" + }, + { + "type": "refactor", + "section": "Refactors" + }, + { + "type": "test", + "section": "Tests", + "hidden": true + }, + { + "type": "build", + "section": "Build System" + }, + { + "type": "ci", + "section": "Continuous Integration", + "hidden": true + } + ], + "release-type": "python", + "extra-files": [ + "src/beeper_desktop_api/_version.py" + ] +} \ No newline at end of file diff --git a/requirements-dev.lock b/requirements-dev.lock new file mode 100644 index 0000000..2fdb945 --- /dev/null +++ b/requirements-dev.lock @@ -0,0 +1,149 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: true +# with-sources: false +# generate-hashes: false +# universal: false + +-e file:. +aiohappyeyeballs==2.6.1 + # via aiohttp +aiohttp==3.13.3 + # via beeper-desktop-api + # via httpx-aiohttp +aiosignal==1.4.0 + # via aiohttp +annotated-types==0.7.0 + # via pydantic +anyio==4.12.1 + # via beeper-desktop-api + # via httpx +argcomplete==3.6.3 + # via nox +async-timeout==5.0.1 + # via aiohttp +attrs==25.4.0 + # via aiohttp + # via nox +backports-asyncio-runner==1.2.0 + # via pytest-asyncio +certifi==2026.1.4 + # via httpcore + # via httpx +colorlog==6.10.1 + # via nox +dependency-groups==1.3.1 + # via nox +dirty-equals==0.11 +distlib==0.4.0 + # via virtualenv +distro==1.9.0 + # via beeper-desktop-api +exceptiongroup==1.3.1 + # via anyio + # via pytest +execnet==2.1.2 + # via pytest-xdist +filelock==3.19.1 + # via virtualenv +frozenlist==1.8.0 + # via aiohttp + # via aiosignal +h11==0.16.0 + # via httpcore +httpcore==1.0.9 + # via httpx +httpx==0.28.1 + # via beeper-desktop-api + # via httpx-aiohttp + # via respx +httpx-aiohttp==0.1.12 + # via beeper-desktop-api +humanize==4.13.0 + # via nox +idna==3.11 + # via anyio + # via httpx + # via yarl +importlib-metadata==8.7.1 +iniconfig==2.1.0 + # via pytest +markdown-it-py==3.0.0 + # via rich +mdurl==0.1.2 + # via markdown-it-py +multidict==6.7.0 + # via aiohttp + # via yarl +mypy==1.17.0 +mypy-extensions==1.1.0 + # via mypy +nodeenv==1.10.0 + # via pyright +nox==2025.11.12 +packaging==25.0 + # via dependency-groups + # via nox + # via pytest +pathspec==1.0.3 + # via mypy +platformdirs==4.4.0 + # via virtualenv +pluggy==1.6.0 + # via pytest +propcache==0.4.1 + # via aiohttp + # via yarl +pydantic==2.12.5 + # via beeper-desktop-api +pydantic-core==2.41.5 + # via pydantic +pygments==2.19.2 + # via pytest + # via rich +pyright==1.1.399 +pytest==8.4.2 + # via pytest-asyncio + # via pytest-xdist +pytest-asyncio==1.2.0 +pytest-xdist==3.8.0 +python-dateutil==2.9.0.post0 + # via time-machine +respx==0.22.0 +rich==14.2.0 +ruff==0.14.13 +six==1.17.0 + # via python-dateutil +sniffio==1.3.1 + # via beeper-desktop-api +time-machine==2.19.0 +tomli==2.4.0 + # via dependency-groups + # via mypy + # via nox + # via pytest +typing-extensions==4.15.0 + # via aiosignal + # via anyio + # via beeper-desktop-api + # via exceptiongroup + # via multidict + # via mypy + # via pydantic + # via pydantic-core + # via pyright + # via pytest-asyncio + # via typing-inspection + # via virtualenv +typing-inspection==0.4.2 + # via pydantic +virtualenv==20.36.1 + # via nox +yarl==1.22.0 + # via aiohttp +zipp==3.23.0 + # via importlib-metadata diff --git a/requirements.lock b/requirements.lock new file mode 100644 index 0000000..eda3b77 --- /dev/null +++ b/requirements.lock @@ -0,0 +1,76 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: true +# with-sources: false +# generate-hashes: false +# universal: false + +-e file:. +aiohappyeyeballs==2.6.1 + # via aiohttp +aiohttp==3.13.3 + # via beeper-desktop-api + # via httpx-aiohttp +aiosignal==1.4.0 + # via aiohttp +annotated-types==0.7.0 + # via pydantic +anyio==4.12.1 + # via beeper-desktop-api + # via httpx +async-timeout==5.0.1 + # via aiohttp +attrs==25.4.0 + # via aiohttp +certifi==2026.1.4 + # via httpcore + # via httpx +distro==1.9.0 + # via beeper-desktop-api +exceptiongroup==1.3.1 + # via anyio +frozenlist==1.8.0 + # via aiohttp + # via aiosignal +h11==0.16.0 + # via httpcore +httpcore==1.0.9 + # via httpx +httpx==0.28.1 + # via beeper-desktop-api + # via httpx-aiohttp +httpx-aiohttp==0.1.12 + # via beeper-desktop-api +idna==3.11 + # via anyio + # via httpx + # via yarl +multidict==6.7.0 + # via aiohttp + # via yarl +propcache==0.4.1 + # via aiohttp + # via yarl +pydantic==2.12.5 + # via beeper-desktop-api +pydantic-core==2.41.5 + # via pydantic +sniffio==1.3.1 + # via beeper-desktop-api +typing-extensions==4.15.0 + # via aiosignal + # via anyio + # via beeper-desktop-api + # via exceptiongroup + # via multidict + # via pydantic + # via pydantic-core + # via typing-inspection +typing-inspection==0.4.2 + # via pydantic +yarl==1.22.0 + # via aiohttp diff --git a/scripts/bootstrap b/scripts/bootstrap new file mode 100755 index 0000000..fe8451e --- /dev/null +++ b/scripts/bootstrap @@ -0,0 +1,27 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "${SKIP_BREW:-}" != "1" ] && [ -t 0 ]; then + brew bundle check >/dev/null 2>&1 || { + echo -n "==> Install Homebrew dependencies? (y/N): " + read -r response + case "$response" in + [yY][eE][sS]|[yY]) + brew bundle + ;; + *) + ;; + esac + echo + } +fi + +echo "==> Installing Python dependencies…" + +# experimental uv support makes installations significantly faster +rye config --set-bool behavior.use-uv=true + +rye sync --all-features diff --git a/scripts/format b/scripts/format new file mode 100755 index 0000000..667ec2d --- /dev/null +++ b/scripts/format @@ -0,0 +1,8 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +echo "==> Running formatters" +rye run format diff --git a/scripts/lint b/scripts/lint new file mode 100755 index 0000000..ca0f8cf --- /dev/null +++ b/scripts/lint @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +if [ "$1" = "--fix" ]; then + echo "==> Running lints with --fix" + rye run fix:ruff +else + echo "==> Running lints" + rye run lint +fi + +echo "==> Making sure it imports" +rye run python -c 'import beeper_desktop_api' diff --git a/scripts/mock b/scripts/mock new file mode 100755 index 0000000..9c7c439 --- /dev/null +++ b/scripts/mock @@ -0,0 +1,52 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +if [[ -n "$1" && "$1" != '--'* ]]; then + URL="$1" + shift +else + URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)" +fi + +# Check if the URL is empty +if [ -z "$URL" ]; then + echo "Error: No OpenAPI spec path/url provided or found in .stats.yml" + exit 1 +fi + +echo "==> Starting mock server with URL ${URL}" + +# Run steady 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=@stdy/cli@0.22.1 -- steady --version + + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=repeat --validator-form-array-format=repeat --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & + + # Wait for server to come online via health endpoint (max 30s) + echo -n "Waiting for server" + attempts=0 + while ! curl --silent --fail "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1; do + if ! kill -0 $! 2>/dev/null; then + echo + cat .stdy.log + exit 1 + fi + attempts=$((attempts + 1)) + if [ "$attempts" -ge 300 ]; then + echo + echo "Timed out waiting for Steady server to start" + cat .stdy.log + exit 1 + fi + echo -n "." + sleep 0.1 + done + + echo +else + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=repeat --validator-form-array-format=repeat --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" +fi diff --git a/scripts/test b/scripts/test new file mode 100755 index 0000000..0159035 --- /dev/null +++ b/scripts/test @@ -0,0 +1,61 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[0;33m' +NC='\033[0m' # No Color + +function steady_is_running() { + curl --silent "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1 +} + +kill_server_on_port() { + pids=$(lsof -t -i tcp:"$1" || echo "") + if [ "$pids" != "" ]; then + kill "$pids" + echo "Stopped $pids." + fi +} + +function is_overriding_api_base_url() { + [ -n "$TEST_API_BASE_URL" ] +} + +if ! is_overriding_api_base_url && ! steady_is_running ; then + # When we exit this script, make sure to kill the background mock server process + trap 'kill_server_on_port 4010' EXIT + + # Start the dev server + ./scripts/mock --daemon +fi + +if is_overriding_api_base_url ; then + echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}" + echo +elif ! steady_is_running ; then + echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Steady server" + echo -e "running against your OpenAPI spec." + echo + echo -e "To run the server, pass in the path or url of your OpenAPI" + echo -e "spec to the steady command:" + echo + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.22.1 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=repeat --validator-form-array-format=repeat --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" + echo + + exit 1 +else + echo -e "${GREEN}✔ Mock steady server is running with your OpenAPI spec${NC}" + echo +fi + +export DEFER_PYDANTIC_BUILD=false + +echo "==> Running tests" +rye run pytest "$@" + +echo "==> Running Pydantic v1 tests" +rye run nox -s test-pydantic-v1 -- "$@" diff --git a/scripts/utils/ruffen-docs.py b/scripts/utils/ruffen-docs.py new file mode 100644 index 0000000..0cf2bd2 --- /dev/null +++ b/scripts/utils/ruffen-docs.py @@ -0,0 +1,167 @@ +# fork of https://github.com/asottile/blacken-docs adapted for ruff +from __future__ import annotations + +import re +import sys +import argparse +import textwrap +import contextlib +import subprocess +from typing import Match, Optional, Sequence, Generator, NamedTuple, cast + +MD_RE = re.compile( + r"(?P^(?P *)```\s*python\n)" r"(?P.*?)" r"(?P^(?P=indent)```\s*$)", + re.DOTALL | re.MULTILINE, +) +MD_PYCON_RE = re.compile( + r"(?P^(?P *)```\s*pycon\n)" r"(?P.*?)" r"(?P^(?P=indent)```.*$)", + re.DOTALL | re.MULTILINE, +) +PYCON_PREFIX = ">>> " +PYCON_CONTINUATION_PREFIX = "..." +PYCON_CONTINUATION_RE = re.compile( + rf"^{re.escape(PYCON_CONTINUATION_PREFIX)}( |$)", +) +DEFAULT_LINE_LENGTH = 100 + + +class CodeBlockError(NamedTuple): + offset: int + exc: Exception + + +def format_str( + src: str, +) -> tuple[str, Sequence[CodeBlockError]]: + errors: list[CodeBlockError] = [] + + @contextlib.contextmanager + def _collect_error(match: Match[str]) -> Generator[None, None, None]: + try: + yield + except Exception as e: + errors.append(CodeBlockError(match.start(), e)) + + def _md_match(match: Match[str]) -> str: + code = textwrap.dedent(match["code"]) + with _collect_error(match): + code = format_code_block(code) + code = textwrap.indent(code, match["indent"]) + return f"{match['before']}{code}{match['after']}" + + def _pycon_match(match: Match[str]) -> str: + code = "" + fragment = cast(Optional[str], None) + + def finish_fragment() -> None: + nonlocal code + nonlocal fragment + + if fragment is not None: + with _collect_error(match): + fragment = format_code_block(fragment) + fragment_lines = fragment.splitlines() + code += f"{PYCON_PREFIX}{fragment_lines[0]}\n" + for line in fragment_lines[1:]: + # Skip blank lines to handle Black adding a blank above + # functions within blocks. A blank line would end the REPL + # continuation prompt. + # + # >>> if True: + # ... def f(): + # ... pass + # ... + if line: + code += f"{PYCON_CONTINUATION_PREFIX} {line}\n" + if fragment_lines[-1].startswith(" "): + code += f"{PYCON_CONTINUATION_PREFIX}\n" + fragment = None + + indentation = None + for line in match["code"].splitlines(): + orig_line, line = line, line.lstrip() + if indentation is None and line: + indentation = len(orig_line) - len(line) + continuation_match = PYCON_CONTINUATION_RE.match(line) + if continuation_match and fragment is not None: + fragment += line[continuation_match.end() :] + "\n" + else: + finish_fragment() + if line.startswith(PYCON_PREFIX): + fragment = line[len(PYCON_PREFIX) :] + "\n" + else: + code += orig_line[indentation:] + "\n" + finish_fragment() + return code + + def _md_pycon_match(match: Match[str]) -> str: + code = _pycon_match(match) + code = textwrap.indent(code, match["indent"]) + return f"{match['before']}{code}{match['after']}" + + src = MD_RE.sub(_md_match, src) + src = MD_PYCON_RE.sub(_md_pycon_match, src) + return src, errors + + +def format_code_block(code: str) -> str: + return subprocess.check_output( + [ + sys.executable, + "-m", + "ruff", + "format", + "--stdin-filename=script.py", + f"--line-length={DEFAULT_LINE_LENGTH}", + ], + encoding="utf-8", + input=code, + ) + + +def format_file( + filename: str, + skip_errors: bool, +) -> int: + with open(filename, encoding="UTF-8") as f: + contents = f.read() + new_contents, errors = format_str(contents) + for error in errors: + lineno = contents[: error.offset].count("\n") + 1 + print(f"{filename}:{lineno}: code block parse error {error.exc}") + if errors and not skip_errors: + return 1 + if contents != new_contents: + print(f"{filename}: Rewriting...") + with open(filename, "w", encoding="UTF-8") as f: + f.write(new_contents) + return 0 + else: + return 0 + + +def main(argv: Sequence[str] | None = None) -> int: + parser = argparse.ArgumentParser() + parser.add_argument( + "-l", + "--line-length", + type=int, + default=DEFAULT_LINE_LENGTH, + ) + parser.add_argument( + "-S", + "--skip-string-normalization", + action="store_true", + ) + parser.add_argument("-E", "--skip-errors", action="store_true") + parser.add_argument("filenames", nargs="*") + args = parser.parse_args(argv) + + retv = 0 + for filename in args.filenames: + retv |= format_file(filename, skip_errors=args.skip_errors) + return retv + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/scripts/utils/upload-artifact.sh b/scripts/utils/upload-artifact.sh new file mode 100755 index 0000000..439b398 --- /dev/null +++ b/scripts/utils/upload-artifact.sh @@ -0,0 +1,27 @@ +#!/usr/bin/env bash +set -exuo pipefail + +FILENAME=$(basename dist/*.whl) + +RESPONSE=$(curl -X POST "$URL?filename=$FILENAME" \ + -H "Authorization: Bearer $AUTH" \ + -H "Content-Type: application/json") + +SIGNED_URL=$(echo "$RESPONSE" | jq -r '.url') + +if [[ "$SIGNED_URL" == "null" ]]; then + echo -e "\033[31mFailed to get signed URL.\033[0m" + exit 1 +fi + +UPLOAD_RESPONSE=$(curl -v -X PUT \ + -H "Content-Type: binary/octet-stream" \ + --data-binary "@dist/$FILENAME" "$SIGNED_URL" 2>&1) + +if echo "$UPLOAD_RESPONSE" | grep -q "HTTP/[0-9.]* 200"; then + echo -e "\033[32mUploaded build to Stainless storage.\033[0m" + echo -e "\033[32mInstallation: pip install 'https://pkg.stainless.com/s/beeper-desktop-api-python/$SHA/$FILENAME'\033[0m" +else + echo -e "\033[31mFailed to upload artifact.\033[0m" + exit 1 +fi diff --git a/src/beeper_desktop_api/__init__.py b/src/beeper_desktop_api/__init__.py new file mode 100644 index 0000000..bd9b7d9 --- /dev/null +++ b/src/beeper_desktop_api/__init__.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import typing as _t + +from . import types +from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes, omit, not_given +from ._utils import file_from_path +from ._client import ( + Client, + Stream, + Timeout, + Transport, + AsyncClient, + AsyncStream, + BeeperDesktop, + RequestOptions, + AsyncBeeperDesktop, +) +from ._models import BaseModel +from ._version import __title__, __version__ +from ._response import APIResponse as APIResponse, AsyncAPIResponse as AsyncAPIResponse +from ._constants import DEFAULT_TIMEOUT, DEFAULT_MAX_RETRIES, DEFAULT_CONNECTION_LIMITS +from ._exceptions import ( + APIError, + ConflictError, + NotFoundError, + APIStatusError, + RateLimitError, + APITimeoutError, + BadRequestError, + APIConnectionError, + BeeperDesktopError, + AuthenticationError, + InternalServerError, + PermissionDeniedError, + UnprocessableEntityError, + APIResponseValidationError, +) +from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient +from ._utils._logs import setup_logging as _setup_logging + +__all__ = [ + "types", + "__version__", + "__title__", + "NoneType", + "Transport", + "ProxiesTypes", + "NotGiven", + "NOT_GIVEN", + "not_given", + "Omit", + "omit", + "BeeperDesktopError", + "APIError", + "APIStatusError", + "APITimeoutError", + "APIConnectionError", + "APIResponseValidationError", + "BadRequestError", + "AuthenticationError", + "PermissionDeniedError", + "NotFoundError", + "ConflictError", + "UnprocessableEntityError", + "RateLimitError", + "InternalServerError", + "Timeout", + "RequestOptions", + "Client", + "AsyncClient", + "Stream", + "AsyncStream", + "BeeperDesktop", + "AsyncBeeperDesktop", + "file_from_path", + "BaseModel", + "DEFAULT_TIMEOUT", + "DEFAULT_MAX_RETRIES", + "DEFAULT_CONNECTION_LIMITS", + "DefaultHttpxClient", + "DefaultAsyncHttpxClient", + "DefaultAioHttpClient", +] + +if not _t.TYPE_CHECKING: + from ._utils._resources_proxy import resources as resources + +_setup_logging() + +# Update the __module__ attribute for exported symbols so that +# error messages point to this module instead of the module +# it was originally defined in, e.g. +# beeper_desktop_api._exceptions.NotFoundError -> beeper_desktop_api.NotFoundError +__locals = locals() +for __name in __all__: + if not __name.startswith("__"): + try: + __locals[__name].__module__ = "beeper_desktop_api" + except (TypeError, AttributeError): + # Some of our exported symbols are builtins which we can't set attributes for. + pass diff --git a/src/beeper_desktop_api/_base_client.py b/src/beeper_desktop_api/_base_client.py new file mode 100644 index 0000000..5bce507 --- /dev/null +++ b/src/beeper_desktop_api/_base_client.py @@ -0,0 +1,2153 @@ +from __future__ import annotations + +import sys +import json +import time +import uuid +import email +import asyncio +import inspect +import logging +import platform +import warnings +import email.utils +from types import TracebackType +from random import random +from typing import ( + TYPE_CHECKING, + Any, + Dict, + Type, + Union, + Generic, + Mapping, + TypeVar, + Iterable, + Iterator, + Optional, + Generator, + AsyncIterator, + cast, + overload, +) +from typing_extensions import Literal, override, get_origin + +import anyio +import httpx +import distro +import pydantic +from httpx import URL +from pydantic import PrivateAttr + +from . import _exceptions +from ._qs import Querystring +from ._files import to_httpx_files, async_to_httpx_files +from ._types import ( + Body, + Omit, + Query, + Headers, + Timeout, + NotGiven, + ResponseT, + AnyMapping, + PostParser, + BinaryTypes, + RequestFiles, + HttpxSendArgs, + RequestOptions, + AsyncBinaryTypes, + HttpxRequestFiles, + ModelBuilderProtocol, + not_given, +) +from ._utils import is_dict, is_list, asyncify, is_given, lru_cache, is_mapping +from ._compat import PYDANTIC_V1, model_copy, model_dump +from ._models import GenericModel, SecurityOptions, FinalRequestOptions, validate_type, construct_type +from ._response import ( + APIResponse, + BaseAPIResponse, + AsyncAPIResponse, + extract_response_type, +) +from ._constants import ( + DEFAULT_TIMEOUT, + MAX_RETRY_DELAY, + DEFAULT_MAX_RETRIES, + INITIAL_RETRY_DELAY, + RAW_RESPONSE_HEADER, + OVERRIDE_CAST_TO_HEADER, + DEFAULT_CONNECTION_LIMITS, +) +from ._streaming import Stream, SSEDecoder, AsyncStream, SSEBytesDecoder +from ._exceptions import ( + APIStatusError, + APITimeoutError, + APIConnectionError, + APIResponseValidationError, +) +from ._utils._json import openapi_dumps + +log: logging.Logger = logging.getLogger(__name__) + +# TODO: make base page type vars covariant +SyncPageT = TypeVar("SyncPageT", bound="BaseSyncPage[Any]") +AsyncPageT = TypeVar("AsyncPageT", bound="BaseAsyncPage[Any]") + + +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) + +_StreamT = TypeVar("_StreamT", bound=Stream[Any]) +_AsyncStreamT = TypeVar("_AsyncStreamT", bound=AsyncStream[Any]) + +if TYPE_CHECKING: + from httpx._config import ( + DEFAULT_TIMEOUT_CONFIG, # pyright: ignore[reportPrivateImportUsage] + ) + + HTTPX_DEFAULT_TIMEOUT = DEFAULT_TIMEOUT_CONFIG +else: + try: + from httpx._config import DEFAULT_TIMEOUT_CONFIG as HTTPX_DEFAULT_TIMEOUT + except ImportError: + # taken from https://github.com/encode/httpx/blob/3ba5fe0d7ac70222590e759c31442b1cab263791/httpx/_config.py#L366 + HTTPX_DEFAULT_TIMEOUT = Timeout(5.0) + + +class PageInfo: + """Stores the necessary information to build the request to retrieve the next page. + + Either `url` or `params` must be set. + """ + + url: URL | NotGiven + params: Query | NotGiven + json: Body | NotGiven + + @overload + def __init__( + self, + *, + url: URL, + ) -> None: ... + + @overload + def __init__( + self, + *, + params: Query, + ) -> None: ... + + @overload + def __init__( + self, + *, + json: Body, + ) -> None: ... + + def __init__( + self, + *, + url: URL | NotGiven = not_given, + json: Body | NotGiven = not_given, + params: Query | NotGiven = not_given, + ) -> None: + self.url = url + self.json = json + self.params = params + + @override + def __repr__(self) -> str: + if self.url: + return f"{self.__class__.__name__}(url={self.url})" + if self.json: + return f"{self.__class__.__name__}(json={self.json})" + return f"{self.__class__.__name__}(params={self.params})" + + +class BasePage(GenericModel, Generic[_T]): + """ + Defines the core interface for pagination. + + Type Args: + ModelT: The pydantic model that represents an item in the response. + + Methods: + has_next_page(): Check if there is another page available + next_page_info(): Get the necessary information to make a request for the next page + """ + + _options: FinalRequestOptions = PrivateAttr() + _model: Type[_T] = PrivateAttr() + + def has_next_page(self) -> bool: + items = self._get_page_items() + if not items: + return False + return self.next_page_info() is not None + + def next_page_info(self) -> Optional[PageInfo]: ... + + def _get_page_items(self) -> Iterable[_T]: # type: ignore[empty-body] + ... + + def _params_from_url(self, url: URL) -> httpx.QueryParams: + # TODO: do we have to preprocess params here? + return httpx.QueryParams(cast(Any, self._options.params)).merge(url.params) + + def _info_to_options(self, info: PageInfo) -> FinalRequestOptions: + options = model_copy(self._options) + options._strip_raw_response_header() + + if not isinstance(info.params, NotGiven): + options.params = {**options.params, **info.params} + return options + + if not isinstance(info.url, NotGiven): + params = self._params_from_url(info.url) + url = info.url.copy_with(params=params) + options.params = dict(url.params) + options.url = str(url) + return options + + if not isinstance(info.json, NotGiven): + if not is_mapping(info.json): + raise TypeError("Pagination is only supported with mappings") + + if not options.json_data: + options.json_data = {**info.json} + else: + if not is_mapping(options.json_data): + raise TypeError("Pagination is only supported with mappings") + + options.json_data = {**options.json_data, **info.json} + return options + + raise ValueError("Unexpected PageInfo state") + + +class BaseSyncPage(BasePage[_T], Generic[_T]): + _client: SyncAPIClient = pydantic.PrivateAttr() + + def _set_private_attributes( + self, + client: SyncAPIClient, + model: Type[_T], + options: FinalRequestOptions, + ) -> None: + if (not PYDANTIC_V1) and getattr(self, "__pydantic_private__", None) is None: + self.__pydantic_private__ = {} + + self._model = model + self._client = client + self._options = options + + # Pydantic uses a custom `__iter__` method to support casting BaseModels + # to dictionaries. e.g. dict(model). + # As we want to support `for item in page`, this is inherently incompatible + # with the default pydantic behaviour. It is not possible to support both + # use cases at once. Fortunately, this is not a big deal as all other pydantic + # methods should continue to work as expected as there is an alternative method + # to cast a model to a dictionary, model.dict(), which is used internally + # by pydantic. + def __iter__(self) -> Iterator[_T]: # type: ignore + for page in self.iter_pages(): + for item in page._get_page_items(): + yield item + + def iter_pages(self: SyncPageT) -> Iterator[SyncPageT]: + page = self + while True: + yield page + if page.has_next_page(): + page = page.get_next_page() + else: + return + + def get_next_page(self: SyncPageT) -> SyncPageT: + info = self.next_page_info() + if not info: + raise RuntimeError( + "No next page expected; please check `.has_next_page()` before calling `.get_next_page()`." + ) + + options = self._info_to_options(info) + return self._client._request_api_list(self._model, page=self.__class__, options=options) + + +class AsyncPaginator(Generic[_T, AsyncPageT]): + def __init__( + self, + client: AsyncAPIClient, + options: FinalRequestOptions, + page_cls: Type[AsyncPageT], + model: Type[_T], + ) -> None: + self._model = model + self._client = client + self._options = options + self._page_cls = page_cls + + def __await__(self) -> Generator[Any, None, AsyncPageT]: + return self._get_page().__await__() + + async def _get_page(self) -> AsyncPageT: + def _parser(resp: AsyncPageT) -> AsyncPageT: + resp._set_private_attributes( + model=self._model, + options=self._options, + client=self._client, + ) + return resp + + self._options.post_parser = _parser + + return await self._client.request(self._page_cls, self._options) + + async def __aiter__(self) -> AsyncIterator[_T]: + # https://github.com/microsoft/pyright/issues/3464 + page = cast( + AsyncPageT, + await self, # type: ignore + ) + async for item in page: + yield item + + +class BaseAsyncPage(BasePage[_T], Generic[_T]): + _client: AsyncAPIClient = pydantic.PrivateAttr() + + def _set_private_attributes( + self, + model: Type[_T], + client: AsyncAPIClient, + options: FinalRequestOptions, + ) -> None: + if (not PYDANTIC_V1) and getattr(self, "__pydantic_private__", None) is None: + self.__pydantic_private__ = {} + + self._model = model + self._client = client + self._options = options + + async def __aiter__(self) -> AsyncIterator[_T]: + async for page in self.iter_pages(): + for item in page._get_page_items(): + yield item + + async def iter_pages(self: AsyncPageT) -> AsyncIterator[AsyncPageT]: + page = self + while True: + yield page + if page.has_next_page(): + page = await page.get_next_page() + else: + return + + async def get_next_page(self: AsyncPageT) -> AsyncPageT: + info = self.next_page_info() + if not info: + raise RuntimeError( + "No next page expected; please check `.has_next_page()` before calling `.get_next_page()`." + ) + + options = self._info_to_options(info) + return await self._client._request_api_list(self._model, page=self.__class__, options=options) + + +_HttpxClientT = TypeVar("_HttpxClientT", bound=Union[httpx.Client, httpx.AsyncClient]) +_DefaultStreamT = TypeVar("_DefaultStreamT", bound=Union[Stream[Any], AsyncStream[Any]]) + + +class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]): + _client: _HttpxClientT + _version: str + _base_url: URL + max_retries: int + timeout: Union[float, Timeout, None] + _strict_response_validation: bool + _idempotency_header: str | None + _default_stream_cls: type[_DefaultStreamT] | None = None + + def __init__( + self, + *, + version: str, + base_url: str | URL, + _strict_response_validation: bool, + max_retries: int = DEFAULT_MAX_RETRIES, + timeout: float | Timeout | None = DEFAULT_TIMEOUT, + custom_headers: Mapping[str, str] | None = None, + custom_query: Mapping[str, object] | None = None, + ) -> None: + self._version = version + self._base_url = self._enforce_trailing_slash(URL(base_url)) + self.max_retries = max_retries + self.timeout = timeout + self._custom_headers = custom_headers or {} + self._custom_query = custom_query or {} + self._strict_response_validation = _strict_response_validation + self._idempotency_header = None + self._platform: Platform | None = None + + if max_retries is None: # pyright: ignore[reportUnnecessaryComparison] + raise TypeError( + "max_retries cannot be None. If you want to disable retries, pass `0`; if you want unlimited retries, pass `math.inf` or a very high number; if you want the default behavior, pass `beeper_desktop_api.DEFAULT_MAX_RETRIES`" + ) + + def _enforce_trailing_slash(self, url: URL) -> URL: + if url.raw_path.endswith(b"/"): + return url + return url.copy_with(raw_path=url.raw_path + b"/") + + def _make_status_error_from_response( + self, + response: httpx.Response, + ) -> APIStatusError: + if response.is_closed and not response.is_stream_consumed: + # We can't read the response body as it has been closed + # before it was read. This can happen if an event hook + # raises a status error. + body = None + err_msg = f"Error code: {response.status_code}" + else: + err_text = response.text.strip() + body = err_text + + try: + body = json.loads(err_text) + err_msg = f"Error code: {response.status_code} - {body}" + except Exception: + err_msg = err_text or f"Error code: {response.status_code}" + + return self._make_status_error(err_msg, body=body, response=response) + + def _make_status_error( + self, + err_msg: str, + *, + body: object, + response: httpx.Response, + ) -> _exceptions.APIStatusError: + raise NotImplementedError() + + def _auth_headers( + self, + security: SecurityOptions, # noqa: ARG002 + ) -> dict[str, str]: + return {} + + def _auth_query( + self, + security: SecurityOptions, # noqa: ARG002 + ) -> dict[str, str]: + return {} + + def _custom_auth( + self, + security: SecurityOptions, # noqa: ARG002 + ) -> httpx.Auth | None: + return None + + def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0) -> httpx.Headers: + custom_headers = options.headers or {} + headers_dict = _merge_mappings({**self._auth_headers(options.security), **self.default_headers}, custom_headers) + self._validate_headers(headers_dict, custom_headers) + + # headers are case-insensitive while dictionaries are not. + headers = httpx.Headers(headers_dict) + + idempotency_header = self._idempotency_header + if idempotency_header and options.idempotency_key and idempotency_header not in headers: + headers[idempotency_header] = options.idempotency_key + + # Don't set these headers if they were already set or removed by the caller. We check + # `custom_headers`, which can contain `Omit()`, instead of `headers` to account for the removal case. + lower_custom_headers = [header.lower() for header in custom_headers] + if "x-stainless-retry-count" not in lower_custom_headers: + headers["x-stainless-retry-count"] = str(retries_taken) + if "x-stainless-read-timeout" not in lower_custom_headers: + timeout = self.timeout if isinstance(options.timeout, NotGiven) else options.timeout + if isinstance(timeout, Timeout): + timeout = timeout.read + if timeout is not None: + headers["x-stainless-read-timeout"] = str(timeout) + + return headers + + def _prepare_url(self, url: str) -> URL: + """ + Merge a URL argument together with any 'base_url' on the client, + to create the URL used for the outgoing request. + """ + # Copied from httpx's `_merge_url` method. + merge_url = URL(url) + if merge_url.is_relative_url: + merge_raw_path = self.base_url.raw_path + merge_url.raw_path.lstrip(b"/") + return self.base_url.copy_with(raw_path=merge_raw_path) + + return merge_url + + def _make_sse_decoder(self) -> SSEDecoder | SSEBytesDecoder: + return SSEDecoder() + + def _build_request( + self, + options: FinalRequestOptions, + *, + retries_taken: int = 0, + ) -> httpx.Request: + if log.isEnabledFor(logging.DEBUG): + log.debug( + "Request options: %s", + model_dump( + options, + exclude_unset=True, + # Pydantic v1 can't dump every type we support in content, so we exclude it for now. + exclude={ + "content", + } + if PYDANTIC_V1 + else {}, + ), + ) + kwargs: dict[str, Any] = {} + + json_data = options.json_data + if options.extra_json is not None: + if json_data is None: + json_data = cast(Body, options.extra_json) + elif is_mapping(json_data): + json_data = _merge_mappings(json_data, options.extra_json) + else: + raise RuntimeError(f"Unexpected JSON data type, {type(json_data)}, cannot merge with `extra_body`") + + headers = self._build_headers(options, retries_taken=retries_taken) + params = _merge_mappings({**self._auth_query(options.security), **self.default_query}, options.params) + content_type = headers.get("Content-Type") + files = options.files + + # If the given Content-Type header is multipart/form-data then it + # has to be removed so that httpx can generate the header with + # additional information for us as it has to be in this form + # for the server to be able to correctly parse the request: + # multipart/form-data; boundary=---abc-- + if content_type is not None and content_type.startswith("multipart/form-data"): + if "boundary" not in content_type: + # only remove the header if the boundary hasn't been explicitly set + # as the caller doesn't want httpx to come up with their own boundary + headers.pop("Content-Type") + + # As we are now sending multipart/form-data instead of application/json + # we need to tell httpx to use it, https://www.python-httpx.org/advanced/clients/#multipart-file-encoding + if json_data: + if not is_dict(json_data): + raise TypeError( + f"Expected query input to be a dictionary for multipart requests but got {type(json_data)} instead." + ) + kwargs["data"] = self._serialize_multipartform(json_data) + + # httpx determines whether or not to send a "multipart/form-data" + # request based on the truthiness of the "files" argument. + # This gets around that issue by generating a dict value that + # evaluates to true. + # + # https://github.com/encode/httpx/discussions/2399#discussioncomment-3814186 + if not files: + files = cast(HttpxRequestFiles, ForceMultipartDict()) + + prepared_url = self._prepare_url(options.url) + # preserve hard-coded query params from the url + if params and prepared_url.query: + params = {**dict(prepared_url.params.items()), **params} + prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0]) + if "_" in prepared_url.host: + # work around https://github.com/encode/httpx/discussions/2880 + kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")} + + is_body_allowed = options.method.lower() != "get" + + if is_body_allowed: + if options.content is not None and json_data is not None: + raise TypeError("Passing both `content` and `json_data` is not supported") + if options.content is not None and files is not None: + raise TypeError("Passing both `content` and `files` is not supported") + if options.content is not None: + kwargs["content"] = options.content + elif isinstance(json_data, bytes): + kwargs["content"] = json_data + elif not files: + # Don't set content when JSON is sent as multipart/form-data, + # since httpx's content param overrides other body arguments + kwargs["content"] = openapi_dumps(json_data) if is_given(json_data) and json_data is not None else None + kwargs["files"] = files + else: + headers.pop("Content-Type", None) + kwargs.pop("data", None) + + # TODO: report this error to httpx + return self._client.build_request( # pyright: ignore[reportUnknownMemberType] + headers=headers, + timeout=self.timeout if isinstance(options.timeout, NotGiven) else options.timeout, + method=options.method, + url=prepared_url, + # the `Query` type that we use is incompatible with qs' + # `Params` type as it needs to be typed as `Mapping[str, object]` + # so that passing a `TypedDict` doesn't cause an error. + # https://github.com/microsoft/pyright/issues/3526#event-6715453066 + params=self.qs.stringify(cast(Mapping[str, Any], params)) if params else None, + **kwargs, + ) + + def _serialize_multipartform(self, data: Mapping[object, object]) -> dict[str, object]: + items = self.qs.stringify_items( + # TODO: type ignore is required as stringify_items is well typed but we can't be + # well typed without heavy validation. + data, # type: ignore + array_format="brackets", + ) + serialized: dict[str, object] = {} + for key, value in items: + existing = serialized.get(key) + + if not existing: + serialized[key] = value + continue + + # If a value has already been set for this key then that + # means we're sending data like `array[]=[1, 2, 3]` and we + # need to tell httpx that we want to send multiple values with + # the same key which is done by using a list or a tuple. + # + # Note: 2d arrays should never result in the same key at both + # levels so it's safe to assume that if the value is a list, + # it was because we changed it to be a list. + if is_list(existing): + existing.append(value) + else: + serialized[key] = [existing, value] + + return serialized + + def _maybe_override_cast_to(self, cast_to: type[ResponseT], options: FinalRequestOptions) -> type[ResponseT]: + if not is_given(options.headers): + return cast_to + + # make a copy of the headers so we don't mutate user-input + headers = dict(options.headers) + + # we internally support defining a temporary header to override the + # default `cast_to` type for use with `.with_raw_response` and `.with_streaming_response` + # see _response.py for implementation details + override_cast_to = headers.pop(OVERRIDE_CAST_TO_HEADER, not_given) + if is_given(override_cast_to): + options.headers = headers + return cast(Type[ResponseT], override_cast_to) + + return cast_to + + def _should_stream_response_body(self, request: httpx.Request) -> bool: + return request.headers.get(RAW_RESPONSE_HEADER) == "stream" # type: ignore[no-any-return] + + def _process_response_data( + self, + *, + data: object, + cast_to: type[ResponseT], + response: httpx.Response, + ) -> ResponseT: + if data is None: + return cast(ResponseT, None) + + if cast_to is object: + return cast(ResponseT, data) + + try: + if inspect.isclass(cast_to) and issubclass(cast_to, ModelBuilderProtocol): + return cast(ResponseT, cast_to.build(response=response, data=data)) + + if self._strict_response_validation: + return cast(ResponseT, validate_type(type_=cast_to, value=data)) + + return cast(ResponseT, construct_type(type_=cast_to, value=data)) + except pydantic.ValidationError as err: + raise APIResponseValidationError(response=response, body=data) from err + + @property + def qs(self) -> Querystring: + return Querystring() + + @property + def custom_auth(self) -> httpx.Auth | None: + return None + + @property + def auth_headers(self) -> dict[str, str]: + return {} + + @property + def default_headers(self) -> dict[str, str | Omit]: + return { + "Accept": "application/json", + "Content-Type": "application/json", + "User-Agent": self.user_agent, + **self.platform_headers(), + **self._custom_headers, + } + + @property + def default_query(self) -> dict[str, object]: + return { + **self._custom_query, + } + + def _validate_headers( + self, + headers: Headers, # noqa: ARG002 + custom_headers: Headers, # noqa: ARG002 + ) -> None: + """Validate the given default headers and custom headers. + + Does nothing by default. + """ + return + + @property + def user_agent(self) -> str: + return f"{self.__class__.__name__}/Python {self._version}" + + @property + def base_url(self) -> URL: + return self._base_url + + @base_url.setter + def base_url(self, url: URL | str) -> None: + self._base_url = self._enforce_trailing_slash(url if isinstance(url, URL) else URL(url)) + + def platform_headers(self) -> Dict[str, str]: + # the actual implementation is in a separate `lru_cache` decorated + # function because adding `lru_cache` to methods will leak memory + # https://github.com/python/cpython/issues/88476 + return platform_headers(self._version, platform=self._platform) + + def _parse_retry_after_header(self, response_headers: Optional[httpx.Headers] = None) -> float | None: + """Returns a float of the number of seconds (not milliseconds) to wait after retrying, or None if unspecified. + + About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After + See also https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#syntax + """ + if response_headers is None: + return None + + # First, try the non-standard `retry-after-ms` header for milliseconds, + # which is more precise than integer-seconds `retry-after` + try: + retry_ms_header = response_headers.get("retry-after-ms", None) + return float(retry_ms_header) / 1000 + except (TypeError, ValueError): + pass + + # Next, try parsing `retry-after` header as seconds (allowing nonstandard floats). + retry_header = response_headers.get("retry-after") + try: + # note: the spec indicates that this should only ever be an integer + # but if someone sends a float there's no reason for us to not respect it + return float(retry_header) + except (TypeError, ValueError): + pass + + # Last, try parsing `retry-after` as a date. + retry_date_tuple = email.utils.parsedate_tz(retry_header) + if retry_date_tuple is None: + return None + + retry_date = email.utils.mktime_tz(retry_date_tuple) + return float(retry_date - time.time()) + + def _calculate_retry_timeout( + self, + remaining_retries: int, + options: FinalRequestOptions, + response_headers: Optional[httpx.Headers] = None, + ) -> float: + max_retries = options.get_max_retries(self.max_retries) + + # If the API asks us to wait a certain amount of time (and it's a reasonable amount), just do what it says. + retry_after = self._parse_retry_after_header(response_headers) + if retry_after is not None and 0 < retry_after <= 60: + return retry_after + + # Also cap retry count to 1000 to avoid any potential overflows with `pow` + nb_retries = min(max_retries - remaining_retries, 1000) + + # Apply exponential backoff, but not more than the max. + sleep_seconds = min(INITIAL_RETRY_DELAY * pow(2.0, nb_retries), MAX_RETRY_DELAY) + + # Apply some jitter, plus-or-minus half a second. + jitter = 1 - 0.25 * random() + timeout = sleep_seconds * jitter + return timeout if timeout >= 0 else 0 + + def _should_retry(self, response: httpx.Response) -> bool: + # Note: this is not a standard header + should_retry_header = response.headers.get("x-should-retry") + + # If the server explicitly says whether or not to retry, obey. + if should_retry_header == "true": + log.debug("Retrying as header `x-should-retry` is set to `true`") + return True + if should_retry_header == "false": + log.debug("Not retrying as header `x-should-retry` is set to `false`") + return False + + # Retry on request timeouts. + if response.status_code == 408: + log.debug("Retrying due to status code %i", response.status_code) + return True + + # Retry on lock timeouts. + if response.status_code == 409: + log.debug("Retrying due to status code %i", response.status_code) + return True + + # Retry on rate limits. + if response.status_code == 429: + log.debug("Retrying due to status code %i", response.status_code) + return True + + # Retry internal errors. + if response.status_code >= 500: + log.debug("Retrying due to status code %i", response.status_code) + return True + + log.debug("Not retrying") + return False + + def _idempotency_key(self) -> str: + return f"stainless-python-retry-{uuid.uuid4()}" + + +class _DefaultHttpxClient(httpx.Client): + def __init__(self, **kwargs: Any) -> None: + kwargs.setdefault("timeout", DEFAULT_TIMEOUT) + kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS) + kwargs.setdefault("follow_redirects", True) + super().__init__(**kwargs) + + +if TYPE_CHECKING: + DefaultHttpxClient = httpx.Client + """An alias to `httpx.Client` that provides the same defaults that this SDK + uses internally. + + This is useful because overriding the `http_client` with your own instance of + `httpx.Client` will result in httpx's defaults being used, not ours. + """ +else: + DefaultHttpxClient = _DefaultHttpxClient + + +class SyncHttpxClientWrapper(DefaultHttpxClient): + def __del__(self) -> None: + if self.is_closed: + return + + try: + self.close() + except Exception: + pass + + +class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]): + _client: httpx.Client + _default_stream_cls: type[Stream[Any]] | None = None + + def __init__( + self, + *, + version: str, + base_url: str | URL, + max_retries: int = DEFAULT_MAX_RETRIES, + timeout: float | Timeout | None | NotGiven = not_given, + http_client: httpx.Client | None = None, + custom_headers: Mapping[str, str] | None = None, + custom_query: Mapping[str, object] | None = None, + _strict_response_validation: bool, + ) -> None: + if not is_given(timeout): + # if the user passed in a custom http client with a non-default + # timeout set then we use that timeout. + # + # note: there is an edge case here where the user passes in a client + # where they've explicitly set the timeout to match the default timeout + # as this check is structural, meaning that we'll think they didn't + # pass in a timeout and will ignore it + if http_client and http_client.timeout != HTTPX_DEFAULT_TIMEOUT: + timeout = http_client.timeout + else: + timeout = DEFAULT_TIMEOUT + + if http_client is not None and not isinstance(http_client, httpx.Client): # pyright: ignore[reportUnnecessaryIsInstance] + raise TypeError( + f"Invalid `http_client` argument; Expected an instance of `httpx.Client` but got {type(http_client)}" + ) + + super().__init__( + version=version, + # cast to a valid type because mypy doesn't understand our type narrowing + timeout=cast(Timeout, timeout), + base_url=base_url, + max_retries=max_retries, + custom_query=custom_query, + custom_headers=custom_headers, + _strict_response_validation=_strict_response_validation, + ) + self._client = http_client or SyncHttpxClientWrapper( + base_url=base_url, + # cast to a valid type because mypy doesn't understand our type narrowing + timeout=cast(Timeout, timeout), + ) + + def is_closed(self) -> bool: + return self._client.is_closed + + def close(self) -> None: + """Close the underlying HTTPX client. + + The client will *not* be usable after this. + """ + # If an error is thrown while constructing a client, self._client + # may not be present + if hasattr(self, "_client"): + self._client.close() + + def __enter__(self: _T) -> _T: + return self + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + self.close() + + def _prepare_options( + self, + options: FinalRequestOptions, # noqa: ARG002 + ) -> FinalRequestOptions: + """Hook for mutating the given options""" + return options + + def _prepare_request( + self, + request: httpx.Request, # noqa: ARG002 + ) -> None: + """This method is used as a callback for mutating the `Request` object + after it has been constructed. + This is useful for cases where you want to add certain headers based off of + the request properties, e.g. `url`, `method` etc. + """ + return None + + @overload + def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: Literal[True], + stream_cls: Type[_StreamT], + ) -> _StreamT: ... + + @overload + def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: bool = False, + stream_cls: Type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: ... + + def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: bool = False, + stream_cls: type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: + cast_to = self._maybe_override_cast_to(cast_to, options) + + # create a copy of the options we were given so that if the + # options are mutated later & we then retry, the retries are + # given the original options + input_options = model_copy(options) + if input_options.idempotency_key is None and input_options.method.lower() != "get": + # ensure the idempotency key is reused between requests + input_options.idempotency_key = self._idempotency_key() + + response: httpx.Response | None = None + max_retries = input_options.get_max_retries(self.max_retries) + + retries_taken = 0 + for retries_taken in range(max_retries + 1): + options = model_copy(input_options) + options = self._prepare_options(options) + + remaining_retries = max_retries - retries_taken + request = self._build_request(options, retries_taken=retries_taken) + self._prepare_request(request) + + kwargs: HttpxSendArgs = {} + custom_auth = self._custom_auth(options.security) + if custom_auth is not None: + kwargs["auth"] = custom_auth + + if options.follow_redirects is not None: + kwargs["follow_redirects"] = options.follow_redirects + + log.debug("Sending HTTP Request: %s %s", request.method, request.url) + + response = None + try: + response = self._client.send( + request, + stream=stream or self._should_stream_response_body(request=request), + **kwargs, + ) + except httpx.TimeoutException as err: + log.debug("Encountered httpx.TimeoutException", exc_info=True) + + if remaining_retries > 0: + self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=None, + ) + continue + + log.debug("Raising timeout error") + raise APITimeoutError(request=request) from err + except Exception as err: + log.debug("Encountered Exception", exc_info=True) + + if remaining_retries > 0: + self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=None, + ) + continue + + log.debug("Raising connection error") + raise APIConnectionError(request=request) from err + + log.debug( + 'HTTP Response: %s %s "%i %s" %s', + request.method, + request.url, + response.status_code, + response.reason_phrase, + response.headers, + ) + + try: + response.raise_for_status() + except httpx.HTTPStatusError as err: # thrown on 4xx and 5xx status code + log.debug("Encountered httpx.HTTPStatusError", exc_info=True) + + if remaining_retries > 0 and self._should_retry(err.response): + err.response.close() + self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=response, + ) + continue + + # If the response is streamed then we need to explicitly read the response + # to completion before attempting to access the response text. + if not err.response.is_closed: + err.response.read() + + log.debug("Re-raising status error") + raise self._make_status_error_from_response(err.response) from None + + break + + assert response is not None, "could not resolve response (should never happen)" + return self._process_response( + cast_to=cast_to, + options=options, + response=response, + stream=stream, + stream_cls=stream_cls, + retries_taken=retries_taken, + ) + + def _sleep_for_retry( + self, *, retries_taken: int, max_retries: int, options: FinalRequestOptions, response: httpx.Response | None + ) -> None: + remaining_retries = max_retries - retries_taken + if remaining_retries == 1: + log.debug("1 retry left") + else: + log.debug("%i retries left", remaining_retries) + + timeout = self._calculate_retry_timeout(remaining_retries, options, response.headers if response else None) + log.info("Retrying request to %s in %f seconds", options.url, timeout) + + time.sleep(timeout) + + def _process_response( + self, + *, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + response: httpx.Response, + stream: bool, + stream_cls: type[Stream[Any]] | type[AsyncStream[Any]] | None, + retries_taken: int = 0, + ) -> ResponseT: + origin = get_origin(cast_to) or cast_to + + if ( + inspect.isclass(origin) + and issubclass(origin, BaseAPIResponse) + # we only want to actually return the custom BaseAPIResponse class if we're + # returning the raw response, or if we're not streaming SSE, as if we're streaming + # SSE then `cast_to` doesn't actively reflect the type we need to parse into + and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER))) + ): + if not issubclass(origin, APIResponse): + raise TypeError(f"API Response types must subclass {APIResponse}; Received {origin}") + + response_cls = cast("type[BaseAPIResponse[Any]]", cast_to) + return cast( + ResponseT, + response_cls( + raw=response, + client=self, + cast_to=extract_response_type(response_cls), + stream=stream, + stream_cls=stream_cls, + options=options, + retries_taken=retries_taken, + ), + ) + + if cast_to == httpx.Response: + return cast(ResponseT, response) + + api_response = APIResponse( + raw=response, + client=self, + cast_to=cast("type[ResponseT]", cast_to), # pyright: ignore[reportUnnecessaryCast] + stream=stream, + stream_cls=stream_cls, + options=options, + retries_taken=retries_taken, + ) + if bool(response.request.headers.get(RAW_RESPONSE_HEADER)): + return cast(ResponseT, api_response) + + return api_response.parse() + + def _request_api_list( + self, + model: Type[object], + page: Type[SyncPageT], + options: FinalRequestOptions, + ) -> SyncPageT: + def _parser(resp: SyncPageT) -> SyncPageT: + resp._set_private_attributes( + client=self, + model=model, + options=options, + ) + return resp + + options.post_parser = _parser + + return self.request(page, options, stream=False) + + @overload + def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: Literal[True], + stream_cls: type[_StreamT], + ) -> _StreamT: ... + + @overload + def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: bool, + stream_cls: type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: ... + + def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: bool = False, + stream_cls: type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: + opts = FinalRequestOptions.construct(method="get", url=path, **options) + # cast is required because mypy complains about returning Any even though + # it understands the type variables + return cast(ResponseT, self.request(cast_to, opts, stream=stream, stream_cls=stream_cls)) + + @overload + def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + options: RequestOptions = {}, + files: RequestFiles | None = None, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + options: RequestOptions = {}, + files: RequestFiles | None = None, + stream: Literal[True], + stream_cls: type[_StreamT], + ) -> _StreamT: ... + + @overload + def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + options: RequestOptions = {}, + files: RequestFiles | None = None, + stream: bool, + stream_cls: type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: ... + + def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + options: RequestOptions = {}, + files: RequestFiles | None = None, + stream: bool = False, + stream_cls: type[_StreamT] | None = None, + ) -> ResponseT | _StreamT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="post", url=path, json_data=body, content=content, files=to_httpx_files(files), **options + ) + return cast(ResponseT, self.request(cast_to, opts, stream=stream, stream_cls=stream_cls)) + + def patch( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="patch", url=path, json_data=body, content=content, files=to_httpx_files(files), **options + ) + return self.request(cast_to, opts) + + def put( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="put", url=path, json_data=body, content=content, files=to_httpx_files(files), **options + ) + return self.request(cast_to, opts) + + def delete( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: BinaryTypes | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct(method="delete", url=path, json_data=body, content=content, **options) + return self.request(cast_to, opts) + + def get_api_list( + self, + path: str, + *, + model: Type[object], + page: Type[SyncPageT], + body: Body | None = None, + options: RequestOptions = {}, + method: str = "get", + ) -> SyncPageT: + opts = FinalRequestOptions.construct(method=method, url=path, json_data=body, **options) + return self._request_api_list(model, page, opts) + + +class _DefaultAsyncHttpxClient(httpx.AsyncClient): + def __init__(self, **kwargs: Any) -> None: + kwargs.setdefault("timeout", DEFAULT_TIMEOUT) + kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS) + kwargs.setdefault("follow_redirects", True) + super().__init__(**kwargs) + + +try: + import httpx_aiohttp +except ImportError: + + class _DefaultAioHttpClient(httpx.AsyncClient): + def __init__(self, **_kwargs: Any) -> None: + raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra") +else: + + class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient): # type: ignore + def __init__(self, **kwargs: Any) -> None: + kwargs.setdefault("timeout", DEFAULT_TIMEOUT) + kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS) + kwargs.setdefault("follow_redirects", True) + + super().__init__(**kwargs) + + +if TYPE_CHECKING: + DefaultAsyncHttpxClient = httpx.AsyncClient + """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK + uses internally. + + This is useful because overriding the `http_client` with your own instance of + `httpx.AsyncClient` will result in httpx's defaults being used, not ours. + """ + + DefaultAioHttpClient = httpx.AsyncClient + """An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`.""" +else: + DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient + DefaultAioHttpClient = _DefaultAioHttpClient + + +class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient): + def __del__(self) -> None: + if self.is_closed: + return + + try: + # TODO(someday): support non asyncio runtimes here + asyncio.get_running_loop().create_task(self.aclose()) + except Exception: + pass + + +class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]): + _client: httpx.AsyncClient + _default_stream_cls: type[AsyncStream[Any]] | None = None + + def __init__( + self, + *, + version: str, + base_url: str | URL, + _strict_response_validation: bool, + max_retries: int = DEFAULT_MAX_RETRIES, + timeout: float | Timeout | None | NotGiven = not_given, + http_client: httpx.AsyncClient | None = None, + custom_headers: Mapping[str, str] | None = None, + custom_query: Mapping[str, object] | None = None, + ) -> None: + if not is_given(timeout): + # if the user passed in a custom http client with a non-default + # timeout set then we use that timeout. + # + # note: there is an edge case here where the user passes in a client + # where they've explicitly set the timeout to match the default timeout + # as this check is structural, meaning that we'll think they didn't + # pass in a timeout and will ignore it + if http_client and http_client.timeout != HTTPX_DEFAULT_TIMEOUT: + timeout = http_client.timeout + else: + timeout = DEFAULT_TIMEOUT + + if http_client is not None and not isinstance(http_client, httpx.AsyncClient): # pyright: ignore[reportUnnecessaryIsInstance] + raise TypeError( + f"Invalid `http_client` argument; Expected an instance of `httpx.AsyncClient` but got {type(http_client)}" + ) + + super().__init__( + version=version, + base_url=base_url, + # cast to a valid type because mypy doesn't understand our type narrowing + timeout=cast(Timeout, timeout), + max_retries=max_retries, + custom_query=custom_query, + custom_headers=custom_headers, + _strict_response_validation=_strict_response_validation, + ) + self._client = http_client or AsyncHttpxClientWrapper( + base_url=base_url, + # cast to a valid type because mypy doesn't understand our type narrowing + timeout=cast(Timeout, timeout), + ) + + def is_closed(self) -> bool: + return self._client.is_closed + + async def close(self) -> None: + """Close the underlying HTTPX client. + + The client will *not* be usable after this. + """ + await self._client.aclose() + + async def __aenter__(self: _T) -> _T: + return self + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + await self.close() + + async def _prepare_options( + self, + options: FinalRequestOptions, # noqa: ARG002 + ) -> FinalRequestOptions: + """Hook for mutating the given options""" + return options + + async def _prepare_request( + self, + request: httpx.Request, # noqa: ARG002 + ) -> None: + """This method is used as a callback for mutating the `Request` object + after it has been constructed. + This is useful for cases where you want to add certain headers based off of + the request properties, e.g. `url`, `method` etc. + """ + return None + + @overload + async def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + async def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: Literal[True], + stream_cls: type[_AsyncStreamT], + ) -> _AsyncStreamT: ... + + @overload + async def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: bool, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: ... + + async def request( + self, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + *, + stream: bool = False, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: + if self._platform is None: + # `get_platform` can make blocking IO calls so we + # execute it earlier while we are in an async context + self._platform = await asyncify(get_platform)() + + cast_to = self._maybe_override_cast_to(cast_to, options) + + # create a copy of the options we were given so that if the + # options are mutated later & we then retry, the retries are + # given the original options + input_options = model_copy(options) + if input_options.idempotency_key is None and input_options.method.lower() != "get": + # ensure the idempotency key is reused between requests + input_options.idempotency_key = self._idempotency_key() + + response: httpx.Response | None = None + max_retries = input_options.get_max_retries(self.max_retries) + + retries_taken = 0 + for retries_taken in range(max_retries + 1): + options = model_copy(input_options) + options = await self._prepare_options(options) + + remaining_retries = max_retries - retries_taken + request = self._build_request(options, retries_taken=retries_taken) + await self._prepare_request(request) + + kwargs: HttpxSendArgs = {} + if self.custom_auth is not None: + kwargs["auth"] = self.custom_auth + + if options.follow_redirects is not None: + kwargs["follow_redirects"] = options.follow_redirects + + log.debug("Sending HTTP Request: %s %s", request.method, request.url) + + response = None + try: + response = await self._client.send( + request, + stream=stream or self._should_stream_response_body(request=request), + **kwargs, + ) + except httpx.TimeoutException as err: + log.debug("Encountered httpx.TimeoutException", exc_info=True) + + if remaining_retries > 0: + await self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=None, + ) + continue + + log.debug("Raising timeout error") + raise APITimeoutError(request=request) from err + except Exception as err: + log.debug("Encountered Exception", exc_info=True) + + if remaining_retries > 0: + await self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=None, + ) + continue + + log.debug("Raising connection error") + raise APIConnectionError(request=request) from err + + log.debug( + 'HTTP Response: %s %s "%i %s" %s', + request.method, + request.url, + response.status_code, + response.reason_phrase, + response.headers, + ) + + try: + response.raise_for_status() + except httpx.HTTPStatusError as err: # thrown on 4xx and 5xx status code + log.debug("Encountered httpx.HTTPStatusError", exc_info=True) + + if remaining_retries > 0 and self._should_retry(err.response): + await err.response.aclose() + await self._sleep_for_retry( + retries_taken=retries_taken, + max_retries=max_retries, + options=input_options, + response=response, + ) + continue + + # If the response is streamed then we need to explicitly read the response + # to completion before attempting to access the response text. + if not err.response.is_closed: + await err.response.aread() + + log.debug("Re-raising status error") + raise self._make_status_error_from_response(err.response) from None + + break + + assert response is not None, "could not resolve response (should never happen)" + return await self._process_response( + cast_to=cast_to, + options=options, + response=response, + stream=stream, + stream_cls=stream_cls, + retries_taken=retries_taken, + ) + + async def _sleep_for_retry( + self, *, retries_taken: int, max_retries: int, options: FinalRequestOptions, response: httpx.Response | None + ) -> None: + remaining_retries = max_retries - retries_taken + if remaining_retries == 1: + log.debug("1 retry left") + else: + log.debug("%i retries left", remaining_retries) + + timeout = self._calculate_retry_timeout(remaining_retries, options, response.headers if response else None) + log.info("Retrying request to %s in %f seconds", options.url, timeout) + + await anyio.sleep(timeout) + + async def _process_response( + self, + *, + cast_to: Type[ResponseT], + options: FinalRequestOptions, + response: httpx.Response, + stream: bool, + stream_cls: type[Stream[Any]] | type[AsyncStream[Any]] | None, + retries_taken: int = 0, + ) -> ResponseT: + origin = get_origin(cast_to) or cast_to + + if ( + inspect.isclass(origin) + and issubclass(origin, BaseAPIResponse) + # we only want to actually return the custom BaseAPIResponse class if we're + # returning the raw response, or if we're not streaming SSE, as if we're streaming + # SSE then `cast_to` doesn't actively reflect the type we need to parse into + and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER))) + ): + if not issubclass(origin, AsyncAPIResponse): + raise TypeError(f"API Response types must subclass {AsyncAPIResponse}; Received {origin}") + + response_cls = cast("type[BaseAPIResponse[Any]]", cast_to) + return cast( + "ResponseT", + response_cls( + raw=response, + client=self, + cast_to=extract_response_type(response_cls), + stream=stream, + stream_cls=stream_cls, + options=options, + retries_taken=retries_taken, + ), + ) + + if cast_to == httpx.Response: + return cast(ResponseT, response) + + api_response = AsyncAPIResponse( + raw=response, + client=self, + cast_to=cast("type[ResponseT]", cast_to), # pyright: ignore[reportUnnecessaryCast] + stream=stream, + stream_cls=stream_cls, + options=options, + retries_taken=retries_taken, + ) + if bool(response.request.headers.get(RAW_RESPONSE_HEADER)): + return cast(ResponseT, api_response) + + return await api_response.parse() + + def _request_api_list( + self, + model: Type[_T], + page: Type[AsyncPageT], + options: FinalRequestOptions, + ) -> AsyncPaginator[_T, AsyncPageT]: + return AsyncPaginator(client=self, options=options, page_cls=page, model=model) + + @overload + async def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + async def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: Literal[True], + stream_cls: type[_AsyncStreamT], + ) -> _AsyncStreamT: ... + + @overload + async def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: bool, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: ... + + async def get( + self, + path: str, + *, + cast_to: Type[ResponseT], + options: RequestOptions = {}, + stream: bool = False, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: + opts = FinalRequestOptions.construct(method="get", url=path, **options) + return await self.request(cast_to, opts, stream=stream, stream_cls=stream_cls) + + @overload + async def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + stream: Literal[False] = False, + ) -> ResponseT: ... + + @overload + async def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + stream: Literal[True], + stream_cls: type[_AsyncStreamT], + ) -> _AsyncStreamT: ... + + @overload + async def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + stream: bool, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: ... + + async def post( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + stream: bool = False, + stream_cls: type[_AsyncStreamT] | None = None, + ) -> ResponseT | _AsyncStreamT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="post", url=path, json_data=body, content=content, files=await async_to_httpx_files(files), **options + ) + return await self.request(cast_to, opts, stream=stream, stream_cls=stream_cls) + + async def patch( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="patch", + url=path, + json_data=body, + content=content, + files=await async_to_httpx_files(files), + **options, + ) + return await self.request(cast_to, opts) + + async def put( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + files: RequestFiles | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if files is not None and content is not None: + raise TypeError("Passing both `files` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct( + method="put", url=path, json_data=body, content=content, files=await async_to_httpx_files(files), **options + ) + return await self.request(cast_to, opts) + + async def delete( + self, + path: str, + *, + cast_to: Type[ResponseT], + body: Body | None = None, + content: AsyncBinaryTypes | None = None, + options: RequestOptions = {}, + ) -> ResponseT: + if body is not None and content is not None: + raise TypeError("Passing both `body` and `content` is not supported") + if isinstance(body, bytes): + warnings.warn( + "Passing raw bytes as `body` is deprecated and will be removed in a future version. " + "Please pass raw bytes via the `content` parameter instead.", + DeprecationWarning, + stacklevel=2, + ) + opts = FinalRequestOptions.construct(method="delete", url=path, json_data=body, content=content, **options) + return await self.request(cast_to, opts) + + def get_api_list( + self, + path: str, + *, + model: Type[_T], + page: Type[AsyncPageT], + body: Body | None = None, + options: RequestOptions = {}, + method: str = "get", + ) -> AsyncPaginator[_T, AsyncPageT]: + opts = FinalRequestOptions.construct(method=method, url=path, json_data=body, **options) + return self._request_api_list(model, page, opts) + + +def make_request_options( + *, + query: Query | None = None, + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + idempotency_key: str | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + post_parser: PostParser | NotGiven = not_given, + security: SecurityOptions | None = None, +) -> RequestOptions: + """Create a dict of type RequestOptions without keys of NotGiven values.""" + options: RequestOptions = {} + if extra_headers is not None: + options["headers"] = extra_headers + + if extra_body is not None: + options["extra_json"] = cast(AnyMapping, extra_body) + + if query is not None: + options["params"] = query + + if extra_query is not None: + options["params"] = {**options.get("params", {}), **extra_query} + + if not isinstance(timeout, NotGiven): + options["timeout"] = timeout + + if idempotency_key is not None: + options["idempotency_key"] = idempotency_key + + if is_given(post_parser): + # internal + options["post_parser"] = post_parser # type: ignore + + if security is not None: + options["security"] = security + + return options + + +class ForceMultipartDict(Dict[str, None]): + def __bool__(self) -> bool: + return True + + +class OtherPlatform: + def __init__(self, name: str) -> None: + self.name = name + + @override + def __str__(self) -> str: + return f"Other:{self.name}" + + +Platform = Union[ + OtherPlatform, + Literal[ + "MacOS", + "Linux", + "Windows", + "FreeBSD", + "OpenBSD", + "iOS", + "Android", + "Unknown", + ], +] + + +def get_platform() -> Platform: + try: + system = platform.system().lower() + platform_name = platform.platform().lower() + except Exception: + return "Unknown" + + if "iphone" in platform_name or "ipad" in platform_name: + # Tested using Python3IDE on an iPhone 11 and Pythonista on an iPad 7 + # system is Darwin and platform_name is a string like: + # - Darwin-21.6.0-iPhone12,1-64bit + # - Darwin-21.6.0-iPad7,11-64bit + return "iOS" + + if system == "darwin": + return "MacOS" + + if system == "windows": + return "Windows" + + if "android" in platform_name: + # Tested using Pydroid 3 + # system is Linux and platform_name is a string like 'Linux-5.10.81-android12-9-00001-geba40aecb3b7-ab8534902-aarch64-with-libc' + return "Android" + + if system == "linux": + # https://distro.readthedocs.io/en/latest/#distro.id + distro_id = distro.id() + if distro_id == "freebsd": + return "FreeBSD" + + if distro_id == "openbsd": + return "OpenBSD" + + return "Linux" + + if platform_name: + return OtherPlatform(platform_name) + + return "Unknown" + + +@lru_cache(maxsize=None) +def platform_headers(version: str, *, platform: Platform | None) -> Dict[str, str]: + return { + "X-Stainless-Lang": "python", + "X-Stainless-Package-Version": version, + "X-Stainless-OS": str(platform or get_platform()), + "X-Stainless-Arch": str(get_architecture()), + "X-Stainless-Runtime": get_python_runtime(), + "X-Stainless-Runtime-Version": get_python_version(), + } + + +class OtherArch: + def __init__(self, name: str) -> None: + self.name = name + + @override + def __str__(self) -> str: + return f"other:{self.name}" + + +Arch = Union[OtherArch, Literal["x32", "x64", "arm", "arm64", "unknown"]] + + +def get_python_runtime() -> str: + try: + return platform.python_implementation() + except Exception: + return "unknown" + + +def get_python_version() -> str: + try: + return platform.python_version() + except Exception: + return "unknown" + + +def get_architecture() -> Arch: + try: + machine = platform.machine().lower() + except Exception: + return "unknown" + + if machine in ("arm64", "aarch64"): + return "arm64" + + # TODO: untested + if machine == "arm": + return "arm" + + if machine == "x86_64": + return "x64" + + # TODO: untested + if sys.maxsize <= 2**32: + return "x32" + + if machine: + return OtherArch(machine) + + return "unknown" + + +def _merge_mappings( + obj1: Mapping[_T_co, Union[_T, Omit]], + obj2: Mapping[_T_co, Union[_T, Omit]], +) -> Dict[_T_co, _T]: + """Merge two mappings of the same type, removing any values that are instances of `Omit`. + + In cases with duplicate keys the second mapping takes precedence. + """ + merged = {**obj1, **obj2} + return {key: value for key, value in merged.items() if not isinstance(value, Omit)} diff --git a/src/beeper_desktop_api/_client.py b/src/beeper_desktop_api/_client.py new file mode 100644 index 0000000..49220c9 --- /dev/null +++ b/src/beeper_desktop_api/_client.py @@ -0,0 +1,994 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import TYPE_CHECKING, Any, Mapping +from typing_extensions import Self, override + +import httpx + +from . import _exceptions +from ._qs import Querystring +from .types import client_focus_params, client_search_params +from ._types import ( + Body, + Omit, + Query, + Headers, + Timeout, + NotGiven, + Transport, + ProxiesTypes, + RequestOptions, + omit, + not_given, +) +from ._utils import ( + is_given, + is_mapping_t, + maybe_transform, + get_async_library, + async_maybe_transform, +) +from ._compat import cached_property +from ._models import SecurityOptions +from ._version import __version__ +from ._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ._streaming import Stream as Stream, AsyncStream as AsyncStream +from ._exceptions import APIStatusError, BeeperDesktopError +from ._base_client import ( + DEFAULT_MAX_RETRIES, + SyncAPIClient, + AsyncAPIClient, + make_request_options, +) +from .types.focus_response import FocusResponse +from .types.search_response import SearchResponse + +if TYPE_CHECKING: + from .resources import app, info, chats, assets, bridges, accounts, messages + from .resources.info import InfoResource, AsyncInfoResource + from .resources.assets import AssetsResource, AsyncAssetsResource + from .resources.app.app import AppResource, AsyncAppResource + from .resources.messages import MessagesResource, AsyncMessagesResource + from .resources.chats.chats import ChatsResource, AsyncChatsResource + from .resources.bridges.bridges import BridgesResource, AsyncBridgesResource + from .resources.accounts.accounts import AccountsResource, AsyncAccountsResource + +__all__ = [ + "Timeout", + "Transport", + "ProxiesTypes", + "RequestOptions", + "BeeperDesktop", + "AsyncBeeperDesktop", + "Client", + "AsyncClient", +] + + +class BeeperDesktop(SyncAPIClient): + # client options + access_token: str + + def __init__( + self, + *, + access_token: str | None = None, + base_url: str | httpx.URL | None = None, + timeout: float | Timeout | None | NotGiven = not_given, + max_retries: int = DEFAULT_MAX_RETRIES, + default_headers: Mapping[str, str] | None = None, + default_query: Mapping[str, object] | None = None, + # Configure a custom httpx client. + # We provide a `DefaultHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`. + # See the [httpx documentation](https://www.python-httpx.org/api/#client) for more details. + http_client: httpx.Client | None = None, + # Enable or disable schema validation for data returned by the API. + # When enabled an error APIResponseValidationError is raised + # if the API responds with invalid data for the expected schema. + # + # This parameter may be removed or changed in the future. + # If you rely on this feature, please open a GitHub issue + # outlining your use-case to help us decide if it should be + # part of our public interface in the future. + _strict_response_validation: bool = False, + ) -> None: + """Construct a new synchronous BeeperDesktop client instance. + + This automatically infers the `access_token` argument from the `BEEPER_ACCESS_TOKEN` environment variable if it is not provided. + """ + if access_token is None: + access_token = os.environ.get("BEEPER_ACCESS_TOKEN") + if access_token is None: + raise BeeperDesktopError( + "The access_token client option must be set either by passing access_token to the client or by setting the BEEPER_ACCESS_TOKEN environment variable" + ) + self.access_token = access_token + + if base_url is None: + base_url = os.environ.get("BEEPER_BASE_URL") + if base_url is None: + base_url = f"http://localhost:23373" + + custom_headers_env = os.environ.get("BEEPER_CUSTOM_HEADERS") + if custom_headers_env is not None: + parsed: dict[str, str] = {} + for line in custom_headers_env.split("\n"): + colon = line.find(":") + if colon >= 0: + parsed[line[:colon].strip()] = line[colon + 1 :].strip() + default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})} + + super().__init__( + version=__version__, + base_url=base_url, + max_retries=max_retries, + timeout=timeout, + http_client=http_client, + custom_headers=default_headers, + custom_query=default_query, + _strict_response_validation=_strict_response_validation, + ) + + @cached_property + def accounts(self) -> AccountsResource: + """Manage connected chat accounts""" + from .resources.accounts import AccountsResource + + return AccountsResource(self) + + @cached_property + def bridges(self) -> BridgesResource: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import BridgesResource + + return BridgesResource(self) + + @cached_property + def chats(self) -> ChatsResource: + """Manage chats""" + from .resources.chats import ChatsResource + + return ChatsResource(self) + + @cached_property + def messages(self) -> MessagesResource: + """Manage messages in chats""" + from .resources.messages import MessagesResource + + return MessagesResource(self) + + @cached_property + def assets(self) -> AssetsResource: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AssetsResource + + return AssetsResource(self) + + @cached_property + def info(self) -> InfoResource: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import InfoResource + + return InfoResource(self) + + @cached_property + def app(self) -> AppResource: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AppResource + + return AppResource(self) + + @cached_property + def with_raw_response(self) -> BeeperDesktopWithRawResponse: + return BeeperDesktopWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> BeeperDesktopWithStreamedResponse: + return BeeperDesktopWithStreamedResponse(self) + + @property + @override + def qs(self) -> Querystring: + return Querystring(array_format="repeat") + + @override + def _auth_headers(self, security: SecurityOptions) -> dict[str, str]: + return { + **(self._bearer_auth if security.get("bearer_auth", False) else {}), + } + + @property + def _bearer_auth(self) -> dict[str, str]: + access_token = self.access_token + return {"Authorization": f"Bearer {access_token}"} + + @property + @override + def default_headers(self) -> dict[str, str | Omit]: + return { + **super().default_headers, + "X-Stainless-Async": "false", + **self._custom_headers, + } + + def copy( + self, + *, + access_token: str | None = None, + base_url: str | httpx.URL | None = None, + timeout: float | Timeout | None | NotGiven = not_given, + http_client: httpx.Client | None = None, + max_retries: int | NotGiven = not_given, + default_headers: Mapping[str, str] | None = None, + set_default_headers: Mapping[str, str] | None = None, + default_query: Mapping[str, object] | None = None, + set_default_query: Mapping[str, object] | None = None, + _extra_kwargs: Mapping[str, Any] = {}, + ) -> Self: + """ + Create a new client instance re-using the same options given to the current client with optional overriding. + """ + if default_headers is not None and set_default_headers is not None: + raise ValueError("The `default_headers` and `set_default_headers` arguments are mutually exclusive") + + if default_query is not None and set_default_query is not None: + raise ValueError("The `default_query` and `set_default_query` arguments are mutually exclusive") + + headers = self._custom_headers + if default_headers is not None: + headers = {**headers, **default_headers} + elif set_default_headers is not None: + headers = set_default_headers + + params = self._custom_query + if default_query is not None: + params = {**params, **default_query} + elif set_default_query is not None: + params = set_default_query + + http_client = http_client or self._client + return self.__class__( + access_token=access_token or self.access_token, + base_url=base_url or self.base_url, + timeout=self.timeout if isinstance(timeout, NotGiven) else timeout, + http_client=http_client, + max_retries=max_retries if is_given(max_retries) else self.max_retries, + default_headers=headers, + default_query=params, + **_extra_kwargs, + ) + + # Alias for `copy` for nicer inline usage, e.g. + # client.with_options(timeout=10).foo.create(...) + with_options = copy + + def focus( + self, + *, + chat_id: str | Omit = omit, + draft_attachment_path: str | Omit = omit, + draft_text: str | Omit = omit, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> FocusResponse: + """ + Focus Beeper Desktop and optionally open a specific chat, jump to a message, or + pre-fill text and an image. + + 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 local image path 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. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self.post( + "/v1/focus", + body=maybe_transform( + { + "chat_id": chat_id, + "draft_attachment_path": draft_attachment_path, + "draft_text": draft_text, + "message_id": message_id, + }, + client_focus_params.ClientFocusParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=FocusResponse, + ) + + def search( + self, + *, + query: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SearchResponse: + """ + Return matching chats, participant matches in group chats, and the first page of + message results in one call. Use the dedicated chat and message search endpoints + for pagination. + + Args: + query: User-typed search text. Uses literal word matching. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self.get( + "/v1/search", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"query": query}, client_search_params.ClientSearchParams), + ), + cast_to=SearchResponse, + ) + + @override + def _make_status_error( + self, + err_msg: str, + *, + body: object, + response: httpx.Response, + ) -> APIStatusError: + if response.status_code == 400: + return _exceptions.BadRequestError(err_msg, response=response, body=body) + + if response.status_code == 401: + return _exceptions.AuthenticationError(err_msg, response=response, body=body) + + if response.status_code == 403: + return _exceptions.PermissionDeniedError(err_msg, response=response, body=body) + + if response.status_code == 404: + return _exceptions.NotFoundError(err_msg, response=response, body=body) + + if response.status_code == 409: + return _exceptions.ConflictError(err_msg, response=response, body=body) + + if response.status_code == 422: + return _exceptions.UnprocessableEntityError(err_msg, response=response, body=body) + + if response.status_code == 429: + return _exceptions.RateLimitError(err_msg, response=response, body=body) + + if response.status_code >= 500: + return _exceptions.InternalServerError(err_msg, response=response, body=body) + return APIStatusError(err_msg, response=response, body=body) + + +class AsyncBeeperDesktop(AsyncAPIClient): + # client options + access_token: str + + def __init__( + self, + *, + access_token: str | None = None, + base_url: str | httpx.URL | None = None, + timeout: float | Timeout | None | NotGiven = not_given, + max_retries: int = DEFAULT_MAX_RETRIES, + default_headers: Mapping[str, str] | None = None, + default_query: Mapping[str, object] | None = None, + # Configure a custom httpx client. + # We provide a `DefaultAsyncHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`. + # See the [httpx documentation](https://www.python-httpx.org/api/#asyncclient) for more details. + http_client: httpx.AsyncClient | None = None, + # Enable or disable schema validation for data returned by the API. + # When enabled an error APIResponseValidationError is raised + # if the API responds with invalid data for the expected schema. + # + # This parameter may be removed or changed in the future. + # If you rely on this feature, please open a GitHub issue + # outlining your use-case to help us decide if it should be + # part of our public interface in the future. + _strict_response_validation: bool = False, + ) -> None: + """Construct a new async AsyncBeeperDesktop client instance. + + This automatically infers the `access_token` argument from the `BEEPER_ACCESS_TOKEN` environment variable if it is not provided. + """ + if access_token is None: + access_token = os.environ.get("BEEPER_ACCESS_TOKEN") + if access_token is None: + raise BeeperDesktopError( + "The access_token client option must be set either by passing access_token to the client or by setting the BEEPER_ACCESS_TOKEN environment variable" + ) + self.access_token = access_token + + if base_url is None: + base_url = os.environ.get("BEEPER_BASE_URL") + if base_url is None: + base_url = f"http://localhost:23373" + + custom_headers_env = os.environ.get("BEEPER_CUSTOM_HEADERS") + if custom_headers_env is not None: + parsed: dict[str, str] = {} + for line in custom_headers_env.split("\n"): + colon = line.find(":") + if colon >= 0: + parsed[line[:colon].strip()] = line[colon + 1 :].strip() + default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})} + + super().__init__( + version=__version__, + base_url=base_url, + max_retries=max_retries, + timeout=timeout, + http_client=http_client, + custom_headers=default_headers, + custom_query=default_query, + _strict_response_validation=_strict_response_validation, + ) + + @cached_property + def accounts(self) -> AsyncAccountsResource: + """Manage connected chat accounts""" + from .resources.accounts import AsyncAccountsResource + + return AsyncAccountsResource(self) + + @cached_property + def bridges(self) -> AsyncBridgesResource: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import AsyncBridgesResource + + return AsyncBridgesResource(self) + + @cached_property + def chats(self) -> AsyncChatsResource: + """Manage chats""" + from .resources.chats import AsyncChatsResource + + return AsyncChatsResource(self) + + @cached_property + def messages(self) -> AsyncMessagesResource: + """Manage messages in chats""" + from .resources.messages import AsyncMessagesResource + + return AsyncMessagesResource(self) + + @cached_property + def assets(self) -> AsyncAssetsResource: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AsyncAssetsResource + + return AsyncAssetsResource(self) + + @cached_property + def info(self) -> AsyncInfoResource: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import AsyncInfoResource + + return AsyncInfoResource(self) + + @cached_property + def app(self) -> AsyncAppResource: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AsyncAppResource + + return AsyncAppResource(self) + + @cached_property + def with_raw_response(self) -> AsyncBeeperDesktopWithRawResponse: + return AsyncBeeperDesktopWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncBeeperDesktopWithStreamedResponse: + return AsyncBeeperDesktopWithStreamedResponse(self) + + @property + @override + def qs(self) -> Querystring: + return Querystring(array_format="repeat") + + @override + def _auth_headers(self, security: SecurityOptions) -> dict[str, str]: + return { + **(self._bearer_auth if security.get("bearer_auth", False) else {}), + } + + @property + def _bearer_auth(self) -> dict[str, str]: + access_token = self.access_token + return {"Authorization": f"Bearer {access_token}"} + + @property + @override + def default_headers(self) -> dict[str, str | Omit]: + return { + **super().default_headers, + "X-Stainless-Async": f"async:{get_async_library()}", + **self._custom_headers, + } + + def copy( + self, + *, + access_token: str | None = None, + base_url: str | httpx.URL | None = None, + timeout: float | Timeout | None | NotGiven = not_given, + http_client: httpx.AsyncClient | None = None, + max_retries: int | NotGiven = not_given, + default_headers: Mapping[str, str] | None = None, + set_default_headers: Mapping[str, str] | None = None, + default_query: Mapping[str, object] | None = None, + set_default_query: Mapping[str, object] | None = None, + _extra_kwargs: Mapping[str, Any] = {}, + ) -> Self: + """ + Create a new client instance re-using the same options given to the current client with optional overriding. + """ + if default_headers is not None and set_default_headers is not None: + raise ValueError("The `default_headers` and `set_default_headers` arguments are mutually exclusive") + + if default_query is not None and set_default_query is not None: + raise ValueError("The `default_query` and `set_default_query` arguments are mutually exclusive") + + headers = self._custom_headers + if default_headers is not None: + headers = {**headers, **default_headers} + elif set_default_headers is not None: + headers = set_default_headers + + params = self._custom_query + if default_query is not None: + params = {**params, **default_query} + elif set_default_query is not None: + params = set_default_query + + http_client = http_client or self._client + return self.__class__( + access_token=access_token or self.access_token, + base_url=base_url or self.base_url, + timeout=self.timeout if isinstance(timeout, NotGiven) else timeout, + http_client=http_client, + max_retries=max_retries if is_given(max_retries) else self.max_retries, + default_headers=headers, + default_query=params, + **_extra_kwargs, + ) + + # Alias for `copy` for nicer inline usage, e.g. + # client.with_options(timeout=10).foo.create(...) + with_options = copy + + async def focus( + self, + *, + chat_id: str | Omit = omit, + draft_attachment_path: str | Omit = omit, + draft_text: str | Omit = omit, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> FocusResponse: + """ + Focus Beeper Desktop and optionally open a specific chat, jump to a message, or + pre-fill text and an image. + + 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 local image path 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. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self.post( + "/v1/focus", + body=await async_maybe_transform( + { + "chat_id": chat_id, + "draft_attachment_path": draft_attachment_path, + "draft_text": draft_text, + "message_id": message_id, + }, + client_focus_params.ClientFocusParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=FocusResponse, + ) + + async def search( + self, + *, + query: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SearchResponse: + """ + Return matching chats, participant matches in group chats, and the first page of + message results in one call. Use the dedicated chat and message search endpoints + for pagination. + + Args: + query: User-typed search text. Uses literal word matching. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self.get( + "/v1/search", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform({"query": query}, client_search_params.ClientSearchParams), + ), + cast_to=SearchResponse, + ) + + @override + def _make_status_error( + self, + err_msg: str, + *, + body: object, + response: httpx.Response, + ) -> APIStatusError: + if response.status_code == 400: + return _exceptions.BadRequestError(err_msg, response=response, body=body) + + if response.status_code == 401: + return _exceptions.AuthenticationError(err_msg, response=response, body=body) + + if response.status_code == 403: + return _exceptions.PermissionDeniedError(err_msg, response=response, body=body) + + if response.status_code == 404: + return _exceptions.NotFoundError(err_msg, response=response, body=body) + + if response.status_code == 409: + return _exceptions.ConflictError(err_msg, response=response, body=body) + + if response.status_code == 422: + return _exceptions.UnprocessableEntityError(err_msg, response=response, body=body) + + if response.status_code == 429: + return _exceptions.RateLimitError(err_msg, response=response, body=body) + + if response.status_code >= 500: + return _exceptions.InternalServerError(err_msg, response=response, body=body) + return APIStatusError(err_msg, response=response, body=body) + + +class BeeperDesktopWithRawResponse: + _client: BeeperDesktop + + def __init__(self, client: BeeperDesktop) -> None: + self._client = client + + self.focus = to_raw_response_wrapper( + client.focus, + ) + self.search = to_raw_response_wrapper( + client.search, + ) + + @cached_property + def accounts(self) -> accounts.AccountsResourceWithRawResponse: + """Manage connected chat accounts""" + from .resources.accounts import AccountsResourceWithRawResponse + + return AccountsResourceWithRawResponse(self._client.accounts) + + @cached_property + def bridges(self) -> bridges.BridgesResourceWithRawResponse: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import BridgesResourceWithRawResponse + + return BridgesResourceWithRawResponse(self._client.bridges) + + @cached_property + def chats(self) -> chats.ChatsResourceWithRawResponse: + """Manage chats""" + from .resources.chats import ChatsResourceWithRawResponse + + return ChatsResourceWithRawResponse(self._client.chats) + + @cached_property + def messages(self) -> messages.MessagesResourceWithRawResponse: + """Manage messages in chats""" + from .resources.messages import MessagesResourceWithRawResponse + + return MessagesResourceWithRawResponse(self._client.messages) + + @cached_property + def assets(self) -> assets.AssetsResourceWithRawResponse: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AssetsResourceWithRawResponse + + return AssetsResourceWithRawResponse(self._client.assets) + + @cached_property + def info(self) -> info.InfoResourceWithRawResponse: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import InfoResourceWithRawResponse + + return InfoResourceWithRawResponse(self._client.info) + + @cached_property + def app(self) -> app.AppResourceWithRawResponse: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AppResourceWithRawResponse + + return AppResourceWithRawResponse(self._client.app) + + +class AsyncBeeperDesktopWithRawResponse: + _client: AsyncBeeperDesktop + + def __init__(self, client: AsyncBeeperDesktop) -> None: + self._client = client + + self.focus = async_to_raw_response_wrapper( + client.focus, + ) + self.search = async_to_raw_response_wrapper( + client.search, + ) + + @cached_property + def accounts(self) -> accounts.AsyncAccountsResourceWithRawResponse: + """Manage connected chat accounts""" + from .resources.accounts import AsyncAccountsResourceWithRawResponse + + return AsyncAccountsResourceWithRawResponse(self._client.accounts) + + @cached_property + def bridges(self) -> bridges.AsyncBridgesResourceWithRawResponse: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import AsyncBridgesResourceWithRawResponse + + return AsyncBridgesResourceWithRawResponse(self._client.bridges) + + @cached_property + def chats(self) -> chats.AsyncChatsResourceWithRawResponse: + """Manage chats""" + from .resources.chats import AsyncChatsResourceWithRawResponse + + return AsyncChatsResourceWithRawResponse(self._client.chats) + + @cached_property + def messages(self) -> messages.AsyncMessagesResourceWithRawResponse: + """Manage messages in chats""" + from .resources.messages import AsyncMessagesResourceWithRawResponse + + return AsyncMessagesResourceWithRawResponse(self._client.messages) + + @cached_property + def assets(self) -> assets.AsyncAssetsResourceWithRawResponse: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AsyncAssetsResourceWithRawResponse + + return AsyncAssetsResourceWithRawResponse(self._client.assets) + + @cached_property + def info(self) -> info.AsyncInfoResourceWithRawResponse: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import AsyncInfoResourceWithRawResponse + + return AsyncInfoResourceWithRawResponse(self._client.info) + + @cached_property + def app(self) -> app.AsyncAppResourceWithRawResponse: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AsyncAppResourceWithRawResponse + + return AsyncAppResourceWithRawResponse(self._client.app) + + +class BeeperDesktopWithStreamedResponse: + _client: BeeperDesktop + + def __init__(self, client: BeeperDesktop) -> None: + self._client = client + + self.focus = to_streamed_response_wrapper( + client.focus, + ) + self.search = to_streamed_response_wrapper( + client.search, + ) + + @cached_property + def accounts(self) -> accounts.AccountsResourceWithStreamingResponse: + """Manage connected chat accounts""" + from .resources.accounts import AccountsResourceWithStreamingResponse + + return AccountsResourceWithStreamingResponse(self._client.accounts) + + @cached_property + def bridges(self) -> bridges.BridgesResourceWithStreamingResponse: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import BridgesResourceWithStreamingResponse + + return BridgesResourceWithStreamingResponse(self._client.bridges) + + @cached_property + def chats(self) -> chats.ChatsResourceWithStreamingResponse: + """Manage chats""" + from .resources.chats import ChatsResourceWithStreamingResponse + + return ChatsResourceWithStreamingResponse(self._client.chats) + + @cached_property + def messages(self) -> messages.MessagesResourceWithStreamingResponse: + """Manage messages in chats""" + from .resources.messages import MessagesResourceWithStreamingResponse + + return MessagesResourceWithStreamingResponse(self._client.messages) + + @cached_property + def assets(self) -> assets.AssetsResourceWithStreamingResponse: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AssetsResourceWithStreamingResponse + + return AssetsResourceWithStreamingResponse(self._client.assets) + + @cached_property + def info(self) -> info.InfoResourceWithStreamingResponse: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import InfoResourceWithStreamingResponse + + return InfoResourceWithStreamingResponse(self._client.info) + + @cached_property + def app(self) -> app.AppResourceWithStreamingResponse: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AppResourceWithStreamingResponse + + return AppResourceWithStreamingResponse(self._client.app) + + +class AsyncBeeperDesktopWithStreamedResponse: + _client: AsyncBeeperDesktop + + def __init__(self, client: AsyncBeeperDesktop) -> None: + self._client = client + + self.focus = async_to_streamed_response_wrapper( + client.focus, + ) + self.search = async_to_streamed_response_wrapper( + client.search, + ) + + @cached_property + def accounts(self) -> accounts.AsyncAccountsResourceWithStreamingResponse: + """Manage connected chat accounts""" + from .resources.accounts import AsyncAccountsResourceWithStreamingResponse + + return AsyncAccountsResourceWithStreamingResponse(self._client.accounts) + + @cached_property + def bridges(self) -> bridges.AsyncBridgesResourceWithStreamingResponse: + """Manage bridge-backed account types, connections, and login sessions""" + from .resources.bridges import AsyncBridgesResourceWithStreamingResponse + + return AsyncBridgesResourceWithStreamingResponse(self._client.bridges) + + @cached_property + def chats(self) -> chats.AsyncChatsResourceWithStreamingResponse: + """Manage chats""" + from .resources.chats import AsyncChatsResourceWithStreamingResponse + + return AsyncChatsResourceWithStreamingResponse(self._client.chats) + + @cached_property + def messages(self) -> messages.AsyncMessagesResourceWithStreamingResponse: + """Manage messages in chats""" + from .resources.messages import AsyncMessagesResourceWithStreamingResponse + + return AsyncMessagesResourceWithStreamingResponse(self._client.messages) + + @cached_property + def assets(self) -> assets.AsyncAssetsResourceWithStreamingResponse: + """Manage assets in Beeper Desktop, like message attachments""" + from .resources.assets import AsyncAssetsResourceWithStreamingResponse + + return AsyncAssetsResourceWithStreamingResponse(self._client.assets) + + @cached_property + def info(self) -> info.AsyncInfoResourceWithStreamingResponse: + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + from .resources.info import AsyncInfoResourceWithStreamingResponse + + return AsyncInfoResourceWithStreamingResponse(self._client.info) + + @cached_property + def app(self) -> app.AsyncAppResourceWithStreamingResponse: + """Manage Beeper app login and encrypted messaging setup""" + from .resources.app import AsyncAppResourceWithStreamingResponse + + return AsyncAppResourceWithStreamingResponse(self._client.app) + + +Client = BeeperDesktop + +AsyncClient = AsyncBeeperDesktop diff --git a/src/beeper_desktop_api/_compat.py b/src/beeper_desktop_api/_compat.py new file mode 100644 index 0000000..e6690a4 --- /dev/null +++ b/src/beeper_desktop_api/_compat.py @@ -0,0 +1,226 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING, Any, Union, Generic, TypeVar, Callable, cast, overload +from datetime import date, datetime +from typing_extensions import Self, Literal, TypedDict + +import pydantic +from pydantic.fields import FieldInfo + +from ._types import IncEx, StrBytesIntFloat + +_T = TypeVar("_T") +_ModelT = TypeVar("_ModelT", bound=pydantic.BaseModel) + +# --------------- Pydantic v2, v3 compatibility --------------- + +# Pyright incorrectly reports some of our functions as overriding a method when they don't +# pyright: reportIncompatibleMethodOverride=false + +PYDANTIC_V1 = pydantic.VERSION.startswith("1.") + +if TYPE_CHECKING: + + def parse_date(value: date | StrBytesIntFloat) -> date: # noqa: ARG001 + ... + + def parse_datetime(value: Union[datetime, StrBytesIntFloat]) -> datetime: # noqa: ARG001 + ... + + def get_args(t: type[Any]) -> tuple[Any, ...]: # noqa: ARG001 + ... + + def is_union(tp: type[Any] | None) -> bool: # noqa: ARG001 + ... + + def get_origin(t: type[Any]) -> type[Any] | None: # noqa: ARG001 + ... + + def is_literal_type(type_: type[Any]) -> bool: # noqa: ARG001 + ... + + def is_typeddict(type_: type[Any]) -> bool: # noqa: ARG001 + ... + +else: + # v1 re-exports + if PYDANTIC_V1: + from pydantic.typing import ( + get_args as get_args, + is_union as is_union, + get_origin as get_origin, + is_typeddict as is_typeddict, + is_literal_type as is_literal_type, + ) + from pydantic.datetime_parse import parse_date as parse_date, parse_datetime as parse_datetime + else: + from ._utils import ( + get_args as get_args, + is_union as is_union, + get_origin as get_origin, + parse_date as parse_date, + is_typeddict as is_typeddict, + parse_datetime as parse_datetime, + is_literal_type as is_literal_type, + ) + + +# refactored config +if TYPE_CHECKING: + from pydantic import ConfigDict as ConfigDict +else: + if PYDANTIC_V1: + # TODO: provide an error message here? + ConfigDict = None + else: + from pydantic import ConfigDict as ConfigDict + + +# renamed methods / properties +def parse_obj(model: type[_ModelT], value: object) -> _ModelT: + if PYDANTIC_V1: + return cast(_ModelT, model.parse_obj(value)) # pyright: ignore[reportDeprecated, reportUnnecessaryCast] + else: + return model.model_validate(value) + + +def field_is_required(field: FieldInfo) -> bool: + if PYDANTIC_V1: + return field.required # type: ignore + return field.is_required() + + +def field_get_default(field: FieldInfo) -> Any: + value = field.get_default() + if PYDANTIC_V1: + return value + from pydantic_core import PydanticUndefined + + if value == PydanticUndefined: + return None + return value + + +def field_outer_type(field: FieldInfo) -> Any: + if PYDANTIC_V1: + return field.outer_type_ # type: ignore + return field.annotation + + +def get_model_config(model: type[pydantic.BaseModel]) -> Any: + if PYDANTIC_V1: + return model.__config__ # type: ignore + return model.model_config + + +def get_model_fields(model: type[pydantic.BaseModel]) -> dict[str, FieldInfo]: + if PYDANTIC_V1: + return model.__fields__ # type: ignore + return model.model_fields + + +def model_copy(model: _ModelT, *, deep: bool = False) -> _ModelT: + if PYDANTIC_V1: + return model.copy(deep=deep) # type: ignore + return model.model_copy(deep=deep) + + +def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str: + if PYDANTIC_V1: + return model.json(indent=indent) # type: ignore + return model.model_dump_json(indent=indent) + + +class _ModelDumpKwargs(TypedDict, total=False): + by_alias: bool + + +def model_dump( + model: pydantic.BaseModel, + *, + exclude: IncEx | None = None, + exclude_unset: bool = False, + exclude_defaults: bool = False, + warnings: bool = True, + mode: Literal["json", "python"] = "python", + by_alias: bool | None = None, +) -> dict[str, Any]: + if (not PYDANTIC_V1) or hasattr(model, "model_dump"): + kwargs: _ModelDumpKwargs = {} + if by_alias is not None: + kwargs["by_alias"] = by_alias + return model.model_dump( + mode=mode, + exclude=exclude, + exclude_unset=exclude_unset, + exclude_defaults=exclude_defaults, + # warnings are not supported in Pydantic v1 + warnings=True if PYDANTIC_V1 else warnings, + **kwargs, + ) + return cast( + "dict[str, Any]", + model.dict( # pyright: ignore[reportDeprecated, reportUnnecessaryCast] + exclude=exclude, exclude_unset=exclude_unset, exclude_defaults=exclude_defaults, by_alias=bool(by_alias) + ), + ) + + +def model_parse(model: type[_ModelT], data: Any) -> _ModelT: + if PYDANTIC_V1: + return model.parse_obj(data) # pyright: ignore[reportDeprecated] + return model.model_validate(data) + + +# generic models +if TYPE_CHECKING: + + class GenericModel(pydantic.BaseModel): ... + +else: + if PYDANTIC_V1: + import pydantic.generics + + class GenericModel(pydantic.generics.GenericModel, pydantic.BaseModel): ... + else: + # there no longer needs to be a distinction in v2 but + # we still have to create our own subclass to avoid + # inconsistent MRO ordering errors + class GenericModel(pydantic.BaseModel): ... + + +# cached properties +if TYPE_CHECKING: + cached_property = property + + # we define a separate type (copied from typeshed) + # that represents that `cached_property` is `set`able + # at runtime, which differs from `@property`. + # + # this is a separate type as editors likely special case + # `@property` and we don't want to cause issues just to have + # more helpful internal types. + + class typed_cached_property(Generic[_T]): + func: Callable[[Any], _T] + attrname: str | None + + def __init__(self, func: Callable[[Any], _T]) -> None: ... + + @overload + def __get__(self, instance: None, owner: type[Any] | None = None) -> Self: ... + + @overload + def __get__(self, instance: object, owner: type[Any] | None = None) -> _T: ... + + def __get__(self, instance: object, owner: type[Any] | None = None) -> _T | Self: + raise NotImplementedError() + + def __set_name__(self, owner: type[Any], name: str) -> None: ... + + # __set__ is not defined at runtime, but @cached_property is designed to be settable + def __set__(self, instance: object, value: _T) -> None: ... +else: + from functools import cached_property as cached_property + + typed_cached_property = cached_property diff --git a/src/beeper_desktop_api/_constants.py b/src/beeper_desktop_api/_constants.py new file mode 100644 index 0000000..b57f90b --- /dev/null +++ b/src/beeper_desktop_api/_constants.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import httpx + +RAW_RESPONSE_HEADER = "X-Stainless-Raw-Response" +OVERRIDE_CAST_TO_HEADER = "____stainless_override_cast_to" + +# default timeout is 30 seconds +DEFAULT_TIMEOUT = httpx.Timeout(timeout=30, connect=5.0) +DEFAULT_MAX_RETRIES = 2 +DEFAULT_CONNECTION_LIMITS = httpx.Limits(max_connections=100, max_keepalive_connections=20) + +INITIAL_RETRY_DELAY = 0.5 +MAX_RETRY_DELAY = 8.0 diff --git a/src/beeper_desktop_api/_exceptions.py b/src/beeper_desktop_api/_exceptions.py new file mode 100644 index 0000000..ce04c57 --- /dev/null +++ b/src/beeper_desktop_api/_exceptions.py @@ -0,0 +1,108 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +__all__ = [ + "BadRequestError", + "AuthenticationError", + "PermissionDeniedError", + "NotFoundError", + "ConflictError", + "UnprocessableEntityError", + "RateLimitError", + "InternalServerError", +] + + +class BeeperDesktopError(Exception): + pass + + +class APIError(BeeperDesktopError): + message: str + request: httpx.Request + + body: object | None + """The API response body. + + If the API responded with a valid JSON structure then this property will be the + decoded result. + + If it isn't a valid JSON structure then this will be the raw response. + + If there was no response associated with this error then it will be `None`. + """ + + def __init__(self, message: str, request: httpx.Request, *, body: object | None) -> None: # noqa: ARG002 + super().__init__(message) + self.request = request + self.message = message + self.body = body + + +class APIResponseValidationError(APIError): + response: httpx.Response + status_code: int + + def __init__(self, response: httpx.Response, body: object | None, *, message: str | None = None) -> None: + super().__init__(message or "Data returned by API invalid for expected schema.", response.request, body=body) + self.response = response + self.status_code = response.status_code + + +class APIStatusError(APIError): + """Raised when an API response has a status code of 4xx or 5xx.""" + + response: httpx.Response + status_code: int + + def __init__(self, message: str, *, response: httpx.Response, body: object | None) -> None: + super().__init__(message, response.request, body=body) + self.response = response + self.status_code = response.status_code + + +class APIConnectionError(APIError): + def __init__(self, *, message: str = "Connection error.", request: httpx.Request) -> None: + super().__init__(message, request, body=None) + + +class APITimeoutError(APIConnectionError): + def __init__(self, request: httpx.Request) -> None: + super().__init__(message="Request timed out.", request=request) + + +class BadRequestError(APIStatusError): + status_code: Literal[400] = 400 # pyright: ignore[reportIncompatibleVariableOverride] + + +class AuthenticationError(APIStatusError): + status_code: Literal[401] = 401 # pyright: ignore[reportIncompatibleVariableOverride] + + +class PermissionDeniedError(APIStatusError): + status_code: Literal[403] = 403 # pyright: ignore[reportIncompatibleVariableOverride] + + +class NotFoundError(APIStatusError): + status_code: Literal[404] = 404 # pyright: ignore[reportIncompatibleVariableOverride] + + +class ConflictError(APIStatusError): + status_code: Literal[409] = 409 # pyright: ignore[reportIncompatibleVariableOverride] + + +class UnprocessableEntityError(APIStatusError): + status_code: Literal[422] = 422 # pyright: ignore[reportIncompatibleVariableOverride] + + +class RateLimitError(APIStatusError): + status_code: Literal[429] = 429 # pyright: ignore[reportIncompatibleVariableOverride] + + +class InternalServerError(APIStatusError): + pass diff --git a/src/beeper_desktop_api/_files.py b/src/beeper_desktop_api/_files.py new file mode 100644 index 0000000..be8e0e1 --- /dev/null +++ b/src/beeper_desktop_api/_files.py @@ -0,0 +1,173 @@ +from __future__ import annotations + +import io +import os +import pathlib +from typing import Sequence, cast, overload +from typing_extensions import TypeVar, TypeGuard + +import anyio + +from ._types import ( + FileTypes, + FileContent, + RequestFiles, + HttpxFileTypes, + Base64FileInput, + HttpxFileContent, + HttpxRequestFiles, +) +from ._utils import is_list, is_mapping, is_tuple_t, is_mapping_t, is_sequence_t + +_T = TypeVar("_T") + + +def is_base64_file_input(obj: object) -> TypeGuard[Base64FileInput]: + return isinstance(obj, io.IOBase) or isinstance(obj, os.PathLike) + + +def is_file_content(obj: object) -> TypeGuard[FileContent]: + return ( + isinstance(obj, bytes) or isinstance(obj, tuple) or isinstance(obj, io.IOBase) or isinstance(obj, os.PathLike) + ) + + +def assert_is_file_content(obj: object, *, key: str | None = None) -> None: + if not is_file_content(obj): + prefix = f"Expected entry at `{key}`" if key is not None else f"Expected file input `{obj!r}`" + raise RuntimeError( + f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead. See https://github.com/beeper/desktop-api-python/tree/main#file-uploads" + ) from None + + +@overload +def to_httpx_files(files: None) -> None: ... + + +@overload +def to_httpx_files(files: RequestFiles) -> HttpxRequestFiles: ... + + +def to_httpx_files(files: RequestFiles | None) -> HttpxRequestFiles | None: + if files is None: + return None + + if is_mapping_t(files): + files = {key: _transform_file(file) for key, file in files.items()} + elif is_sequence_t(files): + files = [(key, _transform_file(file)) for key, file in files] + else: + raise TypeError(f"Unexpected file type input {type(files)}, expected mapping or sequence") + + return files + + +def _transform_file(file: FileTypes) -> HttpxFileTypes: + if is_file_content(file): + if isinstance(file, os.PathLike): + path = pathlib.Path(file) + return (path.name, path.read_bytes()) + + return file + + if is_tuple_t(file): + return (file[0], read_file_content(file[1]), *file[2:]) + + raise TypeError(f"Expected file types input to be a FileContent type or to be a tuple") + + +def read_file_content(file: FileContent) -> HttpxFileContent: + if isinstance(file, os.PathLike): + return pathlib.Path(file).read_bytes() + return file + + +@overload +async def async_to_httpx_files(files: None) -> None: ... + + +@overload +async def async_to_httpx_files(files: RequestFiles) -> HttpxRequestFiles: ... + + +async def async_to_httpx_files(files: RequestFiles | None) -> HttpxRequestFiles | None: + if files is None: + return None + + if is_mapping_t(files): + files = {key: await _async_transform_file(file) for key, file in files.items()} + elif is_sequence_t(files): + files = [(key, await _async_transform_file(file)) for key, file in files] + else: + raise TypeError(f"Unexpected file type input {type(files)}, expected mapping or sequence") + + return files + + +async def _async_transform_file(file: FileTypes) -> HttpxFileTypes: + if is_file_content(file): + if isinstance(file, os.PathLike): + path = anyio.Path(file) + return (path.name, await path.read_bytes()) + + return file + + if is_tuple_t(file): + return (file[0], await async_read_file_content(file[1]), *file[2:]) + + raise TypeError(f"Expected file types input to be a FileContent type or to be a tuple") + + +async def async_read_file_content(file: FileContent) -> HttpxFileContent: + if isinstance(file, os.PathLike): + return await anyio.Path(file).read_bytes() + + return file + + +def deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]]) -> _T: + """Copy only the containers along the given paths. + + Used to guard against mutation by extract_files without copying the entire structure. + Only dicts and lists that lie on a path are copied; everything else + is returned by reference. + + For example, given paths=[["foo", "files", "file"]] and the structure: + { + "foo": { + "bar": {"baz": {}}, + "files": {"file": } + } + } + The root dict, "foo", and "files" are copied (they lie on the path). + "bar" and "baz" are returned by reference (off the path). + """ + return _deepcopy_with_paths(item, paths, 0) + + +def _deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]], index: int) -> _T: + if not paths: + return item + if is_mapping(item): + key_to_paths: dict[str, list[Sequence[str]]] = {} + for path in paths: + if index < len(path): + key_to_paths.setdefault(path[index], []).append(path) + + # if no path continues through this mapping, it won't be mutated and copying it is redundant + if not key_to_paths: + return item + + result = dict(item) + for key, subpaths in key_to_paths.items(): + if key in result: + result[key] = _deepcopy_with_paths(result[key], subpaths, index + 1) + return cast(_T, result) + if is_list(item): + array_paths = [path for path in paths if index < len(path) and path[index] == ""] + + # if no path expects a list here, nothing will be mutated inside it - return by reference + if not array_paths: + return cast(_T, item) + return cast(_T, [_deepcopy_with_paths(entry, array_paths, index + 1) for entry in item]) + return item diff --git a/src/beeper_desktop_api/_models.py b/src/beeper_desktop_api/_models.py new file mode 100644 index 0000000..69f41a6 --- /dev/null +++ b/src/beeper_desktop_api/_models.py @@ -0,0 +1,958 @@ +from __future__ import annotations + +import os +import inspect +import weakref +from typing import ( + IO, + TYPE_CHECKING, + Any, + Type, + Union, + Generic, + TypeVar, + Callable, + Iterable, + Optional, + AsyncIterable, + cast, +) +from datetime import date, datetime +from typing_extensions import ( + List, + Unpack, + Literal, + ClassVar, + Protocol, + Required, + Annotated, + ParamSpec, + TypeAlias, + TypedDict, + TypeGuard, + final, + override, + runtime_checkable, +) + +import pydantic +from pydantic.fields import FieldInfo + +from ._types import ( + Body, + IncEx, + Query, + ModelT, + Headers, + Timeout, + NotGiven, + AnyMapping, + HttpxRequestFiles, +) +from ._utils import ( + PropertyInfo, + is_list, + is_given, + json_safe, + lru_cache, + is_mapping, + parse_date, + coerce_boolean, + parse_datetime, + strip_not_given, + extract_type_arg, + is_annotated_type, + is_type_alias_type, + strip_annotated_type, +) +from ._compat import ( + PYDANTIC_V1, + ConfigDict, + GenericModel as BaseGenericModel, + get_args, + is_union, + parse_obj, + get_origin, + is_literal_type, + get_model_config, + get_model_fields, + field_get_default, +) +from ._constants import RAW_RESPONSE_HEADER + +if TYPE_CHECKING: + from pydantic import GetCoreSchemaHandler, ValidatorFunctionWrapHandler + from pydantic_core import CoreSchema, core_schema + from pydantic_core.core_schema import ModelField, ModelSchema, LiteralSchema, ModelFieldsSchema +else: + try: + from pydantic_core import CoreSchema, core_schema + except ImportError: + CoreSchema = None + core_schema = None + +__all__ = ["BaseModel", "GenericModel"] + +_T = TypeVar("_T") +_BaseModelT = TypeVar("_BaseModelT", bound="BaseModel") + +P = ParamSpec("P") + + +@runtime_checkable +class _ConfigProtocol(Protocol): + allow_population_by_field_name: bool + + +class BaseModel(pydantic.BaseModel): + if PYDANTIC_V1: + + @property + @override + def model_fields_set(self) -> set[str]: + # a forwards-compat shim for pydantic v2 + return self.__fields_set__ # type: ignore + + class Config(pydantic.BaseConfig): # pyright: ignore[reportDeprecated] + extra: Any = pydantic.Extra.allow # type: ignore + else: + model_config: ClassVar[ConfigDict] = ConfigDict( + extra="allow", defer_build=coerce_boolean(os.environ.get("DEFER_PYDANTIC_BUILD", "true")) + ) + + def to_dict( + self, + *, + mode: Literal["json", "python"] = "python", + use_api_names: bool = True, + exclude_unset: bool = True, + exclude_defaults: bool = False, + exclude_none: bool = False, + warnings: bool = True, + ) -> dict[str, object]: + """Recursively generate a dictionary representation of the model, optionally specifying which fields to include or exclude. + + By default, fields that were not set by the API will not be included, + and keys will match the API response, *not* the property names from the model. + + For example, if the API responds with `"fooBar": true` but we've defined a `foo_bar: bool` property, + the output will use the `"fooBar"` key (unless `use_api_names=False` is passed). + + Args: + mode: + If mode is 'json', the dictionary will only contain JSON serializable types. e.g. `datetime` will be turned into a string, `"2024-3-22T18:11:19.117000Z"`. + If mode is 'python', the dictionary may contain any Python objects. e.g. `datetime(2024, 3, 22)` + + use_api_names: Whether to use the key that the API responded with or the property name. Defaults to `True`. + exclude_unset: Whether to exclude fields that have not been explicitly set. + exclude_defaults: Whether to exclude fields that are set to their default value from the output. + exclude_none: Whether to exclude fields that have a value of `None` from the output. + warnings: Whether to log warnings when invalid fields are encountered. This is only supported in Pydantic v2. + """ + return self.model_dump( + mode=mode, + by_alias=use_api_names, + exclude_unset=exclude_unset, + exclude_defaults=exclude_defaults, + exclude_none=exclude_none, + warnings=warnings, + ) + + def to_json( + self, + *, + indent: int | None = 2, + use_api_names: bool = True, + exclude_unset: bool = True, + exclude_defaults: bool = False, + exclude_none: bool = False, + warnings: bool = True, + ) -> str: + """Generates a JSON string representing this model as it would be received from or sent to the API (but with indentation). + + By default, fields that were not set by the API will not be included, + and keys will match the API response, *not* the property names from the model. + + For example, if the API responds with `"fooBar": true` but we've defined a `foo_bar: bool` property, + the output will use the `"fooBar"` key (unless `use_api_names=False` is passed). + + Args: + indent: Indentation to use in the JSON output. If `None` is passed, the output will be compact. Defaults to `2` + use_api_names: Whether to use the key that the API responded with or the property name. Defaults to `True`. + exclude_unset: Whether to exclude fields that have not been explicitly set. + exclude_defaults: Whether to exclude fields that have the default value. + exclude_none: Whether to exclude fields that have a value of `None`. + warnings: Whether to show any warnings that occurred during serialization. This is only supported in Pydantic v2. + """ + return self.model_dump_json( + indent=indent, + by_alias=use_api_names, + exclude_unset=exclude_unset, + exclude_defaults=exclude_defaults, + exclude_none=exclude_none, + warnings=warnings, + ) + + @override + def __str__(self) -> str: + # mypy complains about an invalid self arg + return f"{self.__repr_name__()}({self.__repr_str__(', ')})" # type: ignore[misc] + + # Override the 'construct' method in a way that supports recursive parsing without validation. + # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836. + @classmethod + @override + def construct( # pyright: ignore[reportIncompatibleMethodOverride] + __cls: Type[ModelT], + _fields_set: set[str] | None = None, + **values: object, + ) -> ModelT: + m = __cls.__new__(__cls) + fields_values: dict[str, object] = {} + + config = get_model_config(__cls) + populate_by_name = ( + config.allow_population_by_field_name + if isinstance(config, _ConfigProtocol) + else config.get("populate_by_name") + ) + + if _fields_set is None: + _fields_set = set() + + model_fields = get_model_fields(__cls) + for name, field in model_fields.items(): + key = field.alias + if key is None or (key not in values and populate_by_name): + key = name + + if key in values: + fields_values[name] = _construct_field(value=values[key], field=field, key=key) + _fields_set.add(name) + else: + fields_values[name] = field_get_default(field) + + extra_field_type = _get_extra_fields_type(__cls) + + _extra = {} + for key, value in values.items(): + if key not in model_fields: + parsed = construct_type(value=value, type_=extra_field_type) if extra_field_type is not None else value + + if PYDANTIC_V1: + _fields_set.add(key) + fields_values[key] = parsed + else: + _extra[key] = parsed + + object.__setattr__(m, "__dict__", fields_values) + + if PYDANTIC_V1: + # init_private_attributes() does not exist in v2 + m._init_private_attributes() # type: ignore + + # copied from Pydantic v1's `construct()` method + object.__setattr__(m, "__fields_set__", _fields_set) + else: + # these properties are copied from Pydantic's `model_construct()` method + object.__setattr__(m, "__pydantic_private__", None) + object.__setattr__(m, "__pydantic_extra__", _extra) + object.__setattr__(m, "__pydantic_fields_set__", _fields_set) + + return m + + if not TYPE_CHECKING: + # type checkers incorrectly complain about this assignment + # because the type signatures are technically different + # although not in practice + model_construct = construct + + if PYDANTIC_V1: + # we define aliases for some of the new pydantic v2 methods so + # that we can just document these methods without having to specify + # a specific pydantic version as some users may not know which + # pydantic version they are currently using + + @override + def model_dump( + self, + *, + mode: Literal["json", "python"] | str = "python", + include: IncEx | None = None, + exclude: IncEx | None = None, + context: Any | None = None, + by_alias: bool | None = None, + exclude_unset: bool = False, + exclude_defaults: bool = False, + exclude_none: bool = False, + exclude_computed_fields: bool = False, + round_trip: bool = False, + warnings: bool | Literal["none", "warn", "error"] = True, + fallback: Callable[[Any], Any] | None = None, + serialize_as_any: bool = False, + ) -> dict[str, Any]: + """Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump + + Generate a dictionary representation of the model, optionally specifying which fields to include or exclude. + + Args: + mode: The mode in which `to_python` should run. + If mode is 'json', the output will only contain JSON serializable types. + If mode is 'python', the output may contain non-JSON-serializable Python objects. + include: A set of fields to include in the output. + exclude: A set of fields to exclude from the output. + context: Additional context to pass to the serializer. + by_alias: Whether to use the field's alias in the dictionary key if defined. + exclude_unset: Whether to exclude fields that have not been explicitly set. + exclude_defaults: Whether to exclude fields that are set to their default value. + exclude_none: Whether to exclude fields that have a value of `None`. + exclude_computed_fields: Whether to exclude computed fields. + While this can be useful for round-tripping, it is usually recommended to use the dedicated + `round_trip` parameter instead. + round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. + warnings: How to handle serialization errors. False/"none" ignores them, True/"warn" logs errors, + "error" raises a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError]. + fallback: A function to call when an unknown value is encountered. If not provided, + a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError] error is raised. + serialize_as_any: Whether to serialize fields with duck-typing serialization behavior. + + Returns: + A dictionary representation of the model. + """ + if mode not in {"json", "python"}: + raise ValueError("mode must be either 'json' or 'python'") + if round_trip != False: + raise ValueError("round_trip is only supported in Pydantic v2") + if warnings != True: + raise ValueError("warnings is only supported in Pydantic v2") + if context is not None: + raise ValueError("context is only supported in Pydantic v2") + if serialize_as_any != False: + raise ValueError("serialize_as_any is only supported in Pydantic v2") + if fallback is not None: + raise ValueError("fallback is only supported in Pydantic v2") + if exclude_computed_fields != False: + raise ValueError("exclude_computed_fields is only supported in Pydantic v2") + dumped = super().dict( # pyright: ignore[reportDeprecated] + include=include, + exclude=exclude, + by_alias=by_alias if by_alias is not None else False, + exclude_unset=exclude_unset, + exclude_defaults=exclude_defaults, + exclude_none=exclude_none, + ) + + return cast("dict[str, Any]", json_safe(dumped)) if mode == "json" else dumped + + @override + def model_dump_json( + self, + *, + indent: int | None = None, + ensure_ascii: bool = False, + include: IncEx | None = None, + exclude: IncEx | None = None, + context: Any | None = None, + by_alias: bool | None = None, + exclude_unset: bool = False, + exclude_defaults: bool = False, + exclude_none: bool = False, + exclude_computed_fields: bool = False, + round_trip: bool = False, + warnings: bool | Literal["none", "warn", "error"] = True, + fallback: Callable[[Any], Any] | None = None, + serialize_as_any: bool = False, + ) -> str: + """Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump_json + + Generates a JSON representation of the model using Pydantic's `to_json` method. + + Args: + indent: Indentation to use in the JSON output. If None is passed, the output will be compact. + include: Field(s) to include in the JSON output. Can take either a string or set of strings. + exclude: Field(s) to exclude from the JSON output. Can take either a string or set of strings. + by_alias: Whether to serialize using field aliases. + exclude_unset: Whether to exclude fields that have not been explicitly set. + exclude_defaults: Whether to exclude fields that have the default value. + exclude_none: Whether to exclude fields that have a value of `None`. + round_trip: Whether to use serialization/deserialization between JSON and class instance. + warnings: Whether to show any warnings that occurred during serialization. + + Returns: + A JSON string representation of the model. + """ + if round_trip != False: + raise ValueError("round_trip is only supported in Pydantic v2") + if warnings != True: + raise ValueError("warnings is only supported in Pydantic v2") + if context is not None: + raise ValueError("context is only supported in Pydantic v2") + if serialize_as_any != False: + raise ValueError("serialize_as_any is only supported in Pydantic v2") + if fallback is not None: + raise ValueError("fallback is only supported in Pydantic v2") + if ensure_ascii != False: + raise ValueError("ensure_ascii is only supported in Pydantic v2") + if exclude_computed_fields != False: + raise ValueError("exclude_computed_fields is only supported in Pydantic v2") + return super().json( # type: ignore[reportDeprecated] + indent=indent, + include=include, + exclude=exclude, + by_alias=by_alias if by_alias is not None else False, + exclude_unset=exclude_unset, + exclude_defaults=exclude_defaults, + exclude_none=exclude_none, + ) + + +class _EagerIterable(list[_T], Generic[_T]): + """ + Accepts any Iterable[T] input (including generators), consumes it + eagerly, and validates all items upfront. + + Validation preserves the original container type where possible + (e.g. a set[T] stays a set[T]). Serialization (model_dump / JSON) + always emits a list — round-tripping through model_dump() will not + restore the original container type. + """ + + @classmethod + def __get_pydantic_core_schema__( + cls, + source_type: Any, + handler: GetCoreSchemaHandler, + ) -> CoreSchema: + (item_type,) = get_args(source_type) or (Any,) + item_schema: CoreSchema = handler.generate_schema(item_type) + list_of_items_schema: CoreSchema = core_schema.list_schema(item_schema) + + return core_schema.no_info_wrap_validator_function( + cls._validate, + list_of_items_schema, + serialization=core_schema.plain_serializer_function_ser_schema( + cls._serialize, + info_arg=False, + ), + ) + + @staticmethod + def _validate(v: Iterable[_T], handler: "ValidatorFunctionWrapHandler") -> Any: + original_type: type[Any] = type(v) + + # Normalize to list so list_schema can validate each item + if isinstance(v, list): + items: list[_T] = v + else: + try: + items = list(v) + except TypeError as e: + raise TypeError("Value is not iterable") from e + + # Validate items against the inner schema + validated: list[_T] = handler(items) + + # Reconstruct original container type + if original_type is list: + return validated + # str(list) produces the list's repr, not a string built from items, + # so skip reconstruction for str and its subclasses. + if issubclass(original_type, str): + return validated + try: + return original_type(validated) + except (TypeError, ValueError): + # If the type cannot be reconstructed, just return the validated list + return validated + + @staticmethod + def _serialize(v: Iterable[_T]) -> list[_T]: + """Always serialize as a list so Pydantic's JSON encoder is happy.""" + if isinstance(v, list): + return v + return list(v) + + +EagerIterable: TypeAlias = Annotated[Iterable[_T], _EagerIterable] + + +def _construct_field(value: object, field: FieldInfo, key: str) -> object: + if value is None: + return field_get_default(field) + + if PYDANTIC_V1: + type_ = cast(type, field.outer_type_) # type: ignore + else: + type_ = field.annotation # type: ignore + + if type_ is None: + raise RuntimeError(f"Unexpected field type is None for {key}") + + return construct_type(value=value, type_=type_, metadata=getattr(field, "metadata", None)) + + +def _get_extra_fields_type(cls: type[pydantic.BaseModel]) -> type | None: + if PYDANTIC_V1: + # TODO + return None + + schema = cls.__pydantic_core_schema__ + if schema["type"] == "model": + fields = schema["schema"] + if fields["type"] == "model-fields": + extras = fields.get("extras_schema") + if extras and "cls" in extras: + # mypy can't narrow the type + return extras["cls"] # type: ignore[no-any-return] + + return None + + +def is_basemodel(type_: type) -> bool: + """Returns whether or not the given type is either a `BaseModel` or a union of `BaseModel`""" + if is_union(type_): + for variant in get_args(type_): + if is_basemodel(variant): + return True + + return False + + return is_basemodel_type(type_) + + +def is_basemodel_type(type_: type) -> TypeGuard[type[BaseModel] | type[GenericModel]]: + origin = get_origin(type_) or type_ + if not inspect.isclass(origin): + return False + return issubclass(origin, BaseModel) or issubclass(origin, GenericModel) + + +def build( + base_model_cls: Callable[P, _BaseModelT], + *args: P.args, + **kwargs: P.kwargs, +) -> _BaseModelT: + """Construct a BaseModel class without validation. + + This is useful for cases where you need to instantiate a `BaseModel` + from an API response as this provides type-safe params which isn't supported + by helpers like `construct_type()`. + + ```py + build(MyModel, my_field_a="foo", my_field_b=123) + ``` + """ + if args: + raise TypeError( + "Received positional arguments which are not supported; Keyword arguments must be used instead", + ) + + return cast(_BaseModelT, construct_type(type_=base_model_cls, value=kwargs)) + + +def construct_type_unchecked(*, value: object, type_: type[_T]) -> _T: + """Loose coercion to the expected type with construction of nested values. + + Note: the returned value from this function is not guaranteed to match the + given type. + """ + return cast(_T, construct_type(value=value, type_=type_)) + + +def construct_type(*, value: object, type_: object, metadata: Optional[List[Any]] = None) -> object: + """Loose coercion to the expected type with construction of nested values. + + If the given value does not match the expected type then it is returned as-is. + """ + + # store a reference to the original type we were given before we extract any inner + # types so that we can properly resolve forward references in `TypeAliasType` annotations + original_type = None + + # we allow `object` as the input type because otherwise, passing things like + # `Literal['value']` will be reported as a type error by type checkers + type_ = cast("type[object]", type_) + if is_type_alias_type(type_): + original_type = type_ # type: ignore[unreachable] + type_ = type_.__value__ # type: ignore[unreachable] + + # unwrap `Annotated[T, ...]` -> `T` + if metadata is not None and len(metadata) > 0: + meta: tuple[Any, ...] = tuple(metadata) + elif is_annotated_type(type_): + meta = get_args(type_)[1:] + type_ = extract_type_arg(type_, 0) + else: + meta = tuple() + + # we need to use the origin class for any types that are subscripted generics + # e.g. Dict[str, object] + origin = get_origin(type_) or type_ + args = get_args(type_) + + if is_union(origin): + try: + return validate_type(type_=cast("type[object]", original_type or type_), value=value) + except Exception: + pass + + # if the type is a discriminated union then we want to construct the right variant + # in the union, even if the data doesn't match exactly, otherwise we'd break code + # that relies on the constructed class types, e.g. + # + # class FooType: + # kind: Literal['foo'] + # value: str + # + # class BarType: + # kind: Literal['bar'] + # value: int + # + # without this block, if the data we get is something like `{'kind': 'bar', 'value': 'foo'}` then + # we'd end up constructing `FooType` when it should be `BarType`. + discriminator = _build_discriminated_union_meta(union=type_, meta_annotations=meta) + if discriminator and is_mapping(value): + variant_value = value.get(discriminator.field_alias_from or discriminator.field_name) + if variant_value and isinstance(variant_value, str): + variant_type = discriminator.mapping.get(variant_value) + if variant_type: + return construct_type(type_=variant_type, value=value) + + # if the data is not valid, use the first variant that doesn't fail while deserializing + for variant in args: + try: + return construct_type(value=value, type_=variant) + except Exception: + continue + + raise RuntimeError(f"Could not convert data into a valid instance of {type_}") + + if origin == dict: + if not is_mapping(value): + return value + + _, items_type = get_args(type_) # Dict[_, items_type] + return {key: construct_type(value=item, type_=items_type) for key, item in value.items()} + + if ( + not is_literal_type(type_) + and inspect.isclass(origin) + and (issubclass(origin, BaseModel) or issubclass(origin, GenericModel)) + ): + if is_list(value): + return [cast(Any, type_).construct(**entry) if is_mapping(entry) else entry for entry in value] + + if is_mapping(value): + if issubclass(type_, BaseModel): + return type_.construct(**value) # type: ignore[arg-type] + + return cast(Any, type_).construct(**value) + + if origin == list: + if not is_list(value): + return value + + inner_type = args[0] # List[inner_type] + return [construct_type(value=entry, type_=inner_type) for entry in value] + + if origin == float: + if isinstance(value, int): + coerced = float(value) + if coerced != value: + return value + return coerced + + return value + + if type_ == datetime: + try: + return parse_datetime(value) # type: ignore + except Exception: + return value + + if type_ == date: + try: + return parse_date(value) # type: ignore + except Exception: + return value + + return value + + +@runtime_checkable +class CachedDiscriminatorType(Protocol): + __discriminator__: DiscriminatorDetails + + +DISCRIMINATOR_CACHE: weakref.WeakKeyDictionary[type, DiscriminatorDetails] = weakref.WeakKeyDictionary() + + +class DiscriminatorDetails: + field_name: str + """The name of the discriminator field in the variant class, e.g. + + ```py + class Foo(BaseModel): + type: Literal['foo'] + ``` + + Will result in field_name='type' + """ + + field_alias_from: str | None + """The name of the discriminator field in the API response, e.g. + + ```py + class Foo(BaseModel): + type: Literal['foo'] = Field(alias='type_from_api') + ``` + + Will result in field_alias_from='type_from_api' + """ + + mapping: dict[str, type] + """Mapping of discriminator value to variant type, e.g. + + {'foo': FooVariant, 'bar': BarVariant} + """ + + def __init__( + self, + *, + mapping: dict[str, type], + discriminator_field: str, + discriminator_alias: str | None, + ) -> None: + self.mapping = mapping + self.field_name = discriminator_field + self.field_alias_from = discriminator_alias + + +def _build_discriminated_union_meta(*, union: type, meta_annotations: tuple[Any, ...]) -> DiscriminatorDetails | None: + cached = DISCRIMINATOR_CACHE.get(union) + if cached is not None: + return cached + + discriminator_field_name: str | None = None + + for annotation in meta_annotations: + if isinstance(annotation, PropertyInfo) and annotation.discriminator is not None: + discriminator_field_name = annotation.discriminator + break + + if not discriminator_field_name: + return None + + mapping: dict[str, type] = {} + discriminator_alias: str | None = None + + for variant in get_args(union): + variant = strip_annotated_type(variant) + if is_basemodel_type(variant): + if PYDANTIC_V1: + field_info = cast("dict[str, FieldInfo]", variant.__fields__).get(discriminator_field_name) # pyright: ignore[reportDeprecated, reportUnnecessaryCast] + if not field_info: + continue + + # Note: if one variant defines an alias then they all should + discriminator_alias = field_info.alias + + if (annotation := getattr(field_info, "annotation", None)) and is_literal_type(annotation): + for entry in get_args(annotation): + if isinstance(entry, str): + mapping[entry] = variant + else: + field = _extract_field_schema_pv2(variant, discriminator_field_name) + if not field: + continue + + # Note: if one variant defines an alias then they all should + discriminator_alias = field.get("serialization_alias") + + field_schema = field["schema"] + + if field_schema["type"] == "literal": + for entry in cast("LiteralSchema", field_schema)["expected"]: + if isinstance(entry, str): + mapping[entry] = variant + + if not mapping: + return None + + details = DiscriminatorDetails( + mapping=mapping, + discriminator_field=discriminator_field_name, + discriminator_alias=discriminator_alias, + ) + DISCRIMINATOR_CACHE.setdefault(union, details) + return details + + +def _extract_field_schema_pv2(model: type[BaseModel], field_name: str) -> ModelField | None: + schema = model.__pydantic_core_schema__ + if schema["type"] == "definitions": + schema = schema["schema"] + + if schema["type"] != "model": + return None + + schema = cast("ModelSchema", schema) + fields_schema = schema["schema"] + if fields_schema["type"] != "model-fields": + return None + + fields_schema = cast("ModelFieldsSchema", fields_schema) + field = fields_schema["fields"].get(field_name) + if not field: + return None + + return cast("ModelField", field) # pyright: ignore[reportUnnecessaryCast] + + +def validate_type(*, type_: type[_T], value: object) -> _T: + """Strict validation that the given value matches the expected type""" + if inspect.isclass(type_) and issubclass(type_, pydantic.BaseModel): + return cast(_T, parse_obj(type_, value)) + + return cast(_T, _validate_non_model_type(type_=type_, value=value)) + + +def set_pydantic_config(typ: Any, config: pydantic.ConfigDict) -> None: + """Add a pydantic config for the given type. + + Note: this is a no-op on Pydantic v1. + """ + setattr(typ, "__pydantic_config__", config) # noqa: B010 + + +# our use of subclassing here causes weirdness for type checkers, +# so we just pretend that we don't subclass +if TYPE_CHECKING: + GenericModel = BaseModel +else: + + class GenericModel(BaseGenericModel, BaseModel): + pass + + +if not PYDANTIC_V1: + from pydantic import TypeAdapter as _TypeAdapter + + _CachedTypeAdapter = cast("TypeAdapter[object]", lru_cache(maxsize=None)(_TypeAdapter)) + + if TYPE_CHECKING: + from pydantic import TypeAdapter + else: + TypeAdapter = _CachedTypeAdapter + + def _validate_non_model_type(*, type_: type[_T], value: object) -> _T: + return TypeAdapter(type_).validate_python(value) + +elif not TYPE_CHECKING: # TODO: condition is weird + + class RootModel(GenericModel, Generic[_T]): + """Used as a placeholder to easily convert runtime types to a Pydantic format + to provide validation. + + For example: + ```py + validated = RootModel[int](__root__="5").__root__ + # validated: 5 + ``` + """ + + __root__: _T + + def _validate_non_model_type(*, type_: type[_T], value: object) -> _T: + model = _create_pydantic_model(type_).validate(value) + return cast(_T, model.__root__) + + def _create_pydantic_model(type_: _T) -> Type[RootModel[_T]]: + return RootModel[type_] # type: ignore + + +class SecurityOptions(TypedDict, total=False): + bearer_auth: bool + + +class FinalRequestOptionsInput(TypedDict, total=False): + method: Required[str] + url: Required[str] + params: Query + headers: Headers + max_retries: int + timeout: float | Timeout | None + files: HttpxRequestFiles | None + idempotency_key: str + content: Union[bytes, bytearray, IO[bytes], Iterable[bytes], AsyncIterable[bytes], None] + json_data: Body + extra_json: AnyMapping + follow_redirects: bool + security: SecurityOptions + + +@final +class FinalRequestOptions(pydantic.BaseModel): + method: str + url: str + params: Query = {} + headers: Union[Headers, NotGiven] = NotGiven() + max_retries: Union[int, NotGiven] = NotGiven() + timeout: Union[float, Timeout, None, NotGiven] = NotGiven() + files: Union[HttpxRequestFiles, None] = None + idempotency_key: Union[str, None] = None + post_parser: Union[Callable[[Any], Any], NotGiven] = NotGiven() + follow_redirects: Union[bool, None] = None + security: SecurityOptions = {"bearer_auth": True} + + content: Union[bytes, bytearray, IO[bytes], Iterable[bytes], AsyncIterable[bytes], None] = None + # It should be noted that we cannot use `json` here as that would override + # a BaseModel method in an incompatible fashion. + json_data: Union[Body, None] = None + extra_json: Union[AnyMapping, None] = None + + if PYDANTIC_V1: + + class Config(pydantic.BaseConfig): # pyright: ignore[reportDeprecated] + arbitrary_types_allowed: bool = True + else: + model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True) + + def get_max_retries(self, max_retries: int) -> int: + if isinstance(self.max_retries, NotGiven): + return max_retries + return self.max_retries + + def _strip_raw_response_header(self) -> None: + if not is_given(self.headers): + return + + if self.headers.get(RAW_RESPONSE_HEADER): + self.headers = {**self.headers} + self.headers.pop(RAW_RESPONSE_HEADER) + + # override the `construct` method so that we can run custom transformations. + # this is necessary as we don't want to do any actual runtime type checking + # (which means we can't use validators) but we do want to ensure that `NotGiven` + # values are not present + # + # type ignore required because we're adding explicit types to `**values` + @classmethod + def construct( # type: ignore + cls, + _fields_set: set[str] | None = None, + **values: Unpack[FinalRequestOptionsInput], + ) -> FinalRequestOptions: + kwargs: dict[str, Any] = { + # we unconditionally call `strip_not_given` on any value + # as it will just ignore any non-mapping types + key: strip_not_given(value) + for key, value in values.items() + } + if PYDANTIC_V1: + return cast(FinalRequestOptions, super().construct(_fields_set, **kwargs)) # pyright: ignore[reportDeprecated] + return super().model_construct(_fields_set, **kwargs) + + if not TYPE_CHECKING: + # type checkers incorrectly complain about this assignment + model_construct = construct diff --git a/src/beeper_desktop_api/_qs.py b/src/beeper_desktop_api/_qs.py new file mode 100644 index 0000000..4127c19 --- /dev/null +++ b/src/beeper_desktop_api/_qs.py @@ -0,0 +1,149 @@ +from __future__ import annotations + +from typing import Any, List, Tuple, Union, Mapping, TypeVar +from urllib.parse import parse_qs, urlencode +from typing_extensions import get_args + +from ._types import NotGiven, ArrayFormat, NestedFormat, not_given +from ._utils import flatten + +_T = TypeVar("_T") + +PrimitiveData = Union[str, int, float, bool, None] +# this should be Data = Union[PrimitiveData, "List[Data]", "Tuple[Data]", "Mapping[str, Data]"] +# https://github.com/microsoft/pyright/issues/3555 +Data = Union[PrimitiveData, List[Any], Tuple[Any], "Mapping[str, Any]"] +Params = Mapping[str, Data] + + +class Querystring: + array_format: ArrayFormat + nested_format: NestedFormat + + def __init__( + self, + *, + array_format: ArrayFormat = "repeat", + nested_format: NestedFormat = "brackets", + ) -> None: + self.array_format = array_format + self.nested_format = nested_format + + def parse(self, query: str) -> Mapping[str, object]: + # Note: custom format syntax is not supported yet + return parse_qs(query) + + def stringify( + self, + params: Params, + *, + array_format: ArrayFormat | NotGiven = not_given, + nested_format: NestedFormat | NotGiven = not_given, + ) -> str: + return urlencode( + self.stringify_items( + params, + array_format=array_format, + nested_format=nested_format, + ) + ) + + def stringify_items( + self, + params: Params, + *, + array_format: ArrayFormat | NotGiven = not_given, + nested_format: NestedFormat | NotGiven = not_given, + ) -> list[tuple[str, str]]: + opts = Options( + qs=self, + array_format=array_format, + nested_format=nested_format, + ) + return flatten([self._stringify_item(key, value, opts) for key, value in params.items()]) + + def _stringify_item( + self, + key: str, + value: Data, + opts: Options, + ) -> list[tuple[str, str]]: + if isinstance(value, Mapping): + items: list[tuple[str, str]] = [] + nested_format = opts.nested_format + for subkey, subvalue in value.items(): + items.extend( + self._stringify_item( + # TODO: error if unknown format + f"{key}.{subkey}" if nested_format == "dots" else f"{key}[{subkey}]", + subvalue, + opts, + ) + ) + return items + + if isinstance(value, (list, tuple)): + array_format = opts.array_format + if array_format == "comma": + return [ + ( + key, + ",".join(self._primitive_value_to_str(item) for item in value if item is not None), + ), + ] + elif array_format == "repeat": + items = [] + for item in value: + items.extend(self._stringify_item(key, item, opts)) + return items + elif array_format == "indices": + items = [] + for i, item in enumerate(value): + items.extend(self._stringify_item(f"{key}[{i}]", item, opts)) + return items + elif array_format == "brackets": + items = [] + key = key + "[]" + for item in value: + items.extend(self._stringify_item(key, item, opts)) + return items + else: + raise NotImplementedError( + f"Unknown array_format value: {array_format}, choose from {', '.join(get_args(ArrayFormat))}" + ) + + serialised = self._primitive_value_to_str(value) + if not serialised: + return [] + return [(key, serialised)] + + def _primitive_value_to_str(self, value: PrimitiveData) -> str: + # copied from httpx + if value is True: + return "true" + elif value is False: + return "false" + elif value is None: + return "" + return str(value) + + +_qs = Querystring() +parse = _qs.parse +stringify = _qs.stringify +stringify_items = _qs.stringify_items + + +class Options: + array_format: ArrayFormat + nested_format: NestedFormat + + def __init__( + self, + qs: Querystring = _qs, + *, + array_format: ArrayFormat | NotGiven = not_given, + nested_format: NestedFormat | NotGiven = not_given, + ) -> None: + self.array_format = qs.array_format if isinstance(array_format, NotGiven) else array_format + self.nested_format = qs.nested_format if isinstance(nested_format, NotGiven) else nested_format diff --git a/src/beeper_desktop_api/_resource.py b/src/beeper_desktop_api/_resource.py new file mode 100644 index 0000000..3606e7d --- /dev/null +++ b/src/beeper_desktop_api/_resource.py @@ -0,0 +1,43 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import time +from typing import TYPE_CHECKING + +import anyio + +if TYPE_CHECKING: + from ._client import BeeperDesktop, AsyncBeeperDesktop + + +class SyncAPIResource: + _client: BeeperDesktop + + def __init__(self, client: BeeperDesktop) -> None: + self._client = client + self._get = client.get + self._post = client.post + self._patch = client.patch + self._put = client.put + self._delete = client.delete + self._get_api_list = client.get_api_list + + def _sleep(self, seconds: float) -> None: + time.sleep(seconds) + + +class AsyncAPIResource: + _client: AsyncBeeperDesktop + + def __init__(self, client: AsyncBeeperDesktop) -> None: + self._client = client + self._get = client.get + self._post = client.post + self._patch = client.patch + self._put = client.put + self._delete = client.delete + self._get_api_list = client.get_api_list + + async def _sleep(self, seconds: float) -> None: + await anyio.sleep(seconds) diff --git a/src/beeper_desktop_api/_response.py b/src/beeper_desktop_api/_response.py new file mode 100644 index 0000000..a7f1bf9 --- /dev/null +++ b/src/beeper_desktop_api/_response.py @@ -0,0 +1,835 @@ +from __future__ import annotations + +import os +import inspect +import logging +import datetime +import functools +from types import TracebackType +from typing import ( + TYPE_CHECKING, + Any, + Union, + Generic, + TypeVar, + Callable, + Iterator, + AsyncIterator, + cast, + overload, +) +from typing_extensions import Awaitable, ParamSpec, override, get_origin + +import anyio +import httpx +import pydantic + +from ._types import NoneType +from ._utils import is_given, extract_type_arg, is_annotated_type, is_type_alias_type, extract_type_var_from_base +from ._models import BaseModel, is_basemodel +from ._constants import RAW_RESPONSE_HEADER, OVERRIDE_CAST_TO_HEADER +from ._streaming import Stream, AsyncStream, is_stream_class_type, extract_stream_chunk_type +from ._exceptions import BeeperDesktopError, APIResponseValidationError + +if TYPE_CHECKING: + from ._models import FinalRequestOptions + from ._base_client import BaseClient + + +P = ParamSpec("P") +R = TypeVar("R") +_T = TypeVar("_T") +_APIResponseT = TypeVar("_APIResponseT", bound="APIResponse[Any]") +_AsyncAPIResponseT = TypeVar("_AsyncAPIResponseT", bound="AsyncAPIResponse[Any]") + +log: logging.Logger = logging.getLogger(__name__) + + +class BaseAPIResponse(Generic[R]): + _cast_to: type[R] + _client: BaseClient[Any, Any] + _parsed_by_type: dict[type[Any], Any] + _is_sse_stream: bool + _stream_cls: type[Stream[Any]] | type[AsyncStream[Any]] | None + _options: FinalRequestOptions + + http_response: httpx.Response + + retries_taken: int + """The number of retries made. If no retries happened this will be `0`""" + + def __init__( + self, + *, + raw: httpx.Response, + cast_to: type[R], + client: BaseClient[Any, Any], + stream: bool, + stream_cls: type[Stream[Any]] | type[AsyncStream[Any]] | None, + options: FinalRequestOptions, + retries_taken: int = 0, + ) -> None: + self._cast_to = cast_to + self._client = client + self._parsed_by_type = {} + self._is_sse_stream = stream + self._stream_cls = stream_cls + self._options = options + self.http_response = raw + self.retries_taken = retries_taken + + @property + def headers(self) -> httpx.Headers: + return self.http_response.headers + + @property + def http_request(self) -> httpx.Request: + """Returns the httpx Request instance associated with the current response.""" + return self.http_response.request + + @property + def status_code(self) -> int: + return self.http_response.status_code + + @property + def url(self) -> httpx.URL: + """Returns the URL for which the request was made.""" + return self.http_response.url + + @property + def method(self) -> str: + return self.http_request.method + + @property + def http_version(self) -> str: + return self.http_response.http_version + + @property + def elapsed(self) -> datetime.timedelta: + """The time taken for the complete request/response cycle to complete.""" + return self.http_response.elapsed + + @property + def is_closed(self) -> bool: + """Whether or not the response body has been closed. + + If this is False then there is response data that has not been read yet. + You must either fully consume the response body or call `.close()` + before discarding the response to prevent resource leaks. + """ + return self.http_response.is_closed + + @override + def __repr__(self) -> str: + return ( + f"<{self.__class__.__name__} [{self.status_code} {self.http_response.reason_phrase}] type={self._cast_to}>" + ) + + def _parse(self, *, to: type[_T] | None = None) -> R | _T: + cast_to = to if to is not None else self._cast_to + + # unwrap `TypeAlias('Name', T)` -> `T` + if is_type_alias_type(cast_to): + cast_to = cast_to.__value__ # type: ignore[unreachable] + + # unwrap `Annotated[T, ...]` -> `T` + if cast_to and is_annotated_type(cast_to): + cast_to = extract_type_arg(cast_to, 0) + + origin = get_origin(cast_to) or cast_to + + if self._is_sse_stream: + if to: + if not is_stream_class_type(to): + raise TypeError(f"Expected custom parse type to be a subclass of {Stream} or {AsyncStream}") + + return cast( + _T, + to( + cast_to=extract_stream_chunk_type( + to, + failure_message="Expected custom stream type to be passed with a type argument, e.g. Stream[ChunkType]", + ), + response=self.http_response, + client=cast(Any, self._client), + options=self._options, + ), + ) + + if self._stream_cls: + return cast( + R, + self._stream_cls( + cast_to=extract_stream_chunk_type(self._stream_cls), + response=self.http_response, + client=cast(Any, self._client), + options=self._options, + ), + ) + + stream_cls = cast("type[Stream[Any]] | type[AsyncStream[Any]] | None", self._client._default_stream_cls) + if stream_cls is None: + raise MissingStreamClassError() + + return cast( + R, + stream_cls( + cast_to=cast_to, + response=self.http_response, + client=cast(Any, self._client), + options=self._options, + ), + ) + + if cast_to is NoneType: + return cast(R, None) + + response = self.http_response + if cast_to == str: + return cast(R, response.text) + + if cast_to == bytes: + return cast(R, response.content) + + if cast_to == int: + return cast(R, int(response.text)) + + if cast_to == float: + return cast(R, float(response.text)) + + if cast_to == bool: + return cast(R, response.text.lower() == "true") + + if origin == APIResponse: + raise RuntimeError("Unexpected state - cast_to is `APIResponse`") + + if inspect.isclass(origin) and issubclass(origin, httpx.Response): + # Because of the invariance of our ResponseT TypeVar, users can subclass httpx.Response + # and pass that class to our request functions. We cannot change the variance to be either + # covariant or contravariant as that makes our usage of ResponseT illegal. We could construct + # the response class ourselves but that is something that should be supported directly in httpx + # as it would be easy to incorrectly construct the Response object due to the multitude of arguments. + if cast_to != httpx.Response: + raise ValueError(f"Subclasses of httpx.Response cannot be passed to `cast_to`") + return cast(R, response) + + if ( + inspect.isclass( + origin # pyright: ignore[reportUnknownArgumentType] + ) + and not issubclass(origin, BaseModel) + and issubclass(origin, pydantic.BaseModel) + ): + raise TypeError( + "Pydantic models must subclass our base model type, e.g. `from beeper_desktop_api import BaseModel`" + ) + + if ( + cast_to is not object + and not origin is list + and not origin is dict + and not origin is Union + and not issubclass(origin, BaseModel) + ): + raise RuntimeError( + f"Unsupported type, expected {cast_to} to be a subclass of {BaseModel}, {dict}, {list}, {Union}, {NoneType}, {str} or {httpx.Response}." + ) + + # split is required to handle cases where additional information is included + # in the response, e.g. application/json; charset=utf-8 + content_type, *_ = response.headers.get("content-type", "*").split(";") + if not content_type.endswith("json"): + if is_basemodel(cast_to): + try: + data = response.json() + except Exception as exc: + log.debug("Could not read JSON from response data due to %s - %s", type(exc), exc) + else: + return self._client._process_response_data( + data=data, + cast_to=cast_to, # type: ignore + response=response, + ) + + if self._client._strict_response_validation: + raise APIResponseValidationError( + response=response, + message=f"Expected Content-Type response header to be `application/json` but received `{content_type}` instead.", + body=response.text, + ) + + # If the API responds with content that isn't JSON then we just return + # the (decoded) text without performing any parsing so that you can still + # handle the response however you need to. + return response.text # type: ignore + + data = response.json() + + return self._client._process_response_data( + data=data, + cast_to=cast_to, # type: ignore + response=response, + ) + + +class APIResponse(BaseAPIResponse[R]): + @overload + def parse(self, *, to: type[_T]) -> _T: ... + + @overload + def parse(self) -> R: ... + + def parse(self, *, to: type[_T] | None = None) -> R | _T: + """Returns the rich python representation of this response's data. + + For lower-level control, see `.read()`, `.json()`, `.iter_bytes()`. + + You can customise the type that the response is parsed into through + the `to` argument, e.g. + + ```py + from beeper_desktop_api import BaseModel + + + class MyModel(BaseModel): + foo: str + + + obj = response.parse(to=MyModel) + print(obj.foo) + ``` + + We support parsing: + - `BaseModel` + - `dict` + - `list` + - `Union` + - `str` + - `int` + - `float` + - `httpx.Response` + """ + cache_key = to if to is not None else self._cast_to + cached = self._parsed_by_type.get(cache_key) + if cached is not None: + return cached # type: ignore[no-any-return] + + if not self._is_sse_stream: + self.read() + + parsed = self._parse(to=to) + if is_given(self._options.post_parser): + parsed = self._options.post_parser(parsed) + + self._parsed_by_type[cache_key] = parsed + return parsed + + def read(self) -> bytes: + """Read and return the binary response content.""" + try: + return self.http_response.read() + except httpx.StreamConsumed as exc: + # The default error raised by httpx isn't very + # helpful in our case so we re-raise it with + # a different error message. + raise StreamAlreadyConsumed() from exc + + def text(self) -> str: + """Read and decode the response content into a string.""" + self.read() + return self.http_response.text + + def json(self) -> object: + """Read and decode the JSON response content.""" + self.read() + return self.http_response.json() + + def close(self) -> None: + """Close the response and release the connection. + + Automatically called if the response body is read to completion. + """ + self.http_response.close() + + def iter_bytes(self, chunk_size: int | None = None) -> Iterator[bytes]: + """ + A byte-iterator over the decoded response content. + + This automatically handles gzip, deflate and brotli encoded responses. + """ + for chunk in self.http_response.iter_bytes(chunk_size): + yield chunk + + def iter_text(self, chunk_size: int | None = None) -> Iterator[str]: + """A str-iterator over the decoded response content + that handles both gzip, deflate, etc but also detects the content's + string encoding. + """ + for chunk in self.http_response.iter_text(chunk_size): + yield chunk + + def iter_lines(self) -> Iterator[str]: + """Like `iter_text()` but will only yield chunks for each line""" + for chunk in self.http_response.iter_lines(): + yield chunk + + +class AsyncAPIResponse(BaseAPIResponse[R]): + @overload + async def parse(self, *, to: type[_T]) -> _T: ... + + @overload + async def parse(self) -> R: ... + + async def parse(self, *, to: type[_T] | None = None) -> R | _T: + """Returns the rich python representation of this response's data. + + For lower-level control, see `.read()`, `.json()`, `.iter_bytes()`. + + You can customise the type that the response is parsed into through + the `to` argument, e.g. + + ```py + from beeper_desktop_api import BaseModel + + + class MyModel(BaseModel): + foo: str + + + obj = response.parse(to=MyModel) + print(obj.foo) + ``` + + We support parsing: + - `BaseModel` + - `dict` + - `list` + - `Union` + - `str` + - `httpx.Response` + """ + cache_key = to if to is not None else self._cast_to + cached = self._parsed_by_type.get(cache_key) + if cached is not None: + return cached # type: ignore[no-any-return] + + if not self._is_sse_stream: + await self.read() + + parsed = self._parse(to=to) + if is_given(self._options.post_parser): + parsed = self._options.post_parser(parsed) + + self._parsed_by_type[cache_key] = parsed + return parsed + + async def read(self) -> bytes: + """Read and return the binary response content.""" + try: + return await self.http_response.aread() + except httpx.StreamConsumed as exc: + # the default error raised by httpx isn't very + # helpful in our case so we re-raise it with + # a different error message + raise StreamAlreadyConsumed() from exc + + async def text(self) -> str: + """Read and decode the response content into a string.""" + await self.read() + return self.http_response.text + + async def json(self) -> object: + """Read and decode the JSON response content.""" + await self.read() + return self.http_response.json() + + async def close(self) -> None: + """Close the response and release the connection. + + Automatically called if the response body is read to completion. + """ + await self.http_response.aclose() + + async def iter_bytes(self, chunk_size: int | None = None) -> AsyncIterator[bytes]: + """ + A byte-iterator over the decoded response content. + + This automatically handles gzip, deflate and brotli encoded responses. + """ + async for chunk in self.http_response.aiter_bytes(chunk_size): + yield chunk + + async def iter_text(self, chunk_size: int | None = None) -> AsyncIterator[str]: + """A str-iterator over the decoded response content + that handles both gzip, deflate, etc but also detects the content's + string encoding. + """ + async for chunk in self.http_response.aiter_text(chunk_size): + yield chunk + + async def iter_lines(self) -> AsyncIterator[str]: + """Like `iter_text()` but will only yield chunks for each line""" + async for chunk in self.http_response.aiter_lines(): + yield chunk + + +class BinaryAPIResponse(APIResponse[bytes]): + """Subclass of APIResponse providing helpers for dealing with binary data. + + Note: If you want to stream the response data instead of eagerly reading it + all at once then you should use `.with_streaming_response` when making + the API request, e.g. `.with_streaming_response.get_binary_response()` + """ + + def write_to_file( + self, + file: str | os.PathLike[str], + ) -> None: + """Write the output to the given file. + + Accepts a filename or any path-like object, e.g. pathlib.Path + + Note: if you want to stream the data to the file instead of writing + all at once then you should use `.with_streaming_response` when making + the API request, e.g. `.with_streaming_response.get_binary_response()` + """ + with open(file, mode="wb") as f: + for data in self.iter_bytes(): + f.write(data) + + +class AsyncBinaryAPIResponse(AsyncAPIResponse[bytes]): + """Subclass of APIResponse providing helpers for dealing with binary data. + + Note: If you want to stream the response data instead of eagerly reading it + all at once then you should use `.with_streaming_response` when making + the API request, e.g. `.with_streaming_response.get_binary_response()` + """ + + async def write_to_file( + self, + file: str | os.PathLike[str], + ) -> None: + """Write the output to the given file. + + Accepts a filename or any path-like object, e.g. pathlib.Path + + Note: if you want to stream the data to the file instead of writing + all at once then you should use `.with_streaming_response` when making + the API request, e.g. `.with_streaming_response.get_binary_response()` + """ + path = anyio.Path(file) + async with await path.open(mode="wb") as f: + async for data in self.iter_bytes(): + await f.write(data) + + +class StreamedBinaryAPIResponse(APIResponse[bytes]): + def stream_to_file( + self, + file: str | os.PathLike[str], + *, + chunk_size: int | None = None, + ) -> None: + """Streams the output to the given file. + + Accepts a filename or any path-like object, e.g. pathlib.Path + """ + with open(file, mode="wb") as f: + for data in self.iter_bytes(chunk_size): + f.write(data) + + +class AsyncStreamedBinaryAPIResponse(AsyncAPIResponse[bytes]): + async def stream_to_file( + self, + file: str | os.PathLike[str], + *, + chunk_size: int | None = None, + ) -> None: + """Streams the output to the given file. + + Accepts a filename or any path-like object, e.g. pathlib.Path + """ + path = anyio.Path(file) + async with await path.open(mode="wb") as f: + async for data in self.iter_bytes(chunk_size): + await f.write(data) + + +class MissingStreamClassError(TypeError): + def __init__(self) -> None: + super().__init__( + "The `stream` argument was set to `True` but the `stream_cls` argument was not given. See `beeper_desktop_api._streaming` for reference", + ) + + +class StreamAlreadyConsumed(BeeperDesktopError): + """ + Attempted to read or stream content, but the content has already + been streamed. + + This can happen if you use a method like `.iter_lines()` and then attempt + to read th entire response body afterwards, e.g. + + ```py + response = await client.post(...) + async for line in response.iter_lines(): + ... # do something with `line` + + content = await response.read() + # ^ error + ``` + + If you want this behaviour you'll need to either manually accumulate the response + content or call `await response.read()` before iterating over the stream. + """ + + def __init__(self) -> None: + message = ( + "Attempted to read or stream some content, but the content has " + "already been streamed. " + "This could be due to attempting to stream the response " + "content more than once." + "\n\n" + "You can fix this by manually accumulating the response content while streaming " + "or by calling `.read()` before starting to stream." + ) + super().__init__(message) + + +class ResponseContextManager(Generic[_APIResponseT]): + """Context manager for ensuring that a request is not made + until it is entered and that the response will always be closed + when the context manager exits + """ + + def __init__(self, request_func: Callable[[], _APIResponseT]) -> None: + self._request_func = request_func + self.__response: _APIResponseT | None = None + + def __enter__(self) -> _APIResponseT: + self.__response = self._request_func() + return self.__response + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + if self.__response is not None: + self.__response.close() + + +class AsyncResponseContextManager(Generic[_AsyncAPIResponseT]): + """Context manager for ensuring that a request is not made + until it is entered and that the response will always be closed + when the context manager exits + """ + + def __init__(self, api_request: Awaitable[_AsyncAPIResponseT]) -> None: + self._api_request = api_request + self.__response: _AsyncAPIResponseT | None = None + + async def __aenter__(self) -> _AsyncAPIResponseT: + self.__response = await self._api_request + return self.__response + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + if self.__response is not None: + await self.__response.close() + + +def to_streamed_response_wrapper(func: Callable[P, R]) -> Callable[P, ResponseContextManager[APIResponse[R]]]: + """Higher order function that takes one of our bound API methods and wraps it + to support streaming and returning the raw `APIResponse` object directly. + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> ResponseContextManager[APIResponse[R]]: + extra_headers: dict[str, str] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "stream" + + kwargs["extra_headers"] = extra_headers + + make_request = functools.partial(func, *args, **kwargs) + + return ResponseContextManager(cast(Callable[[], APIResponse[R]], make_request)) + + return wrapped + + +def async_to_streamed_response_wrapper( + func: Callable[P, Awaitable[R]], +) -> Callable[P, AsyncResponseContextManager[AsyncAPIResponse[R]]]: + """Higher order function that takes one of our bound API methods and wraps it + to support streaming and returning the raw `APIResponse` object directly. + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> AsyncResponseContextManager[AsyncAPIResponse[R]]: + extra_headers: dict[str, str] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "stream" + + kwargs["extra_headers"] = extra_headers + + make_request = func(*args, **kwargs) + + return AsyncResponseContextManager(cast(Awaitable[AsyncAPIResponse[R]], make_request)) + + return wrapped + + +def to_custom_streamed_response_wrapper( + func: Callable[P, object], + response_cls: type[_APIResponseT], +) -> Callable[P, ResponseContextManager[_APIResponseT]]: + """Higher order function that takes one of our bound API methods and an `APIResponse` class + and wraps the method to support streaming and returning the given response class directly. + + Note: the given `response_cls` *must* be concrete, e.g. `class BinaryAPIResponse(APIResponse[bytes])` + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> ResponseContextManager[_APIResponseT]: + extra_headers: dict[str, Any] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "stream" + extra_headers[OVERRIDE_CAST_TO_HEADER] = response_cls + + kwargs["extra_headers"] = extra_headers + + make_request = functools.partial(func, *args, **kwargs) + + return ResponseContextManager(cast(Callable[[], _APIResponseT], make_request)) + + return wrapped + + +def async_to_custom_streamed_response_wrapper( + func: Callable[P, Awaitable[object]], + response_cls: type[_AsyncAPIResponseT], +) -> Callable[P, AsyncResponseContextManager[_AsyncAPIResponseT]]: + """Higher order function that takes one of our bound API methods and an `APIResponse` class + and wraps the method to support streaming and returning the given response class directly. + + Note: the given `response_cls` *must* be concrete, e.g. `class BinaryAPIResponse(APIResponse[bytes])` + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> AsyncResponseContextManager[_AsyncAPIResponseT]: + extra_headers: dict[str, Any] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "stream" + extra_headers[OVERRIDE_CAST_TO_HEADER] = response_cls + + kwargs["extra_headers"] = extra_headers + + make_request = func(*args, **kwargs) + + return AsyncResponseContextManager(cast(Awaitable[_AsyncAPIResponseT], make_request)) + + return wrapped + + +def to_raw_response_wrapper(func: Callable[P, R]) -> Callable[P, APIResponse[R]]: + """Higher order function that takes one of our bound API methods and wraps it + to support returning the raw `APIResponse` object directly. + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> APIResponse[R]: + extra_headers: dict[str, str] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "raw" + + kwargs["extra_headers"] = extra_headers + + return cast(APIResponse[R], func(*args, **kwargs)) + + return wrapped + + +def async_to_raw_response_wrapper(func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[AsyncAPIResponse[R]]]: + """Higher order function that takes one of our bound API methods and wraps it + to support returning the raw `APIResponse` object directly. + """ + + @functools.wraps(func) + async def wrapped(*args: P.args, **kwargs: P.kwargs) -> AsyncAPIResponse[R]: + extra_headers: dict[str, str] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "raw" + + kwargs["extra_headers"] = extra_headers + + return cast(AsyncAPIResponse[R], await func(*args, **kwargs)) + + return wrapped + + +def to_custom_raw_response_wrapper( + func: Callable[P, object], + response_cls: type[_APIResponseT], +) -> Callable[P, _APIResponseT]: + """Higher order function that takes one of our bound API methods and an `APIResponse` class + and wraps the method to support returning the given response class directly. + + Note: the given `response_cls` *must* be concrete, e.g. `class BinaryAPIResponse(APIResponse[bytes])` + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> _APIResponseT: + extra_headers: dict[str, Any] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "raw" + extra_headers[OVERRIDE_CAST_TO_HEADER] = response_cls + + kwargs["extra_headers"] = extra_headers + + return cast(_APIResponseT, func(*args, **kwargs)) + + return wrapped + + +def async_to_custom_raw_response_wrapper( + func: Callable[P, Awaitable[object]], + response_cls: type[_AsyncAPIResponseT], +) -> Callable[P, Awaitable[_AsyncAPIResponseT]]: + """Higher order function that takes one of our bound API methods and an `APIResponse` class + and wraps the method to support returning the given response class directly. + + Note: the given `response_cls` *must* be concrete, e.g. `class BinaryAPIResponse(APIResponse[bytes])` + """ + + @functools.wraps(func) + def wrapped(*args: P.args, **kwargs: P.kwargs) -> Awaitable[_AsyncAPIResponseT]: + extra_headers: dict[str, Any] = {**(cast(Any, kwargs.get("extra_headers")) or {})} + extra_headers[RAW_RESPONSE_HEADER] = "raw" + extra_headers[OVERRIDE_CAST_TO_HEADER] = response_cls + + kwargs["extra_headers"] = extra_headers + + return cast(Awaitable[_AsyncAPIResponseT], func(*args, **kwargs)) + + return wrapped + + +def extract_response_type(typ: type[BaseAPIResponse[Any]]) -> type: + """Given a type like `APIResponse[T]`, returns the generic type variable `T`. + + This also handles the case where a concrete subclass is given, e.g. + ```py + class MyResponse(APIResponse[bytes]): + ... + + extract_response_type(MyResponse) -> bytes + ``` + """ + return extract_type_var_from_base( + typ, + generic_bases=cast("tuple[type, ...]", (BaseAPIResponse, APIResponse, AsyncAPIResponse)), + index=0, + ) diff --git a/src/beeper_desktop_api/_streaming.py b/src/beeper_desktop_api/_streaming.py new file mode 100644 index 0000000..be797cc --- /dev/null +++ b/src/beeper_desktop_api/_streaming.py @@ -0,0 +1,338 @@ +# Note: initially copied from https://github.com/florimondmanca/httpx-sse/blob/master/src/httpx_sse/_decoders.py +from __future__ import annotations + +import json +import inspect +from types import TracebackType +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 + +from ._utils import extract_type_var_from_base + +if TYPE_CHECKING: + from ._client import BeeperDesktop, AsyncBeeperDesktop + from ._models import FinalRequestOptions + + +_T = TypeVar("_T") + + +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__( + self, + *, + 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__() + + def __next__(self) -> _T: + return self._iterator.__next__() + + def __iter__(self) -> Iterator[_T]: + for item in self._iterator: + yield item + + def _iter_events(self) -> Iterator[ServerSentEvent]: + yield from self._decoder.iter_bytes(self.response.iter_bytes()) + + def __stream__(self) -> Iterator[_T]: + cast_to = cast(Any, self._cast_to) + response = self.response + process_data = self._client._process_response_data + iterator = self._iter_events() + + try: + for sse in iterator: + yield process_data(data=sse.json(), cast_to=cast_to, response=response) + finally: + # Ensure the response is closed even if the consumer doesn't read all data + response.close() + + def __enter__(self) -> Self: + return self + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + self.close() + + def close(self) -> None: + """ + Close the response and release the connection. + + Automatically called if the response body is read to completion. + """ + self.response.close() + + +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__( + self, + *, + 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__() + + async def __anext__(self) -> _T: + return await self._iterator.__anext__() + + async def __aiter__(self) -> AsyncIterator[_T]: + async for item in self._iterator: + yield item + + async def _iter_events(self) -> AsyncIterator[ServerSentEvent]: + async for sse in self._decoder.aiter_bytes(self.response.aiter_bytes()): + yield sse + + async def __stream__(self) -> AsyncIterator[_T]: + cast_to = cast(Any, self._cast_to) + response = self.response + process_data = self._client._process_response_data + iterator = self._iter_events() + + try: + async for sse in iterator: + yield process_data(data=sse.json(), cast_to=cast_to, response=response) + finally: + # Ensure the response is closed even if the consumer doesn't read all data + await response.aclose() + + async def __aenter__(self) -> Self: + return self + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + exc_tb: TracebackType | None, + ) -> None: + await self.close() + + async def close(self) -> None: + """ + Close the response and release the connection. + + Automatically called if the response body is read to completion. + """ + await self.response.aclose() + + +class ServerSentEvent: + def __init__( + self, + *, + event: str | None = None, + data: str | None = None, + id: str | None = None, + retry: int | None = None, + ) -> None: + if data is None: + data = "" + + self._id = id + self._data = data + self._event = event or None + self._retry = retry + + @property + def event(self) -> str | None: + return self._event + + @property + def id(self) -> str | None: + return self._id + + @property + def retry(self) -> int | None: + return self._retry + + @property + def data(self) -> str: + return self._data + + def json(self) -> Any: + return json.loads(self.data) + + @override + def __repr__(self) -> str: + return f"ServerSentEvent(event={self.event}, data={self.data}, id={self.id}, retry={self.retry})" + + +class SSEDecoder: + _data: list[str] + _event: str | None + _retry: int | None + _last_event_id: str | None + + def __init__(self) -> None: + self._event = None + self._data = [] + self._last_event_id = None + self._retry = None + + def iter_bytes(self, iterator: Iterator[bytes]) -> Iterator[ServerSentEvent]: + """Given an iterator that yields raw binary data, iterate over it & yield every event encountered""" + for chunk in self._iter_chunks(iterator): + # Split before decoding so splitlines() only uses \r and \n + for raw_line in chunk.splitlines(): + line = raw_line.decode("utf-8") + sse = self.decode(line) + if sse: + yield sse + + def _iter_chunks(self, iterator: Iterator[bytes]) -> Iterator[bytes]: + """Given an iterator that yields raw binary data, iterate over it and yield individual SSE chunks""" + data = b"" + for chunk in iterator: + for line in chunk.splitlines(keepends=True): + data += line + if data.endswith((b"\r\r", b"\n\n", b"\r\n\r\n")): + yield data + data = b"" + if data: + yield data + + async def aiter_bytes(self, iterator: AsyncIterator[bytes]) -> AsyncIterator[ServerSentEvent]: + """Given an iterator that yields raw binary data, iterate over it & yield every event encountered""" + async for chunk in self._aiter_chunks(iterator): + # Split before decoding so splitlines() only uses \r and \n + for raw_line in chunk.splitlines(): + line = raw_line.decode("utf-8") + sse = self.decode(line) + if sse: + yield sse + + async def _aiter_chunks(self, iterator: AsyncIterator[bytes]) -> AsyncIterator[bytes]: + """Given an iterator that yields raw binary data, iterate over it and yield individual SSE chunks""" + data = b"" + async for chunk in iterator: + for line in chunk.splitlines(keepends=True): + data += line + if data.endswith((b"\r\r", b"\n\n", b"\r\n\r\n")): + yield data + data = b"" + if data: + yield data + + def decode(self, line: str) -> ServerSentEvent | None: + # See: https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation # noqa: E501 + + if not line: + if not self._event and not self._data and not self._last_event_id and self._retry is None: + return None + + sse = ServerSentEvent( + event=self._event, + data="\n".join(self._data), + id=self._last_event_id, + retry=self._retry, + ) + + # NOTE: as per the SSE spec, do not reset last_event_id. + self._event = None + self._data = [] + self._retry = None + + return sse + + if line.startswith(":"): + return None + + fieldname, _, value = line.partition(":") + + if value.startswith(" "): + value = value[1:] + + if fieldname == "event": + self._event = value + elif fieldname == "data": + self._data.append(value) + elif fieldname == "id": + if "\0" in value: + pass + else: + self._last_event_id = value + elif fieldname == "retry": + try: + self._retry = int(value) + except (TypeError, ValueError): + pass + else: + pass # Field is ignored. + + return None + + +@runtime_checkable +class SSEBytesDecoder(Protocol): + def iter_bytes(self, iterator: Iterator[bytes]) -> Iterator[ServerSentEvent]: + """Given an iterator that yields raw binary data, iterate over it & yield every event encountered""" + ... + + def aiter_bytes(self, iterator: AsyncIterator[bytes]) -> AsyncIterator[ServerSentEvent]: + """Given an async iterator that yields raw binary data, iterate over it & yield every event encountered""" + ... + + +def is_stream_class_type(typ: type) -> TypeGuard[type[Stream[object]] | type[AsyncStream[object]]]: + """TypeGuard for determining whether or not the given type is a subclass of `Stream` / `AsyncStream`""" + origin = get_origin(typ) or typ + return inspect.isclass(origin) and issubclass(origin, (Stream, AsyncStream)) + + +def extract_stream_chunk_type( + stream_cls: type, + *, + failure_message: str | None = None, +) -> type: + """Given a type like `Stream[T]`, returns the generic type variable `T`. + + This also handles the case where a concrete subclass is given, e.g. + ```py + class MyStream(Stream[bytes]): + ... + + extract_stream_chunk_type(MyStream) -> bytes + ``` + """ + from ._base_client import Stream, AsyncStream + + return extract_type_var_from_base( + stream_cls, + index=0, + generic_bases=cast("tuple[type, ...]", (Stream, AsyncStream)), + failure_message=failure_message, + ) diff --git a/src/beeper_desktop_api/_types.py b/src/beeper_desktop_api/_types.py new file mode 100644 index 0000000..a131d99 --- /dev/null +++ b/src/beeper_desktop_api/_types.py @@ -0,0 +1,274 @@ +from __future__ import annotations + +from os import PathLike +from typing import ( + IO, + TYPE_CHECKING, + Any, + Dict, + List, + Type, + Tuple, + Union, + Mapping, + TypeVar, + Callable, + Iterable, + Iterator, + Optional, + Sequence, + AsyncIterable, +) +from typing_extensions import ( + Set, + Literal, + Protocol, + TypeAlias, + TypedDict, + SupportsIndex, + overload, + override, + runtime_checkable, +) + +import httpx +import pydantic +from httpx import URL, Proxy, Timeout, Response, BaseTransport, AsyncBaseTransport + +if TYPE_CHECKING: + from ._models import BaseModel, SecurityOptions + from ._response import APIResponse, AsyncAPIResponse + +Transport = BaseTransport +AsyncTransport = AsyncBaseTransport +Query = Mapping[str, object] +Body = object +AnyMapping = Mapping[str, object] +ModelT = TypeVar("ModelT", bound=pydantic.BaseModel) +_T = TypeVar("_T") + +ArrayFormat = Literal["comma", "repeat", "indices", "brackets"] +NestedFormat = Literal["dots", "brackets"] + + +# Approximates httpx internal ProxiesTypes and RequestFiles types +# while adding support for `PathLike` instances +ProxiesDict = Dict["str | URL", Union[None, str, URL, Proxy]] +ProxiesTypes = Union[str, Proxy, ProxiesDict] +if TYPE_CHECKING: + Base64FileInput = Union[IO[bytes], PathLike[str]] + FileContent = Union[IO[bytes], bytes, PathLike[str]] +else: + Base64FileInput = Union[IO[bytes], PathLike] + FileContent = Union[IO[bytes], bytes, PathLike] # PathLike is not subscriptable in Python 3.8. + + +# Used for sending raw binary data / streaming data in request bodies +# e.g. for file uploads without multipart encoding +BinaryTypes = Union[bytes, bytearray, IO[bytes], Iterable[bytes]] +AsyncBinaryTypes = Union[bytes, bytearray, IO[bytes], AsyncIterable[bytes]] + +FileTypes = Union[ + # file (or bytes) + FileContent, + # (filename, file (or bytes)) + Tuple[Optional[str], FileContent], + # (filename, file (or bytes), content_type) + Tuple[Optional[str], FileContent, Optional[str]], + # (filename, file (or bytes), content_type, headers) + Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], +] +RequestFiles = Union[Mapping[str, FileTypes], Sequence[Tuple[str, FileTypes]]] + +# duplicate of the above but without our custom file support +HttpxFileContent = Union[IO[bytes], bytes] +HttpxFileTypes = Union[ + # file (or bytes) + HttpxFileContent, + # (filename, file (or bytes)) + Tuple[Optional[str], HttpxFileContent], + # (filename, file (or bytes), content_type) + Tuple[Optional[str], HttpxFileContent, Optional[str]], + # (filename, file (or bytes), content_type, headers) + Tuple[Optional[str], HttpxFileContent, Optional[str], Mapping[str, str]], +] +HttpxRequestFiles = Union[Mapping[str, HttpxFileTypes], Sequence[Tuple[str, HttpxFileTypes]]] + +# Workaround to support (cast_to: Type[ResponseT]) -> ResponseT +# where ResponseT includes `None`. In order to support directly +# passing `None`, overloads would have to be defined for every +# method that uses `ResponseT` which would lead to an unacceptable +# amount of code duplication and make it unreadable. See _base_client.py +# for example usage. +# +# This unfortunately means that you will either have +# to import this type and pass it explicitly: +# +# from beeper_desktop_api import NoneType +# client.get('/foo', cast_to=NoneType) +# +# or build it yourself: +# +# client.get('/foo', cast_to=type(None)) +if TYPE_CHECKING: + NoneType: Type[None] +else: + NoneType = type(None) + + +class RequestOptions(TypedDict, total=False): + headers: Headers + max_retries: int + timeout: float | Timeout | None + params: Query + extra_json: AnyMapping + idempotency_key: str + follow_redirects: bool + security: SecurityOptions + + +# Sentinel class used until PEP 0661 is accepted +class NotGiven: + """ + For parameters with a meaningful None value, we need to distinguish between + the user explicitly passing None, and the user not passing the parameter at + all. + + User code shouldn't need to use not_given directly. + + For example: + + ```py + def create(timeout: Timeout | None | NotGiven = not_given): ... + + + create(timeout=1) # 1s timeout + create(timeout=None) # No timeout + create() # Default timeout behavior + ``` + """ + + def __bool__(self) -> Literal[False]: + return False + + @override + def __repr__(self) -> str: + return "NOT_GIVEN" + + +not_given = NotGiven() +# for backwards compatibility: +NOT_GIVEN = NotGiven() + + +class Omit: + """ + To explicitly omit something from being sent in a request, use `omit`. + + ```py + # as the default `Content-Type` header is `application/json` that will be sent + client.post("/upload/files", files={"file": b"my raw file content"}) + + # you can't explicitly override the header as it has to be dynamically generated + # to look something like: 'multipart/form-data; boundary=0d8382fcf5f8c3be01ca2e11002d2983' + client.post(..., headers={"Content-Type": "multipart/form-data"}) + + # instead you can remove the default `application/json` header by passing omit + client.post(..., headers={"Content-Type": omit}) + ``` + """ + + def __bool__(self) -> Literal[False]: + return False + + +omit = Omit() + + +@runtime_checkable +class ModelBuilderProtocol(Protocol): + @classmethod + def build( + cls: type[_T], + *, + response: Response, + data: object, + ) -> _T: ... + + +Headers = Mapping[str, Union[str, Omit]] + + +class HeadersLikeProtocol(Protocol): + def get(self, __key: str) -> str | None: ... + + +HeadersLike = Union[Headers, HeadersLikeProtocol] + +ResponseT = TypeVar( + "ResponseT", + bound=Union[ + object, + str, + None, + "BaseModel", + List[Any], + Dict[str, Any], + Response, + ModelBuilderProtocol, + "APIResponse[Any]", + "AsyncAPIResponse[Any]", + ], +) + +StrBytesIntFloat = Union[str, bytes, int, float] + +# Note: copied from Pydantic +# https://github.com/pydantic/pydantic/blob/6f31f8f68ef011f84357330186f603ff295312fd/pydantic/main.py#L79 +IncEx: TypeAlias = Union[Set[int], Set[str], Mapping[int, Union["IncEx", bool]], Mapping[str, Union["IncEx", bool]]] + +PostParser = Callable[[Any], Any] + + +@runtime_checkable +class InheritsGeneric(Protocol): + """Represents a type that has inherited from `Generic` + + The `__orig_bases__` property can be used to determine the resolved + type variable for a given base class. + """ + + __orig_bases__: tuple[_GenericAlias] + + +class _GenericAlias(Protocol): + __origin__: type[object] + + +class HttpxSendArgs(TypedDict, total=False): + auth: httpx.Auth + follow_redirects: bool + + +_T_co = TypeVar("_T_co", covariant=True) + + +if TYPE_CHECKING: + # This works because str.__contains__ does not accept object (either in typeshed or at runtime) + # https://github.com/hauntsaninja/useful_types/blob/5e9710f3875107d068e7679fd7fec9cfab0eff3b/useful_types/__init__.py#L285 + # + # Note: index() and count() methods are intentionally omitted to allow pyright to properly + # infer TypedDict types when dict literals are used in lists assigned to SequenceNotStr. + class SequenceNotStr(Protocol[_T_co]): + @overload + def __getitem__(self, index: SupportsIndex, /) -> _T_co: ... + @overload + def __getitem__(self, index: slice, /) -> Sequence[_T_co]: ... + def __contains__(self, value: object, /) -> bool: ... + def __len__(self) -> int: ... + def __iter__(self) -> Iterator[_T_co]: ... + def __reversed__(self) -> Iterator[_T_co]: ... +else: + # just point this to a normal `Sequence` at runtime to avoid having to special case + # deserializing our custom sequence type + SequenceNotStr = Sequence diff --git a/src/beeper_desktop_api/_utils/__init__.py b/src/beeper_desktop_api/_utils/__init__.py new file mode 100644 index 0000000..1c090e5 --- /dev/null +++ b/src/beeper_desktop_api/_utils/__init__.py @@ -0,0 +1,64 @@ +from ._path import path_template as path_template +from ._sync import asyncify as asyncify +from ._proxy import LazyProxy as LazyProxy +from ._utils import ( + flatten as flatten, + is_dict as is_dict, + is_list as is_list, + is_given as is_given, + is_tuple as is_tuple, + json_safe as json_safe, + lru_cache as lru_cache, + is_mapping as is_mapping, + is_tuple_t as is_tuple_t, + is_iterable as is_iterable, + is_sequence as is_sequence, + coerce_float as coerce_float, + is_mapping_t as is_mapping_t, + removeprefix as removeprefix, + removesuffix as removesuffix, + extract_files as extract_files, + is_sequence_t as is_sequence_t, + required_args as required_args, + coerce_boolean as coerce_boolean, + coerce_integer as coerce_integer, + file_from_path as file_from_path, + strip_not_given as strip_not_given, + get_async_library as get_async_library, + maybe_coerce_float as maybe_coerce_float, + get_required_header as get_required_header, + maybe_coerce_boolean as maybe_coerce_boolean, + maybe_coerce_integer as maybe_coerce_integer, +) +from ._compat import ( + get_args as get_args, + is_union as is_union, + get_origin as get_origin, + is_typeddict as is_typeddict, + is_literal_type as is_literal_type, +) +from ._typing import ( + is_list_type as is_list_type, + is_union_type as is_union_type, + extract_type_arg as extract_type_arg, + is_iterable_type as is_iterable_type, + is_required_type as is_required_type, + is_sequence_type as is_sequence_type, + is_annotated_type as is_annotated_type, + is_type_alias_type as is_type_alias_type, + strip_annotated_type as strip_annotated_type, + extract_type_var_from_base as extract_type_var_from_base, +) +from ._streams import consume_sync_iterator as consume_sync_iterator, consume_async_iterator as consume_async_iterator +from ._transform import ( + PropertyInfo as PropertyInfo, + transform as transform, + async_transform as async_transform, + maybe_transform as maybe_transform, + async_maybe_transform as async_maybe_transform, +) +from ._reflection import ( + function_has_argument as function_has_argument, + assert_signatures_in_sync as assert_signatures_in_sync, +) +from ._datetime_parse import parse_date as parse_date, parse_datetime as parse_datetime diff --git a/src/beeper_desktop_api/_utils/_compat.py b/src/beeper_desktop_api/_utils/_compat.py new file mode 100644 index 0000000..2c70b29 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_compat.py @@ -0,0 +1,45 @@ +from __future__ import annotations + +import sys +import typing_extensions +from typing import Any, Type, Union, Literal, Optional +from datetime import date, datetime +from typing_extensions import get_args as _get_args, get_origin as _get_origin + +from .._types import StrBytesIntFloat +from ._datetime_parse import parse_date as _parse_date, parse_datetime as _parse_datetime + +_LITERAL_TYPES = {Literal, typing_extensions.Literal} + + +def get_args(tp: type[Any]) -> tuple[Any, ...]: + return _get_args(tp) + + +def get_origin(tp: type[Any]) -> type[Any] | None: + return _get_origin(tp) + + +def is_union(tp: Optional[Type[Any]]) -> bool: + if sys.version_info < (3, 10): + return tp is Union # type: ignore[comparison-overlap] + else: + import types + + return tp is Union or tp is types.UnionType # type: ignore[comparison-overlap] + + +def is_typeddict(tp: Type[Any]) -> bool: + return typing_extensions.is_typeddict(tp) + + +def is_literal_type(tp: Type[Any]) -> bool: + return get_origin(tp) in _LITERAL_TYPES + + +def parse_date(value: Union[date, StrBytesIntFloat]) -> date: + return _parse_date(value) + + +def parse_datetime(value: Union[datetime, StrBytesIntFloat]) -> datetime: + return _parse_datetime(value) diff --git a/src/beeper_desktop_api/_utils/_datetime_parse.py b/src/beeper_desktop_api/_utils/_datetime_parse.py new file mode 100644 index 0000000..7cb9d9e --- /dev/null +++ b/src/beeper_desktop_api/_utils/_datetime_parse.py @@ -0,0 +1,136 @@ +""" +This file contains code from https://github.com/pydantic/pydantic/blob/main/pydantic/v1/datetime_parse.py +without the Pydantic v1 specific errors. +""" + +from __future__ import annotations + +import re +from typing import Dict, Union, Optional +from datetime import date, datetime, timezone, timedelta + +from .._types import StrBytesIntFloat + +date_expr = r"(?P\d{4})-(?P\d{1,2})-(?P\d{1,2})" +time_expr = ( + r"(?P\d{1,2}):(?P\d{1,2})" + r"(?::(?P\d{1,2})(?:\.(?P\d{1,6})\d{0,6})?)?" + r"(?PZ|[+-]\d{2}(?::?\d{2})?)?$" +) + +date_re = re.compile(f"{date_expr}$") +datetime_re = re.compile(f"{date_expr}[T ]{time_expr}") + + +EPOCH = datetime(1970, 1, 1) +# if greater than this, the number is in ms, if less than or equal it's in seconds +# (in seconds this is 11th October 2603, in ms it's 20th August 1970) +MS_WATERSHED = int(2e10) +# slightly more than datetime.max in ns - (datetime.max - EPOCH).total_seconds() * 1e9 +MAX_NUMBER = int(3e20) + + +def _get_numeric(value: StrBytesIntFloat, native_expected_type: str) -> Union[None, int, float]: + if isinstance(value, (int, float)): + return value + try: + return float(value) + except ValueError: + return None + except TypeError: + raise TypeError(f"invalid type; expected {native_expected_type}, string, bytes, int or float") from None + + +def _from_unix_seconds(seconds: Union[int, float]) -> datetime: + if seconds > MAX_NUMBER: + return datetime.max + elif seconds < -MAX_NUMBER: + return datetime.min + + while abs(seconds) > MS_WATERSHED: + seconds /= 1000 + dt = EPOCH + timedelta(seconds=seconds) + return dt.replace(tzinfo=timezone.utc) + + +def _parse_timezone(value: Optional[str]) -> Union[None, int, timezone]: + if value == "Z": + return timezone.utc + elif value is not None: + offset_mins = int(value[-2:]) if len(value) > 3 else 0 + offset = 60 * int(value[1:3]) + offset_mins + if value[0] == "-": + offset = -offset + return timezone(timedelta(minutes=offset)) + else: + return None + + +def parse_datetime(value: Union[datetime, StrBytesIntFloat]) -> datetime: + """ + Parse a datetime/int/float/string and return a datetime.datetime. + + This function supports time zone offsets. When the input contains one, + the output uses a timezone with a fixed offset from UTC. + + Raise ValueError if the input is well formatted but not a valid datetime. + Raise ValueError if the input isn't well formatted. + """ + if isinstance(value, datetime): + return value + + number = _get_numeric(value, "datetime") + if number is not None: + return _from_unix_seconds(number) + + if isinstance(value, bytes): + value = value.decode() + + assert not isinstance(value, (float, int)) + + match = datetime_re.match(value) + if match is None: + raise ValueError("invalid datetime format") + + kw = match.groupdict() + if kw["microsecond"]: + kw["microsecond"] = kw["microsecond"].ljust(6, "0") + + tzinfo = _parse_timezone(kw.pop("tzinfo")) + kw_: Dict[str, Union[None, int, timezone]] = {k: int(v) for k, v in kw.items() if v is not None} + kw_["tzinfo"] = tzinfo + + return datetime(**kw_) # type: ignore + + +def parse_date(value: Union[date, StrBytesIntFloat]) -> date: + """ + Parse a date/int/float/string and return a datetime.date. + + Raise ValueError if the input is well formatted but not a valid date. + Raise ValueError if the input isn't well formatted. + """ + if isinstance(value, date): + if isinstance(value, datetime): + return value.date() + else: + return value + + number = _get_numeric(value, "date") + if number is not None: + return _from_unix_seconds(number).date() + + if isinstance(value, bytes): + value = value.decode() + + assert not isinstance(value, (float, int)) + match = date_re.match(value) + if match is None: + raise ValueError("invalid date format") + + kw = {k: int(v) for k, v in match.groupdict().items()} + + try: + return date(**kw) + except ValueError: + raise ValueError("invalid date format") from None diff --git a/src/beeper_desktop_api/_utils/_json.py b/src/beeper_desktop_api/_utils/_json.py new file mode 100644 index 0000000..6058421 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_json.py @@ -0,0 +1,35 @@ +import json +from typing import Any +from datetime import datetime +from typing_extensions import override + +import pydantic + +from .._compat import model_dump + + +def openapi_dumps(obj: Any) -> bytes: + """ + Serialize an object to UTF-8 encoded JSON bytes. + + Extends the standard json.dumps with support for additional types + commonly used in the SDK, such as `datetime`, `pydantic.BaseModel`, etc. + """ + return json.dumps( + obj, + cls=_CustomEncoder, + # Uses the same defaults as httpx's JSON serialization + ensure_ascii=False, + separators=(",", ":"), + allow_nan=False, + ).encode() + + +class _CustomEncoder(json.JSONEncoder): + @override + def default(self, o: Any) -> Any: + if isinstance(o, datetime): + return o.isoformat() + if isinstance(o, pydantic.BaseModel): + return model_dump(o, exclude_unset=True, mode="json", by_alias=True) + return super().default(o) diff --git a/src/beeper_desktop_api/_utils/_logs.py b/src/beeper_desktop_api/_utils/_logs.py new file mode 100644 index 0000000..96d73d5 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_logs.py @@ -0,0 +1,25 @@ +import os +import logging + +logger: logging.Logger = logging.getLogger("beeper_desktop_api") +httpx_logger: logging.Logger = logging.getLogger("httpx") + + +def _basic_config() -> None: + # e.g. [2023-10-05 14:12:26 - beeper_desktop_api._base_client:818 - DEBUG] HTTP Request: POST http://127.0.0.1:4010/foo/bar "200 OK" + logging.basicConfig( + format="[%(asctime)s - %(name)s:%(lineno)d - %(levelname)s] %(message)s", + datefmt="%Y-%m-%d %H:%M:%S", + ) + + +def setup_logging() -> None: + env = os.environ.get("BEEPER_LOG") + if env == "debug": + _basic_config() + logger.setLevel(logging.DEBUG) + httpx_logger.setLevel(logging.DEBUG) + elif env == "info": + _basic_config() + logger.setLevel(logging.INFO) + httpx_logger.setLevel(logging.INFO) diff --git a/src/beeper_desktop_api/_utils/_path.py b/src/beeper_desktop_api/_utils/_path.py new file mode 100644 index 0000000..4d6e1e4 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_path.py @@ -0,0 +1,127 @@ +from __future__ import annotations + +import re +from typing import ( + Any, + Mapping, + Callable, +) +from urllib.parse import quote + +# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E). +_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$") + +_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}") + + +def _quote_path_segment_part(value: str) -> str: + """Percent-encode `value` for use in a URI path segment. + + Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 + """ + # quote() already treats unreserved characters (letters, digits, and -._~) + # as safe, so we only need to add sub-delims, ':', and '@'. + # Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted. + return quote(value, safe="!$&'()*+,;=:@") + + +def _quote_query_part(value: str) -> str: + """Percent-encode `value` for use in a URI query string. + + Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 + """ + return quote(value, safe="!$'()*+,;:@/?") + + +def _quote_fragment_part(value: str) -> str: + """Percent-encode `value` for use in a URI fragment. + + Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + """ + return quote(value, safe="!$&'()*+,;=:@/?") + + +def _interpolate( + template: str, + values: Mapping[str, Any], + quoter: Callable[[str], str], +) -> str: + """Replace {name} placeholders in `template`, quoting each value with `quoter`. + + Placeholder names are looked up in `values`. + + Raises: + KeyError: If a placeholder is not found in `values`. + """ + # re.split with a capturing group returns alternating + # [text, name, text, name, ..., text] elements. + parts = _PLACEHOLDER_RE.split(template) + + for i in range(1, len(parts), 2): + name = parts[i] + if name not in values: + raise KeyError(f"a value for placeholder {{{name}}} was not provided") + val = values[name] + if val is None: + parts[i] = "null" + elif isinstance(val, bool): + parts[i] = "true" if val else "false" + else: + parts[i] = quoter(str(values[name])) + + return "".join(parts) + + +def path_template(template: str, /, **kwargs: Any) -> str: + """Interpolate {name} placeholders in `template` from keyword arguments. + + Args: + template: The template string containing {name} placeholders. + **kwargs: Keyword arguments to interpolate into the template. + + Returns: + The template with placeholders interpolated and percent-encoded. + + Safe characters for percent-encoding are dependent on the URI component. + Placeholders in path and fragment portions are percent-encoded where the `segment` + and `fragment` sets from RFC 3986 respectively are considered safe. + Placeholders in the query portion are percent-encoded where the `query` set from + RFC 3986 §3.3 is considered safe except for = and & characters. + + Raises: + KeyError: If a placeholder is not found in `kwargs`. + ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments). + """ + # Split the template into path, query, and fragment portions. + fragment_template: str | None = None + query_template: str | None = None + + rest = template + if "#" in rest: + rest, fragment_template = rest.split("#", 1) + if "?" in rest: + rest, query_template = rest.split("?", 1) + path_template = rest + + # Interpolate each portion with the appropriate quoting rules. + path_result = _interpolate(path_template, kwargs, _quote_path_segment_part) + + # Reject dot-segments (. and ..) in the final assembled path. The check + # runs after interpolation so that adjacent placeholders or a mix of static + # text and placeholders that together form a dot-segment are caught. + # Also reject percent-encoded dot-segments to protect against incorrectly + # implemented normalization in servers/proxies. + for segment in path_result.split("/"): + if _DOT_SEGMENT_RE.match(segment): + raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed") + + result = path_result + if query_template is not None: + result += "?" + _interpolate(query_template, kwargs, _quote_query_part) + if fragment_template is not None: + result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part) + + return result diff --git a/src/beeper_desktop_api/_utils/_proxy.py b/src/beeper_desktop_api/_utils/_proxy.py new file mode 100644 index 0000000..0f239a3 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_proxy.py @@ -0,0 +1,65 @@ +from __future__ import annotations + +from abc import ABC, abstractmethod +from typing import Generic, TypeVar, Iterable, cast +from typing_extensions import override + +T = TypeVar("T") + + +class LazyProxy(Generic[T], ABC): + """Implements data methods to pretend that an instance is another instance. + + This includes forwarding attribute access and other methods. + """ + + # Note: we have to special case proxies that themselves return proxies + # to support using a proxy as a catch-all for any random access, e.g. `proxy.foo.bar.baz` + + def __getattr__(self, attr: str) -> object: + proxied = self.__get_proxied__() + if isinstance(proxied, LazyProxy): + return proxied # pyright: ignore + return getattr(proxied, attr) + + @override + def __repr__(self) -> str: + proxied = self.__get_proxied__() + if isinstance(proxied, LazyProxy): + return proxied.__class__.__name__ + return repr(self.__get_proxied__()) + + @override + def __str__(self) -> str: + proxied = self.__get_proxied__() + if isinstance(proxied, LazyProxy): + return proxied.__class__.__name__ + return str(proxied) + + @override + def __dir__(self) -> Iterable[str]: + proxied = self.__get_proxied__() + if isinstance(proxied, LazyProxy): + return [] + return proxied.__dir__() + + @property # type: ignore + @override + def __class__(self) -> type: # pyright: ignore + try: + proxied = self.__get_proxied__() + except Exception: + return type(self) + if issubclass(type(proxied), LazyProxy): + return type(proxied) + return proxied.__class__ + + def __get_proxied__(self) -> T: + return self.__load__() + + def __as_proxied__(self) -> T: + """Helper method that returns the current proxy, typed as the loaded object""" + return cast(T, self) + + @abstractmethod + def __load__(self) -> T: ... diff --git a/src/beeper_desktop_api/_utils/_reflection.py b/src/beeper_desktop_api/_utils/_reflection.py new file mode 100644 index 0000000..89aa712 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_reflection.py @@ -0,0 +1,42 @@ +from __future__ import annotations + +import inspect +from typing import Any, Callable + + +def function_has_argument(func: Callable[..., Any], arg_name: str) -> bool: + """Returns whether or not the given function has a specific parameter""" + sig = inspect.signature(func) + return arg_name in sig.parameters + + +def assert_signatures_in_sync( + source_func: Callable[..., Any], + check_func: Callable[..., Any], + *, + exclude_params: set[str] = set(), +) -> None: + """Ensure that the signature of the second function matches the first.""" + + check_sig = inspect.signature(check_func) + source_sig = inspect.signature(source_func) + + errors: list[str] = [] + + for name, source_param in source_sig.parameters.items(): + if name in exclude_params: + continue + + custom_param = check_sig.parameters.get(name) + if not custom_param: + errors.append(f"the `{name}` param is missing") + continue + + if custom_param.annotation != source_param.annotation: + errors.append( + f"types for the `{name}` param are do not match; source={repr(source_param.annotation)} checking={repr(custom_param.annotation)}" + ) + continue + + if errors: + raise AssertionError(f"{len(errors)} errors encountered when comparing signatures:\n\n" + "\n\n".join(errors)) diff --git a/src/beeper_desktop_api/_utils/_resources_proxy.py b/src/beeper_desktop_api/_utils/_resources_proxy.py new file mode 100644 index 0000000..531be88 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_resources_proxy.py @@ -0,0 +1,24 @@ +from __future__ import annotations + +from typing import Any +from typing_extensions import override + +from ._proxy import LazyProxy + + +class ResourcesProxy(LazyProxy[Any]): + """A proxy for the `beeper_desktop_api.resources` module. + + This is used so that we can lazily import `beeper_desktop_api.resources` only when + needed *and* so that users can just import `beeper_desktop_api` and reference `beeper_desktop_api.resources` + """ + + @override + def __load__(self) -> Any: + import importlib + + mod = importlib.import_module("beeper_desktop_api.resources") + return mod + + +resources = ResourcesProxy().__as_proxied__() diff --git a/src/beeper_desktop_api/_utils/_streams.py b/src/beeper_desktop_api/_utils/_streams.py new file mode 100644 index 0000000..f4a0208 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_streams.py @@ -0,0 +1,12 @@ +from typing import Any +from typing_extensions import Iterator, AsyncIterator + + +def consume_sync_iterator(iterator: Iterator[Any]) -> None: + for _ in iterator: + ... + + +async def consume_async_iterator(iterator: AsyncIterator[Any]) -> None: + async for _ in iterator: + ... diff --git a/src/beeper_desktop_api/_utils/_sync.py b/src/beeper_desktop_api/_utils/_sync.py new file mode 100644 index 0000000..f6027c1 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_sync.py @@ -0,0 +1,58 @@ +from __future__ import annotations + +import asyncio +import functools +from typing import TypeVar, Callable, Awaitable +from typing_extensions import ParamSpec + +import anyio +import sniffio +import anyio.to_thread + +T_Retval = TypeVar("T_Retval") +T_ParamSpec = ParamSpec("T_ParamSpec") + + +async def to_thread( + func: Callable[T_ParamSpec, T_Retval], /, *args: T_ParamSpec.args, **kwargs: T_ParamSpec.kwargs +) -> T_Retval: + if sniffio.current_async_library() == "asyncio": + return await asyncio.to_thread(func, *args, **kwargs) + + return await anyio.to_thread.run_sync( + functools.partial(func, *args, **kwargs), + ) + + +# inspired by `asyncer`, https://github.com/tiangolo/asyncer +def asyncify(function: Callable[T_ParamSpec, T_Retval]) -> Callable[T_ParamSpec, Awaitable[T_Retval]]: + """ + Take a blocking function and create an async one that receives the same + positional and keyword arguments. + + Usage: + + ```python + def blocking_func(arg1, arg2, kwarg1=None): + # blocking code + return result + + + result = asyncify(blocking_function)(arg1, arg2, kwarg1=value1) + ``` + + ## Arguments + + `function`: a blocking regular callable (e.g. a function) + + ## Return + + An async function that takes the same positional and keyword arguments as the + original one, that when called runs the same original function in a thread worker + and returns the result. + """ + + async def wrapper(*args: T_ParamSpec.args, **kwargs: T_ParamSpec.kwargs) -> T_Retval: + return await to_thread(function, *args, **kwargs) + + return wrapper diff --git a/src/beeper_desktop_api/_utils/_transform.py b/src/beeper_desktop_api/_utils/_transform.py new file mode 100644 index 0000000..5207549 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_transform.py @@ -0,0 +1,457 @@ +from __future__ import annotations + +import io +import base64 +import pathlib +from typing import Any, Mapping, TypeVar, cast +from datetime import date, datetime +from typing_extensions import Literal, get_args, override, get_type_hints as _get_type_hints + +import anyio +import pydantic + +from ._utils import ( + is_list, + is_given, + lru_cache, + is_mapping, + is_iterable, + is_sequence, +) +from .._files import is_base64_file_input +from ._compat import get_origin, is_typeddict +from ._typing import ( + is_list_type, + is_union_type, + extract_type_arg, + is_iterable_type, + is_required_type, + is_sequence_type, + is_annotated_type, + strip_annotated_type, +) + +_T = TypeVar("_T") + + +# TODO: support for drilling globals() and locals() +# TODO: ensure works correctly with forward references in all cases + + +PropertyFormat = Literal["iso8601", "base64", "custom"] + + +class PropertyInfo: + """Metadata class to be used in Annotated types to provide information about a given type. + + For example: + + class MyParams(TypedDict): + account_holder_name: Annotated[str, PropertyInfo(alias='accountHolderName')] + + This means that {'account_holder_name': 'Robert'} will be transformed to {'accountHolderName': 'Robert'} before being sent to the API. + """ + + alias: str | None + format: PropertyFormat | None + format_template: str | None + discriminator: str | None + + def __init__( + self, + *, + alias: str | None = None, + format: PropertyFormat | None = None, + format_template: str | None = None, + discriminator: str | None = None, + ) -> None: + self.alias = alias + self.format = format + self.format_template = format_template + self.discriminator = discriminator + + @override + def __repr__(self) -> str: + return f"{self.__class__.__name__}(alias='{self.alias}', format={self.format}, format_template='{self.format_template}', discriminator='{self.discriminator}')" + + +def maybe_transform( + data: object, + expected_type: object, +) -> Any | None: + """Wrapper over `transform()` that allows `None` to be passed. + + See `transform()` for more details. + """ + if data is None: + return None + return transform(data, expected_type) + + +# Wrapper over _transform_recursive providing fake types +def transform( + data: _T, + expected_type: object, +) -> _T: + """Transform dictionaries based off of type information from the given type, for example: + + ```py + class Params(TypedDict, total=False): + card_id: Required[Annotated[str, PropertyInfo(alias="cardID")]] + + + transformed = transform({"card_id": ""}, Params) + # {'cardID': ''} + ``` + + Any keys / data that does not have type information given will be included as is. + + It should be noted that the transformations that this function does are not represented in the type system. + """ + transformed = _transform_recursive(data, annotation=cast(type, expected_type)) + return cast(_T, transformed) + + +@lru_cache(maxsize=8096) +def _get_annotated_type(type_: type) -> type | None: + """If the given type is an `Annotated` type then it is returned, if not `None` is returned. + + This also unwraps the type when applicable, e.g. `Required[Annotated[T, ...]]` + """ + if is_required_type(type_): + # Unwrap `Required[Annotated[T, ...]]` to `Annotated[T, ...]` + type_ = get_args(type_)[0] + + if is_annotated_type(type_): + return type_ + + return None + + +def _maybe_transform_key(key: str, type_: type) -> str: + """Transform the given `data` based on the annotations provided in `type_`. + + Note: this function only looks at `Annotated` types that contain `PropertyInfo` metadata. + """ + annotated_type = _get_annotated_type(type_) + if annotated_type is None: + # no `Annotated` definition for this type, no transformation needed + return key + + # ignore the first argument as it is the actual type + annotations = get_args(annotated_type)[1:] + for annotation in annotations: + if isinstance(annotation, PropertyInfo) and annotation.alias is not None: + return annotation.alias + + return key + + +def _no_transform_needed(annotation: type) -> bool: + return annotation == float or annotation == int + + +def _transform_recursive( + data: object, + *, + annotation: type, + inner_type: type | None = None, +) -> object: + """Transform the given data against the expected type. + + Args: + annotation: The direct type annotation given to the particular piece of data. + This may or may not be wrapped in metadata types, e.g. `Required[T]`, `Annotated[T, ...]` etc + + inner_type: If applicable, this is the "inside" type. This is useful in certain cases where the outside type + is a container type such as `List[T]`. In that case `inner_type` should be set to `T` so that each entry in + the list can be transformed using the metadata from the container type. + + Defaults to the same value as the `annotation` argument. + """ + from .._compat import model_dump + + if inner_type is None: + inner_type = annotation + + stripped_type = strip_annotated_type(inner_type) + origin = get_origin(stripped_type) or stripped_type + if is_typeddict(stripped_type) and is_mapping(data): + return _transform_typeddict(data, stripped_type) + + if origin == dict and is_mapping(data): + items_type = get_args(stripped_type)[1] + return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()} + + if ( + # List[T] + (is_list_type(stripped_type) and is_list(data)) + # Iterable[T] + or (is_iterable_type(stripped_type) and is_iterable(data) and not isinstance(data, str)) + # Sequence[T] + or (is_sequence_type(stripped_type) and is_sequence(data) and not isinstance(data, str)) + ): + # dicts are technically iterable, but it is an iterable on the keys of the dict and is not usually + # intended as an iterable, so we don't transform it. + if isinstance(data, dict): + return cast(object, data) + + inner_type = extract_type_arg(stripped_type, 0) + if _no_transform_needed(inner_type): + # for some types there is no need to transform anything, so we can get a small + # perf boost from skipping that work. + # + # but we still need to convert to a list to ensure the data is json-serializable + if is_list(data): + return data + return list(data) + + return [_transform_recursive(d, annotation=annotation, inner_type=inner_type) for d in data] + + if is_union_type(stripped_type): + # For union types we run the transformation against all subtypes to ensure that everything is transformed. + # + # TODO: there may be edge cases where the same normalized field name will transform to two different names + # in different subtypes. + for subtype in get_args(stripped_type): + data = _transform_recursive(data, annotation=annotation, inner_type=subtype) + return data + + if isinstance(data, pydantic.BaseModel): + return model_dump(data, exclude_unset=True, mode="json") + + annotated_type = _get_annotated_type(annotation) + if annotated_type is None: + return data + + # ignore the first argument as it is the actual type + annotations = get_args(annotated_type)[1:] + for annotation in annotations: + if isinstance(annotation, PropertyInfo) and annotation.format is not None: + return _format_data(data, annotation.format, annotation.format_template) + + return data + + +def _format_data(data: object, format_: PropertyFormat, format_template: str | None) -> object: + if isinstance(data, (date, datetime)): + if format_ == "iso8601": + return data.isoformat() + + if format_ == "custom" and format_template is not None: + return data.strftime(format_template) + + if format_ == "base64" and is_base64_file_input(data): + binary: str | bytes | None = None + + if isinstance(data, pathlib.Path): + binary = data.read_bytes() + elif isinstance(data, io.IOBase): + binary = data.read() + + if isinstance(binary, str): # type: ignore[unreachable] + binary = binary.encode() + + if not isinstance(binary, bytes): + raise RuntimeError(f"Could not read bytes from {data}; Received {type(binary)}") + + return base64.b64encode(binary).decode("ascii") + + return data + + +def _transform_typeddict( + data: Mapping[str, object], + expected_type: type, +) -> Mapping[str, object]: + result: dict[str, object] = {} + annotations = get_type_hints(expected_type, include_extras=True) + for key, value in data.items(): + if not is_given(value): + # we don't need to include omitted values here as they'll + # be stripped out before the request is sent anyway + continue + + type_ = annotations.get(key) + if type_ is None: + # we do not have a type annotation for this field, leave it as is + result[key] = value + else: + result[_maybe_transform_key(key, type_)] = _transform_recursive(value, annotation=type_) + return result + + +async def async_maybe_transform( + data: object, + expected_type: object, +) -> Any | None: + """Wrapper over `async_transform()` that allows `None` to be passed. + + See `async_transform()` for more details. + """ + if data is None: + return None + return await async_transform(data, expected_type) + + +async def async_transform( + data: _T, + expected_type: object, +) -> _T: + """Transform dictionaries based off of type information from the given type, for example: + + ```py + class Params(TypedDict, total=False): + card_id: Required[Annotated[str, PropertyInfo(alias="cardID")]] + + + transformed = transform({"card_id": ""}, Params) + # {'cardID': ''} + ``` + + Any keys / data that does not have type information given will be included as is. + + It should be noted that the transformations that this function does are not represented in the type system. + """ + transformed = await _async_transform_recursive(data, annotation=cast(type, expected_type)) + return cast(_T, transformed) + + +async def _async_transform_recursive( + data: object, + *, + annotation: type, + inner_type: type | None = None, +) -> object: + """Transform the given data against the expected type. + + Args: + annotation: The direct type annotation given to the particular piece of data. + This may or may not be wrapped in metadata types, e.g. `Required[T]`, `Annotated[T, ...]` etc + + inner_type: If applicable, this is the "inside" type. This is useful in certain cases where the outside type + is a container type such as `List[T]`. In that case `inner_type` should be set to `T` so that each entry in + the list can be transformed using the metadata from the container type. + + Defaults to the same value as the `annotation` argument. + """ + from .._compat import model_dump + + if inner_type is None: + inner_type = annotation + + stripped_type = strip_annotated_type(inner_type) + origin = get_origin(stripped_type) or stripped_type + if is_typeddict(stripped_type) and is_mapping(data): + return await _async_transform_typeddict(data, stripped_type) + + if origin == dict and is_mapping(data): + items_type = get_args(stripped_type)[1] + return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()} + + if ( + # List[T] + (is_list_type(stripped_type) and is_list(data)) + # Iterable[T] + or (is_iterable_type(stripped_type) and is_iterable(data) and not isinstance(data, str)) + # Sequence[T] + or (is_sequence_type(stripped_type) and is_sequence(data) and not isinstance(data, str)) + ): + # dicts are technically iterable, but it is an iterable on the keys of the dict and is not usually + # intended as an iterable, so we don't transform it. + if isinstance(data, dict): + return cast(object, data) + + inner_type = extract_type_arg(stripped_type, 0) + if _no_transform_needed(inner_type): + # for some types there is no need to transform anything, so we can get a small + # perf boost from skipping that work. + # + # but we still need to convert to a list to ensure the data is json-serializable + if is_list(data): + return data + return list(data) + + return [await _async_transform_recursive(d, annotation=annotation, inner_type=inner_type) for d in data] + + if is_union_type(stripped_type): + # For union types we run the transformation against all subtypes to ensure that everything is transformed. + # + # TODO: there may be edge cases where the same normalized field name will transform to two different names + # in different subtypes. + for subtype in get_args(stripped_type): + data = await _async_transform_recursive(data, annotation=annotation, inner_type=subtype) + return data + + if isinstance(data, pydantic.BaseModel): + return model_dump(data, exclude_unset=True, mode="json") + + annotated_type = _get_annotated_type(annotation) + if annotated_type is None: + return data + + # ignore the first argument as it is the actual type + annotations = get_args(annotated_type)[1:] + for annotation in annotations: + if isinstance(annotation, PropertyInfo) and annotation.format is not None: + return await _async_format_data(data, annotation.format, annotation.format_template) + + return data + + +async def _async_format_data(data: object, format_: PropertyFormat, format_template: str | None) -> object: + if isinstance(data, (date, datetime)): + if format_ == "iso8601": + return data.isoformat() + + if format_ == "custom" and format_template is not None: + return data.strftime(format_template) + + if format_ == "base64" and is_base64_file_input(data): + binary: str | bytes | None = None + + if isinstance(data, pathlib.Path): + binary = await anyio.Path(data).read_bytes() + elif isinstance(data, io.IOBase): + binary = data.read() + + if isinstance(binary, str): # type: ignore[unreachable] + binary = binary.encode() + + if not isinstance(binary, bytes): + raise RuntimeError(f"Could not read bytes from {data}; Received {type(binary)}") + + return base64.b64encode(binary).decode("ascii") + + return data + + +async def _async_transform_typeddict( + data: Mapping[str, object], + expected_type: type, +) -> Mapping[str, object]: + result: dict[str, object] = {} + annotations = get_type_hints(expected_type, include_extras=True) + for key, value in data.items(): + if not is_given(value): + # we don't need to include omitted values here as they'll + # be stripped out before the request is sent anyway + continue + + type_ = annotations.get(key) + if type_ is None: + # we do not have a type annotation for this field, leave it as is + result[key] = value + else: + result[_maybe_transform_key(key, type_)] = await _async_transform_recursive(value, annotation=type_) + return result + + +@lru_cache(maxsize=8096) +def get_type_hints( + obj: Any, + globalns: dict[str, Any] | None = None, + localns: Mapping[str, Any] | None = None, + include_extras: bool = False, +) -> dict[str, Any]: + return _get_type_hints(obj, globalns=globalns, localns=localns, include_extras=include_extras) diff --git a/src/beeper_desktop_api/_utils/_typing.py b/src/beeper_desktop_api/_utils/_typing.py new file mode 100644 index 0000000..193109f --- /dev/null +++ b/src/beeper_desktop_api/_utils/_typing.py @@ -0,0 +1,156 @@ +from __future__ import annotations + +import sys +import typing +import typing_extensions +from typing import Any, TypeVar, Iterable, cast +from collections import abc as _c_abc +from typing_extensions import ( + TypeIs, + Required, + Annotated, + get_args, + get_origin, +) + +from ._utils import lru_cache +from .._types import InheritsGeneric +from ._compat import is_union as _is_union + + +def is_annotated_type(typ: type) -> bool: + return get_origin(typ) == Annotated + + +def is_list_type(typ: type) -> bool: + return (get_origin(typ) or typ) == list + + +def is_sequence_type(typ: type) -> bool: + origin = get_origin(typ) or typ + return origin == typing_extensions.Sequence or origin == typing.Sequence or origin == _c_abc.Sequence + + +def is_iterable_type(typ: type) -> bool: + """If the given type is `typing.Iterable[T]`""" + origin = get_origin(typ) or typ + return origin == Iterable or origin == _c_abc.Iterable + + +def is_union_type(typ: type) -> bool: + return _is_union(get_origin(typ)) + + +def is_required_type(typ: type) -> bool: + return get_origin(typ) == Required + + +def is_typevar(typ: type) -> bool: + # type ignore is required because type checkers + # think this expression will always return False + return type(typ) == TypeVar # type: ignore + + +_TYPE_ALIAS_TYPES: tuple[type[typing_extensions.TypeAliasType], ...] = (typing_extensions.TypeAliasType,) +if sys.version_info >= (3, 12): + _TYPE_ALIAS_TYPES = (*_TYPE_ALIAS_TYPES, typing.TypeAliasType) + + +def is_type_alias_type(tp: Any, /) -> TypeIs[typing_extensions.TypeAliasType]: + """Return whether the provided argument is an instance of `TypeAliasType`. + + ```python + type Int = int + is_type_alias_type(Int) + # > True + Str = TypeAliasType("Str", str) + is_type_alias_type(Str) + # > True + ``` + """ + return isinstance(tp, _TYPE_ALIAS_TYPES) + + +# Extracts T from Annotated[T, ...] or from Required[Annotated[T, ...]] +@lru_cache(maxsize=8096) +def strip_annotated_type(typ: type) -> type: + if is_required_type(typ) or is_annotated_type(typ): + return strip_annotated_type(cast(type, get_args(typ)[0])) + + return typ + + +def extract_type_arg(typ: type, index: int) -> type: + args = get_args(typ) + try: + return cast(type, args[index]) + except IndexError as err: + raise RuntimeError(f"Expected type {typ} to have a type argument at index {index} but it did not") from err + + +def extract_type_var_from_base( + typ: type, + *, + generic_bases: tuple[type, ...], + index: int, + failure_message: str | None = None, +) -> type: + """Given a type like `Foo[T]`, returns the generic type variable `T`. + + This also handles the case where a concrete subclass is given, e.g. + ```py + class MyResponse(Foo[bytes]): + ... + + extract_type_var(MyResponse, bases=(Foo,), index=0) -> bytes + ``` + + And where a generic subclass is given: + ```py + _T = TypeVar('_T') + class MyResponse(Foo[_T]): + ... + + extract_type_var(MyResponse[bytes], bases=(Foo,), index=0) -> bytes + ``` + """ + cls = cast(object, get_origin(typ) or typ) + if cls in generic_bases: # pyright: ignore[reportUnnecessaryContains] + # we're given the class directly + return extract_type_arg(typ, index) + + # if a subclass is given + # --- + # this is needed as __orig_bases__ is not present in the typeshed stubs + # because it is intended to be for internal use only, however there does + # not seem to be a way to resolve generic TypeVars for inherited subclasses + # without using it. + if isinstance(cls, InheritsGeneric): + target_base_class: Any | None = None + for base in cls.__orig_bases__: + if base.__origin__ in generic_bases: + target_base_class = base + break + + if target_base_class is None: + raise RuntimeError( + "Could not find the generic base class;\n" + "This should never happen;\n" + f"Does {cls} inherit from one of {generic_bases} ?" + ) + + extracted = extract_type_arg(target_base_class, index) + if is_typevar(extracted): + # If the extracted type argument is itself a type variable + # then that means the subclass itself is generic, so we have + # to resolve the type argument from the class itself, not + # the base class. + # + # Note: if there is more than 1 type argument, the subclass could + # change the ordering of the type arguments, this is not currently + # supported. + return extract_type_arg(typ, index) + + return extracted + + raise RuntimeError(failure_message or f"Could not resolve inner type variable at index {index} for {typ}") diff --git a/src/beeper_desktop_api/_utils/_utils.py b/src/beeper_desktop_api/_utils/_utils.py new file mode 100644 index 0000000..199cd23 --- /dev/null +++ b/src/beeper_desktop_api/_utils/_utils.py @@ -0,0 +1,433 @@ +from __future__ import annotations + +import os +import re +import inspect +import functools +from typing import ( + Any, + Tuple, + Mapping, + TypeVar, + Callable, + Iterable, + Sequence, + cast, + overload, +) +from pathlib import Path +from datetime import date, datetime +from typing_extensions import TypeGuard, get_args + +import sniffio + +from .._types import Omit, NotGiven, FileTypes, ArrayFormat, HeadersLike + +_T = TypeVar("_T") +_TupleT = TypeVar("_TupleT", bound=Tuple[object, ...]) +_MappingT = TypeVar("_MappingT", bound=Mapping[str, object]) +_SequenceT = TypeVar("_SequenceT", bound=Sequence[object]) +CallableT = TypeVar("CallableT", bound=Callable[..., Any]) + + +def flatten(t: Iterable[Iterable[_T]]) -> list[_T]: + return [item for sublist in t for item in sublist] + + +def extract_files( + # TODO: this needs to take Dict but variance issues..... + # create protocol type ? + query: Mapping[str, object], + *, + paths: Sequence[Sequence[str]], + array_format: ArrayFormat = "brackets", +) -> list[tuple[str, FileTypes]]: + """Recursively extract files from the given dictionary based on specified paths. + + A path may look like this ['foo', 'files', '', 'data']. + + ``array_format`` controls how ```` segments contribute to the emitted + field name. Supported values: ``"brackets"`` (``foo[]``), ``"repeat"`` and + ``"comma"`` (``foo``), ``"indices"`` (``foo[0]``, ``foo[1]``). + + Note: this mutates the given dictionary. + """ + files: list[tuple[str, FileTypes]] = [] + for path in paths: + files.extend(_extract_items(query, path, index=0, flattened_key=None, array_format=array_format)) + return files + + +def _array_suffix(array_format: ArrayFormat, array_index: int) -> str: + if array_format == "brackets": + return "[]" + if array_format == "indices": + return f"[{array_index}]" + if array_format == "repeat" or array_format == "comma": + # Both repeat the bare field name for each file part; there is no + # meaningful way to comma-join binary parts. + return "" + raise NotImplementedError( + f"Unknown array_format value: {array_format}, choose from {', '.join(get_args(ArrayFormat))}" + ) + + +def _extract_items( + obj: object, + path: Sequence[str], + *, + index: int, + flattened_key: str | None, + array_format: ArrayFormat, +) -> list[tuple[str, FileTypes]]: + try: + key = path[index] + except IndexError: + if not is_given(obj): + # no value was provided - we can safely ignore + return [] + + # cyclical import + from .._files import assert_is_file_content + + # We have exhausted the path, return the entry we found. + assert flattened_key is not None + + if is_list(obj): + files: list[tuple[str, FileTypes]] = [] + for array_index, entry in enumerate(obj): + suffix = _array_suffix(array_format, array_index) + emitted_key = (flattened_key + suffix) if flattened_key else suffix + assert_is_file_content(entry, key=emitted_key) + files.append((emitted_key, cast(FileTypes, entry))) + return files + + assert_is_file_content(obj, key=flattened_key) + return [(flattened_key, cast(FileTypes, obj))] + + index += 1 + if is_dict(obj): + try: + # Remove the field if there are no more dict keys in the path, + # only "" traversal markers or end. + if all(p == "" for p in path[index:]): + item = obj.pop(key) + else: + item = obj[key] + except KeyError: + # Key was not present in the dictionary, this is not indicative of an error + # as the given path may not point to a required field. We also do not want + # to enforce required fields as the API may differ from the spec in some cases. + return [] + if flattened_key is None: + flattened_key = key + else: + flattened_key += f"[{key}]" + return _extract_items( + item, + path, + index=index, + flattened_key=flattened_key, + array_format=array_format, + ) + elif is_list(obj): + if key != "": + return [] + + return flatten( + [ + _extract_items( + item, + path, + index=index, + flattened_key=( + (flattened_key if flattened_key is not None else "") + _array_suffix(array_format, array_index) + ), + array_format=array_format, + ) + for array_index, item in enumerate(obj) + ] + ) + + # Something unexpected was passed, just ignore it. + return [] + + +def is_given(obj: _T | NotGiven | Omit) -> TypeGuard[_T]: + return not isinstance(obj, NotGiven) and not isinstance(obj, Omit) + + +# Type safe methods for narrowing types with TypeVars. +# The default narrowing for isinstance(obj, dict) is dict[unknown, unknown], +# however this cause Pyright to rightfully report errors. As we know we don't +# care about the contained types we can safely use `object` in its place. +# +# There are two separate functions defined, `is_*` and `is_*_t` for different use cases. +# `is_*` is for when you're dealing with an unknown input +# `is_*_t` is for when you're narrowing a known union type to a specific subset + + +def is_tuple(obj: object) -> TypeGuard[tuple[object, ...]]: + return isinstance(obj, tuple) + + +def is_tuple_t(obj: _TupleT | object) -> TypeGuard[_TupleT]: + return isinstance(obj, tuple) + + +def is_sequence(obj: object) -> TypeGuard[Sequence[object]]: + return isinstance(obj, Sequence) + + +def is_sequence_t(obj: _SequenceT | object) -> TypeGuard[_SequenceT]: + return isinstance(obj, Sequence) + + +def is_mapping(obj: object) -> TypeGuard[Mapping[str, object]]: + return isinstance(obj, Mapping) + + +def is_mapping_t(obj: _MappingT | object) -> TypeGuard[_MappingT]: + return isinstance(obj, Mapping) + + +def is_dict(obj: object) -> TypeGuard[dict[object, object]]: + return isinstance(obj, dict) + + +def is_list(obj: object) -> TypeGuard[list[object]]: + return isinstance(obj, list) + + +def is_iterable(obj: object) -> TypeGuard[Iterable[object]]: + return isinstance(obj, Iterable) + + +# copied from https://github.com/Rapptz/RoboDanny +def human_join(seq: Sequence[str], *, delim: str = ", ", final: str = "or") -> str: + size = len(seq) + if size == 0: + return "" + + if size == 1: + return seq[0] + + if size == 2: + return f"{seq[0]} {final} {seq[1]}" + + return delim.join(seq[:-1]) + f" {final} {seq[-1]}" + + +def quote(string: str) -> str: + """Add single quotation marks around the given string. Does *not* do any escaping.""" + return f"'{string}'" + + +def required_args(*variants: Sequence[str]) -> Callable[[CallableT], CallableT]: + """Decorator to enforce a given set of arguments or variants of arguments are passed to the decorated function. + + Useful for enforcing runtime validation of overloaded functions. + + Example usage: + ```py + @overload + def foo(*, a: str) -> str: ... + + + @overload + def foo(*, b: bool) -> str: ... + + + # This enforces the same constraints that a static type checker would + # i.e. that either a or b must be passed to the function + @required_args(["a"], ["b"]) + def foo(*, a: str | None = None, b: bool | None = None) -> str: ... + ``` + """ + + def inner(func: CallableT) -> CallableT: + params = inspect.signature(func).parameters + positional = [ + name + for name, param in params.items() + if param.kind + in { + param.POSITIONAL_ONLY, + param.POSITIONAL_OR_KEYWORD, + } + ] + + @functools.wraps(func) + def wrapper(*args: object, **kwargs: object) -> object: + given_params: set[str] = set() + for i, _ in enumerate(args): + try: + given_params.add(positional[i]) + except IndexError: + raise TypeError( + f"{func.__name__}() takes {len(positional)} argument(s) but {len(args)} were given" + ) from None + + for key in kwargs.keys(): + given_params.add(key) + + for variant in variants: + matches = all((param in given_params for param in variant)) + if matches: + break + else: # no break + if len(variants) > 1: + variations = human_join( + ["(" + human_join([quote(arg) for arg in variant], final="and") + ")" for variant in variants] + ) + msg = f"Missing required arguments; Expected either {variations} arguments to be given" + else: + assert len(variants) > 0 + + # TODO: this error message is not deterministic + missing = list(set(variants[0]) - given_params) + if len(missing) > 1: + msg = f"Missing required arguments: {human_join([quote(arg) for arg in missing])}" + else: + msg = f"Missing required argument: {quote(missing[0])}" + raise TypeError(msg) + return func(*args, **kwargs) + + return wrapper # type: ignore + + return inner + + +_K = TypeVar("_K") +_V = TypeVar("_V") + + +@overload +def strip_not_given(obj: None) -> None: ... + + +@overload +def strip_not_given(obj: Mapping[_K, _V | NotGiven]) -> dict[_K, _V]: ... + + +@overload +def strip_not_given(obj: object) -> object: ... + + +def strip_not_given(obj: object | None) -> object: + """Remove all top-level keys where their values are instances of `NotGiven`""" + if obj is None: + return None + + if not is_mapping(obj): + return obj + + return {key: value for key, value in obj.items() if not isinstance(value, NotGiven)} + + +def coerce_integer(val: str) -> int: + return int(val, base=10) + + +def coerce_float(val: str) -> float: + return float(val) + + +def coerce_boolean(val: str) -> bool: + return val == "true" or val == "1" or val == "on" + + +def maybe_coerce_integer(val: str | None) -> int | None: + if val is None: + return None + return coerce_integer(val) + + +def maybe_coerce_float(val: str | None) -> float | None: + if val is None: + return None + return coerce_float(val) + + +def maybe_coerce_boolean(val: str | None) -> bool | None: + if val is None: + return None + return coerce_boolean(val) + + +def removeprefix(string: str, prefix: str) -> str: + """Remove a prefix from a string. + + Backport of `str.removeprefix` for Python < 3.9 + """ + if string.startswith(prefix): + return string[len(prefix) :] + return string + + +def removesuffix(string: str, suffix: str) -> str: + """Remove a suffix from a string. + + Backport of `str.removesuffix` for Python < 3.9 + """ + if string.endswith(suffix): + return string[: -len(suffix)] + return string + + +def file_from_path(path: str) -> FileTypes: + contents = Path(path).read_bytes() + file_name = os.path.basename(path) + return (file_name, contents) + + +def get_required_header(headers: HeadersLike, header: str) -> str: + lower_header = header.lower() + if is_mapping_t(headers): + # mypy doesn't understand the type narrowing here + for k, v in headers.items(): # type: ignore + if k.lower() == lower_header and isinstance(v, str): + return v + + # to deal with the case where the header looks like Stainless-Event-Id + intercaps_header = re.sub(r"([^\w])(\w)", lambda pat: pat.group(1) + pat.group(2).upper(), header.capitalize()) + + for normalized_header in [header, lower_header, header.upper(), intercaps_header]: + value = headers.get(normalized_header) + if value: + return value + + raise ValueError(f"Could not find {header} header") + + +def get_async_library() -> str: + try: + return sniffio.current_async_library() + except Exception: + return "false" + + +def lru_cache(*, maxsize: int | None = 128) -> Callable[[CallableT], CallableT]: + """A version of functools.lru_cache that retains the type signature + for the wrapped function arguments. + """ + wrapper = functools.lru_cache( # noqa: TID251 + maxsize=maxsize, + ) + return cast(Any, wrapper) # type: ignore[no-any-return] + + +def json_safe(data: object) -> object: + """Translates a mapping / sequence recursively in the same fashion + as `pydantic` v2's `model_dump(mode="json")`. + """ + if is_mapping(data): + return {json_safe(key): json_safe(value) for key, value in data.items()} + + if is_iterable(data) and not isinstance(data, (str, bytes, bytearray)): + return [json_safe(item) for item in data] + + if isinstance(data, (datetime, date)): + return data.isoformat() + + return data diff --git a/src/beeper_desktop_api/_version.py b/src/beeper_desktop_api/_version.py new file mode 100644 index 0000000..60fb169 --- /dev/null +++ b/src/beeper_desktop_api/_version.py @@ -0,0 +1,4 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +__title__ = "beeper_desktop_api" +__version__ = "5.0.0" # x-release-please-version diff --git a/src/beeper_desktop_api/lib/.keep b/src/beeper_desktop_api/lib/.keep new file mode 100644 index 0000000..5e2c99f --- /dev/null +++ b/src/beeper_desktop_api/lib/.keep @@ -0,0 +1,4 @@ +File generated from our OpenAPI spec by Stainless. + +This directory can be used to store custom files to expand the SDK. +It is ignored by Stainless code generation and its content (other than this keep file) won't be touched. \ No newline at end of file diff --git a/src/beeper_desktop_api/pagination.py b/src/beeper_desktop_api/pagination.py new file mode 100644 index 0000000..b3dc44c --- /dev/null +++ b/src/beeper_desktop_api/pagination.py @@ -0,0 +1,132 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Generic, TypeVar, Optional +from typing_extensions import override + +from pydantic import Field as FieldInfo + +from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage + +__all__ = ["SyncCursorSearch", "AsyncCursorSearch", "SyncCursorNoLimit", "AsyncCursorNoLimit"] + +_T = TypeVar("_T") + + +class SyncCursorSearch(BaseSyncPage[_T], BasePage[_T], Generic[_T]): + items: List[_T] + has_more: Optional[bool] = FieldInfo(alias="hasMore", default=None) + oldest_cursor: Optional[str] = FieldInfo(alias="oldestCursor", default=None) + newest_cursor: Optional[str] = FieldInfo(alias="newestCursor", default=None) + + @override + def _get_page_items(self) -> List[_T]: + items = self.items + if not items: + return [] + return items + + @override + def has_next_page(self) -> bool: + has_more = self.has_more + if has_more is not None and has_more is False: + return False + + return super().has_next_page() + + @override + def next_page_info(self) -> Optional[PageInfo]: + oldest_cursor = self.oldest_cursor + if not oldest_cursor: + return None + + return PageInfo(params={"cursor": oldest_cursor}) + + +class AsyncCursorSearch(BaseAsyncPage[_T], BasePage[_T], Generic[_T]): + items: List[_T] + has_more: Optional[bool] = FieldInfo(alias="hasMore", default=None) + oldest_cursor: Optional[str] = FieldInfo(alias="oldestCursor", default=None) + newest_cursor: Optional[str] = FieldInfo(alias="newestCursor", default=None) + + @override + def _get_page_items(self) -> List[_T]: + items = self.items + if not items: + return [] + return items + + @override + def has_next_page(self) -> bool: + has_more = self.has_more + if has_more is not None and has_more is False: + return False + + return super().has_next_page() + + @override + def next_page_info(self) -> Optional[PageInfo]: + oldest_cursor = self.oldest_cursor + if not oldest_cursor: + return None + + return PageInfo(params={"cursor": oldest_cursor}) + + +class SyncCursorNoLimit(BaseSyncPage[_T], BasePage[_T], Generic[_T]): + items: List[_T] + has_more: Optional[bool] = FieldInfo(alias="hasMore", default=None) + oldest_cursor: Optional[str] = FieldInfo(alias="oldestCursor", default=None) + newest_cursor: Optional[str] = FieldInfo(alias="newestCursor", default=None) + + @override + def _get_page_items(self) -> List[_T]: + items = self.items + if not items: + return [] + return items + + @override + def has_next_page(self) -> bool: + has_more = self.has_more + if has_more is not None and has_more is False: + return False + + return super().has_next_page() + + @override + def next_page_info(self) -> Optional[PageInfo]: + oldest_cursor = self.oldest_cursor + if not oldest_cursor: + return None + + return PageInfo(params={"cursor": oldest_cursor}) + + +class AsyncCursorNoLimit(BaseAsyncPage[_T], BasePage[_T], Generic[_T]): + items: List[_T] + has_more: Optional[bool] = FieldInfo(alias="hasMore", default=None) + oldest_cursor: Optional[str] = FieldInfo(alias="oldestCursor", default=None) + newest_cursor: Optional[str] = FieldInfo(alias="newestCursor", default=None) + + @override + def _get_page_items(self) -> List[_T]: + items = self.items + if not items: + return [] + return items + + @override + def has_next_page(self) -> bool: + has_more = self.has_more + if has_more is not None and has_more is False: + return False + + return super().has_next_page() + + @override + def next_page_info(self) -> Optional[PageInfo]: + oldest_cursor = self.oldest_cursor + if not oldest_cursor: + return None + + return PageInfo(params={"cursor": oldest_cursor}) diff --git a/src/beeper_desktop_api/py.typed b/src/beeper_desktop_api/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/src/beeper_desktop_api/resources/__init__.py b/src/beeper_desktop_api/resources/__init__.py new file mode 100644 index 0000000..528054c --- /dev/null +++ b/src/beeper_desktop_api/resources/__init__.py @@ -0,0 +1,103 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .app import ( + AppResource, + AsyncAppResource, + AppResourceWithRawResponse, + AsyncAppResourceWithRawResponse, + AppResourceWithStreamingResponse, + AsyncAppResourceWithStreamingResponse, +) +from .info import ( + InfoResource, + AsyncInfoResource, + InfoResourceWithRawResponse, + AsyncInfoResourceWithRawResponse, + InfoResourceWithStreamingResponse, + AsyncInfoResourceWithStreamingResponse, +) +from .chats import ( + ChatsResource, + AsyncChatsResource, + ChatsResourceWithRawResponse, + AsyncChatsResourceWithRawResponse, + ChatsResourceWithStreamingResponse, + AsyncChatsResourceWithStreamingResponse, +) +from .assets import ( + AssetsResource, + AsyncAssetsResource, + AssetsResourceWithRawResponse, + AsyncAssetsResourceWithRawResponse, + AssetsResourceWithStreamingResponse, + AsyncAssetsResourceWithStreamingResponse, +) +from .bridges import ( + BridgesResource, + AsyncBridgesResource, + BridgesResourceWithRawResponse, + AsyncBridgesResourceWithRawResponse, + BridgesResourceWithStreamingResponse, + AsyncBridgesResourceWithStreamingResponse, +) +from .accounts import ( + AccountsResource, + AsyncAccountsResource, + AccountsResourceWithRawResponse, + AsyncAccountsResourceWithRawResponse, + AccountsResourceWithStreamingResponse, + AsyncAccountsResourceWithStreamingResponse, +) +from .messages import ( + MessagesResource, + AsyncMessagesResource, + MessagesResourceWithRawResponse, + AsyncMessagesResourceWithRawResponse, + MessagesResourceWithStreamingResponse, + AsyncMessagesResourceWithStreamingResponse, +) + +__all__ = [ + "AccountsResource", + "AsyncAccountsResource", + "AccountsResourceWithRawResponse", + "AsyncAccountsResourceWithRawResponse", + "AccountsResourceWithStreamingResponse", + "AsyncAccountsResourceWithStreamingResponse", + "BridgesResource", + "AsyncBridgesResource", + "BridgesResourceWithRawResponse", + "AsyncBridgesResourceWithRawResponse", + "BridgesResourceWithStreamingResponse", + "AsyncBridgesResourceWithStreamingResponse", + "ChatsResource", + "AsyncChatsResource", + "ChatsResourceWithRawResponse", + "AsyncChatsResourceWithRawResponse", + "ChatsResourceWithStreamingResponse", + "AsyncChatsResourceWithStreamingResponse", + "MessagesResource", + "AsyncMessagesResource", + "MessagesResourceWithRawResponse", + "AsyncMessagesResourceWithRawResponse", + "MessagesResourceWithStreamingResponse", + "AsyncMessagesResourceWithStreamingResponse", + "AssetsResource", + "AsyncAssetsResource", + "AssetsResourceWithRawResponse", + "AsyncAssetsResourceWithRawResponse", + "AssetsResourceWithStreamingResponse", + "AsyncAssetsResourceWithStreamingResponse", + "InfoResource", + "AsyncInfoResource", + "InfoResourceWithRawResponse", + "AsyncInfoResourceWithRawResponse", + "InfoResourceWithStreamingResponse", + "AsyncInfoResourceWithStreamingResponse", + "AppResource", + "AsyncAppResource", + "AppResourceWithRawResponse", + "AsyncAppResourceWithRawResponse", + "AppResourceWithStreamingResponse", + "AsyncAppResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/accounts/__init__.py b/src/beeper_desktop_api/resources/accounts/__init__.py new file mode 100644 index 0000000..13ef88f --- /dev/null +++ b/src/beeper_desktop_api/resources/accounts/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .accounts import ( + AccountsResource, + AsyncAccountsResource, + AccountsResourceWithRawResponse, + AsyncAccountsResourceWithRawResponse, + AccountsResourceWithStreamingResponse, + AsyncAccountsResourceWithStreamingResponse, +) +from .contacts import ( + ContactsResource, + AsyncContactsResource, + ContactsResourceWithRawResponse, + AsyncContactsResourceWithRawResponse, + ContactsResourceWithStreamingResponse, + AsyncContactsResourceWithStreamingResponse, +) + +__all__ = [ + "ContactsResource", + "AsyncContactsResource", + "ContactsResourceWithRawResponse", + "AsyncContactsResourceWithRawResponse", + "ContactsResourceWithStreamingResponse", + "AsyncContactsResourceWithStreamingResponse", + "AccountsResource", + "AsyncAccountsResource", + "AccountsResourceWithRawResponse", + "AsyncAccountsResourceWithRawResponse", + "AccountsResourceWithStreamingResponse", + "AsyncAccountsResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/accounts/accounts.py b/src/beeper_desktop_api/resources/accounts/accounts.py new file mode 100644 index 0000000..8c247e4 --- /dev/null +++ b/src/beeper_desktop_api/resources/accounts/accounts.py @@ -0,0 +1,267 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from .contacts import ( + ContactsResource, + AsyncContactsResource, + ContactsResourceWithRawResponse, + AsyncContactsResourceWithRawResponse, + ContactsResourceWithStreamingResponse, + AsyncContactsResourceWithStreamingResponse, +) +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.account_list_response import AccountListResponse +from ...types.account_retrieve_response import AccountRetrieveResponse + +__all__ = ["AccountsResource", "AsyncAccountsResource"] + + +class AccountsResource(SyncAPIResource): + """Manage connected chat accounts""" + + @cached_property + def contacts(self) -> ContactsResource: + """Manage contacts on a specific account""" + return ContactsResource(self._client) + + @cached_property + def with_raw_response(self) -> AccountsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AccountsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AccountsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AccountsResourceWithStreamingResponse(self) + + def retrieve( + self, + account_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AccountRetrieveResponse: + """ + Get one chat account connected to this Beeper Client API server. + + Args: + account_id: Account ID this resource belongs to. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return self._get( + path_template("/v1/accounts/{account_id}", account_id=account_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AccountRetrieveResponse, + ) + + def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AccountListResponse: + """ + List chat accounts connected to this Beeper Client API server, including bridge, + network, user identity, and connection status. + """ + return self._get( + "/v1/accounts", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AccountListResponse, + ) + + +class AsyncAccountsResource(AsyncAPIResource): + """Manage connected chat accounts""" + + @cached_property + def contacts(self) -> AsyncContactsResource: + """Manage contacts on a specific account""" + return AsyncContactsResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncAccountsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncAccountsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAccountsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncAccountsResourceWithStreamingResponse(self) + + async def retrieve( + self, + account_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AccountRetrieveResponse: + """ + Get one chat account connected to this Beeper Client API server. + + Args: + account_id: Account ID this resource belongs to. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return await self._get( + path_template("/v1/accounts/{account_id}", account_id=account_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AccountRetrieveResponse, + ) + + async def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AccountListResponse: + """ + List chat accounts connected to this Beeper Client API server, including bridge, + network, user identity, and connection status. + """ + return await self._get( + "/v1/accounts", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AccountListResponse, + ) + + +class AccountsResourceWithRawResponse: + def __init__(self, accounts: AccountsResource) -> None: + self._accounts = accounts + + self.retrieve = to_raw_response_wrapper( + accounts.retrieve, + ) + self.list = to_raw_response_wrapper( + accounts.list, + ) + + @cached_property + def contacts(self) -> ContactsResourceWithRawResponse: + """Manage contacts on a specific account""" + return ContactsResourceWithRawResponse(self._accounts.contacts) + + +class AsyncAccountsResourceWithRawResponse: + def __init__(self, accounts: AsyncAccountsResource) -> None: + self._accounts = accounts + + self.retrieve = async_to_raw_response_wrapper( + accounts.retrieve, + ) + self.list = async_to_raw_response_wrapper( + accounts.list, + ) + + @cached_property + def contacts(self) -> AsyncContactsResourceWithRawResponse: + """Manage contacts on a specific account""" + return AsyncContactsResourceWithRawResponse(self._accounts.contacts) + + +class AccountsResourceWithStreamingResponse: + def __init__(self, accounts: AccountsResource) -> None: + self._accounts = accounts + + self.retrieve = to_streamed_response_wrapper( + accounts.retrieve, + ) + self.list = to_streamed_response_wrapper( + accounts.list, + ) + + @cached_property + def contacts(self) -> ContactsResourceWithStreamingResponse: + """Manage contacts on a specific account""" + return ContactsResourceWithStreamingResponse(self._accounts.contacts) + + +class AsyncAccountsResourceWithStreamingResponse: + def __init__(self, accounts: AsyncAccountsResource) -> None: + self._accounts = accounts + + self.retrieve = async_to_streamed_response_wrapper( + accounts.retrieve, + ) + self.list = async_to_streamed_response_wrapper( + accounts.list, + ) + + @cached_property + def contacts(self) -> AsyncContactsResourceWithStreamingResponse: + """Manage contacts on a specific account""" + return AsyncContactsResourceWithStreamingResponse(self._accounts.contacts) diff --git a/src/beeper_desktop_api/resources/accounts/contacts.py b/src/beeper_desktop_api/resources/accounts/contacts.py new file mode 100644 index 0000000..7c6469d --- /dev/null +++ b/src/beeper_desktop_api/resources/accounts/contacts.py @@ -0,0 +1,327 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...pagination import SyncCursorSearch, AsyncCursorSearch +from ..._base_client import AsyncPaginator, make_request_options +from ...types.accounts import contact_list_params, contact_search_params +from ...types.shared.user import User +from ...types.accounts.contact_search_response import ContactSearchResponse + +__all__ = ["ContactsResource", "AsyncContactsResource"] + + +class ContactsResource(SyncAPIResource): + """Manage contacts on a specific account""" + + @cached_property + def with_raw_response(self) -> ContactsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return ContactsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ContactsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return ContactsResourceWithStreamingResponse(self) + + def list( + self, + account_id: str, + *, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + limit: int | Omit = omit, + query: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SyncCursorSearch[User]: + """ + List merged contacts for a specific account with cursor-based pagination. + + Args: + account_id: Account ID this resource belongs to. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + limit: Maximum contacts to return per page. + + query: Optional search query for contact lookup. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return self._get_api_list( + path_template("/v1/accounts/{account_id}/contacts/list", account_id=account_id), + page=SyncCursorSearch[User], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "direction": direction, + "limit": limit, + "query": query, + }, + contact_list_params.ContactListParams, + ), + ), + model=User, + ) + + def search( + self, + account_id: str, + *, + query: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ContactSearchResponse: + """ + Search contacts on a specific account using merged account contacts, network + search, and exact identifier lookup. + + Args: + account_id: Account ID this resource belongs to. + + query: Text to search contacts by. Matching behavior depends on the network. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return self._get( + path_template("/v1/accounts/{account_id}/contacts", account_id=account_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"query": query}, contact_search_params.ContactSearchParams), + ), + cast_to=ContactSearchResponse, + ) + + +class AsyncContactsResource(AsyncAPIResource): + """Manage contacts on a specific account""" + + @cached_property + def with_raw_response(self) -> AsyncContactsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncContactsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncContactsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncContactsResourceWithStreamingResponse(self) + + def list( + self, + account_id: str, + *, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + limit: int | Omit = omit, + query: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncPaginator[User, AsyncCursorSearch[User]]: + """ + List merged contacts for a specific account with cursor-based pagination. + + Args: + account_id: Account ID this resource belongs to. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + limit: Maximum contacts to return per page. + + query: Optional search query for contact lookup. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return self._get_api_list( + path_template("/v1/accounts/{account_id}/contacts/list", account_id=account_id), + page=AsyncCursorSearch[User], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "direction": direction, + "limit": limit, + "query": query, + }, + contact_list_params.ContactListParams, + ), + ), + model=User, + ) + + async def search( + self, + account_id: str, + *, + query: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ContactSearchResponse: + """ + Search contacts on a specific account using merged account contacts, network + search, and exact identifier lookup. + + Args: + account_id: Account ID this resource belongs to. + + query: Text to search contacts by. Matching behavior depends on the network. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not account_id: + raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}") + return await self._get( + path_template("/v1/accounts/{account_id}/contacts", account_id=account_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform({"query": query}, contact_search_params.ContactSearchParams), + ), + cast_to=ContactSearchResponse, + ) + + +class ContactsResourceWithRawResponse: + def __init__(self, contacts: ContactsResource) -> None: + self._contacts = contacts + + self.list = to_raw_response_wrapper( + contacts.list, + ) + self.search = to_raw_response_wrapper( + contacts.search, + ) + + +class AsyncContactsResourceWithRawResponse: + def __init__(self, contacts: AsyncContactsResource) -> None: + self._contacts = contacts + + self.list = async_to_raw_response_wrapper( + contacts.list, + ) + self.search = async_to_raw_response_wrapper( + contacts.search, + ) + + +class ContactsResourceWithStreamingResponse: + def __init__(self, contacts: ContactsResource) -> None: + self._contacts = contacts + + self.list = to_streamed_response_wrapper( + contacts.list, + ) + self.search = to_streamed_response_wrapper( + contacts.search, + ) + + +class AsyncContactsResourceWithStreamingResponse: + def __init__(self, contacts: AsyncContactsResource) -> None: + self._contacts = contacts + + self.list = async_to_streamed_response_wrapper( + contacts.list, + ) + self.search = async_to_streamed_response_wrapper( + contacts.search, + ) diff --git a/src/beeper_desktop_api/resources/app/__init__.py b/src/beeper_desktop_api/resources/app/__init__.py new file mode 100644 index 0000000..68b246e --- /dev/null +++ b/src/beeper_desktop_api/resources/app/__init__.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .app import ( + AppResource, + AsyncAppResource, + AppResourceWithRawResponse, + AsyncAppResourceWithRawResponse, + AppResourceWithStreamingResponse, + AsyncAppResourceWithStreamingResponse, +) +from .login import ( + LoginResource, + AsyncLoginResource, + LoginResourceWithRawResponse, + AsyncLoginResourceWithRawResponse, + LoginResourceWithStreamingResponse, + AsyncLoginResourceWithStreamingResponse, +) +from .verifications import ( + VerificationsResource, + AsyncVerificationsResource, + VerificationsResourceWithRawResponse, + AsyncVerificationsResourceWithRawResponse, + VerificationsResourceWithStreamingResponse, + AsyncVerificationsResourceWithStreamingResponse, +) + +__all__ = [ + "LoginResource", + "AsyncLoginResource", + "LoginResourceWithRawResponse", + "AsyncLoginResourceWithRawResponse", + "LoginResourceWithStreamingResponse", + "AsyncLoginResourceWithStreamingResponse", + "VerificationsResource", + "AsyncVerificationsResource", + "VerificationsResourceWithRawResponse", + "AsyncVerificationsResourceWithRawResponse", + "VerificationsResourceWithStreamingResponse", + "AsyncVerificationsResourceWithStreamingResponse", + "AppResource", + "AsyncAppResource", + "AppResourceWithRawResponse", + "AsyncAppResourceWithRawResponse", + "AppResourceWithStreamingResponse", + "AsyncAppResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/app/app.py b/src/beeper_desktop_api/resources/app/app.py new file mode 100644 index 0000000..e53e47f --- /dev/null +++ b/src/beeper_desktop_api/resources/app/app.py @@ -0,0 +1,223 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .login.login import ( + LoginResource, + AsyncLoginResource, + LoginResourceWithRawResponse, + AsyncLoginResourceWithRawResponse, + LoginResourceWithStreamingResponse, + AsyncLoginResourceWithStreamingResponse, +) +from ..._base_client import make_request_options +from .verifications.verifications import ( + VerificationsResource, + AsyncVerificationsResource, + VerificationsResourceWithRawResponse, + AsyncVerificationsResourceWithRawResponse, + VerificationsResourceWithStreamingResponse, + AsyncVerificationsResourceWithStreamingResponse, +) +from ...types.app_session_response import AppSessionResponse + +__all__ = ["AppResource", "AsyncAppResource"] + + +class AppResource(SyncAPIResource): + """Manage Beeper app login and encrypted messaging setup""" + + @cached_property + def login(self) -> LoginResource: + """Complete first-party Beeper app login""" + return LoginResource(self._client) + + @cached_property + def verifications(self) -> VerificationsResource: + """Manage device verification transactions""" + return VerificationsResource(self._client) + + @cached_property + def with_raw_response(self) -> AppResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AppResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AppResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AppResourceWithStreamingResponse(self) + + def session( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AppSessionResponse: + """ + Return the current Beeper Desktop or Beeper Server sign-in and encrypted + messaging setup state. This endpoint is public before sign-in so apps can + discover that sign-in is needed; after sign-in, pass a read token. + """ + return self._get( + "/v1/app/setup", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AppSessionResponse, + ) + + +class AsyncAppResource(AsyncAPIResource): + """Manage Beeper app login and encrypted messaging setup""" + + @cached_property + def login(self) -> AsyncLoginResource: + """Complete first-party Beeper app login""" + return AsyncLoginResource(self._client) + + @cached_property + def verifications(self) -> AsyncVerificationsResource: + """Manage device verification transactions""" + return AsyncVerificationsResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncAppResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncAppResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAppResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncAppResourceWithStreamingResponse(self) + + async def session( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AppSessionResponse: + """ + Return the current Beeper Desktop or Beeper Server sign-in and encrypted + messaging setup state. This endpoint is public before sign-in so apps can + discover that sign-in is needed; after sign-in, pass a read token. + """ + return await self._get( + "/v1/app/setup", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AppSessionResponse, + ) + + +class AppResourceWithRawResponse: + def __init__(self, app: AppResource) -> None: + self._app = app + + self.session = to_raw_response_wrapper( + app.session, + ) + + @cached_property + def login(self) -> LoginResourceWithRawResponse: + """Complete first-party Beeper app login""" + return LoginResourceWithRawResponse(self._app.login) + + @cached_property + def verifications(self) -> VerificationsResourceWithRawResponse: + """Manage device verification transactions""" + return VerificationsResourceWithRawResponse(self._app.verifications) + + +class AsyncAppResourceWithRawResponse: + def __init__(self, app: AsyncAppResource) -> None: + self._app = app + + self.session = async_to_raw_response_wrapper( + app.session, + ) + + @cached_property + def login(self) -> AsyncLoginResourceWithRawResponse: + """Complete first-party Beeper app login""" + return AsyncLoginResourceWithRawResponse(self._app.login) + + @cached_property + def verifications(self) -> AsyncVerificationsResourceWithRawResponse: + """Manage device verification transactions""" + return AsyncVerificationsResourceWithRawResponse(self._app.verifications) + + +class AppResourceWithStreamingResponse: + def __init__(self, app: AppResource) -> None: + self._app = app + + self.session = to_streamed_response_wrapper( + app.session, + ) + + @cached_property + def login(self) -> LoginResourceWithStreamingResponse: + """Complete first-party Beeper app login""" + return LoginResourceWithStreamingResponse(self._app.login) + + @cached_property + def verifications(self) -> VerificationsResourceWithStreamingResponse: + """Manage device verification transactions""" + return VerificationsResourceWithStreamingResponse(self._app.verifications) + + +class AsyncAppResourceWithStreamingResponse: + def __init__(self, app: AsyncAppResource) -> None: + self._app = app + + self.session = async_to_streamed_response_wrapper( + app.session, + ) + + @cached_property + def login(self) -> AsyncLoginResourceWithStreamingResponse: + """Complete first-party Beeper app login""" + return AsyncLoginResourceWithStreamingResponse(self._app.login) + + @cached_property + def verifications(self) -> AsyncVerificationsResourceWithStreamingResponse: + """Manage device verification transactions""" + return AsyncVerificationsResourceWithStreamingResponse(self._app.verifications) diff --git a/src/beeper_desktop_api/resources/app/login/__init__.py b/src/beeper_desktop_api/resources/app/login/__init__.py new file mode 100644 index 0000000..fa69ee9 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .login import ( + LoginResource, + AsyncLoginResource, + LoginResourceWithRawResponse, + AsyncLoginResourceWithRawResponse, + LoginResourceWithStreamingResponse, + AsyncLoginResourceWithStreamingResponse, +) +from .verification import ( + VerificationResource, + AsyncVerificationResource, + VerificationResourceWithRawResponse, + AsyncVerificationResourceWithRawResponse, + VerificationResourceWithStreamingResponse, + AsyncVerificationResourceWithStreamingResponse, +) + +__all__ = [ + "VerificationResource", + "AsyncVerificationResource", + "VerificationResourceWithRawResponse", + "AsyncVerificationResourceWithRawResponse", + "VerificationResourceWithStreamingResponse", + "AsyncVerificationResourceWithStreamingResponse", + "LoginResource", + "AsyncLoginResource", + "LoginResourceWithRawResponse", + "AsyncLoginResourceWithRawResponse", + "LoginResourceWithStreamingResponse", + "AsyncLoginResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/app/login/login.py b/src/beeper_desktop_api/resources/app/login/login.py new file mode 100644 index 0000000..ed63a26 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/login.py @@ -0,0 +1,552 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Any, cast +from typing_extensions import Literal + +import httpx + +from ...._types import Body, Query, Headers, NoneType, NotGiven, not_given +from ...._utils import maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ....types.app import login_email_params, login_register_params, login_response_params +from ...._base_client import make_request_options +from .verification.verification import ( + VerificationResource, + AsyncVerificationResource, + VerificationResourceWithRawResponse, + AsyncVerificationResourceWithRawResponse, + VerificationResourceWithStreamingResponse, + AsyncVerificationResourceWithStreamingResponse, +) +from ....types.app.login_start_response import LoginStartResponse +from ....types.app.login_register_response import LoginRegisterResponse +from ....types.app.login_response_response import LoginResponseResponse + +__all__ = ["LoginResource", "AsyncLoginResource"] + + +class LoginResource(SyncAPIResource): + """Complete first-party Beeper app login""" + + @cached_property + def verification(self) -> VerificationResource: + return VerificationResource(self._client) + + @cached_property + def with_raw_response(self) -> LoginResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return LoginResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> LoginResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return LoginResourceWithStreamingResponse(self) + + def email( + self, + *, + email: str, + setup_request_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """ + Send a sign-in code to the user email address for app setup. + + Args: + email: Email address to send the sign-in code to. + + setup_request_id: Setup request ID returned by the start step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._post( + "/v1/app/setup/email", + body=maybe_transform( + { + "email": email, + "setup_request_id": setup_request_id, + }, + login_email_params.LoginEmailParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=NoneType, + ) + + def register( + self, + *, + accept_terms: Literal[True], + lead_token: str, + setup_request_id: str, + username: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginRegisterResponse: + """ + Create a Beeper account after the user chooses a username and accepts the Terms + of Use. + + Args: + accept_terms: Confirms that the user agreed to our + [terms of use](https://www.beeper.com/terms-onboarding) and has read our + [privacy policy](https://www.beeper.com/privacy). + + lead_token: Registration token returned by Beeper. + + setup_request_id: Setup request ID returned by the start step. + + username: Username selected by the user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/register", + body=maybe_transform( + { + "accept_terms": accept_terms, + "lead_token": lead_token, + "setup_request_id": setup_request_id, + "username": username, + }, + login_register_params.LoginRegisterParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=LoginRegisterResponse, + ) + + def response( + self, + *, + response: str, + setup_request_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginResponseResponse: + """Finish setup sign-in with the code sent to the user email address. + + If the user + needs a new account, the response includes account creation copy and username + suggestions. + + Args: + response: Sign-in code from the user email. + + setup_request_id: Setup request ID returned by the start step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return cast( + LoginResponseResponse, + self._post( + "/v1/app/setup/response", + body=maybe_transform( + { + "response": response, + "setup_request_id": setup_request_id, + }, + login_response_params.LoginResponseParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=cast( + Any, LoginResponseResponse + ), # Union types cannot be passed in as arguments in the type system + ), + ) + + def start( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginStartResponse: + """Start setting up Beeper Desktop or Beeper Server. + + The flow supports existing + Beeper accounts and new account creation. + """ + return self._post( + "/v1/app/setup/start", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=LoginStartResponse, + ) + + +class AsyncLoginResource(AsyncAPIResource): + """Complete first-party Beeper app login""" + + @cached_property + def verification(self) -> AsyncVerificationResource: + return AsyncVerificationResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncLoginResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncLoginResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncLoginResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncLoginResourceWithStreamingResponse(self) + + async def email( + self, + *, + email: str, + setup_request_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """ + Send a sign-in code to the user email address for app setup. + + Args: + email: Email address to send the sign-in code to. + + setup_request_id: Setup request ID returned by the start step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._post( + "/v1/app/setup/email", + body=await async_maybe_transform( + { + "email": email, + "setup_request_id": setup_request_id, + }, + login_email_params.LoginEmailParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=NoneType, + ) + + async def register( + self, + *, + accept_terms: Literal[True], + lead_token: str, + setup_request_id: str, + username: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginRegisterResponse: + """ + Create a Beeper account after the user chooses a username and accepts the Terms + of Use. + + Args: + accept_terms: Confirms that the user agreed to our + [terms of use](https://www.beeper.com/terms-onboarding) and has read our + [privacy policy](https://www.beeper.com/privacy). + + lead_token: Registration token returned by Beeper. + + setup_request_id: Setup request ID returned by the start step. + + username: Username selected by the user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/register", + body=await async_maybe_transform( + { + "accept_terms": accept_terms, + "lead_token": lead_token, + "setup_request_id": setup_request_id, + "username": username, + }, + login_register_params.LoginRegisterParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=LoginRegisterResponse, + ) + + async def response( + self, + *, + response: str, + setup_request_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginResponseResponse: + """Finish setup sign-in with the code sent to the user email address. + + If the user + needs a new account, the response includes account creation copy and username + suggestions. + + Args: + response: Sign-in code from the user email. + + setup_request_id: Setup request ID returned by the start step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return cast( + LoginResponseResponse, + await self._post( + "/v1/app/setup/response", + body=await async_maybe_transform( + { + "response": response, + "setup_request_id": setup_request_id, + }, + login_response_params.LoginResponseParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=cast( + Any, LoginResponseResponse + ), # Union types cannot be passed in as arguments in the type system + ), + ) + + async def start( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginStartResponse: + """Start setting up Beeper Desktop or Beeper Server. + + The flow supports existing + Beeper accounts and new account creation. + """ + return await self._post( + "/v1/app/setup/start", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=LoginStartResponse, + ) + + +class LoginResourceWithRawResponse: + def __init__(self, login: LoginResource) -> None: + self._login = login + + self.email = to_raw_response_wrapper( + login.email, + ) + self.register = to_raw_response_wrapper( + login.register, + ) + self.response = to_raw_response_wrapper( + login.response, + ) + self.start = to_raw_response_wrapper( + login.start, + ) + + @cached_property + def verification(self) -> VerificationResourceWithRawResponse: + return VerificationResourceWithRawResponse(self._login.verification) + + +class AsyncLoginResourceWithRawResponse: + def __init__(self, login: AsyncLoginResource) -> None: + self._login = login + + self.email = async_to_raw_response_wrapper( + login.email, + ) + self.register = async_to_raw_response_wrapper( + login.register, + ) + self.response = async_to_raw_response_wrapper( + login.response, + ) + self.start = async_to_raw_response_wrapper( + login.start, + ) + + @cached_property + def verification(self) -> AsyncVerificationResourceWithRawResponse: + return AsyncVerificationResourceWithRawResponse(self._login.verification) + + +class LoginResourceWithStreamingResponse: + def __init__(self, login: LoginResource) -> None: + self._login = login + + self.email = to_streamed_response_wrapper( + login.email, + ) + self.register = to_streamed_response_wrapper( + login.register, + ) + self.response = to_streamed_response_wrapper( + login.response, + ) + self.start = to_streamed_response_wrapper( + login.start, + ) + + @cached_property + def verification(self) -> VerificationResourceWithStreamingResponse: + return VerificationResourceWithStreamingResponse(self._login.verification) + + +class AsyncLoginResourceWithStreamingResponse: + def __init__(self, login: AsyncLoginResource) -> None: + self._login = login + + self.email = async_to_streamed_response_wrapper( + login.email, + ) + self.register = async_to_streamed_response_wrapper( + login.register, + ) + self.response = async_to_streamed_response_wrapper( + login.response, + ) + self.start = async_to_streamed_response_wrapper( + login.start, + ) + + @cached_property + def verification(self) -> AsyncVerificationResourceWithStreamingResponse: + return AsyncVerificationResourceWithStreamingResponse(self._login.verification) diff --git a/src/beeper_desktop_api/resources/app/login/verification/__init__.py b/src/beeper_desktop_api/resources/app/login/verification/__init__.py new file mode 100644 index 0000000..05bb4b1 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/verification/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .recovery_key import ( + RecoveryKeyResource, + AsyncRecoveryKeyResource, + RecoveryKeyResourceWithRawResponse, + AsyncRecoveryKeyResourceWithRawResponse, + RecoveryKeyResourceWithStreamingResponse, + AsyncRecoveryKeyResourceWithStreamingResponse, +) +from .verification import ( + VerificationResource, + AsyncVerificationResource, + VerificationResourceWithRawResponse, + AsyncVerificationResourceWithRawResponse, + VerificationResourceWithStreamingResponse, + AsyncVerificationResourceWithStreamingResponse, +) + +__all__ = [ + "RecoveryKeyResource", + "AsyncRecoveryKeyResource", + "RecoveryKeyResourceWithRawResponse", + "AsyncRecoveryKeyResourceWithRawResponse", + "RecoveryKeyResourceWithStreamingResponse", + "AsyncRecoveryKeyResourceWithStreamingResponse", + "VerificationResource", + "AsyncVerificationResource", + "VerificationResourceWithRawResponse", + "AsyncVerificationResourceWithRawResponse", + "VerificationResourceWithStreamingResponse", + "AsyncVerificationResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/app/login/verification/recovery_key/__init__.py b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/__init__.py new file mode 100644 index 0000000..ec6a210 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .reset import ( + ResetResource, + AsyncResetResource, + ResetResourceWithRawResponse, + AsyncResetResourceWithRawResponse, + ResetResourceWithStreamingResponse, + AsyncResetResourceWithStreamingResponse, +) +from .recovery_key import ( + RecoveryKeyResource, + AsyncRecoveryKeyResource, + RecoveryKeyResourceWithRawResponse, + AsyncRecoveryKeyResourceWithRawResponse, + RecoveryKeyResourceWithStreamingResponse, + AsyncRecoveryKeyResourceWithStreamingResponse, +) + +__all__ = [ + "ResetResource", + "AsyncResetResource", + "ResetResourceWithRawResponse", + "AsyncResetResourceWithRawResponse", + "ResetResourceWithStreamingResponse", + "AsyncResetResourceWithStreamingResponse", + "RecoveryKeyResource", + "AsyncRecoveryKeyResource", + "RecoveryKeyResourceWithRawResponse", + "AsyncRecoveryKeyResourceWithRawResponse", + "RecoveryKeyResourceWithStreamingResponse", + "AsyncRecoveryKeyResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/app/login/verification/recovery_key/recovery_key.py b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/recovery_key.py new file mode 100644 index 0000000..ba347a5 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/recovery_key.py @@ -0,0 +1,227 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from .reset import ( + ResetResource, + AsyncResetResource, + ResetResourceWithRawResponse, + AsyncResetResourceWithRawResponse, + ResetResourceWithStreamingResponse, + AsyncResetResourceWithStreamingResponse, +) +from ......_types import Body, Query, Headers, NotGiven, not_given +from ......_utils import maybe_transform, async_maybe_transform +from ......_compat import cached_property +from ......_resource import SyncAPIResource, AsyncAPIResource +from ......_response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ......_base_client import make_request_options +from ......types.app.login.verification import recovery_key_verify_params +from ......types.app.login.verification.recovery_key_verify_response import RecoveryKeyVerifyResponse + +__all__ = ["RecoveryKeyResource", "AsyncRecoveryKeyResource"] + + +class RecoveryKeyResource(SyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def reset(self) -> ResetResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return ResetResource(self._client) + + @cached_property + def with_raw_response(self) -> RecoveryKeyResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return RecoveryKeyResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> RecoveryKeyResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return RecoveryKeyResourceWithStreamingResponse(self) + + def verify( + self, + *, + recovery_key: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RecoveryKeyVerifyResponse: + """ + Unlock encrypted messages with the user recovery key. + + Args: + recovery_key: Recovery key saved by the user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/verification/recovery-key", + body=maybe_transform({"recovery_key": recovery_key}, recovery_key_verify_params.RecoveryKeyVerifyParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RecoveryKeyVerifyResponse, + ) + + +class AsyncRecoveryKeyResource(AsyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def reset(self) -> AsyncResetResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncResetResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncRecoveryKeyResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncRecoveryKeyResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncRecoveryKeyResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncRecoveryKeyResourceWithStreamingResponse(self) + + async def verify( + self, + *, + recovery_key: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RecoveryKeyVerifyResponse: + """ + Unlock encrypted messages with the user recovery key. + + Args: + recovery_key: Recovery key saved by the user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/verification/recovery-key", + body=await async_maybe_transform( + {"recovery_key": recovery_key}, recovery_key_verify_params.RecoveryKeyVerifyParams + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RecoveryKeyVerifyResponse, + ) + + +class RecoveryKeyResourceWithRawResponse: + def __init__(self, recovery_key: RecoveryKeyResource) -> None: + self._recovery_key = recovery_key + + self.verify = to_raw_response_wrapper( + recovery_key.verify, + ) + + @cached_property + def reset(self) -> ResetResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return ResetResourceWithRawResponse(self._recovery_key.reset) + + +class AsyncRecoveryKeyResourceWithRawResponse: + def __init__(self, recovery_key: AsyncRecoveryKeyResource) -> None: + self._recovery_key = recovery_key + + self.verify = async_to_raw_response_wrapper( + recovery_key.verify, + ) + + @cached_property + def reset(self) -> AsyncResetResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncResetResourceWithRawResponse(self._recovery_key.reset) + + +class RecoveryKeyResourceWithStreamingResponse: + def __init__(self, recovery_key: RecoveryKeyResource) -> None: + self._recovery_key = recovery_key + + self.verify = to_streamed_response_wrapper( + recovery_key.verify, + ) + + @cached_property + def reset(self) -> ResetResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return ResetResourceWithStreamingResponse(self._recovery_key.reset) + + +class AsyncRecoveryKeyResourceWithStreamingResponse: + def __init__(self, recovery_key: AsyncRecoveryKeyResource) -> None: + self._recovery_key = recovery_key + + self.verify = async_to_streamed_response_wrapper( + recovery_key.verify, + ) + + @cached_property + def reset(self) -> AsyncResetResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncResetResourceWithStreamingResponse(self._recovery_key.reset) diff --git a/src/beeper_desktop_api/resources/app/login/verification/recovery_key/reset.py b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/reset.py new file mode 100644 index 0000000..0272f0f --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/verification/recovery_key/reset.py @@ -0,0 +1,260 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ......_types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ......_utils import maybe_transform, async_maybe_transform +from ......_compat import cached_property +from ......_resource import SyncAPIResource, AsyncAPIResource +from ......_response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ......_base_client import make_request_options +from ......types.app.login.verification.recovery_key import reset_create_params, reset_confirm_params +from ......types.app.login.verification.recovery_key.reset_create_response import ResetCreateResponse +from ......types.app.login.verification.recovery_key.reset_confirm_response import ResetConfirmResponse + +__all__ = ["ResetResource", "AsyncResetResource"] + + +class ResetResource(SyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> ResetResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return ResetResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ResetResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return ResetResourceWithStreamingResponse(self) + + def create( + self, + *, + existing_recovery_key: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ResetCreateResponse: + """ + Create a new recovery key when the user cannot use the existing one. + + Args: + existing_recovery_key: Existing recovery key, if the user has it. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/verification/recovery-key/reset", + body=maybe_transform( + {"existing_recovery_key": existing_recovery_key}, reset_create_params.ResetCreateParams + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ResetCreateResponse, + ) + + def confirm( + self, + *, + recovery_key: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ResetConfirmResponse: + """ + Confirm that the new recovery key should be used for this account. + + Args: + recovery_key: New recovery key returned by the reset step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/verification/recovery-key/reset/confirm", + body=maybe_transform({"recovery_key": recovery_key}, reset_confirm_params.ResetConfirmParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ResetConfirmResponse, + ) + + +class AsyncResetResource(AsyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> AsyncResetResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncResetResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncResetResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncResetResourceWithStreamingResponse(self) + + async def create( + self, + *, + existing_recovery_key: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ResetCreateResponse: + """ + Create a new recovery key when the user cannot use the existing one. + + Args: + existing_recovery_key: Existing recovery key, if the user has it. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/verification/recovery-key/reset", + body=await async_maybe_transform( + {"existing_recovery_key": existing_recovery_key}, reset_create_params.ResetCreateParams + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ResetCreateResponse, + ) + + async def confirm( + self, + *, + recovery_key: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ResetConfirmResponse: + """ + Confirm that the new recovery key should be used for this account. + + Args: + recovery_key: New recovery key returned by the reset step. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/verification/recovery-key/reset/confirm", + body=await async_maybe_transform({"recovery_key": recovery_key}, reset_confirm_params.ResetConfirmParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ResetConfirmResponse, + ) + + +class ResetResourceWithRawResponse: + def __init__(self, reset: ResetResource) -> None: + self._reset = reset + + self.create = to_raw_response_wrapper( + reset.create, + ) + self.confirm = to_raw_response_wrapper( + reset.confirm, + ) + + +class AsyncResetResourceWithRawResponse: + def __init__(self, reset: AsyncResetResource) -> None: + self._reset = reset + + self.create = async_to_raw_response_wrapper( + reset.create, + ) + self.confirm = async_to_raw_response_wrapper( + reset.confirm, + ) + + +class ResetResourceWithStreamingResponse: + def __init__(self, reset: ResetResource) -> None: + self._reset = reset + + self.create = to_streamed_response_wrapper( + reset.create, + ) + self.confirm = to_streamed_response_wrapper( + reset.confirm, + ) + + +class AsyncResetResourceWithStreamingResponse: + def __init__(self, reset: AsyncResetResource) -> None: + self._reset = reset + + self.create = async_to_streamed_response_wrapper( + reset.create, + ) + self.confirm = async_to_streamed_response_wrapper( + reset.confirm, + ) diff --git a/src/beeper_desktop_api/resources/app/login/verification/verification.py b/src/beeper_desktop_api/resources/app/login/verification/verification.py new file mode 100644 index 0000000..9c940ce --- /dev/null +++ b/src/beeper_desktop_api/resources/app/login/verification/verification.py @@ -0,0 +1,120 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from ....._compat import cached_property +from ....._resource import SyncAPIResource, AsyncAPIResource +from .recovery_key.recovery_key import ( + RecoveryKeyResource, + AsyncRecoveryKeyResource, + RecoveryKeyResourceWithRawResponse, + AsyncRecoveryKeyResourceWithRawResponse, + RecoveryKeyResourceWithStreamingResponse, + AsyncRecoveryKeyResourceWithStreamingResponse, +) + +__all__ = ["VerificationResource", "AsyncVerificationResource"] + + +class VerificationResource(SyncAPIResource): + @cached_property + def recovery_key(self) -> RecoveryKeyResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return RecoveryKeyResource(self._client) + + @cached_property + def with_raw_response(self) -> VerificationResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return VerificationResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> VerificationResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return VerificationResourceWithStreamingResponse(self) + + +class AsyncVerificationResource(AsyncAPIResource): + @cached_property + def recovery_key(self) -> AsyncRecoveryKeyResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncRecoveryKeyResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncVerificationResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncVerificationResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncVerificationResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncVerificationResourceWithStreamingResponse(self) + + +class VerificationResourceWithRawResponse: + def __init__(self, verification: VerificationResource) -> None: + self._verification = verification + + @cached_property + def recovery_key(self) -> RecoveryKeyResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return RecoveryKeyResourceWithRawResponse(self._verification.recovery_key) + + +class AsyncVerificationResourceWithRawResponse: + def __init__(self, verification: AsyncVerificationResource) -> None: + self._verification = verification + + @cached_property + def recovery_key(self) -> AsyncRecoveryKeyResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncRecoveryKeyResourceWithRawResponse(self._verification.recovery_key) + + +class VerificationResourceWithStreamingResponse: + def __init__(self, verification: VerificationResource) -> None: + self._verification = verification + + @cached_property + def recovery_key(self) -> RecoveryKeyResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return RecoveryKeyResourceWithStreamingResponse(self._verification.recovery_key) + + +class AsyncVerificationResourceWithStreamingResponse: + def __init__(self, verification: AsyncVerificationResource) -> None: + self._verification = verification + + @cached_property + def recovery_key(self) -> AsyncRecoveryKeyResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncRecoveryKeyResourceWithStreamingResponse(self._verification.recovery_key) diff --git a/src/beeper_desktop_api/resources/app/verifications/__init__.py b/src/beeper_desktop_api/resources/app/verifications/__init__.py new file mode 100644 index 0000000..b57241e --- /dev/null +++ b/src/beeper_desktop_api/resources/app/verifications/__init__.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .qr import ( + QrResource, + AsyncQrResource, + QrResourceWithRawResponse, + AsyncQrResourceWithRawResponse, + QrResourceWithStreamingResponse, + AsyncQrResourceWithStreamingResponse, +) +from .sas import ( + SASResource, + AsyncSASResource, + SASResourceWithRawResponse, + AsyncSASResourceWithRawResponse, + SASResourceWithStreamingResponse, + AsyncSASResourceWithStreamingResponse, +) +from .verifications import ( + VerificationsResource, + AsyncVerificationsResource, + VerificationsResourceWithRawResponse, + AsyncVerificationsResourceWithRawResponse, + VerificationsResourceWithStreamingResponse, + AsyncVerificationsResourceWithStreamingResponse, +) + +__all__ = [ + "QrResource", + "AsyncQrResource", + "QrResourceWithRawResponse", + "AsyncQrResourceWithRawResponse", + "QrResourceWithStreamingResponse", + "AsyncQrResourceWithStreamingResponse", + "SASResource", + "AsyncSASResource", + "SASResourceWithRawResponse", + "AsyncSASResourceWithRawResponse", + "SASResourceWithStreamingResponse", + "AsyncSASResourceWithStreamingResponse", + "VerificationsResource", + "AsyncVerificationsResource", + "VerificationsResourceWithRawResponse", + "AsyncVerificationsResourceWithRawResponse", + "VerificationsResourceWithStreamingResponse", + "AsyncVerificationsResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/app/verifications/qr.py b/src/beeper_desktop_api/resources/app/verifications/qr.py new file mode 100644 index 0000000..d01a234 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/verifications/qr.py @@ -0,0 +1,262 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ...._types import Body, Query, Headers, NotGiven, not_given +from ...._utils import path_template, maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...._base_client import make_request_options +from ....types.app.verifications import qr_scan_params +from ....types.app.verifications.qr_scan_response import QrScanResponse +from ....types.app.verifications.qr_confirm_scanned_response import QrConfirmScannedResponse + +__all__ = ["QrResource", "AsyncQrResource"] + + +class QrResource(SyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> QrResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return QrResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> QrResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return QrResourceWithStreamingResponse(self) + + def confirm_scanned( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> QrConfirmScannedResponse: + """ + Confirm that another device scanned this device QR code. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._post( + path_template( + "/v1/app/setup/verifications/{verification_id}/qr/confirm-scanned", verification_id=verification_id + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=QrConfirmScannedResponse, + ) + + def scan( + self, + *, + data: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> QrScanResponse: + """ + Submit the QR code scanned from another signed-in device. + + Args: + data: QR code payload scanned from the other device. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/verifications/qr/scan", + body=maybe_transform({"data": data}, qr_scan_params.QrScanParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=QrScanResponse, + ) + + +class AsyncQrResource(AsyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> AsyncQrResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncQrResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncQrResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncQrResourceWithStreamingResponse(self) + + async def confirm_scanned( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> QrConfirmScannedResponse: + """ + Confirm that another device scanned this device QR code. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._post( + path_template( + "/v1/app/setup/verifications/{verification_id}/qr/confirm-scanned", verification_id=verification_id + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=QrConfirmScannedResponse, + ) + + async def scan( + self, + *, + data: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> QrScanResponse: + """ + Submit the QR code scanned from another signed-in device. + + Args: + data: QR code payload scanned from the other device. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/verifications/qr/scan", + body=await async_maybe_transform({"data": data}, qr_scan_params.QrScanParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=QrScanResponse, + ) + + +class QrResourceWithRawResponse: + def __init__(self, qr: QrResource) -> None: + self._qr = qr + + self.confirm_scanned = to_raw_response_wrapper( + qr.confirm_scanned, + ) + self.scan = to_raw_response_wrapper( + qr.scan, + ) + + +class AsyncQrResourceWithRawResponse: + def __init__(self, qr: AsyncQrResource) -> None: + self._qr = qr + + self.confirm_scanned = async_to_raw_response_wrapper( + qr.confirm_scanned, + ) + self.scan = async_to_raw_response_wrapper( + qr.scan, + ) + + +class QrResourceWithStreamingResponse: + def __init__(self, qr: QrResource) -> None: + self._qr = qr + + self.confirm_scanned = to_streamed_response_wrapper( + qr.confirm_scanned, + ) + self.scan = to_streamed_response_wrapper( + qr.scan, + ) + + +class AsyncQrResourceWithStreamingResponse: + def __init__(self, qr: AsyncQrResource) -> None: + self._qr = qr + + self.confirm_scanned = async_to_streamed_response_wrapper( + qr.confirm_scanned, + ) + self.scan = async_to_streamed_response_wrapper( + qr.scan, + ) diff --git a/src/beeper_desktop_api/resources/app/verifications/sas.py b/src/beeper_desktop_api/resources/app/verifications/sas.py new file mode 100644 index 0000000..f5e5143 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/verifications/sas.py @@ -0,0 +1,259 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ...._types import Body, Query, Headers, NotGiven, not_given +from ...._utils import path_template +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...._base_client import make_request_options +from ....types.app.verifications.sas_start_response import SASStartResponse +from ....types.app.verifications.sas_confirm_response import SASConfirmResponse + +__all__ = ["SASResource", "AsyncSASResource"] + + +class SASResource(SyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> SASResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return SASResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SASResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return SASResourceWithStreamingResponse(self) + + def confirm( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SASConfirmResponse: + """ + Confirm that the emoji or number sequence matches on both devices. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._post( + path_template("/v1/app/setup/verifications/{verification_id}/sas/confirm", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SASConfirmResponse, + ) + + def start( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SASStartResponse: + """ + Start emoji comparison for device verification. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._post( + path_template("/v1/app/setup/verifications/{verification_id}/sas/start", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SASStartResponse, + ) + + +class AsyncSASResource(AsyncAPIResource): + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + + @cached_property + def with_raw_response(self) -> AsyncSASResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncSASResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSASResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncSASResourceWithStreamingResponse(self) + + async def confirm( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SASConfirmResponse: + """ + Confirm that the emoji or number sequence matches on both devices. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._post( + path_template("/v1/app/setup/verifications/{verification_id}/sas/confirm", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SASConfirmResponse, + ) + + async def start( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SASStartResponse: + """ + Start emoji comparison for device verification. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._post( + path_template("/v1/app/setup/verifications/{verification_id}/sas/start", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SASStartResponse, + ) + + +class SASResourceWithRawResponse: + def __init__(self, sas: SASResource) -> None: + self._sas = sas + + self.confirm = to_raw_response_wrapper( + sas.confirm, + ) + self.start = to_raw_response_wrapper( + sas.start, + ) + + +class AsyncSASResourceWithRawResponse: + def __init__(self, sas: AsyncSASResource) -> None: + self._sas = sas + + self.confirm = async_to_raw_response_wrapper( + sas.confirm, + ) + self.start = async_to_raw_response_wrapper( + sas.start, + ) + + +class SASResourceWithStreamingResponse: + def __init__(self, sas: SASResource) -> None: + self._sas = sas + + self.confirm = to_streamed_response_wrapper( + sas.confirm, + ) + self.start = to_streamed_response_wrapper( + sas.start, + ) + + +class AsyncSASResourceWithStreamingResponse: + def __init__(self, sas: AsyncSASResource) -> None: + self._sas = sas + + self.confirm = async_to_streamed_response_wrapper( + sas.confirm, + ) + self.start = async_to_streamed_response_wrapper( + sas.start, + ) diff --git a/src/beeper_desktop_api/resources/app/verifications/verifications.py b/src/beeper_desktop_api/resources/app/verifications/verifications.py new file mode 100644 index 0000000..3854036 --- /dev/null +++ b/src/beeper_desktop_api/resources/app/verifications/verifications.py @@ -0,0 +1,625 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from .qr import ( + QrResource, + AsyncQrResource, + QrResourceWithRawResponse, + AsyncQrResourceWithRawResponse, + QrResourceWithStreamingResponse, + AsyncQrResourceWithStreamingResponse, +) +from .sas import ( + SASResource, + AsyncSASResource, + SASResourceWithRawResponse, + AsyncSASResourceWithRawResponse, + SASResourceWithStreamingResponse, + AsyncSASResourceWithStreamingResponse, +) +from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ...._utils import path_template, maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ....types.app import verification_cancel_params, verification_create_params +from ...._base_client import make_request_options +from ....types.app.verification_list_response import VerificationListResponse +from ....types.app.verification_accept_response import VerificationAcceptResponse +from ....types.app.verification_cancel_response import VerificationCancelResponse +from ....types.app.verification_create_response import VerificationCreateResponse +from ....types.app.verification_retrieve_response import VerificationRetrieveResponse + +__all__ = ["VerificationsResource", "AsyncVerificationsResource"] + + +class VerificationsResource(SyncAPIResource): + """Manage device verification transactions""" + + @cached_property + def qr(self) -> QrResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return QrResource(self._client) + + @cached_property + def sas(self) -> SASResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return SASResource(self._client) + + @cached_property + def with_raw_response(self) -> VerificationsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return VerificationsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> VerificationsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return VerificationsResourceWithStreamingResponse(self) + + def create( + self, + *, + purpose: Literal["login", "device"] | Omit = omit, + user_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationCreateResponse: + """ + Start verifying this device from another signed-in device. + + Args: + purpose: Why this verification is being started. + + user_id: Beeper user ID to verify. Defaults to the signed-in user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/app/setup/verifications", + body=maybe_transform( + { + "purpose": purpose, + "user_id": user_id, + }, + verification_create_params.VerificationCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationCreateResponse, + ) + + def retrieve( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationRetrieveResponse: + """ + Get the current state of a device verification transaction. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._get( + path_template("/v1/app/setup/verifications/{verification_id}", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationRetrieveResponse, + ) + + def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationListResponse: + """List pending and active device verifications. + + Use this to recover state without + a WebSocket connection. + """ + return self._get( + "/v1/app/setup/verifications", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationListResponse, + ) + + def accept( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationAcceptResponse: + """ + Accept an incoming device verification request. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._post( + path_template("/v1/app/setup/verifications/{verification_id}/accept", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationAcceptResponse, + ) + + def cancel( + self, + verification_id: str, + *, + code: str | Omit = omit, + reason: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationCancelResponse: + """ + Cancel an active device verification request. + + Args: + verification_id: Verification ID. + + code: Optional cancellation code. + + reason: Optional user-facing cancellation reason. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return self._post( + path_template("/v1/app/setup/verifications/{verification_id}/cancel", verification_id=verification_id), + body=maybe_transform( + { + "code": code, + "reason": reason, + }, + verification_cancel_params.VerificationCancelParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationCancelResponse, + ) + + +class AsyncVerificationsResource(AsyncAPIResource): + """Manage device verification transactions""" + + @cached_property + def qr(self) -> AsyncQrResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncQrResource(self._client) + + @cached_property + def sas(self) -> AsyncSASResource: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncSASResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncVerificationsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncVerificationsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncVerificationsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncVerificationsResourceWithStreamingResponse(self) + + async def create( + self, + *, + purpose: Literal["login", "device"] | Omit = omit, + user_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationCreateResponse: + """ + Start verifying this device from another signed-in device. + + Args: + purpose: Why this verification is being started. + + user_id: Beeper user ID to verify. Defaults to the signed-in user. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/app/setup/verifications", + body=await async_maybe_transform( + { + "purpose": purpose, + "user_id": user_id, + }, + verification_create_params.VerificationCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationCreateResponse, + ) + + async def retrieve( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationRetrieveResponse: + """ + Get the current state of a device verification transaction. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._get( + path_template("/v1/app/setup/verifications/{verification_id}", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationRetrieveResponse, + ) + + async def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationListResponse: + """List pending and active device verifications. + + Use this to recover state without + a WebSocket connection. + """ + return await self._get( + "/v1/app/setup/verifications", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationListResponse, + ) + + async def accept( + self, + verification_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationAcceptResponse: + """ + Accept an incoming device verification request. + + Args: + verification_id: Verification ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._post( + path_template("/v1/app/setup/verifications/{verification_id}/accept", verification_id=verification_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationAcceptResponse, + ) + + async def cancel( + self, + verification_id: str, + *, + code: str | Omit = omit, + reason: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerificationCancelResponse: + """ + Cancel an active device verification request. + + Args: + verification_id: Verification ID. + + code: Optional cancellation code. + + reason: Optional user-facing cancellation reason. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not verification_id: + raise ValueError(f"Expected a non-empty value for `verification_id` but received {verification_id!r}") + return await self._post( + path_template("/v1/app/setup/verifications/{verification_id}/cancel", verification_id=verification_id), + body=await async_maybe_transform( + { + "code": code, + "reason": reason, + }, + verification_cancel_params.VerificationCancelParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerificationCancelResponse, + ) + + +class VerificationsResourceWithRawResponse: + def __init__(self, verifications: VerificationsResource) -> None: + self._verifications = verifications + + self.create = to_raw_response_wrapper( + verifications.create, + ) + self.retrieve = to_raw_response_wrapper( + verifications.retrieve, + ) + self.list = to_raw_response_wrapper( + verifications.list, + ) + self.accept = to_raw_response_wrapper( + verifications.accept, + ) + self.cancel = to_raw_response_wrapper( + verifications.cancel, + ) + + @cached_property + def qr(self) -> QrResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return QrResourceWithRawResponse(self._verifications.qr) + + @cached_property + def sas(self) -> SASResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return SASResourceWithRawResponse(self._verifications.sas) + + +class AsyncVerificationsResourceWithRawResponse: + def __init__(self, verifications: AsyncVerificationsResource) -> None: + self._verifications = verifications + + self.create = async_to_raw_response_wrapper( + verifications.create, + ) + self.retrieve = async_to_raw_response_wrapper( + verifications.retrieve, + ) + self.list = async_to_raw_response_wrapper( + verifications.list, + ) + self.accept = async_to_raw_response_wrapper( + verifications.accept, + ) + self.cancel = async_to_raw_response_wrapper( + verifications.cancel, + ) + + @cached_property + def qr(self) -> AsyncQrResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncQrResourceWithRawResponse(self._verifications.qr) + + @cached_property + def sas(self) -> AsyncSASResourceWithRawResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncSASResourceWithRawResponse(self._verifications.sas) + + +class VerificationsResourceWithStreamingResponse: + def __init__(self, verifications: VerificationsResource) -> None: + self._verifications = verifications + + self.create = to_streamed_response_wrapper( + verifications.create, + ) + self.retrieve = to_streamed_response_wrapper( + verifications.retrieve, + ) + self.list = to_streamed_response_wrapper( + verifications.list, + ) + self.accept = to_streamed_response_wrapper( + verifications.accept, + ) + self.cancel = to_streamed_response_wrapper( + verifications.cancel, + ) + + @cached_property + def qr(self) -> QrResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return QrResourceWithStreamingResponse(self._verifications.qr) + + @cached_property + def sas(self) -> SASResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return SASResourceWithStreamingResponse(self._verifications.sas) + + +class AsyncVerificationsResourceWithStreamingResponse: + def __init__(self, verifications: AsyncVerificationsResource) -> None: + self._verifications = verifications + + self.create = async_to_streamed_response_wrapper( + verifications.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + verifications.retrieve, + ) + self.list = async_to_streamed_response_wrapper( + verifications.list, + ) + self.accept = async_to_streamed_response_wrapper( + verifications.accept, + ) + self.cancel = async_to_streamed_response_wrapper( + verifications.cancel, + ) + + @cached_property + def qr(self) -> AsyncQrResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncQrResourceWithStreamingResponse(self._verifications.qr) + + @cached_property + def sas(self) -> AsyncSASResourceWithStreamingResponse: + """ + First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server. + """ + return AsyncSASResourceWithStreamingResponse(self._verifications.sas) diff --git a/src/beeper_desktop_api/resources/assets.py b/src/beeper_desktop_api/resources/assets.py new file mode 100644 index 0000000..a67081f --- /dev/null +++ b/src/beeper_desktop_api/resources/assets.py @@ -0,0 +1,520 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Mapping, cast + +import httpx + +from ..types import asset_serve_params, asset_upload_params, asset_download_params, asset_upload_base64_params +from .._files import deepcopy_with_paths +from .._types import Body, Omit, Query, Headers, NotGiven, FileTypes, omit, not_given +from .._utils import extract_files, maybe_transform, async_maybe_transform +from .._compat import cached_property +from .._resource import SyncAPIResource, AsyncAPIResource +from .._response import ( + BinaryAPIResponse, + AsyncBinaryAPIResponse, + StreamedBinaryAPIResponse, + AsyncStreamedBinaryAPIResponse, + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + to_custom_raw_response_wrapper, + async_to_streamed_response_wrapper, + to_custom_streamed_response_wrapper, + async_to_custom_raw_response_wrapper, + async_to_custom_streamed_response_wrapper, +) +from .._base_client import make_request_options +from ..types.asset_upload_response import AssetUploadResponse +from ..types.asset_download_response import AssetDownloadResponse +from ..types.asset_upload_base64_response import AssetUploadBase64Response + +__all__ = ["AssetsResource", "AsyncAssetsResource"] + + +class AssetsResource(SyncAPIResource): + """Manage assets in Beeper Desktop, like message attachments""" + + @cached_property + def with_raw_response(self) -> AssetsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AssetsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AssetsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AssetsResourceWithStreamingResponse(self) + + def download( + self, + *, + url: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetDownloadResponse: + """ + Download a file from an mxc:// or localmxc:// URL to the device running the + Beeper Client API and return the local file URL. + + Args: + url: Beeper media URL (mxc:// or localmxc://) for the file to download. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/assets/download", + body=maybe_transform({"url": url}, asset_download_params.AssetDownloadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetDownloadResponse, + ) + + def serve( + self, + *, + url: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BinaryAPIResponse: + """Stream a file given an mxc://, localmxc://, or file:// URL. + + Downloads first if + not cached. Supports Range requests for seeking in large files. + + Args: + url: File URL to serve. Accepts mxc://, localmxc://, or file:// URLs. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})} + return self._get( + "/v1/assets/serve", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"url": url}, asset_serve_params.AssetServeParams), + ), + cast_to=BinaryAPIResponse, + ) + + def upload( + self, + *, + file: FileTypes, + file_name: str | Omit = omit, + mime_type: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetUploadResponse: + """Upload a file to a temporary location using multipart/form-data. + + Returns an + uploadID that can be referenced when sending a message or creating a draft + attachment. + + Args: + file: The file to upload (max 500 MB). + + file_name: Original filename. Defaults to the uploaded file name if omitted + + mime_type: MIME type. Auto-detected from magic bytes if omitted + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + body = deepcopy_with_paths( + { + "file": file, + "file_name": file_name, + "mime_type": mime_type, + }, + [["file"]], + ) + files = extract_files(cast(Mapping[str, object], body), paths=[["file"]]) + # It should be noted that the actual Content-Type header that will be + # sent to the server will contain a `boundary` parameter, e.g. + # multipart/form-data; boundary=---abc-- + extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})} + return self._post( + "/v1/assets/upload", + body=maybe_transform(body, asset_upload_params.AssetUploadParams), + files=files, + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetUploadResponse, + ) + + def upload_base64( + self, + *, + content: str, + file_name: str | Omit = omit, + mime_type: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetUploadBase64Response: + """Upload a file using a JSON body with base64-encoded content. + + Returns an uploadID + that can be referenced when sending a message or creating a draft attachment. + Alternative to the multipart upload endpoint. + + Args: + content: Base64-encoded file content (max ~500MB decoded) + + file_name: Original filename. Generated if omitted + + mime_type: MIME type. Auto-detected from magic bytes if omitted + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/assets/upload/base64", + body=maybe_transform( + { + "content": content, + "file_name": file_name, + "mime_type": mime_type, + }, + asset_upload_base64_params.AssetUploadBase64Params, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetUploadBase64Response, + ) + + +class AsyncAssetsResource(AsyncAPIResource): + """Manage assets in Beeper Desktop, like message attachments""" + + @cached_property + def with_raw_response(self) -> AsyncAssetsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncAssetsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAssetsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncAssetsResourceWithStreamingResponse(self) + + async def download( + self, + *, + url: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetDownloadResponse: + """ + Download a file from an mxc:// or localmxc:// URL to the device running the + Beeper Client API and return the local file URL. + + Args: + url: Beeper media URL (mxc:// or localmxc://) for the file to download. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/assets/download", + body=await async_maybe_transform({"url": url}, asset_download_params.AssetDownloadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetDownloadResponse, + ) + + async def serve( + self, + *, + url: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncBinaryAPIResponse: + """Stream a file given an mxc://, localmxc://, or file:// URL. + + Downloads first if + not cached. Supports Range requests for seeking in large files. + + Args: + url: File URL to serve. Accepts mxc://, localmxc://, or file:// URLs. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})} + return await self._get( + "/v1/assets/serve", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform({"url": url}, asset_serve_params.AssetServeParams), + ), + cast_to=AsyncBinaryAPIResponse, + ) + + async def upload( + self, + *, + file: FileTypes, + file_name: str | Omit = omit, + mime_type: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetUploadResponse: + """Upload a file to a temporary location using multipart/form-data. + + Returns an + uploadID that can be referenced when sending a message or creating a draft + attachment. + + Args: + file: The file to upload (max 500 MB). + + file_name: Original filename. Defaults to the uploaded file name if omitted + + mime_type: MIME type. Auto-detected from magic bytes if omitted + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + body = deepcopy_with_paths( + { + "file": file, + "file_name": file_name, + "mime_type": mime_type, + }, + [["file"]], + ) + files = extract_files(cast(Mapping[str, object], body), paths=[["file"]]) + # It should be noted that the actual Content-Type header that will be + # sent to the server will contain a `boundary` parameter, e.g. + # multipart/form-data; boundary=---abc-- + extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})} + return await self._post( + "/v1/assets/upload", + body=await async_maybe_transform(body, asset_upload_params.AssetUploadParams), + files=files, + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetUploadResponse, + ) + + async def upload_base64( + self, + *, + content: str, + file_name: str | Omit = omit, + mime_type: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AssetUploadBase64Response: + """Upload a file using a JSON body with base64-encoded content. + + Returns an uploadID + that can be referenced when sending a message or creating a draft attachment. + Alternative to the multipart upload endpoint. + + Args: + content: Base64-encoded file content (max ~500MB decoded) + + file_name: Original filename. Generated if omitted + + mime_type: MIME type. Auto-detected from magic bytes if omitted + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/assets/upload/base64", + body=await async_maybe_transform( + { + "content": content, + "file_name": file_name, + "mime_type": mime_type, + }, + asset_upload_base64_params.AssetUploadBase64Params, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AssetUploadBase64Response, + ) + + +class AssetsResourceWithRawResponse: + def __init__(self, assets: AssetsResource) -> None: + self._assets = assets + + self.download = to_raw_response_wrapper( + assets.download, + ) + self.serve = to_custom_raw_response_wrapper( + assets.serve, + BinaryAPIResponse, + ) + self.upload = to_raw_response_wrapper( + assets.upload, + ) + self.upload_base64 = to_raw_response_wrapper( + assets.upload_base64, + ) + + +class AsyncAssetsResourceWithRawResponse: + def __init__(self, assets: AsyncAssetsResource) -> None: + self._assets = assets + + self.download = async_to_raw_response_wrapper( + assets.download, + ) + self.serve = async_to_custom_raw_response_wrapper( + assets.serve, + AsyncBinaryAPIResponse, + ) + self.upload = async_to_raw_response_wrapper( + assets.upload, + ) + self.upload_base64 = async_to_raw_response_wrapper( + assets.upload_base64, + ) + + +class AssetsResourceWithStreamingResponse: + def __init__(self, assets: AssetsResource) -> None: + self._assets = assets + + self.download = to_streamed_response_wrapper( + assets.download, + ) + self.serve = to_custom_streamed_response_wrapper( + assets.serve, + StreamedBinaryAPIResponse, + ) + self.upload = to_streamed_response_wrapper( + assets.upload, + ) + self.upload_base64 = to_streamed_response_wrapper( + assets.upload_base64, + ) + + +class AsyncAssetsResourceWithStreamingResponse: + def __init__(self, assets: AsyncAssetsResource) -> None: + self._assets = assets + + self.download = async_to_streamed_response_wrapper( + assets.download, + ) + self.serve = async_to_custom_streamed_response_wrapper( + assets.serve, + AsyncStreamedBinaryAPIResponse, + ) + self.upload = async_to_streamed_response_wrapper( + assets.upload, + ) + self.upload_base64 = async_to_streamed_response_wrapper( + assets.upload_base64, + ) diff --git a/src/beeper_desktop_api/resources/bridges/__init__.py b/src/beeper_desktop_api/resources/bridges/__init__.py new file mode 100644 index 0000000..e0e3ac7 --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/__init__.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .bridges import ( + BridgesResource, + AsyncBridgesResource, + BridgesResourceWithRawResponse, + AsyncBridgesResourceWithRawResponse, + BridgesResourceWithStreamingResponse, + AsyncBridgesResourceWithStreamingResponse, +) +from .login_flows import ( + LoginFlowsResource, + AsyncLoginFlowsResource, + LoginFlowsResourceWithRawResponse, + AsyncLoginFlowsResourceWithRawResponse, + LoginFlowsResourceWithStreamingResponse, + AsyncLoginFlowsResourceWithStreamingResponse, +) +from .login_sessions import ( + LoginSessionsResource, + AsyncLoginSessionsResource, + LoginSessionsResourceWithRawResponse, + AsyncLoginSessionsResourceWithRawResponse, + LoginSessionsResourceWithStreamingResponse, + AsyncLoginSessionsResourceWithStreamingResponse, +) + +__all__ = [ + "LoginFlowsResource", + "AsyncLoginFlowsResource", + "LoginFlowsResourceWithRawResponse", + "AsyncLoginFlowsResourceWithRawResponse", + "LoginFlowsResourceWithStreamingResponse", + "AsyncLoginFlowsResourceWithStreamingResponse", + "LoginSessionsResource", + "AsyncLoginSessionsResource", + "LoginSessionsResourceWithRawResponse", + "AsyncLoginSessionsResourceWithRawResponse", + "LoginSessionsResourceWithStreamingResponse", + "AsyncLoginSessionsResourceWithStreamingResponse", + "BridgesResource", + "AsyncBridgesResource", + "BridgesResourceWithRawResponse", + "AsyncBridgesResourceWithRawResponse", + "BridgesResourceWithStreamingResponse", + "AsyncBridgesResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/bridges/bridges.py b/src/beeper_desktop_api/resources/bridges/bridges.py new file mode 100644 index 0000000..c34145c --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/bridges.py @@ -0,0 +1,420 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .login_flows import ( + LoginFlowsResource, + AsyncLoginFlowsResource, + LoginFlowsResourceWithRawResponse, + AsyncLoginFlowsResourceWithRawResponse, + LoginFlowsResourceWithStreamingResponse, + AsyncLoginFlowsResourceWithStreamingResponse, +) +from ..._base_client import make_request_options +from ...types.bridge_list_response import BridgeListResponse +from .login_sessions.login_sessions import ( + LoginSessionsResource, + AsyncLoginSessionsResource, + LoginSessionsResourceWithRawResponse, + AsyncLoginSessionsResourceWithRawResponse, + LoginSessionsResourceWithStreamingResponse, + AsyncLoginSessionsResourceWithStreamingResponse, +) +from ...types.bridge_retrieve_response import BridgeRetrieveResponse +from ...types.provisioning_capabilities import ProvisioningCapabilities + +__all__ = ["BridgesResource", "AsyncBridgesResource"] + + +class BridgesResource(SyncAPIResource): + """Manage bridge-backed account types, connections, and login sessions""" + + @cached_property + def login_flows(self) -> LoginFlowsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginFlowsResource(self._client) + + @cached_property + def login_sessions(self) -> LoginSessionsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginSessionsResource(self._client) + + @cached_property + def with_raw_response(self) -> BridgesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return BridgesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> BridgesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return BridgesResourceWithStreamingResponse(self) + + def retrieve( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BridgeRetrieveResponse: + """ + Get one bridge, including the chat accounts connected through it. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return self._get( + path_template("/v1/bridges/{bridge_id}", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=BridgeRetrieveResponse, + ) + + def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BridgeListResponse: + """List available bridges. + + A bridge is a chat-network connector that can connect or + reconnect chat accounts. Connected accounts use the same Account schema as GET + /v1/accounts. + """ + return self._get( + "/v1/bridges", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=BridgeListResponse, + ) + + def retrieve_capabilities( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ProvisioningCapabilities: + """Get advanced network capabilities for a bridge. + + This endpoint is intended for + clients that build custom connect or chat-creation flows. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return self._get( + path_template("/v1/bridges/{bridge_id}/capabilities", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ProvisioningCapabilities, + ) + + +class AsyncBridgesResource(AsyncAPIResource): + """Manage bridge-backed account types, connections, and login sessions""" + + @cached_property + def login_flows(self) -> AsyncLoginFlowsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginFlowsResource(self._client) + + @cached_property + def login_sessions(self) -> AsyncLoginSessionsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginSessionsResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncBridgesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncBridgesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncBridgesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncBridgesResourceWithStreamingResponse(self) + + async def retrieve( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BridgeRetrieveResponse: + """ + Get one bridge, including the chat accounts connected through it. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return await self._get( + path_template("/v1/bridges/{bridge_id}", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=BridgeRetrieveResponse, + ) + + async def list( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BridgeListResponse: + """List available bridges. + + A bridge is a chat-network connector that can connect or + reconnect chat accounts. Connected accounts use the same Account schema as GET + /v1/accounts. + """ + return await self._get( + "/v1/bridges", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=BridgeListResponse, + ) + + async def retrieve_capabilities( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ProvisioningCapabilities: + """Get advanced network capabilities for a bridge. + + This endpoint is intended for + clients that build custom connect or chat-creation flows. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return await self._get( + path_template("/v1/bridges/{bridge_id}/capabilities", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ProvisioningCapabilities, + ) + + +class BridgesResourceWithRawResponse: + def __init__(self, bridges: BridgesResource) -> None: + self._bridges = bridges + + self.retrieve = to_raw_response_wrapper( + bridges.retrieve, + ) + self.list = to_raw_response_wrapper( + bridges.list, + ) + self.retrieve_capabilities = to_raw_response_wrapper( + bridges.retrieve_capabilities, + ) + + @cached_property + def login_flows(self) -> LoginFlowsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginFlowsResourceWithRawResponse(self._bridges.login_flows) + + @cached_property + def login_sessions(self) -> LoginSessionsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginSessionsResourceWithRawResponse(self._bridges.login_sessions) + + +class AsyncBridgesResourceWithRawResponse: + def __init__(self, bridges: AsyncBridgesResource) -> None: + self._bridges = bridges + + self.retrieve = async_to_raw_response_wrapper( + bridges.retrieve, + ) + self.list = async_to_raw_response_wrapper( + bridges.list, + ) + self.retrieve_capabilities = async_to_raw_response_wrapper( + bridges.retrieve_capabilities, + ) + + @cached_property + def login_flows(self) -> AsyncLoginFlowsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginFlowsResourceWithRawResponse(self._bridges.login_flows) + + @cached_property + def login_sessions(self) -> AsyncLoginSessionsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginSessionsResourceWithRawResponse(self._bridges.login_sessions) + + +class BridgesResourceWithStreamingResponse: + def __init__(self, bridges: BridgesResource) -> None: + self._bridges = bridges + + self.retrieve = to_streamed_response_wrapper( + bridges.retrieve, + ) + self.list = to_streamed_response_wrapper( + bridges.list, + ) + self.retrieve_capabilities = to_streamed_response_wrapper( + bridges.retrieve_capabilities, + ) + + @cached_property + def login_flows(self) -> LoginFlowsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginFlowsResourceWithStreamingResponse(self._bridges.login_flows) + + @cached_property + def login_sessions(self) -> LoginSessionsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return LoginSessionsResourceWithStreamingResponse(self._bridges.login_sessions) + + +class AsyncBridgesResourceWithStreamingResponse: + def __init__(self, bridges: AsyncBridgesResource) -> None: + self._bridges = bridges + + self.retrieve = async_to_streamed_response_wrapper( + bridges.retrieve, + ) + self.list = async_to_streamed_response_wrapper( + bridges.list, + ) + self.retrieve_capabilities = async_to_streamed_response_wrapper( + bridges.retrieve_capabilities, + ) + + @cached_property + def login_flows(self) -> AsyncLoginFlowsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginFlowsResourceWithStreamingResponse(self._bridges.login_flows) + + @cached_property + def login_sessions(self) -> AsyncLoginSessionsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncLoginSessionsResourceWithStreamingResponse(self._bridges.login_sessions) diff --git a/src/beeper_desktop_api/resources/bridges/login_flows.py b/src/beeper_desktop_api/resources/bridges/login_flows.py new file mode 100644 index 0000000..bc14e73 --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/login_flows.py @@ -0,0 +1,180 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.bridges.login_flow_list_response import LoginFlowListResponse + +__all__ = ["LoginFlowsResource", "AsyncLoginFlowsResource"] + + +class LoginFlowsResource(SyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def with_raw_response(self) -> LoginFlowsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return LoginFlowsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> LoginFlowsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return LoginFlowsResourceWithStreamingResponse(self) + + def list( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginFlowListResponse: + """List connect and reconnect flow options for a bridge. + + Use a flowID when creating + a bridge login session. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return self._get( + path_template("/v1/bridges/{bridge_id}/login-flows", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginFlowListResponse, + ) + + +class AsyncLoginFlowsResource(AsyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def with_raw_response(self) -> AsyncLoginFlowsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncLoginFlowsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncLoginFlowsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncLoginFlowsResourceWithStreamingResponse(self) + + async def list( + self, + bridge_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginFlowListResponse: + """List connect and reconnect flow options for a bridge. + + Use a flowID when creating + a bridge login session. + + Args: + bridge_id: Bridge ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return await self._get( + path_template("/v1/bridges/{bridge_id}/login-flows", bridge_id=bridge_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginFlowListResponse, + ) + + +class LoginFlowsResourceWithRawResponse: + def __init__(self, login_flows: LoginFlowsResource) -> None: + self._login_flows = login_flows + + self.list = to_raw_response_wrapper( + login_flows.list, + ) + + +class AsyncLoginFlowsResourceWithRawResponse: + def __init__(self, login_flows: AsyncLoginFlowsResource) -> None: + self._login_flows = login_flows + + self.list = async_to_raw_response_wrapper( + login_flows.list, + ) + + +class LoginFlowsResourceWithStreamingResponse: + def __init__(self, login_flows: LoginFlowsResource) -> None: + self._login_flows = login_flows + + self.list = to_streamed_response_wrapper( + login_flows.list, + ) + + +class AsyncLoginFlowsResourceWithStreamingResponse: + def __init__(self, login_flows: AsyncLoginFlowsResource) -> None: + self._login_flows = login_flows + + self.list = async_to_streamed_response_wrapper( + login_flows.list, + ) diff --git a/src/beeper_desktop_api/resources/bridges/login_sessions/__init__.py b/src/beeper_desktop_api/resources/bridges/login_sessions/__init__.py new file mode 100644 index 0000000..18becaa --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/login_sessions/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .steps import ( + StepsResource, + AsyncStepsResource, + StepsResourceWithRawResponse, + AsyncStepsResourceWithRawResponse, + StepsResourceWithStreamingResponse, + AsyncStepsResourceWithStreamingResponse, +) +from .login_sessions import ( + LoginSessionsResource, + AsyncLoginSessionsResource, + LoginSessionsResourceWithRawResponse, + AsyncLoginSessionsResourceWithRawResponse, + LoginSessionsResourceWithStreamingResponse, + AsyncLoginSessionsResourceWithStreamingResponse, +) + +__all__ = [ + "StepsResource", + "AsyncStepsResource", + "StepsResourceWithRawResponse", + "AsyncStepsResourceWithRawResponse", + "StepsResourceWithStreamingResponse", + "AsyncStepsResourceWithStreamingResponse", + "LoginSessionsResource", + "AsyncLoginSessionsResource", + "LoginSessionsResourceWithRawResponse", + "AsyncLoginSessionsResourceWithRawResponse", + "LoginSessionsResourceWithStreamingResponse", + "AsyncLoginSessionsResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/bridges/login_sessions/login_sessions.py b/src/beeper_desktop_api/resources/bridges/login_sessions/login_sessions.py new file mode 100644 index 0000000..5fd6051 --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/login_sessions/login_sessions.py @@ -0,0 +1,468 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from .steps import ( + StepsResource, + AsyncStepsResource, + StepsResourceWithRawResponse, + AsyncStepsResourceWithRawResponse, + StepsResourceWithStreamingResponse, + AsyncStepsResourceWithStreamingResponse, +) +from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ...._utils import path_template, maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...._base_client import make_request_options +from ....types.bridges import login_session_create_params +from ....types.login_session import LoginSession +from ....types.bridges.login_session_cancel_response import LoginSessionCancelResponse + +__all__ = ["LoginSessionsResource", "AsyncLoginSessionsResource"] + + +class LoginSessionsResource(SyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def steps(self) -> StepsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return StepsResource(self._client) + + @cached_property + def with_raw_response(self) -> LoginSessionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return LoginSessionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> LoginSessionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return LoginSessionsResourceWithStreamingResponse(self) + + def create( + self, + bridge_id: str, + *, + account_id: str | Omit = omit, + flow_id: str | Omit = omit, + login_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Start a temporary bridge login session to connect a new chat account or + reconnect an existing bridge login. Omit loginID and accountID to connect a new + account. + + Args: + bridge_id: Bridge ID. + + account_id: Existing chat account ID to reconnect. Omit to connect a new account. + + flow_id: Optional flow ID returned by the list login flows endpoint. If omitted, Beeper + chooses the default flow. + + login_id: Existing bridge login ID to reconnect. Omit to connect a new account. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return self._post( + path_template("/v1/bridges/{bridge_id}/login-sessions", bridge_id=bridge_id), + body=maybe_transform( + { + "account_id": account_id, + "flow_id": flow_id, + "login_id": login_id, + }, + login_session_create_params.LoginSessionCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + def retrieve( + self, + login_session_id: str, + *, + bridge_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Get the current state of a temporary bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + return self._get( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + def cancel( + self, + login_session_id: str, + *, + bridge_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSessionCancelResponse: + """ + Cancel a temporary bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + return self._delete( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSessionCancelResponse, + ) + + +class AsyncLoginSessionsResource(AsyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def steps(self) -> AsyncStepsResource: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncStepsResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncLoginSessionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncLoginSessionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncLoginSessionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncLoginSessionsResourceWithStreamingResponse(self) + + async def create( + self, + bridge_id: str, + *, + account_id: str | Omit = omit, + flow_id: str | Omit = omit, + login_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Start a temporary bridge login session to connect a new chat account or + reconnect an existing bridge login. Omit loginID and accountID to connect a new + account. + + Args: + bridge_id: Bridge ID. + + account_id: Existing chat account ID to reconnect. Omit to connect a new account. + + flow_id: Optional flow ID returned by the list login flows endpoint. If omitted, Beeper + chooses the default flow. + + login_id: Existing bridge login ID to reconnect. Omit to connect a new account. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + return await self._post( + path_template("/v1/bridges/{bridge_id}/login-sessions", bridge_id=bridge_id), + body=await async_maybe_transform( + { + "account_id": account_id, + "flow_id": flow_id, + "login_id": login_id, + }, + login_session_create_params.LoginSessionCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + async def retrieve( + self, + login_session_id: str, + *, + bridge_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Get the current state of a temporary bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + return await self._get( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + async def cancel( + self, + login_session_id: str, + *, + bridge_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSessionCancelResponse: + """ + Cancel a temporary bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + return await self._delete( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSessionCancelResponse, + ) + + +class LoginSessionsResourceWithRawResponse: + def __init__(self, login_sessions: LoginSessionsResource) -> None: + self._login_sessions = login_sessions + + self.create = to_raw_response_wrapper( + login_sessions.create, + ) + self.retrieve = to_raw_response_wrapper( + login_sessions.retrieve, + ) + self.cancel = to_raw_response_wrapper( + login_sessions.cancel, + ) + + @cached_property + def steps(self) -> StepsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return StepsResourceWithRawResponse(self._login_sessions.steps) + + +class AsyncLoginSessionsResourceWithRawResponse: + def __init__(self, login_sessions: AsyncLoginSessionsResource) -> None: + self._login_sessions = login_sessions + + self.create = async_to_raw_response_wrapper( + login_sessions.create, + ) + self.retrieve = async_to_raw_response_wrapper( + login_sessions.retrieve, + ) + self.cancel = async_to_raw_response_wrapper( + login_sessions.cancel, + ) + + @cached_property + def steps(self) -> AsyncStepsResourceWithRawResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncStepsResourceWithRawResponse(self._login_sessions.steps) + + +class LoginSessionsResourceWithStreamingResponse: + def __init__(self, login_sessions: LoginSessionsResource) -> None: + self._login_sessions = login_sessions + + self.create = to_streamed_response_wrapper( + login_sessions.create, + ) + self.retrieve = to_streamed_response_wrapper( + login_sessions.retrieve, + ) + self.cancel = to_streamed_response_wrapper( + login_sessions.cancel, + ) + + @cached_property + def steps(self) -> StepsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return StepsResourceWithStreamingResponse(self._login_sessions.steps) + + +class AsyncLoginSessionsResourceWithStreamingResponse: + def __init__(self, login_sessions: AsyncLoginSessionsResource) -> None: + self._login_sessions = login_sessions + + self.create = async_to_streamed_response_wrapper( + login_sessions.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + login_sessions.retrieve, + ) + self.cancel = async_to_streamed_response_wrapper( + login_sessions.cancel, + ) + + @cached_property + def steps(self) -> AsyncStepsResourceWithStreamingResponse: + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + return AsyncStepsResourceWithStreamingResponse(self._login_sessions.steps) diff --git a/src/beeper_desktop_api/resources/bridges/login_sessions/steps.py b/src/beeper_desktop_api/resources/bridges/login_sessions/steps.py new file mode 100644 index 0000000..6bc590e --- /dev/null +++ b/src/beeper_desktop_api/resources/bridges/login_sessions/steps.py @@ -0,0 +1,250 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict +from typing_extensions import Literal + +import httpx + +from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ...._utils import path_template, maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...._base_client import make_request_options +from ....types.login_session import LoginSession +from ....types.bridges.login_sessions import step_submit_params + +__all__ = ["StepsResource", "AsyncStepsResource"] + + +class StepsResource(SyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def with_raw_response(self) -> StepsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return StepsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> StepsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return StepsResourceWithStreamingResponse(self) + + def submit( + self, + step_id: str, + *, + bridge_id: str, + login_session_id: str, + type: Literal["user_input", "cookies", "display_and_wait"], + fields: Dict[str, str] | Omit = omit, + last_url: str | Omit = omit, + source: Literal["api", "webview", "browser_extension"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Submit input for the current step of a bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + step_id: Current bridge login session step ID. + + fields: Field values keyed by the field IDs from the current step. + + last_url: Last browser URL reached during a cookies step, if available. + + source: How the step was completed. Omit unless the client needs to distinguish an + embedded webview or browser extension. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + if not step_id: + raise ValueError(f"Expected a non-empty value for `step_id` but received {step_id!r}") + return self._post( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}/steps/{step_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + step_id=step_id, + ), + body=maybe_transform( + { + "type": type, + "fields": fields, + "last_url": last_url, + "source": source, + }, + step_submit_params.StepSubmitParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + +class AsyncStepsResource(AsyncAPIResource): + """ + Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities. + """ + + @cached_property + def with_raw_response(self) -> AsyncStepsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncStepsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncStepsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncStepsResourceWithStreamingResponse(self) + + async def submit( + self, + step_id: str, + *, + bridge_id: str, + login_session_id: str, + type: Literal["user_input", "cookies", "display_and_wait"], + fields: Dict[str, str] | Omit = omit, + last_url: str | Omit = omit, + source: Literal["api", "webview", "browser_extension"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> LoginSession: + """ + Submit input for the current step of a bridge login session. + + Args: + bridge_id: Bridge ID. + + login_session_id: Temporary bridge login session ID. + + step_id: Current bridge login session step ID. + + fields: Field values keyed by the field IDs from the current step. + + last_url: Last browser URL reached during a cookies step, if available. + + source: How the step was completed. Omit unless the client needs to distinguish an + embedded webview or browser extension. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not bridge_id: + raise ValueError(f"Expected a non-empty value for `bridge_id` but received {bridge_id!r}") + if not login_session_id: + raise ValueError(f"Expected a non-empty value for `login_session_id` but received {login_session_id!r}") + if not step_id: + raise ValueError(f"Expected a non-empty value for `step_id` but received {step_id!r}") + return await self._post( + path_template( + "/v1/bridges/{bridge_id}/login-sessions/{login_session_id}/steps/{step_id}", + bridge_id=bridge_id, + login_session_id=login_session_id, + step_id=step_id, + ), + body=await async_maybe_transform( + { + "type": type, + "fields": fields, + "last_url": last_url, + "source": source, + }, + step_submit_params.StepSubmitParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=LoginSession, + ) + + +class StepsResourceWithRawResponse: + def __init__(self, steps: StepsResource) -> None: + self._steps = steps + + self.submit = to_raw_response_wrapper( + steps.submit, + ) + + +class AsyncStepsResourceWithRawResponse: + def __init__(self, steps: AsyncStepsResource) -> None: + self._steps = steps + + self.submit = async_to_raw_response_wrapper( + steps.submit, + ) + + +class StepsResourceWithStreamingResponse: + def __init__(self, steps: StepsResource) -> None: + self._steps = steps + + self.submit = to_streamed_response_wrapper( + steps.submit, + ) + + +class AsyncStepsResourceWithStreamingResponse: + def __init__(self, steps: AsyncStepsResource) -> None: + self._steps = steps + + self.submit = async_to_streamed_response_wrapper( + steps.submit, + ) diff --git a/src/beeper_desktop_api/resources/chats/__init__.py b/src/beeper_desktop_api/resources/chats/__init__.py new file mode 100644 index 0000000..83986f5 --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/__init__.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .chats import ( + ChatsResource, + AsyncChatsResource, + ChatsResourceWithRawResponse, + AsyncChatsResourceWithRawResponse, + ChatsResourceWithStreamingResponse, + AsyncChatsResourceWithStreamingResponse, +) +from .messages import ( + MessagesResource, + AsyncMessagesResource, + MessagesResourceWithRawResponse, + AsyncMessagesResourceWithRawResponse, + MessagesResourceWithStreamingResponse, + AsyncMessagesResourceWithStreamingResponse, +) +from .reminders import ( + RemindersResource, + AsyncRemindersResource, + RemindersResourceWithRawResponse, + AsyncRemindersResourceWithRawResponse, + RemindersResourceWithStreamingResponse, + AsyncRemindersResourceWithStreamingResponse, +) + +__all__ = [ + "RemindersResource", + "AsyncRemindersResource", + "RemindersResourceWithRawResponse", + "AsyncRemindersResourceWithRawResponse", + "RemindersResourceWithStreamingResponse", + "AsyncRemindersResourceWithStreamingResponse", + "MessagesResource", + "AsyncMessagesResource", + "MessagesResourceWithRawResponse", + "AsyncMessagesResourceWithRawResponse", + "MessagesResourceWithStreamingResponse", + "AsyncMessagesResourceWithStreamingResponse", + "ChatsResource", + "AsyncChatsResource", + "ChatsResourceWithRawResponse", + "AsyncChatsResourceWithRawResponse", + "ChatsResourceWithStreamingResponse", + "AsyncChatsResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/chats/chats.py b/src/beeper_desktop_api/resources/chats/chats.py new file mode 100644 index 0000000..66dd5e7 --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/chats.py @@ -0,0 +1,1405 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union, Optional +from datetime import datetime +from typing_extensions import Literal + +import httpx + +from ...types import ( + chat_list_params, + chat_start_params, + chat_create_params, + chat_search_params, + chat_update_params, + chat_archive_params, + chat_retrieve_params, + chat_mark_read_params, + chat_mark_unread_params, +) +from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from .reminders import ( + RemindersResource, + AsyncRemindersResource, + RemindersResourceWithRawResponse, + AsyncRemindersResourceWithRawResponse, + RemindersResourceWithStreamingResponse, + AsyncRemindersResourceWithStreamingResponse, +) +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...pagination import SyncCursorSearch, AsyncCursorSearch, SyncCursorNoLimit, AsyncCursorNoLimit +from ...types.chat import Chat +from ..._base_client import AsyncPaginator, make_request_options +from .messages.messages import ( + MessagesResource, + AsyncMessagesResource, + MessagesResourceWithRawResponse, + AsyncMessagesResourceWithRawResponse, + MessagesResourceWithStreamingResponse, + AsyncMessagesResourceWithStreamingResponse, +) +from ...types.chat_list_response import ChatListResponse +from ...types.chat_start_response import ChatStartResponse +from ...types.chat_create_response import ChatCreateResponse + +__all__ = ["ChatsResource", "AsyncChatsResource"] + + +class ChatsResource(SyncAPIResource): + """Manage chats""" + + @cached_property + def reminders(self) -> RemindersResource: + """Manage reminders for chats""" + return RemindersResource(self._client) + + @cached_property + def messages(self) -> MessagesResource: + """Manage chat messages""" + return MessagesResource(self._client) + + @cached_property + def with_raw_response(self) -> ChatsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return ChatsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ChatsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return ChatsResourceWithStreamingResponse(self) + + def create( + self, + *, + account_id: str, + participant_ids: SequenceNotStr[str], + type: Literal["single", "group"], + message_text: str | Omit = omit, + title: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ChatCreateResponse: + """Create a direct or group chat from participant IDs. + + Returns the created chat. + + Args: + account_id: Account to create or start the chat on. + + participant_ids: User IDs to include in the new chat. + + type: 'single' requires exactly one participantID; 'group' supports multiple + participants and optional title. + + message_text: Optional first message content if the platform requires it to create the chat. + + title: Optional title for group chats; ignored for single chats on most networks. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/chats", + body=maybe_transform( + { + "account_id": account_id, + "participant_ids": participant_ids, + "type": type, + "message_text": message_text, + "title": title, + }, + chat_create_params.ChatCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ChatCreateResponse, + ) + + def retrieve( + self, + chat_id: str, + *, + max_participant_count: Optional[int] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Retrieve chat details, including metadata, participants, and the latest message. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + max_participant_count: Maximum number of participants to return. Use -1 for all; otherwise 0-500. + Defaults to 100. List and search endpoints return up to 20 participants per + chat. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._get( + path_template("/v1/chats/{chat_id}", chat_id=chat_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + {"max_participant_count": max_participant_count}, chat_retrieve_params.ChatRetrieveParams + ), + ), + cast_to=Chat, + ) + + def update( + self, + chat_id: str, + *, + description: Optional[str] | Omit = omit, + draft: Optional[chat_update_params.Draft] | Omit = omit, + img_url: Optional[str] | Omit = omit, + is_archived: bool | Omit = omit, + is_low_priority: bool | Omit = omit, + is_muted: bool | Omit = omit, + is_pinned: bool | Omit = omit, + message_expiry_seconds: Optional[int] | Omit = omit, + title: Optional[str] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """Update supported chat fields. + + Non-empty drafts are accepted only when the + current draft is empty. Send draft=null to clear the draft before setting new + draft text or attachments. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + description: Group chat description/topic. Support depends on the chat account and chat + permissions. + + draft: Draft object to set or clear. Non-empty drafts are only accepted when the + current draft is empty. Send draft=null to clear text and attachments together + before setting a new draft. + + img_url: Local filesystem path to a group chat avatar image. Support depends on the chat + account and chat permissions. + + is_archived: Archive or unarchive the chat. + + is_low_priority: Mark or unmark the chat as low priority when supported by the account. + + is_muted: Mute or unmute the chat. + + is_pinned: Pin or unpin the chat when supported by the account. + + message_expiry_seconds: Disappearing-message timer in seconds, or null to clear when supported. + + title: Custom chat title. Support depends on the chat account and chat permissions. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._patch( + path_template("/v1/chats/{chat_id}", chat_id=chat_id), + body=maybe_transform( + { + "description": description, + "draft": draft, + "img_url": img_url, + "is_archived": is_archived, + "is_low_priority": is_low_priority, + "is_muted": is_muted, + "is_pinned": is_pinned, + "message_expiry_seconds": message_expiry_seconds, + "title": title, + }, + chat_update_params.ChatUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def list( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SyncCursorNoLimit[ChatListResponse]: + """List all chats sorted by last activity (most recent first). + + Combines all + accounts into a single paginated list. + + Args: + account_ids: Limit to specific account IDs. If omitted, fetches from all accounts. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/chats", + page=SyncCursorNoLimit[ChatListResponse], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "cursor": cursor, + "direction": direction, + }, + chat_list_params.ChatListParams, + ), + ), + model=ChatListResponse, + ) + + def archive( + self, + chat_id: str, + *, + archived: bool | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Archive or unarchive a chat. + + Set archived=true to move it to Archive, or + archived=false to move it back to the inbox. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + archived: True to archive, false to unarchive + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._post( + path_template("/v1/chats/{chat_id}/archive", chat_id=chat_id), + body=maybe_transform({"archived": archived}, chat_archive_params.ChatArchiveParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + def mark_read( + self, + chat_id: str, + *, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Mark a chat as read, optionally through a specific message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Optional message ID to mark read through. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._post( + path_template("/v1/chats/{chat_id}/read", chat_id=chat_id), + body=maybe_transform({"message_id": message_id}, chat_mark_read_params.ChatMarkReadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def mark_unread( + self, + chat_id: str, + *, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Mark a chat as unread, optionally from a specific message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Optional message ID to mark unread from. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._post( + path_template("/v1/chats/{chat_id}/unread", chat_id=chat_id), + body=maybe_transform({"message_id": message_id}, chat_mark_unread_params.ChatMarkUnreadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def notify_anyway( + self, + chat_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Send a notification despite the recipient focus state when the network supports + it. Currently intended for iMessage on macOS; unsupported networks return an + error. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._post( + path_template("/v1/chats/{chat_id}/notify-anyway", chat_id=chat_id), + body={}, + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def search( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + inbox: Literal["primary", "low-priority", "archive"] | Omit = omit, + include_muted: Optional[bool] | Omit = omit, + last_activity_after: Union[str, datetime] | Omit = omit, + last_activity_before: Union[str, datetime] | Omit = omit, + limit: int | Omit = omit, + query: str | Omit = omit, + scope: Literal["titles", "participants"] | Omit = omit, + type: Literal["single", "group", "any"] | Omit = omit, + unread_only: Optional[bool] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SyncCursorSearch[Chat]: + """ + Search chats by title, network, or participant names. + + Args: + account_ids: Limit results to specific chat accounts. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + inbox: Filter by inbox type: "primary" (non-archived, non-low-priority), + "low-priority", or "archive". If not specified, shows all chats. + + include_muted: Include chats marked as Muted by the user, which are usually less important. + Default: true. Set to false if the user wants a more refined search. + + last_activity_after: Only include chats with last activity after this ISO 8601 datetime. + + last_activity_before: Only include chats with last activity before this ISO 8601 datetime. + + limit: Set the maximum number of chats to retrieve. Valid range: 1-200, default is 50 + + query: Literal chat search. Use words the user typed, such as "dinner". When multiple + words are provided, all must match. Case-insensitive. + + scope: Search scope: 'titles' matches title + network; 'participants' matches + participant names. + + type: Specify the type of chats to retrieve: use "single" for direct messages, "group" + for group chats, or "any" to get all types + + unread_only: Set to true to only retrieve chats that have unread messages + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/chats/search", + page=SyncCursorSearch[Chat], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "cursor": cursor, + "direction": direction, + "inbox": inbox, + "include_muted": include_muted, + "last_activity_after": last_activity_after, + "last_activity_before": last_activity_before, + "limit": limit, + "query": query, + "scope": scope, + "type": type, + "unread_only": unread_only, + }, + chat_search_params.ChatSearchParams, + ), + ), + model=Chat, + ) + + def start( + self, + *, + account_id: str, + user: chat_start_params.User, + allow_invite: bool | Omit = omit, + message_text: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ChatStartResponse: + """Resolve a user/contact and open a direct chat. + + Reuses and returns an existing + direct chat when one is found. Available in Beeper v4.2.808+. + + Args: + account_id: Account to create or start the chat on. + + user: Contact-like user payload used to resolve the best identifier. + + allow_invite: Whether invite-based DM creation is allowed when required by the platform. + + message_text: Optional first message content if the platform requires it to create the chat. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v1/chats/start", + body=maybe_transform( + { + "account_id": account_id, + "user": user, + "allow_invite": allow_invite, + "message_text": message_text, + }, + chat_start_params.ChatStartParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ChatStartResponse, + ) + + +class AsyncChatsResource(AsyncAPIResource): + """Manage chats""" + + @cached_property + def reminders(self) -> AsyncRemindersResource: + """Manage reminders for chats""" + return AsyncRemindersResource(self._client) + + @cached_property + def messages(self) -> AsyncMessagesResource: + """Manage chat messages""" + return AsyncMessagesResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncChatsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncChatsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncChatsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncChatsResourceWithStreamingResponse(self) + + async def create( + self, + *, + account_id: str, + participant_ids: SequenceNotStr[str], + type: Literal["single", "group"], + message_text: str | Omit = omit, + title: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ChatCreateResponse: + """Create a direct or group chat from participant IDs. + + Returns the created chat. + + Args: + account_id: Account to create or start the chat on. + + participant_ids: User IDs to include in the new chat. + + type: 'single' requires exactly one participantID; 'group' supports multiple + participants and optional title. + + message_text: Optional first message content if the platform requires it to create the chat. + + title: Optional title for group chats; ignored for single chats on most networks. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/chats", + body=await async_maybe_transform( + { + "account_id": account_id, + "participant_ids": participant_ids, + "type": type, + "message_text": message_text, + "title": title, + }, + chat_create_params.ChatCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ChatCreateResponse, + ) + + async def retrieve( + self, + chat_id: str, + *, + max_participant_count: Optional[int] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Retrieve chat details, including metadata, participants, and the latest message. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + max_participant_count: Maximum number of participants to return. Use -1 for all; otherwise 0-500. + Defaults to 100. List and search endpoints return up to 20 participants per + chat. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._get( + path_template("/v1/chats/{chat_id}", chat_id=chat_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"max_participant_count": max_participant_count}, chat_retrieve_params.ChatRetrieveParams + ), + ), + cast_to=Chat, + ) + + async def update( + self, + chat_id: str, + *, + description: Optional[str] | Omit = omit, + draft: Optional[chat_update_params.Draft] | Omit = omit, + img_url: Optional[str] | Omit = omit, + is_archived: bool | Omit = omit, + is_low_priority: bool | Omit = omit, + is_muted: bool | Omit = omit, + is_pinned: bool | Omit = omit, + message_expiry_seconds: Optional[int] | Omit = omit, + title: Optional[str] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """Update supported chat fields. + + Non-empty drafts are accepted only when the + current draft is empty. Send draft=null to clear the draft before setting new + draft text or attachments. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + description: Group chat description/topic. Support depends on the chat account and chat + permissions. + + draft: Draft object to set or clear. Non-empty drafts are only accepted when the + current draft is empty. Send draft=null to clear text and attachments together + before setting a new draft. + + img_url: Local filesystem path to a group chat avatar image. Support depends on the chat + account and chat permissions. + + is_archived: Archive or unarchive the chat. + + is_low_priority: Mark or unmark the chat as low priority when supported by the account. + + is_muted: Mute or unmute the chat. + + is_pinned: Pin or unpin the chat when supported by the account. + + message_expiry_seconds: Disappearing-message timer in seconds, or null to clear when supported. + + title: Custom chat title. Support depends on the chat account and chat permissions. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._patch( + path_template("/v1/chats/{chat_id}", chat_id=chat_id), + body=await async_maybe_transform( + { + "description": description, + "draft": draft, + "img_url": img_url, + "is_archived": is_archived, + "is_low_priority": is_low_priority, + "is_muted": is_muted, + "is_pinned": is_pinned, + "message_expiry_seconds": message_expiry_seconds, + "title": title, + }, + chat_update_params.ChatUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def list( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncPaginator[ChatListResponse, AsyncCursorNoLimit[ChatListResponse]]: + """List all chats sorted by last activity (most recent first). + + Combines all + accounts into a single paginated list. + + Args: + account_ids: Limit to specific account IDs. If omitted, fetches from all accounts. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/chats", + page=AsyncCursorNoLimit[ChatListResponse], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "cursor": cursor, + "direction": direction, + }, + chat_list_params.ChatListParams, + ), + ), + model=ChatListResponse, + ) + + async def archive( + self, + chat_id: str, + *, + archived: bool | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Archive or unarchive a chat. + + Set archived=true to move it to Archive, or + archived=false to move it back to the inbox. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + archived: True to archive, false to unarchive + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._post( + path_template("/v1/chats/{chat_id}/archive", chat_id=chat_id), + body=await async_maybe_transform({"archived": archived}, chat_archive_params.ChatArchiveParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + async def mark_read( + self, + chat_id: str, + *, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Mark a chat as read, optionally through a specific message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Optional message ID to mark read through. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._post( + path_template("/v1/chats/{chat_id}/read", chat_id=chat_id), + body=await async_maybe_transform({"message_id": message_id}, chat_mark_read_params.ChatMarkReadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + async def mark_unread( + self, + chat_id: str, + *, + message_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Mark a chat as unread, optionally from a specific message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Optional message ID to mark unread from. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._post( + path_template("/v1/chats/{chat_id}/unread", chat_id=chat_id), + body=await async_maybe_transform({"message_id": message_id}, chat_mark_unread_params.ChatMarkUnreadParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + async def notify_anyway( + self, + chat_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Chat: + """ + Send a notification despite the recipient focus state when the network supports + it. Currently intended for iMessage on macOS; unsupported networks return an + error. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._post( + path_template("/v1/chats/{chat_id}/notify-anyway", chat_id=chat_id), + body={}, + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Chat, + ) + + def search( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + inbox: Literal["primary", "low-priority", "archive"] | Omit = omit, + include_muted: Optional[bool] | Omit = omit, + last_activity_after: Union[str, datetime] | Omit = omit, + last_activity_before: Union[str, datetime] | Omit = omit, + limit: int | Omit = omit, + query: str | Omit = omit, + scope: Literal["titles", "participants"] | Omit = omit, + type: Literal["single", "group", "any"] | Omit = omit, + unread_only: Optional[bool] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncPaginator[Chat, AsyncCursorSearch[Chat]]: + """ + Search chats by title, network, or participant names. + + Args: + account_ids: Limit results to specific chat accounts. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + inbox: Filter by inbox type: "primary" (non-archived, non-low-priority), + "low-priority", or "archive". If not specified, shows all chats. + + include_muted: Include chats marked as Muted by the user, which are usually less important. + Default: true. Set to false if the user wants a more refined search. + + last_activity_after: Only include chats with last activity after this ISO 8601 datetime. + + last_activity_before: Only include chats with last activity before this ISO 8601 datetime. + + limit: Set the maximum number of chats to retrieve. Valid range: 1-200, default is 50 + + query: Literal chat search. Use words the user typed, such as "dinner". When multiple + words are provided, all must match. Case-insensitive. + + scope: Search scope: 'titles' matches title + network; 'participants' matches + participant names. + + type: Specify the type of chats to retrieve: use "single" for direct messages, "group" + for group chats, or "any" to get all types + + unread_only: Set to true to only retrieve chats that have unread messages + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/chats/search", + page=AsyncCursorSearch[Chat], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "cursor": cursor, + "direction": direction, + "inbox": inbox, + "include_muted": include_muted, + "last_activity_after": last_activity_after, + "last_activity_before": last_activity_before, + "limit": limit, + "query": query, + "scope": scope, + "type": type, + "unread_only": unread_only, + }, + chat_search_params.ChatSearchParams, + ), + ), + model=Chat, + ) + + async def start( + self, + *, + account_id: str, + user: chat_start_params.User, + allow_invite: bool | Omit = omit, + message_text: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ChatStartResponse: + """Resolve a user/contact and open a direct chat. + + Reuses and returns an existing + direct chat when one is found. Available in Beeper v4.2.808+. + + Args: + account_id: Account to create or start the chat on. + + user: Contact-like user payload used to resolve the best identifier. + + allow_invite: Whether invite-based DM creation is allowed when required by the platform. + + message_text: Optional first message content if the platform requires it to create the chat. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v1/chats/start", + body=await async_maybe_transform( + { + "account_id": account_id, + "user": user, + "allow_invite": allow_invite, + "message_text": message_text, + }, + chat_start_params.ChatStartParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ChatStartResponse, + ) + + +class ChatsResourceWithRawResponse: + def __init__(self, chats: ChatsResource) -> None: + self._chats = chats + + self.create = to_raw_response_wrapper( + chats.create, + ) + self.retrieve = to_raw_response_wrapper( + chats.retrieve, + ) + self.update = to_raw_response_wrapper( + chats.update, + ) + self.list = to_raw_response_wrapper( + chats.list, + ) + self.archive = to_raw_response_wrapper( + chats.archive, + ) + self.mark_read = to_raw_response_wrapper( + chats.mark_read, + ) + self.mark_unread = to_raw_response_wrapper( + chats.mark_unread, + ) + self.notify_anyway = to_raw_response_wrapper( + chats.notify_anyway, + ) + self.search = to_raw_response_wrapper( + chats.search, + ) + self.start = to_raw_response_wrapper( + chats.start, + ) + + @cached_property + def reminders(self) -> RemindersResourceWithRawResponse: + """Manage reminders for chats""" + return RemindersResourceWithRawResponse(self._chats.reminders) + + @cached_property + def messages(self) -> MessagesResourceWithRawResponse: + """Manage chat messages""" + return MessagesResourceWithRawResponse(self._chats.messages) + + +class AsyncChatsResourceWithRawResponse: + def __init__(self, chats: AsyncChatsResource) -> None: + self._chats = chats + + self.create = async_to_raw_response_wrapper( + chats.create, + ) + self.retrieve = async_to_raw_response_wrapper( + chats.retrieve, + ) + self.update = async_to_raw_response_wrapper( + chats.update, + ) + self.list = async_to_raw_response_wrapper( + chats.list, + ) + self.archive = async_to_raw_response_wrapper( + chats.archive, + ) + self.mark_read = async_to_raw_response_wrapper( + chats.mark_read, + ) + self.mark_unread = async_to_raw_response_wrapper( + chats.mark_unread, + ) + self.notify_anyway = async_to_raw_response_wrapper( + chats.notify_anyway, + ) + self.search = async_to_raw_response_wrapper( + chats.search, + ) + self.start = async_to_raw_response_wrapper( + chats.start, + ) + + @cached_property + def reminders(self) -> AsyncRemindersResourceWithRawResponse: + """Manage reminders for chats""" + return AsyncRemindersResourceWithRawResponse(self._chats.reminders) + + @cached_property + def messages(self) -> AsyncMessagesResourceWithRawResponse: + """Manage chat messages""" + return AsyncMessagesResourceWithRawResponse(self._chats.messages) + + +class ChatsResourceWithStreamingResponse: + def __init__(self, chats: ChatsResource) -> None: + self._chats = chats + + self.create = to_streamed_response_wrapper( + chats.create, + ) + self.retrieve = to_streamed_response_wrapper( + chats.retrieve, + ) + self.update = to_streamed_response_wrapper( + chats.update, + ) + self.list = to_streamed_response_wrapper( + chats.list, + ) + self.archive = to_streamed_response_wrapper( + chats.archive, + ) + self.mark_read = to_streamed_response_wrapper( + chats.mark_read, + ) + self.mark_unread = to_streamed_response_wrapper( + chats.mark_unread, + ) + self.notify_anyway = to_streamed_response_wrapper( + chats.notify_anyway, + ) + self.search = to_streamed_response_wrapper( + chats.search, + ) + self.start = to_streamed_response_wrapper( + chats.start, + ) + + @cached_property + def reminders(self) -> RemindersResourceWithStreamingResponse: + """Manage reminders for chats""" + return RemindersResourceWithStreamingResponse(self._chats.reminders) + + @cached_property + def messages(self) -> MessagesResourceWithStreamingResponse: + """Manage chat messages""" + return MessagesResourceWithStreamingResponse(self._chats.messages) + + +class AsyncChatsResourceWithStreamingResponse: + def __init__(self, chats: AsyncChatsResource) -> None: + self._chats = chats + + self.create = async_to_streamed_response_wrapper( + chats.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + chats.retrieve, + ) + self.update = async_to_streamed_response_wrapper( + chats.update, + ) + self.list = async_to_streamed_response_wrapper( + chats.list, + ) + self.archive = async_to_streamed_response_wrapper( + chats.archive, + ) + self.mark_read = async_to_streamed_response_wrapper( + chats.mark_read, + ) + self.mark_unread = async_to_streamed_response_wrapper( + chats.mark_unread, + ) + self.notify_anyway = async_to_streamed_response_wrapper( + chats.notify_anyway, + ) + self.search = async_to_streamed_response_wrapper( + chats.search, + ) + self.start = async_to_streamed_response_wrapper( + chats.start, + ) + + @cached_property + def reminders(self) -> AsyncRemindersResourceWithStreamingResponse: + """Manage reminders for chats""" + return AsyncRemindersResourceWithStreamingResponse(self._chats.reminders) + + @cached_property + def messages(self) -> AsyncMessagesResourceWithStreamingResponse: + """Manage chat messages""" + return AsyncMessagesResourceWithStreamingResponse(self._chats.messages) diff --git a/src/beeper_desktop_api/resources/chats/messages/__init__.py b/src/beeper_desktop_api/resources/chats/messages/__init__.py new file mode 100644 index 0000000..8028430 --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/messages/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .messages import ( + MessagesResource, + AsyncMessagesResource, + MessagesResourceWithRawResponse, + AsyncMessagesResourceWithRawResponse, + MessagesResourceWithStreamingResponse, + AsyncMessagesResourceWithStreamingResponse, +) +from .reactions import ( + ReactionsResource, + AsyncReactionsResource, + ReactionsResourceWithRawResponse, + AsyncReactionsResourceWithRawResponse, + ReactionsResourceWithStreamingResponse, + AsyncReactionsResourceWithStreamingResponse, +) + +__all__ = [ + "ReactionsResource", + "AsyncReactionsResource", + "ReactionsResourceWithRawResponse", + "AsyncReactionsResourceWithRawResponse", + "ReactionsResourceWithStreamingResponse", + "AsyncReactionsResourceWithStreamingResponse", + "MessagesResource", + "AsyncMessagesResource", + "MessagesResourceWithRawResponse", + "AsyncMessagesResourceWithRawResponse", + "MessagesResourceWithStreamingResponse", + "AsyncMessagesResourceWithStreamingResponse", +] diff --git a/src/beeper_desktop_api/resources/chats/messages/messages.py b/src/beeper_desktop_api/resources/chats/messages/messages.py new file mode 100644 index 0000000..a6a32d7 --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/messages/messages.py @@ -0,0 +1,112 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .reactions import ( + ReactionsResource, + AsyncReactionsResource, + ReactionsResourceWithRawResponse, + AsyncReactionsResourceWithRawResponse, + ReactionsResourceWithStreamingResponse, + AsyncReactionsResourceWithStreamingResponse, +) +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource + +__all__ = ["MessagesResource", "AsyncMessagesResource"] + + +class MessagesResource(SyncAPIResource): + """Manage chat messages""" + + @cached_property + def reactions(self) -> ReactionsResource: + """Manage message reactions""" + return ReactionsResource(self._client) + + @cached_property + def with_raw_response(self) -> MessagesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return MessagesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> MessagesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return MessagesResourceWithStreamingResponse(self) + + +class AsyncMessagesResource(AsyncAPIResource): + """Manage chat messages""" + + @cached_property + def reactions(self) -> AsyncReactionsResource: + """Manage message reactions""" + return AsyncReactionsResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncMessagesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncMessagesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncMessagesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncMessagesResourceWithStreamingResponse(self) + + +class MessagesResourceWithRawResponse: + def __init__(self, messages: MessagesResource) -> None: + self._messages = messages + + @cached_property + def reactions(self) -> ReactionsResourceWithRawResponse: + """Manage message reactions""" + return ReactionsResourceWithRawResponse(self._messages.reactions) + + +class AsyncMessagesResourceWithRawResponse: + def __init__(self, messages: AsyncMessagesResource) -> None: + self._messages = messages + + @cached_property + def reactions(self) -> AsyncReactionsResourceWithRawResponse: + """Manage message reactions""" + return AsyncReactionsResourceWithRawResponse(self._messages.reactions) + + +class MessagesResourceWithStreamingResponse: + def __init__(self, messages: MessagesResource) -> None: + self._messages = messages + + @cached_property + def reactions(self) -> ReactionsResourceWithStreamingResponse: + """Manage message reactions""" + return ReactionsResourceWithStreamingResponse(self._messages.reactions) + + +class AsyncMessagesResourceWithStreamingResponse: + def __init__(self, messages: AsyncMessagesResource) -> None: + self._messages = messages + + @cached_property + def reactions(self) -> AsyncReactionsResourceWithStreamingResponse: + """Manage message reactions""" + return AsyncReactionsResourceWithStreamingResponse(self._messages.reactions) diff --git a/src/beeper_desktop_api/resources/chats/messages/reactions.py b/src/beeper_desktop_api/resources/chats/messages/reactions.py new file mode 100644 index 0000000..c9199da --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/messages/reactions.py @@ -0,0 +1,332 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ...._utils import path_template, maybe_transform, async_maybe_transform +from ...._compat import cached_property +from ...._resource import SyncAPIResource, AsyncAPIResource +from ...._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...._base_client import make_request_options +from ....types.chats.messages import reaction_add_params +from ....types.chats.messages.reaction_add_response import ReactionAddResponse +from ....types.chats.messages.reaction_delete_response import ReactionDeleteResponse + +__all__ = ["ReactionsResource", "AsyncReactionsResource"] + + +class ReactionsResource(SyncAPIResource): + """Manage message reactions""" + + @cached_property + def with_raw_response(self) -> ReactionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return ReactionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ReactionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return ReactionsResourceWithStreamingResponse(self) + + def delete( + self, + reaction_key: str, + *, + chat_id: str, + message_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ReactionDeleteResponse: + """ + Remove the reaction added by the authenticated user from an existing message. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + reaction_key: Reaction key to remove (emoji, shortcode, or custom emoji key) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + if not reaction_key: + raise ValueError(f"Expected a non-empty value for `reaction_key` but received {reaction_key!r}") + return self._delete( + path_template( + "/v1/chats/{chat_id}/messages/{message_id}/reactions/{reaction_key}", + chat_id=chat_id, + message_id=message_id, + reaction_key=reaction_key, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ReactionDeleteResponse, + ) + + def add( + self, + message_id: str, + *, + chat_id: str, + reaction_key: str, + transaction_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ReactionAddResponse: + """Add a reaction to an existing message. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + reaction_key: Reaction key to add (emoji, shortcode, or custom emoji key) + + transaction_id: Optional transaction ID for deduplication and send tracking + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return self._post( + path_template( + "/v1/chats/{chat_id}/messages/{message_id}/reactions", chat_id=chat_id, message_id=message_id + ), + body=maybe_transform( + { + "reaction_key": reaction_key, + "transaction_id": transaction_id, + }, + reaction_add_params.ReactionAddParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ReactionAddResponse, + ) + + +class AsyncReactionsResource(AsyncAPIResource): + """Manage message reactions""" + + @cached_property + def with_raw_response(self) -> AsyncReactionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncReactionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncReactionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncReactionsResourceWithStreamingResponse(self) + + async def delete( + self, + reaction_key: str, + *, + chat_id: str, + message_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ReactionDeleteResponse: + """ + Remove the reaction added by the authenticated user from an existing message. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + reaction_key: Reaction key to remove (emoji, shortcode, or custom emoji key) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + if not reaction_key: + raise ValueError(f"Expected a non-empty value for `reaction_key` but received {reaction_key!r}") + return await self._delete( + path_template( + "/v1/chats/{chat_id}/messages/{message_id}/reactions/{reaction_key}", + chat_id=chat_id, + message_id=message_id, + reaction_key=reaction_key, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ReactionDeleteResponse, + ) + + async def add( + self, + message_id: str, + *, + chat_id: str, + reaction_key: str, + transaction_id: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ReactionAddResponse: + """Add a reaction to an existing message. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + reaction_key: Reaction key to add (emoji, shortcode, or custom emoji key) + + transaction_id: Optional transaction ID for deduplication and send tracking + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return await self._post( + path_template( + "/v1/chats/{chat_id}/messages/{message_id}/reactions", chat_id=chat_id, message_id=message_id + ), + body=await async_maybe_transform( + { + "reaction_key": reaction_key, + "transaction_id": transaction_id, + }, + reaction_add_params.ReactionAddParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ReactionAddResponse, + ) + + +class ReactionsResourceWithRawResponse: + def __init__(self, reactions: ReactionsResource) -> None: + self._reactions = reactions + + self.delete = to_raw_response_wrapper( + reactions.delete, + ) + self.add = to_raw_response_wrapper( + reactions.add, + ) + + +class AsyncReactionsResourceWithRawResponse: + def __init__(self, reactions: AsyncReactionsResource) -> None: + self._reactions = reactions + + self.delete = async_to_raw_response_wrapper( + reactions.delete, + ) + self.add = async_to_raw_response_wrapper( + reactions.add, + ) + + +class ReactionsResourceWithStreamingResponse: + def __init__(self, reactions: ReactionsResource) -> None: + self._reactions = reactions + + self.delete = to_streamed_response_wrapper( + reactions.delete, + ) + self.add = to_streamed_response_wrapper( + reactions.add, + ) + + +class AsyncReactionsResourceWithStreamingResponse: + def __init__(self, reactions: AsyncReactionsResource) -> None: + self._reactions = reactions + + self.delete = async_to_streamed_response_wrapper( + reactions.delete, + ) + self.add = async_to_streamed_response_wrapper( + reactions.add, + ) diff --git a/src/beeper_desktop_api/resources/chats/reminders.py b/src/beeper_desktop_api/resources/chats/reminders.py new file mode 100644 index 0000000..fb02508 --- /dev/null +++ b/src/beeper_desktop_api/resources/chats/reminders.py @@ -0,0 +1,274 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NoneType, NotGiven, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ...types.chats import reminder_create_params +from ..._base_client import make_request_options + +__all__ = ["RemindersResource", "AsyncRemindersResource"] + + +class RemindersResource(SyncAPIResource): + """Manage reminders for chats""" + + @cached_property + def with_raw_response(self) -> RemindersResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return RemindersResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> RemindersResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return RemindersResourceWithStreamingResponse(self) + + def create( + self, + chat_id: str, + *, + reminder: reminder_create_params.Reminder, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Set a reminder for a chat at a specific time. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + reminder: Reminder configuration + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._post( + path_template("/v1/chats/{chat_id}/reminders", chat_id=chat_id), + body=maybe_transform({"reminder": reminder}, reminder_create_params.ReminderCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + def delete( + self, + chat_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Clear an existing reminder from a chat. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._delete( + path_template("/v1/chats/{chat_id}/reminders", chat_id=chat_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + +class AsyncRemindersResource(AsyncAPIResource): + """Manage reminders for chats""" + + @cached_property + def with_raw_response(self) -> AsyncRemindersResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncRemindersResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncRemindersResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncRemindersResourceWithStreamingResponse(self) + + async def create( + self, + chat_id: str, + *, + reminder: reminder_create_params.Reminder, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Set a reminder for a chat at a specific time. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + reminder: Reminder configuration + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._post( + path_template("/v1/chats/{chat_id}/reminders", chat_id=chat_id), + body=await async_maybe_transform({"reminder": reminder}, reminder_create_params.ReminderCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + async def delete( + self, + chat_id: str, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Clear an existing reminder from a chat. + + Args: + chat_id: Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._delete( + path_template("/v1/chats/{chat_id}/reminders", chat_id=chat_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + + +class RemindersResourceWithRawResponse: + def __init__(self, reminders: RemindersResource) -> None: + self._reminders = reminders + + self.create = to_raw_response_wrapper( + reminders.create, + ) + self.delete = to_raw_response_wrapper( + reminders.delete, + ) + + +class AsyncRemindersResourceWithRawResponse: + def __init__(self, reminders: AsyncRemindersResource) -> None: + self._reminders = reminders + + self.create = async_to_raw_response_wrapper( + reminders.create, + ) + self.delete = async_to_raw_response_wrapper( + reminders.delete, + ) + + +class RemindersResourceWithStreamingResponse: + def __init__(self, reminders: RemindersResource) -> None: + self._reminders = reminders + + self.create = to_streamed_response_wrapper( + reminders.create, + ) + self.delete = to_streamed_response_wrapper( + reminders.delete, + ) + + +class AsyncRemindersResourceWithStreamingResponse: + def __init__(self, reminders: AsyncRemindersResource) -> None: + self._reminders = reminders + + self.create = async_to_streamed_response_wrapper( + reminders.create, + ) + self.delete = async_to_streamed_response_wrapper( + reminders.delete, + ) diff --git a/src/beeper_desktop_api/resources/info.py b/src/beeper_desktop_api/resources/info.py new file mode 100644 index 0000000..c642841 --- /dev/null +++ b/src/beeper_desktop_api/resources/info.py @@ -0,0 +1,159 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from .._types import Body, Query, Headers, NotGiven, not_given +from .._compat import cached_property +from .._resource import SyncAPIResource, AsyncAPIResource +from .._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .._base_client import make_request_options +from ..types.info_retrieve_response import InfoRetrieveResponse + +__all__ = ["InfoResource", "AsyncInfoResource"] + + +class InfoResource(SyncAPIResource): + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + + @cached_property + def with_raw_response(self) -> InfoResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return InfoResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> InfoResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return InfoResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> InfoRetrieveResponse: + """ + Returns app, platform, server, endpoint discovery, OAuth, and WebSocket metadata + for this Beeper Client API server. + """ + return self._get( + "/v1/info", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=InfoRetrieveResponse, + ) + + +class AsyncInfoResource(AsyncAPIResource): + """Server discovery and capability metadata. + + Use /v1/info before authentication setup. + """ + + @cached_property + def with_raw_response(self) -> AsyncInfoResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncInfoResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncInfoResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncInfoResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> InfoRetrieveResponse: + """ + Returns app, platform, server, endpoint discovery, OAuth, and WebSocket metadata + for this Beeper Client API server. + """ + return await self._get( + "/v1/info", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + security={}, + ), + cast_to=InfoRetrieveResponse, + ) + + +class InfoResourceWithRawResponse: + def __init__(self, info: InfoResource) -> None: + self._info = info + + self.retrieve = to_raw_response_wrapper( + info.retrieve, + ) + + +class AsyncInfoResourceWithRawResponse: + def __init__(self, info: AsyncInfoResource) -> None: + self._info = info + + self.retrieve = async_to_raw_response_wrapper( + info.retrieve, + ) + + +class InfoResourceWithStreamingResponse: + def __init__(self, info: InfoResource) -> None: + self._info = info + + self.retrieve = to_streamed_response_wrapper( + info.retrieve, + ) + + +class AsyncInfoResourceWithStreamingResponse: + def __init__(self, info: AsyncInfoResource) -> None: + self._info = info + + self.retrieve = async_to_streamed_response_wrapper( + info.retrieve, + ) diff --git a/src/beeper_desktop_api/resources/messages.py b/src/beeper_desktop_api/resources/messages.py new file mode 100644 index 0000000..7c4e7e6 --- /dev/null +++ b/src/beeper_desktop_api/resources/messages.py @@ -0,0 +1,884 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import List, Union, Optional +from datetime import datetime +from typing_extensions import Literal + +import httpx + +from ..types import ( + message_list_params, + message_send_params, + message_delete_params, + message_search_params, + message_update_params, +) +from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given +from .._utils import path_template, maybe_transform, async_maybe_transform +from .._compat import cached_property +from .._resource import SyncAPIResource, AsyncAPIResource +from .._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..pagination import SyncCursorSearch, AsyncCursorSearch, SyncCursorNoLimit, AsyncCursorNoLimit +from .._base_client import AsyncPaginator, make_request_options +from ..types.shared.message import Message +from ..types.message_send_response import MessageSendResponse +from ..types.message_update_response import MessageUpdateResponse + +__all__ = ["MessagesResource", "AsyncMessagesResource"] + + +class MessagesResource(SyncAPIResource): + """Manage messages in chats""" + + @cached_property + def with_raw_response(self) -> MessagesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return MessagesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> MessagesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return MessagesResourceWithStreamingResponse(self) + + def retrieve( + self, + message_id: str, + *, + chat_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Message: + """ + Retrieve a message by final message ID, pendingMessageID, or Matrix event ID. + chatID may be a Beeper chat ID or a local chat ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return self._get( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Message, + ) + + def update( + self, + message_id: str, + *, + chat_id: str, + text: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> MessageUpdateResponse: + """Edit the text content of an existing message. + + Messages with attachments cannot + be edited. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + text: New text content for the message + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return self._put( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + body=maybe_transform({"text": text}, message_update_params.MessageUpdateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=MessageUpdateResponse, + ) + + def list( + self, + chat_id: str, + *, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SyncCursorNoLimit[Message]: + """List all messages in a chat with cursor-based pagination. + + Sorted by timestamp. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._get_api_list( + path_template("/v1/chats/{chat_id}/messages", chat_id=chat_id), + page=SyncCursorNoLimit[Message], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "direction": direction, + }, + message_list_params.MessageListParams, + ), + ), + model=Message, + ) + + def delete( + self, + message_id: str, + *, + chat_id: str, + for_everyone: Optional[bool] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Delete a message by final message ID. + + Pending message IDs are not accepted + because messages cannot be deleted while sending. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + for_everyone: True to request deletion for everyone when the network supports it; false to + delete only for the authenticated user when supported. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._delete( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"for_everyone": for_everyone}, message_delete_params.MessageDeleteParams), + ), + cast_to=NoneType, + ) + + def search( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + chat_ids: SequenceNotStr[str] | Omit = omit, + chat_type: Literal["group", "single"] | Omit = omit, + cursor: str | Omit = omit, + date_after: Union[str, datetime] | Omit = omit, + date_before: Union[str, datetime] | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + exclude_low_priority: Optional[bool] | Omit = omit, + include_muted: Optional[bool] | Omit = omit, + limit: int | Omit = omit, + media_types: List[Literal["any", "video", "image", "link", "file"]] | Omit = omit, + query: str | Omit = omit, + sender: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SyncCursorSearch[Message]: + """ + Search messages across chats. + + Args: + account_ids: Limit search to specific account IDs. + + chat_ids: Limit search to specific chat IDs. + + chat_type: Filter by chat type: 'group' for group chats, 'single' for 1:1 chats. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + date_after: Only include messages with timestamp strictly after this ISO 8601 datetime + (e.g., '2024-07-01T00:00:00Z' or '2024-07-01T00:00:00+02:00'). + + date_before: Only include messages with timestamp strictly before this ISO 8601 datetime + (e.g., '2024-07-31T23:59:59Z' or '2024-07-31T23:59:59+02:00'). + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + exclude_low_priority: Exclude messages marked Low Priority by the user. Default: true. Set to false to + include all. + + include_muted: Include messages in chats marked as Muted by the user, which are usually less + important. Default: true. Set to false if the user wants a more refined search. + + limit: Maximum number of messages to return. + + media_types: Filter messages by media types. Use ['any'] for any media type, or specify exact + types like ['video', 'image']. Omit for no media filtering. + + query: Literal word search. Finds messages containing these words in any order. Use + words the user actually typed, not inferred concepts. Example: use "dinner" + rather than "dinner plans". If omitted, returns results filtered only by the + other parameters. + + sender: Filter by sender: 'me' (messages sent by the authenticated user), 'others' + (messages sent by others), or a specific user ID string (user.id). + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/messages/search", + page=SyncCursorSearch[Message], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "chat_ids": chat_ids, + "chat_type": chat_type, + "cursor": cursor, + "date_after": date_after, + "date_before": date_before, + "direction": direction, + "exclude_low_priority": exclude_low_priority, + "include_muted": include_muted, + "limit": limit, + "media_types": media_types, + "query": query, + "sender": sender, + }, + message_search_params.MessageSearchParams, + ), + ), + model=Message, + ) + + def send( + self, + chat_id: str, + *, + attachment: message_send_params.Attachment | Omit = omit, + reply_to_message_id: str | Omit = omit, + text: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> MessageSendResponse: + """Send a text message to a specific chat. + + Supports replying to existing messages. + Returns a pending message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + attachment: Single attachment to send with the message + + reply_to_message_id: Provide a message ID to send this as a reply to an existing message + + text: Draft text. Plain text and Markdown are converted to Beeper rich text with the + same rules used by send and edit. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._post( + path_template("/v1/chats/{chat_id}/messages", chat_id=chat_id), + body=maybe_transform( + { + "attachment": attachment, + "reply_to_message_id": reply_to_message_id, + "text": text, + }, + message_send_params.MessageSendParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=MessageSendResponse, + ) + + +class AsyncMessagesResource(AsyncAPIResource): + """Manage messages in chats""" + + @cached_property + def with_raw_response(self) -> AsyncMessagesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/beeper/desktop-api-python#accessing-raw-response-data-eg-headers + """ + return AsyncMessagesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncMessagesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/beeper/desktop-api-python#with_streaming_response + """ + return AsyncMessagesResourceWithStreamingResponse(self) + + async def retrieve( + self, + message_id: str, + *, + chat_id: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> Message: + """ + Retrieve a message by final message ID, pendingMessageID, or Matrix event ID. + chatID may be a Beeper chat ID or a local chat ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return await self._get( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=Message, + ) + + async def update( + self, + message_id: str, + *, + chat_id: str, + text: str, + # 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> MessageUpdateResponse: + """Edit the text content of an existing message. + + Messages with attachments cannot + be edited. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + text: New text content for the message + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + return await self._put( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + body=await async_maybe_transform({"text": text}, message_update_params.MessageUpdateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=MessageUpdateResponse, + ) + + def list( + self, + chat_id: str, + *, + cursor: str | Omit = omit, + direction: Literal["after", "before"] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncPaginator[Message, AsyncCursorNoLimit[Message]]: + """List all messages in a chat with cursor-based pagination. + + Sorted by timestamp. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return self._get_api_list( + path_template("/v1/chats/{chat_id}/messages", chat_id=chat_id), + page=AsyncCursorNoLimit[Message], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "direction": direction, + }, + message_list_params.MessageListParams, + ), + ), + model=Message, + ) + + async def delete( + self, + message_id: str, + *, + chat_id: str, + for_everyone: Optional[bool] | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """Delete a message by final message ID. + + Pending message IDs are not accepted + because messages cannot be deleted while sending. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + message_id: Message ID. + + for_everyone: True to request deletion for everyone when the network supports it; false to + delete only for the authenticated user when supported. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + if not message_id: + raise ValueError(f"Expected a non-empty value for `message_id` but received {message_id!r}") + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._delete( + path_template("/v1/chats/{chat_id}/messages/{message_id}", chat_id=chat_id, message_id=message_id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"for_everyone": for_everyone}, message_delete_params.MessageDeleteParams + ), + ), + cast_to=NoneType, + ) + + def search( + self, + *, + account_ids: SequenceNotStr[str] | Omit = omit, + chat_ids: SequenceNotStr[str] | Omit = omit, + chat_type: Literal["group", "single"] | Omit = omit, + cursor: str | Omit = omit, + date_after: Union[str, datetime] | Omit = omit, + date_before: Union[str, datetime] | Omit = omit, + direction: Literal["after", "before"] | Omit = omit, + exclude_low_priority: Optional[bool] | Omit = omit, + include_muted: Optional[bool] | Omit = omit, + limit: int | Omit = omit, + media_types: List[Literal["any", "video", "image", "link", "file"]] | Omit = omit, + query: str | Omit = omit, + sender: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AsyncPaginator[Message, AsyncCursorSearch[Message]]: + """ + Search messages across chats. + + Args: + account_ids: Limit search to specific account IDs. + + chat_ids: Limit search to specific chat IDs. + + chat_type: Filter by chat type: 'group' for group chats, 'single' for 1:1 chats. + + cursor: Opaque pagination cursor; do not inspect. Use together with 'direction'. + + date_after: Only include messages with timestamp strictly after this ISO 8601 datetime + (e.g., '2024-07-01T00:00:00Z' or '2024-07-01T00:00:00+02:00'). + + date_before: Only include messages with timestamp strictly before this ISO 8601 datetime + (e.g., '2024-07-31T23:59:59Z' or '2024-07-31T23:59:59+02:00'). + + direction: Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + + exclude_low_priority: Exclude messages marked Low Priority by the user. Default: true. Set to false to + include all. + + include_muted: Include messages in chats marked as Muted by the user, which are usually less + important. Default: true. Set to false if the user wants a more refined search. + + limit: Maximum number of messages to return. + + media_types: Filter messages by media types. Use ['any'] for any media type, or specify exact + types like ['video', 'image']. Omit for no media filtering. + + query: Literal word search. Finds messages containing these words in any order. Use + words the user actually typed, not inferred concepts. Example: use "dinner" + rather than "dinner plans". If omitted, returns results filtered only by the + other parameters. + + sender: Filter by sender: 'me' (messages sent by the authenticated user), 'others' + (messages sent by others), or a specific user ID string (user.id). + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get_api_list( + "/v1/messages/search", + page=AsyncCursorSearch[Message], + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "account_ids": account_ids, + "chat_ids": chat_ids, + "chat_type": chat_type, + "cursor": cursor, + "date_after": date_after, + "date_before": date_before, + "direction": direction, + "exclude_low_priority": exclude_low_priority, + "include_muted": include_muted, + "limit": limit, + "media_types": media_types, + "query": query, + "sender": sender, + }, + message_search_params.MessageSearchParams, + ), + ), + model=Message, + ) + + async def send( + self, + chat_id: str, + *, + attachment: message_send_params.Attachment | Omit = omit, + reply_to_message_id: str | Omit = omit, + text: str | 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, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> MessageSendResponse: + """Send a text message to a specific chat. + + Supports replying to existing messages. + Returns a pending message ID. + + Args: + chat_id: Chat ID. Input routes also accept the local chat ID from this installation when + available. + + attachment: Single attachment to send with the message + + reply_to_message_id: Provide a message ID to send this as a reply to an existing message + + text: Draft text. Plain text and Markdown are converted to Beeper rich text with the + same rules used by send and edit. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not chat_id: + raise ValueError(f"Expected a non-empty value for `chat_id` but received {chat_id!r}") + return await self._post( + path_template("/v1/chats/{chat_id}/messages", chat_id=chat_id), + body=await async_maybe_transform( + { + "attachment": attachment, + "reply_to_message_id": reply_to_message_id, + "text": text, + }, + message_send_params.MessageSendParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=MessageSendResponse, + ) + + +class MessagesResourceWithRawResponse: + def __init__(self, messages: MessagesResource) -> None: + self._messages = messages + + self.retrieve = to_raw_response_wrapper( + messages.retrieve, + ) + self.update = to_raw_response_wrapper( + messages.update, + ) + self.list = to_raw_response_wrapper( + messages.list, + ) + self.delete = to_raw_response_wrapper( + messages.delete, + ) + self.search = to_raw_response_wrapper( + messages.search, + ) + self.send = to_raw_response_wrapper( + messages.send, + ) + + +class AsyncMessagesResourceWithRawResponse: + def __init__(self, messages: AsyncMessagesResource) -> None: + self._messages = messages + + self.retrieve = async_to_raw_response_wrapper( + messages.retrieve, + ) + self.update = async_to_raw_response_wrapper( + messages.update, + ) + self.list = async_to_raw_response_wrapper( + messages.list, + ) + self.delete = async_to_raw_response_wrapper( + messages.delete, + ) + self.search = async_to_raw_response_wrapper( + messages.search, + ) + self.send = async_to_raw_response_wrapper( + messages.send, + ) + + +class MessagesResourceWithStreamingResponse: + def __init__(self, messages: MessagesResource) -> None: + self._messages = messages + + self.retrieve = to_streamed_response_wrapper( + messages.retrieve, + ) + self.update = to_streamed_response_wrapper( + messages.update, + ) + self.list = to_streamed_response_wrapper( + messages.list, + ) + self.delete = to_streamed_response_wrapper( + messages.delete, + ) + self.search = to_streamed_response_wrapper( + messages.search, + ) + self.send = to_streamed_response_wrapper( + messages.send, + ) + + +class AsyncMessagesResourceWithStreamingResponse: + def __init__(self, messages: AsyncMessagesResource) -> None: + self._messages = messages + + self.retrieve = async_to_streamed_response_wrapper( + messages.retrieve, + ) + self.update = async_to_streamed_response_wrapper( + messages.update, + ) + self.list = async_to_streamed_response_wrapper( + messages.list, + ) + self.delete = async_to_streamed_response_wrapper( + messages.delete, + ) + self.search = async_to_streamed_response_wrapper( + messages.search, + ) + self.send = async_to_streamed_response_wrapper( + messages.send, + ) diff --git a/src/beeper_desktop_api/types/__init__.py b/src/beeper_desktop_api/types/__init__.py new file mode 100644 index 0000000..137c214 --- /dev/null +++ b/src/beeper_desktop_api/types/__init__.py @@ -0,0 +1,62 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .chat import Chat as Chat +from .bridge import Bridge as Bridge +from .shared import ( + User as User, + Error as Error, + Message as Message, + APIError as APIError, + Reaction as Reaction, + Attachment as Attachment, + AppStateSnapshot as AppStateSnapshot, +) +from .account import Account as Account +from .login_flow import LoginFlow as LoginFlow +from .cookie_field import CookieField as CookieField +from .login_session import LoginSession as LoginSession +from .account_bridge import AccountBridge as AccountBridge +from .focus_response import FocusResponse as FocusResponse +from .search_response import SearchResponse as SearchResponse +from .chat_list_params import ChatListParams as ChatListParams +from .chat_start_params import ChatStartParams as ChatStartParams +from .login_input_field import LoginInputField as LoginInputField +from .asset_serve_params import AssetServeParams as AssetServeParams +from .chat_create_params import ChatCreateParams as ChatCreateParams +from .chat_list_response import ChatListResponse as ChatListResponse +from .chat_search_params import ChatSearchParams as ChatSearchParams +from .chat_update_params import ChatUpdateParams as ChatUpdateParams +from .asset_upload_params import AssetUploadParams as AssetUploadParams +from .chat_archive_params import ChatArchiveParams as ChatArchiveParams +from .chat_start_response import ChatStartResponse as ChatStartResponse +from .client_focus_params import ClientFocusParams as ClientFocusParams +from .message_list_params import MessageListParams as MessageListParams +from .message_send_params import MessageSendParams as MessageSendParams +from .app_session_response import AppSessionResponse as AppSessionResponse +from .bridge_list_response import BridgeListResponse as BridgeListResponse +from .chat_create_response import ChatCreateResponse as ChatCreateResponse +from .chat_retrieve_params import ChatRetrieveParams as ChatRetrieveParams +from .client_search_params import ClientSearchParams as ClientSearchParams +from .account_list_response import AccountListResponse as AccountListResponse +from .asset_download_params import AssetDownloadParams as AssetDownloadParams +from .asset_upload_response import AssetUploadResponse as AssetUploadResponse +from .chat_mark_read_params import ChatMarkReadParams as ChatMarkReadParams +from .message_delete_params import MessageDeleteParams as MessageDeleteParams +from .message_search_params import MessageSearchParams as MessageSearchParams +from .message_send_response import MessageSendResponse as MessageSendResponse +from .message_update_params import MessageUpdateParams as MessageUpdateParams +from .group_field_capability import GroupFieldCapability as GroupFieldCapability +from .info_retrieve_response import InfoRetrieveResponse as InfoRetrieveResponse +from .asset_download_response import AssetDownloadResponse as AssetDownloadResponse +from .chat_mark_unread_params import ChatMarkUnreadParams as ChatMarkUnreadParams +from .group_type_capabilities import GroupTypeCapabilities as GroupTypeCapabilities +from .message_update_response import MessageUpdateResponse as MessageUpdateResponse +from .bridge_retrieve_response import BridgeRetrieveResponse as BridgeRetrieveResponse +from .account_retrieve_response import AccountRetrieveResponse as AccountRetrieveResponse +from .provisioning_capabilities import ProvisioningCapabilities as ProvisioningCapabilities +from .asset_upload_base64_params import AssetUploadBase64Params as AssetUploadBase64Params +from .asset_upload_base64_response import AssetUploadBase64Response as AssetUploadBase64Response +from .disappearing_timer_capability import DisappearingTimerCapability as DisappearingTimerCapability +from .resolve_identifier_capabilities import ResolveIdentifierCapabilities as ResolveIdentifierCapabilities diff --git a/src/beeper_desktop_api/types/account.py b/src/beeper_desktop_api/types/account.py new file mode 100644 index 0000000..a469ec4 --- /dev/null +++ b/src/beeper_desktop_api/types/account.py @@ -0,0 +1,60 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel +from .shared.user import User +from .account_bridge import AccountBridge + +__all__ = ["Account"] + + +class Account(BaseModel): + """A chat account added to Beeper.""" + + account_id: str = FieldInfo(alias="accountID") + """Chat account added to Beeper. + + Use this to route account-scoped actions. Examples include matrix for + Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for + workspace-scoped cloud bridges, and local-whatsapp*ba*... for local bridges. + """ + + bridge: AccountBridge + """Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.""" + + status: Literal[ + "connected", + "connecting", + "backfilling", + "connection_required", + "reconnect_required", + "attention_required", + "disconnected", + "disabled", + ] + """Current connection status for this account.""" + + user: User + """User the account belongs to.""" + + capabilities: Optional[Dict[str, Optional[object]]] = None + """Runtime chat/message capabilities for this connected account, when available.""" + + login_id: Optional[str] = FieldInfo(alias="loginID", default=None) + """Bridge login ID for this account, when known. + + One bridge login can contain multiple chat accounts. + """ + + network: Optional[str] = None + """Human-friendly network name for the account. + + Omitted when the network is unknown. + """ + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly account status text.""" diff --git a/src/beeper_desktop_api/types/account_bridge.py b/src/beeper_desktop_api/types/account_bridge.py new file mode 100644 index 0000000..d507424 --- /dev/null +++ b/src/beeper_desktop_api/types/account_bridge.py @@ -0,0 +1,31 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["AccountBridge"] + + +class AccountBridge(BaseModel): + """Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.""" + + id: str + """Bridge identifier. + + Beeper Cloud accounts often use the network type (for example matrix or + discordgo); on-device accounts use a local bridge ID (for example + local-whatsapp). Available in Beeper Desktop v4.2.785+. + """ + + provider: Literal["cloud", "self-hosted", "local", "platform-sdk"] + """Where this account runs: on this device or in Beeper Cloud. + + Available in Beeper Desktop v4.2.785+. + """ + + type: str + """Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. + + Available in Beeper Desktop v4.2.785+. + """ diff --git a/src/beeper_desktop_api/types/account_list_response.py b/src/beeper_desktop_api/types/account_list_response.py new file mode 100644 index 0000000..8268843 --- /dev/null +++ b/src/beeper_desktop_api/types/account_list_response.py @@ -0,0 +1,10 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List +from typing_extensions import TypeAlias + +from .account import Account + +__all__ = ["AccountListResponse"] + +AccountListResponse: TypeAlias = List[Account] diff --git a/src/beeper_desktop_api/types/account_retrieve_response.py b/src/beeper_desktop_api/types/account_retrieve_response.py new file mode 100644 index 0000000..20b59e8 --- /dev/null +++ b/src/beeper_desktop_api/types/account_retrieve_response.py @@ -0,0 +1,60 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel +from .shared.user import User +from .account_bridge import AccountBridge + +__all__ = ["AccountRetrieveResponse"] + + +class AccountRetrieveResponse(BaseModel): + """A chat account added to Beeper.""" + + account_id: str = FieldInfo(alias="accountID") + """Chat account added to Beeper. + + Use this to route account-scoped actions. Examples include matrix for + Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for + workspace-scoped cloud bridges, and local-whatsapp*ba*... for local bridges. + """ + + bridge: AccountBridge + """Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.""" + + status: Literal[ + "connected", + "connecting", + "backfilling", + "connection_required", + "reconnect_required", + "attention_required", + "disconnected", + "disabled", + ] + """Current connection status for this account.""" + + user: User + """User the account belongs to.""" + + capabilities: Optional[Dict[str, Optional[object]]] = None + """Runtime chat/message capabilities for this connected account, when available.""" + + login_id: Optional[str] = FieldInfo(alias="loginID", default=None) + """Bridge login ID for this account, when known. + + One bridge login can contain multiple chat accounts. + """ + + network: Optional[str] = None + """Human-friendly network name for the account. + + Omitted when the network is unknown. + """ + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly account status text.""" diff --git a/src/beeper_desktop_api/types/accounts/__init__.py b/src/beeper_desktop_api/types/accounts/__init__.py new file mode 100644 index 0000000..2addd13 --- /dev/null +++ b/src/beeper_desktop_api/types/accounts/__init__.py @@ -0,0 +1,7 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .contact_list_params import ContactListParams as ContactListParams +from .contact_search_params import ContactSearchParams as ContactSearchParams +from .contact_search_response import ContactSearchResponse as ContactSearchResponse diff --git a/src/beeper_desktop_api/types/accounts/contact_list_params.py b/src/beeper_desktop_api/types/accounts/contact_list_params.py new file mode 100644 index 0000000..983aea0 --- /dev/null +++ b/src/beeper_desktop_api/types/accounts/contact_list_params.py @@ -0,0 +1,24 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, TypedDict + +__all__ = ["ContactListParams"] + + +class ContactListParams(TypedDict, total=False): + cursor: str + """Opaque pagination cursor; do not inspect. Use together with 'direction'.""" + + direction: Literal["after", "before"] + """ + Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + """ + + limit: int + """Maximum contacts to return per page.""" + + query: str + """Optional search query for contact lookup.""" diff --git a/src/beeper_desktop_api/types/accounts/contact_search_params.py b/src/beeper_desktop_api/types/accounts/contact_search_params.py new file mode 100644 index 0000000..b663175 --- /dev/null +++ b/src/beeper_desktop_api/types/accounts/contact_search_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["ContactSearchParams"] + + +class ContactSearchParams(TypedDict, total=False): + query: Required[str] + """Text to search contacts by. Matching behavior depends on the network.""" diff --git a/src/beeper_desktop_api/types/accounts/contact_search_response.py b/src/beeper_desktop_api/types/accounts/contact_search_response.py new file mode 100644 index 0000000..e86aeed --- /dev/null +++ b/src/beeper_desktop_api/types/accounts/contact_search_response.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List + +from ..._models import BaseModel +from ..shared.user import User + +__all__ = ["ContactSearchResponse"] + + +class ContactSearchResponse(BaseModel): + items: List[User] diff --git a/src/beeper_desktop_api/types/app/__init__.py b/src/beeper_desktop_api/types/app/__init__.py new file mode 100644 index 0000000..2944080 --- /dev/null +++ b/src/beeper_desktop_api/types/app/__init__.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .login_email_params import LoginEmailParams as LoginEmailParams +from .login_start_response import LoginStartResponse as LoginStartResponse +from .login_register_params import LoginRegisterParams as LoginRegisterParams +from .login_response_params import LoginResponseParams as LoginResponseParams +from .login_register_response import LoginRegisterResponse as LoginRegisterResponse +from .login_response_response import LoginResponseResponse as LoginResponseResponse +from .verification_cancel_params import VerificationCancelParams as VerificationCancelParams +from .verification_create_params import VerificationCreateParams as VerificationCreateParams +from .verification_list_response import VerificationListResponse as VerificationListResponse +from .verification_accept_response import VerificationAcceptResponse as VerificationAcceptResponse +from .verification_cancel_response import VerificationCancelResponse as VerificationCancelResponse +from .verification_create_response import VerificationCreateResponse as VerificationCreateResponse +from .verification_retrieve_response import VerificationRetrieveResponse as VerificationRetrieveResponse diff --git a/src/beeper_desktop_api/types/app/login/__init__.py b/src/beeper_desktop_api/types/app/login/__init__.py new file mode 100644 index 0000000..f8ee8b1 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/__init__.py @@ -0,0 +1,3 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations diff --git a/src/beeper_desktop_api/types/app/login/verification/__init__.py b/src/beeper_desktop_api/types/app/login/verification/__init__.py new file mode 100644 index 0000000..d979259 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/__init__.py @@ -0,0 +1,6 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .recovery_key_verify_params import RecoveryKeyVerifyParams as RecoveryKeyVerifyParams +from .recovery_key_verify_response import RecoveryKeyVerifyResponse as RecoveryKeyVerifyResponse diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key/__init__.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key/__init__.py new file mode 100644 index 0000000..0299c46 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key/__init__.py @@ -0,0 +1,8 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .reset_create_params import ResetCreateParams as ResetCreateParams +from .reset_confirm_params import ResetConfirmParams as ResetConfirmParams +from .reset_create_response import ResetCreateResponse as ResetCreateResponse +from .reset_confirm_response import ResetConfirmResponse as ResetConfirmResponse diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_params.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_params.py new file mode 100644 index 0000000..8c5ce40 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ......_utils import PropertyInfo + +__all__ = ["ResetConfirmParams"] + + +class ResetConfirmParams(TypedDict, total=False): + recovery_key: Required[Annotated[str, PropertyInfo(alias="recoveryKey")]] + """New recovery key returned by the reset step.""" diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_response.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_response.py new file mode 100644 index 0000000..bc6cb66 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_confirm_response.py @@ -0,0 +1,192 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ......_models import BaseModel + +__all__ = [ + "ResetConfirmResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class ResetConfirmResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_params.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_params.py new file mode 100644 index 0000000..5d9fd5b --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from ......_utils import PropertyInfo + +__all__ = ["ResetCreateParams"] + + +class ResetCreateParams(TypedDict, total=False): + existing_recovery_key: Annotated[str, PropertyInfo(alias="existingRecoveryKey")] + """Existing recovery key, if the user has it.""" diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_response.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_response.py new file mode 100644 index 0000000..166f642 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key/reset_create_response.py @@ -0,0 +1,200 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ......_models import BaseModel + +__all__ = [ + "ResetCreateResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """ + Current app sign-in and encrypted messaging setup state after creating the new recovery key. + """ + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class ResetCreateResponse(BaseModel): + recovery_key: str = FieldInfo(alias="recoveryKey") + """New recovery key. Show it once and ask the user to save it.""" + + session: Session + """ + Current app sign-in and encrypted messaging setup state after creating the new + recovery key. + """ diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_params.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_params.py new file mode 100644 index 0000000..cdb0e08 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ....._utils import PropertyInfo + +__all__ = ["RecoveryKeyVerifyParams"] + + +class RecoveryKeyVerifyParams(TypedDict, total=False): + recovery_key: Required[Annotated[str, PropertyInfo(alias="recoveryKey")]] + """Recovery key saved by the user.""" diff --git a/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_response.py b/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_response.py new file mode 100644 index 0000000..1c3baaa --- /dev/null +++ b/src/beeper_desktop_api/types/app/login/verification/recovery_key_verify_response.py @@ -0,0 +1,192 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ....._models import BaseModel + +__all__ = [ + "RecoveryKeyVerifyResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class RecoveryKeyVerifyResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" diff --git a/src/beeper_desktop_api/types/app/login_email_params.py b/src/beeper_desktop_api/types/app/login_email_params.py new file mode 100644 index 0000000..30062dd --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_email_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["LoginEmailParams"] + + +class LoginEmailParams(TypedDict, total=False): + email: Required[str] + """Email address to send the sign-in code to.""" + + setup_request_id: Required[Annotated[str, PropertyInfo(alias="setupRequestID")]] + """Setup request ID returned by the start step.""" diff --git a/src/beeper_desktop_api/types/app/login_register_params.py b/src/beeper_desktop_api/types/app/login_register_params.py new file mode 100644 index 0000000..7848626 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_register_params.py @@ -0,0 +1,27 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["LoginRegisterParams"] + + +class LoginRegisterParams(TypedDict, total=False): + accept_terms: Required[Annotated[Literal[True], PropertyInfo(alias="acceptTerms")]] + """ + Confirms that the user agreed to our + [terms of use](https://www.beeper.com/terms-onboarding) and has read our + [privacy policy](https://www.beeper.com/privacy). + """ + + lead_token: Required[Annotated[str, PropertyInfo(alias="leadToken")]] + """Registration token returned by Beeper.""" + + setup_request_id: Required[Annotated[str, PropertyInfo(alias="setupRequestID")]] + """Setup request ID returned by the start step.""" + + username: Required[str] + """Username selected by the user.""" diff --git a/src/beeper_desktop_api/types/app/login_register_response.py b/src/beeper_desktop_api/types/app/login_register_response.py new file mode 100644 index 0000000..c67f552 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_register_response.py @@ -0,0 +1,212 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "LoginRegisterResponse", + "Matrix", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", +] + + +class Matrix(BaseModel): + """Account credentials for first-party app setup.""" + + access_token: str = FieldInfo(alias="accessToken") + """Beeper account access token. Returned once for first-party app setup.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state after sign-in.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class LoginRegisterResponse(BaseModel): + matrix: Matrix + """Account credentials for first-party app setup.""" + + session: Session + """Current app sign-in and encrypted messaging setup state after sign-in.""" diff --git a/src/beeper_desktop_api/types/app/login_response_params.py b/src/beeper_desktop_api/types/app/login_response_params.py new file mode 100644 index 0000000..72a2b3a --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_response_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["LoginResponseParams"] + + +class LoginResponseParams(TypedDict, total=False): + response: Required[str] + """Sign-in code from the user email.""" + + setup_request_id: Required[Annotated[str, PropertyInfo(alias="setupRequestID")]] + """Setup request ID returned by the start step.""" diff --git a/src/beeper_desktop_api/types/app/login_response_response.py b/src/beeper_desktop_api/types/app/login_response_response.py new file mode 100644 index 0000000..fb75746 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_response_response.py @@ -0,0 +1,251 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Union, Optional +from typing_extensions import Literal, TypeAlias + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "LoginResponseResponse", + "Success", + "SuccessMatrix", + "SuccessSession", + "SuccessSessionE2EE", + "SuccessSessionE2EESecrets", + "SuccessSessionMatrix", + "SuccessSessionVerification", + "SuccessSessionVerificationError", + "SuccessSessionVerificationOtherDevice", + "SuccessSessionVerificationQr", + "SuccessSessionVerificationSAS", + "RegistrationRequired", + "RegistrationRequiredCopy", +] + + +class SuccessMatrix(BaseModel): + """Account credentials for first-party app setup.""" + + access_token: str = FieldInfo(alias="accessToken") + """Beeper account access token. Returned once for first-party app setup.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SuccessSessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SuccessSessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SuccessSessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SuccessSessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SuccessSessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SuccessSessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SuccessSessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SuccessSessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SuccessSessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SuccessSessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SuccessSessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SuccessSessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SuccessSessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class SuccessSession(BaseModel): + """Current app sign-in and encrypted messaging setup state after sign-in.""" + + e2ee: SuccessSessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SuccessSessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SuccessSessionVerification] = None + """Trusted device verification progress.""" + + +class Success(BaseModel): + matrix: SuccessMatrix + """Account credentials for first-party app setup.""" + + session: SuccessSession + """Current app sign-in and encrypted messaging setup state after sign-in.""" + + +class RegistrationRequiredCopy(BaseModel): + """Copy to display during account creation.""" + + submit: Literal["Continue"] + """Submit button label.""" + + terms: Literal["By continuing, you agree to the Terms of Use and acknowledge the Privacy Policy."] + """Terms and privacy notice to show before account creation.""" + + title: Literal["Choose your username"] + """Title for the username step.""" + + username_placeholder: Literal["Username"] = FieldInfo(alias="usernamePlaceholder") + """Placeholder for the username field.""" + + +class RegistrationRequired(BaseModel): + copy_: RegistrationRequiredCopy = FieldInfo(alias="copy") + """Copy to display during account creation.""" + + lead_token: str = FieldInfo(alias="leadToken") + """Registration token returned by Beeper.""" + + registration_required: Literal[True] = FieldInfo(alias="registrationRequired") + """Indicates that the user needs to create a Beeper account.""" + + setup_request_id: str = FieldInfo(alias="setupRequestID") + """Setup request ID to use when creating the account.""" + + username_suggestions: Optional[List[str]] = FieldInfo(alias="usernameSuggestions", default=None) + """Suggested usernames for the new account.""" + + +LoginResponseResponse: TypeAlias = Union[Success, RegistrationRequired] diff --git a/src/beeper_desktop_api/types/app/login_start_response.py b/src/beeper_desktop_api/types/app/login_start_response.py new file mode 100644 index 0000000..7a2d5d9 --- /dev/null +++ b/src/beeper_desktop_api/types/app/login_start_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["LoginStartResponse"] + + +class LoginStartResponse(BaseModel): + setup_request_id: str = FieldInfo(alias="setupRequestID") + """Setup request ID to use in the next sign-in step.""" + + sign_in_methods: List[str] = FieldInfo(alias="signInMethods") + """Available sign-in methods for this setup request.""" diff --git a/src/beeper_desktop_api/types/app/verification_accept_response.py b/src/beeper_desktop_api/types/app/verification_accept_response.py new file mode 100644 index 0000000..4691a54 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_accept_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "VerificationAcceptResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class VerificationAcceptResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verification_cancel_params.py b/src/beeper_desktop_api/types/app/verification_cancel_params.py new file mode 100644 index 0000000..d954b97 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_cancel_params.py @@ -0,0 +1,15 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import TypedDict + +__all__ = ["VerificationCancelParams"] + + +class VerificationCancelParams(TypedDict, total=False): + code: str + """Optional cancellation code.""" + + reason: str + """Optional user-facing cancellation reason.""" diff --git a/src/beeper_desktop_api/types/app/verification_cancel_response.py b/src/beeper_desktop_api/types/app/verification_cancel_response.py new file mode 100644 index 0000000..68dfc2f --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_cancel_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "VerificationCancelResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class VerificationCancelResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verification_create_params.py b/src/beeper_desktop_api/types/app/verification_create_params.py new file mode 100644 index 0000000..6359e67 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_create_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["VerificationCreateParams"] + + +class VerificationCreateParams(TypedDict, total=False): + purpose: Literal["login", "device"] + """Why this verification is being started.""" + + user_id: Annotated[str, PropertyInfo(alias="userID")] + """Beeper user ID to verify. Defaults to the signed-in user.""" diff --git a/src/beeper_desktop_api/types/app/verification_create_response.py b/src/beeper_desktop_api/types/app/verification_create_response.py new file mode 100644 index 0000000..a88c143 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_create_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "VerificationCreateResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class VerificationCreateResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verification_list_response.py b/src/beeper_desktop_api/types/app/verification_list_response.py new file mode 100644 index 0000000..8b138f4 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_list_response.py @@ -0,0 +1,90 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["VerificationListResponse", "Item", "ItemError", "ItemOtherDevice", "ItemQr", "ItemSAS"] + + +class ItemError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class ItemOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class ItemQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class ItemSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Item(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[ItemError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[ItemOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[ItemQr] = None + """QR verification data.""" + + sas: Optional[ItemSAS] = None + """Emoji or number comparison data for verification.""" + + +class VerificationListResponse(BaseModel): + items: List[Item] diff --git a/src/beeper_desktop_api/types/app/verification_retrieve_response.py b/src/beeper_desktop_api/types/app/verification_retrieve_response.py new file mode 100644 index 0000000..baff10c --- /dev/null +++ b/src/beeper_desktop_api/types/app/verification_retrieve_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "VerificationRetrieveResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class VerificationRetrieveResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verifications/__init__.py b/src/beeper_desktop_api/types/app/verifications/__init__.py new file mode 100644 index 0000000..72e2812 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/__init__.py @@ -0,0 +1,9 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .qr_scan_params import QrScanParams as QrScanParams +from .qr_scan_response import QrScanResponse as QrScanResponse +from .sas_start_response import SASStartResponse as SASStartResponse +from .sas_confirm_response import SASConfirmResponse as SASConfirmResponse +from .qr_confirm_scanned_response import QrConfirmScannedResponse as QrConfirmScannedResponse diff --git a/src/beeper_desktop_api/types/app/verifications/qr_confirm_scanned_response.py b/src/beeper_desktop_api/types/app/verifications/qr_confirm_scanned_response.py new file mode 100644 index 0000000..c63b4f9 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/qr_confirm_scanned_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ...._models import BaseModel + +__all__ = [ + "QrConfirmScannedResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class QrConfirmScannedResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verifications/qr_scan_params.py b/src/beeper_desktop_api/types/app/verifications/qr_scan_params.py new file mode 100644 index 0000000..a16f78e --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/qr_scan_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["QrScanParams"] + + +class QrScanParams(TypedDict, total=False): + data: Required[str] + """QR code payload scanned from the other device.""" diff --git a/src/beeper_desktop_api/types/app/verifications/qr_scan_response.py b/src/beeper_desktop_api/types/app/verifications/qr_scan_response.py new file mode 100644 index 0000000..46c3399 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/qr_scan_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ...._models import BaseModel + +__all__ = [ + "QrScanResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class QrScanResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verifications/sas_confirm_response.py b/src/beeper_desktop_api/types/app/verifications/sas_confirm_response.py new file mode 100644 index 0000000..340de20 --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/sas_confirm_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ...._models import BaseModel + +__all__ = [ + "SASConfirmResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class SASConfirmResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app/verifications/sas_start_response.py b/src/beeper_desktop_api/types/app/verifications/sas_start_response.py new file mode 100644 index 0000000..544c4ad --- /dev/null +++ b/src/beeper_desktop_api/types/app/verifications/sas_start_response.py @@ -0,0 +1,276 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ...._models import BaseModel + +__all__ = [ + "SASStartResponse", + "Session", + "SessionE2EE", + "SessionE2EESecrets", + "SessionMatrix", + "SessionVerification", + "SessionVerificationError", + "SessionVerificationOtherDevice", + "SessionVerificationQr", + "SessionVerificationSAS", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class SessionE2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class SessionE2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: SessionE2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class SessionMatrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class SessionVerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class SessionVerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class SessionVerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class SessionVerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class SessionVerification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[SessionVerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[SessionVerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[SessionVerificationQr] = None + """QR verification data.""" + + sas: Optional[SessionVerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class Session(BaseModel): + """Current app sign-in and encrypted messaging setup state.""" + + e2ee: SessionE2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[SessionMatrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[SessionVerification] = None + """Trusted device verification progress.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class SASStartResponse(BaseModel): + session: Session + """Current app sign-in and encrypted messaging setup state.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/app_session_response.py b/src/beeper_desktop_api/types/app_session_response.py new file mode 100644 index 0000000..1b5deee --- /dev/null +++ b/src/beeper_desktop_api/types/app_session_response.py @@ -0,0 +1,184 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = [ + "AppSessionResponse", + "E2EE", + "E2EESecrets", + "Matrix", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class E2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class E2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: E2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class Matrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class AppSessionResponse(BaseModel): + e2ee: E2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[Matrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/asset_download_params.py b/src/beeper_desktop_api/types/asset_download_params.py new file mode 100644 index 0000000..58a04a1 --- /dev/null +++ b/src/beeper_desktop_api/types/asset_download_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["AssetDownloadParams"] + + +class AssetDownloadParams(TypedDict, total=False): + url: Required[str] + """Beeper media URL (mxc:// or localmxc://) for the file to download.""" diff --git a/src/beeper_desktop_api/types/asset_download_response.py b/src/beeper_desktop_api/types/asset_download_response.py new file mode 100644 index 0000000..a2bd7ec --- /dev/null +++ b/src/beeper_desktop_api/types/asset_download_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["AssetDownloadResponse"] + + +class AssetDownloadResponse(BaseModel): + error: Optional[str] = None + """Error message if the download failed.""" + + src_url: Optional[str] = FieldInfo(alias="srcURL", default=None) + """Local file URL to the downloaded file.""" diff --git a/src/beeper_desktop_api/types/asset_serve_params.py b/src/beeper_desktop_api/types/asset_serve_params.py new file mode 100644 index 0000000..80b77c7 --- /dev/null +++ b/src/beeper_desktop_api/types/asset_serve_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["AssetServeParams"] + + +class AssetServeParams(TypedDict, total=False): + url: Required[str] + """File URL to serve. Accepts mxc://, localmxc://, or file:// URLs.""" diff --git a/src/beeper_desktop_api/types/asset_upload_base64_params.py b/src/beeper_desktop_api/types/asset_upload_base64_params.py new file mode 100644 index 0000000..9600201 --- /dev/null +++ b/src/beeper_desktop_api/types/asset_upload_base64_params.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["AssetUploadBase64Params"] + + +class AssetUploadBase64Params(TypedDict, total=False): + content: Required[str] + """Base64-encoded file content (max ~500MB decoded)""" + + file_name: Annotated[str, PropertyInfo(alias="fileName")] + """Original filename. Generated if omitted""" + + mime_type: Annotated[str, PropertyInfo(alias="mimeType")] + """MIME type. Auto-detected from magic bytes if omitted""" diff --git a/src/beeper_desktop_api/types/asset_upload_base64_response.py b/src/beeper_desktop_api/types/asset_upload_base64_response.py new file mode 100644 index 0000000..41d8ddd --- /dev/null +++ b/src/beeper_desktop_api/types/asset_upload_base64_response.py @@ -0,0 +1,38 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["AssetUploadBase64Response"] + + +class AssetUploadBase64Response(BaseModel): + duration: Optional[float] = None + """Duration in seconds (audio/videos)""" + + error: Optional[str] = None + """Error message if upload failed""" + + file_name: Optional[str] = FieldInfo(alias="fileName", default=None) + """Resolved filename""" + + file_size: Optional[float] = FieldInfo(alias="fileSize", default=None) + """File size in bytes""" + + height: Optional[float] = None + """Height in pixels (images/videos)""" + + mime_type: Optional[str] = FieldInfo(alias="mimeType", default=None) + """Detected or provided MIME type""" + + src_url: Optional[str] = FieldInfo(alias="srcURL", default=None) + """Local file URL (file://) for the uploaded file""" + + upload_id: Optional[str] = FieldInfo(alias="uploadID", default=None) + """Unique upload ID for this temporary file""" + + width: Optional[float] = None + """Width in pixels (images/videos)""" diff --git a/src/beeper_desktop_api/types/asset_upload_params.py b/src/beeper_desktop_api/types/asset_upload_params.py new file mode 100644 index 0000000..3249b44 --- /dev/null +++ b/src/beeper_desktop_api/types/asset_upload_params.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from .._types import FileTypes +from .._utils import PropertyInfo + +__all__ = ["AssetUploadParams"] + + +class AssetUploadParams(TypedDict, total=False): + file: Required[FileTypes] + """The file to upload (max 500 MB).""" + + file_name: Annotated[str, PropertyInfo(alias="fileName")] + """Original filename. Defaults to the uploaded file name if omitted""" + + mime_type: Annotated[str, PropertyInfo(alias="mimeType")] + """MIME type. Auto-detected from magic bytes if omitted""" diff --git a/src/beeper_desktop_api/types/asset_upload_response.py b/src/beeper_desktop_api/types/asset_upload_response.py new file mode 100644 index 0000000..82dadd5 --- /dev/null +++ b/src/beeper_desktop_api/types/asset_upload_response.py @@ -0,0 +1,38 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["AssetUploadResponse"] + + +class AssetUploadResponse(BaseModel): + duration: Optional[float] = None + """Duration in seconds (audio/videos)""" + + error: Optional[str] = None + """Error message if upload failed""" + + file_name: Optional[str] = FieldInfo(alias="fileName", default=None) + """Resolved filename""" + + file_size: Optional[float] = FieldInfo(alias="fileSize", default=None) + """File size in bytes""" + + height: Optional[float] = None + """Height in pixels (images/videos)""" + + mime_type: Optional[str] = FieldInfo(alias="mimeType", default=None) + """Detected or provided MIME type""" + + src_url: Optional[str] = FieldInfo(alias="srcURL", default=None) + """Local file URL (file://) for the uploaded file""" + + upload_id: Optional[str] = FieldInfo(alias="uploadID", default=None) + """Unique upload ID for this temporary file""" + + width: Optional[float] = None + """Width in pixels (images/videos)""" diff --git a/src/beeper_desktop_api/types/bridge.py b/src/beeper_desktop_api/types/bridge.py new file mode 100644 index 0000000..38adb1b --- /dev/null +++ b/src/beeper_desktop_api/types/bridge.py @@ -0,0 +1,51 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .account import Account +from .._models import BaseModel + +__all__ = ["Bridge"] + + +class Bridge(BaseModel): + """Available bridge that can connect or reconnect chat accounts.""" + + id: str + """Bridge ID. Use with bridge endpoints.""" + + accounts: List[Account] + """Connected accounts for this bridge. + + Uses the same Account schema as GET /v1/accounts. + """ + + active_account_count: int = FieldInfo(alias="activeAccountCount") + """Number of active accounts for this network on this device.""" + + display_name: str = FieldInfo(alias="displayName") + """Human-friendly bridge name shown in Beeper.""" + + provider: Literal["cloud", "self-hosted", "local", "platform-sdk"] + """Where accounts for this bridge run: on this device or in Beeper Cloud.""" + + status: Literal["available", "connected", "limit_reached", "temporarily_unavailable", "disabled"] + """Whether this bridge can currently be used to connect new accounts.""" + + supports_multiple_accounts: bool = FieldInfo(alias="supportsMultipleAccounts") + """Whether this bridge can have multiple active accounts for the same network.""" + + type: str + """ + Underlying bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, + or twitter. + """ + + network: Optional[str] = None + """Network grouping used for account counts and limits.""" + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly status text matching Beeper account management language.""" diff --git a/src/beeper_desktop_api/types/bridge_list_response.py b/src/beeper_desktop_api/types/bridge_list_response.py new file mode 100644 index 0000000..ed0d497 --- /dev/null +++ b/src/beeper_desktop_api/types/bridge_list_response.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List + +from .bridge import Bridge +from .._models import BaseModel + +__all__ = ["BridgeListResponse"] + + +class BridgeListResponse(BaseModel): + """Available bridges and their connected accounts.""" + + items: List[Bridge] diff --git a/src/beeper_desktop_api/types/bridge_retrieve_response.py b/src/beeper_desktop_api/types/bridge_retrieve_response.py new file mode 100644 index 0000000..89b4512 --- /dev/null +++ b/src/beeper_desktop_api/types/bridge_retrieve_response.py @@ -0,0 +1,51 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .account import Account +from .._models import BaseModel + +__all__ = ["BridgeRetrieveResponse"] + + +class BridgeRetrieveResponse(BaseModel): + """Available bridge that can connect or reconnect chat accounts.""" + + id: str + """Bridge ID. Use with bridge endpoints.""" + + accounts: List[Account] + """Connected accounts for this bridge. + + Uses the same Account schema as GET /v1/accounts. + """ + + active_account_count: int = FieldInfo(alias="activeAccountCount") + """Number of active accounts for this network on this device.""" + + display_name: str = FieldInfo(alias="displayName") + """Human-friendly bridge name shown in Beeper.""" + + provider: Literal["cloud", "self-hosted", "local", "platform-sdk"] + """Where accounts for this bridge run: on this device or in Beeper Cloud.""" + + status: Literal["available", "connected", "limit_reached", "temporarily_unavailable", "disabled"] + """Whether this bridge can currently be used to connect new accounts.""" + + supports_multiple_accounts: bool = FieldInfo(alias="supportsMultipleAccounts") + """Whether this bridge can have multiple active accounts for the same network.""" + + type: str + """ + Underlying bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, + or twitter. + """ + + network: Optional[str] = None + """Network grouping used for account counts and limits.""" + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly status text matching Beeper account management language.""" diff --git a/src/beeper_desktop_api/types/bridges/__init__.py b/src/beeper_desktop_api/types/bridges/__init__.py new file mode 100644 index 0000000..4efdabc --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/__init__.py @@ -0,0 +1,7 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .login_flow_list_response import LoginFlowListResponse as LoginFlowListResponse +from .login_session_create_params import LoginSessionCreateParams as LoginSessionCreateParams +from .login_session_cancel_response import LoginSessionCancelResponse as LoginSessionCancelResponse diff --git a/src/beeper_desktop_api/types/bridges/login_flow_list_response.py b/src/beeper_desktop_api/types/bridges/login_flow_list_response.py new file mode 100644 index 0000000..1d625e3 --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/login_flow_list_response.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List + +from ..._models import BaseModel +from ..login_flow import LoginFlow + +__all__ = ["LoginFlowListResponse"] + + +class LoginFlowListResponse(BaseModel): + items: List[LoginFlow] diff --git a/src/beeper_desktop_api/types/bridges/login_session_cancel_response.py b/src/beeper_desktop_api/types/bridges/login_session_cancel_response.py new file mode 100644 index 0000000..a3aaee6 --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/login_session_cancel_response.py @@ -0,0 +1,17 @@ +# 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 + +__all__ = ["LoginSessionCancelResponse"] + + +class LoginSessionCancelResponse(BaseModel): + bridge_id: str = FieldInfo(alias="bridgeID") + + login_session_id: str = FieldInfo(alias="loginSessionID") + + status: Literal["cancelled"] diff --git a/src/beeper_desktop_api/types/bridges/login_session_create_params.py b/src/beeper_desktop_api/types/bridges/login_session_create_params.py new file mode 100644 index 0000000..8da4234 --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/login_session_create_params.py @@ -0,0 +1,23 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["LoginSessionCreateParams"] + + +class LoginSessionCreateParams(TypedDict, total=False): + account_id: Annotated[str, PropertyInfo(alias="accountID")] + """Existing chat account ID to reconnect. Omit to connect a new account.""" + + flow_id: Annotated[str, PropertyInfo(alias="flowID")] + """Optional flow ID returned by the list login flows endpoint. + + If omitted, Beeper chooses the default flow. + """ + + login_id: Annotated[str, PropertyInfo(alias="loginID")] + """Existing bridge login ID to reconnect. Omit to connect a new account.""" diff --git a/src/beeper_desktop_api/types/bridges/login_sessions/__init__.py b/src/beeper_desktop_api/types/bridges/login_sessions/__init__.py new file mode 100644 index 0000000..a83b5fb --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/login_sessions/__init__.py @@ -0,0 +1,5 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .step_submit_params import StepSubmitParams as StepSubmitParams diff --git a/src/beeper_desktop_api/types/bridges/login_sessions/step_submit_params.py b/src/beeper_desktop_api/types/bridges/login_sessions/step_submit_params.py new file mode 100644 index 0000000..e099810 --- /dev/null +++ b/src/beeper_desktop_api/types/bridges/login_sessions/step_submit_params.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ...._utils import PropertyInfo + +__all__ = ["StepSubmitParams"] + + +class StepSubmitParams(TypedDict, total=False): + bridge_id: Required[Annotated[str, PropertyInfo(alias="bridgeID")]] + """Bridge ID.""" + + login_session_id: Required[Annotated[str, PropertyInfo(alias="loginSessionID")]] + """Temporary bridge login session ID.""" + + type: Required[Literal["user_input", "cookies", "display_and_wait"]] + + fields: Dict[str, str] + """Field values keyed by the field IDs from the current step.""" + + last_url: Annotated[str, PropertyInfo(alias="lastURL")] + """Last browser URL reached during a cookies step, if available.""" + + source: Literal["api", "webview", "browser_extension"] + """How the step was completed. + + Omit unless the client needs to distinguish an embedded webview or browser + extension. + """ diff --git a/src/beeper_desktop_api/types/chat.py b/src/beeper_desktop_api/types/chat.py new file mode 100644 index 0000000..788c891 --- /dev/null +++ b/src/beeper_desktop_api/types/chat.py @@ -0,0 +1,470 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel +from .shared.user import User + +__all__ = [ + "Chat", + "Participants", + "ParticipantsItem", + "Capabilities", + "CapabilitiesAttachments", + "CapabilitiesDisappearingTimer", + "CapabilitiesMessageRequest", + "CapabilitiesParticipantActions", + "CapabilitiesState", + "CapabilitiesStateAvatar", + "CapabilitiesStateDescription", + "CapabilitiesStateDisappearingTimer", + "CapabilitiesStateTitle", + "Draft", + "DraftAttachments", + "DraftAttachmentsSize", + "Reminder", + "Snooze", +] + + +class ParticipantsItem(User): + """A chat participant. Extends User with chat membership metadata.""" + + is_admin: Optional[bool] = FieldInfo(alias="isAdmin", default=None) + """True if this participant has admin privileges in the chat.""" + + is_network_bot: Optional[bool] = FieldInfo(alias="isNetworkBot", default=None) + """True if this participant represents an automated network account.""" + + is_pending: Optional[bool] = FieldInfo(alias="isPending", default=None) + """True if this participant has been invited but has not joined yet.""" + + +class Participants(BaseModel): + """Chat participants information.""" + + has_more: bool = FieldInfo(alias="hasMore") + """True if there are more participants than included in items.""" + + items: List[ParticipantsItem] + """Participants returned for this chat (limited by the request; may be a subset).""" + + total: int + """Total number of participants in the chat.""" + + +class CapabilitiesAttachments(BaseModel): + """Capabilities for one attachment message type.""" + + mime_types: Dict[str, Literal[-2, -1, 0, 1, 2]] = FieldInfo(alias="mimeTypes") + """Supported MIME types or MIME patterns for this file message type. + + Missing MIME types should be treated as rejected. + """ + + caption: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + max_caption_length: Optional[int] = FieldInfo(alias="maxCaptionLength", default=None) + """Maximum caption length when captions are supported.""" + + max_duration: Optional[int] = FieldInfo(alias="maxDuration", default=None) + """Maximum audio or video duration in seconds.""" + + max_height: Optional[int] = FieldInfo(alias="maxHeight", default=None) + """Maximum image or video height in pixels.""" + + max_size: Optional[int] = FieldInfo(alias="maxSize", default=None) + """Maximum file size in bytes.""" + + max_width: Optional[int] = FieldInfo(alias="maxWidth", default=None) + """Maximum image or video width in pixels.""" + + view_once: Optional[bool] = FieldInfo(alias="viewOnce", default=None) + """True if this file type can be sent as view-once media.""" + + +class CapabilitiesDisappearingTimer(BaseModel): + """Disappearing-message timer capabilities.""" + + omit_empty_timer: Optional[bool] = FieldInfo(alias="omitEmptyTimer", default=None) + """True if empty timer objects should be omitted from message content.""" + + timers: Optional[List[int]] = None + """Allowed disappearing timer values in milliseconds. + + Omitted means any timer is allowed. + """ + + types: Optional[List[Literal["afterRead", "afterSend"]]] = None + """Supported disappearing timer types.""" + + +class CapabilitiesMessageRequest(BaseModel): + """Message request capabilities.""" + + accept_with_button: Optional[Literal[-2, -1, 0, 1, 2]] = FieldInfo(alias="acceptWithButton", default=None) + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + accept_with_message: Optional[Literal[-2, -1, 0, 1, 2]] = FieldInfo(alias="acceptWithMessage", default=None) + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesParticipantActions(BaseModel): + """Participant management capabilities.""" + + ban: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + invite: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + kick: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + leave: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + revoke_invite: Optional[Literal[-2, -1, 0, 1, 2]] = FieldInfo(alias="revokeInvite", default=None) + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesStateAvatar(BaseModel): + """Chat avatar state capability.""" + + level: Literal[-2, -1, 0, 1, 2] + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesStateDescription(BaseModel): + """Chat description/topic state capability.""" + + level: Literal[-2, -1, 0, 1, 2] + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesStateDisappearingTimer(BaseModel): + """Disappearing-message timer state capability.""" + + level: Literal[-2, -1, 0, 1, 2] + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesStateTitle(BaseModel): + """Chat title state capability.""" + + level: Literal[-2, -1, 0, 1, 2] + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + +class CapabilitiesState(BaseModel): + """Chat state update capabilities.""" + + avatar: Optional[CapabilitiesStateAvatar] = None + """Chat avatar state capability.""" + + description: Optional[CapabilitiesStateDescription] = None + """Chat description/topic state capability.""" + + disappearing_timer: Optional[CapabilitiesStateDisappearingTimer] = FieldInfo( + alias="disappearingTimer", default=None + ) + """Disappearing-message timer state capability.""" + + title: Optional[CapabilitiesStateTitle] = None + """Chat title state capability.""" + + +class Capabilities(BaseModel): + """Chat capabilities reported by the platform.""" + + allowed_reactions: Optional[List[str]] = FieldInfo(alias="allowedReactions", default=None) + """Allowed Unicode reactions. Omitted means all emoji reactions are allowed.""" + + archive: Optional[bool] = None + """True if archive/unarchive is supported.""" + + attachments: Optional[Dict[str, CapabilitiesAttachments]] = None + """ + Supported attachment message types and their per-type constraints, keyed by + Matrix msgtype or pseudo-msgtype (for example m.image, m.video, + org.matrix.msc3245.voice). Missing message types should be treated as rejected. + """ + + custom_emoji_reactions: Optional[bool] = FieldInfo(alias="customEmojiReactions", default=None) + """True if custom emoji reactions are supported.""" + + delete: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + delete_chat: Optional[bool] = FieldInfo(alias="deleteChat", default=None) + """True if deleting chats for the authenticated user is supported.""" + + delete_chat_for_everyone: Optional[bool] = FieldInfo(alias="deleteChatForEveryone", default=None) + """True if deleting chats for everyone is supported.""" + + delete_for_me: Optional[bool] = FieldInfo(alias="deleteForMe", default=None) + """True if deleting messages only for the authenticated user is supported.""" + + delete_max_age: Optional[int] = FieldInfo(alias="deleteMaxAge", default=None) + """Maximum message age for delete-for-everyone, in seconds.""" + + disappearing_timer: Optional[CapabilitiesDisappearingTimer] = FieldInfo(alias="disappearingTimer", default=None) + """Disappearing-message timer capabilities.""" + + edit: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + edit_max_age: Optional[int] = FieldInfo(alias="editMaxAge", default=None) + """Maximum message age for edits, in seconds.""" + + edit_max_count: Optional[int] = FieldInfo(alias="editMaxCount", default=None) + """Maximum number of edits allowed for one message.""" + + formatting: Optional[Dict[str, Literal[-2, -1, 0, 1, 2]]] = None + """ + Supported rich-text formatting features keyed by feature name (for example bold, + inline_code, code_block.syntax_highlighting). Omitted means no formatting + support is advertised. + """ + + location_message: Optional[Literal[-2, -1, 0, 1, 2]] = FieldInfo(alias="locationMessage", default=None) + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + mark_as_unread: Optional[bool] = FieldInfo(alias="markAsUnread", default=None) + """True if marking chats unread is supported.""" + + max_text_length: Optional[int] = FieldInfo(alias="maxTextLength", default=None) + """Maximum length of normal text messages.""" + + message_request: Optional[CapabilitiesMessageRequest] = FieldInfo(alias="messageRequest", default=None) + """Message request capabilities.""" + + participant_actions: Optional[CapabilitiesParticipantActions] = FieldInfo(alias="participantActions", default=None) + """Participant management capabilities.""" + + poll: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + reaction: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + reaction_count: Optional[int] = FieldInfo(alias="reactionCount", default=None) + """Maximum number of reactions allowed on a single message.""" + + read_receipts: Optional[bool] = FieldInfo(alias="readReceipts", default=None) + """True if read receipts are supported.""" + + reply: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + state: Optional[CapabilitiesState] = None + """Chat state update capabilities.""" + + thread: Optional[Literal[-2, -1, 0, 1, 2]] = None + """ + -2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully + supported. + """ + + typing_notifications: Optional[bool] = FieldInfo(alias="typingNotifications", default=None) + """True if typing notifications are supported.""" + + +class DraftAttachmentsSize(BaseModel): + """Pixel dimensions of the attachment.""" + + height: Optional[float] = None + + width: Optional[float] = None + + +class DraftAttachments(BaseModel): + id: str + """Draft attachment identifier.""" + + type: Literal["file", "gif", "recorded_audio"] + """Draft attachment type. GIF and recorded audio are mutually exclusive types.""" + + audio_duration_seconds: Optional[float] = FieldInfo(alias="audioDurationSeconds", default=None) + """Audio duration in seconds if known.""" + + file_name: Optional[str] = FieldInfo(alias="fileName", default=None) + """Original filename if available.""" + + file_path: Optional[str] = FieldInfo(alias="filePath", default=None) + """Local filesystem path for the draft attachment.""" + + file_size: Optional[float] = FieldInfo(alias="fileSize", default=None) + """File size in bytes if known.""" + + mime_type: Optional[str] = FieldInfo(alias="mimeType", default=None) + """MIME type if known.""" + + size: Optional[DraftAttachmentsSize] = None + """Pixel dimensions of the attachment.""" + + sticker_id: Optional[str] = FieldInfo(alias="stickerID", default=None) + """Sticker identifier if the draft attachment is a sticker.""" + + +class Draft(BaseModel): + """Current draft object for this chat, or null when no draft is set.""" + + text: str + """Rich-text draft body as returned by Beeper.""" + + attachments: Optional[Dict[str, DraftAttachments]] = None + """Draft attachments keyed by attachment ID.""" + + +class Reminder(BaseModel): + """Current reminder for this chat, or null when no reminder is set.""" + + dismiss_on_incoming_message: Optional[bool] = FieldInfo(alias="dismissOnIncomingMessage", default=None) + """Cancel reminder if someone messages in the chat.""" + + remind_at: Optional[datetime] = FieldInfo(alias="remindAt", default=None) + """Timestamp when the reminder should trigger.""" + + +class Snooze(BaseModel): + """Current snooze state for this chat, or null when no snooze is set.""" + + snooze_until: Optional[datetime] = FieldInfo(alias="snoozeUntil", default=None) + """Timestamp when the snooze expires.""" + + user_snoozed_at: Optional[datetime] = FieldInfo(alias="userSnoozedAt", default=None) + """Timestamp when the user set the snooze.""" + + +class Chat(BaseModel): + id: str + """Unique identifier of the chat across Beeper.""" + + account_id: str = FieldInfo(alias="accountID") + """Account ID this chat belongs to.""" + + network: str + """Display-only human-readable account/network name.""" + + participants: Participants + """Chat participants information.""" + + title: str + """Display title of the chat as computed by the client/server.""" + + type: Literal["single", "group"] + """Chat type: 'single' for direct messages, 'group' for group chats.""" + + unread_count: int = FieldInfo(alias="unreadCount") + """Number of unread messages.""" + + capabilities: Optional[Capabilities] = None + """Chat capabilities reported by the platform.""" + + description: Optional[str] = None + """Group chat description/topic when available.""" + + draft: Optional[Draft] = None + """Current draft object for this chat, or null when no draft is set.""" + + img_url: Optional[str] = FieldInfo(alias="imgURL", default=None) + """Local filesystem path to the chat avatar image when available.""" + + is_archived: Optional[bool] = FieldInfo(alias="isArchived", default=None) + """True if chat is archived.""" + + is_low_priority: Optional[bool] = FieldInfo(alias="isLowPriority", default=None) + """True if chat is marked low priority.""" + + is_marked_unread: Optional[bool] = FieldInfo(alias="isMarkedUnread", default=None) + """True if the chat was explicitly marked unread by the authenticated user.""" + + is_muted: Optional[bool] = FieldInfo(alias="isMuted", default=None) + """True if chat notifications are muted.""" + + is_pinned: Optional[bool] = FieldInfo(alias="isPinned", default=None) + """True if chat is pinned.""" + + is_read_only: Optional[bool] = FieldInfo(alias="isReadOnly", default=None) + """True if messages cannot be sent in this chat.""" + + last_activity: Optional[datetime] = FieldInfo(alias="lastActivity", default=None) + """Timestamp of last activity.""" + + last_read_message_sort_key: Optional[str] = FieldInfo(alias="lastReadMessageSortKey", default=None) + """Last read message sortKey.""" + + local_chat_id: Optional[str] = FieldInfo(alias="localChatID", default=None) + """Local chat ID specific to this installation.""" + + message_expiry_seconds: Optional[int] = FieldInfo(alias="messageExpirySeconds", default=None) + """Disappearing-message timer in seconds when available.""" + + reminder: Optional[Reminder] = None + """Current reminder for this chat, or null when no reminder is set.""" + + snooze: Optional[Snooze] = None + """Current snooze state for this chat, or null when no snooze is set.""" + + unread_mentions_count: Optional[int] = FieldInfo(alias="unreadMentionsCount", default=None) + """Number of unread messages that mention the authenticated user or @room.""" diff --git a/src/beeper_desktop_api/types/chat_archive_params.py b/src/beeper_desktop_api/types/chat_archive_params.py new file mode 100644 index 0000000..38cc168 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_archive_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import TypedDict + +__all__ = ["ChatArchiveParams"] + + +class ChatArchiveParams(TypedDict, total=False): + archived: bool + """True to archive, false to unarchive""" diff --git a/src/beeper_desktop_api/types/chat_create_params.py b/src/beeper_desktop_api/types/chat_create_params.py new file mode 100644 index 0000000..8a4041f --- /dev/null +++ b/src/beeper_desktop_api/types/chat_create_params.py @@ -0,0 +1,30 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Required, Annotated, TypedDict + +from .._types import SequenceNotStr +from .._utils import PropertyInfo + +__all__ = ["ChatCreateParams"] + + +class ChatCreateParams(TypedDict, total=False): + account_id: Required[Annotated[str, PropertyInfo(alias="accountID")]] + """Account to create or start the chat on.""" + + 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. + """ + + message_text: Annotated[str, PropertyInfo(alias="messageText")] + """Optional first message content if the platform requires it to create the chat.""" + + title: str + """Optional title for group chats; ignored for single chats on most networks.""" diff --git a/src/beeper_desktop_api/types/chat_create_response.py b/src/beeper_desktop_api/types/chat_create_response.py new file mode 100644 index 0000000..f114484 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_create_response.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .chat import Chat + +__all__ = ["ChatCreateResponse"] + + +class ChatCreateResponse(Chat): + chat_id: str = FieldInfo(alias="chatID") + """DEPRECATED - use id instead. Compatibility alias for older clients.""" + + status: Optional[Literal["existing", "created"]] = None + """DEPRECATED - legacy start-chat status for older clients. + + New clients should inspect the returned Chat instead. + """ diff --git a/src/beeper_desktop_api/types/chat_list_params.py b/src/beeper_desktop_api/types/chat_list_params.py new file mode 100644 index 0000000..d216046 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_list_params.py @@ -0,0 +1,24 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Annotated, TypedDict + +from .._types import SequenceNotStr +from .._utils import PropertyInfo + +__all__ = ["ChatListParams"] + + +class ChatListParams(TypedDict, total=False): + account_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="accountIDs")] + """Limit to specific account IDs. If omitted, fetches from all accounts.""" + + cursor: str + """Opaque pagination cursor; do not inspect. Use together with 'direction'.""" + + direction: Literal["after", "before"] + """ + Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + """ diff --git a/src/beeper_desktop_api/types/chat_list_response.py b/src/beeper_desktop_api/types/chat_list_response.py new file mode 100644 index 0000000..07ceab1 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_list_response.py @@ -0,0 +1,15 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .chat import Chat +from .shared.message import Message + +__all__ = ["ChatListResponse"] + + +class ChatListResponse(Chat): + """Chat with optional last message preview.""" + + preview: Optional[Message] = None + """Last message preview for this chat, if available.""" diff --git a/src/beeper_desktop_api/types/chat_mark_read_params.py b/src/beeper_desktop_api/types/chat_mark_read_params.py new file mode 100644 index 0000000..a8d4ab6 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_mark_read_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ChatMarkReadParams"] + + +class ChatMarkReadParams(TypedDict, total=False): + message_id: Annotated[str, PropertyInfo(alias="messageID")] + """Optional message ID to mark read through.""" diff --git a/src/beeper_desktop_api/types/chat_mark_unread_params.py b/src/beeper_desktop_api/types/chat_mark_unread_params.py new file mode 100644 index 0000000..142c15b --- /dev/null +++ b/src/beeper_desktop_api/types/chat_mark_unread_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ChatMarkUnreadParams"] + + +class ChatMarkUnreadParams(TypedDict, total=False): + message_id: Annotated[str, PropertyInfo(alias="messageID")] + """Optional message ID to mark unread from.""" diff --git a/src/beeper_desktop_api/types/chat_retrieve_params.py b/src/beeper_desktop_api/types/chat_retrieve_params.py new file mode 100644 index 0000000..4d31ec4 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_retrieve_params.py @@ -0,0 +1,19 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Optional +from typing_extensions import Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ChatRetrieveParams"] + + +class ChatRetrieveParams(TypedDict, total=False): + max_participant_count: Annotated[Optional[int], PropertyInfo(alias="maxParticipantCount")] + """Maximum number of participants to return. + + Use -1 for all; otherwise 0-500. Defaults to 100. List and search endpoints + return up to 20 participants per chat. + """ diff --git a/src/beeper_desktop_api/types/chat_search_params.py b/src/beeper_desktop_api/types/chat_search_params.py new file mode 100644 index 0000000..b3d8876 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_search_params.py @@ -0,0 +1,69 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union, Optional +from datetime import datetime +from typing_extensions import Literal, Annotated, TypedDict + +from .._types import SequenceNotStr +from .._utils import PropertyInfo + +__all__ = ["ChatSearchParams"] + + +class ChatSearchParams(TypedDict, total=False): + account_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="accountIDs")] + """Limit results to specific chat accounts.""" + + cursor: str + """Opaque pagination cursor; do not inspect. Use together with 'direction'.""" + + direction: Literal["after", "before"] + """ + Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + """ + + inbox: Literal["primary", "low-priority", "archive"] + """ + Filter by inbox type: "primary" (non-archived, non-low-priority), + "low-priority", or "archive". If not specified, shows all chats. + """ + + include_muted: Annotated[Optional[bool], PropertyInfo(alias="includeMuted")] + """Include chats marked as Muted by the user, which are usually less important. + + Default: true. Set to false if the user wants a more refined search. + """ + + last_activity_after: Annotated[Union[str, datetime], PropertyInfo(alias="lastActivityAfter", format="iso8601")] + """Only include chats with last activity after this ISO 8601 datetime.""" + + last_activity_before: Annotated[Union[str, datetime], PropertyInfo(alias="lastActivityBefore", format="iso8601")] + """Only include chats with last activity before this ISO 8601 datetime.""" + + limit: int + """Set the maximum number of chats to retrieve. Valid range: 1-200, default is 50""" + + query: str + """Literal chat search. + + Use words the user typed, such as "dinner". When multiple words are provided, + all must match. Case-insensitive. + """ + + scope: Literal["titles", "participants"] + """ + Search scope: 'titles' matches title + network; 'participants' matches + participant names. + """ + + type: Literal["single", "group", "any"] + """ + Specify the type of chats to retrieve: use "single" for direct messages, "group" + for group chats, or "any" to get all types + """ + + unread_only: Annotated[Optional[bool], PropertyInfo(alias="unreadOnly")] + """Set to true to only retrieve chats that have unread messages""" diff --git a/src/beeper_desktop_api/types/chat_start_params.py b/src/beeper_desktop_api/types/chat_start_params.py new file mode 100644 index 0000000..69030f1 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_start_params.py @@ -0,0 +1,42 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ChatStartParams", "User"] + + +class ChatStartParams(TypedDict, total=False): + account_id: Required[Annotated[str, PropertyInfo(alias="accountID")]] + """Account to create or start the chat on.""" + + user: Required[User] + """Contact-like user 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.""" + + message_text: Annotated[str, PropertyInfo(alias="messageText")] + """Optional first message content if the platform requires it to create the chat.""" + + +class User(TypedDict, total=False): + """Contact-like user 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.""" diff --git a/src/beeper_desktop_api/types/chat_start_response.py b/src/beeper_desktop_api/types/chat_start_response.py new file mode 100644 index 0000000..5b3880f --- /dev/null +++ b/src/beeper_desktop_api/types/chat_start_response.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .chat import Chat + +__all__ = ["ChatStartResponse"] + + +class ChatStartResponse(Chat): + chat_id: str = FieldInfo(alias="chatID") + """DEPRECATED - use id instead. Compatibility alias for older clients.""" + + status: Optional[Literal["existing", "created"]] = None + """DEPRECATED - legacy start-chat status for older clients. + + New clients should inspect the returned Chat instead. + """ diff --git a/src/beeper_desktop_api/types/chat_update_params.py b/src/beeper_desktop_api/types/chat_update_params.py new file mode 100644 index 0000000..1e6da03 --- /dev/null +++ b/src/beeper_desktop_api/types/chat_update_params.py @@ -0,0 +1,106 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Optional +from typing_extensions import Literal, Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ChatUpdateParams", "Draft", "DraftAttachments", "DraftAttachmentsSize"] + + +class ChatUpdateParams(TypedDict, total=False): + description: Optional[str] + """Group chat description/topic. + + Support depends on the chat account and chat permissions. + """ + + draft: Optional[Draft] + """Draft object to set or clear. + + Non-empty drafts are only accepted when the current draft is empty. Send + draft=null to clear text and attachments together before setting a new draft. + """ + + img_url: Annotated[Optional[str], PropertyInfo(alias="imgURL")] + """Local filesystem path to a group chat avatar image. + + Support depends on the chat account and chat permissions. + """ + + is_archived: Annotated[bool, PropertyInfo(alias="isArchived")] + """Archive or unarchive the chat.""" + + is_low_priority: Annotated[bool, PropertyInfo(alias="isLowPriority")] + """Mark or unmark the chat as low priority when supported by the account.""" + + is_muted: Annotated[bool, PropertyInfo(alias="isMuted")] + """Mute or unmute the chat.""" + + is_pinned: Annotated[bool, PropertyInfo(alias="isPinned")] + """Pin or unpin the chat when supported by the account.""" + + message_expiry_seconds: Annotated[Optional[int], PropertyInfo(alias="messageExpirySeconds")] + """Disappearing-message timer in seconds, or null to clear when supported.""" + + title: Optional[str] + """Custom chat title. Support depends on the chat account and chat permissions.""" + + +class DraftAttachmentsSize(TypedDict, total=False): + """Dimensions (optional override of cached value)""" + + height: Required[float] + + width: Required[float] + + +class DraftAttachments(TypedDict, total=False): + upload_id: Required[Annotated[str, PropertyInfo(alias="uploadID")]] + """Upload ID from uploadAsset endpoint. Required to reference uploaded files.""" + + id: str + """Optional draft attachment identifier. + + If omitted, a new identifier is generated. + """ + + duration: float + """Duration in seconds (optional override of cached value)""" + + file_name: Annotated[str, PropertyInfo(alias="fileName")] + """Filename (optional override of cached value)""" + + mime_type: Annotated[str, PropertyInfo(alias="mimeType")] + """MIME type (optional override of cached value)""" + + size: DraftAttachmentsSize + """Dimensions (optional override of cached value)""" + + type: Literal["image", "video", "audio", "file", "gif", "voice-note", "sticker"] + """Attachment type hint (image, video, audio, file, gif, voice-note, sticker). + + If omitted, auto-detected from mimeType + """ + + +class Draft(TypedDict, total=False): + """Draft object to set or clear. + + Non-empty drafts are only accepted when the current draft is empty. Send draft=null to clear text and attachments together before setting a new draft. + """ + + text: Required[str] + """Draft text. + + Plain text and Markdown are converted to Beeper rich text with the same rules + used by send and edit. + """ + + attachments: Dict[str, DraftAttachments] + """Draft attachments keyed by attachment ID. + + Each attachment must reference an uploadID returned by the upload file endpoint. + """ diff --git a/src/beeper_desktop_api/types/chats/__init__.py b/src/beeper_desktop_api/types/chats/__init__.py new file mode 100644 index 0000000..848b361 --- /dev/null +++ b/src/beeper_desktop_api/types/chats/__init__.py @@ -0,0 +1,5 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .reminder_create_params import ReminderCreateParams as ReminderCreateParams diff --git a/src/beeper_desktop_api/types/chats/messages/__init__.py b/src/beeper_desktop_api/types/chats/messages/__init__.py new file mode 100644 index 0000000..cd93e4b --- /dev/null +++ b/src/beeper_desktop_api/types/chats/messages/__init__.py @@ -0,0 +1,7 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .reaction_add_params import ReactionAddParams as ReactionAddParams +from .reaction_add_response import ReactionAddResponse as ReactionAddResponse +from .reaction_delete_response import ReactionDeleteResponse as ReactionDeleteResponse diff --git a/src/beeper_desktop_api/types/chats/messages/reaction_add_params.py b/src/beeper_desktop_api/types/chats/messages/reaction_add_params.py new file mode 100644 index 0000000..24b3585 --- /dev/null +++ b/src/beeper_desktop_api/types/chats/messages/reaction_add_params.py @@ -0,0 +1,24 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ...._utils import PropertyInfo + +__all__ = ["ReactionAddParams"] + + +class ReactionAddParams(TypedDict, total=False): + chat_id: Required[Annotated[str, PropertyInfo(alias="chatID")]] + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + reaction_key: Required[Annotated[str, PropertyInfo(alias="reactionKey")]] + """Reaction key to add (emoji, shortcode, or custom emoji key)""" + + transaction_id: Annotated[str, PropertyInfo(alias="transactionID")] + """Optional transaction ID for deduplication and send tracking""" diff --git a/src/beeper_desktop_api/types/chats/messages/reaction_add_response.py b/src/beeper_desktop_api/types/chats/messages/reaction_add_response.py new file mode 100644 index 0000000..d465e10 --- /dev/null +++ b/src/beeper_desktop_api/types/chats/messages/reaction_add_response.py @@ -0,0 +1,33 @@ +# 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 + +__all__ = ["ReactionAddResponse"] + + +class ReactionAddResponse(BaseModel): + chat_id: str = FieldInfo(alias="chatID") + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + message_id: str = FieldInfo(alias="messageID") + """Message ID.""" + + reaction_key: str = FieldInfo(alias="reactionKey") + """Reaction key that was added.""" + + success: Literal[True] + """Always true. + + Indicates the reaction was queued; failures return an error response. + """ + + transaction_id: str = FieldInfo(alias="transactionID") + """Transaction ID used for send tracking.""" diff --git a/src/beeper_desktop_api/types/chats/messages/reaction_delete_response.py b/src/beeper_desktop_api/types/chats/messages/reaction_delete_response.py new file mode 100644 index 0000000..48b65de --- /dev/null +++ b/src/beeper_desktop_api/types/chats/messages/reaction_delete_response.py @@ -0,0 +1,30 @@ +# 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 + +__all__ = ["ReactionDeleteResponse"] + + +class ReactionDeleteResponse(BaseModel): + chat_id: str = FieldInfo(alias="chatID") + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + message_id: str = FieldInfo(alias="messageID") + """Message ID.""" + + reaction_key: str = FieldInfo(alias="reactionKey") + """Reaction key that was removed.""" + + success: Literal[True] + """Always true. + + Indicates the reaction removal was queued; failures return an error response. + """ diff --git a/src/beeper_desktop_api/types/chats/reminder_create_params.py b/src/beeper_desktop_api/types/chats/reminder_create_params.py new file mode 100644 index 0000000..e9e29b6 --- /dev/null +++ b/src/beeper_desktop_api/types/chats/reminder_create_params.py @@ -0,0 +1,26 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from datetime import datetime +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["ReminderCreateParams", "Reminder"] + + +class ReminderCreateParams(TypedDict, total=False): + reminder: Required[Reminder] + """Reminder configuration""" + + +class Reminder(TypedDict, total=False): + """Reminder configuration""" + + remind_at: Required[Annotated[Union[str, datetime], PropertyInfo(alias="remindAt", format="iso8601")]] + """Timestamp when the reminder should trigger.""" + + dismiss_on_incoming_message: Annotated[bool, PropertyInfo(alias="dismissOnIncomingMessage")] + """Cancel reminder if someone messages in the chat""" diff --git a/src/beeper_desktop_api/types/client_focus_params.py b/src/beeper_desktop_api/types/client_focus_params.py new file mode 100644 index 0000000..c8e0d9d --- /dev/null +++ b/src/beeper_desktop_api/types/client_focus_params.py @@ -0,0 +1,26 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["ClientFocusParams"] + + +class ClientFocusParams(TypedDict, total=False): + chat_id: Annotated[str, PropertyInfo(alias="chatID")] + """Optional Beeper chat ID (or local chat ID) to focus after opening the app. + + If omitted, only opens/focuses the app. + """ + + draft_attachment_path: Annotated[str, PropertyInfo(alias="draftAttachmentPath")] + """Optional local image path to populate in the message input field.""" + + draft_text: Annotated[str, PropertyInfo(alias="draftText")] + """Optional plain text to populate in the message input field.""" + + message_id: Annotated[str, PropertyInfo(alias="messageID")] + """Optional message ID. Jumps to that message in the chat when opening.""" diff --git a/src/beeper_desktop_api/types/client_search_params.py b/src/beeper_desktop_api/types/client_search_params.py new file mode 100644 index 0000000..fb7f161 --- /dev/null +++ b/src/beeper_desktop_api/types/client_search_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["ClientSearchParams"] + + +class ClientSearchParams(TypedDict, total=False): + query: Required[str] + """User-typed search text. Uses literal word matching.""" diff --git a/src/beeper_desktop_api/types/cookie_field.py b/src/beeper_desktop_api/types/cookie_field.py new file mode 100644 index 0000000..5c20149 --- /dev/null +++ b/src/beeper_desktop_api/types/cookie_field.py @@ -0,0 +1,19 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["CookieField"] + + +class CookieField(BaseModel): + id: str + """Field ID to send back in the fields object.""" + + name: Optional[str] = None + """Cookie, header, or local storage key to collect.""" + + type: Optional[Literal["cookie", "header", "local_storage"]] = None + """Browser storage source for this value.""" diff --git a/src/beeper_desktop_api/types/disappearing_timer_capability.py b/src/beeper_desktop_api/types/disappearing_timer_capability.py new file mode 100644 index 0000000..9e86c25 --- /dev/null +++ b/src/beeper_desktop_api/types/disappearing_timer_capability.py @@ -0,0 +1,18 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["DisappearingTimerCapability"] + + +class DisappearingTimerCapability(BaseModel): + """Disappearing-message timer capability.""" + + types: List[Literal["", "after_read", "after_send"]] + + omit_empty_timer: Optional[Literal[True]] = None + + timers: Optional[List[int]] = None diff --git a/src/beeper_desktop_api/types/focus_response.py b/src/beeper_desktop_api/types/focus_response.py new file mode 100644 index 0000000..c6a0262 --- /dev/null +++ b/src/beeper_desktop_api/types/focus_response.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .._models import BaseModel + +__all__ = ["FocusResponse"] + + +class FocusResponse(BaseModel): + """Response indicating successful app focus action.""" + + success: bool + """Whether the app was successfully opened/focused.""" diff --git a/src/beeper_desktop_api/types/group_field_capability.py b/src/beeper_desktop_api/types/group_field_capability.py new file mode 100644 index 0000000..2ecbb92 --- /dev/null +++ b/src/beeper_desktop_api/types/group_field_capability.py @@ -0,0 +1,23 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel +from .disappearing_timer_capability import DisappearingTimerCapability + +__all__ = ["GroupFieldCapability"] + + +class GroupFieldCapability(BaseModel): + """Group creation field capability.""" + + allowed: bool + + max_length: Optional[int] = None + + min_length: Optional[int] = None + + required: Optional[bool] = None + + settings: Optional[DisappearingTimerCapability] = None + """Disappearing-message timer capability.""" diff --git a/src/beeper_desktop_api/types/group_type_capabilities.py b/src/beeper_desktop_api/types/group_type_capabilities.py new file mode 100644 index 0000000..abb841f --- /dev/null +++ b/src/beeper_desktop_api/types/group_type_capabilities.py @@ -0,0 +1,35 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel +from .group_field_capability import GroupFieldCapability + +__all__ = ["GroupTypeCapabilities"] + + +class GroupTypeCapabilities(BaseModel): + """Group creation capabilities for one group type.""" + + type_description: str + + avatar: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + disappear: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + name: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + parent: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + participants: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + topic: Optional[GroupFieldCapability] = None + """Group creation field capability.""" + + username: Optional[GroupFieldCapability] = None + """Group creation field capability.""" diff --git a/src/beeper_desktop_api/types/info_retrieve_response.py b/src/beeper_desktop_api/types/info_retrieve_response.py new file mode 100644 index 0000000..74124de --- /dev/null +++ b/src/beeper_desktop_api/types/info_retrieve_response.py @@ -0,0 +1,92 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel + +__all__ = ["InfoRetrieveResponse", "App", "Endpoints", "EndpointsOAuth", "Platform", "Server"] + + +class App(BaseModel): + bundle_id: str + """App bundle identifier""" + + name: str + """App name""" + + version: str + """App version""" + + +class EndpointsOAuth(BaseModel): + authorization_endpoint: str + """OAuth authorization endpoint""" + + introspection_endpoint: str + """OAuth introspection endpoint""" + + registration_endpoint: str + """OAuth dynamic client registration endpoint""" + + revocation_endpoint: str + """OAuth token revocation endpoint""" + + token_endpoint: str + """OAuth token endpoint""" + + userinfo_endpoint: str + """OAuth userinfo endpoint""" + + +class Endpoints(BaseModel): + mcp: str + """MCP endpoint""" + + oauth: EndpointsOAuth + + spec: str + """OpenAPI spec endpoint""" + + ws_events: str + """WebSocket events endpoint""" + + +class Platform(BaseModel): + arch: str + """CPU architecture""" + + os: str + """Operating system identifier""" + + release: Optional[str] = None + """Runtime release version""" + + +class Server(BaseModel): + base_url: str + """Base URL of the Beeper Client API server""" + + hostname: str + """Listening host""" + + mcp_enabled: bool + """Whether MCP endpoint is enabled""" + + port: int + """Listening port""" + + remote_access: bool + """Whether remote access is enabled""" + + status: str + """Server status""" + + +class InfoRetrieveResponse(BaseModel): + app: App + + endpoints: Endpoints + + platform: Platform + + server: Server diff --git a/src/beeper_desktop_api/types/login_flow.py b/src/beeper_desktop_api/types/login_flow.py new file mode 100644 index 0000000..fe0c71b --- /dev/null +++ b/src/beeper_desktop_api/types/login_flow.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel + +__all__ = ["LoginFlow"] + + +class LoginFlow(BaseModel): + """Connect or reconnect flow option for a bridge.""" + + id: str + """Flow ID to pass when creating a bridge login session.""" + + description: Optional[str] = None + """Short explanation for when to use this flow, when provided.""" + + name: Optional[str] = None + """Display name for the flow, when provided.""" diff --git a/src/beeper_desktop_api/types/login_input_field.py b/src/beeper_desktop_api/types/login_input_field.py new file mode 100644 index 0000000..4407f27 --- /dev/null +++ b/src/beeper_desktop_api/types/login_input_field.py @@ -0,0 +1,29 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["LoginInputField"] + + +class LoginInputField(BaseModel): + id: str + """Field ID to send back in the fields object.""" + + initial_value: Optional[str] = FieldInfo(alias="initialValue", default=None) + """Initial field value, when provided by the network.""" + + label: Optional[str] = None + """Field label to show to the user.""" + + optional: Optional[bool] = None + """True if the user can leave this field empty.""" + + placeholder: Optional[str] = None + """Placeholder text to show when the field is empty.""" + + type: Optional[str] = None + """Suggested input type, such as text, password, or email.""" diff --git a/src/beeper_desktop_api/types/login_session.py b/src/beeper_desktop_api/types/login_session.py new file mode 100644 index 0000000..1a5fe9f --- /dev/null +++ b/src/beeper_desktop_api/types/login_session.py @@ -0,0 +1,207 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Union, Optional +from typing_extensions import Literal, TypeAlias + +from pydantic import Field as FieldInfo + +from .account import Account +from .._models import BaseModel +from .shared.user import User +from .cookie_field import CookieField +from .shared.api_error import APIError +from .login_input_field import LoginInputField + +__all__ = [ + "LoginSession", + "CurrentStep", + "CurrentStepUserInput", + "CurrentStepCookies", + "CurrentStepDisplayAndWait", + "CurrentStepDisplayAndWaitDisplay", + "CurrentStepDisplayAndWaitDisplayQrCode", + "CurrentStepDisplayAndWaitDisplayEmoji", + "CurrentStepDisplayAndWaitDisplayEmpty", + "CurrentStepComplete", + "CurrentStepCompleteLogin", + "Login", +] + + +class CurrentStepUserInput(BaseModel): + fields: List[LoginInputField] + + step_id: str = FieldInfo(alias="stepID") + + type: Literal["user_input"] + + attachments: Optional[List[Optional[object]]] = None + + instructions: Optional[str] = None + """User-facing instructions for this step.""" + + +class CurrentStepCookies(BaseModel): + fields: List[CookieField] + + step_id: str = FieldInfo(alias="stepID") + + type: Literal["cookies"] + + url: str + """URL to open for the user.""" + + expected_final_url_regex: Optional[str] = FieldInfo(alias="expectedFinalURLRegex", default=None) + """Regular expression that identifies the final URL after sign-in.""" + + extract_js: Optional[str] = FieldInfo(alias="extractJS", default=None) + """Optional extraction script for browser-based sign-in helpers. + + Treat as an opaque helper value. + """ + + instructions: Optional[str] = None + """User-facing instructions for this browser step.""" + + user_agent: Optional[str] = FieldInfo(alias="userAgent", default=None) + """Suggested user agent for the browser session.""" + + +class CurrentStepDisplayAndWaitDisplayQrCode(BaseModel): + data: str + + type: Literal["qr"] + + +class CurrentStepDisplayAndWaitDisplayEmoji(BaseModel): + image_url: str = FieldInfo(alias="imageURL") + + type: Literal["emoji"] + + +class CurrentStepDisplayAndWaitDisplayEmpty(BaseModel): + type: Literal["nothing"] + + +CurrentStepDisplayAndWaitDisplay: TypeAlias = Union[ + CurrentStepDisplayAndWaitDisplayQrCode, CurrentStepDisplayAndWaitDisplayEmoji, CurrentStepDisplayAndWaitDisplayEmpty +] + + +class CurrentStepDisplayAndWait(BaseModel): + display: CurrentStepDisplayAndWaitDisplay + + step_id: str = FieldInfo(alias="stepID") + + type: Literal["display_and_wait"] + + instructions: Optional[str] = None + """User-facing instructions for this step.""" + + +class CurrentStepCompleteLogin(BaseModel): + """Signed-in identity for a bridge. + + One bridge login can contain multiple chat accounts. + """ + + bridge_id: str = FieldInfo(alias="bridgeID") + """Bridge ID.""" + + login_id: str = FieldInfo(alias="loginID") + """Bridge login ID.""" + + remove_scopes: List[Literal["current-device", "all-devices"]] = FieldInfo(alias="removeScopes") + + status: Literal["connected", "connecting", "needs_login", "logged_out", "unknown"] + + account_ids: Optional[List[str]] = FieldInfo(alias="accountIDs", default=None) + """Chat accounts that belong to this bridge login, when known.""" + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly bridge login status text.""" + + user: Optional[User] = None + """User the account belongs to.""" + + +class CurrentStepComplete(BaseModel): + type: Literal["complete"] + + account: Optional[Account] = None + """A chat account added to Beeper.""" + + instructions: Optional[str] = None + """Completion instructions, when provided.""" + + login: Optional[CurrentStepCompleteLogin] = None + """Signed-in identity for a bridge. + + One bridge login can contain multiple chat accounts. + """ + + step_id: Optional[str] = FieldInfo(alias="stepID", default=None) + + +CurrentStep: TypeAlias = Union[CurrentStepUserInput, CurrentStepCookies, CurrentStepDisplayAndWait, CurrentStepComplete] + + +class Login(BaseModel): + """Signed-in identity for a bridge. + + One bridge login can contain multiple chat accounts. + """ + + bridge_id: str = FieldInfo(alias="bridgeID") + """Bridge ID.""" + + login_id: str = FieldInfo(alias="loginID") + """Bridge login ID.""" + + remove_scopes: List[Literal["current-device", "all-devices"]] = FieldInfo(alias="removeScopes") + + status: Literal["connected", "connecting", "needs_login", "logged_out", "unknown"] + + account_ids: Optional[List[str]] = FieldInfo(alias="accountIDs", default=None) + """Chat accounts that belong to this bridge login, when known.""" + + status_text: Optional[str] = FieldInfo(alias="statusText", default=None) + """Human-friendly bridge login status text.""" + + user: Optional[User] = None + """User the account belongs to.""" + + +class LoginSession(BaseModel): + bridge_id: str = FieldInfo(alias="bridgeID") + """Bridge ID.""" + + login_session_id: str = FieldInfo(alias="loginSessionID") + """Temporary bridge login session ID.""" + + status: Literal[ + "waiting_for_input", "waiting_for_cookies", "waiting_for_display", "complete", "cancelled", "failed" + ] + + account: Optional[Account] = None + """A chat account added to Beeper.""" + + account_id: Optional[str] = FieldInfo(alias="accountID", default=None) + """Chat account ID for reconnect flows, when known.""" + + current_step: Optional[CurrentStep] = FieldInfo(alias="currentStep", default=None) + """Step the client should show or complete next. + + Omitted when the session is complete, cancelled, or failed. + """ + + error: Optional[APIError] = None + + login: Optional[Login] = None + """Signed-in identity for a bridge. + + One bridge login can contain multiple chat accounts. + """ + + login_id: Optional[str] = FieldInfo(alias="loginID", default=None) + """Bridge login ID for reconnect flows, when known.""" diff --git a/src/beeper_desktop_api/types/message_delete_params.py b/src/beeper_desktop_api/types/message_delete_params.py new file mode 100644 index 0000000..ee4ca5e --- /dev/null +++ b/src/beeper_desktop_api/types/message_delete_params.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Optional +from typing_extensions import Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["MessageDeleteParams"] + + +class MessageDeleteParams(TypedDict, total=False): + chat_id: Required[Annotated[str, PropertyInfo(alias="chatID")]] + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + for_everyone: Annotated[Optional[bool], PropertyInfo(alias="forEveryone")] + """ + True to request deletion for everyone when the network supports it; false to + delete only for the authenticated user when supported. + """ diff --git a/src/beeper_desktop_api/types/message_list_params.py b/src/beeper_desktop_api/types/message_list_params.py new file mode 100644 index 0000000..e6a04d2 --- /dev/null +++ b/src/beeper_desktop_api/types/message_list_params.py @@ -0,0 +1,18 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, TypedDict + +__all__ = ["MessageListParams"] + + +class MessageListParams(TypedDict, total=False): + cursor: str + """Opaque pagination cursor; do not inspect. Use together with 'direction'.""" + + direction: Literal["after", "before"] + """ + Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + """ diff --git a/src/beeper_desktop_api/types/message_search_params.py b/src/beeper_desktop_api/types/message_search_params.py new file mode 100644 index 0000000..09b3336 --- /dev/null +++ b/src/beeper_desktop_api/types/message_search_params.py @@ -0,0 +1,80 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import List, Union, Optional +from datetime import datetime +from typing_extensions import Literal, Annotated, TypedDict + +from .._types import SequenceNotStr +from .._utils import PropertyInfo + +__all__ = ["MessageSearchParams"] + + +class MessageSearchParams(TypedDict, total=False): + account_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="accountIDs")] + """Limit search to specific account IDs.""" + + chat_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="chatIDs")] + """Limit search to specific chat IDs.""" + + chat_type: Annotated[Literal["group", "single"], PropertyInfo(alias="chatType")] + """Filter by chat type: 'group' for group chats, 'single' for 1:1 chats.""" + + cursor: str + """Opaque pagination cursor; do not inspect. Use together with 'direction'.""" + + date_after: Annotated[Union[str, datetime], PropertyInfo(alias="dateAfter", format="iso8601")] + """ + Only include messages with timestamp strictly after this ISO 8601 datetime + (e.g., '2024-07-01T00:00:00Z' or '2024-07-01T00:00:00+02:00'). + """ + + date_before: Annotated[Union[str, datetime], PropertyInfo(alias="dateBefore", format="iso8601")] + """ + Only include messages with timestamp strictly before this ISO 8601 datetime + (e.g., '2024-07-31T23:59:59Z' or '2024-07-31T23:59:59+02:00'). + """ + + direction: Literal["after", "before"] + """ + Pagination direction used with 'cursor': 'before' fetches older results, 'after' + fetches newer results. Defaults to 'before' when only 'cursor' is provided. + """ + + exclude_low_priority: Annotated[Optional[bool], PropertyInfo(alias="excludeLowPriority")] + """Exclude messages marked Low Priority by the user. + + Default: true. Set to false to include all. + """ + + include_muted: Annotated[Optional[bool], PropertyInfo(alias="includeMuted")] + """ + Include messages in chats marked as Muted by the user, which are usually less + important. Default: true. Set to false if the user wants a more refined search. + """ + + limit: int + """Maximum number of messages to return.""" + + media_types: Annotated[List[Literal["any", "video", "image", "link", "file"]], PropertyInfo(alias="mediaTypes")] + """Filter messages by media types. + + Use ['any'] for any media type, or specify exact types like ['video', 'image']. + Omit for no media filtering. + """ + + query: str + """Literal word search. + + Finds messages containing these words in any order. Use words the user actually + typed, not inferred concepts. Example: use "dinner" rather than "dinner plans". + If omitted, returns results filtered only by the other parameters. + """ + + sender: str + """ + Filter by sender: 'me' (messages sent by the authenticated user), 'others' + (messages sent by others), or a specific user ID string (user.id). + """ diff --git a/src/beeper_desktop_api/types/message_send_params.py b/src/beeper_desktop_api/types/message_send_params.py new file mode 100644 index 0000000..f73d26d --- /dev/null +++ b/src/beeper_desktop_api/types/message_send_params.py @@ -0,0 +1,57 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["MessageSendParams", "Attachment", "AttachmentSize"] + + +class MessageSendParams(TypedDict, total=False): + attachment: Attachment + """Single attachment to send with the message""" + + reply_to_message_id: Annotated[str, PropertyInfo(alias="replyToMessageID")] + """Provide a message ID to send this as a reply to an existing message""" + + text: str + """Draft text. + + Plain text and Markdown are converted to Beeper rich text with the same rules + used by send and edit. + """ + + +class AttachmentSize(TypedDict, total=False): + """Dimensions (optional override of cached value)""" + + height: Required[float] + + width: Required[float] + + +class Attachment(TypedDict, total=False): + """Single attachment to send with the message""" + + upload_id: Required[Annotated[str, PropertyInfo(alias="uploadID")]] + """Upload ID from uploadAsset endpoint. Required to reference uploaded files.""" + + duration: float + """Duration in seconds (optional override of cached value)""" + + file_name: Annotated[str, PropertyInfo(alias="fileName")] + """Filename (optional override of cached value)""" + + mime_type: Annotated[str, PropertyInfo(alias="mimeType")] + """MIME type (optional override of cached value)""" + + size: AttachmentSize + """Dimensions (optional override of cached value)""" + + type: Literal["image", "video", "audio", "file", "gif", "voice-note", "sticker"] + """Attachment type hint (image, video, audio, file, gif, voice-note, sticker). + + If omitted, auto-detected from mimeType + """ diff --git a/src/beeper_desktop_api/types/message_send_response.py b/src/beeper_desktop_api/types/message_send_response.py new file mode 100644 index 0000000..82ae9ce --- /dev/null +++ b/src/beeper_desktop_api/types/message_send_response.py @@ -0,0 +1,23 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["MessageSendResponse"] + + +class MessageSendResponse(BaseModel): + chat_id: str = FieldInfo(alias="chatID") + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + pending_message_id: str = FieldInfo(alias="pendingMessageID") + """Pending ID assigned to the message before the network confirms the send. + + Pass it to GET /v1/chats/{chatID}/messages/{messageID} to resolve, or wait for + the matching message.upserted over the WebSocket. + """ diff --git a/src/beeper_desktop_api/types/message_update_params.py b/src/beeper_desktop_api/types/message_update_params.py new file mode 100644 index 0000000..024259b --- /dev/null +++ b/src/beeper_desktop_api/types/message_update_params.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["MessageUpdateParams"] + + +class MessageUpdateParams(TypedDict, total=False): + chat_id: Required[Annotated[str, PropertyInfo(alias="chatID")]] + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + text: Required[str] + """New text content for the message""" diff --git a/src/beeper_desktop_api/types/message_update_response.py b/src/beeper_desktop_api/types/message_update_response.py new file mode 100644 index 0000000..095f542 --- /dev/null +++ b/src/beeper_desktop_api/types/message_update_response.py @@ -0,0 +1,20 @@ +# 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 .shared.message import Message + +__all__ = ["MessageUpdateResponse"] + + +class MessageUpdateResponse(Message): + message_id: str = FieldInfo(alias="messageID") + """DEPRECATED - use id instead. Compatibility alias for older clients.""" + + success: Literal[True] + """DEPRECATED - compatibility field. + + Successful responses are already represented by the 200 status code. + """ diff --git a/src/beeper_desktop_api/types/provisioning_capabilities.py b/src/beeper_desktop_api/types/provisioning_capabilities.py new file mode 100644 index 0000000..2a6d15a --- /dev/null +++ b/src/beeper_desktop_api/types/provisioning_capabilities.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional + +from .._models import BaseModel +from .group_type_capabilities import GroupTypeCapabilities +from .resolve_identifier_capabilities import ResolveIdentifierCapabilities + +__all__ = ["ProvisioningCapabilities"] + + +class ProvisioningCapabilities(BaseModel): + """Advanced network capabilities for account lookup and group creation.""" + + group_creation: Dict[str, GroupTypeCapabilities] + + resolve_identifier: ResolveIdentifierCapabilities + """Identifier lookup capabilities for this bridge.""" + + image_pack_import: Optional[bool] = None diff --git a/src/beeper_desktop_api/types/resolve_identifier_capabilities.py b/src/beeper_desktop_api/types/resolve_identifier_capabilities.py new file mode 100644 index 0000000..23038a6 --- /dev/null +++ b/src/beeper_desktop_api/types/resolve_identifier_capabilities.py @@ -0,0 +1,23 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .._models import BaseModel + +__all__ = ["ResolveIdentifierCapabilities"] + + +class ResolveIdentifierCapabilities(BaseModel): + """Identifier lookup capabilities for this bridge.""" + + any_phone: bool + + contact_list: bool + + create_dm: bool + + lookup_email: bool + + lookup_phone: bool + + lookup_username: bool + + search: bool diff --git a/src/beeper_desktop_api/types/search_response.py b/src/beeper_desktop_api/types/search_response.py new file mode 100644 index 0000000..fe5113c --- /dev/null +++ b/src/beeper_desktop_api/types/search_response.py @@ -0,0 +1,48 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional + +from pydantic import Field as FieldInfo + +from .chat import Chat +from .._models import BaseModel +from .shared.message import Message + +__all__ = ["SearchResponse", "Results", "ResultsMessages"] + + +class ResultsMessages(BaseModel): + chats: Dict[str, Chat] + """Map of chatID -> chat details for chats referenced in items.""" + + has_more: bool = FieldInfo(alias="hasMore") + """True if additional results can be fetched using the provided cursors.""" + + items: List[Message] + """Messages matching the query and filters.""" + + newest_cursor: Optional[str] = FieldInfo(alias="newestCursor", default=None) + """Cursor for fetching newer results (use with direction='after'). + + Opaque string; do not inspect. + """ + + oldest_cursor: Optional[str] = FieldInfo(alias="oldestCursor", default=None) + """Cursor for fetching older results (use with direction='before'). + + Opaque string; do not inspect. + """ + + +class Results(BaseModel): + chats: List[Chat] + """Top chat results.""" + + in_groups: List[Chat] + """Top group results by participant matches.""" + + messages: ResultsMessages + + +class SearchResponse(BaseModel): + results: Results diff --git a/src/beeper_desktop_api/types/shared/__init__.py b/src/beeper_desktop_api/types/shared/__init__.py new file mode 100644 index 0000000..c29fad6 --- /dev/null +++ b/src/beeper_desktop_api/types/shared/__init__.py @@ -0,0 +1,9 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .user import User as User +from .error import Error as Error +from .message import Message as Message +from .reaction import Reaction as Reaction +from .api_error import APIError as APIError +from .attachment import Attachment as Attachment +from .app_state_snapshot import AppStateSnapshot as AppStateSnapshot diff --git a/src/beeper_desktop_api/types/shared/api_error.py b/src/beeper_desktop_api/types/shared/api_error.py new file mode 100644 index 0000000..1f000f0 --- /dev/null +++ b/src/beeper_desktop_api/types/shared/api_error.py @@ -0,0 +1,15 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional + +from ..._models import BaseModel + +__all__ = ["APIError"] + + +class APIError(BaseModel): + code: str + + message: str + + details: Optional[Dict[str, Optional[object]]] = None diff --git a/src/beeper_desktop_api/types/shared/app_state_snapshot.py b/src/beeper_desktop_api/types/shared/app_state_snapshot.py new file mode 100644 index 0000000..58eea37 --- /dev/null +++ b/src/beeper_desktop_api/types/shared/app_state_snapshot.py @@ -0,0 +1,184 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = [ + "AppStateSnapshot", + "E2EE", + "E2EESecrets", + "Matrix", + "Verification", + "VerificationError", + "VerificationOtherDevice", + "VerificationQr", + "VerificationSAS", +] + + +class E2EESecrets(BaseModel): + """Encrypted messaging keys available on this device.""" + + master_key: bool = FieldInfo(alias="masterKey") + """Whether the account identity key is available.""" + + megolm_backup_key: bool = FieldInfo(alias="megolmBackupKey") + """Whether the encrypted message backup key is available.""" + + recovery_key: bool = FieldInfo(alias="recoveryKey") + """Whether a recovery key is available.""" + + self_signing_key: bool = FieldInfo(alias="selfSigningKey") + """Whether the device trust key is available.""" + + user_signing_key: bool = FieldInfo(alias="userSigningKey") + """Whether the user trust key is available.""" + + +class E2EE(BaseModel): + """Encrypted messaging setup status.""" + + cross_signing: bool = FieldInfo(alias="crossSigning") + """Whether this account can verify trusted devices.""" + + first_sync_done: bool = FieldInfo(alias="firstSyncDone") + """Whether the first encrypted message sync is complete.""" + + has_backed_up_recovery_key: bool = FieldInfo(alias="hasBackedUpRecoveryKey") + """Whether the user confirmed that they saved their recovery key.""" + + initialized: bool + """Whether encrypted messaging setup has started.""" + + key_backup: bool = FieldInfo(alias="keyBackup") + """Whether encrypted message backup is available.""" + + secrets: E2EESecrets + """Encrypted messaging keys available on this device.""" + + secret_storage: bool = FieldInfo(alias="secretStorage") + """Whether secure key storage is available.""" + + verified: bool + """Whether this device is trusted for encrypted messages.""" + + recovery_key_generated_at: Optional[float] = FieldInfo(alias="recoveryKeyGeneratedAt", default=None) + """Unix timestamp for when the recovery key was created.""" + + +class Matrix(BaseModel): + """Signed-in account details. Omitted until sign-in is complete.""" + + device_id: str = FieldInfo(alias="deviceID") + """Current device ID.""" + + homeserver: str + """Beeper homeserver URL for this account.""" + + user_id: str = FieldInfo(alias="userID") + """Signed-in Beeper user ID.""" + + +class VerificationError(BaseModel): + """Verification error details, if verification stopped.""" + + code: str + """Verification error code.""" + + reason: str + """User-facing verification error message.""" + + +class VerificationOtherDevice(BaseModel): + """Other device participating in verification.""" + + id: str + """Other device ID.""" + + name: Optional[str] = None + """Other device display name, if known.""" + + +class VerificationQr(BaseModel): + """QR verification data.""" + + data: str + """QR code payload to display for verification.""" + + +class VerificationSAS(BaseModel): + """Emoji or number comparison data for verification.""" + + emojis: str + """Emoji sequence to compare on both devices.""" + + decimals: Optional[str] = None + """Number sequence to compare on both devices.""" + + +class Verification(BaseModel): + """Trusted device verification progress.""" + + id: str + """Verification ID to pass in verification action paths.""" + + available_actions: List[Literal["accept", "cancel", "qr.confirmScanned", "sas.start", "sas.confirm"]] = FieldInfo( + alias="availableActions" + ) + """Verification actions that are valid for the current state.""" + + direction: Literal["incoming", "outgoing"] + """Whether this device started or received the verification.""" + + methods: List[Literal["qr", "sas"]] + """Verification methods supported for this transaction.""" + + purpose: Literal["login", "device"] + """Why this verification exists.""" + + state: Literal["requested", "ready", "sas_ready", "qr_scanned", "done", "cancelled", "error"] + """Current trusted-device verification state.""" + + error: Optional[VerificationError] = None + """Verification error details, if verification stopped.""" + + other_device: Optional[VerificationOtherDevice] = FieldInfo(alias="otherDevice", default=None) + """Other device participating in verification.""" + + other_user_id: Optional[str] = FieldInfo(alias="otherUserID", default=None) + """Other Beeper user participating in verification.""" + + qr: Optional[VerificationQr] = None + """QR verification data.""" + + sas: Optional[VerificationSAS] = None + """Emoji or number comparison data for verification.""" + + +class AppStateSnapshot(BaseModel): + e2ee: E2EE + """Encrypted messaging setup status.""" + + state: Literal[ + "needs-login", + "initializing", + "needs-cross-signing-setup", + "needs-verification", + "needs-secrets", + "needs-first-sync", + "ready", + ] + """ + Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper + Server. + """ + + matrix: Optional[Matrix] = None + """Signed-in account details. Omitted until sign-in is complete.""" + + verification: Optional[Verification] = None + """Trusted device verification progress.""" diff --git a/src/beeper_desktop_api/types/shared/attachment.py b/src/beeper_desktop_api/types/shared/attachment.py new file mode 100644 index 0000000..cd7ed3b --- /dev/null +++ b/src/beeper_desktop_api/types/shared/attachment.py @@ -0,0 +1,83 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["Attachment", "Size", "Transcription"] + + +class Size(BaseModel): + """Pixel dimensions of the attachment: width/height in px.""" + + height: Optional[float] = None + + width: Optional[float] = None + + +class Transcription(BaseModel): + """Attachment transcription if available.""" + + engine: str + """Transcription engine.""" + + transcription: str + """Transcribed text.""" + + language: Optional[str] = None + """Detected or selected language.""" + + +class Attachment(BaseModel): + type: Literal["unknown", "img", "video", "audio"] + """Attachment type.""" + + id: Optional[str] = None + """Attachment identifier, typically an mxc:// URL. + + Use the download file endpoint to get a local file path. + """ + + duration: Optional[float] = None + """Duration in seconds (audio/video).""" + + file_name: Optional[str] = FieldInfo(alias="fileName", default=None) + """Original filename if available.""" + + file_size: Optional[float] = FieldInfo(alias="fileSize", default=None) + """File size in bytes if known.""" + + is_gif: Optional[bool] = FieldInfo(alias="isGif", default=None) + """True if the attachment is a GIF.""" + + is_sticker: Optional[bool] = FieldInfo(alias="isSticker", default=None) + """True if the attachment is a sticker.""" + + is_voice_note: Optional[bool] = FieldInfo(alias="isVoiceNote", default=None) + """True if the attachment is a voice note.""" + + mime_type: Optional[str] = FieldInfo(alias="mimeType", default=None) + """MIME type if known (e.g., 'image/png').""" + + poster_img: Optional[str] = FieldInfo(alias="posterImg", default=None) + """Preview image URL for video attachments (poster frame). + + May be temporary or available only on this device; download promptly if durable + access is needed. + """ + + size: Optional[Size] = None + """Pixel dimensions of the attachment: width/height in px.""" + + src_url: Optional[str] = FieldInfo(alias="srcURL", default=None) + """Public URL or local file path to fetch the file. + + May be temporary or available only on this device; download promptly if durable + access is needed. + """ + + transcription: Optional[Transcription] = None + """Attachment transcription if available.""" diff --git a/src/beeper_desktop_api/types/shared/error.py b/src/beeper_desktop_api/types/shared/error.py new file mode 100644 index 0000000..17c2409 --- /dev/null +++ b/src/beeper_desktop_api/types/shared/error.py @@ -0,0 +1,40 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Union, Optional +from typing_extensions import TypeAlias + +from ..._models import BaseModel + +__all__ = ["Error", "Details", "DetailsValidationDetails", "DetailsValidationDetailsIssue"] + + +class DetailsValidationDetailsIssue(BaseModel): + code: str + """Validation issue code""" + + message: str + """Human-readable description of the validation issue""" + + path: List[Union[str, float]] + """Path pointing to the invalid field within the payload""" + + +class DetailsValidationDetails(BaseModel): + """Validation error details""" + + issues: List[DetailsValidationDetailsIssue] + """List of validation issues""" + + +Details: TypeAlias = Union[DetailsValidationDetails, Dict[str, Optional[object]], Optional[object]] + + +class Error(BaseModel): + code: str + """Machine-readable error code""" + + message: str + """Error message""" + + details: Optional[Details] = None + """Additional error details for debugging""" diff --git a/src/beeper_desktop_api/types/shared/message.py b/src/beeper_desktop_api/types/shared/message.py new file mode 100644 index 0000000..2f74fe4 --- /dev/null +++ b/src/beeper_desktop_api/types/shared/message.py @@ -0,0 +1,160 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Union, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .reaction import Reaction +from ..._models import BaseModel +from .attachment import Attachment + +__all__ = ["Message", "Link", "LinkImgSize", "SendStatus"] + + +class LinkImgSize(BaseModel): + """Preview image dimensions.""" + + height: Optional[float] = None + + width: Optional[float] = None + + +class Link(BaseModel): + """Link preview included with a message.""" + + title: str + """Link preview title.""" + + url: str + """Resolved link URL.""" + + favicon: Optional[str] = None + """Favicon URL if available. + + May be temporary or available only on this device; download promptly if durable + access is needed. + """ + + img: Optional[str] = None + """Preview image URL if available. + + May be temporary or available only on this device; download promptly if durable + access is needed. + """ + + img_size: Optional[LinkImgSize] = FieldInfo(alias="imgSize", default=None) + """Preview image dimensions.""" + + original_url: Optional[str] = FieldInfo(alias="originalURL", default=None) + """Original URL when the displayed URL is shortened or redirected.""" + + summary: Optional[str] = None + """Link preview summary.""" + + +class SendStatus(BaseModel): + """Message send status for this message, when reported by the bridge.""" + + status: Literal["SUCCESS", "PENDING", "FAIL_RETRIABLE", "FAIL_PERMANENT"] + """Current status of the message send attempt.""" + + timestamp: datetime + """Timestamp for the send status event.""" + + delivered_to_users: Optional[List[str]] = FieldInfo(alias="deliveredToUsers", default=None) + """User IDs the message was delivered to, when reported by the network.""" + + internal_error: Optional[str] = FieldInfo(alias="internalError", default=None) + """Diagnostic error detail from the messaging network adapter. + + Do not show directly to users. + """ + + message: Optional[str] = None + """Human-readable send status or failure message.""" + + reason: Optional[str] = None + """Machine-readable failure reason. Present when the send status is a failure.""" + + +class Message(BaseModel): + id: str + """Message ID.""" + + account_id: str = FieldInfo(alias="accountID") + """Beeper account ID the message belongs to.""" + + chat_id: str = FieldInfo(alias="chatID") + """Chat ID. + + Input routes also accept the local chat ID from this installation when + available. + """ + + sender_id: str = FieldInfo(alias="senderID") + """Fully qualified sender user ID. + + Network-backed IDs usually include the network prefix and homeserver. + """ + + sort_key: str = FieldInfo(alias="sortKey") + """A unique, sortable key used to sort messages.""" + + timestamp: datetime + """Message timestamp.""" + + attachments: Optional[List[Attachment]] = None + """Attachments included with this message, if any.""" + + edited_timestamp: Optional[datetime] = FieldInfo(alias="editedTimestamp", default=None) + """Timestamp when the message was edited, if known.""" + + is_deleted: Optional[bool] = FieldInfo(alias="isDeleted", default=None) + """True if the message has been deleted.""" + + is_hidden: Optional[bool] = FieldInfo(alias="isHidden", default=None) + """True if the message is hidden from normal display.""" + + is_sender: Optional[bool] = FieldInfo(alias="isSender", default=None) + """True if the authenticated user sent the message.""" + + is_unread: Optional[bool] = FieldInfo(alias="isUnread", default=None) + """True if the message is unread for the authenticated user. May be omitted.""" + + linked_message_id: Optional[str] = FieldInfo(alias="linkedMessageID", default=None) + """ID of the message this is a reply to, if any.""" + + links: Optional[List[Link]] = None + """Link previews included with this message, if any.""" + + mentions: Optional[List[str]] = None + """ + Mentioned user IDs, @room, or null for legacy messages that require text + scanning. + """ + + reactions: Optional[List[Reaction]] = None + """Reactions to the message, if any.""" + + seen: Union[bool, datetime, Dict[str, Union[bool, datetime]], None] = None + """Read receipt state for this message, when available.""" + + sender_name: Optional[str] = FieldInfo(alias="senderName", default=None) + """Resolved sender display name.""" + + send_status: Optional[SendStatus] = FieldInfo(alias="sendStatus", default=None) + """Message send status for this message, when reported by the bridge.""" + + text: Optional[str] = None + """Rich-text message body if present.""" + + type: Optional[ + Literal["TEXT", "NOTICE", "IMAGE", "VIDEO", "VOICE", "AUDIO", "FILE", "STICKER", "LOCATION", "REACTION"] + ] = None + """Message content type. + + Useful for distinguishing reactions, media messages, and state events from + regular text messages. + """ diff --git a/src/beeper_desktop_api/types/shared/reaction.py b/src/beeper_desktop_api/types/shared/reaction.py new file mode 100644 index 0000000..751db4e --- /dev/null +++ b/src/beeper_desktop_api/types/shared/reaction.py @@ -0,0 +1,37 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["Reaction"] + + +class Reaction(BaseModel): + id: str + """Reaction ID. + + When a participant can react more than once, the ID is the participant ID + concatenated with the reaction key; otherwise it equals the participant ID. + """ + + participant_id: str = FieldInfo(alias="participantID") + """User ID of the participant who reacted.""" + + reaction_key: str = FieldInfo(alias="reactionKey") + """ + The reaction key: an emoji (😄), a network-specific key, or a shortcode like + "smiling-face". + """ + + emoji: Optional[bool] = None + """True if the reactionKey is an emoji.""" + + img_url: Optional[str] = FieldInfo(alias="imgURL", default=None) + """URL to the reaction's image. + + May be temporary or available only on this device; download promptly if durable + access is needed. + """ diff --git a/src/beeper_desktop_api/types/shared/user.py b/src/beeper_desktop_api/types/shared/user.py new file mode 100644 index 0000000..2f170ab --- /dev/null +++ b/src/beeper_desktop_api/types/shared/user.py @@ -0,0 +1,48 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["User"] + + +class User(BaseModel): + """User the account belongs to.""" + + id: str + """Stable Beeper user ID. Use as the primary key when referencing a person.""" + + cannot_message: Optional[bool] = FieldInfo(alias="cannotMessage", default=None) + """ + True if Beeper cannot initiate messages to this user (e.g., blocked, network + restriction, or no DM path). The user may still message you. + """ + + email: Optional[str] = None + """Email address if known. Not guaranteed verified.""" + + full_name: Optional[str] = FieldInfo(alias="fullName", default=None) + """Display name as shown in clients (e.g., 'Alice Example'). May include emojis.""" + + img_url: Optional[str] = FieldInfo(alias="imgURL", default=None) + """Avatar image URL if available. + + This may be a remote URL, media URL, data URL, or local file URL depending on + the source. May be temporary or available only on this device; download promptly + if durable access is needed. + """ + + is_self: Optional[bool] = FieldInfo(alias="isSelf", default=None) + """True if this user represents the authenticated account's own identity.""" + + phone_number: Optional[str] = FieldInfo(alias="phoneNumber", default=None) + """User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.""" + + username: Optional[str] = None + """Human-readable handle if available (e.g., '@alice'). + + May be network-specific and not globally unique. + """ diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/__init__.py b/tests/api_resources/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/accounts/__init__.py b/tests/api_resources/accounts/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/accounts/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/accounts/test_contacts.py b/tests/api_resources/accounts/test_contacts.py new file mode 100644 index 0000000..1361a11 --- /dev/null +++ b/tests/api_resources/accounts/test_contacts.py @@ -0,0 +1,208 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.pagination import SyncCursorSearch, AsyncCursorSearch +from beeper_desktop_api.types.shared import User +from beeper_desktop_api.types.accounts import ContactSearchResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestContacts: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + contact = client.accounts.contacts.list( + account_id="accountID", + ) + assert_matches_type(SyncCursorSearch[User], contact, path=["response"]) + + @parametrize + def test_method_list_with_all_params(self, client: BeeperDesktop) -> None: + contact = client.accounts.contacts.list( + account_id="accountID", + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + limit=1, + query="x", + ) + assert_matches_type(SyncCursorSearch[User], contact, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.accounts.contacts.with_raw_response.list( + account_id="accountID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + contact = response.parse() + assert_matches_type(SyncCursorSearch[User], contact, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.accounts.contacts.with_streaming_response.list( + account_id="accountID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + contact = response.parse() + assert_matches_type(SyncCursorSearch[User], contact, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_list(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + client.accounts.contacts.with_raw_response.list( + account_id="", + ) + + @parametrize + def test_method_search(self, client: BeeperDesktop) -> None: + contact = client.accounts.contacts.search( + account_id="accountID", + query="x", + ) + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + @parametrize + def test_raw_response_search(self, client: BeeperDesktop) -> None: + response = client.accounts.contacts.with_raw_response.search( + account_id="accountID", + query="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + contact = response.parse() + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + @parametrize + def test_streaming_response_search(self, client: BeeperDesktop) -> None: + with client.accounts.contacts.with_streaming_response.search( + account_id="accountID", + query="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + contact = response.parse() + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_search(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + client.accounts.contacts.with_raw_response.search( + account_id="", + query="x", + ) + + +class TestAsyncContacts: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + contact = await async_client.accounts.contacts.list( + account_id="accountID", + ) + assert_matches_type(AsyncCursorSearch[User], contact, path=["response"]) + + @parametrize + async def test_method_list_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + contact = await async_client.accounts.contacts.list( + account_id="accountID", + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + limit=1, + query="x", + ) + assert_matches_type(AsyncCursorSearch[User], contact, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.accounts.contacts.with_raw_response.list( + account_id="accountID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + contact = await response.parse() + assert_matches_type(AsyncCursorSearch[User], contact, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.accounts.contacts.with_streaming_response.list( + account_id="accountID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + contact = await response.parse() + assert_matches_type(AsyncCursorSearch[User], contact, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_list(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + await async_client.accounts.contacts.with_raw_response.list( + account_id="", + ) + + @parametrize + async def test_method_search(self, async_client: AsyncBeeperDesktop) -> None: + contact = await async_client.accounts.contacts.search( + account_id="accountID", + query="x", + ) + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + @parametrize + async def test_raw_response_search(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.accounts.contacts.with_raw_response.search( + account_id="accountID", + query="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + contact = await response.parse() + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + @parametrize + async def test_streaming_response_search(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.accounts.contacts.with_streaming_response.search( + account_id="accountID", + query="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + contact = await response.parse() + assert_matches_type(ContactSearchResponse, contact, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_search(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + await async_client.accounts.contacts.with_raw_response.search( + account_id="", + query="x", + ) diff --git a/tests/api_resources/app/__init__.py b/tests/api_resources/app/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/app/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/app/login/__init__.py b/tests/api_resources/app/login/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/app/login/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/app/login/verification/__init__.py b/tests/api_resources/app/login/verification/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/app/login/verification/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/app/login/verification/recovery_key/__init__.py b/tests/api_resources/app/login/verification/recovery_key/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/app/login/verification/recovery_key/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/app/login/verification/recovery_key/test_reset.py b/tests/api_resources/app/login/verification/recovery_key/test_reset.py new file mode 100644 index 0000000..9b96cbd --- /dev/null +++ b/tests/api_resources/app/login/verification/recovery_key/test_reset.py @@ -0,0 +1,153 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app.login.verification.recovery_key import ( + ResetCreateResponse, + ResetConfirmResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestReset: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: BeeperDesktop) -> None: + reset = client.app.login.verification.recovery_key.reset.create() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: BeeperDesktop) -> None: + reset = client.app.login.verification.recovery_key.reset.create( + existing_recovery_key="existingRecoveryKey", + ) + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: BeeperDesktop) -> None: + response = client.app.login.verification.recovery_key.reset.with_raw_response.create() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reset = response.parse() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: BeeperDesktop) -> None: + with client.app.login.verification.recovery_key.reset.with_streaming_response.create() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reset = response.parse() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_confirm(self, client: BeeperDesktop) -> None: + reset = client.app.login.verification.recovery_key.reset.confirm( + recovery_key="x", + ) + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + @parametrize + def test_raw_response_confirm(self, client: BeeperDesktop) -> None: + response = client.app.login.verification.recovery_key.reset.with_raw_response.confirm( + recovery_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reset = response.parse() + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + @parametrize + def test_streaming_response_confirm(self, client: BeeperDesktop) -> None: + with client.app.login.verification.recovery_key.reset.with_streaming_response.confirm( + recovery_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reset = response.parse() + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncReset: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncBeeperDesktop) -> None: + reset = await async_client.app.login.verification.recovery_key.reset.create() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + reset = await async_client.app.login.verification.recovery_key.reset.create( + existing_recovery_key="existingRecoveryKey", + ) + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.verification.recovery_key.reset.with_raw_response.create() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reset = await response.parse() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.verification.recovery_key.reset.with_streaming_response.create() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reset = await response.parse() + assert_matches_type(ResetCreateResponse, reset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_confirm(self, async_client: AsyncBeeperDesktop) -> None: + reset = await async_client.app.login.verification.recovery_key.reset.confirm( + recovery_key="x", + ) + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + @parametrize + async def test_raw_response_confirm(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.verification.recovery_key.reset.with_raw_response.confirm( + recovery_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reset = await response.parse() + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + @parametrize + async def test_streaming_response_confirm(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.verification.recovery_key.reset.with_streaming_response.confirm( + recovery_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reset = await response.parse() + assert_matches_type(ResetConfirmResponse, reset, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/app/login/verification/test_recovery_key.py b/tests/api_resources/app/login/verification/test_recovery_key.py new file mode 100644 index 0000000..5778b2a --- /dev/null +++ b/tests/api_resources/app/login/verification/test_recovery_key.py @@ -0,0 +1,86 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app.login.verification import RecoveryKeyVerifyResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestRecoveryKey: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_verify(self, client: BeeperDesktop) -> None: + recovery_key = client.app.login.verification.recovery_key.verify( + recovery_key="x", + ) + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + @parametrize + def test_raw_response_verify(self, client: BeeperDesktop) -> None: + response = client.app.login.verification.recovery_key.with_raw_response.verify( + recovery_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + recovery_key = response.parse() + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + @parametrize + def test_streaming_response_verify(self, client: BeeperDesktop) -> None: + with client.app.login.verification.recovery_key.with_streaming_response.verify( + recovery_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + recovery_key = response.parse() + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncRecoveryKey: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_verify(self, async_client: AsyncBeeperDesktop) -> None: + recovery_key = await async_client.app.login.verification.recovery_key.verify( + recovery_key="x", + ) + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + @parametrize + async def test_raw_response_verify(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.verification.recovery_key.with_raw_response.verify( + recovery_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + recovery_key = await response.parse() + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + @parametrize + async def test_streaming_response_verify(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.verification.recovery_key.with_streaming_response.verify( + recovery_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + recovery_key = await response.parse() + assert_matches_type(RecoveryKeyVerifyResponse, recovery_key, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/app/test_login.py b/tests/api_resources/app/test_login.py new file mode 100644 index 0000000..343ef54 --- /dev/null +++ b/tests/api_resources/app/test_login.py @@ -0,0 +1,294 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app import ( + LoginStartResponse, + LoginRegisterResponse, + LoginResponseResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestLogin: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_email(self, client: BeeperDesktop) -> None: + login = client.app.login.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) + assert login is None + + @parametrize + def test_raw_response_email(self, client: BeeperDesktop) -> None: + response = client.app.login.with_raw_response.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = response.parse() + assert login is None + + @parametrize + def test_streaming_response_email(self, client: BeeperDesktop) -> None: + with client.app.login.with_streaming_response.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = response.parse() + assert login is None + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_register(self, client: BeeperDesktop) -> None: + login = client.app.login.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + @parametrize + def test_raw_response_register(self, client: BeeperDesktop) -> None: + response = client.app.login.with_raw_response.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = response.parse() + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + @parametrize + def test_streaming_response_register(self, client: BeeperDesktop) -> None: + with client.app.login.with_streaming_response.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = response.parse() + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_response(self, client: BeeperDesktop) -> None: + login = client.app.login.response( + response="response", + setup_request_id="setupRequestID", + ) + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + @parametrize + def test_raw_response_response(self, client: BeeperDesktop) -> None: + response = client.app.login.with_raw_response.response( + response="response", + setup_request_id="setupRequestID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = response.parse() + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + @parametrize + def test_streaming_response_response(self, client: BeeperDesktop) -> None: + with client.app.login.with_streaming_response.response( + response="response", + setup_request_id="setupRequestID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = response.parse() + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_start(self, client: BeeperDesktop) -> None: + login = client.app.login.start() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + @parametrize + def test_raw_response_start(self, client: BeeperDesktop) -> None: + response = client.app.login.with_raw_response.start() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = response.parse() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + @parametrize + def test_streaming_response_start(self, client: BeeperDesktop) -> None: + with client.app.login.with_streaming_response.start() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = response.parse() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncLogin: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_email(self, async_client: AsyncBeeperDesktop) -> None: + login = await async_client.app.login.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) + assert login is None + + @parametrize + async def test_raw_response_email(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.with_raw_response.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = await response.parse() + assert login is None + + @parametrize + async def test_streaming_response_email(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.with_streaming_response.email( + email="dev@stainless.com", + setup_request_id="setupRequestID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = await response.parse() + assert login is None + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_register(self, async_client: AsyncBeeperDesktop) -> None: + login = await async_client.app.login.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + @parametrize + async def test_raw_response_register(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.with_raw_response.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = await response.parse() + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + @parametrize + async def test_streaming_response_register(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.with_streaming_response.register( + accept_terms=True, + lead_token="leadToken", + setup_request_id="setupRequestID", + username="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = await response.parse() + assert_matches_type(LoginRegisterResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_response(self, async_client: AsyncBeeperDesktop) -> None: + login = await async_client.app.login.response( + response="response", + setup_request_id="setupRequestID", + ) + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + @parametrize + async def test_raw_response_response(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.with_raw_response.response( + response="response", + setup_request_id="setupRequestID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = await response.parse() + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + @parametrize + async def test_streaming_response_response(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.with_streaming_response.response( + response="response", + setup_request_id="setupRequestID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = await response.parse() + assert_matches_type(LoginResponseResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_start(self, async_client: AsyncBeeperDesktop) -> None: + login = await async_client.app.login.start() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + @parametrize + async def test_raw_response_start(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.login.with_raw_response.start() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login = await response.parse() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + @parametrize + async def test_streaming_response_start(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.login.with_streaming_response.start() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login = await response.parse() + assert_matches_type(LoginStartResponse, login, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/app/test_verifications.py b/tests/api_resources/app/test_verifications.py new file mode 100644 index 0000000..b94df48 --- /dev/null +++ b/tests/api_resources/app/test_verifications.py @@ -0,0 +1,392 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app import ( + VerificationListResponse, + VerificationAcceptResponse, + VerificationCancelResponse, + VerificationCreateResponse, + VerificationRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestVerifications: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.create() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.create( + purpose="login", + user_id="userID", + ) + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: BeeperDesktop) -> None: + response = client.app.verifications.with_raw_response.create() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = response.parse() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: BeeperDesktop) -> None: + with client.app.verifications.with_streaming_response.create() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = response.parse() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.retrieve( + "x", + ) + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.app.verifications.with_raw_response.retrieve( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = response.parse() + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.app.verifications.with_streaming_response.retrieve( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = response.parse() + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.list() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.app.verifications.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = response.parse() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.app.verifications.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = response.parse() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_accept(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.accept( + "x", + ) + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + @parametrize + def test_raw_response_accept(self, client: BeeperDesktop) -> None: + response = client.app.verifications.with_raw_response.accept( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = response.parse() + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + @parametrize + def test_streaming_response_accept(self, client: BeeperDesktop) -> None: + with client.app.verifications.with_streaming_response.accept( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = response.parse() + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_accept(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.with_raw_response.accept( + "", + ) + + @parametrize + def test_method_cancel(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.cancel( + verification_id="x", + ) + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + def test_method_cancel_with_all_params(self, client: BeeperDesktop) -> None: + verification = client.app.verifications.cancel( + verification_id="x", + code="code", + reason="reason", + ) + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + def test_raw_response_cancel(self, client: BeeperDesktop) -> None: + response = client.app.verifications.with_raw_response.cancel( + verification_id="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = response.parse() + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + def test_streaming_response_cancel(self, client: BeeperDesktop) -> None: + with client.app.verifications.with_streaming_response.cancel( + verification_id="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = response.parse() + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_cancel(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.with_raw_response.cancel( + verification_id="", + ) + + +class TestAsyncVerifications: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.create() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.create( + purpose="login", + user_id="userID", + ) + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.with_raw_response.create() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = await response.parse() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.with_streaming_response.create() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = await response.parse() + assert_matches_type(VerificationCreateResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.retrieve( + "x", + ) + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.with_raw_response.retrieve( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = await response.parse() + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.with_streaming_response.retrieve( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = await response.parse() + assert_matches_type(VerificationRetrieveResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.list() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = await response.parse() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = await response.parse() + assert_matches_type(VerificationListResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_accept(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.accept( + "x", + ) + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + @parametrize + async def test_raw_response_accept(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.with_raw_response.accept( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = await response.parse() + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + @parametrize + async def test_streaming_response_accept(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.with_streaming_response.accept( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = await response.parse() + assert_matches_type(VerificationAcceptResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_accept(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.with_raw_response.accept( + "", + ) + + @parametrize + async def test_method_cancel(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.cancel( + verification_id="x", + ) + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + async def test_method_cancel_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + verification = await async_client.app.verifications.cancel( + verification_id="x", + code="code", + reason="reason", + ) + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + async def test_raw_response_cancel(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.with_raw_response.cancel( + verification_id="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verification = await response.parse() + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + @parametrize + async def test_streaming_response_cancel(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.with_streaming_response.cancel( + verification_id="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verification = await response.parse() + assert_matches_type(VerificationCancelResponse, verification, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_cancel(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.with_raw_response.cancel( + verification_id="", + ) diff --git a/tests/api_resources/app/verifications/__init__.py b/tests/api_resources/app/verifications/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/app/verifications/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/app/verifications/test_qr.py b/tests/api_resources/app/verifications/test_qr.py new file mode 100644 index 0000000..2678078 --- /dev/null +++ b/tests/api_resources/app/verifications/test_qr.py @@ -0,0 +1,162 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app.verifications import QrScanResponse, QrConfirmScannedResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestQr: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_confirm_scanned(self, client: BeeperDesktop) -> None: + qr = client.app.verifications.qr.confirm_scanned( + "x", + ) + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + @parametrize + def test_raw_response_confirm_scanned(self, client: BeeperDesktop) -> None: + response = client.app.verifications.qr.with_raw_response.confirm_scanned( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + qr = response.parse() + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + @parametrize + def test_streaming_response_confirm_scanned(self, client: BeeperDesktop) -> None: + with client.app.verifications.qr.with_streaming_response.confirm_scanned( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + qr = response.parse() + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_confirm_scanned(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.qr.with_raw_response.confirm_scanned( + "", + ) + + @parametrize + def test_method_scan(self, client: BeeperDesktop) -> None: + qr = client.app.verifications.qr.scan( + data="x", + ) + assert_matches_type(QrScanResponse, qr, path=["response"]) + + @parametrize + def test_raw_response_scan(self, client: BeeperDesktop) -> None: + response = client.app.verifications.qr.with_raw_response.scan( + data="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + qr = response.parse() + assert_matches_type(QrScanResponse, qr, path=["response"]) + + @parametrize + def test_streaming_response_scan(self, client: BeeperDesktop) -> None: + with client.app.verifications.qr.with_streaming_response.scan( + data="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + qr = response.parse() + assert_matches_type(QrScanResponse, qr, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncQr: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_confirm_scanned(self, async_client: AsyncBeeperDesktop) -> None: + qr = await async_client.app.verifications.qr.confirm_scanned( + "x", + ) + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + @parametrize + async def test_raw_response_confirm_scanned(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.qr.with_raw_response.confirm_scanned( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + qr = await response.parse() + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + @parametrize + async def test_streaming_response_confirm_scanned(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.qr.with_streaming_response.confirm_scanned( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + qr = await response.parse() + assert_matches_type(QrConfirmScannedResponse, qr, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_confirm_scanned(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.qr.with_raw_response.confirm_scanned( + "", + ) + + @parametrize + async def test_method_scan(self, async_client: AsyncBeeperDesktop) -> None: + qr = await async_client.app.verifications.qr.scan( + data="x", + ) + assert_matches_type(QrScanResponse, qr, path=["response"]) + + @parametrize + async def test_raw_response_scan(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.qr.with_raw_response.scan( + data="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + qr = await response.parse() + assert_matches_type(QrScanResponse, qr, path=["response"]) + + @parametrize + async def test_streaming_response_scan(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.qr.with_streaming_response.scan( + data="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + qr = await response.parse() + assert_matches_type(QrScanResponse, qr, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/app/verifications/test_sas.py b/tests/api_resources/app/verifications/test_sas.py new file mode 100644 index 0000000..020880b --- /dev/null +++ b/tests/api_resources/app/verifications/test_sas.py @@ -0,0 +1,176 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.app.verifications import SASStartResponse, SASConfirmResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSAS: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_confirm(self, client: BeeperDesktop) -> None: + sas = client.app.verifications.sas.confirm( + "x", + ) + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + @parametrize + def test_raw_response_confirm(self, client: BeeperDesktop) -> None: + response = client.app.verifications.sas.with_raw_response.confirm( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sas = response.parse() + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + @parametrize + def test_streaming_response_confirm(self, client: BeeperDesktop) -> None: + with client.app.verifications.sas.with_streaming_response.confirm( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sas = response.parse() + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_confirm(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.sas.with_raw_response.confirm( + "", + ) + + @parametrize + def test_method_start(self, client: BeeperDesktop) -> None: + sas = client.app.verifications.sas.start( + "x", + ) + assert_matches_type(SASStartResponse, sas, path=["response"]) + + @parametrize + def test_raw_response_start(self, client: BeeperDesktop) -> None: + response = client.app.verifications.sas.with_raw_response.start( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sas = response.parse() + assert_matches_type(SASStartResponse, sas, path=["response"]) + + @parametrize + def test_streaming_response_start(self, client: BeeperDesktop) -> None: + with client.app.verifications.sas.with_streaming_response.start( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sas = response.parse() + assert_matches_type(SASStartResponse, sas, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_start(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + client.app.verifications.sas.with_raw_response.start( + "", + ) + + +class TestAsyncSAS: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_confirm(self, async_client: AsyncBeeperDesktop) -> None: + sas = await async_client.app.verifications.sas.confirm( + "x", + ) + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + @parametrize + async def test_raw_response_confirm(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.sas.with_raw_response.confirm( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sas = await response.parse() + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + @parametrize + async def test_streaming_response_confirm(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.sas.with_streaming_response.confirm( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sas = await response.parse() + assert_matches_type(SASConfirmResponse, sas, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_confirm(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.sas.with_raw_response.confirm( + "", + ) + + @parametrize + async def test_method_start(self, async_client: AsyncBeeperDesktop) -> None: + sas = await async_client.app.verifications.sas.start( + "x", + ) + assert_matches_type(SASStartResponse, sas, path=["response"]) + + @parametrize + async def test_raw_response_start(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.verifications.sas.with_raw_response.start( + "x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sas = await response.parse() + assert_matches_type(SASStartResponse, sas, path=["response"]) + + @parametrize + async def test_streaming_response_start(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.verifications.sas.with_streaming_response.start( + "x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sas = await response.parse() + assert_matches_type(SASStartResponse, sas, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_start(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `verification_id` but received ''"): + await async_client.app.verifications.sas.with_raw_response.start( + "", + ) diff --git a/tests/api_resources/bridges/__init__.py b/tests/api_resources/bridges/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/bridges/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/bridges/login_sessions/__init__.py b/tests/api_resources/bridges/login_sessions/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/bridges/login_sessions/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/bridges/login_sessions/test_steps.py b/tests/api_resources/bridges/login_sessions/test_steps.py new file mode 100644 index 0000000..7b8f9b4 --- /dev/null +++ b/tests/api_resources/bridges/login_sessions/test_steps.py @@ -0,0 +1,182 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import LoginSession + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSteps: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_submit(self, client: BeeperDesktop) -> None: + step = client.bridges.login_sessions.steps.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + def test_method_submit_with_all_params(self, client: BeeperDesktop) -> None: + step = client.bridges.login_sessions.steps.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + fields={"foo": "string"}, + last_url="lastURL", + source="api", + ) + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + def test_raw_response_submit(self, client: BeeperDesktop) -> None: + response = client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + step = response.parse() + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + def test_streaming_response_submit(self, client: BeeperDesktop) -> None: + with client.bridges.login_sessions.steps.with_streaming_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + step = response.parse() + assert_matches_type(LoginSession, step, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_submit(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="", + login_session_id="123", + type="user_input", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="", + type="user_input", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `step_id` but received ''"): + client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) + + +class TestAsyncSteps: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_submit(self, async_client: AsyncBeeperDesktop) -> None: + step = await async_client.bridges.login_sessions.steps.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + async def test_method_submit_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + step = await async_client.bridges.login_sessions.steps.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + fields={"foo": "string"}, + last_url="lastURL", + source="api", + ) + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + async def test_raw_response_submit(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + step = await response.parse() + assert_matches_type(LoginSession, step, path=["response"]) + + @parametrize + async def test_streaming_response_submit(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.login_sessions.steps.with_streaming_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + step = await response.parse() + assert_matches_type(LoginSession, step, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_submit(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="", + login_session_id="123", + type="user_input", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + await async_client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="x", + bridge_id="local-whatsapp", + login_session_id="", + type="user_input", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `step_id` but received ''"): + await async_client.bridges.login_sessions.steps.with_raw_response.submit( + step_id="", + bridge_id="local-whatsapp", + login_session_id="123", + type="user_input", + ) diff --git a/tests/api_resources/bridges/test_login_flows.py b/tests/api_resources/bridges/test_login_flows.py new file mode 100644 index 0000000..d14a6fb --- /dev/null +++ b/tests/api_resources/bridges/test_login_flows.py @@ -0,0 +1,100 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.bridges import LoginFlowListResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestLoginFlows: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + login_flow = client.bridges.login_flows.list( + "local-whatsapp", + ) + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.bridges.login_flows.with_raw_response.list( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_flow = response.parse() + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.bridges.login_flows.with_streaming_response.list( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_flow = response.parse() + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_list(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.login_flows.with_raw_response.list( + "", + ) + + +class TestAsyncLoginFlows: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + login_flow = await async_client.bridges.login_flows.list( + "local-whatsapp", + ) + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.login_flows.with_raw_response.list( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_flow = await response.parse() + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.login_flows.with_streaming_response.list( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_flow = await response.parse() + assert_matches_type(LoginFlowListResponse, login_flow, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_list(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.login_flows.with_raw_response.list( + "", + ) diff --git a/tests/api_resources/bridges/test_login_sessions.py b/tests/api_resources/bridges/test_login_sessions.py new file mode 100644 index 0000000..adf87f8 --- /dev/null +++ b/tests/api_resources/bridges/test_login_sessions.py @@ -0,0 +1,313 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import LoginSession +from beeper_desktop_api.types.bridges import LoginSessionCancelResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestLoginSessions: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: BeeperDesktop) -> None: + login_session = client.bridges.login_sessions.create( + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: BeeperDesktop) -> None: + login_session = client.bridges.login_sessions.create( + bridge_id="local-whatsapp", + account_id="x", + flow_id="x", + login_id="x", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: BeeperDesktop) -> None: + response = client.bridges.login_sessions.with_raw_response.create( + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: BeeperDesktop) -> None: + with client.bridges.login_sessions.with_streaming_response.create( + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.login_sessions.with_raw_response.create( + bridge_id="", + ) + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + login_session = client.bridges.login_sessions.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.bridges.login_sessions.with_streaming_response.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="123", + bridge_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="", + bridge_id="local-whatsapp", + ) + + @parametrize + def test_method_cancel(self, client: BeeperDesktop) -> None: + login_session = client.bridges.login_sessions.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + @parametrize + def test_raw_response_cancel(self, client: BeeperDesktop) -> None: + response = client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = response.parse() + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + @parametrize + def test_streaming_response_cancel(self, client: BeeperDesktop) -> None: + with client.bridges.login_sessions.with_streaming_response.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = response.parse() + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_cancel(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="123", + bridge_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="", + bridge_id="local-whatsapp", + ) + + +class TestAsyncLoginSessions: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncBeeperDesktop) -> None: + login_session = await async_client.bridges.login_sessions.create( + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + login_session = await async_client.bridges.login_sessions.create( + bridge_id="local-whatsapp", + account_id="x", + flow_id="x", + login_id="x", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.login_sessions.with_raw_response.create( + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = await response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.login_sessions.with_streaming_response.create( + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = await response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.login_sessions.with_raw_response.create( + bridge_id="", + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + login_session = await async_client.bridges.login_sessions.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = await response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.login_sessions.with_streaming_response.retrieve( + login_session_id="123", + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = await response.parse() + assert_matches_type(LoginSession, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="123", + bridge_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + await async_client.bridges.login_sessions.with_raw_response.retrieve( + login_session_id="", + bridge_id="local-whatsapp", + ) + + @parametrize + async def test_method_cancel(self, async_client: AsyncBeeperDesktop) -> None: + login_session = await async_client.bridges.login_sessions.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + @parametrize + async def test_raw_response_cancel(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + login_session = await response.parse() + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + @parametrize + async def test_streaming_response_cancel(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.login_sessions.with_streaming_response.cancel( + login_session_id="123", + bridge_id="local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + login_session = await response.parse() + assert_matches_type(LoginSessionCancelResponse, login_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_cancel(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="123", + bridge_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `login_session_id` but received ''"): + await async_client.bridges.login_sessions.with_raw_response.cancel( + login_session_id="", + bridge_id="local-whatsapp", + ) diff --git a/tests/api_resources/chats/__init__.py b/tests/api_resources/chats/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/chats/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/chats/messages/__init__.py b/tests/api_resources/chats/messages/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/chats/messages/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/chats/messages/test_reactions.py b/tests/api_resources/chats/messages/test_reactions.py new file mode 100644 index 0000000..5b8a782 --- /dev/null +++ b/tests/api_resources/chats/messages/test_reactions.py @@ -0,0 +1,270 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types.chats.messages import ReactionAddResponse, ReactionDeleteResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestReactions: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_delete(self, client: BeeperDesktop) -> None: + reaction = client.chats.messages.reactions.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + @parametrize + def test_raw_response_delete(self, client: BeeperDesktop) -> None: + response = client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reaction = response.parse() + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + @parametrize + def test_streaming_response_delete(self, client: BeeperDesktop) -> None: + with client.chats.messages.reactions.with_streaming_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reaction = response.parse() + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_delete(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="", + message_id="1343993", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `reaction_key` but received ''"): + client.chats.messages.reactions.with_raw_response.delete( + reaction_key="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + + @parametrize + def test_method_add(self, client: BeeperDesktop) -> None: + reaction = client.chats.messages.reactions.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + def test_method_add_with_all_params(self, client: BeeperDesktop) -> None: + reaction = client.chats.messages.reactions.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + transaction_id="transactionID", + ) + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + def test_raw_response_add(self, client: BeeperDesktop) -> None: + response = client.chats.messages.reactions.with_raw_response.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reaction = response.parse() + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + def test_streaming_response_add(self, client: BeeperDesktop) -> None: + with client.chats.messages.reactions.with_streaming_response.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reaction = response.parse() + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_add(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.messages.reactions.with_raw_response.add( + message_id="1343993", + chat_id="", + reaction_key="x", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + client.chats.messages.reactions.with_raw_response.add( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) + + +class TestAsyncReactions: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_delete(self, async_client: AsyncBeeperDesktop) -> None: + reaction = await async_client.chats.messages.reactions.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reaction = await response.parse() + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.messages.reactions.with_streaming_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reaction = await response.parse() + assert_matches_type(ReactionDeleteResponse, reaction, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_delete(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="", + message_id="1343993", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + await async_client.chats.messages.reactions.with_raw_response.delete( + reaction_key="x", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `reaction_key` but received ''"): + await async_client.chats.messages.reactions.with_raw_response.delete( + reaction_key="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + + @parametrize + async def test_method_add(self, async_client: AsyncBeeperDesktop) -> None: + reaction = await async_client.chats.messages.reactions.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + async def test_method_add_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + reaction = await async_client.chats.messages.reactions.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + transaction_id="transactionID", + ) + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + async def test_raw_response_add(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.messages.reactions.with_raw_response.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reaction = await response.parse() + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + @parametrize + async def test_streaming_response_add(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.messages.reactions.with_streaming_response.add( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reaction = await response.parse() + assert_matches_type(ReactionAddResponse, reaction, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_add(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.messages.reactions.with_raw_response.add( + message_id="1343993", + chat_id="", + reaction_key="x", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + await async_client.chats.messages.reactions.with_raw_response.add( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reaction_key="x", + ) diff --git a/tests/api_resources/chats/test_reminders.py b/tests/api_resources/chats/test_reminders.py new file mode 100644 index 0000000..f21dc2d --- /dev/null +++ b/tests/api_resources/chats/test_reminders.py @@ -0,0 +1,205 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api._utils import parse_datetime + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestReminders: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: BeeperDesktop) -> None: + reminder = client.chats.reminders.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + assert reminder is None + + @parametrize + def test_method_create_with_all_params(self, client: BeeperDesktop) -> None: + reminder = client.chats.reminders.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={ + "remind_at": parse_datetime("2025-08-31T23:30:12.520Z"), + "dismiss_on_incoming_message": True, + }, + ) + assert reminder is None + + @parametrize + def test_raw_response_create(self, client: BeeperDesktop) -> None: + response = client.chats.reminders.with_raw_response.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reminder = response.parse() + assert reminder is None + + @parametrize + def test_streaming_response_create(self, client: BeeperDesktop) -> None: + with client.chats.reminders.with_streaming_response.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reminder = response.parse() + assert reminder is None + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.reminders.with_raw_response.create( + chat_id="", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + + @parametrize + def test_method_delete(self, client: BeeperDesktop) -> None: + reminder = client.chats.reminders.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert reminder is None + + @parametrize + def test_raw_response_delete(self, client: BeeperDesktop) -> None: + response = client.chats.reminders.with_raw_response.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reminder = response.parse() + assert reminder is None + + @parametrize + def test_streaming_response_delete(self, client: BeeperDesktop) -> None: + with client.chats.reminders.with_streaming_response.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reminder = response.parse() + assert reminder is None + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_delete(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.reminders.with_raw_response.delete( + "", + ) + + +class TestAsyncReminders: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncBeeperDesktop) -> None: + reminder = await async_client.chats.reminders.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + assert reminder is None + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + reminder = await async_client.chats.reminders.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={ + "remind_at": parse_datetime("2025-08-31T23:30:12.520Z"), + "dismiss_on_incoming_message": True, + }, + ) + assert reminder is None + + @parametrize + async def test_raw_response_create(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.reminders.with_raw_response.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reminder = await response.parse() + assert reminder is None + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.reminders.with_streaming_response.create( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reminder = await response.parse() + assert reminder is None + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.reminders.with_raw_response.create( + chat_id="", + reminder={"remind_at": parse_datetime("2025-08-31T23:30:12.520Z")}, + ) + + @parametrize + async def test_method_delete(self, async_client: AsyncBeeperDesktop) -> None: + reminder = await async_client.chats.reminders.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert reminder is None + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.reminders.with_raw_response.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + reminder = await response.parse() + assert reminder is None + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.reminders.with_streaming_response.delete( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + reminder = await response.parse() + assert reminder is None + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_delete(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.reminders.with_raw_response.delete( + "", + ) diff --git a/tests/api_resources/test_accounts.py b/tests/api_resources/test_accounts.py new file mode 100644 index 0000000..dfe06af --- /dev/null +++ b/tests/api_resources/test_accounts.py @@ -0,0 +1,150 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import AccountListResponse, AccountRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAccounts: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + account = client.accounts.retrieve( + "accountID", + ) + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.accounts.with_raw_response.retrieve( + "accountID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + account = response.parse() + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.accounts.with_streaming_response.retrieve( + "accountID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + account = response.parse() + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + client.accounts.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + account = client.accounts.list() + assert_matches_type(AccountListResponse, account, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.accounts.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + account = response.parse() + assert_matches_type(AccountListResponse, account, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.accounts.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + account = response.parse() + assert_matches_type(AccountListResponse, account, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncAccounts: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + account = await async_client.accounts.retrieve( + "accountID", + ) + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.accounts.with_raw_response.retrieve( + "accountID", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + account = await response.parse() + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.accounts.with_streaming_response.retrieve( + "accountID", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + account = await response.parse() + assert_matches_type(AccountRetrieveResponse, account, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"): + await async_client.accounts.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + account = await async_client.accounts.list() + assert_matches_type(AccountListResponse, account, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.accounts.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + account = await response.parse() + assert_matches_type(AccountListResponse, account, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.accounts.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + account = await response.parse() + assert_matches_type(AccountListResponse, account, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_app.py b/tests/api_resources/test_app.py new file mode 100644 index 0000000..5fe739f --- /dev/null +++ b/tests/api_resources/test_app.py @@ -0,0 +1,74 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import AppSessionResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestApp: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_session(self, client: BeeperDesktop) -> None: + app = client.app.session() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + @parametrize + def test_raw_response_session(self, client: BeeperDesktop) -> None: + response = client.app.with_raw_response.session() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + app = response.parse() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + @parametrize + def test_streaming_response_session(self, client: BeeperDesktop) -> None: + with client.app.with_streaming_response.session() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + app = response.parse() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncApp: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_session(self, async_client: AsyncBeeperDesktop) -> None: + app = await async_client.app.session() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + @parametrize + async def test_raw_response_session(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.app.with_raw_response.session() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + app = await response.parse() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + @parametrize + async def test_streaming_response_session(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.app.with_streaming_response.session() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + app = await response.parse() + assert_matches_type(AppSessionResponse, app, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_assets.py b/tests/api_resources/test_assets.py new file mode 100644 index 0000000..f63f7bb --- /dev/null +++ b/tests/api_resources/test_assets.py @@ -0,0 +1,342 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import httpx +import pytest +from respx import MockRouter + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import ( + AssetUploadResponse, + AssetDownloadResponse, + AssetUploadBase64Response, +) +from beeper_desktop_api._response import ( + BinaryAPIResponse, + AsyncBinaryAPIResponse, + StreamedBinaryAPIResponse, + AsyncStreamedBinaryAPIResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAssets: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_download(self, client: BeeperDesktop) -> None: + asset = client.assets.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + @parametrize + def test_raw_response_download(self, client: BeeperDesktop) -> None: + response = client.assets.with_raw_response.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = response.parse() + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + @parametrize + def test_streaming_response_download(self, client: BeeperDesktop) -> None: + with client.assets.with_streaming_response.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = response.parse() + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + @pytest.mark.respx(base_url=base_url) + def test_method_serve(self, client: BeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + asset = client.assets.serve( + url="x", + ) + assert asset.is_closed + assert asset.json() == {"foo": "bar"} + assert cast(Any, asset.is_closed) is True + assert isinstance(asset, BinaryAPIResponse) + + @parametrize + @pytest.mark.respx(base_url=base_url) + def test_raw_response_serve(self, client: BeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + asset = client.assets.with_raw_response.serve( + url="x", + ) + + assert asset.is_closed is True + assert asset.http_request.headers.get("X-Stainless-Lang") == "python" + assert asset.json() == {"foo": "bar"} + assert isinstance(asset, BinaryAPIResponse) + + @parametrize + @pytest.mark.respx(base_url=base_url) + def test_streaming_response_serve(self, client: BeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + with client.assets.with_streaming_response.serve( + url="x", + ) as asset: + assert not asset.is_closed + assert asset.http_request.headers.get("X-Stainless-Lang") == "python" + + assert asset.json() == {"foo": "bar"} + assert cast(Any, asset.is_closed) is True + assert isinstance(asset, StreamedBinaryAPIResponse) + + assert cast(Any, asset.is_closed) is True + + @parametrize + def test_method_upload(self, client: BeeperDesktop) -> None: + asset = client.assets.upload( + file=b"Example data", + ) + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + def test_method_upload_with_all_params(self, client: BeeperDesktop) -> None: + asset = client.assets.upload( + file=b"Example data", + file_name="fileName", + mime_type="mimeType", + ) + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + def test_raw_response_upload(self, client: BeeperDesktop) -> None: + response = client.assets.with_raw_response.upload( + file=b"Example data", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = response.parse() + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + def test_streaming_response_upload(self, client: BeeperDesktop) -> None: + with client.assets.with_streaming_response.upload( + file=b"Example data", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = response.parse() + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_upload_base64(self, client: BeeperDesktop) -> None: + asset = client.assets.upload_base64( + content="x", + ) + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + def test_method_upload_base64_with_all_params(self, client: BeeperDesktop) -> None: + asset = client.assets.upload_base64( + content="x", + file_name="fileName", + mime_type="mimeType", + ) + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + def test_raw_response_upload_base64(self, client: BeeperDesktop) -> None: + response = client.assets.with_raw_response.upload_base64( + content="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = response.parse() + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + def test_streaming_response_upload_base64(self, client: BeeperDesktop) -> None: + with client.assets.with_streaming_response.upload_base64( + content="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = response.parse() + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncAssets: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_download(self, async_client: AsyncBeeperDesktop) -> None: + asset = await async_client.assets.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + @parametrize + async def test_raw_response_download(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.assets.with_raw_response.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = await response.parse() + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + @parametrize + async def test_streaming_response_download(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.assets.with_streaming_response.download( + url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = await response.parse() + assert_matches_type(AssetDownloadResponse, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + @pytest.mark.respx(base_url=base_url) + async def test_method_serve(self, async_client: AsyncBeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + asset = await async_client.assets.serve( + url="x", + ) + assert asset.is_closed + assert await asset.json() == {"foo": "bar"} + assert cast(Any, asset.is_closed) is True + assert isinstance(asset, AsyncBinaryAPIResponse) + + @parametrize + @pytest.mark.respx(base_url=base_url) + async def test_raw_response_serve(self, async_client: AsyncBeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + asset = await async_client.assets.with_raw_response.serve( + url="x", + ) + + assert asset.is_closed is True + assert asset.http_request.headers.get("X-Stainless-Lang") == "python" + assert await asset.json() == {"foo": "bar"} + assert isinstance(asset, AsyncBinaryAPIResponse) + + @parametrize + @pytest.mark.respx(base_url=base_url) + async def test_streaming_response_serve(self, async_client: AsyncBeeperDesktop, respx_mock: MockRouter) -> None: + respx_mock.get("/v1/assets/serve").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + async with async_client.assets.with_streaming_response.serve( + url="x", + ) as asset: + assert not asset.is_closed + assert asset.http_request.headers.get("X-Stainless-Lang") == "python" + + assert await asset.json() == {"foo": "bar"} + assert cast(Any, asset.is_closed) is True + assert isinstance(asset, AsyncStreamedBinaryAPIResponse) + + assert cast(Any, asset.is_closed) is True + + @parametrize + async def test_method_upload(self, async_client: AsyncBeeperDesktop) -> None: + asset = await async_client.assets.upload( + file=b"Example data", + ) + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + async def test_method_upload_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + asset = await async_client.assets.upload( + file=b"Example data", + file_name="fileName", + mime_type="mimeType", + ) + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + async def test_raw_response_upload(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.assets.with_raw_response.upload( + file=b"Example data", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = await response.parse() + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + @parametrize + async def test_streaming_response_upload(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.assets.with_streaming_response.upload( + file=b"Example data", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = await response.parse() + assert_matches_type(AssetUploadResponse, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_upload_base64(self, async_client: AsyncBeeperDesktop) -> None: + asset = await async_client.assets.upload_base64( + content="x", + ) + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + async def test_method_upload_base64_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + asset = await async_client.assets.upload_base64( + content="x", + file_name="fileName", + mime_type="mimeType", + ) + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + async def test_raw_response_upload_base64(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.assets.with_raw_response.upload_base64( + content="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + asset = await response.parse() + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + @parametrize + async def test_streaming_response_upload_base64(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.assets.with_streaming_response.upload_base64( + content="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + asset = await response.parse() + assert_matches_type(AssetUploadBase64Response, asset, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_bridges.py b/tests/api_resources/test_bridges.py new file mode 100644 index 0000000..91654f1 --- /dev/null +++ b/tests/api_resources/test_bridges.py @@ -0,0 +1,226 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import BridgeListResponse, BridgeRetrieveResponse, ProvisioningCapabilities + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestBridges: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + bridge = client.bridges.retrieve( + "local-whatsapp", + ) + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.bridges.with_raw_response.retrieve( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = response.parse() + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.bridges.with_streaming_response.retrieve( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = response.parse() + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + bridge = client.bridges.list() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.bridges.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = response.parse() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.bridges.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = response.parse() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve_capabilities(self, client: BeeperDesktop) -> None: + bridge = client.bridges.retrieve_capabilities( + "local-whatsapp", + ) + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + @parametrize + def test_raw_response_retrieve_capabilities(self, client: BeeperDesktop) -> None: + response = client.bridges.with_raw_response.retrieve_capabilities( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = response.parse() + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + @parametrize + def test_streaming_response_retrieve_capabilities(self, client: BeeperDesktop) -> None: + with client.bridges.with_streaming_response.retrieve_capabilities( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = response.parse() + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve_capabilities(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + client.bridges.with_raw_response.retrieve_capabilities( + "", + ) + + +class TestAsyncBridges: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + bridge = await async_client.bridges.retrieve( + "local-whatsapp", + ) + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.with_raw_response.retrieve( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = await response.parse() + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.with_streaming_response.retrieve( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = await response.parse() + assert_matches_type(BridgeRetrieveResponse, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + bridge = await async_client.bridges.list() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = await response.parse() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = await response.parse() + assert_matches_type(BridgeListResponse, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve_capabilities(self, async_client: AsyncBeeperDesktop) -> None: + bridge = await async_client.bridges.retrieve_capabilities( + "local-whatsapp", + ) + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + @parametrize + async def test_raw_response_retrieve_capabilities(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.bridges.with_raw_response.retrieve_capabilities( + "local-whatsapp", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + bridge = await response.parse() + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve_capabilities(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.bridges.with_streaming_response.retrieve_capabilities( + "local-whatsapp", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + bridge = await response.parse() + assert_matches_type(ProvisioningCapabilities, bridge, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve_capabilities(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `bridge_id` but received ''"): + await async_client.bridges.with_raw_response.retrieve_capabilities( + "", + ) diff --git a/tests/api_resources/test_chats.py b/tests/api_resources/test_chats.py new file mode 100644 index 0000000..f161ea6 --- /dev/null +++ b/tests/api_resources/test_chats.py @@ -0,0 +1,965 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import ( + Chat, + ChatListResponse, + ChatStartResponse, + ChatCreateResponse, +) +from beeper_desktop_api._utils import parse_datetime +from beeper_desktop_api.pagination import SyncCursorSearch, AsyncCursorSearch, SyncCursorNoLimit, AsyncCursorNoLimit + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestChats: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: BeeperDesktop) -> None: + chat = client.chats.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.create( + account_id="accountID", + participant_ids=["string"], + type="single", + message_text="messageText", + title="title", + ) + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + chat = client.chats.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + max_participant_count=100, + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.retrieve( + chat_id="", + ) + + @parametrize + def test_method_update(self, client: BeeperDesktop) -> None: + chat = client.chats.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_method_update_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + description="description", + draft={ + "text": "text", + "attachments": { + "foo": { + "upload_id": "uploadID", + "id": "id", + "duration": 0, + "file_name": "fileName", + "mime_type": "mimeType", + "size": { + "height": 0, + "width": 0, + }, + "type": "image", + } + }, + }, + img_url="imgURL", + is_archived=True, + is_low_priority=True, + is_muted=True, + is_pinned=True, + message_expiry_seconds=0, + title="title", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_raw_response_update(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_streaming_response_update(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_update(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.update( + chat_id="", + ) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + chat = client.chats.list() + assert_matches_type(SyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + def test_method_list_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.list( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + ) + assert_matches_type(SyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(SyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(SyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_archive(self, client: BeeperDesktop) -> None: + chat = client.chats.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert chat is None + + @parametrize + def test_method_archive_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + archived=True, + ) + assert chat is None + + @parametrize + def test_raw_response_archive(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert chat is None + + @parametrize + def test_streaming_response_archive(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert chat is None + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_archive(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.archive( + chat_id="", + ) + + @parametrize + def test_method_mark_read(self, client: BeeperDesktop) -> None: + chat = client.chats.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_method_mark_read_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_raw_response_mark_read(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_streaming_response_mark_read(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_mark_read(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.mark_read( + chat_id="", + ) + + @parametrize + def test_method_mark_unread(self, client: BeeperDesktop) -> None: + chat = client.chats.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_method_mark_unread_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_raw_response_mark_unread(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_streaming_response_mark_unread(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_mark_unread(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.mark_unread( + chat_id="", + ) + + @parametrize + def test_method_notify_anyway(self, client: BeeperDesktop) -> None: + chat = client.chats.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_raw_response_notify_anyway(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + def test_streaming_response_notify_anyway(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_notify_anyway(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.chats.with_raw_response.notify_anyway( + "", + ) + + @parametrize + def test_method_search(self, client: BeeperDesktop) -> None: + chat = client.chats.search() + assert_matches_type(SyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + def test_method_search_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + inbox="primary", + include_muted=True, + last_activity_after=parse_datetime("2019-12-27T18:11:19.117Z"), + last_activity_before=parse_datetime("2019-12-27T18:11:19.117Z"), + limit=1, + query="x", + scope="titles", + type="single", + unread_only=True, + ) + assert_matches_type(SyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + def test_raw_response_search(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.search() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(SyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + def test_streaming_response_search(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.search() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(SyncCursorSearch[Chat], chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_start(self, client: BeeperDesktop) -> None: + chat = client.chats.start( + account_id="accountID", + user={}, + ) + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + def test_method_start_with_all_params(self, client: BeeperDesktop) -> None: + chat = client.chats.start( + account_id="accountID", + user={ + "id": "id", + "email": "email", + "full_name": "fullName", + "phone_number": "phoneNumber", + "username": "username", + }, + allow_invite=True, + message_text="messageText", + ) + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + def test_raw_response_start(self, client: BeeperDesktop) -> None: + response = client.chats.with_raw_response.start( + account_id="accountID", + user={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = response.parse() + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + def test_streaming_response_start(self, client: BeeperDesktop) -> None: + with client.chats.with_streaming_response.start( + account_id="accountID", + user={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = response.parse() + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncChats: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.create( + account_id="accountID", + participant_ids=["string"], + type="single", + message_text="messageText", + title="title", + ) + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.create( + account_id="accountID", + participant_ids=["string"], + type="single", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(ChatCreateResponse, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + max_participant_count=100, + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.retrieve( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.retrieve( + chat_id="", + ) + + @parametrize + async def test_method_update(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_method_update_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + description="description", + draft={ + "text": "text", + "attachments": { + "foo": { + "upload_id": "uploadID", + "id": "id", + "duration": 0, + "file_name": "fileName", + "mime_type": "mimeType", + "size": { + "height": 0, + "width": 0, + }, + "type": "image", + } + }, + }, + img_url="imgURL", + is_archived=True, + is_low_priority=True, + is_muted=True, + is_pinned=True, + message_expiry_seconds=0, + title="title", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_raw_response_update(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_streaming_response_update(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.update( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_update(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.update( + chat_id="", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.list() + assert_matches_type(AsyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + async def test_method_list_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.list( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + ) + assert_matches_type(AsyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(AsyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(AsyncCursorNoLimit[ChatListResponse], chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_archive(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert chat is None + + @parametrize + async def test_method_archive_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + archived=True, + ) + assert chat is None + + @parametrize + async def test_raw_response_archive(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert chat is None + + @parametrize + async def test_streaming_response_archive(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.archive( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert chat is None + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_archive(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.archive( + chat_id="", + ) + + @parametrize + async def test_method_mark_read(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_method_mark_read_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_raw_response_mark_read(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_streaming_response_mark_read(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.mark_read( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_mark_read(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.mark_read( + chat_id="", + ) + + @parametrize + async def test_method_mark_unread(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_method_mark_unread_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + message_id="1343993", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_raw_response_mark_unread(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_streaming_response_mark_unread(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.mark_unread( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_mark_unread(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.mark_unread( + chat_id="", + ) + + @parametrize + async def test_method_notify_anyway(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_raw_response_notify_anyway(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + @parametrize + async def test_streaming_response_notify_anyway(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.notify_anyway( + "!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(Chat, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_notify_anyway(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.chats.with_raw_response.notify_anyway( + "", + ) + + @parametrize + async def test_method_search(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.search() + assert_matches_type(AsyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + async def test_method_search_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + inbox="primary", + include_muted=True, + last_activity_after=parse_datetime("2019-12-27T18:11:19.117Z"), + last_activity_before=parse_datetime("2019-12-27T18:11:19.117Z"), + limit=1, + query="x", + scope="titles", + type="single", + unread_only=True, + ) + assert_matches_type(AsyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + async def test_raw_response_search(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.search() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(AsyncCursorSearch[Chat], chat, path=["response"]) + + @parametrize + async def test_streaming_response_search(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.search() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(AsyncCursorSearch[Chat], chat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_start(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.start( + account_id="accountID", + user={}, + ) + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + async def test_method_start_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + chat = await async_client.chats.start( + account_id="accountID", + user={ + "id": "id", + "email": "email", + "full_name": "fullName", + "phone_number": "phoneNumber", + "username": "username", + }, + allow_invite=True, + message_text="messageText", + ) + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + async def test_raw_response_start(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.chats.with_raw_response.start( + account_id="accountID", + user={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + chat = await response.parse() + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + @parametrize + async def test_streaming_response_start(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.chats.with_streaming_response.start( + account_id="accountID", + user={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + chat = await response.parse() + assert_matches_type(ChatStartResponse, chat, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_client.py b/tests/api_resources/test_client.py new file mode 100644 index 0000000..324cc52 --- /dev/null +++ b/tests/api_resources/test_client.py @@ -0,0 +1,156 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import FocusResponse, SearchResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestClient: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_focus(self, client: BeeperDesktop) -> None: + client_ = client.focus() + assert_matches_type(FocusResponse, client_, path=["response"]) + + @parametrize + def test_method_focus_with_all_params(self, client: BeeperDesktop) -> None: + client_ = client.focus( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + draft_attachment_path="draftAttachmentPath", + draft_text="draftText", + message_id="messageID", + ) + assert_matches_type(FocusResponse, client_, path=["response"]) + + @parametrize + def test_raw_response_focus(self, client: BeeperDesktop) -> None: + response = client.with_raw_response.focus() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + client_ = response.parse() + assert_matches_type(FocusResponse, client_, path=["response"]) + + @parametrize + def test_streaming_response_focus(self, client: BeeperDesktop) -> None: + with client.with_streaming_response.focus() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + client_ = response.parse() + assert_matches_type(FocusResponse, client_, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_search(self, client: BeeperDesktop) -> None: + client_ = client.search( + query="x", + ) + assert_matches_type(SearchResponse, client_, path=["response"]) + + @parametrize + def test_raw_response_search(self, client: BeeperDesktop) -> None: + response = client.with_raw_response.search( + query="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + client_ = response.parse() + assert_matches_type(SearchResponse, client_, path=["response"]) + + @parametrize + def test_streaming_response_search(self, client: BeeperDesktop) -> None: + with client.with_streaming_response.search( + query="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + client_ = response.parse() + assert_matches_type(SearchResponse, client_, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncClient: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_focus(self, async_client: AsyncBeeperDesktop) -> None: + client = await async_client.focus() + assert_matches_type(FocusResponse, client, path=["response"]) + + @parametrize + async def test_method_focus_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + client = await async_client.focus( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + draft_attachment_path="draftAttachmentPath", + draft_text="draftText", + message_id="messageID", + ) + assert_matches_type(FocusResponse, client, path=["response"]) + + @parametrize + async def test_raw_response_focus(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.with_raw_response.focus() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + client = await response.parse() + assert_matches_type(FocusResponse, client, path=["response"]) + + @parametrize + async def test_streaming_response_focus(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.with_streaming_response.focus() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + client = await response.parse() + assert_matches_type(FocusResponse, client, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_search(self, async_client: AsyncBeeperDesktop) -> None: + client = await async_client.search( + query="x", + ) + assert_matches_type(SearchResponse, client, path=["response"]) + + @parametrize + async def test_raw_response_search(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.with_raw_response.search( + query="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + client = await response.parse() + assert_matches_type(SearchResponse, client, path=["response"]) + + @parametrize + async def test_streaming_response_search(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.with_streaming_response.search( + query="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + client = await response.parse() + assert_matches_type(SearchResponse, client, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_info.py b/tests/api_resources/test_info.py new file mode 100644 index 0000000..66d98ed --- /dev/null +++ b/tests/api_resources/test_info.py @@ -0,0 +1,74 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import InfoRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestInfo: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + info = client.info.retrieve() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.info.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + info = response.parse() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.info.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + info = response.parse() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncInfo: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + info = await async_client.info.retrieve() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.info.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + info = await response.parse() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.info.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + info = await response.parse() + assert_matches_type(InfoRetrieveResponse, info, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_messages.py b/tests/api_resources/test_messages.py new file mode 100644 index 0000000..1d301b2 --- /dev/null +++ b/tests/api_resources/test_messages.py @@ -0,0 +1,644 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from tests.utils import assert_matches_type +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api.types import ( + MessageSendResponse, + MessageUpdateResponse, +) +from beeper_desktop_api._utils import parse_datetime +from beeper_desktop_api.pagination import SyncCursorSearch, AsyncCursorSearch, SyncCursorNoLimit, AsyncCursorNoLimit +from beeper_desktop_api.types.shared import Message + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestMessages: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: BeeperDesktop) -> None: + message = client.messages.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Message, message, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert_matches_type(Message, message, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert_matches_type(Message, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.messages.with_raw_response.retrieve( + message_id="1343993", + chat_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + client.messages.with_raw_response.retrieve( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + @parametrize + def test_method_update(self, client: BeeperDesktop) -> None: + message = client.messages.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + @parametrize + def test_raw_response_update(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + @parametrize + def test_streaming_response_update(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_update(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.messages.with_raw_response.update( + message_id="1343993", + chat_id="", + text="x", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + client.messages.with_raw_response.update( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + + @parametrize + def test_method_list(self, client: BeeperDesktop) -> None: + message = client.messages.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(SyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + def test_method_list_with_all_params(self, client: BeeperDesktop) -> None: + message = client.messages.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + ) + assert_matches_type(SyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert_matches_type(SyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert_matches_type(SyncCursorNoLimit[Message], message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_list(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.messages.with_raw_response.list( + chat_id="", + ) + + @parametrize + def test_method_delete(self, client: BeeperDesktop) -> None: + message = client.messages.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert message is None + + @parametrize + def test_method_delete_with_all_params(self, client: BeeperDesktop) -> None: + message = client.messages.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + for_everyone=True, + ) + assert message is None + + @parametrize + def test_raw_response_delete(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert message is None + + @parametrize + def test_streaming_response_delete(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert message is None + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_delete(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.messages.with_raw_response.delete( + message_id="1343993", + chat_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + client.messages.with_raw_response.delete( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + @parametrize + def test_method_search(self, client: BeeperDesktop) -> None: + message = client.messages.search() + assert_matches_type(SyncCursorSearch[Message], message, path=["response"]) + + @parametrize + def test_method_search_with_all_params(self, client: BeeperDesktop) -> None: + message = client.messages.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + chat_ids=["!NCdzlIaMjZUmvmvyHU:beeper.com", "1231073"], + chat_type="group", + cursor="1725489123456|c29tZUltc2dQYWdl", + date_after=parse_datetime("2025-08-01T00:00:00Z"), + date_before=parse_datetime("2025-08-31T23:59:59Z"), + direction="before", + exclude_low_priority=True, + include_muted=True, + limit=20, + media_types=["any"], + query="dinner", + sender="sender", + ) + assert_matches_type(SyncCursorSearch[Message], message, path=["response"]) + + @parametrize + def test_raw_response_search(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.search() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert_matches_type(SyncCursorSearch[Message], message, path=["response"]) + + @parametrize + def test_streaming_response_search(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.search() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert_matches_type(SyncCursorSearch[Message], message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_send(self, client: BeeperDesktop) -> None: + message = client.messages.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + def test_method_send_with_all_params(self, client: BeeperDesktop) -> None: + message = client.messages.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + attachment={ + "upload_id": "uploadID", + "duration": 0, + "file_name": "fileName", + "mime_type": "mimeType", + "size": { + "height": 0, + "width": 0, + }, + "type": "image", + }, + reply_to_message_id="replyToMessageID", + text="text", + ) + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + def test_raw_response_send(self, client: BeeperDesktop) -> None: + response = client.messages.with_raw_response.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = response.parse() + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + def test_streaming_response_send(self, client: BeeperDesktop) -> None: + with client.messages.with_streaming_response.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = response.parse() + assert_matches_type(MessageSendResponse, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_send(self, client: BeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + client.messages.with_raw_response.send( + chat_id="", + ) + + +class TestAsyncMessages: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(Message, message, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert_matches_type(Message, message, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.retrieve( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert_matches_type(Message, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.messages.with_raw_response.retrieve( + message_id="1343993", + chat_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + await async_client.messages.with_raw_response.retrieve( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + @parametrize + async def test_method_update(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + @parametrize + async def test_raw_response_update(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + @parametrize + async def test_streaming_response_update(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.update( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert_matches_type(MessageUpdateResponse, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_update(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.messages.with_raw_response.update( + message_id="1343993", + chat_id="", + text="x", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + await async_client.messages.with_raw_response.update( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + text="x", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(AsyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + async def test_method_list_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + cursor="1725489123456|c29tZUltc2dQYWdl", + direction="before", + ) + assert_matches_type(AsyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert_matches_type(AsyncCursorNoLimit[Message], message, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.list( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert_matches_type(AsyncCursorNoLimit[Message], message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_list(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.messages.with_raw_response.list( + chat_id="", + ) + + @parametrize + async def test_method_delete(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert message is None + + @parametrize + async def test_method_delete_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + for_everyone=True, + ) + assert message is None + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert message is None + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.delete( + message_id="1343993", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert message is None + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_delete(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.messages.with_raw_response.delete( + message_id="1343993", + chat_id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `message_id` but received ''"): + await async_client.messages.with_raw_response.delete( + message_id="", + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + @parametrize + async def test_method_search(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.search() + assert_matches_type(AsyncCursorSearch[Message], message, path=["response"]) + + @parametrize + async def test_method_search_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.search( + account_ids=["matrix", "discordgo", "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc"], + chat_ids=["!NCdzlIaMjZUmvmvyHU:beeper.com", "1231073"], + chat_type="group", + cursor="1725489123456|c29tZUltc2dQYWdl", + date_after=parse_datetime("2025-08-01T00:00:00Z"), + date_before=parse_datetime("2025-08-31T23:59:59Z"), + direction="before", + exclude_low_priority=True, + include_muted=True, + limit=20, + media_types=["any"], + query="dinner", + sender="sender", + ) + assert_matches_type(AsyncCursorSearch[Message], message, path=["response"]) + + @parametrize + async def test_raw_response_search(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.search() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert_matches_type(AsyncCursorSearch[Message], message, path=["response"]) + + @parametrize + async def test_streaming_response_search(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.search() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert_matches_type(AsyncCursorSearch[Message], message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_send(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + async def test_method_send_with_all_params(self, async_client: AsyncBeeperDesktop) -> None: + message = await async_client.messages.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + attachment={ + "upload_id": "uploadID", + "duration": 0, + "file_name": "fileName", + "mime_type": "mimeType", + "size": { + "height": 0, + "width": 0, + }, + "type": "image", + }, + reply_to_message_id="replyToMessageID", + text="text", + ) + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + async def test_raw_response_send(self, async_client: AsyncBeeperDesktop) -> None: + response = await async_client.messages.with_raw_response.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + message = await response.parse() + assert_matches_type(MessageSendResponse, message, path=["response"]) + + @parametrize + async def test_streaming_response_send(self, async_client: AsyncBeeperDesktop) -> None: + async with async_client.messages.with_streaming_response.send( + chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + message = await response.parse() + assert_matches_type(MessageSendResponse, message, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_send(self, async_client: AsyncBeeperDesktop) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `chat_id` but received ''"): + await async_client.messages.with_raw_response.send( + chat_id="", + ) diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..5d1317a --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,84 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +import logging +from typing import TYPE_CHECKING, Iterator, AsyncIterator + +import httpx +import pytest +from pytest_asyncio import is_async_test + +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop, DefaultAioHttpClient +from beeper_desktop_api._utils import is_dict + +if TYPE_CHECKING: + from _pytest.fixtures import FixtureRequest # pyright: ignore[reportPrivateImportUsage] + +pytest.register_assert_rewrite("tests.utils") + +logging.getLogger("beeper_desktop_api").setLevel(logging.DEBUG) + + +# automatically add `pytest.mark.asyncio()` to all of our async tests +# so we don't have to add that boilerplate everywhere +def pytest_collection_modifyitems(items: list[pytest.Function]) -> None: + pytest_asyncio_tests = (item for item in items if is_async_test(item)) + session_scope_marker = pytest.mark.asyncio(loop_scope="session") + for async_test in pytest_asyncio_tests: + async_test.add_marker(session_scope_marker, append=False) + + # We skip tests that use both the aiohttp client and respx_mock as respx_mock + # doesn't support custom transports. + for item in items: + if "async_client" not in item.fixturenames or "respx_mock" not in item.fixturenames: + continue + + if not hasattr(item, "callspec"): + continue + + async_client_param = item.callspec.params.get("async_client") + if is_dict(async_client_param) and async_client_param.get("http_client") == "aiohttp": + item.add_marker(pytest.mark.skip(reason="aiohttp client is not compatible with respx_mock")) + + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + +access_token = "My Access Token" + + +@pytest.fixture(scope="session") +def client(request: FixtureRequest) -> Iterator[BeeperDesktop]: + strict = getattr(request, "param", True) + if not isinstance(strict, bool): + raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}") + + with BeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=strict) as client: + yield client + + +@pytest.fixture(scope="session") +async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncBeeperDesktop]: + param = getattr(request, "param", True) + + # defaults + strict = True + http_client: None | httpx.AsyncClient = None + + if isinstance(param, bool): + strict = param + elif is_dict(param): + strict = param.get("strict", True) + assert isinstance(strict, bool) + + http_client_type = param.get("http_client", "httpx") + if http_client_type == "aiohttp": + http_client = DefaultAioHttpClient() + else: + raise TypeError(f"Unexpected fixture parameter type {type(param)}, expected bool or dict") + + async with AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=strict, http_client=http_client + ) as client: + yield client diff --git a/tests/sample_file.txt b/tests/sample_file.txt new file mode 100644 index 0000000..af5626b --- /dev/null +++ b/tests/sample_file.txt @@ -0,0 +1 @@ +Hello, world! diff --git a/tests/test_client.py b/tests/test_client.py new file mode 100644 index 0000000..d9ab686 --- /dev/null +++ b/tests/test_client.py @@ -0,0 +1,2027 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import gc +import os +import sys +import json +import asyncio +import inspect +import dataclasses +import tracemalloc +from typing import Any, Union, TypeVar, Callable, Iterable, Iterator, Optional, Coroutine, cast +from unittest import mock +from typing_extensions import Literal, AsyncIterator, override + +import httpx +import pytest +from respx import MockRouter +from pydantic import ValidationError + +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop, APIResponseValidationError +from beeper_desktop_api._types import Omit +from beeper_desktop_api._utils import asyncify +from beeper_desktop_api._models import BaseModel, FinalRequestOptions +from beeper_desktop_api._exceptions import ( + APIStatusError, + APITimeoutError, + BeeperDesktopError, + APIResponseValidationError, +) +from beeper_desktop_api._base_client import ( + DEFAULT_TIMEOUT, + HTTPX_DEFAULT_TIMEOUT, + BaseClient, + OtherPlatform, + DefaultHttpxClient, + DefaultAsyncHttpxClient, + get_platform, + make_request_options, +) + +from .utils import update_env + +T = TypeVar("T") +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") +access_token = "My Access Token" + + +def _get_params(client: BaseClient[Any, Any]) -> dict[str, str]: + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + url = httpx.URL(request.url) + return dict(url.params) + + +def _low_retry_timeout(*_args: Any, **_kwargs: Any) -> float: + return 0.1 + + +def mirror_request_content(request: httpx.Request) -> httpx.Response: + return httpx.Response(200, content=request.content) + + +# note: we can't use the httpx.MockTransport class as it consumes the request +# body itself, which means we can't test that the body is read lazily +class MockTransport(httpx.BaseTransport, httpx.AsyncBaseTransport): + def __init__( + self, + handler: Callable[[httpx.Request], httpx.Response] + | Callable[[httpx.Request], Coroutine[Any, Any, httpx.Response]], + ) -> None: + self.handler = handler + + @override + def handle_request( + self, + request: httpx.Request, + ) -> httpx.Response: + assert not inspect.iscoroutinefunction(self.handler), "handler must not be a coroutine function" + assert inspect.isfunction(self.handler), "handler must be a function" + return self.handler(request) + + @override + async def handle_async_request( + self, + request: httpx.Request, + ) -> httpx.Response: + assert inspect.iscoroutinefunction(self.handler), "handler must be a coroutine function" + return await self.handler(request) + + +@dataclasses.dataclass +class Counter: + value: int = 0 + + +def _make_sync_iterator(iterable: Iterable[T], counter: Optional[Counter] = None) -> Iterator[T]: + for item in iterable: + if counter: + counter.value += 1 + yield item + + +async def _make_async_iterator(iterable: Iterable[T], counter: Optional[Counter] = None) -> AsyncIterator[T]: + for item in iterable: + if counter: + counter.value += 1 + yield item + + +def _get_open_connections(client: BeeperDesktop | AsyncBeeperDesktop) -> int: + transport = client._client._transport + assert isinstance(transport, httpx.HTTPTransport) or isinstance(transport, httpx.AsyncHTTPTransport) + + pool = transport._pool + return len(pool._requests) + + +class TestBeeperDesktop: + @pytest.mark.respx(base_url=base_url) + def test_raw_response(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.post("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = client.post("/foo", cast_to=httpx.Response) + assert response.status_code == 200 + assert isinstance(response, httpx.Response) + assert response.json() == {"foo": "bar"} + + @pytest.mark.respx(base_url=base_url) + def test_raw_response_for_binary(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.post("/foo").mock( + return_value=httpx.Response(200, headers={"Content-Type": "application/binary"}, content='{"foo": "bar"}') + ) + + response = client.post("/foo", cast_to=httpx.Response) + assert response.status_code == 200 + assert isinstance(response, httpx.Response) + assert response.json() == {"foo": "bar"} + + def test_copy(self, client: BeeperDesktop) -> None: + copied = client.copy() + assert id(copied) != id(client) + + copied = client.copy(access_token="another My Access Token") + assert copied.access_token == "another My Access Token" + assert client.access_token == "My Access Token" + + def test_copy_default_options(self, client: BeeperDesktop) -> None: + # options that have a default are overridden correctly + copied = client.copy(max_retries=7) + assert copied.max_retries == 7 + assert client.max_retries == 2 + + copied2 = copied.copy(max_retries=6) + assert copied2.max_retries == 6 + assert copied.max_retries == 7 + + # timeout + assert isinstance(client.timeout, httpx.Timeout) + copied = client.copy(timeout=None) + assert copied.timeout is None + assert isinstance(client.timeout, httpx.Timeout) + + def test_copy_default_headers(self) -> None: + client = BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={"X-Foo": "bar"}, + ) + assert client.default_headers["X-Foo"] == "bar" + + # does not override the already given value when not specified + copied = client.copy() + assert copied.default_headers["X-Foo"] == "bar" + + # merges already given headers + copied = client.copy(default_headers={"X-Bar": "stainless"}) + assert copied.default_headers["X-Foo"] == "bar" + assert copied.default_headers["X-Bar"] == "stainless" + + # uses new values for any already given headers + copied = client.copy(default_headers={"X-Foo": "stainless"}) + assert copied.default_headers["X-Foo"] == "stainless" + + # set_default_headers + + # completely overrides already set values + copied = client.copy(set_default_headers={}) + assert copied.default_headers.get("X-Foo") is None + + copied = client.copy(set_default_headers={"X-Bar": "Robert"}) + assert copied.default_headers["X-Bar"] == "Robert" + + with pytest.raises( + ValueError, + match="`default_headers` and `set_default_headers` arguments are mutually exclusive", + ): + client.copy(set_default_headers={}, default_headers={"X-Foo": "Bar"}) + client.close() + + def test_copy_default_query(self) -> None: + client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, default_query={"foo": "bar"} + ) + assert _get_params(client)["foo"] == "bar" + + # does not override the already given value when not specified + copied = client.copy() + assert _get_params(copied)["foo"] == "bar" + + # merges already given params + copied = client.copy(default_query={"bar": "stainless"}) + params = _get_params(copied) + assert params["foo"] == "bar" + assert params["bar"] == "stainless" + + # uses new values for any already given headers + copied = client.copy(default_query={"foo": "stainless"}) + assert _get_params(copied)["foo"] == "stainless" + + # set_default_query + + # completely overrides already set values + copied = client.copy(set_default_query={}) + assert _get_params(copied) == {} + + copied = client.copy(set_default_query={"bar": "Robert"}) + assert _get_params(copied)["bar"] == "Robert" + + with pytest.raises( + ValueError, + # TODO: update + match="`default_query` and `set_default_query` arguments are mutually exclusive", + ): + client.copy(set_default_query={}, default_query={"foo": "Bar"}) + + client.close() + + def test_copy_signature(self, client: BeeperDesktop) -> None: + # ensure the same parameters that can be passed to the client are defined in the `.copy()` method + init_signature = inspect.signature( + # mypy doesn't like that we access the `__init__` property. + client.__init__, # type: ignore[misc] + ) + copy_signature = inspect.signature(client.copy) + exclude_params = {"transport", "proxies", "_strict_response_validation"} + + for name in init_signature.parameters.keys(): + if name in exclude_params: + continue + + copy_param = copy_signature.parameters.get(name) + assert copy_param is not None, f"copy() signature is missing the {name} param" + + @pytest.mark.skipif(sys.version_info >= (3, 10), reason="fails because of a memory leak that started from 3.12") + def test_copy_build_request(self, client: BeeperDesktop) -> None: + options = FinalRequestOptions(method="get", url="/foo") + + def build_request(options: FinalRequestOptions) -> None: + client_copy = client.copy() + client_copy._build_request(options) + + # ensure that the machinery is warmed up before tracing starts. + build_request(options) + gc.collect() + + tracemalloc.start(1000) + + snapshot_before = tracemalloc.take_snapshot() + + ITERATIONS = 10 + for _ in range(ITERATIONS): + build_request(options) + + gc.collect() + snapshot_after = tracemalloc.take_snapshot() + + tracemalloc.stop() + + def add_leak(leaks: list[tracemalloc.StatisticDiff], diff: tracemalloc.StatisticDiff) -> None: + if diff.count == 0: + # Avoid false positives by considering only leaks (i.e. allocations that persist). + return + + if diff.count % ITERATIONS != 0: + # Avoid false positives by considering only leaks that appear per iteration. + return + + for frame in diff.traceback: + if any( + frame.filename.endswith(fragment) + for fragment in [ + # to_raw_response_wrapper leaks through the @functools.wraps() decorator. + # + # removing the decorator fixes the leak for reasons we don't understand. + "beeper_desktop_api/_legacy_response.py", + "beeper_desktop_api/_response.py", + # pydantic.BaseModel.model_dump || pydantic.BaseModel.dict leak memory for some reason. + "beeper_desktop_api/_compat.py", + # Standard library leaks we don't care about. + "/logging/__init__.py", + ] + ): + return + + leaks.append(diff) + + leaks: list[tracemalloc.StatisticDiff] = [] + for diff in snapshot_after.compare_to(snapshot_before, "traceback"): + add_leak(leaks, diff) + if leaks: + for leak in leaks: + print("MEMORY LEAK:", leak) + for frame in leak.traceback: + print(frame) + raise AssertionError() + + def test_request_timeout(self, client: BeeperDesktop) -> None: + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT + + request = client._build_request(FinalRequestOptions(method="get", url="/foo", timeout=httpx.Timeout(100.0))) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(100.0) + + def test_client_timeout_option(self) -> None: + client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, timeout=httpx.Timeout(0) + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(0) + + client.close() + + def test_http_client_timeout_option(self) -> None: + # custom timeout given to the httpx client should be used + with httpx.Client(timeout=None) as http_client: + client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(None) + + client.close() + + # no timeout given to the httpx client should not use the httpx default + with httpx.Client() as http_client: + client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT + + client.close() + + # explicitly passing the default timeout currently results in it being ignored + with httpx.Client(timeout=HTTPX_DEFAULT_TIMEOUT) as http_client: + client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT # our default + + client.close() + + async def test_invalid_http_client(self) -> None: + with pytest.raises(TypeError, match="Invalid `http_client` arg"): + async with httpx.AsyncClient() as http_client: + BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + http_client=cast(Any, http_client), + ) + + def test_default_headers_option(self) -> None: + test_client = BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={"X-Foo": "bar"}, + ) + request = test_client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("x-foo") == "bar" + assert request.headers.get("x-stainless-lang") == "python" + + test_client2 = BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={ + "X-Foo": "stainless", + "X-Stainless-Lang": "my-overriding-header", + }, + ) + request = test_client2._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("x-foo") == "stainless" + assert request.headers.get("x-stainless-lang") == "my-overriding-header" + + test_client.close() + test_client2.close() + + def test_validate_headers(self) -> None: + client = BeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("Authorization") == f"Bearer {access_token}" + + with pytest.raises(BeeperDesktopError): + with update_env(**{"BEEPER_ACCESS_TOKEN": Omit()}): + client2 = BeeperDesktop(base_url=base_url, access_token=None, _strict_response_validation=True) + _ = client2 + + def test_default_query_option(self) -> None: + client = BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_query={"query_param": "bar"}, + ) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + url = httpx.URL(request.url) + assert dict(url.params) == {"query_param": "bar"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/foo", + params={"foo": "baz", "query_param": "overridden"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"foo": "baz", "query_param": "overridden"} + + client.close() + + def test_hardcoded_query_params_in_url(self, client: BeeperDesktop) -> None: + request = client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true")) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/foo?beta=true", + params={"limit": "10", "page": "abc"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/files/a%2Fb?beta=true", + params={"limit": "10"}, + ) + ) + assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10" + + def test_request_extra_json(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + extra_json={"baz": False}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"foo": "bar", "baz": False} + + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + extra_json={"baz": False}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"baz": False} + + # `extra_json` takes priority over `json_data` when keys clash + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar", "baz": True}, + extra_json={"baz": None}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"foo": "bar", "baz": None} + + def test_request_extra_headers(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options(extra_headers={"X-Foo": "Foo"}), + ), + ) + assert request.headers.get("X-Foo") == "Foo" + + # `extra_headers` takes priority over `default_headers` when keys clash + request = client.with_options(default_headers={"X-Bar": "true"})._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + extra_headers={"X-Bar": "false"}, + ), + ), + ) + assert request.headers.get("X-Bar") == "false" + + def test_request_extra_query(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + extra_query={"my_query_param": "Foo"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"my_query_param": "Foo"} + + # if both `query` and `extra_query` are given, they are merged + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + query={"bar": "1"}, + extra_query={"foo": "2"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"bar": "1", "foo": "2"} + + # `extra_query` takes priority over `query` when keys clash + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + query={"foo": "1"}, + extra_query={"foo": "2"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"foo": "2"} + + def test_multipart_repeating_array(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions.construct( + method="post", + url="/foo", + headers={"Content-Type": "multipart/form-data; boundary=6b7ba517decee4a450543ea6ae821c82"}, + json_data={"array": ["foo", "bar"]}, + files=[("foo.txt", b"hello world")], + ) + ) + + assert request.read().split(b"\r\n") == [ + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="array[]"', + b"", + b"foo", + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="array[]"', + b"", + b"bar", + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="foo.txt"; filename="upload"', + b"Content-Type: application/octet-stream", + b"", + b"hello world", + b"--6b7ba517decee4a450543ea6ae821c82--", + b"", + ] + + @pytest.mark.respx(base_url=base_url) + def test_binary_content_upload(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.post("/upload").mock(side_effect=mirror_request_content) + + file_content = b"Hello, this is a test file." + + response = client.post( + "/upload", + content=file_content, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + + def test_binary_content_upload_with_iterator(self) -> None: + file_content = b"Hello, this is a test file." + counter = Counter() + iterator = _make_sync_iterator([file_content], counter=counter) + + def mock_handler(request: httpx.Request) -> httpx.Response: + assert counter.value == 0, "the request body should not have been read" + return httpx.Response(200, content=request.read()) + + with BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.Client(transport=MockTransport(handler=mock_handler)), + ) as client: + response = client.post( + "/upload", + content=iterator, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + assert counter.value == 1 + + @pytest.mark.respx(base_url=base_url) + def test_binary_content_upload_with_body_is_deprecated(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.post("/upload").mock(side_effect=mirror_request_content) + + file_content = b"Hello, this is a test file." + + with pytest.deprecated_call( + match="Passing raw bytes as `body` is deprecated and will be removed in a future version. Please pass raw bytes via the `content` parameter instead." + ): + response = client.post( + "/upload", + body=file_content, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + + @pytest.mark.respx(base_url=base_url) + def test_basic_union_response(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + class Model1(BaseModel): + name: str + + class Model2(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model2) + assert response.foo == "bar" + + @pytest.mark.respx(base_url=base_url) + def test_union_response_different_types(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + """Union of objects with the same field name using a different type""" + + class Model1(BaseModel): + foo: int + + class Model2(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model2) + assert response.foo == "bar" + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": 1})) + + response = client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model1) + assert response.foo == 1 + + @pytest.mark.respx(base_url=base_url) + def test_non_application_json_content_type_for_json_data( + self, respx_mock: MockRouter, client: BeeperDesktop + ) -> None: + """ + Response that sets Content-Type to something other than application/json but returns json data + """ + + class Model(BaseModel): + foo: int + + respx_mock.get("/foo").mock( + return_value=httpx.Response( + 200, + content=json.dumps({"foo": 2}), + headers={"Content-Type": "application/text"}, + ) + ) + + response = client.get("/foo", cast_to=Model) + assert isinstance(response, Model) + assert response.foo == 2 + + def test_base_url_setter(self) -> None: + client = BeeperDesktop( + base_url="https://example.com/from_init", access_token=access_token, _strict_response_validation=True + ) + assert client.base_url == "https://example.com/from_init/" + + client.base_url = "https://example.com/from_setter" # type: ignore[assignment] + + assert client.base_url == "https://example.com/from_setter/" + + client.close() + + def test_base_url_env(self) -> None: + with update_env(BEEPER_BASE_URL="http://localhost:5000/from/env"): + client = BeeperDesktop(access_token=access_token, _strict_response_validation=True) + assert client.base_url == "http://localhost:5000/from/env/" + + @pytest.mark.parametrize( + "client", + [ + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.Client(), + ), + ], + ids=["standard", "custom http client"], + ) + def test_base_url_trailing_slash(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "http://localhost:5000/custom/path/foo" + client.close() + + @pytest.mark.parametrize( + "client", + [ + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.Client(), + ), + ], + ids=["standard", "custom http client"], + ) + def test_base_url_no_trailing_slash(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "http://localhost:5000/custom/path/foo" + client.close() + + @pytest.mark.parametrize( + "client", + [ + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + BeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.Client(), + ), + ], + ids=["standard", "custom http client"], + ) + def test_absolute_request_url(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="https://myapi.com/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "https://myapi.com/foo" + client.close() + + def test_copied_client_does_not_close_http(self) -> None: + test_client = BeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + assert not test_client.is_closed() + + copied = test_client.copy() + assert copied is not test_client + + del copied + + assert not test_client.is_closed() + + def test_client_context_manager(self) -> None: + test_client = BeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + with test_client as c2: + assert c2 is test_client + assert not c2.is_closed() + assert not test_client.is_closed() + assert test_client.is_closed() + + @pytest.mark.respx(base_url=base_url) + def test_client_response_validation_error(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + class Model(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": {"invalid": True}})) + + with pytest.raises(APIResponseValidationError) as exc: + client.get("/foo", cast_to=Model) + + assert isinstance(exc.value.__cause__, ValidationError) + + def test_client_max_retries_validation(self) -> None: + with pytest.raises(TypeError, match=r"max_retries cannot be None"): + BeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + max_retries=cast(Any, None), + ) + + @pytest.mark.respx(base_url=base_url) + def test_received_text_for_expected_json(self, respx_mock: MockRouter) -> None: + class Model(BaseModel): + name: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, text="my-custom-format")) + + strict_client = BeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + + with pytest.raises(APIResponseValidationError): + strict_client.get("/foo", cast_to=Model) + + non_strict_client = BeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=False + ) + + response = non_strict_client.get("/foo", cast_to=Model) + assert isinstance(response, str) # type: ignore[unreachable] + + strict_client.close() + non_strict_client.close() + + @pytest.mark.parametrize( + "remaining_retries,retry_after,timeout", + [ + [3, "20", 20], + [3, "0", 0.5], + [3, "-10", 0.5], + [3, "60", 60], + [3, "61", 0.5], + [3, "Fri, 29 Sep 2023 16:26:57 GMT", 20], + [3, "Fri, 29 Sep 2023 16:26:37 GMT", 0.5], + [3, "Fri, 29 Sep 2023 16:26:27 GMT", 0.5], + [3, "Fri, 29 Sep 2023 16:27:37 GMT", 60], + [3, "Fri, 29 Sep 2023 16:27:38 GMT", 0.5], + [3, "99999999999999999999999999999999999", 0.5], + [3, "Zun, 29 Sep 2023 16:26:27 GMT", 0.5], + [3, "", 0.5], + [2, "", 0.5 * 2.0], + [1, "", 0.5 * 4.0], + [-1100, "", 8], # test large number potentially overflowing + ], + ) + @mock.patch("time.time", mock.MagicMock(return_value=1696004797)) + def test_parse_retry_after_header( + self, remaining_retries: int, retry_after: str, timeout: float, client: BeeperDesktop + ) -> None: + headers = httpx.Headers({"retry-after": retry_after}) + options = FinalRequestOptions(method="get", url="/foo", max_retries=3) + calculated = client._calculate_retry_timeout(remaining_retries, options, headers) + assert calculated == pytest.approx(timeout, 0.5 * 0.875) # pyright: ignore[reportUnknownMemberType] + + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.get("/v1/accounts").mock(side_effect=httpx.TimeoutException("Test timeout error")) + + with pytest.raises(APITimeoutError): + client.accounts.with_streaming_response.list().__enter__() + + assert _get_open_connections(client) == 0 + + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + respx_mock.get("/v1/accounts").mock(return_value=httpx.Response(500)) + + with pytest.raises(APIStatusError): + client.accounts.with_streaming_response.list().__enter__() + assert _get_open_connections(client) == 0 + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + @pytest.mark.parametrize("failure_mode", ["status", "exception"]) + def test_retries_taken( + self, + client: BeeperDesktop, + failures_before_success: int, + failure_mode: Literal["status", "exception"], + respx_mock: MockRouter, + ) -> None: + client = client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + if failure_mode == "exception": + raise RuntimeError("oops") + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = client.accounts.with_raw_response.list() + + assert response.retries_taken == failures_before_success + assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + def test_omit_retry_count_header( + self, client: BeeperDesktop, failures_before_success: int, respx_mock: MockRouter + ) -> None: + client = client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = client.accounts.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()}) + + assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0 + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + def test_overwrite_retry_count_header( + self, client: BeeperDesktop, failures_before_success: int, respx_mock: MockRouter + ) -> None: + client = client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = client.accounts.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"}) + + assert response.http_request.headers.get("x-stainless-retry-count") == "42" + + def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None: + # Test that the proxy environment variables are set correctly + monkeypatch.setenv("HTTPS_PROXY", "https://example.org") + # Delete in case our environment has any proxy env vars set + monkeypatch.delenv("HTTP_PROXY", raising=False) + monkeypatch.delenv("ALL_PROXY", raising=False) + monkeypatch.delenv("NO_PROXY", raising=False) + monkeypatch.delenv("http_proxy", raising=False) + monkeypatch.delenv("https_proxy", raising=False) + monkeypatch.delenv("all_proxy", raising=False) + monkeypatch.delenv("no_proxy", raising=False) + + client = DefaultHttpxClient() + + mounts = tuple(client._mounts.items()) + assert len(mounts) == 1 + assert mounts[0][0].pattern == "https://" + + @pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning") + def test_default_client_creation(self) -> None: + # Ensure that the client can be initialized without any exceptions + DefaultHttpxClient( + verify=True, + cert=None, + trust_env=True, + http1=True, + http2=False, + limits=httpx.Limits(max_connections=100, max_keepalive_connections=20), + ) + + @pytest.mark.respx(base_url=base_url) + def test_follow_redirects(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + # Test that the default follow_redirects=True allows following redirects + respx_mock.post("/redirect").mock( + return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"}) + ) + respx_mock.get("/redirected").mock(return_value=httpx.Response(200, json={"status": "ok"})) + + response = client.post("/redirect", body={"key": "value"}, cast_to=httpx.Response) + assert response.status_code == 200 + assert response.json() == {"status": "ok"} + + @pytest.mark.respx(base_url=base_url) + def test_follow_redirects_disabled(self, respx_mock: MockRouter, client: BeeperDesktop) -> None: + # Test that follow_redirects=False prevents following redirects + respx_mock.post("/redirect").mock( + return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"}) + ) + + with pytest.raises(APIStatusError) as exc_info: + client.post("/redirect", body={"key": "value"}, options={"follow_redirects": False}, cast_to=httpx.Response) + + assert exc_info.value.response.status_code == 302 + assert exc_info.value.response.headers["Location"] == f"{base_url}/redirected" + + +class TestAsyncBeeperDesktop: + @pytest.mark.respx(base_url=base_url) + async def test_raw_response(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + respx_mock.post("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = await async_client.post("/foo", cast_to=httpx.Response) + assert response.status_code == 200 + assert isinstance(response, httpx.Response) + assert response.json() == {"foo": "bar"} + + @pytest.mark.respx(base_url=base_url) + async def test_raw_response_for_binary(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + respx_mock.post("/foo").mock( + return_value=httpx.Response(200, headers={"Content-Type": "application/binary"}, content='{"foo": "bar"}') + ) + + response = await async_client.post("/foo", cast_to=httpx.Response) + assert response.status_code == 200 + assert isinstance(response, httpx.Response) + assert response.json() == {"foo": "bar"} + + def test_copy(self, async_client: AsyncBeeperDesktop) -> None: + copied = async_client.copy() + assert id(copied) != id(async_client) + + copied = async_client.copy(access_token="another My Access Token") + assert copied.access_token == "another My Access Token" + assert async_client.access_token == "My Access Token" + + def test_copy_default_options(self, async_client: AsyncBeeperDesktop) -> None: + # options that have a default are overridden correctly + copied = async_client.copy(max_retries=7) + assert copied.max_retries == 7 + assert async_client.max_retries == 2 + + copied2 = copied.copy(max_retries=6) + assert copied2.max_retries == 6 + assert copied.max_retries == 7 + + # timeout + assert isinstance(async_client.timeout, httpx.Timeout) + copied = async_client.copy(timeout=None) + assert copied.timeout is None + assert isinstance(async_client.timeout, httpx.Timeout) + + async def test_copy_default_headers(self) -> None: + client = AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={"X-Foo": "bar"}, + ) + assert client.default_headers["X-Foo"] == "bar" + + # does not override the already given value when not specified + copied = client.copy() + assert copied.default_headers["X-Foo"] == "bar" + + # merges already given headers + copied = client.copy(default_headers={"X-Bar": "stainless"}) + assert copied.default_headers["X-Foo"] == "bar" + assert copied.default_headers["X-Bar"] == "stainless" + + # uses new values for any already given headers + copied = client.copy(default_headers={"X-Foo": "stainless"}) + assert copied.default_headers["X-Foo"] == "stainless" + + # set_default_headers + + # completely overrides already set values + copied = client.copy(set_default_headers={}) + assert copied.default_headers.get("X-Foo") is None + + copied = client.copy(set_default_headers={"X-Bar": "Robert"}) + assert copied.default_headers["X-Bar"] == "Robert" + + with pytest.raises( + ValueError, + match="`default_headers` and `set_default_headers` arguments are mutually exclusive", + ): + client.copy(set_default_headers={}, default_headers={"X-Foo": "Bar"}) + await client.close() + + async def test_copy_default_query(self) -> None: + client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, default_query={"foo": "bar"} + ) + assert _get_params(client)["foo"] == "bar" + + # does not override the already given value when not specified + copied = client.copy() + assert _get_params(copied)["foo"] == "bar" + + # merges already given params + copied = client.copy(default_query={"bar": "stainless"}) + params = _get_params(copied) + assert params["foo"] == "bar" + assert params["bar"] == "stainless" + + # uses new values for any already given headers + copied = client.copy(default_query={"foo": "stainless"}) + assert _get_params(copied)["foo"] == "stainless" + + # set_default_query + + # completely overrides already set values + copied = client.copy(set_default_query={}) + assert _get_params(copied) == {} + + copied = client.copy(set_default_query={"bar": "Robert"}) + assert _get_params(copied)["bar"] == "Robert" + + with pytest.raises( + ValueError, + # TODO: update + match="`default_query` and `set_default_query` arguments are mutually exclusive", + ): + client.copy(set_default_query={}, default_query={"foo": "Bar"}) + + await client.close() + + def test_copy_signature(self, async_client: AsyncBeeperDesktop) -> None: + # ensure the same parameters that can be passed to the client are defined in the `.copy()` method + init_signature = inspect.signature( + # mypy doesn't like that we access the `__init__` property. + async_client.__init__, # type: ignore[misc] + ) + copy_signature = inspect.signature(async_client.copy) + exclude_params = {"transport", "proxies", "_strict_response_validation"} + + for name in init_signature.parameters.keys(): + if name in exclude_params: + continue + + copy_param = copy_signature.parameters.get(name) + assert copy_param is not None, f"copy() signature is missing the {name} param" + + @pytest.mark.skipif(sys.version_info >= (3, 10), reason="fails because of a memory leak that started from 3.12") + def test_copy_build_request(self, async_client: AsyncBeeperDesktop) -> None: + options = FinalRequestOptions(method="get", url="/foo") + + def build_request(options: FinalRequestOptions) -> None: + client_copy = async_client.copy() + client_copy._build_request(options) + + # ensure that the machinery is warmed up before tracing starts. + build_request(options) + gc.collect() + + tracemalloc.start(1000) + + snapshot_before = tracemalloc.take_snapshot() + + ITERATIONS = 10 + for _ in range(ITERATIONS): + build_request(options) + + gc.collect() + snapshot_after = tracemalloc.take_snapshot() + + tracemalloc.stop() + + def add_leak(leaks: list[tracemalloc.StatisticDiff], diff: tracemalloc.StatisticDiff) -> None: + if diff.count == 0: + # Avoid false positives by considering only leaks (i.e. allocations that persist). + return + + if diff.count % ITERATIONS != 0: + # Avoid false positives by considering only leaks that appear per iteration. + return + + for frame in diff.traceback: + if any( + frame.filename.endswith(fragment) + for fragment in [ + # to_raw_response_wrapper leaks through the @functools.wraps() decorator. + # + # removing the decorator fixes the leak for reasons we don't understand. + "beeper_desktop_api/_legacy_response.py", + "beeper_desktop_api/_response.py", + # pydantic.BaseModel.model_dump || pydantic.BaseModel.dict leak memory for some reason. + "beeper_desktop_api/_compat.py", + # Standard library leaks we don't care about. + "/logging/__init__.py", + ] + ): + return + + leaks.append(diff) + + leaks: list[tracemalloc.StatisticDiff] = [] + for diff in snapshot_after.compare_to(snapshot_before, "traceback"): + add_leak(leaks, diff) + if leaks: + for leak in leaks: + print("MEMORY LEAK:", leak) + for frame in leak.traceback: + print(frame) + raise AssertionError() + + async def test_request_timeout(self, async_client: AsyncBeeperDesktop) -> None: + request = async_client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT + + request = async_client._build_request( + FinalRequestOptions(method="get", url="/foo", timeout=httpx.Timeout(100.0)) + ) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(100.0) + + async def test_client_timeout_option(self) -> None: + client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, timeout=httpx.Timeout(0) + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(0) + + await client.close() + + async def test_http_client_timeout_option(self) -> None: + # custom timeout given to the httpx client should be used + async with httpx.AsyncClient(timeout=None) as http_client: + client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == httpx.Timeout(None) + + await client.close() + + # no timeout given to the httpx client should not use the httpx default + async with httpx.AsyncClient() as http_client: + client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT + + await client.close() + + # explicitly passing the default timeout currently results in it being ignored + async with httpx.AsyncClient(timeout=HTTPX_DEFAULT_TIMEOUT) as http_client: + client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True, http_client=http_client + ) + + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore + assert timeout == DEFAULT_TIMEOUT # our default + + await client.close() + + def test_invalid_http_client(self) -> None: + with pytest.raises(TypeError, match="Invalid `http_client` arg"): + with httpx.Client() as http_client: + AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + http_client=cast(Any, http_client), + ) + + async def test_default_headers_option(self) -> None: + test_client = AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={"X-Foo": "bar"}, + ) + request = test_client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("x-foo") == "bar" + assert request.headers.get("x-stainless-lang") == "python" + + test_client2 = AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_headers={ + "X-Foo": "stainless", + "X-Stainless-Lang": "my-overriding-header", + }, + ) + request = test_client2._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("x-foo") == "stainless" + assert request.headers.get("x-stainless-lang") == "my-overriding-header" + + await test_client.close() + await test_client2.close() + + def test_validate_headers(self) -> None: + client = AsyncBeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("Authorization") == f"Bearer {access_token}" + + with pytest.raises(BeeperDesktopError): + with update_env(**{"BEEPER_ACCESS_TOKEN": Omit()}): + client2 = AsyncBeeperDesktop(base_url=base_url, access_token=None, _strict_response_validation=True) + _ = client2 + + async def test_default_query_option(self) -> None: + client = AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + default_query={"query_param": "bar"}, + ) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + url = httpx.URL(request.url) + assert dict(url.params) == {"query_param": "bar"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/foo", + params={"foo": "baz", "query_param": "overridden"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"foo": "baz", "query_param": "overridden"} + + await client.close() + + async def test_hardcoded_query_params_in_url(self, async_client: AsyncBeeperDesktop) -> None: + request = async_client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true")) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true"} + + request = async_client._build_request( + FinalRequestOptions( + method="get", + url="/foo?beta=true", + params={"limit": "10", "page": "abc"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"} + + request = async_client._build_request( + FinalRequestOptions( + method="get", + url="/files/a%2Fb?beta=true", + params={"limit": "10"}, + ) + ) + assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10" + + def test_request_extra_json(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + extra_json={"baz": False}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"foo": "bar", "baz": False} + + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + extra_json={"baz": False}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"baz": False} + + # `extra_json` takes priority over `json_data` when keys clash + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar", "baz": True}, + extra_json={"baz": None}, + ), + ) + data = json.loads(request.content.decode("utf-8")) + assert data == {"foo": "bar", "baz": None} + + def test_request_extra_headers(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options(extra_headers={"X-Foo": "Foo"}), + ), + ) + assert request.headers.get("X-Foo") == "Foo" + + # `extra_headers` takes priority over `default_headers` when keys clash + request = client.with_options(default_headers={"X-Bar": "true"})._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + extra_headers={"X-Bar": "false"}, + ), + ), + ) + assert request.headers.get("X-Bar") == "false" + + def test_request_extra_query(self, client: BeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + extra_query={"my_query_param": "Foo"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"my_query_param": "Foo"} + + # if both `query` and `extra_query` are given, they are merged + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + query={"bar": "1"}, + extra_query={"foo": "2"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"bar": "1", "foo": "2"} + + # `extra_query` takes priority over `query` when keys clash + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + **make_request_options( + query={"foo": "1"}, + extra_query={"foo": "2"}, + ), + ), + ) + params = dict(request.url.params) + assert params == {"foo": "2"} + + def test_multipart_repeating_array(self, async_client: AsyncBeeperDesktop) -> None: + request = async_client._build_request( + FinalRequestOptions.construct( + method="post", + url="/foo", + headers={"Content-Type": "multipart/form-data; boundary=6b7ba517decee4a450543ea6ae821c82"}, + json_data={"array": ["foo", "bar"]}, + files=[("foo.txt", b"hello world")], + ) + ) + + assert request.read().split(b"\r\n") == [ + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="array[]"', + b"", + b"foo", + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="array[]"', + b"", + b"bar", + b"--6b7ba517decee4a450543ea6ae821c82", + b'Content-Disposition: form-data; name="foo.txt"; filename="upload"', + b"Content-Type: application/octet-stream", + b"", + b"hello world", + b"--6b7ba517decee4a450543ea6ae821c82--", + b"", + ] + + @pytest.mark.respx(base_url=base_url) + async def test_binary_content_upload(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + respx_mock.post("/upload").mock(side_effect=mirror_request_content) + + file_content = b"Hello, this is a test file." + + response = await async_client.post( + "/upload", + content=file_content, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + + async def test_binary_content_upload_with_asynciterator(self) -> None: + file_content = b"Hello, this is a test file." + counter = Counter() + iterator = _make_async_iterator([file_content], counter=counter) + + async def mock_handler(request: httpx.Request) -> httpx.Response: + assert counter.value == 0, "the request body should not have been read" + return httpx.Response(200, content=await request.aread()) + + async with AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.AsyncClient(transport=MockTransport(handler=mock_handler)), + ) as client: + response = await client.post( + "/upload", + content=iterator, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + assert counter.value == 1 + + @pytest.mark.respx(base_url=base_url) + async def test_binary_content_upload_with_body_is_deprecated( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + respx_mock.post("/upload").mock(side_effect=mirror_request_content) + + file_content = b"Hello, this is a test file." + + with pytest.deprecated_call( + match="Passing raw bytes as `body` is deprecated and will be removed in a future version. Please pass raw bytes via the `content` parameter instead." + ): + response = await async_client.post( + "/upload", + body=file_content, + cast_to=httpx.Response, + options={"headers": {"Content-Type": "application/octet-stream"}}, + ) + + assert response.status_code == 200 + assert response.request.headers["Content-Type"] == "application/octet-stream" + assert response.content == file_content + + @pytest.mark.respx(base_url=base_url) + async def test_basic_union_response(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + class Model1(BaseModel): + name: str + + class Model2(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = await async_client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model2) + assert response.foo == "bar" + + @pytest.mark.respx(base_url=base_url) + async def test_union_response_different_types( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + """Union of objects with the same field name using a different type""" + + class Model1(BaseModel): + foo: int + + class Model2(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + response = await async_client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model2) + assert response.foo == "bar" + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": 1})) + + response = await async_client.get("/foo", cast_to=cast(Any, Union[Model1, Model2])) + assert isinstance(response, Model1) + assert response.foo == 1 + + @pytest.mark.respx(base_url=base_url) + async def test_non_application_json_content_type_for_json_data( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + """ + Response that sets Content-Type to something other than application/json but returns json data + """ + + class Model(BaseModel): + foo: int + + respx_mock.get("/foo").mock( + return_value=httpx.Response( + 200, + content=json.dumps({"foo": 2}), + headers={"Content-Type": "application/text"}, + ) + ) + + response = await async_client.get("/foo", cast_to=Model) + assert isinstance(response, Model) + assert response.foo == 2 + + async def test_base_url_setter(self) -> None: + client = AsyncBeeperDesktop( + base_url="https://example.com/from_init", access_token=access_token, _strict_response_validation=True + ) + assert client.base_url == "https://example.com/from_init/" + + client.base_url = "https://example.com/from_setter" # type: ignore[assignment] + + assert client.base_url == "https://example.com/from_setter/" + + await client.close() + + async def test_base_url_env(self) -> None: + with update_env(BEEPER_BASE_URL="http://localhost:5000/from/env"): + client = AsyncBeeperDesktop(access_token=access_token, _strict_response_validation=True) + assert client.base_url == "http://localhost:5000/from/env/" + + @pytest.mark.parametrize( + "client", + [ + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.AsyncClient(), + ), + ], + ids=["standard", "custom http client"], + ) + async def test_base_url_trailing_slash(self, client: AsyncBeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "http://localhost:5000/custom/path/foo" + await client.close() + + @pytest.mark.parametrize( + "client", + [ + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.AsyncClient(), + ), + ], + ids=["standard", "custom http client"], + ) + async def test_base_url_no_trailing_slash(self, client: AsyncBeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "http://localhost:5000/custom/path/foo" + await client.close() + + @pytest.mark.parametrize( + "client", + [ + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + ), + AsyncBeeperDesktop( + base_url="http://localhost:5000/custom/path/", + access_token=access_token, + _strict_response_validation=True, + http_client=httpx.AsyncClient(), + ), + ], + ids=["standard", "custom http client"], + ) + async def test_absolute_request_url(self, client: AsyncBeeperDesktop) -> None: + request = client._build_request( + FinalRequestOptions( + method="post", + url="https://myapi.com/foo", + json_data={"foo": "bar"}, + ), + ) + assert request.url == "https://myapi.com/foo" + await client.close() + + async def test_copied_client_does_not_close_http(self) -> None: + test_client = AsyncBeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + assert not test_client.is_closed() + + copied = test_client.copy() + assert copied is not test_client + + del copied + + await asyncio.sleep(0.2) + assert not test_client.is_closed() + + async def test_client_context_manager(self) -> None: + test_client = AsyncBeeperDesktop(base_url=base_url, access_token=access_token, _strict_response_validation=True) + async with test_client as c2: + assert c2 is test_client + assert not c2.is_closed() + assert not test_client.is_closed() + assert test_client.is_closed() + + @pytest.mark.respx(base_url=base_url) + async def test_client_response_validation_error( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + class Model(BaseModel): + foo: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, json={"foo": {"invalid": True}})) + + with pytest.raises(APIResponseValidationError) as exc: + await async_client.get("/foo", cast_to=Model) + + assert isinstance(exc.value.__cause__, ValidationError) + + async def test_client_max_retries_validation(self) -> None: + with pytest.raises(TypeError, match=r"max_retries cannot be None"): + AsyncBeeperDesktop( + base_url=base_url, + access_token=access_token, + _strict_response_validation=True, + max_retries=cast(Any, None), + ) + + @pytest.mark.respx(base_url=base_url) + async def test_received_text_for_expected_json(self, respx_mock: MockRouter) -> None: + class Model(BaseModel): + name: str + + respx_mock.get("/foo").mock(return_value=httpx.Response(200, text="my-custom-format")) + + strict_client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=True + ) + + with pytest.raises(APIResponseValidationError): + await strict_client.get("/foo", cast_to=Model) + + non_strict_client = AsyncBeeperDesktop( + base_url=base_url, access_token=access_token, _strict_response_validation=False + ) + + response = await non_strict_client.get("/foo", cast_to=Model) + assert isinstance(response, str) # type: ignore[unreachable] + + await strict_client.close() + await non_strict_client.close() + + @pytest.mark.parametrize( + "remaining_retries,retry_after,timeout", + [ + [3, "20", 20], + [3, "0", 0.5], + [3, "-10", 0.5], + [3, "60", 60], + [3, "61", 0.5], + [3, "Fri, 29 Sep 2023 16:26:57 GMT", 20], + [3, "Fri, 29 Sep 2023 16:26:37 GMT", 0.5], + [3, "Fri, 29 Sep 2023 16:26:27 GMT", 0.5], + [3, "Fri, 29 Sep 2023 16:27:37 GMT", 60], + [3, "Fri, 29 Sep 2023 16:27:38 GMT", 0.5], + [3, "99999999999999999999999999999999999", 0.5], + [3, "Zun, 29 Sep 2023 16:26:27 GMT", 0.5], + [3, "", 0.5], + [2, "", 0.5 * 2.0], + [1, "", 0.5 * 4.0], + [-1100, "", 8], # test large number potentially overflowing + ], + ) + @mock.patch("time.time", mock.MagicMock(return_value=1696004797)) + async def test_parse_retry_after_header( + self, remaining_retries: int, retry_after: str, timeout: float, async_client: AsyncBeeperDesktop + ) -> None: + headers = httpx.Headers({"retry-after": retry_after}) + options = FinalRequestOptions(method="get", url="/foo", max_retries=3) + calculated = async_client._calculate_retry_timeout(remaining_retries, options, headers) + assert calculated == pytest.approx(timeout, 0.5 * 0.875) # pyright: ignore[reportUnknownMemberType] + + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + async def test_retrying_timeout_errors_doesnt_leak( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + respx_mock.get("/v1/accounts").mock(side_effect=httpx.TimeoutException("Test timeout error")) + + with pytest.raises(APITimeoutError): + await async_client.accounts.with_streaming_response.list().__aenter__() + + assert _get_open_connections(async_client) == 0 + + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + async def test_retrying_status_errors_doesnt_leak( + self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop + ) -> None: + respx_mock.get("/v1/accounts").mock(return_value=httpx.Response(500)) + + with pytest.raises(APIStatusError): + await async_client.accounts.with_streaming_response.list().__aenter__() + assert _get_open_connections(async_client) == 0 + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + @pytest.mark.parametrize("failure_mode", ["status", "exception"]) + async def test_retries_taken( + self, + async_client: AsyncBeeperDesktop, + failures_before_success: int, + failure_mode: Literal["status", "exception"], + respx_mock: MockRouter, + ) -> None: + client = async_client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + if failure_mode == "exception": + raise RuntimeError("oops") + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = await client.accounts.with_raw_response.list() + + assert response.retries_taken == failures_before_success + assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + async def test_omit_retry_count_header( + self, async_client: AsyncBeeperDesktop, failures_before_success: int, respx_mock: MockRouter + ) -> None: + client = async_client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = await client.accounts.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()}) + + assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0 + + @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) + @mock.patch("beeper_desktop_api._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) + @pytest.mark.respx(base_url=base_url) + async def test_overwrite_retry_count_header( + self, async_client: AsyncBeeperDesktop, failures_before_success: int, respx_mock: MockRouter + ) -> None: + client = async_client.with_options(max_retries=4) + + nb_retries = 0 + + def retry_handler(_request: httpx.Request) -> httpx.Response: + nonlocal nb_retries + if nb_retries < failures_before_success: + nb_retries += 1 + return httpx.Response(500) + return httpx.Response(200) + + respx_mock.get("/v1/accounts").mock(side_effect=retry_handler) + + response = await client.accounts.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"}) + + assert response.http_request.headers.get("x-stainless-retry-count") == "42" + + async def test_get_platform(self) -> None: + platform = await asyncify(get_platform)() + assert isinstance(platform, (str, OtherPlatform)) + + async def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None: + # Test that the proxy environment variables are set correctly + monkeypatch.setenv("HTTPS_PROXY", "https://example.org") + # Delete in case our environment has any proxy env vars set + monkeypatch.delenv("HTTP_PROXY", raising=False) + monkeypatch.delenv("ALL_PROXY", raising=False) + monkeypatch.delenv("NO_PROXY", raising=False) + monkeypatch.delenv("http_proxy", raising=False) + monkeypatch.delenv("https_proxy", raising=False) + monkeypatch.delenv("all_proxy", raising=False) + monkeypatch.delenv("no_proxy", raising=False) + + client = DefaultAsyncHttpxClient() + + mounts = tuple(client._mounts.items()) + assert len(mounts) == 1 + assert mounts[0][0].pattern == "https://" + + @pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning") + async def test_default_client_creation(self) -> None: + # Ensure that the client can be initialized without any exceptions + DefaultAsyncHttpxClient( + verify=True, + cert=None, + trust_env=True, + http1=True, + http2=False, + limits=httpx.Limits(max_connections=100, max_keepalive_connections=20), + ) + + @pytest.mark.respx(base_url=base_url) + async def test_follow_redirects(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + # Test that the default follow_redirects=True allows following redirects + respx_mock.post("/redirect").mock( + return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"}) + ) + respx_mock.get("/redirected").mock(return_value=httpx.Response(200, json={"status": "ok"})) + + response = await async_client.post("/redirect", body={"key": "value"}, cast_to=httpx.Response) + assert response.status_code == 200 + assert response.json() == {"status": "ok"} + + @pytest.mark.respx(base_url=base_url) + async def test_follow_redirects_disabled(self, respx_mock: MockRouter, async_client: AsyncBeeperDesktop) -> None: + # Test that follow_redirects=False prevents following redirects + respx_mock.post("/redirect").mock( + return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"}) + ) + + with pytest.raises(APIStatusError) as exc_info: + await async_client.post( + "/redirect", body={"key": "value"}, options={"follow_redirects": False}, cast_to=httpx.Response + ) + + assert exc_info.value.response.status_code == 302 + assert exc_info.value.response.headers["Location"] == f"{base_url}/redirected" diff --git a/tests/test_extract_files.py b/tests/test_extract_files.py new file mode 100644 index 0000000..889c22e --- /dev/null +++ b/tests/test_extract_files.py @@ -0,0 +1,91 @@ +from __future__ import annotations + +from typing import Sequence + +import pytest + +from beeper_desktop_api._types import FileTypes, ArrayFormat +from beeper_desktop_api._utils import extract_files + + +def test_removes_files_from_input() -> None: + query = {"foo": "bar"} + assert extract_files(query, paths=[]) == [] + assert query == {"foo": "bar"} + + query2 = {"foo": b"Bar", "hello": "world"} + assert extract_files(query2, paths=[["foo"]]) == [("foo", b"Bar")] + assert query2 == {"hello": "world"} + + query3 = {"foo": {"foo": {"bar": b"Bar"}}, "hello": "world"} + assert extract_files(query3, paths=[["foo", "foo", "bar"]]) == [("foo[foo][bar]", b"Bar")] + assert query3 == {"foo": {"foo": {}}, "hello": "world"} + + query4 = {"foo": {"bar": b"Bar", "baz": "foo"}, "hello": "world"} + assert extract_files(query4, paths=[["foo", "bar"]]) == [("foo[bar]", b"Bar")] + assert query4 == {"hello": "world", "foo": {"baz": "foo"}} + + +def test_multiple_files() -> None: + query = {"documents": [{"file": b"My first file"}, {"file": b"My second file"}]} + assert extract_files(query, paths=[["documents", "", "file"]]) == [ + ("documents[][file]", b"My first file"), + ("documents[][file]", b"My second file"), + ] + assert query == {"documents": [{}, {}]} + + +def test_top_level_file_array() -> None: + query = {"files": [b"file one", b"file two"], "title": "hello"} + assert extract_files(query, paths=[["files", ""]]) == [("files[]", b"file one"), ("files[]", b"file two")] + assert query == {"title": "hello"} + + +@pytest.mark.parametrize( + "query,paths,expected", + [ + [ + {"foo": {"bar": "baz"}}, + [["foo", "", "bar"]], + [], + ], + [ + {"foo": ["bar", "baz"]}, + [["foo", "bar"]], + [], + ], + [ + {"foo": {"bar": "baz"}}, + [["foo", "foo"]], + [], + ], + ], + ids=["dict expecting array", "array expecting dict", "unknown keys"], +) +def test_ignores_incorrect_paths( + query: dict[str, object], + paths: Sequence[Sequence[str]], + expected: list[tuple[str, FileTypes]], +) -> None: + assert extract_files(query, paths=paths) == expected + + +@pytest.mark.parametrize( + "array_format,expected_top_level,expected_nested", + [ + ("brackets", [("files[]", b"a"), ("files[]", b"b")], [("items[][file]", b"a"), ("items[][file]", b"b")]), + ("repeat", [("files", b"a"), ("files", b"b")], [("items[file]", b"a"), ("items[file]", b"b")]), + ("comma", [("files", b"a"), ("files", b"b")], [("items[file]", b"a"), ("items[file]", b"b")]), + ("indices", [("files[0]", b"a"), ("files[1]", b"b")], [("items[0][file]", b"a"), ("items[1][file]", b"b")]), + ], +) +def test_array_format_controls_file_field_names( + array_format: ArrayFormat, + expected_top_level: list[tuple[str, FileTypes]], + expected_nested: list[tuple[str, FileTypes]], +) -> None: + top_level = {"files": [b"a", b"b"]} + assert extract_files(top_level, paths=[["files", ""]], array_format=array_format) == expected_top_level + + nested = {"items": [{"file": b"a"}, {"file": b"b"}]} + assert extract_files(nested, paths=[["items", "", "file"]], array_format=array_format) == expected_nested diff --git a/tests/test_files.py b/tests/test_files.py new file mode 100644 index 0000000..c7492da --- /dev/null +++ b/tests/test_files.py @@ -0,0 +1,148 @@ +from pathlib import Path + +import anyio +import pytest +from dirty_equals import IsDict, IsList, IsBytes, IsTuple + +from beeper_desktop_api._files import to_httpx_files, deepcopy_with_paths, async_to_httpx_files +from beeper_desktop_api._utils import extract_files + +readme_path = Path(__file__).parent.parent.joinpath("README.md") + + +def test_pathlib_includes_file_name() -> None: + result = to_httpx_files({"file": readme_path}) + print(result) + assert result == IsDict({"file": IsTuple("README.md", IsBytes())}) + + +def test_tuple_input() -> None: + result = to_httpx_files([("file", readme_path)]) + print(result) + assert result == IsList(IsTuple("file", IsTuple("README.md", IsBytes()))) + + +@pytest.mark.asyncio +async def test_async_pathlib_includes_file_name() -> None: + result = await async_to_httpx_files({"file": readme_path}) + print(result) + assert result == IsDict({"file": IsTuple("README.md", IsBytes())}) + + +@pytest.mark.asyncio +async def test_async_supports_anyio_path() -> None: + result = await async_to_httpx_files({"file": anyio.Path(readme_path)}) + print(result) + assert result == IsDict({"file": IsTuple("README.md", IsBytes())}) + + +@pytest.mark.asyncio +async def test_async_tuple_input() -> None: + result = await async_to_httpx_files([("file", readme_path)]) + print(result) + assert result == IsList(IsTuple("file", IsTuple("README.md", IsBytes()))) + + +def test_string_not_allowed() -> None: + with pytest.raises(TypeError, match="Expected file types input to be a FileContent type or to be a tuple"): + to_httpx_files( + { + "file": "foo", # type: ignore + } + ) + + +def assert_different_identities(obj1: object, obj2: object) -> None: + assert obj1 == obj2 + assert obj1 is not obj2 + + +class TestDeepcopyWithPaths: + def test_copies_top_level_dict(self) -> None: + original = {"file": b"data", "other": "value"} + result = deepcopy_with_paths(original, [["file"]]) + assert_different_identities(result, original) + + def test_file_value_is_same_reference(self) -> None: + file_bytes = b"contents" + original = {"file": file_bytes} + result = deepcopy_with_paths(original, [["file"]]) + assert_different_identities(result, original) + assert result["file"] is file_bytes + + def test_list_popped_wholesale(self) -> None: + files = [b"f1", b"f2"] + original = {"files": files, "title": "t"} + result = deepcopy_with_paths(original, [["files", ""]]) + assert_different_identities(result, original) + result_files = result["files"] + assert isinstance(result_files, list) + assert_different_identities(result_files, files) + + def test_nested_array_path_copies_list_and_elements(self) -> None: + elem1 = {"file": b"f1", "extra": 1} + elem2 = {"file": b"f2", "extra": 2} + original = {"items": [elem1, elem2]} + result = deepcopy_with_paths(original, [["items", "", "file"]]) + assert_different_identities(result, original) + result_items = result["items"] + assert isinstance(result_items, list) + assert_different_identities(result_items, original["items"]) + assert_different_identities(result_items[0], elem1) + assert_different_identities(result_items[1], elem2) + + def test_empty_paths_returns_same_object(self) -> None: + original = {"foo": "bar"} + result = deepcopy_with_paths(original, []) + assert result is original + + def test_multiple_paths(self) -> None: + f1 = b"file1" + f2 = b"file2" + original = {"a": f1, "b": f2, "c": "unchanged"} + result = deepcopy_with_paths(original, [["a"], ["b"]]) + assert_different_identities(result, original) + assert result["a"] is f1 + assert result["b"] is f2 + assert result["c"] is original["c"] + + def test_extract_files_does_not_mutate_original_top_level(self) -> None: + file_bytes = b"contents" + original = {"file": file_bytes, "other": "value"} + + copied = deepcopy_with_paths(original, [["file"]]) + extracted = extract_files(copied, paths=[["file"]]) + + assert extracted == [("file", file_bytes)] + assert original == {"file": file_bytes, "other": "value"} + assert copied == {"other": "value"} + + def test_extract_files_does_not_mutate_original_nested_array_path(self) -> None: + file1 = b"f1" + file2 = b"f2" + original = { + "items": [ + {"file": file1, "extra": 1}, + {"file": file2, "extra": 2}, + ], + "title": "example", + } + + copied = deepcopy_with_paths(original, [["items", "", "file"]]) + extracted = extract_files(copied, paths=[["items", "", "file"]]) + + assert [entry for _, entry in extracted] == [file1, file2] + assert original == { + "items": [ + {"file": file1, "extra": 1}, + {"file": file2, "extra": 2}, + ], + "title": "example", + } + assert copied == { + "items": [ + {"extra": 1}, + {"extra": 2}, + ], + "title": "example", + } diff --git a/tests/test_models.py b/tests/test_models.py new file mode 100644 index 0000000..d228ea1 --- /dev/null +++ b/tests/test_models.py @@ -0,0 +1,1017 @@ +import json +from typing import TYPE_CHECKING, Any, Dict, List, Union, Iterable, Optional, cast +from datetime import datetime, timezone +from collections import deque +from typing_extensions import Literal, Annotated, TypedDict, TypeAliasType + +import pytest +import pydantic +from pydantic import Field + +from beeper_desktop_api._utils import PropertyInfo +from beeper_desktop_api._compat import PYDANTIC_V1, parse_obj, model_dump, model_json +from beeper_desktop_api._models import DISCRIMINATOR_CACHE, BaseModel, EagerIterable, construct_type + + +class BasicModel(BaseModel): + foo: str + + +@pytest.mark.parametrize("value", ["hello", 1], ids=["correct type", "mismatched"]) +def test_basic(value: object) -> None: + m = BasicModel.construct(foo=value) + assert m.foo == value + + +def test_directly_nested_model() -> None: + class NestedModel(BaseModel): + nested: BasicModel + + m = NestedModel.construct(nested={"foo": "Foo!"}) + assert m.nested.foo == "Foo!" + + # mismatched types + m = NestedModel.construct(nested="hello!") + assert cast(Any, m.nested) == "hello!" + + +def test_optional_nested_model() -> None: + class NestedModel(BaseModel): + nested: Optional[BasicModel] + + m1 = NestedModel.construct(nested=None) + assert m1.nested is None + + m2 = NestedModel.construct(nested={"foo": "bar"}) + assert m2.nested is not None + assert m2.nested.foo == "bar" + + # mismatched types + m3 = NestedModel.construct(nested={"foo"}) + assert isinstance(cast(Any, m3.nested), set) + assert cast(Any, m3.nested) == {"foo"} + + +def test_list_nested_model() -> None: + class NestedModel(BaseModel): + nested: List[BasicModel] + + m = NestedModel.construct(nested=[{"foo": "bar"}, {"foo": "2"}]) + assert m.nested is not None + assert isinstance(m.nested, list) + assert len(m.nested) == 2 + assert m.nested[0].foo == "bar" + assert m.nested[1].foo == "2" + + # mismatched types + m = NestedModel.construct(nested=True) + assert cast(Any, m.nested) is True + + m = NestedModel.construct(nested=[False]) + assert cast(Any, m.nested) == [False] + + +def test_optional_list_nested_model() -> None: + class NestedModel(BaseModel): + nested: Optional[List[BasicModel]] + + m1 = NestedModel.construct(nested=[{"foo": "bar"}, {"foo": "2"}]) + assert m1.nested is not None + assert isinstance(m1.nested, list) + assert len(m1.nested) == 2 + assert m1.nested[0].foo == "bar" + assert m1.nested[1].foo == "2" + + m2 = NestedModel.construct(nested=None) + assert m2.nested is None + + # mismatched types + m3 = NestedModel.construct(nested={1}) + assert cast(Any, m3.nested) == {1} + + m4 = NestedModel.construct(nested=[False]) + assert cast(Any, m4.nested) == [False] + + +def test_list_optional_items_nested_model() -> None: + class NestedModel(BaseModel): + nested: List[Optional[BasicModel]] + + m = NestedModel.construct(nested=[None, {"foo": "bar"}]) + assert m.nested is not None + assert isinstance(m.nested, list) + assert len(m.nested) == 2 + assert m.nested[0] is None + assert m.nested[1] is not None + assert m.nested[1].foo == "bar" + + # mismatched types + m3 = NestedModel.construct(nested="foo") + assert cast(Any, m3.nested) == "foo" + + m4 = NestedModel.construct(nested=[False]) + assert cast(Any, m4.nested) == [False] + + +def test_list_mismatched_type() -> None: + class NestedModel(BaseModel): + nested: List[str] + + m = NestedModel.construct(nested=False) + assert cast(Any, m.nested) is False + + +def test_raw_dictionary() -> None: + class NestedModel(BaseModel): + nested: Dict[str, str] + + m = NestedModel.construct(nested={"hello": "world"}) + assert m.nested == {"hello": "world"} + + # mismatched types + m = NestedModel.construct(nested=False) + assert cast(Any, m.nested) is False + + +def test_nested_dictionary_model() -> None: + class NestedModel(BaseModel): + nested: Dict[str, BasicModel] + + m = NestedModel.construct(nested={"hello": {"foo": "bar"}}) + assert isinstance(m.nested, dict) + assert m.nested["hello"].foo == "bar" + + # mismatched types + m = NestedModel.construct(nested={"hello": False}) + assert cast(Any, m.nested["hello"]) is False + + +def test_unknown_fields() -> None: + m1 = BasicModel.construct(foo="foo", unknown=1) + assert m1.foo == "foo" + assert cast(Any, m1).unknown == 1 + + m2 = BasicModel.construct(foo="foo", unknown={"foo_bar": True}) + assert m2.foo == "foo" + assert cast(Any, m2).unknown == {"foo_bar": True} + + assert model_dump(m2) == {"foo": "foo", "unknown": {"foo_bar": True}} + + +def test_strict_validation_unknown_fields() -> None: + class Model(BaseModel): + foo: str + + model = parse_obj(Model, dict(foo="hello!", user="Robert")) + assert model.foo == "hello!" + assert cast(Any, model).user == "Robert" + + assert model_dump(model) == {"foo": "hello!", "user": "Robert"} + + +def test_aliases() -> None: + class Model(BaseModel): + my_field: int = Field(alias="myField") + + m = Model.construct(myField=1) + assert m.my_field == 1 + + # mismatched types + m = Model.construct(myField={"hello": False}) + assert cast(Any, m.my_field) == {"hello": False} + + +def test_repr() -> None: + model = BasicModel(foo="bar") + assert str(model) == "BasicModel(foo='bar')" + assert repr(model) == "BasicModel(foo='bar')" + + +def test_repr_nested_model() -> None: + class Child(BaseModel): + name: str + age: int + + class Parent(BaseModel): + name: str + child: Child + + model = Parent(name="Robert", child=Child(name="Foo", age=5)) + assert str(model) == "Parent(name='Robert', child=Child(name='Foo', age=5))" + assert repr(model) == "Parent(name='Robert', child=Child(name='Foo', age=5))" + + +def test_optional_list() -> None: + class Submodel(BaseModel): + name: str + + class Model(BaseModel): + items: Optional[List[Submodel]] + + m = Model.construct(items=None) + assert m.items is None + + m = Model.construct(items=[]) + assert m.items == [] + + m = Model.construct(items=[{"name": "Robert"}]) + assert m.items is not None + assert len(m.items) == 1 + assert m.items[0].name == "Robert" + + +def test_nested_union_of_models() -> None: + class Submodel1(BaseModel): + bar: bool + + class Submodel2(BaseModel): + thing: str + + class Model(BaseModel): + foo: Union[Submodel1, Submodel2] + + m = Model.construct(foo={"thing": "hello"}) + assert isinstance(m.foo, Submodel2) + assert m.foo.thing == "hello" + + +def test_nested_union_of_mixed_types() -> None: + class Submodel1(BaseModel): + bar: bool + + class Model(BaseModel): + foo: Union[Submodel1, Literal[True], Literal["CARD_HOLDER"]] + + m = Model.construct(foo=True) + assert m.foo is True + + m = Model.construct(foo="CARD_HOLDER") + assert m.foo == "CARD_HOLDER" + + m = Model.construct(foo={"bar": False}) + assert isinstance(m.foo, Submodel1) + assert m.foo.bar is False + + +def test_nested_union_multiple_variants() -> None: + class Submodel1(BaseModel): + bar: bool + + class Submodel2(BaseModel): + thing: str + + class Submodel3(BaseModel): + foo: int + + class Model(BaseModel): + foo: Union[Submodel1, Submodel2, None, Submodel3] + + m = Model.construct(foo={"thing": "hello"}) + assert isinstance(m.foo, Submodel2) + assert m.foo.thing == "hello" + + m = Model.construct(foo=None) + assert m.foo is None + + m = Model.construct() + assert m.foo is None + + m = Model.construct(foo={"foo": "1"}) + assert isinstance(m.foo, Submodel3) + assert m.foo.foo == 1 + + +def test_nested_union_invalid_data() -> None: + class Submodel1(BaseModel): + level: int + + class Submodel2(BaseModel): + name: str + + class Model(BaseModel): + foo: Union[Submodel1, Submodel2] + + m = Model.construct(foo=True) + assert cast(bool, m.foo) is True + + m = Model.construct(foo={"name": 3}) + if PYDANTIC_V1: + assert isinstance(m.foo, Submodel2) + assert m.foo.name == "3" + else: + assert isinstance(m.foo, Submodel1) + assert m.foo.name == 3 # type: ignore + + +def test_list_of_unions() -> None: + class Submodel1(BaseModel): + level: int + + class Submodel2(BaseModel): + name: str + + class Model(BaseModel): + items: List[Union[Submodel1, Submodel2]] + + m = Model.construct(items=[{"level": 1}, {"name": "Robert"}]) + assert len(m.items) == 2 + assert isinstance(m.items[0], Submodel1) + assert m.items[0].level == 1 + assert isinstance(m.items[1], Submodel2) + assert m.items[1].name == "Robert" + + m = Model.construct(items=[{"level": -1}, 156]) + assert len(m.items) == 2 + assert isinstance(m.items[0], Submodel1) + assert m.items[0].level == -1 + assert cast(Any, m.items[1]) == 156 + + +def test_union_of_lists() -> None: + class SubModel1(BaseModel): + level: int + + class SubModel2(BaseModel): + name: str + + class Model(BaseModel): + items: Union[List[SubModel1], List[SubModel2]] + + # with one valid entry + m = Model.construct(items=[{"name": "Robert"}]) + assert len(m.items) == 1 + assert isinstance(m.items[0], SubModel2) + assert m.items[0].name == "Robert" + + # with two entries pointing to different types + m = Model.construct(items=[{"level": 1}, {"name": "Robert"}]) + assert len(m.items) == 2 + assert isinstance(m.items[0], SubModel1) + assert m.items[0].level == 1 + assert isinstance(m.items[1], SubModel1) + assert cast(Any, m.items[1]).name == "Robert" + + # with two entries pointing to *completely* different types + m = Model.construct(items=[{"level": -1}, 156]) + assert len(m.items) == 2 + assert isinstance(m.items[0], SubModel1) + assert m.items[0].level == -1 + assert cast(Any, m.items[1]) == 156 + + +def test_dict_of_union() -> None: + class SubModel1(BaseModel): + name: str + + class SubModel2(BaseModel): + foo: str + + class Model(BaseModel): + data: Dict[str, Union[SubModel1, SubModel2]] + + m = Model.construct(data={"hello": {"name": "there"}, "foo": {"foo": "bar"}}) + assert len(list(m.data.keys())) == 2 + assert isinstance(m.data["hello"], SubModel1) + assert m.data["hello"].name == "there" + assert isinstance(m.data["foo"], SubModel2) + assert m.data["foo"].foo == "bar" + + # TODO: test mismatched type + + +def test_double_nested_union() -> None: + class SubModel1(BaseModel): + name: str + + class SubModel2(BaseModel): + bar: str + + class Model(BaseModel): + data: Dict[str, List[Union[SubModel1, SubModel2]]] + + m = Model.construct(data={"foo": [{"bar": "baz"}, {"name": "Robert"}]}) + assert len(m.data["foo"]) == 2 + + entry1 = m.data["foo"][0] + assert isinstance(entry1, SubModel2) + assert entry1.bar == "baz" + + entry2 = m.data["foo"][1] + assert isinstance(entry2, SubModel1) + assert entry2.name == "Robert" + + # TODO: test mismatched type + + +def test_union_of_dict() -> None: + class SubModel1(BaseModel): + name: str + + class SubModel2(BaseModel): + foo: str + + class Model(BaseModel): + data: Union[Dict[str, SubModel1], Dict[str, SubModel2]] + + m = Model.construct(data={"hello": {"name": "there"}, "foo": {"foo": "bar"}}) + assert len(list(m.data.keys())) == 2 + assert isinstance(m.data["hello"], SubModel1) + assert m.data["hello"].name == "there" + assert isinstance(m.data["foo"], SubModel1) + assert cast(Any, m.data["foo"]).foo == "bar" + + +def test_iso8601_datetime() -> None: + class Model(BaseModel): + created_at: datetime + + expected = datetime(2019, 12, 27, 18, 11, 19, 117000, tzinfo=timezone.utc) + + if PYDANTIC_V1: + expected_json = '{"created_at": "2019-12-27T18:11:19.117000+00:00"}' + else: + expected_json = '{"created_at":"2019-12-27T18:11:19.117000Z"}' + + model = Model.construct(created_at="2019-12-27T18:11:19.117Z") + assert model.created_at == expected + assert model_json(model) == expected_json + + model = parse_obj(Model, dict(created_at="2019-12-27T18:11:19.117Z")) + assert model.created_at == expected + assert model_json(model) == expected_json + + +def test_does_not_coerce_int() -> None: + class Model(BaseModel): + bar: int + + assert Model.construct(bar=1).bar == 1 + assert Model.construct(bar=10.9).bar == 10.9 + assert Model.construct(bar="19").bar == "19" # type: ignore[comparison-overlap] + assert Model.construct(bar=False).bar is False + + +def test_int_to_float_safe_conversion() -> None: + class Model(BaseModel): + float_field: float + + m = Model.construct(float_field=10) + assert m.float_field == 10.0 + assert isinstance(m.float_field, float) + + m = Model.construct(float_field=10.12) + assert m.float_field == 10.12 + assert isinstance(m.float_field, float) + + # number too big + m = Model.construct(float_field=2**53 + 1) + assert m.float_field == 2**53 + 1 + assert isinstance(m.float_field, int) + + +def test_deprecated_alias() -> None: + class Model(BaseModel): + resource_id: str = Field(alias="model_id") + + @property + def model_id(self) -> str: + return self.resource_id + + m = Model.construct(model_id="id") + assert m.model_id == "id" + assert m.resource_id == "id" + assert m.resource_id is m.model_id + + m = parse_obj(Model, {"model_id": "id"}) + assert m.model_id == "id" + assert m.resource_id == "id" + assert m.resource_id is m.model_id + + +def test_omitted_fields() -> None: + class Model(BaseModel): + resource_id: Optional[str] = None + + m = Model.construct() + assert m.resource_id is None + assert "resource_id" not in m.model_fields_set + + m = Model.construct(resource_id=None) + assert m.resource_id is None + assert "resource_id" in m.model_fields_set + + m = Model.construct(resource_id="foo") + assert m.resource_id == "foo" + assert "resource_id" in m.model_fields_set + + +def test_to_dict() -> None: + class Model(BaseModel): + foo: Optional[str] = Field(alias="FOO", default=None) + + m = Model(FOO="hello") + assert m.to_dict() == {"FOO": "hello"} + assert m.to_dict(use_api_names=False) == {"foo": "hello"} + + m2 = Model() + assert m2.to_dict() == {} + assert m2.to_dict(exclude_unset=False) == {"FOO": None} + assert m2.to_dict(exclude_unset=False, exclude_none=True) == {} + assert m2.to_dict(exclude_unset=False, exclude_defaults=True) == {} + + m3 = Model(FOO=None) + assert m3.to_dict() == {"FOO": None} + assert m3.to_dict(exclude_none=True) == {} + assert m3.to_dict(exclude_defaults=True) == {} + + class Model2(BaseModel): + created_at: datetime + + time_str = "2024-03-21T11:39:01.275859" + m4 = Model2.construct(created_at=time_str) + assert m4.to_dict(mode="python") == {"created_at": datetime.fromisoformat(time_str)} + assert m4.to_dict(mode="json") == {"created_at": time_str} + + if PYDANTIC_V1: + with pytest.raises(ValueError, match="warnings is only supported in Pydantic v2"): + m.to_dict(warnings=False) + + +def test_forwards_compat_model_dump_method() -> None: + class Model(BaseModel): + foo: Optional[str] = Field(alias="FOO", default=None) + + m = Model(FOO="hello") + assert m.model_dump() == {"foo": "hello"} + assert m.model_dump(include={"bar"}) == {} + assert m.model_dump(exclude={"foo"}) == {} + assert m.model_dump(by_alias=True) == {"FOO": "hello"} + + m2 = Model() + assert m2.model_dump() == {"foo": None} + assert m2.model_dump(exclude_unset=True) == {} + assert m2.model_dump(exclude_none=True) == {} + assert m2.model_dump(exclude_defaults=True) == {} + + m3 = Model(FOO=None) + assert m3.model_dump() == {"foo": None} + assert m3.model_dump(exclude_none=True) == {} + + if PYDANTIC_V1: + with pytest.raises(ValueError, match="round_trip is only supported in Pydantic v2"): + m.model_dump(round_trip=True) + + with pytest.raises(ValueError, match="warnings is only supported in Pydantic v2"): + m.model_dump(warnings=False) + + +def test_compat_method_no_error_for_warnings() -> None: + class Model(BaseModel): + foo: Optional[str] + + m = Model(foo="hello") + assert isinstance(model_dump(m, warnings=False), dict) + + +def test_to_json() -> None: + class Model(BaseModel): + foo: Optional[str] = Field(alias="FOO", default=None) + + m = Model(FOO="hello") + assert json.loads(m.to_json()) == {"FOO": "hello"} + assert json.loads(m.to_json(use_api_names=False)) == {"foo": "hello"} + + if PYDANTIC_V1: + assert m.to_json(indent=None) == '{"FOO": "hello"}' + else: + assert m.to_json(indent=None) == '{"FOO":"hello"}' + + m2 = Model() + assert json.loads(m2.to_json()) == {} + assert json.loads(m2.to_json(exclude_unset=False)) == {"FOO": None} + assert json.loads(m2.to_json(exclude_unset=False, exclude_none=True)) == {} + assert json.loads(m2.to_json(exclude_unset=False, exclude_defaults=True)) == {} + + m3 = Model(FOO=None) + assert json.loads(m3.to_json()) == {"FOO": None} + assert json.loads(m3.to_json(exclude_none=True)) == {} + + if PYDANTIC_V1: + with pytest.raises(ValueError, match="warnings is only supported in Pydantic v2"): + m.to_json(warnings=False) + + +def test_forwards_compat_model_dump_json_method() -> None: + class Model(BaseModel): + foo: Optional[str] = Field(alias="FOO", default=None) + + m = Model(FOO="hello") + assert json.loads(m.model_dump_json()) == {"foo": "hello"} + assert json.loads(m.model_dump_json(include={"bar"})) == {} + assert json.loads(m.model_dump_json(include={"foo"})) == {"foo": "hello"} + assert json.loads(m.model_dump_json(by_alias=True)) == {"FOO": "hello"} + + assert m.model_dump_json(indent=2) == '{\n "foo": "hello"\n}' + + m2 = Model() + assert json.loads(m2.model_dump_json()) == {"foo": None} + assert json.loads(m2.model_dump_json(exclude_unset=True)) == {} + assert json.loads(m2.model_dump_json(exclude_none=True)) == {} + assert json.loads(m2.model_dump_json(exclude_defaults=True)) == {} + + m3 = Model(FOO=None) + assert json.loads(m3.model_dump_json()) == {"foo": None} + assert json.loads(m3.model_dump_json(exclude_none=True)) == {} + + if PYDANTIC_V1: + with pytest.raises(ValueError, match="round_trip is only supported in Pydantic v2"): + m.model_dump_json(round_trip=True) + + with pytest.raises(ValueError, match="warnings is only supported in Pydantic v2"): + m.model_dump_json(warnings=False) + + +def test_type_compat() -> None: + # our model type can be assigned to Pydantic's model type + + def takes_pydantic(model: pydantic.BaseModel) -> None: # noqa: ARG001 + ... + + class OurModel(BaseModel): + foo: Optional[str] = None + + takes_pydantic(OurModel()) + + +def test_annotated_types() -> None: + class Model(BaseModel): + value: str + + m = construct_type( + value={"value": "foo"}, + type_=cast(Any, Annotated[Model, "random metadata"]), + ) + assert isinstance(m, Model) + assert m.value == "foo" + + +def test_discriminated_unions_invalid_data() -> None: + class A(BaseModel): + type: Literal["a"] + + data: str + + class B(BaseModel): + type: Literal["b"] + + data: int + + m = construct_type( + value={"type": "b", "data": "foo"}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="type")]), + ) + assert isinstance(m, B) + assert m.type == "b" + assert m.data == "foo" # type: ignore[comparison-overlap] + + m = construct_type( + value={"type": "a", "data": 100}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="type")]), + ) + assert isinstance(m, A) + assert m.type == "a" + if PYDANTIC_V1: + # pydantic v1 automatically converts inputs to strings + # if the expected type is a str + assert m.data == "100" + else: + assert m.data == 100 # type: ignore[comparison-overlap] + + +def test_discriminated_unions_unknown_variant() -> None: + class A(BaseModel): + type: Literal["a"] + + data: str + + class B(BaseModel): + type: Literal["b"] + + data: int + + m = construct_type( + value={"type": "c", "data": None, "new_thing": "bar"}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="type")]), + ) + + # just chooses the first variant + assert isinstance(m, A) + assert m.type == "c" # type: ignore[comparison-overlap] + assert m.data == None # type: ignore[unreachable] + assert m.new_thing == "bar" + + +def test_discriminated_unions_invalid_data_nested_unions() -> None: + class A(BaseModel): + type: Literal["a"] + + data: str + + class B(BaseModel): + type: Literal["b"] + + data: int + + class C(BaseModel): + type: Literal["c"] + + data: bool + + m = construct_type( + value={"type": "b", "data": "foo"}, + type_=cast(Any, Annotated[Union[Union[A, B], C], PropertyInfo(discriminator="type")]), + ) + assert isinstance(m, B) + assert m.type == "b" + assert m.data == "foo" # type: ignore[comparison-overlap] + + m = construct_type( + value={"type": "c", "data": "foo"}, + type_=cast(Any, Annotated[Union[Union[A, B], C], PropertyInfo(discriminator="type")]), + ) + assert isinstance(m, C) + assert m.type == "c" + assert m.data == "foo" # type: ignore[comparison-overlap] + + +def test_discriminated_unions_with_aliases_invalid_data() -> None: + class A(BaseModel): + foo_type: Literal["a"] = Field(alias="type") + + data: str + + class B(BaseModel): + foo_type: Literal["b"] = Field(alias="type") + + data: int + + m = construct_type( + value={"type": "b", "data": "foo"}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="foo_type")]), + ) + assert isinstance(m, B) + assert m.foo_type == "b" + assert m.data == "foo" # type: ignore[comparison-overlap] + + m = construct_type( + value={"type": "a", "data": 100}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="foo_type")]), + ) + assert isinstance(m, A) + assert m.foo_type == "a" + if PYDANTIC_V1: + # pydantic v1 automatically converts inputs to strings + # if the expected type is a str + assert m.data == "100" + else: + assert m.data == 100 # type: ignore[comparison-overlap] + + +def test_discriminated_unions_overlapping_discriminators_invalid_data() -> None: + class A(BaseModel): + type: Literal["a"] + + data: bool + + class B(BaseModel): + type: Literal["a"] + + data: int + + m = construct_type( + value={"type": "a", "data": "foo"}, + type_=cast(Any, Annotated[Union[A, B], PropertyInfo(discriminator="type")]), + ) + assert isinstance(m, B) + assert m.type == "a" + assert m.data == "foo" # type: ignore[comparison-overlap] + + +def test_discriminated_unions_invalid_data_uses_cache() -> None: + class A(BaseModel): + type: Literal["a"] + + data: str + + class B(BaseModel): + type: Literal["b"] + + data: int + + UnionType = cast(Any, Union[A, B]) + + assert not DISCRIMINATOR_CACHE.get(UnionType) + + m = construct_type( + value={"type": "b", "data": "foo"}, type_=cast(Any, Annotated[UnionType, PropertyInfo(discriminator="type")]) + ) + assert isinstance(m, B) + assert m.type == "b" + assert m.data == "foo" # type: ignore[comparison-overlap] + + discriminator = DISCRIMINATOR_CACHE.get(UnionType) + assert discriminator is not None + + m = construct_type( + value={"type": "b", "data": "foo"}, type_=cast(Any, Annotated[UnionType, PropertyInfo(discriminator="type")]) + ) + assert isinstance(m, B) + assert m.type == "b" + assert m.data == "foo" # type: ignore[comparison-overlap] + + # if the discriminator details object stays the same between invocations then + # we hit the cache + assert DISCRIMINATOR_CACHE.get(UnionType) is discriminator + + +@pytest.mark.skipif(PYDANTIC_V1, reason="TypeAliasType is not supported in Pydantic v1") +def test_type_alias_type() -> None: + Alias = TypeAliasType("Alias", str) # pyright: ignore + + class Model(BaseModel): + alias: Alias + union: Union[int, Alias] + + m = construct_type(value={"alias": "foo", "union": "bar"}, type_=Model) + assert isinstance(m, Model) + assert isinstance(m.alias, str) + assert m.alias == "foo" + assert isinstance(m.union, str) + assert m.union == "bar" + + +@pytest.mark.skipif(PYDANTIC_V1, reason="TypeAliasType is not supported in Pydantic v1") +def test_field_named_cls() -> None: + class Model(BaseModel): + cls: str + + m = construct_type(value={"cls": "foo"}, type_=Model) + assert isinstance(m, Model) + assert isinstance(m.cls, str) + + +def test_discriminated_union_case() -> None: + class A(BaseModel): + type: Literal["a"] + + data: bool + + class B(BaseModel): + type: Literal["b"] + + data: List[Union[A, object]] + + class ModelA(BaseModel): + type: Literal["modelA"] + + data: int + + class ModelB(BaseModel): + type: Literal["modelB"] + + required: str + + data: Union[A, B] + + # when constructing ModelA | ModelB, value data doesn't match ModelB exactly - missing `required` + m = construct_type( + value={"type": "modelB", "data": {"type": "a", "data": True}}, + type_=cast(Any, Annotated[Union[ModelA, ModelB], PropertyInfo(discriminator="type")]), + ) + + assert isinstance(m, ModelB) + + +def test_nested_discriminated_union() -> None: + class InnerType1(BaseModel): + type: Literal["type_1"] + + class InnerModel(BaseModel): + inner_value: str + + class InnerType2(BaseModel): + type: Literal["type_2"] + some_inner_model: InnerModel + + class Type1(BaseModel): + base_type: Literal["base_type_1"] + value: Annotated[ + Union[ + InnerType1, + InnerType2, + ], + PropertyInfo(discriminator="type"), + ] + + class Type2(BaseModel): + base_type: Literal["base_type_2"] + + T = Annotated[ + Union[ + Type1, + Type2, + ], + PropertyInfo(discriminator="base_type"), + ] + + model = construct_type( + type_=T, + value={ + "base_type": "base_type_1", + "value": { + "type": "type_2", + }, + }, + ) + assert isinstance(model, Type1) + assert isinstance(model.value, InnerType2) + + +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2 for now") +def test_extra_properties() -> None: + class Item(BaseModel): + prop: int + + class Model(BaseModel): + __pydantic_extra__: Dict[str, Item] = Field(init=False) # pyright: ignore[reportIncompatibleVariableOverride] + + other: str + + if TYPE_CHECKING: + + def __getattr__(self, attr: str) -> Item: ... + + model = construct_type( + type_=Model, + value={ + "a": {"prop": 1}, + "other": "foo", + }, + ) + assert isinstance(model, Model) + assert model.a.prop == 1 + assert isinstance(model.a, Item) + assert model.other == "foo" + + +# NOTE: Workaround for Pydantic Iterable behavior. +# Iterable fields are replaced with a ValidatorIterator and may be consumed +# during serialization, which can cause subsequent dumps to return empty data. +# See: https://github.com/pydantic/pydantic/issues/9541 +@pytest.mark.parametrize( + "data, expected_validated", + [ + ([1, 2, 3], [1, 2, 3]), + ((1, 2, 3), (1, 2, 3)), + (set([1, 2, 3]), set([1, 2, 3])), + (iter([1, 2, 3]), [1, 2, 3]), + ([], []), + ((x for x in [1, 2, 3]), [1, 2, 3]), + (map(lambda x: x, [1, 2, 3]), [1, 2, 3]), + (frozenset([1, 2, 3]), frozenset([1, 2, 3])), + (deque([1, 2, 3]), deque([1, 2, 3])), + ], + ids=["list", "tuple", "set", "iterator", "empty", "generator", "map", "frozenset", "deque"], +) +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction(data: Iterable[int], expected_validated: Iterable[int]) -> None: + class TypeWithIterable(TypedDict): + items: EagerIterable[int] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": data}}) + assert m.data["items"] == expected_validated + + # Verify repeated dumps don't lose data (the original bug) + assert m.model_dump()["data"]["items"] == list(expected_validated) + assert m.model_dump()["data"]["items"] == list(expected_validated) + + +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction_str_falls_back_to_list() -> None: + # str is iterable (over chars), but str(list_of_chars) produces the list's repr + # rather than reconstructing a string from items. We special-case str to fall + # back to list instead of attempting reconstruction. + class TypeWithIterable(TypedDict): + items: EagerIterable[str] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": "hello"}}) + + # falls back to list of chars rather than calling str(["h", "e", "l", "l", "o"]) + assert m.data["items"] == ["h", "e", "l", "l", "o"] + assert m.model_dump()["data"]["items"] == ["h", "e", "l", "l", "o"] diff --git a/tests/test_qs.py b/tests/test_qs.py new file mode 100644 index 0000000..8587110 --- /dev/null +++ b/tests/test_qs.py @@ -0,0 +1,78 @@ +from typing import Any, cast +from functools import partial +from urllib.parse import unquote + +import pytest + +from beeper_desktop_api._qs import Querystring, stringify + + +def test_empty() -> None: + assert stringify({}) == "" + assert stringify({"a": {}}) == "" + assert stringify({"a": {"b": {"c": {}}}}) == "" + + +def test_basic() -> None: + assert stringify({"a": 1}) == "a=1" + assert stringify({"a": "b"}) == "a=b" + assert stringify({"a": True}) == "a=true" + assert stringify({"a": False}) == "a=false" + assert stringify({"a": 1.23456}) == "a=1.23456" + assert stringify({"a": None}) == "" + + +@pytest.mark.parametrize("method", ["class", "function"]) +def test_nested_dotted(method: str) -> None: + if method == "class": + serialise = Querystring(nested_format="dots").stringify + else: + serialise = partial(stringify, nested_format="dots") + + assert unquote(serialise({"a": {"b": "c"}})) == "a.b=c" + assert unquote(serialise({"a": {"b": "c", "d": "e", "f": "g"}})) == "a.b=c&a.d=e&a.f=g" + assert unquote(serialise({"a": {"b": {"c": {"d": "e"}}}})) == "a.b.c.d=e" + assert unquote(serialise({"a": {"b": True}})) == "a.b=true" + + +def test_nested_brackets() -> None: + assert unquote(stringify({"a": {"b": "c"}})) == "a[b]=c" + assert unquote(stringify({"a": {"b": "c", "d": "e", "f": "g"}})) == "a[b]=c&a[d]=e&a[f]=g" + assert unquote(stringify({"a": {"b": {"c": {"d": "e"}}}})) == "a[b][c][d]=e" + assert unquote(stringify({"a": {"b": True}})) == "a[b]=true" + + +@pytest.mark.parametrize("method", ["class", "function"]) +def test_array_comma(method: str) -> None: + if method == "class": + serialise = Querystring(array_format="comma").stringify + else: + serialise = partial(stringify, array_format="comma") + + assert unquote(serialise({"in": ["foo", "bar"]})) == "in=foo,bar" + assert unquote(serialise({"a": {"b": [True, False]}})) == "a[b]=true,false" + assert unquote(serialise({"a": {"b": [True, False, None, True]}})) == "a[b]=true,false,true" + + +def test_array_repeat() -> None: + assert unquote(stringify({"in": ["foo", "bar"]})) == "in=foo&in=bar" + assert unquote(stringify({"a": {"b": [True, False]}})) == "a[b]=true&a[b]=false" + assert unquote(stringify({"a": {"b": [True, False, None, True]}})) == "a[b]=true&a[b]=false&a[b]=true" + assert unquote(stringify({"in": ["foo", {"b": {"c": ["d", "e"]}}]})) == "in=foo&in[b][c]=d&in[b][c]=e" + + +@pytest.mark.parametrize("method", ["class", "function"]) +def test_array_brackets(method: str) -> None: + if method == "class": + serialise = Querystring(array_format="brackets").stringify + else: + serialise = partial(stringify, array_format="brackets") + + assert unquote(serialise({"in": ["foo", "bar"]})) == "in[]=foo&in[]=bar" + assert unquote(serialise({"a": {"b": [True, False]}})) == "a[b][]=true&a[b][]=false" + assert unquote(serialise({"a": {"b": [True, False, None, True]}})) == "a[b][]=true&a[b][]=false&a[b][]=true" + + +def test_unknown_array_format() -> None: + with pytest.raises(NotImplementedError, match="Unknown array_format value: foo, choose from comma, repeat"): + stringify({"a": ["foo", "bar"]}, array_format=cast(Any, "foo")) diff --git a/tests/test_required_args.py b/tests/test_required_args.py new file mode 100644 index 0000000..71794c6 --- /dev/null +++ b/tests/test_required_args.py @@ -0,0 +1,111 @@ +from __future__ import annotations + +import pytest + +from beeper_desktop_api._utils import required_args + + +def test_too_many_positional_params() -> None: + @required_args(["a"]) + def foo(a: str | None = None) -> str | None: + return a + + with pytest.raises(TypeError, match=r"foo\(\) takes 1 argument\(s\) but 2 were given"): + foo("a", "b") # type: ignore + + +def test_positional_param() -> None: + @required_args(["a"]) + def foo(a: str | None = None) -> str | None: + return a + + assert foo("a") == "a" + assert foo(None) is None + assert foo(a="b") == "b" + + with pytest.raises(TypeError, match="Missing required argument: 'a'"): + foo() + + +def test_keyword_only_param() -> None: + @required_args(["a"]) + def foo(*, a: str | None = None) -> str | None: + return a + + assert foo(a="a") == "a" + assert foo(a=None) is None + assert foo(a="b") == "b" + + with pytest.raises(TypeError, match="Missing required argument: 'a'"): + foo() + + +def test_multiple_params() -> None: + @required_args(["a", "b", "c"]) + def foo(a: str = "", *, b: str = "", c: str = "") -> str | None: + return f"{a} {b} {c}" + + assert foo(a="a", b="b", c="c") == "a b c" + + error_message = r"Missing required arguments.*" + + with pytest.raises(TypeError, match=error_message): + foo() + + with pytest.raises(TypeError, match=error_message): + foo(a="a") + + with pytest.raises(TypeError, match=error_message): + foo(b="b") + + with pytest.raises(TypeError, match=error_message): + foo(c="c") + + with pytest.raises(TypeError, match=r"Missing required argument: 'a'"): + foo(b="a", c="c") + + with pytest.raises(TypeError, match=r"Missing required argument: 'b'"): + foo("a", c="c") + + +def test_multiple_variants() -> None: + @required_args(["a"], ["b"]) + def foo(*, a: str | None = None, b: str | None = None) -> str | None: + return a if a is not None else b + + assert foo(a="foo") == "foo" + assert foo(b="bar") == "bar" + assert foo(a=None) is None + assert foo(b=None) is None + + # TODO: this error message could probably be improved + with pytest.raises( + TypeError, + match=r"Missing required arguments; Expected either \('a'\) or \('b'\) arguments to be given", + ): + foo() + + +def test_multiple_params_multiple_variants() -> None: + @required_args(["a", "b"], ["c"]) + def foo(*, a: str | None = None, b: str | None = None, c: str | None = None) -> str | None: + if a is not None: + return a + if b is not None: + return b + return c + + error_message = r"Missing required arguments; Expected either \('a' and 'b'\) or \('c'\) arguments to be given" + + with pytest.raises(TypeError, match=error_message): + foo(a="foo") + + with pytest.raises(TypeError, match=error_message): + foo(b="bar") + + with pytest.raises(TypeError, match=error_message): + foo() + + assert foo(a=None, b="bar") == "bar" + assert foo(c=None) is None + assert foo(c="foo") == "foo" diff --git a/tests/test_response.py b/tests/test_response.py new file mode 100644 index 0000000..c68d8cd --- /dev/null +++ b/tests/test_response.py @@ -0,0 +1,277 @@ +import json +from typing import Any, List, Union, cast +from typing_extensions import Annotated + +import httpx +import pytest +import pydantic + +from beeper_desktop_api import BaseModel, BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api._response import ( + APIResponse, + BaseAPIResponse, + AsyncAPIResponse, + BinaryAPIResponse, + AsyncBinaryAPIResponse, + extract_response_type, +) +from beeper_desktop_api._streaming import Stream +from beeper_desktop_api._base_client import FinalRequestOptions + + +class ConcreteBaseAPIResponse(APIResponse[bytes]): ... + + +class ConcreteAPIResponse(APIResponse[List[str]]): ... + + +class ConcreteAsyncAPIResponse(APIResponse[httpx.Response]): ... + + +def test_extract_response_type_direct_classes() -> None: + assert extract_response_type(BaseAPIResponse[str]) == str + assert extract_response_type(APIResponse[str]) == str + assert extract_response_type(AsyncAPIResponse[str]) == str + + +def test_extract_response_type_direct_class_missing_type_arg() -> None: + with pytest.raises( + RuntimeError, + match="Expected type to have a type argument at index 0 but it did not", + ): + extract_response_type(AsyncAPIResponse) + + +def test_extract_response_type_concrete_subclasses() -> None: + assert extract_response_type(ConcreteBaseAPIResponse) == bytes + assert extract_response_type(ConcreteAPIResponse) == List[str] + assert extract_response_type(ConcreteAsyncAPIResponse) == httpx.Response + + +def test_extract_response_type_binary_response() -> None: + assert extract_response_type(BinaryAPIResponse) == bytes + assert extract_response_type(AsyncBinaryAPIResponse) == bytes + + +class PydanticModel(pydantic.BaseModel): ... + + +def test_response_parse_mismatched_basemodel(client: BeeperDesktop) -> None: + response = APIResponse( + raw=httpx.Response(200, content=b"foo"), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + with pytest.raises( + TypeError, + match="Pydantic models must subclass our base model type, e.g. `from beeper_desktop_api import BaseModel`", + ): + response.parse(to=PydanticModel) + + +@pytest.mark.asyncio +async def test_async_response_parse_mismatched_basemodel(async_client: AsyncBeeperDesktop) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=b"foo"), + client=async_client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + with pytest.raises( + TypeError, + match="Pydantic models must subclass our base model type, e.g. `from beeper_desktop_api import BaseModel`", + ): + await response.parse(to=PydanticModel) + + +def test_response_parse_custom_stream(client: BeeperDesktop) -> None: + response = APIResponse( + raw=httpx.Response(200, content=b"foo"), + client=client, + stream=True, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + stream = response.parse(to=Stream[int]) + assert stream._cast_to == int + + +@pytest.mark.asyncio +async def test_async_response_parse_custom_stream(async_client: AsyncBeeperDesktop) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=b"foo"), + client=async_client, + stream=True, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + stream = await response.parse(to=Stream[int]) + assert stream._cast_to == int + + +class CustomModel(BaseModel): + foo: str + bar: int + + +def test_response_parse_custom_model(client: BeeperDesktop) -> None: + response = APIResponse( + raw=httpx.Response(200, content=json.dumps({"foo": "hello!", "bar": 2})), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = response.parse(to=CustomModel) + assert obj.foo == "hello!" + assert obj.bar == 2 + + +@pytest.mark.asyncio +async def test_async_response_parse_custom_model(async_client: AsyncBeeperDesktop) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=json.dumps({"foo": "hello!", "bar": 2})), + client=async_client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = await response.parse(to=CustomModel) + assert obj.foo == "hello!" + assert obj.bar == 2 + + +def test_response_parse_annotated_type(client: BeeperDesktop) -> None: + response = APIResponse( + raw=httpx.Response(200, content=json.dumps({"foo": "hello!", "bar": 2})), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = response.parse( + to=cast("type[CustomModel]", Annotated[CustomModel, "random metadata"]), + ) + assert obj.foo == "hello!" + assert obj.bar == 2 + + +async def test_async_response_parse_annotated_type(async_client: AsyncBeeperDesktop) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=json.dumps({"foo": "hello!", "bar": 2})), + client=async_client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = await response.parse( + to=cast("type[CustomModel]", Annotated[CustomModel, "random metadata"]), + ) + assert obj.foo == "hello!" + assert obj.bar == 2 + + +@pytest.mark.parametrize( + "content, expected", + [ + ("false", False), + ("true", True), + ("False", False), + ("True", True), + ("TrUe", True), + ("FalSe", False), + ], +) +def test_response_parse_bool(client: BeeperDesktop, content: str, expected: bool) -> None: + response = APIResponse( + raw=httpx.Response(200, content=content), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + result = response.parse(to=bool) + assert result is expected + + +@pytest.mark.parametrize( + "content, expected", + [ + ("false", False), + ("true", True), + ("False", False), + ("True", True), + ("TrUe", True), + ("FalSe", False), + ], +) +async def test_async_response_parse_bool(client: AsyncBeeperDesktop, content: str, expected: bool) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=content), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + result = await response.parse(to=bool) + assert result is expected + + +class OtherModel(BaseModel): + a: str + + +@pytest.mark.parametrize("client", [False], indirect=True) # loose validation +def test_response_parse_expect_model_union_non_json_content(client: BeeperDesktop) -> None: + response = APIResponse( + raw=httpx.Response(200, content=b"foo", headers={"Content-Type": "application/text"}), + client=client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = response.parse(to=cast(Any, Union[CustomModel, OtherModel])) + assert isinstance(obj, str) + assert obj == "foo" + + +@pytest.mark.asyncio +@pytest.mark.parametrize("async_client", [False], indirect=True) # loose validation +async def test_async_response_parse_expect_model_union_non_json_content(async_client: AsyncBeeperDesktop) -> None: + response = AsyncAPIResponse( + raw=httpx.Response(200, content=b"foo", headers={"Content-Type": "application/text"}), + client=async_client, + stream=False, + stream_cls=None, + cast_to=str, + options=FinalRequestOptions.construct(method="get", url="/foo"), + ) + + obj = await response.parse(to=cast(Any, Union[CustomModel, OtherModel])) + assert isinstance(obj, str) + assert obj == "foo" diff --git a/tests/test_streaming.py b/tests/test_streaming.py new file mode 100644 index 0000000..892dba3 --- /dev/null +++ b/tests/test_streaming.py @@ -0,0 +1,252 @@ +from __future__ import annotations + +from typing import Iterator, AsyncIterator + +import httpx +import pytest + +from beeper_desktop_api import BeeperDesktop, AsyncBeeperDesktop +from beeper_desktop_api._streaming import Stream, AsyncStream, ServerSentEvent + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_basic(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b"event: completion\n" + yield b'data: {"foo":true}\n' + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "completion" + assert sse.json() == {"foo": True} + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_data_missing_event(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b'data: {"foo":true}\n' + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event is None + assert sse.json() == {"foo": True} + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_event_missing_data(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.data == "" + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_multiple_events(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b"\n" + yield b"event: completion\n" + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.data == "" + + sse = await iter_next(iterator) + assert sse.event == "completion" + assert sse.data == "" + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_multiple_events_with_data(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b'data: {"foo":true}\n' + yield b"\n" + yield b"event: completion\n" + yield b'data: {"bar":false}\n' + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.json() == {"foo": True} + + sse = await iter_next(iterator) + assert sse.event == "completion" + assert sse.json() == {"bar": False} + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_multiple_data_lines_with_empty_line( + sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop +) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b"data: {\n" + yield b'data: "foo":\n' + yield b"data: \n" + yield b"data:\n" + yield b"data: true}\n" + yield b"\n\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.json() == {"foo": True} + assert sse.data == '{\n"foo":\n\n\ntrue}' + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_data_json_escaped_double_new_line( + sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop +) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b'data: {"foo": "my long\\n\\ncontent"}' + yield b"\n\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.json() == {"foo": "my long\n\ncontent"} + + await assert_empty_iter(iterator) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_multiple_data_lines(sync: bool, client: BeeperDesktop, async_client: AsyncBeeperDesktop) -> None: + def body() -> Iterator[bytes]: + yield b"event: ping\n" + yield b"data: {\n" + yield b'data: "foo":\n' + yield b"data: true}\n" + yield b"\n\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event == "ping" + assert sse.json() == {"foo": True} + + await assert_empty_iter(iterator) + + +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_special_new_line_character( + sync: bool, + client: BeeperDesktop, + async_client: AsyncBeeperDesktop, +) -> None: + def body() -> Iterator[bytes]: + yield b'data: {"content":" culpa"}\n' + yield b"\n" + yield b'data: {"content":" \xe2\x80\xa8"}\n' + yield b"\n" + yield b'data: {"content":"foo"}\n' + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event is None + assert sse.json() == {"content": " culpa"} + + sse = await iter_next(iterator) + assert sse.event is None + assert sse.json() == {"content": " 
"} + + sse = await iter_next(iterator) + assert sse.event is None + assert sse.json() == {"content": "foo"} + + await assert_empty_iter(iterator) + + +@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"]) +async def test_multi_byte_character_multiple_chunks( + sync: bool, + client: BeeperDesktop, + async_client: AsyncBeeperDesktop, +) -> None: + def body() -> Iterator[bytes]: + yield b'data: {"content":"' + # bytes taken from the string 'известни' and arbitrarily split + # so that some multi-byte characters span multiple chunks + yield b"\xd0" + yield b"\xb8\xd0\xb7\xd0" + yield b"\xb2\xd0\xb5\xd1\x81\xd1\x82\xd0\xbd\xd0\xb8" + yield b'"}\n' + yield b"\n" + + iterator = make_event_iterator(content=body(), sync=sync, client=client, async_client=async_client) + + sse = await iter_next(iterator) + assert sse.event is None + assert sse.json() == {"content": "известни"} + + +async def to_aiter(iter: Iterator[bytes]) -> AsyncIterator[bytes]: + for chunk in iter: + yield chunk + + +async def iter_next(iter: Iterator[ServerSentEvent] | AsyncIterator[ServerSentEvent]) -> ServerSentEvent: + if isinstance(iter, AsyncIterator): + return await iter.__anext__() + + return next(iter) + + +async def assert_empty_iter(iter: Iterator[ServerSentEvent] | AsyncIterator[ServerSentEvent]) -> None: + with pytest.raises((StopAsyncIteration, RuntimeError)): + await iter_next(iter) + + +def make_event_iterator( + content: Iterator[bytes], + *, + sync: bool, + client: BeeperDesktop, + async_client: AsyncBeeperDesktop, +) -> Iterator[ServerSentEvent] | AsyncIterator[ServerSentEvent]: + if sync: + return Stream(cast_to=object, client=client, response=httpx.Response(200, content=content))._iter_events() + + return AsyncStream( + cast_to=object, client=async_client, response=httpx.Response(200, content=to_aiter(content)) + )._iter_events() diff --git a/tests/test_transform.py b/tests/test_transform.py new file mode 100644 index 0000000..83d1090 --- /dev/null +++ b/tests/test_transform.py @@ -0,0 +1,460 @@ +from __future__ import annotations + +import io +import pathlib +from typing import Any, Dict, List, Union, TypeVar, Iterable, Optional, cast +from datetime import date, datetime +from typing_extensions import Required, Annotated, TypedDict + +import pytest + +from beeper_desktop_api._types import Base64FileInput, omit, not_given +from beeper_desktop_api._utils import ( + PropertyInfo, + transform as _transform, + parse_datetime, + async_transform as _async_transform, +) +from beeper_desktop_api._compat import PYDANTIC_V1 +from beeper_desktop_api._models import BaseModel + +_T = TypeVar("_T") + +SAMPLE_FILE_PATH = pathlib.Path(__file__).parent.joinpath("sample_file.txt") + + +async def transform( + data: _T, + expected_type: object, + use_async: bool, +) -> _T: + if use_async: + return await _async_transform(data, expected_type=expected_type) + + return _transform(data, expected_type=expected_type) + + +parametrize = pytest.mark.parametrize("use_async", [False, True], ids=["sync", "async"]) + + +class Foo1(TypedDict): + foo_bar: Annotated[str, PropertyInfo(alias="fooBar")] + + +@parametrize +@pytest.mark.asyncio +async def test_top_level_alias(use_async: bool) -> None: + assert await transform({"foo_bar": "hello"}, expected_type=Foo1, use_async=use_async) == {"fooBar": "hello"} + + +class Foo2(TypedDict): + bar: Bar2 + + +class Bar2(TypedDict): + this_thing: Annotated[int, PropertyInfo(alias="this__thing")] + baz: Annotated[Baz2, PropertyInfo(alias="Baz")] + + +class Baz2(TypedDict): + my_baz: Annotated[str, PropertyInfo(alias="myBaz")] + + +@parametrize +@pytest.mark.asyncio +async def test_recursive_typeddict(use_async: bool) -> None: + assert await transform({"bar": {"this_thing": 1}}, Foo2, use_async) == {"bar": {"this__thing": 1}} + assert await transform({"bar": {"baz": {"my_baz": "foo"}}}, Foo2, use_async) == {"bar": {"Baz": {"myBaz": "foo"}}} + + +class Foo3(TypedDict): + things: List[Bar3] + + +class Bar3(TypedDict): + my_field: Annotated[str, PropertyInfo(alias="myField")] + + +@parametrize +@pytest.mark.asyncio +async def test_list_of_typeddict(use_async: bool) -> None: + result = await transform({"things": [{"my_field": "foo"}, {"my_field": "foo2"}]}, Foo3, use_async) + assert result == {"things": [{"myField": "foo"}, {"myField": "foo2"}]} + + +class Foo4(TypedDict): + foo: Union[Bar4, Baz4] + + +class Bar4(TypedDict): + foo_bar: Annotated[str, PropertyInfo(alias="fooBar")] + + +class Baz4(TypedDict): + foo_baz: Annotated[str, PropertyInfo(alias="fooBaz")] + + +@parametrize +@pytest.mark.asyncio +async def test_union_of_typeddict(use_async: bool) -> None: + assert await transform({"foo": {"foo_bar": "bar"}}, Foo4, use_async) == {"foo": {"fooBar": "bar"}} + assert await transform({"foo": {"foo_baz": "baz"}}, Foo4, use_async) == {"foo": {"fooBaz": "baz"}} + assert await transform({"foo": {"foo_baz": "baz", "foo_bar": "bar"}}, Foo4, use_async) == { + "foo": {"fooBaz": "baz", "fooBar": "bar"} + } + + +class Foo5(TypedDict): + foo: Annotated[Union[Bar4, List[Baz4]], PropertyInfo(alias="FOO")] + + +class Bar5(TypedDict): + foo_bar: Annotated[str, PropertyInfo(alias="fooBar")] + + +class Baz5(TypedDict): + foo_baz: Annotated[str, PropertyInfo(alias="fooBaz")] + + +@parametrize +@pytest.mark.asyncio +async def test_union_of_list(use_async: bool) -> None: + assert await transform({"foo": {"foo_bar": "bar"}}, Foo5, use_async) == {"FOO": {"fooBar": "bar"}} + assert await transform( + { + "foo": [ + {"foo_baz": "baz"}, + {"foo_baz": "baz"}, + ] + }, + Foo5, + use_async, + ) == {"FOO": [{"fooBaz": "baz"}, {"fooBaz": "baz"}]} + + +class Foo6(TypedDict): + bar: Annotated[str, PropertyInfo(alias="Bar")] + + +@parametrize +@pytest.mark.asyncio +async def test_includes_unknown_keys(use_async: bool) -> None: + assert await transform({"bar": "bar", "baz_": {"FOO": 1}}, Foo6, use_async) == { + "Bar": "bar", + "baz_": {"FOO": 1}, + } + + +class Foo7(TypedDict): + bar: Annotated[List[Bar7], PropertyInfo(alias="bAr")] + foo: Bar7 + + +class Bar7(TypedDict): + foo: str + + +@parametrize +@pytest.mark.asyncio +async def test_ignores_invalid_input(use_async: bool) -> None: + assert await transform({"bar": ""}, Foo7, use_async) == {"bAr": ""} + assert await transform({"foo": ""}, Foo7, use_async) == {"foo": ""} + + +class DatetimeDict(TypedDict, total=False): + foo: Annotated[datetime, PropertyInfo(format="iso8601")] + + bar: Annotated[Optional[datetime], PropertyInfo(format="iso8601")] + + required: Required[Annotated[Optional[datetime], PropertyInfo(format="iso8601")]] + + list_: Required[Annotated[Optional[List[datetime]], PropertyInfo(format="iso8601")]] + + union: Annotated[Union[int, datetime], PropertyInfo(format="iso8601")] + + +class DateDict(TypedDict, total=False): + foo: Annotated[date, PropertyInfo(format="iso8601")] + + +class DatetimeModel(BaseModel): + foo: datetime + + +class DateModel(BaseModel): + foo: Optional[date] + + +@parametrize +@pytest.mark.asyncio +async def test_iso8601_format(use_async: bool) -> None: + dt = datetime.fromisoformat("2023-02-23T14:16:36.337692+00:00") + tz = "+00:00" if PYDANTIC_V1 else "Z" + assert await transform({"foo": dt}, DatetimeDict, use_async) == {"foo": "2023-02-23T14:16:36.337692+00:00"} # type: ignore[comparison-overlap] + assert await transform(DatetimeModel(foo=dt), Any, use_async) == {"foo": "2023-02-23T14:16:36.337692" + tz} # type: ignore[comparison-overlap] + + dt = dt.replace(tzinfo=None) + assert await transform({"foo": dt}, DatetimeDict, use_async) == {"foo": "2023-02-23T14:16:36.337692"} # type: ignore[comparison-overlap] + assert await transform(DatetimeModel(foo=dt), Any, use_async) == {"foo": "2023-02-23T14:16:36.337692"} # type: ignore[comparison-overlap] + + assert await transform({"foo": None}, DateDict, use_async) == {"foo": None} # type: ignore[comparison-overlap] + assert await transform(DateModel(foo=None), Any, use_async) == {"foo": None} # type: ignore + assert await transform({"foo": date.fromisoformat("2023-02-23")}, DateDict, use_async) == {"foo": "2023-02-23"} # type: ignore[comparison-overlap] + assert await transform(DateModel(foo=date.fromisoformat("2023-02-23")), DateDict, use_async) == { + "foo": "2023-02-23" + } # type: ignore[comparison-overlap] + + +@parametrize +@pytest.mark.asyncio +async def test_optional_iso8601_format(use_async: bool) -> None: + dt = datetime.fromisoformat("2023-02-23T14:16:36.337692+00:00") + assert await transform({"bar": dt}, DatetimeDict, use_async) == {"bar": "2023-02-23T14:16:36.337692+00:00"} # type: ignore[comparison-overlap] + + assert await transform({"bar": None}, DatetimeDict, use_async) == {"bar": None} + + +@parametrize +@pytest.mark.asyncio +async def test_required_iso8601_format(use_async: bool) -> None: + dt = datetime.fromisoformat("2023-02-23T14:16:36.337692+00:00") + assert await transform({"required": dt}, DatetimeDict, use_async) == { + "required": "2023-02-23T14:16:36.337692+00:00" + } # type: ignore[comparison-overlap] + + assert await transform({"required": None}, DatetimeDict, use_async) == {"required": None} + + +@parametrize +@pytest.mark.asyncio +async def test_union_datetime(use_async: bool) -> None: + dt = datetime.fromisoformat("2023-02-23T14:16:36.337692+00:00") + assert await transform({"union": dt}, DatetimeDict, use_async) == { # type: ignore[comparison-overlap] + "union": "2023-02-23T14:16:36.337692+00:00" + } + + assert await transform({"union": "foo"}, DatetimeDict, use_async) == {"union": "foo"} + + +@parametrize +@pytest.mark.asyncio +async def test_nested_list_iso6801_format(use_async: bool) -> None: + dt1 = datetime.fromisoformat("2023-02-23T14:16:36.337692+00:00") + dt2 = parse_datetime("2022-01-15T06:34:23Z") + assert await transform({"list_": [dt1, dt2]}, DatetimeDict, use_async) == { # type: ignore[comparison-overlap] + "list_": ["2023-02-23T14:16:36.337692+00:00", "2022-01-15T06:34:23+00:00"] + } + + +@parametrize +@pytest.mark.asyncio +async def test_datetime_custom_format(use_async: bool) -> None: + dt = parse_datetime("2022-01-15T06:34:23Z") + + result = await transform(dt, Annotated[datetime, PropertyInfo(format="custom", format_template="%H")], use_async) + assert result == "06" # type: ignore[comparison-overlap] + + +class DateDictWithRequiredAlias(TypedDict, total=False): + required_prop: Required[Annotated[date, PropertyInfo(format="iso8601", alias="prop")]] + + +@parametrize +@pytest.mark.asyncio +async def test_datetime_with_alias(use_async: bool) -> None: + assert await transform({"required_prop": None}, DateDictWithRequiredAlias, use_async) == {"prop": None} # type: ignore[comparison-overlap] + assert await transform( + {"required_prop": date.fromisoformat("2023-02-23")}, DateDictWithRequiredAlias, use_async + ) == {"prop": "2023-02-23"} # type: ignore[comparison-overlap] + + +class MyModel(BaseModel): + foo: str + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_model_to_dictionary(use_async: bool) -> None: + assert cast(Any, await transform(MyModel(foo="hi!"), Any, use_async)) == {"foo": "hi!"} + assert cast(Any, await transform(MyModel.construct(foo="hi!"), Any, use_async)) == {"foo": "hi!"} + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_empty_model(use_async: bool) -> None: + assert cast(Any, await transform(MyModel.construct(), Any, use_async)) == {} + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_unknown_field(use_async: bool) -> None: + assert cast(Any, await transform(MyModel.construct(my_untyped_field=True), Any, use_async)) == { + "my_untyped_field": True + } + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_mismatched_types(use_async: bool) -> None: + model = MyModel.construct(foo=True) + if PYDANTIC_V1: + params = await transform(model, Any, use_async) + else: + with pytest.warns(UserWarning): + params = await transform(model, Any, use_async) + assert cast(Any, params) == {"foo": True} + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_mismatched_object_type(use_async: bool) -> None: + model = MyModel.construct(foo=MyModel.construct(hello="world")) + if PYDANTIC_V1: + params = await transform(model, Any, use_async) + else: + with pytest.warns(UserWarning): + params = await transform(model, Any, use_async) + assert cast(Any, params) == {"foo": {"hello": "world"}} + + +class ModelNestedObjects(BaseModel): + nested: MyModel + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_nested_objects(use_async: bool) -> None: + model = ModelNestedObjects.construct(nested={"foo": "stainless"}) + assert isinstance(model.nested, MyModel) + assert cast(Any, await transform(model, Any, use_async)) == {"nested": {"foo": "stainless"}} + + +class ModelWithDefaultField(BaseModel): + foo: str + with_none_default: Union[str, None] = None + with_str_default: str = "foo" + + +@parametrize +@pytest.mark.asyncio +async def test_pydantic_default_field(use_async: bool) -> None: + # should be excluded when defaults are used + model = ModelWithDefaultField.construct() + assert model.with_none_default is None + assert model.with_str_default == "foo" + assert cast(Any, await transform(model, Any, use_async)) == {} + + # should be included when the default value is explicitly given + model = ModelWithDefaultField.construct(with_none_default=None, with_str_default="foo") + assert model.with_none_default is None + assert model.with_str_default == "foo" + assert cast(Any, await transform(model, Any, use_async)) == {"with_none_default": None, "with_str_default": "foo"} + + # should be included when a non-default value is explicitly given + model = ModelWithDefaultField.construct(with_none_default="bar", with_str_default="baz") + assert model.with_none_default == "bar" + assert model.with_str_default == "baz" + assert cast(Any, await transform(model, Any, use_async)) == {"with_none_default": "bar", "with_str_default": "baz"} + + +class TypedDictIterableUnion(TypedDict): + foo: Annotated[Union[Bar8, Iterable[Baz8]], PropertyInfo(alias="FOO")] + + +class Bar8(TypedDict): + foo_bar: Annotated[str, PropertyInfo(alias="fooBar")] + + +class Baz8(TypedDict): + foo_baz: Annotated[str, PropertyInfo(alias="fooBaz")] + + +@parametrize +@pytest.mark.asyncio +async def test_iterable_of_dictionaries(use_async: bool) -> None: + assert await transform({"foo": [{"foo_baz": "bar"}]}, TypedDictIterableUnion, use_async) == { + "FOO": [{"fooBaz": "bar"}] + } + assert cast(Any, await transform({"foo": ({"foo_baz": "bar"},)}, TypedDictIterableUnion, use_async)) == { + "FOO": [{"fooBaz": "bar"}] + } + + def my_iter() -> Iterable[Baz8]: + yield {"foo_baz": "hello"} + yield {"foo_baz": "world"} + + assert await transform({"foo": my_iter()}, TypedDictIterableUnion, use_async) == { + "FOO": [{"fooBaz": "hello"}, {"fooBaz": "world"}] + } + + +@parametrize +@pytest.mark.asyncio +async def test_dictionary_items(use_async: bool) -> None: + class DictItems(TypedDict): + foo_baz: Annotated[str, PropertyInfo(alias="fooBaz")] + + assert await transform({"foo": {"foo_baz": "bar"}}, Dict[str, DictItems], use_async) == {"foo": {"fooBaz": "bar"}} + + +class TypedDictIterableUnionStr(TypedDict): + foo: Annotated[Union[str, Iterable[Baz8]], PropertyInfo(alias="FOO")] + + +@parametrize +@pytest.mark.asyncio +async def test_iterable_union_str(use_async: bool) -> None: + assert await transform({"foo": "bar"}, TypedDictIterableUnionStr, use_async) == {"FOO": "bar"} + assert cast(Any, await transform(iter([{"foo_baz": "bar"}]), Union[str, Iterable[Baz8]], use_async)) == [ + {"fooBaz": "bar"} + ] + + +class TypedDictBase64Input(TypedDict): + foo: Annotated[Union[str, Base64FileInput], PropertyInfo(format="base64")] + + +@parametrize +@pytest.mark.asyncio +async def test_base64_file_input(use_async: bool) -> None: + # strings are left as-is + assert await transform({"foo": "bar"}, TypedDictBase64Input, use_async) == {"foo": "bar"} + + # pathlib.Path is automatically converted to base64 + assert await transform({"foo": SAMPLE_FILE_PATH}, TypedDictBase64Input, use_async) == { + "foo": "SGVsbG8sIHdvcmxkIQo=" + } # type: ignore[comparison-overlap] + + # io instances are automatically converted to base64 + assert await transform({"foo": io.StringIO("Hello, world!")}, TypedDictBase64Input, use_async) == { + "foo": "SGVsbG8sIHdvcmxkIQ==" + } # type: ignore[comparison-overlap] + assert await transform({"foo": io.BytesIO(b"Hello, world!")}, TypedDictBase64Input, use_async) == { + "foo": "SGVsbG8sIHdvcmxkIQ==" + } # type: ignore[comparison-overlap] + + +@parametrize +@pytest.mark.asyncio +async def test_transform_skipping(use_async: bool) -> None: + # lists of ints are left as-is + data = [1, 2, 3] + assert await transform(data, List[int], use_async) is data + + # iterables of ints are converted to a list + data = iter([1, 2, 3]) + assert await transform(data, Iterable[int], use_async) == [1, 2, 3] + + +@parametrize +@pytest.mark.asyncio +async def test_strips_notgiven(use_async: bool) -> None: + assert await transform({"foo_bar": "bar"}, Foo1, use_async) == {"fooBar": "bar"} + assert await transform({"foo_bar": not_given}, Foo1, use_async) == {} + + +@parametrize +@pytest.mark.asyncio +async def test_strips_omit(use_async: bool) -> None: + assert await transform({"foo_bar": "bar"}, Foo1, use_async) == {"fooBar": "bar"} + assert await transform({"foo_bar": omit}, Foo1, use_async) == {} diff --git a/tests/test_utils/test_datetime_parse.py b/tests/test_utils/test_datetime_parse.py new file mode 100644 index 0000000..e45c8ff --- /dev/null +++ b/tests/test_utils/test_datetime_parse.py @@ -0,0 +1,110 @@ +""" +Copied from https://github.com/pydantic/pydantic/blob/v1.10.22/tests/test_datetime_parse.py +with modifications so it works without pydantic v1 imports. +""" + +from typing import Type, Union +from datetime import date, datetime, timezone, timedelta + +import pytest + +from beeper_desktop_api._utils import parse_date, parse_datetime + + +def create_tz(minutes: int) -> timezone: + return timezone(timedelta(minutes=minutes)) + + +@pytest.mark.parametrize( + "value,result", + [ + # Valid inputs + ("1494012444.883309", date(2017, 5, 5)), + (b"1494012444.883309", date(2017, 5, 5)), + (1_494_012_444.883_309, date(2017, 5, 5)), + ("1494012444", date(2017, 5, 5)), + (1_494_012_444, date(2017, 5, 5)), + (0, date(1970, 1, 1)), + ("2012-04-23", date(2012, 4, 23)), + (b"2012-04-23", date(2012, 4, 23)), + ("2012-4-9", date(2012, 4, 9)), + (date(2012, 4, 9), date(2012, 4, 9)), + (datetime(2012, 4, 9, 12, 15), date(2012, 4, 9)), + # Invalid inputs + ("x20120423", ValueError), + ("2012-04-56", ValueError), + (19_999_999_999, date(2603, 10, 11)), # just before watershed + (20_000_000_001, date(1970, 8, 20)), # just after watershed + (1_549_316_052, date(2019, 2, 4)), # nowish in s + (1_549_316_052_104, date(2019, 2, 4)), # nowish in ms + (1_549_316_052_104_324, date(2019, 2, 4)), # nowish in μs + (1_549_316_052_104_324_096, date(2019, 2, 4)), # nowish in ns + ("infinity", date(9999, 12, 31)), + ("inf", date(9999, 12, 31)), + (float("inf"), date(9999, 12, 31)), + ("infinity ", date(9999, 12, 31)), + (int("1" + "0" * 100), date(9999, 12, 31)), + (1e1000, date(9999, 12, 31)), + ("-infinity", date(1, 1, 1)), + ("-inf", date(1, 1, 1)), + ("nan", ValueError), + ], +) +def test_date_parsing(value: Union[str, bytes, int, float], result: Union[date, Type[Exception]]) -> None: + if type(result) == type and issubclass(result, Exception): # pyright: ignore[reportUnnecessaryIsInstance] + with pytest.raises(result): + parse_date(value) + else: + assert parse_date(value) == result + + +@pytest.mark.parametrize( + "value,result", + [ + # Valid inputs + # values in seconds + ("1494012444.883309", datetime(2017, 5, 5, 19, 27, 24, 883_309, tzinfo=timezone.utc)), + (1_494_012_444.883_309, datetime(2017, 5, 5, 19, 27, 24, 883_309, tzinfo=timezone.utc)), + ("1494012444", datetime(2017, 5, 5, 19, 27, 24, tzinfo=timezone.utc)), + (b"1494012444", datetime(2017, 5, 5, 19, 27, 24, tzinfo=timezone.utc)), + (1_494_012_444, datetime(2017, 5, 5, 19, 27, 24, tzinfo=timezone.utc)), + # values in ms + ("1494012444000.883309", datetime(2017, 5, 5, 19, 27, 24, 883, tzinfo=timezone.utc)), + ("-1494012444000.883309", datetime(1922, 8, 29, 4, 32, 35, 999117, tzinfo=timezone.utc)), + (1_494_012_444_000, datetime(2017, 5, 5, 19, 27, 24, tzinfo=timezone.utc)), + ("2012-04-23T09:15:00", datetime(2012, 4, 23, 9, 15)), + ("2012-4-9 4:8:16", datetime(2012, 4, 9, 4, 8, 16)), + ("2012-04-23T09:15:00Z", datetime(2012, 4, 23, 9, 15, 0, 0, timezone.utc)), + ("2012-4-9 4:8:16-0320", datetime(2012, 4, 9, 4, 8, 16, 0, create_tz(-200))), + ("2012-04-23T10:20:30.400+02:30", datetime(2012, 4, 23, 10, 20, 30, 400_000, create_tz(150))), + ("2012-04-23T10:20:30.400+02", datetime(2012, 4, 23, 10, 20, 30, 400_000, create_tz(120))), + ("2012-04-23T10:20:30.400-02", datetime(2012, 4, 23, 10, 20, 30, 400_000, create_tz(-120))), + (b"2012-04-23T10:20:30.400-02", datetime(2012, 4, 23, 10, 20, 30, 400_000, create_tz(-120))), + (datetime(2017, 5, 5), datetime(2017, 5, 5)), + (0, datetime(1970, 1, 1, 0, 0, 0, tzinfo=timezone.utc)), + # Invalid inputs + ("x20120423091500", ValueError), + ("2012-04-56T09:15:90", ValueError), + ("2012-04-23T11:05:00-25:00", ValueError), + (19_999_999_999, datetime(2603, 10, 11, 11, 33, 19, tzinfo=timezone.utc)), # just before watershed + (20_000_000_001, datetime(1970, 8, 20, 11, 33, 20, 1000, tzinfo=timezone.utc)), # just after watershed + (1_549_316_052, datetime(2019, 2, 4, 21, 34, 12, 0, tzinfo=timezone.utc)), # nowish in s + (1_549_316_052_104, datetime(2019, 2, 4, 21, 34, 12, 104_000, tzinfo=timezone.utc)), # nowish in ms + (1_549_316_052_104_324, datetime(2019, 2, 4, 21, 34, 12, 104_324, tzinfo=timezone.utc)), # nowish in μs + (1_549_316_052_104_324_096, datetime(2019, 2, 4, 21, 34, 12, 104_324, tzinfo=timezone.utc)), # nowish in ns + ("infinity", datetime(9999, 12, 31, 23, 59, 59, 999999)), + ("inf", datetime(9999, 12, 31, 23, 59, 59, 999999)), + ("inf ", datetime(9999, 12, 31, 23, 59, 59, 999999)), + (1e50, datetime(9999, 12, 31, 23, 59, 59, 999999)), + (float("inf"), datetime(9999, 12, 31, 23, 59, 59, 999999)), + ("-infinity", datetime(1, 1, 1, 0, 0)), + ("-inf", datetime(1, 1, 1, 0, 0)), + ("nan", ValueError), + ], +) +def test_datetime_parsing(value: Union[str, bytes, int, float], result: Union[datetime, Type[Exception]]) -> None: + if type(result) == type and issubclass(result, Exception): # pyright: ignore[reportUnnecessaryIsInstance] + with pytest.raises(result): + parse_datetime(value) + else: + assert parse_datetime(value) == result diff --git a/tests/test_utils/test_json.py b/tests/test_utils/test_json.py new file mode 100644 index 0000000..ef5fab1 --- /dev/null +++ b/tests/test_utils/test_json.py @@ -0,0 +1,126 @@ +from __future__ import annotations + +import datetime +from typing import Union + +import pydantic + +from beeper_desktop_api import _compat +from beeper_desktop_api._utils._json import openapi_dumps + + +class TestOpenapiDumps: + def test_basic(self) -> None: + data = {"key": "value", "number": 42} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"key":"value","number":42}' + + def test_datetime_serialization(self) -> None: + dt = datetime.datetime(2023, 1, 1, 12, 0, 0) + data = {"datetime": dt} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"datetime":"2023-01-01T12:00:00"}' + + def test_pydantic_model_serialization(self) -> None: + class User(pydantic.BaseModel): + first_name: str + last_name: str + age: int + + model_instance = User(first_name="John", last_name="Kramer", age=83) + data = {"model": model_instance} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"first_name":"John","last_name":"Kramer","age":83}}' + + def test_pydantic_model_with_default_values(self) -> None: + class User(pydantic.BaseModel): + name: str + role: str = "user" + active: bool = True + score: int = 0 + + model_instance = User(name="Alice") + data = {"model": model_instance} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"name":"Alice"}}' + + def test_pydantic_model_with_default_values_overridden(self) -> None: + class User(pydantic.BaseModel): + name: str + role: str = "user" + active: bool = True + + model_instance = User(name="Bob", role="admin", active=False) + data = {"model": model_instance} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"name":"Bob","role":"admin","active":false}}' + + def test_pydantic_model_with_alias(self) -> None: + class User(pydantic.BaseModel): + first_name: str = pydantic.Field(alias="firstName") + last_name: str = pydantic.Field(alias="lastName") + + model_instance = User(firstName="John", lastName="Doe") + data = {"model": model_instance} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"firstName":"John","lastName":"Doe"}}' + + def test_pydantic_model_with_alias_and_default(self) -> None: + class User(pydantic.BaseModel): + user_name: str = pydantic.Field(alias="userName") + user_role: str = pydantic.Field(default="member", alias="userRole") + is_active: bool = pydantic.Field(default=True, alias="isActive") + + model_instance = User(userName="charlie") + data = {"model": model_instance} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"userName":"charlie"}}' + + model_with_overrides = User(userName="diana", userRole="admin", isActive=False) + data = {"model": model_with_overrides} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"userName":"diana","userRole":"admin","isActive":false}}' + + def test_pydantic_model_with_nested_models_and_defaults(self) -> None: + class Address(pydantic.BaseModel): + street: str + city: str = "Unknown" + + class User(pydantic.BaseModel): + name: str + address: Address + verified: bool = False + + if _compat.PYDANTIC_V1: + # to handle forward references in Pydantic v1 + User.update_forward_refs(**locals()) # type: ignore[reportDeprecated] + + address = Address(street="123 Main St") + user = User(name="Diana", address=address) + data = {"user": user} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"user":{"name":"Diana","address":{"street":"123 Main St"}}}' + + address_with_city = Address(street="456 Oak Ave", city="Boston") + user_verified = User(name="Eve", address=address_with_city, verified=True) + data = {"user": user_verified} + json_bytes = openapi_dumps(data) + assert ( + json_bytes == b'{"user":{"name":"Eve","address":{"street":"456 Oak Ave","city":"Boston"},"verified":true}}' + ) + + def test_pydantic_model_with_optional_fields(self) -> None: + class User(pydantic.BaseModel): + name: str + email: Union[str, None] + phone: Union[str, None] + + model_with_none = User(name="Eve", email=None, phone=None) + data = {"model": model_with_none} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"name":"Eve","email":null,"phone":null}}' + + model_with_values = User(name="Frank", email="frank@example.com", phone=None) + data = {"model": model_with_values} + json_bytes = openapi_dumps(data) + assert json_bytes == b'{"model":{"name":"Frank","email":"frank@example.com","phone":null}}' diff --git a/tests/test_utils/test_path.py b/tests/test_utils/test_path.py new file mode 100644 index 0000000..d429db8 --- /dev/null +++ b/tests/test_utils/test_path.py @@ -0,0 +1,89 @@ +from __future__ import annotations + +from typing import Any + +import pytest + +from beeper_desktop_api._utils._path import path_template + + +@pytest.mark.parametrize( + "template, kwargs, expected", + [ + ("/v1/{id}", dict(id="abc"), "/v1/abc"), + ("/v1/{a}/{b}", dict(a="x", b="y"), "/v1/x/y"), + ("/v1/{a}{b}/path/{c}?val={d}#{e}", dict(a="x", b="y", c="z", d="u", e="v"), "/v1/xy/path/z?val=u#v"), + ("/{w}/{w}", dict(w="echo"), "/echo/echo"), + ("/v1/static", {}, "/v1/static"), + ("", {}, ""), + ("/v1/?q={n}&count=10", dict(n=42), "/v1/?q=42&count=10"), + ("/v1/{v}", dict(v=None), "/v1/null"), + ("/v1/{v}", dict(v=True), "/v1/true"), + ("/v1/{v}", dict(v=False), "/v1/false"), + ("/v1/{v}", dict(v=".hidden"), "/v1/.hidden"), # dot prefix ok + ("/v1/{v}", dict(v="file.txt"), "/v1/file.txt"), # dot in middle ok + ("/v1/{v}", dict(v="..."), "/v1/..."), # triple dot ok + ("/v1/{a}{b}", dict(a=".", b="txt"), "/v1/.txt"), # dot var combining with adjacent to be ok + ("/items?q={v}#{f}", dict(v=".", f=".."), "/items?q=.#.."), # dots in query/fragment are fine + ( + "/v1/{a}?query={b}", + dict(a="../../other/endpoint", b="a&bad=true"), + "/v1/..%2F..%2Fother%2Fendpoint?query=a%26bad%3Dtrue", + ), + ("/v1/{val}", dict(val="a/b/c"), "/v1/a%2Fb%2Fc"), + ("/v1/{val}", dict(val="a/b/c?query=value"), "/v1/a%2Fb%2Fc%3Fquery=value"), + ("/v1/{val}", dict(val="a/b/c?query=value&bad=true"), "/v1/a%2Fb%2Fc%3Fquery=value&bad=true"), + ("/v1/{val}", dict(val="%20"), "/v1/%2520"), # escapes escape sequences in input + # Query: slash and ? are safe, # is not + ("/items?q={v}", dict(v="a/b"), "/items?q=a/b"), + ("/items?q={v}", dict(v="a?b"), "/items?q=a?b"), + ("/items?q={v}", dict(v="a#b"), "/items?q=a%23b"), + ("/items?q={v}", dict(v="a b"), "/items?q=a%20b"), + # Fragment: slash and ? are safe + ("/docs#{v}", dict(v="a/b"), "/docs#a/b"), + ("/docs#{v}", dict(v="a?b"), "/docs#a?b"), + # Path: slash, ? and # are all encoded + ("/v1/{v}", dict(v="a/b"), "/v1/a%2Fb"), + ("/v1/{v}", dict(v="a?b"), "/v1/a%3Fb"), + ("/v1/{v}", dict(v="a#b"), "/v1/a%23b"), + # same var encoded differently by component + ( + "/v1/{v}?q={v}#{v}", + dict(v="a/b?c#d"), + "/v1/a%2Fb%3Fc%23d?q=a/b?c%23d#a/b?c%23d", + ), + ("/v1/{val}", dict(val="x?admin=true"), "/v1/x%3Fadmin=true"), # query injection + ("/v1/{val}", dict(val="x#admin"), "/v1/x%23admin"), # fragment injection + ], +) +def test_interpolation(template: str, kwargs: dict[str, Any], expected: str) -> None: + assert path_template(template, **kwargs) == expected + + +def test_missing_kwarg_raises_key_error() -> None: + with pytest.raises(KeyError, match="org_id"): + path_template("/v1/{org_id}") + + +@pytest.mark.parametrize( + "template, kwargs", + [ + ("{a}/path", dict(a=".")), + ("{a}/path", dict(a="..")), + ("/v1/{a}", dict(a=".")), + ("/v1/{a}", dict(a="..")), + ("/v1/{a}/path", dict(a=".")), + ("/v1/{a}/path", dict(a="..")), + ("/v1/{a}{b}", dict(a=".", b=".")), # adjacent vars → ".." + ("/v1/{a}.", dict(a=".")), # var + static → ".." + ("/v1/{a}{b}", dict(a="", b=".")), # empty + dot → "." + ("/v1/%2e/{x}", dict(x="ok")), # encoded dot in static text + ("/v1/%2e./{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/.%2E/{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/{v}?q=1", dict(v="..")), + ("/v1/{v}#frag", dict(v="..")), + ], +) +def test_dot_segment_rejected(template: str, kwargs: dict[str, Any]) -> None: + with pytest.raises(ValueError, match="dot-segment"): + path_template(template, **kwargs) diff --git a/tests/test_utils/test_proxy.py b/tests/test_utils/test_proxy.py new file mode 100644 index 0000000..4292729 --- /dev/null +++ b/tests/test_utils/test_proxy.py @@ -0,0 +1,34 @@ +import operator +from typing import Any +from typing_extensions import override + +from beeper_desktop_api._utils import LazyProxy + + +class RecursiveLazyProxy(LazyProxy[Any]): + @override + def __load__(self) -> Any: + return self + + def __call__(self, *_args: Any, **_kwds: Any) -> Any: + raise RuntimeError("This should never be called!") + + +def test_recursive_proxy() -> None: + proxy = RecursiveLazyProxy() + assert repr(proxy) == "RecursiveLazyProxy" + assert str(proxy) == "RecursiveLazyProxy" + assert dir(proxy) == [] + assert type(proxy).__name__ == "RecursiveLazyProxy" + assert type(operator.attrgetter("name.foo.bar.baz")(proxy)).__name__ == "RecursiveLazyProxy" + + +def test_isinstance_does_not_error() -> None: + class AlwaysErrorProxy(LazyProxy[Any]): + @override + def __load__(self) -> Any: + raise RuntimeError("Mocking missing dependency") + + proxy = AlwaysErrorProxy() + assert not isinstance(proxy, dict) + assert isinstance(proxy, LazyProxy) diff --git a/tests/test_utils/test_typing.py b/tests/test_utils/test_typing.py new file mode 100644 index 0000000..1f34442 --- /dev/null +++ b/tests/test_utils/test_typing.py @@ -0,0 +1,73 @@ +from __future__ import annotations + +from typing import Generic, TypeVar, cast + +from beeper_desktop_api._utils import extract_type_var_from_base + +_T = TypeVar("_T") +_T2 = TypeVar("_T2") +_T3 = TypeVar("_T3") + + +class BaseGeneric(Generic[_T]): ... + + +class SubclassGeneric(BaseGeneric[_T]): ... + + +class BaseGenericMultipleTypeArgs(Generic[_T, _T2, _T3]): ... + + +class SubclassGenericMultipleTypeArgs(BaseGenericMultipleTypeArgs[_T, _T2, _T3]): ... + + +class SubclassDifferentOrderGenericMultipleTypeArgs(BaseGenericMultipleTypeArgs[_T2, _T, _T3]): ... + + +def test_extract_type_var() -> None: + assert ( + extract_type_var_from_base( + BaseGeneric[int], + index=0, + generic_bases=cast("tuple[type, ...]", (BaseGeneric,)), + ) + == int + ) + + +def test_extract_type_var_generic_subclass() -> None: + assert ( + extract_type_var_from_base( + SubclassGeneric[int], + index=0, + generic_bases=cast("tuple[type, ...]", (BaseGeneric,)), + ) + == int + ) + + +def test_extract_type_var_multiple() -> None: + typ = BaseGenericMultipleTypeArgs[int, str, None] + + generic_bases = cast("tuple[type, ...]", (BaseGenericMultipleTypeArgs,)) + assert extract_type_var_from_base(typ, index=0, generic_bases=generic_bases) == int + assert extract_type_var_from_base(typ, index=1, generic_bases=generic_bases) == str + assert extract_type_var_from_base(typ, index=2, generic_bases=generic_bases) == type(None) + + +def test_extract_type_var_generic_subclass_multiple() -> None: + typ = SubclassGenericMultipleTypeArgs[int, str, None] + + generic_bases = cast("tuple[type, ...]", (BaseGenericMultipleTypeArgs,)) + assert extract_type_var_from_base(typ, index=0, generic_bases=generic_bases) == int + assert extract_type_var_from_base(typ, index=1, generic_bases=generic_bases) == str + assert extract_type_var_from_base(typ, index=2, generic_bases=generic_bases) == type(None) + + +def test_extract_type_var_generic_subclass_different_ordering_multiple() -> None: + typ = SubclassDifferentOrderGenericMultipleTypeArgs[int, str, None] + + generic_bases = cast("tuple[type, ...]", (BaseGenericMultipleTypeArgs,)) + assert extract_type_var_from_base(typ, index=0, generic_bases=generic_bases) == int + assert extract_type_var_from_base(typ, index=1, generic_bases=generic_bases) == str + assert extract_type_var_from_base(typ, index=2, generic_bases=generic_bases) == type(None) diff --git a/tests/utils.py b/tests/utils.py new file mode 100644 index 0000000..9aaac3c --- /dev/null +++ b/tests/utils.py @@ -0,0 +1,167 @@ +from __future__ import annotations + +import os +import inspect +import traceback +import contextlib +from typing import Any, TypeVar, Iterator, Sequence, cast +from datetime import date, datetime +from typing_extensions import Literal, get_args, get_origin, assert_type + +from beeper_desktop_api._types import Omit, NoneType +from beeper_desktop_api._utils import ( + is_dict, + is_list, + is_list_type, + is_union_type, + extract_type_arg, + is_sequence_type, + is_annotated_type, + is_type_alias_type, +) +from beeper_desktop_api._compat import PYDANTIC_V1, field_outer_type, get_model_fields +from beeper_desktop_api._models import BaseModel + +BaseModelT = TypeVar("BaseModelT", bound=BaseModel) + + +def assert_matches_model(model: type[BaseModelT], value: BaseModelT, *, path: list[str]) -> bool: + for name, field in get_model_fields(model).items(): + field_value = getattr(value, name) + if PYDANTIC_V1: + # in v1 nullability was structured differently + # https://docs.pydantic.dev/2.0/migration/#required-optional-and-nullable-fields + allow_none = getattr(field, "allow_none", False) + else: + allow_none = False + + assert_matches_type( + field_outer_type(field), + field_value, + path=[*path, name], + allow_none=allow_none, + ) + + return True + + +# Note: the `path` argument is only used to improve error messages when `--showlocals` is used +def assert_matches_type( + type_: Any, + value: object, + *, + path: list[str], + allow_none: bool = False, +) -> None: + if is_type_alias_type(type_): + type_ = type_.__value__ + + # unwrap `Annotated[T, ...]` -> `T` + if is_annotated_type(type_): + type_ = extract_type_arg(type_, 0) + + if allow_none and value is None: + return + + if type_ is None or type_ is NoneType: + assert value is None + return + + origin = get_origin(type_) or type_ + + if is_list_type(type_): + return _assert_list_type(type_, value) + + if is_sequence_type(type_): + assert isinstance(value, Sequence) + inner_type = get_args(type_)[0] + for entry in value: # type: ignore + assert_type(inner_type, entry) # type: ignore + return + + if origin == str: + assert isinstance(value, str) + elif origin == int: + assert isinstance(value, int) + elif origin == bool: + assert isinstance(value, bool) + elif origin == float: + assert isinstance(value, float) + elif origin == bytes: + assert isinstance(value, bytes) + elif origin == datetime: + assert isinstance(value, datetime) + elif origin == date: + assert isinstance(value, date) + elif origin == object: + # nothing to do here, the expected type is unknown + pass + elif origin == Literal: + assert value in get_args(type_) + elif origin == dict: + assert is_dict(value) + + args = get_args(type_) + key_type = args[0] + items_type = args[1] + + for key, item in value.items(): + assert_matches_type(key_type, key, path=[*path, ""]) + assert_matches_type(items_type, item, path=[*path, ""]) + elif is_union_type(type_): + variants = get_args(type_) + + try: + none_index = variants.index(type(None)) + except ValueError: + pass + else: + # special case Optional[T] for better error messages + if len(variants) == 2: + if value is None: + # valid + return + + return assert_matches_type(type_=variants[not none_index], value=value, path=path) + + for i, variant in enumerate(variants): + try: + assert_matches_type(variant, value, path=[*path, f"variant {i}"]) + return + except AssertionError: + traceback.print_exc() + continue + + raise AssertionError("Did not match any variants") + elif issubclass(origin, BaseModel): + assert isinstance(value, type_) + assert assert_matches_model(type_, cast(Any, value), path=path) + elif inspect.isclass(origin) and origin.__name__ == "HttpxBinaryResponseContent": + assert value.__class__.__name__ == "HttpxBinaryResponseContent" + else: + assert None, f"Unhandled field type: {type_}" + + +def _assert_list_type(type_: type[object], value: object) -> None: + assert is_list(value) + + inner_type = get_args(type_)[0] + for entry in value: + assert_type(inner_type, entry) # type: ignore + + +@contextlib.contextmanager +def update_env(**new_env: str | Omit) -> Iterator[None]: + old = os.environ.copy() + + try: + for name, value in new_env.items(): + if isinstance(value, Omit): + os.environ.pop(name, None) + else: + os.environ[name] = value + + yield None + finally: + os.environ.clear() + os.environ.update(old)