tello-ai-sdk 0.1.0__tar.gz

tello_ai_sdk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --locked --extra dev
+      - run: uv run pytest -q

tello_ai_sdk-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,59 @@
+name: Publish PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: '3.13'
+      - run: uv sync --locked --extra dev
+      - run: uv run pytest -q
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Sync version from tag
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          printf '__version__ = "%s"\n' "$VERSION" > src/tello/_version.py
+      - run: python -m pip install --upgrade build
+      - run: python -m build
+      - run: python -m pip install --upgrade twine && python -m twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

tello_ai_sdk-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+node_modules/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+examples/.env
+.worktrees/

tello_ai_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,119 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+### Fixed
+
+- `wait_closed()` no longer ends on an error from a command other than
+  `create_call`. It used to raise on any error frame that arrived while a call
+  was active, so a mid-call `dtmfDigitsInvalid` raised `ValidationError` while
+  the call was still live, and a caller that then closed the socket made the
+  gateway cancel the real call. The wire contract (§6) keeps the connection
+  open on a failed command, and a failed `answer` / `send_dtmf` /
+  `get_summary` / `cancel` leaves the call running, so `wait_closed()` now
+  raises only for an error echoing the `requestId` of the current call's
+  `create_call`: a refusal, or a failure after `call.created`. Errors from
+  those other commands are delivered only to `EventType.ERROR` handlers.
+- `create_call` always sends a `requestId`: `request_id` when non-empty,
+  otherwise a generated UUID. The signature is unchanged.
+- A `callAlreadyActive` answering the `create_call` that started the call now
+  ends `wait_closed()` with `CallAlreadyActiveError`. Right after a call ends,
+  the gateway holds the session until it has cleaned that call up (contract
+  §4.1), so a `create_call` sent in that window is refused and never gets
+  `call.created`; `wait_closed()` used to ignore that refusal and hang. Retry
+  the call shortly. A `callAlreadyActive` answering a `create_call` sent
+  during a live call is still only an event, and `noActiveCall` never ends
+  the wait.
+- A `create_call` whose frame cannot be sent (the client is not connected, or
+  the socket has already closed) no longer leaves the client treating a call
+  as running. It raises as before, the next `wait_closed()` raises the same
+  error instead of hanging, and the next `create_call` starts a new call.
+- A call cut off by a dropped connection no longer carries over into the next
+  connection: after `connect()`, an error echoing the dropped call's
+  `create_call` requestId no longer ends the new call's wait.
+- Reconnecting from a `DISCONNECTED` handler works. The dropped connection's
+  receive loop marked the new connection closed once the handler returned,
+  so `wait_closed()` returned at once while the new call was still live, and
+  the dropped call's wait returned instead of raising `ConnectionClosedError`.
+
+### Changed (call wait)
+
+- **Behavior change**: a `wait_closed()` started during a call returns when
+  that call ends, with that call's outcome, even if a handler has already
+  started the next call. It used to keep waiting through a follow-up call
+  started from a terminal handler. Call `wait_closed()` again to wait for the
+  follow-up.
+
+### Changed (packaging)
+
+- Requires `websockets>=14` (was `>=13`). The test suite runs on the asyncio
+  implementation that `websockets` 14 made the default, so 13 was declared
+  but never tested.
+- The package metadata declares the license as a PEP 639 expression
+  (`License-Expression: Apache-2.0`, with `LICENSE` as the license file) and
+  lists trove classifiers for Python 3.10–3.13, `Typing :: Typed`,
+  `Framework :: AsyncIO`, and `Development Status :: 3 - Alpha`. Building
+  needs hatchling 1.27 or newer.
+- The README links on PyPI point at GitHub; as relative paths they were
+  broken on the project page.
+
+### Breaking changes (PyPI distribution name)
+
+- **Breaking**: the distribution is published as `tello-ai-sdk`. `tello-sdk` on PyPI belongs to an unrelated Tello EDU drone library, so `pip install tello-sdk` never installed this SDK. The import name stays `tello`.
+- License is Apache-2.0 (was MIT), matching tello-go and tello-js.
+
+### Breaking changes (SMS removed from the SDK contract)
+
+- **Breaking**: `send_sms` was removed entirely (the `sendSms` command, the `sms.sent` event, and the `SmsSentEvent` / `EventType.SMS_SENT` symbols no longer exist). The gateway dropped the `sendSms` handler, so a client still sending the frame matches no handler, receives no response at all, and blocks until its own timeout.
+- **Breaking**: the `smsToRequired` / `smsMessageRequired` / `smsFailed` error codes are gone from the contract and from the error-code → exception mapping.
+- **Breaking**: `examples/send_sms.py` was deleted, and `examples/call_summary_sms.py` became `examples/call_summary.py` (the call → `getSummary` half is unchanged; only the follow-up SMS was dropped). `LIVE_SMS_TO` / `LIVE_SMS_MESSAGE` are no longer read by any example.
+
+### Breaking changes (agent selection removed from the SDK contract)
+
+- **Breaking**: `create_call` no longer takes an `agent_id` parameter; the `createCall` wire frame never carries an `agentId` field (the gateway resolves the agent server-side). The `agentIdRequired` error code is gone from the contract.
+- **Breaking**: `list_agents` was removed entirely (the `listAgents` command, the `agents.listed` event, and the `AgentInfo` / `AgentsListedEvent` / `EventType.AGENTS_LISTED` symbols no longer exist).
+
+- Initial WS realtime client for turn-provider-gateway `/sdk`.
+- `TelloClient`: connect (internal `auth`/`auth.ok` handshake), `create_call` / `answer` / `send_dtmf` / `cancel`, pub/sub event handlers, `wait_closed`.
+- `send_dtmf(digits, message_id=None, request_id=None)`: mirrors `answer` but sends DTMF `digits` via the `sendDtmf` wire command.
+- Event parsing for `user.turn` / `agent.turn` / `call.statusChanged` / `call.completed` / `call.noAnswer` / `call.failed` / `error`.
+
+### Changed (auth handshake)
+
+- Connection auth moved from the `Authorization: Bearer` upgrade header to an
+  application-level handshake: the client sends
+  `{"event":"auth","data":{"token":"<apiKey>"}}` as the first frame and blocks
+  until the server returns `auth.ok` before `connect()` succeeds. Auth stays
+  internal (no public step). The API key never appears on the upgrade request,
+  in the URL query, in logs, or in exceptions. An `unauthenticated` error frame,
+  a 4401 close, or an `auth.ok` wait timeout each raise `AuthenticationError`
+  from `connect()`.
+
+### Changed (camelCase wire contract)
+
+- Inbound frames are camelCase-only: event types `call.statusChanged` / `call.noAnswer`,
+  keys `sessionId` / `callId` / `turnIndex` / `previousStatus` / `failureReason` / `requestId`,
+  status vocabulary `inProgress` / `noAnswer` (etc.), error codes `toRequired` /
+  `callIdRequired` / `callNotFound` / `callNotCompleted` / `callAlreadyActive` /
+  `noActiveCall` / `dtmfDigitsRequired` / `dtmfDigitsInvalid` / `callRejected` /
+  `internalError`.
+- Added `dtmf.accepted` event parsing (`DtmfAcceptedEvent`), acking a `sendDtmf` command.
+- Python attribute names stay snake_case (`event.call_id`, `event.turn_index`, ...);
+  `Event` gains a `session_id` attribute (parsed from `sessionId`).
+- Outbound commands were already camelCase and are unchanged.
+- Error-code → exception mapping; automatic pong via `websockets`.
+- `TELLO_API_KEY` / `TELLO_URL` environment-variable config (`TelloClient()` with no args).
+- Version sourced solely from `src/tello/_version.py` (hatch dynamic version).
+
+### Fixes (code review)
+
+- `wait_closed()` no longer hangs when the gateway rejects a `create_call`
+  (toRequired / callRejected / internalError); it raises the mapped error.
+- Abnormal mid-call disconnect now raises `ConnectionClosedError` instead of
+  returning as a phantom success.
+- Receive loop drops valid-JSON non-object frames instead of crashing.
+- Terminal handler that starts a follow-up call no longer trips a stale done flag.
+- `DISCONNECTED` is delivered as a typed `Event` (was a raw dict).
+- Map close code 4429 to `SessionReplacedError`; derive auth error from the
+  socket close code on the connect-then-send race.
+- Remove empty `calls.py` placeholder.

tello_ai_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tello_ai_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.5
+Name: tello-ai-sdk
+Version: 0.1.0
+Summary: Tello SDK for Python — WebSocket realtime client for turn-provider-gateway
+Project-URL: Homepage, https://telloai.io
+Project-URL: Repository, https://github.com/tello-ai/tello-python
+Author: Tello
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: realtime,sdk,telephony,tello,voice,websocket
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: websockets>=14
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+**English** | [한국어](https://github.com/tello-ai/tello-python/blob/main/README.ko.md)
+
+# tello-ai-sdk (Python)
+
+> repo: `tello-python` · PyPI package: `tello-ai-sdk` · import: `tello`
+
+Tello SDK for Python — a thin **WebSocket** realtime client for the
+turn-provider-gateway `/sdk` endpoint. The SDK is the "conversation brain":
+the gateway streams each caller turn from a live phone call, and your handler's
+reply is forwarded back into the call.
+
+> Transport is WebSocket only. There is no REST or webhook surface. The protocol
+> contract lives in [`docs/protocol/sdk-ws.v1.md`](https://github.com/tello-ai/tello-python/blob/main/docs/protocol/sdk-ws.v1.md).
+
+## 1. Install
+
+```bash
+pip install tello-ai-sdk     # requires Python >= 3.10; imports as `tello`
+```
+
+## 2. API key
+
+The key authenticates the connection through an application-level handshake:
+right after the socket opens the SDK sends an `auth` frame carrying the key in
+its `token` field and waits for the server's `auth.ok` before anything else
+runs. The key is never placed on the WS upgrade request or in the URL query.
+This is fully internal — you never call auth yourself; `connect()` (and `async
+with`) simply does not succeed until authentication has. Issue a key in the portal
+(Agent settings → Advanced → Agent-linked / SDK).
+
+Pass it explicitly or via environment variables:
+
+```bash
+export TELLO_API_KEY="tello_live_xxx"
+export TELLO_URL="ws://localhost:3000/sdk"   # optional; defaults to ws://localhost:3000/sdk
+```
+
+`TelloClient()` with no arguments then reads `TELLO_API_KEY` / `TELLO_URL`.
+
+## 3. Connect + start a call
+
+```python
+import asyncio
+from tello import TelloClient, EventType
+
+async def main():
+    async with TelloClient(api_key="tello_live_xxx", url="ws://localhost:3000/sdk") as client:
+        @client.on(EventType.USER_TURN)
+        async def on_user_turn(event):
+            await client.answer(text="확인했습니다. 계속 말씀해주세요.")
+
+        await client.create_call(to="+821012345678", prompt="예약 확인")
+        await client.wait_closed()
+
+asyncio.run(main())
+```
+
+`TelloClient(...)` is the constructor (Python has no `new`). The `async with`
+form is sugar for `connect()` / `aclose()`; use them explicitly if you prefer:
+
+```python
+client = TelloClient(api_key="tello_live_xxx", url="ws://localhost:3000/sdk")
+await client.connect()
+client.on(EventType.USER_TURN, on_user_turn)
+await client.create_call(to="+821012345678", prompt="예약 확인")
+await client.wait_closed()
+await client.aclose()
+```
+
+## 4. Realtime turn events (pub/sub)
+
+Subscribe handlers (sync or async) per event type via `client.on(...)`:
+
+| `EventType` | value | payload fields |
+| --- | --- | --- |
+| `CALL_CREATED` | `call.created` | `call_id`, `session_id` |
+| `USER_TURN` | `user.turn` | `turn_index`, `text` |
+| `AGENT_TURN` | `agent.turn` | `turn_index`, `text` |
+| `ANSWER_ACCEPTED` | `answer.accepted` | `request_id?`, `message_id` |
+| `DTMF_ACCEPTED` | `dtmf.accepted` | `request_id?`, `message_id`, `digits` |
+| `CALL_SUMMARY` | `call.summary` | `request_id?`, `status`, `duration_seconds?`, `transcript?`, `summary?`, `credit_charged?` |
+| `CALL_STATUS_CHANGED` | `call.statusChanged` | `status`, `previous_status` |
+| `CALL_COMPLETED` | `call.completed` | `status` |
+| `CALL_NO_ANSWER` | `call.noAnswer` | `status`, `failure_reason?` |
+| `CALL_FAILED` | `call.failed` | `status`, `failure_reason?` |
+| `ERROR` | `error` | `code`, `message`, `request_id?`, `question?` |
+| `DISCONNECTED` | `disconnected` | SDK-local; emitted when the WS closes |
+
+Payload fields above are the Python attribute names; the wire frames themselves
+use camelCase keys (`sessionId`, `callId`, `turnIndex`, `previousStatus`,
+`failureReason`, `requestId`). An unknown `type` falls back to the base `Event`
+so forward-compatible additions still reach subscribers.
+
+Commands: `await client.create_call(to, prompt="", metadata=None, request_id=None)`,
+`await client.answer(text, message_id=None, request_id=None)`,
+`await client.send_dtmf(digits, message_id=None, request_id=None)`, `await client.cancel()`,
+`await client.get_summary(call_id, request_id=None)`. `create_call` always sends
+a `requestId`: the one you pass, or a generated UUID when you omit it. Give each
+command its own `request_id`, or omit it (see §5).
+
+`await client.wait_closed()` resolves when the call reaches a terminal state
+(`call.completed` / `call.noAnswer` / `call.failed`, or a `call.statusChanged`
+with status `cancelled`) or the connection closes. After `cancel()`, the gateway
+ends the call with that cancelled `call.statusChanged` (its `previous_status` is
+the status before the cancel); no `call.completed` follows. A wait in progress
+returns when its own call ends, even if a handler has already started a
+follow-up call; call `wait_closed()` again to wait for the follow-up. It raises
+instead when the call's `create_call` fails (see §5); an error from any other
+command does not end the wait.
+
+## 5. Error handling
+
+Gateway error frames map 1:1 to exceptions
+(see [`docs/errors/errors.v1.json`](https://github.com/tello-ai/tello-python/blob/main/docs/errors/errors.v1.json)):
+
+| gateway `code` | exception |
+| --- | --- |
+| `unauthenticated` | `AuthenticationError` (auth handshake; also close code 4401) |
+| `toRequired` | `ValidationError` |
+| `callIdRequired` | `ValidationError` |
+| `callNotFound` | `ValidationError` |
+| `callNotCompleted` | `ValidationError` |
+| `dtmfDigitsRequired` | `ValidationError` |
+| `dtmfDigitsInvalid` | `ValidationError` |
+| `callAlreadyActive` | `CallAlreadyActiveError` |
+| `noActiveCall` | `NoActiveCallError` |
+| `callRejected` | `CallRejectedError` (with `.question`) |
+| `internalError` | `TelloServerError` |
+
+Every error carries the gateway code on `.code` — branch on that, never on
+`.args[0]`, which is display text the gateway may reword.
+
+`createCall` can also be refused before any call exists — no `call.created`, no
+`callId`, no charge. The gateway never retries these; any retry policy is yours.
+
+| gateway `code` | exception | what to do |
+| --- | --- | --- |
+| `insufficientCredit` | `CallRefusedError` | tell the user to top up; do not resend |
+| `concurrentLimitExceeded` | `CallRefusedError` | wait for one of your own calls to end, then retry |
+| `callerNotVerified` | `CallRefusedError` | tell the user to verify the number; do not resend |
+| `noRepresentativeNumber` | `CallRefusedError` | tell the user to configure a caller number; do not resend |
+| `callProviderUnauthorized` | `CallProviderError` | service fault; report it, resending never helps |
+| `callProviderDraining` | `CallProviderError` | retry later at your own pace |
+| `callProviderUnavailable` | `CallProviderError` | retry later at your own pace |
+| `callSetupFailed` | `CallProviderError` | surface as a failure and report it |
+
+Command-level errors are also delivered to `EventType.ERROR` subscribers without
+closing the socket. Only an error answering the call's own `create_call` ends
+the call: `create_call` always sends a `requestId` (generated when you omit it)
+and the gateway echoes it on the error frame, which is how the SDK tells that
+error apart. Errors from `answer`, `send_dtmf`, `get_summary`, and `cancel` do
+not end the call; they are delivered only as `EventType.ERROR` events, and
+`wait_closed()` keeps waiting for the call's terminal event. So give each
+command its own `request_id`, or omit it: never reuse the `create_call`
+requestId on another command, because an error answering that command would
+then end the wait. `wait_closed()` re-raises the relevant error so a failed
+`create_call` (e.g. `toRequired`, `callRejected`) does not hang:
+
+- auth failure (`unauthenticated` frame, close 4401, or `auth.ok` timeout) → `AuthenticationError`, raised from `connect()`
+- a `create_call` error (a refusal before `call.created`, or a failure after it) → its mapped exception above
+- `callAlreadyActive` → `CallAlreadyActiveError`, but only when it answers the `create_call` that started the call: the gateway is still finishing the previous call, so this one never started. Retry shortly. Answering a `create_call` sent during a live call, it is only an `EventType.ERROR` event and the live call continues. `noActiveCall` never ends the wait
+- the connection dropping mid-call → `ConnectionClosedError`
+- the session being displaced (close 4429) → `SessionReplacedError`
+
+An `EventType.ERROR` handler receives an `ErrorEvent`, not an exception. To turn
+it into the typed exception from the tables above, pass its fields to
+`exception_for` from `tello.errors`:
+
+```python
+from tello import CallRefusedError, EventType
+from tello.errors import exception_for
+
+@client.on(EventType.ERROR)
+def on_error(event):
+    error = exception_for(event.code, event.message, event.question)
+    if isinstance(error, CallRefusedError):
+        print(f"refused: {error.code}")
+```
+
+The gateway drives a WS-level ping heartbeat; `websockets` answers pongs
+automatically. There is no reconnect/resume — treat an abnormal close as
+reconnect-worthy and restart the call.
+
+## 6. Examples
+
+Runnable programs live in [`examples/`](https://github.com/tello-ai/tello-python/blob/main/examples/README.md):
+
+```bash
+uv run python examples/basic_call.py       # connect, one call, answer each turn
+uv run python examples/agent_callback.py   # full lifecycle, history, cancel, typed errors
+uv run python examples/call_summary.py     # gated live scenario ending in call.summary
+```
+
+They place real calls. Read [`examples/README.md`](https://github.com/tello-ai/tello-python/blob/main/examples/README.md) first.
+
+## 7. Version compatibility
+
+`tello-ai-sdk 0.1.x` implements Tello WS protocol `1.0`.
+
+The full frame contract is in [`docs/protocol/sdk-ws.v1.md`](https://github.com/tello-ai/tello-python/blob/main/docs/protocol/sdk-ws.v1.md),
+with [`docs/events/sdk-events.v1.schema.json`](https://github.com/tello-ai/tello-python/blob/main/docs/events/sdk-events.v1.schema.json)
+and [`docs/errors/errors.v1.json`](https://github.com/tello-ai/tello-python/blob/main/docs/errors/errors.v1.json). Those three files
+are generated copies of the canonical contract that lives beside the gateway
+implementation — read them here, edit them there.