python-casahome 0.2.0__py3-none-any.whl

python_casahome-0.2.0.dist-info/METADATA

@@ -0,0 +1,272 @@
+Metadata-Version: 2.5
+Name: python-casahome
+Version: 0.2.0
+Summary: Unofficial async client for the Casa (getcasa.com) member API
+Author: Borski
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: pydantic>=2.5
+Description-Content-Type: text/markdown
+
+# python-casahome
+
+Async Python client for the [Casa](https://getcasa.com) home membership API.
+
+Unofficial. Not affiliated with or endorsed by Casa.
+
+## Status
+
+Version 0.2.0, alpha.
+
+- The library is read-heavy. Most methods are GETs, and most of those have been
+  confirmed against live traffic.
+- A few write methods exist. They are unverified and haven't been exercised
+  against the real backend. Treat them as experimental.
+- Endpoint shapes were inferred from the iOS app and confirmed against live
+  traffic where marked. Casa can change its private API at any time.
+
+## Install
+
+PyPI isn't set up yet. Install from GitHub:
+
+```
+pip install "python-casahome @ git+https://github.com/borski/python-casahome@v0.2.0"
+```
+
+Requires Python 3.11 or newer.
+
+## Authentication
+
+Casa signs members in with Firebase phone auth, and SMS sign-in only works from
+the real app. This library starts from a Firebase refresh token instead and
+exchanges it for short-lived ID tokens.
+
+Casa offers no official way to export that token. You obtain your own refresh
+token from your own Casa app session, for example by inspecting your own app's
+traffic during login and reading `refreshToken` from the Firebase token
+response.
+
+Treat the refresh token like a password. Anyone holding it can act as you.
+Keep it in a password manager or secret store, never in source control.
+
+The token doesn't expire on a timer, but Firebase can rotate it. Pass
+`on_refresh_token_rotated` to `FirebaseAuth` (sync or async) and persist the new
+value when it fires.
+
+## Quick start
+
+```python
+import asyncio
+
+from casahome import CasaApi
+
+
+async def main() -> None:
+    async with CasaApi.create("YOUR_REFRESH_TOKEN") as api:
+        me = await api.bootstrap()
+        for home in me.homes:
+            print(home.display_address, home.status)
+            weather = await api.weather(home.id)
+            print(weather)
+
+
+asyncio.run(main())
+```
+
+If you already own an `aiohttp.ClientSession` (for example in Home Assistant),
+build the pieces yourself:
+
+```python
+from casahome import CasaApi, CasaClient, FirebaseAuth
+
+auth = FirebaseAuth(session, refresh_token, on_refresh_token_rotated=save_token)
+api = CasaApi(
+    CasaClient(session, auth),
+    device_id=stored_device_id,
+    timezone="America/Los_Angeles",
+)
+```
+
+`bootstrap` registers a device with Casa. Long-lived callers should persist
+`api.device_id` and pass it back on the next start. Otherwise every restart adds
+a new device to the account.
+
+A runnable example lives in `examples/bootstrap.py`:
+
+```
+CASA_REFRESH_TOKEN=... uv run examples/bootstrap.py
+```
+
+## Coverage
+
+Each method's docstring starts with `VERIFIED` or `UNVERIFIED`.
+`casahome.is_unverified(api.some_method)` reports the same thing at runtime.
+
+The "Live-confirmed" column means:
+
+- **yes**: the path, method, response envelope and list item shapes were seen
+  in live traffic.
+- **partial**: the path, method and envelope were seen, but lists came back
+  empty or items are kept as opaque JSON. Item models are inferred.
+- **no**: inferred from the app only. Not seen working live.
+
+The envelope is the top-level response keys. Item shape is the structure of
+elements inside lists. All live confirmation dates from 2026-10.
+
+### Reads
+
+| Method | Live-confirmed | Notes |
+|---|---|---|
+| `bootstrap` | yes | Profile, homes, badge counts, app update info. |
+| `onboarding_details` | yes | Raw dict, or `None` on 304. |
+| `onboarding_details_typed` | yes | Typed version of the above. |
+| `onboarding_availability` | yes | |
+| `home_details` | yes | Stories, rooms, inventory entities. |
+| `inventory_item` | yes | One entity. |
+| `inventory_makes` | yes | |
+| `inventory_enums` | yes | Takes a property's `enum_type` key, such as `light_fixture_type`. |
+| `inventory_paint_matches` | yes | |
+| `inventory_service_history` | partial | Room and home targets seen. Entity target untested. |
+| `room_types` | yes | |
+| `room_image_options` | yes | |
+| `room_image_candidates` | yes | |
+| `matterport_images` | yes | |
+| `badge_counts` | yes | |
+| `weather` | yes | |
+| `credits_summary` | yes | |
+| `home_feed` | yes | `props` varies by card template and stays a JSON dict. |
+| `home_members` | yes | |
+| `schedule_preferences` | yes | |
+| `notification_settings` | yes | |
+| `access_preferences` | partial | Option values not seen populated. |
+| `autopilot_plans` | yes | |
+| `paint_brands`, `paint_collections`, `paint_colors`, `paint_search` | yes | |
+| `suggested_todos` | yes | Question rounds and destination stay opaque. |
+| `todo_details` | yes | Same caveat. |
+| `document_types` | yes | |
+| `help_center_bundle` | yes | Only `member_ios` tested. |
+| `release_notes` | yes | |
+| `release_notes_diff` | yes | |
+| `casa_ai_bootstrap` | partial | Messages not seen populated. |
+| `casa_ai_messages` | partial | |
+| `requests_tab` | partial | |
+| `completed_requests` | partial | |
+| `calendar` | partial | Bounds sent as epoch seconds. |
+| `calendar_busy` | partial | |
+| `calendar_sync` | partial | |
+| `mailbox`, `mail_items`, `packages` | partial | |
+| `documents` | partial | Query parameters untested. |
+| `work_document_source` | partial | Only the `todo_id` selector tested. |
+| `vehicles` | partial | |
+| `utilities_insights` | partial | |
+| `purchases` | partial | |
+| `property_taxes` | partial | |
+| `recurring_vendor_categories` | yes | |
+| `recurring_vendors` | partial | |
+| `bookable_handyman_tasks` | partial | Items stay opaque JSON. |
+| `referral_code` | partial | `display` and `referred_homes` stay opaque JSON. |
+| `request_details` | no | |
+| `membership_info` | no | Returned 404 in testing. |
+| `membership_savings` | no | Returned 404 in testing. |
+| `availability_request_details` | no | |
+| `document_details` | no | |
+| `document_suggestions` | no | |
+| `document_structure_suggestions` | no | |
+| `request_purchases` | no | |
+| `task_details` | no | |
+| `vendor_visit_details` | no | |
+| `vendor_visit_autopilot_plan` | no | |
+| `vendor_visit_calls` | no | |
+| `vendor_visit_conversation` | no | |
+| `vendor_visit_purchases` | no | |
+| `casa_ai_events` | partial | Opt-in SSE stream. Transport confirmed, event payloads untested. |
+
+### Writes
+
+| Method | Live-confirmed |
+|---|---|
+| `create_todo_result` | no |
+| `create_todo` | no |
+| `send_request_message` | no |
+| `update_entity_properties` | no |
+
+## Models
+
+Import models from `casahome.models`. Unknown response fields are kept in
+`model_extra` rather than dropped, so new server fields don't break parsing.
+A response that doesn't match the expected shape raises `CasaResponseError`.
+
+Identifier arguments are checked before any request. They must be nonempty
+path-safe segments (letters, digits, `.`, `_`, `~`, `-`). IDs aren't trimmed,
+lowercased or forced to UUIDs.
+
+Responses can contain personal data: names, contact details, messages,
+documents and purchase info. Avoid logging whole models. URLs in responses are
+returned as data. The library never follows them.
+
+## Writes
+
+The write methods are unverified. Their request bodies were inferred from the
+app and have not been exercised against the live backend. Nothing is sent until
+you await a write method.
+
+- Each write is sent exactly once. There is no retry, including on 401. The ID
+  token is refreshed before the request, and a 401 raises `CasaAuthError`.
+  Deciding whether to repeat is up to you.
+- If the response fails to parse, the server may still have performed the
+  action. Don't assume a parse error means it's safe to repeat.
+- Request bodies are strict Pydantic models. Unknown fields and invalid values
+  raise `CasaRequestError` before any I/O. Free-text fields are capped at
+  10,000 characters.
+- Optional fields set to `None` are omitted from the JSON. Empty strings and
+  empty lists are sent as given.
+- `send_request_message` only allows the `member` sender role.
+- `create_todo_result` returns the full envelope, including
+  `needs_support_confirmation`. `create_todo` is the older helper that returns
+  just the todo.
+
+## CasaAI event stream
+
+`api.casa_ai_events(home_id, after=None)` is an opt-in async generator over the
+CasaAI server-sent event stream. It doesn't reconnect on its own. Close it with
+`contextlib.aclosing` if you stop early:
+
+```python
+from contextlib import aclosing
+
+from casahome.streaming import CasaAIResyncRequiredEvent, CasaAIThreadUpdateEvent
+
+async with aclosing(api.casa_ai_events(home_id, after=saved_cursor)) as events:
+    async for event in events:
+        saved_cursor = event.id
+        if isinstance(event, CasaAIResyncRequiredEvent):
+            break  # Reload state, then subscribe again.
+        if isinstance(event, CasaAIThreadUpdateEvent):
+            update = event.payload  # Opaque JSON.
+```
+
+Lines are capped at 64 KiB and events at 256 KiB. A 401 refreshes the token and
+retries the GET once.
+
+## Development
+
+```
+uv sync
+uv run pytest -q
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy src tests
+```
+
+Tests use synthetic data and a loopback test server. They make no network calls
+and need no credentials.
+
+## License
+
+MIT. See `LICENSE`.

python_casahome-0.2.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+casahome/__init__.py,sha256=FUrxuSt6SCLRCNM1nKgjkc7Y9brDHEu4EiFGUkqmM5g,623
+casahome/_base_http.py,sha256=6dO3aEUx0u1JrNSH1HKlCLH2RWmv3ym1aENB3R1Jfjw,615
+casahome/api.py,sha256=31d8xVmjWacQ_IP-GPdoeOFYlCYLOaoz4K5EWaCXBos,49295
+casahome/auth.py,sha256=dzDQ7mDT9HhPlDQDVvQPMlWA1ixlr7duFSfxYf-X9yY,7024
+casahome/client.py,sha256=eD57CrlrEMfE9lqaD8oT7f4mzOodO_xIQM59nZLlUzg,6423
+casahome/const.py,sha256=2LapgPjdsyNr6p5Eu6COmoxoYxmxdpq6EwlvPy7PcQo,1530
+casahome/exceptions.py,sha256=biNTiSergZrNJpHjb1ovwhlmdeoKw2FDcIbk2PQ12Ck,1526
+casahome/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+casahome/streaming.py,sha256=osvR7e700QreJGiXu_4_tLEMd6iQD2PxBSwPLf2RtRQ,10600
+casahome/models/__init__.py,sha256=r9WhPcoVe6HL4qdn8JjIgJ7Pn-8zxVexIMpXtqrUjfc,11887
+casahome/models/_base.py,sha256=lk8610B1lWgSHkx7bJmgp1Lv5w0hotag4aF38FiY7Mw,702
+casahome/models/ai.py,sha256=IoLnkBK76_L3On1JrA_JCtX5uXNmr0LZWRVfjcQIbQA,1623
+casahome/models/assets.py,sha256=x_RaOKmubnJ-tDQQi8THyyuNIN4wgpgZYSDwjv590cU,3380
+casahome/models/availability.py,sha256=0DxhWB1_oYEswlex4rLhiicVERerb0aPZY22kKNT4a4,1016
+casahome/models/bootstrap.py,sha256=dQG147w8g8TLPk58KVRBWnIKaa7K9Uxb-i_C6tpEbxM,4010
+casahome/models/calendar.py,sha256=MfUy1PSzaMv-4qUkDcp3MT6X2QvPjBUiD9fOAgo5bcM,803
+casahome/models/catalogs.py,sha256=pvNGP0Os5APtDECQJ3EK41J8Sw5UD64YIwef4HLww_w,1960
+casahome/models/credits.py,sha256=z8vZ33z_UEjGjWr4tfTsfA0bAz2f3Lt-m8AoThGmays,632
+casahome/models/documents.py,sha256=MQKx_KN6W6gQ6_iJSS--0sqqWk7zf3G9P0VjNIWSMAs,3182
+casahome/models/enums.py,sha256=Z_yXKDRdNDGrw03tu8k98e5C140xMuaCRT8UKv_gmh0,5313
+casahome/models/feed.py,sha256=TT72bsuoCkXGHNH6oum0vTflyj3hyQaCy87pUo88uko,1032
+casahome/models/help_center.py,sha256=WGbUNlnX14OnWnlBi0I47EDu3_GCUN8RLFMZZ4esfao,1318
+casahome/models/home.py,sha256=u3Tv4nt7XIzfdSFOiMvnnFQTneKcR5Hf1bbg-SYOTgw,5191
+casahome/models/images.py,sha256=kfRMFbITk7b88jKsEk8uqzvUVPGv2wVyrfDueCUVgso,1077
+casahome/models/mailbox.py,sha256=hRw4hyNEr6RRPoa3VmnJHuwSL3vHhc69sJ9qPfuI9H4,4414
+casahome/models/maintenance.py,sha256=_nO-Gb2IVyobtDRVScpB8RbQy3Z8u_mc2tmq2J21P40,5473
+casahome/models/membership.py,sha256=ZEpp-ph3yKJoNos56iw0-pXranEWwBQKC3ymAvFDIaU,1542
+casahome/models/paint.py,sha256=-Uz8mRh7NbqxIYEedG7oHSk9xHqdjN_057E7kKCNxq4,1218
+casahome/models/preferences.py,sha256=08LKOmQn_23HbzKPWCP4IyugtXL9KKqE7CBjUFfwcJw,2491
+casahome/models/purchases.py,sha256=GPg67Ezz1Hb5ro8H6MYbmuO-RyB8bFoSvjFoVCqt2e8,3324
+casahome/models/read_todos.py,sha256=FdXthUhOigzg00IhLFU_pHiMZSHbJnmCZ8gzpN2y6zk,632
+casahome/models/referral.py,sha256=KqJ0-CBLutVelZI2FyCiBIXGKSMiCXGjzHW8cZ_j49I,580
+casahome/models/requests.py,sha256=Jie3VKXEFvpzmJ4RIPyhN0TzhWRm6DCLH6CVJIsLgtw,3955
+casahome/models/tasks.py,sha256=P52NlcKP8tNRaQhVElBpJmkpXaUdowY1Vx8v2Obsveo,1887
+casahome/models/taxes.py,sha256=yYoL43bMpxoyN0DjWiAnnnX7rQXHLFwaw4HMTxRo0uE,1421
+casahome/models/todos.py,sha256=RxJqlGAUmEtluP3y8brPcIK57Q_wv9i70QT0CZpXdbg,1151
+casahome/models/visits.py,sha256=h4kugiOb5eppF8mFZIlkvuE9EURskrjdXM-tc1UUjNc,4027
+casahome/models/write_contracts.py,sha256=_kM2wMtlG8semmZ2ANnhjL2kf-iqdD0PRlxEv3_3Z9U,5217
+python_casahome-0.2.0.dist-info/METADATA,sha256=jBzjHVHJRto7-g8urWYpUsN9dpflgfOV_tNTioJUb40,9549
+python_casahome-0.2.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+python_casahome-0.2.0.dist-info/licenses/LICENSE,sha256=Dvy3ioQ2BYi_o6pnuNBrn8xYHudZ6q7-THRl0E9NeCY,1063
+python_casahome-0.2.0.dist-info/RECORD,,

python_casahome-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

python_casahome-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Borski
+
+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.