woku 0.1.0__tar.gz

woku-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.pyright/
+
+# Environments
+.venv/
+venv/
+.env
+
+# uv
+uv.lock
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/

woku-0.1.0/LICENSE

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

woku-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: woku
+Version: 0.1.0
+Summary: Official server-side SDK for the Woku management API (trackers, VoC tools, action plans, tickets, delivery and capture over /v1).
+Project-URL: Homepage, https://woku.app
+Project-URL: Repository, https://github.com/wokuApp/woku-python
+Project-URL: Issues, https://github.com/wokuApp/woku-python/issues
+Author: Woku
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,ces,csat,customer-feedback,nps,sdk,voice-of-customer,woku
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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.9
+Requires-Dist: httpx>=0.24
+Requires-Dist: pydantic>=2
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# woku
+
+Official **server-side** SDK for the [Woku](https://woku.app) management API.
+
+[![PyPI](https://img.shields.io/pypi/v/woku)](https://pypi.org/project/woku/)
+[![Python](https://img.shields.io/pypi/pyversions/woku)](https://pypi.org/project/woku/)
+[![License](https://img.shields.io/pypi/l/woku)](./LICENSE)
+
+</div>
+
+## Why
+
+Manage your entire Woku account from your backend with one typed client:
+trackers, VoC tools (NPS/CSAT/CES), wokus, forms, flows, action plans,
+support tickets, delivery tracking and survey sends over the public `/v1` API.
+
+- **Sync and async** clients (`Woku` / `AsyncWoku`) on top of `httpx`.
+- **Typed** request bodies (Pydantic v2 models generated from the OpenAPI spec)
+  and response shapes.
+- **Automatic retries** with full-jitter backoff and `Retry-After` support.
+- **Idempotent creates**: creates carry an auto-generated `Idempotency-Key`, so
+  a retry after a blip never creates twice. Action calls (`send`, `test`,
+  `reply`) are never silently replayed.
+- **Auto-paginated** lists: `for ticket in woku.tickets.list(): ...`.
+- **Typed errors** with the server `request_id` for support.
+
+> **Server-only.** The secret key grants full management access. Keep it on your
+> backend, never in a browser, mobile app or other client you do not control.
+
+## Install
+
+```bash
+pip install woku
+# or: uv add woku
+```
+
+Requires Python 3.9+.
+
+## Quickstart
+
+```python
+from woku import Woku
+
+woku = Woku(api_key="sk_...")  # or set WOKU_API_KEY and call Woku()
+
+# Create a tracker definition (idempotent).
+tracker = woku.trackers.create({"name": "Store #1", "system": "retail"})
+
+# Create an NPS tool and send it.
+tool = woku.nps_tools.create(
+    {"name": "Post-purchase", "npsMessage": "How likely are you to recommend us?"}
+)
+woku.nps.send_invitations(
+    {"channel": "email", "npsToolId": tool["_id"], "recipients": ["ana@example.com"]}
+)
+
+# Read delivery + response rate.
+stats = woku.dispatches.stats({"channel": "email"})
+print(stats["responseRate"])
+```
+
+The key is read from `WOKU_API_KEY` when you omit `api_key`. You can also pass
+it directly: `Woku("sk_...")`.
+
+Request bodies accept either a plain dict (as above) or a generated Pydantic
+model from `woku._generated.models`.
+
+## Async
+
+```python
+import asyncio
+from woku import AsyncWoku
+
+
+async def main() -> None:
+    async with AsyncWoku(api_key="sk_...") as woku:
+        async for ticket in await woku.tickets.list({"severity": "high"}):
+            print(ticket["title"])
+
+
+asyncio.run(main())
+```
+
+## Pagination
+
+List methods return a page you can iterate item by item across pages, or walk
+page by page:
+
+```python
+for ticket in woku.tickets.list({"severity": "high"}):
+    print(ticket["title"])
+
+first = woku.dispatches.list({"channel": "whatsapp"})
+if first.has_next_page():
+    second = first.get_next_page()
+```
+
+## Errors
+
+Every failure is a `WokuError`. HTTP errors are typed subclasses carrying the
+status, parsed body and `request_id`:
+
+```python
+from woku import NotFoundError, RateLimitError
+
+try:
+    woku.tickets.get("nonexistent")
+except NotFoundError as err:
+    print(err.status, err.request_id)  # 404, "req_..."
+except RateLimitError as err:
+    print("retry after", err.retry_after_seconds)
+```
+
+Transport failures (DNS/TLS/timeout) are `WokuConnectionError` /
+`WokuTimeoutError`.
+
+## Configuration
+
+```python
+Woku(
+    api_key="sk_...",
+    base_url="https://clientapi.woku.app",  # default
+    timeout=60.0,  # seconds, default
+    max_retries=2,  # default
+)
+```
+
+Per-call overrides go in the `options` argument of any method:
+
+```python
+woku.tickets.list({"severity": "high"}, options={"timeout": 10.0, "max_retries": 0})
+woku.nps_tools.create(body, options={"idempotency_key": "my-key"})
+```
+
+## Resources
+
+`trackers`, `nps_tools` / `csat_tools` / `ces_tools`, `nps` / `csat` / `ces`,
+`wokus`, `forms`, `flows`, `action_plans`, `action_plan_groups`, `tickets`,
+`ticket_destinations`, `dispatches`, `reports`, `company`, `quarantines`.
+
+## License
+
+MIT

woku-0.1.0/README.md

@@ -0,0 +1,145 @@
+<div align="center">
+
+# woku
+
+Official **server-side** SDK for the [Woku](https://woku.app) management API.
+
+[![PyPI](https://img.shields.io/pypi/v/woku)](https://pypi.org/project/woku/)
+[![Python](https://img.shields.io/pypi/pyversions/woku)](https://pypi.org/project/woku/)
+[![License](https://img.shields.io/pypi/l/woku)](./LICENSE)
+
+</div>
+
+## Why
+
+Manage your entire Woku account from your backend with one typed client:
+trackers, VoC tools (NPS/CSAT/CES), wokus, forms, flows, action plans,
+support tickets, delivery tracking and survey sends over the public `/v1` API.
+
+- **Sync and async** clients (`Woku` / `AsyncWoku`) on top of `httpx`.
+- **Typed** request bodies (Pydantic v2 models generated from the OpenAPI spec)
+  and response shapes.
+- **Automatic retries** with full-jitter backoff and `Retry-After` support.
+- **Idempotent creates**: creates carry an auto-generated `Idempotency-Key`, so
+  a retry after a blip never creates twice. Action calls (`send`, `test`,
+  `reply`) are never silently replayed.
+- **Auto-paginated** lists: `for ticket in woku.tickets.list(): ...`.
+- **Typed errors** with the server `request_id` for support.
+
+> **Server-only.** The secret key grants full management access. Keep it on your
+> backend, never in a browser, mobile app or other client you do not control.
+
+## Install
+
+```bash
+pip install woku
+# or: uv add woku
+```
+
+Requires Python 3.9+.
+
+## Quickstart
+
+```python
+from woku import Woku
+
+woku = Woku(api_key="sk_...")  # or set WOKU_API_KEY and call Woku()
+
+# Create a tracker definition (idempotent).
+tracker = woku.trackers.create({"name": "Store #1", "system": "retail"})
+
+# Create an NPS tool and send it.
+tool = woku.nps_tools.create(
+    {"name": "Post-purchase", "npsMessage": "How likely are you to recommend us?"}
+)
+woku.nps.send_invitations(
+    {"channel": "email", "npsToolId": tool["_id"], "recipients": ["ana@example.com"]}
+)
+
+# Read delivery + response rate.
+stats = woku.dispatches.stats({"channel": "email"})
+print(stats["responseRate"])
+```
+
+The key is read from `WOKU_API_KEY` when you omit `api_key`. You can also pass
+it directly: `Woku("sk_...")`.
+
+Request bodies accept either a plain dict (as above) or a generated Pydantic
+model from `woku._generated.models`.
+
+## Async
+
+```python
+import asyncio
+from woku import AsyncWoku
+
+
+async def main() -> None:
+    async with AsyncWoku(api_key="sk_...") as woku:
+        async for ticket in await woku.tickets.list({"severity": "high"}):
+            print(ticket["title"])
+
+
+asyncio.run(main())
+```
+
+## Pagination
+
+List methods return a page you can iterate item by item across pages, or walk
+page by page:
+
+```python
+for ticket in woku.tickets.list({"severity": "high"}):
+    print(ticket["title"])
+
+first = woku.dispatches.list({"channel": "whatsapp"})
+if first.has_next_page():
+    second = first.get_next_page()
+```
+
+## Errors
+
+Every failure is a `WokuError`. HTTP errors are typed subclasses carrying the
+status, parsed body and `request_id`:
+
+```python
+from woku import NotFoundError, RateLimitError
+
+try:
+    woku.tickets.get("nonexistent")
+except NotFoundError as err:
+    print(err.status, err.request_id)  # 404, "req_..."
+except RateLimitError as err:
+    print("retry after", err.retry_after_seconds)
+```
+
+Transport failures (DNS/TLS/timeout) are `WokuConnectionError` /
+`WokuTimeoutError`.
+
+## Configuration
+
+```python
+Woku(
+    api_key="sk_...",
+    base_url="https://clientapi.woku.app",  # default
+    timeout=60.0,  # seconds, default
+    max_retries=2,  # default
+)
+```
+
+Per-call overrides go in the `options` argument of any method:
+
+```python
+woku.tickets.list({"severity": "high"}, options={"timeout": 10.0, "max_retries": 0})
+woku.nps_tools.create(body, options={"idempotency_key": "my-key"})
+```
+
+## Resources
+
+`trackers`, `nps_tools` / `csat_tools` / `ces_tools`, `nps` / `csat` / `ces`,
+`wokus`, `forms`, `flows`, `action_plans`, `action_plan_groups`, `tickets`,
+`ticket_destinations`, `dispatches`, `reports`, `company`, `quarantines`.
+
+## License
+
+MIT