rodmena-caas-client 0.1.0__tar.gz

rodmena_caas_client-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

rodmena_caas_client-0.1.0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project are documented here, newest first.
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.1.0] - 2026-09-12
+
+### Added
+- `Client` and `AsyncClient` with the same surface.
+- Send verbs `sms`, `call`, `whatsapp`, `telegram`, each accepting `at` or
+  `delay` for deferred delivery, validated client-side.
+- `otp.send` / `otp.verify`.
+- Listings: `messages`, `calls`, `voicemails` (with unread state and sender and
+  date filters), `scheduled` (list, get, cancel), `numbers`, `subscriptions`.
+- `status()`, `usage()` including live quota, and `api.rotate()`.
+- Typed exception hierarchy mapped from the service's responses; `py.typed`.
+
+[0.1.0]: https://pypi.org/project/rodmena-caas-client/0.1.0/

rodmena_caas_client-0.1.0/LICENSE

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

rodmena_caas_client-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.5
+Name: rodmena-caas-client
+Version: 0.1.0
+Summary: Python client for the Rodmena CaaS platform: SMS, voice, WhatsApp, Telegram, OTP and voicemail
+Project-URL: Homepage, https://tel.rodmena.co.uk
+Project-URL: Documentation, https://tel.rodmena.co.uk/llms.txt
+Project-URL: Repository, https://github.com/rodmena-limited/cass-client
+Project-URL: Issues, https://github.com/rodmena-limited/cass-client/issues
+Author-email: RODMENA LIMITED <hello@rodmena.co.uk>
+License: MIT
+License-File: LICENSE
+Keywords: caas,otp,rodmena,sms,telephony,voice
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: Telephony
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.24
+Requires-Dist: pydantic>=2.5
+Description-Content-Type: text/markdown
+
+# rodmena-caas-client
+
+Python client for the Rodmena CaaS platform — SMS, voice calls, WhatsApp,
+Telegram, OTP and voicemail, from one API key.
+
+```bash
+pip install rodmena-caas-client
+```
+
+## Quick start
+
+```python
+from caas_client import Client
+
+rcs = Client("tel_your_api_key")  # or set CAAS_API_KEY
+
+rcs.sms(to="+447700900555", message="Your order has shipped")
+rcs.sms(to="+447700900555", message="Reminder", delay=3600)  # in an hour
+rcs.sms(to="+447700900555", message="Tomorrow", at="2026-09-13T09:00:00+01:00")
+
+rcs.call(to="+447700900555", dialog="Your code is 4 2 4 2", repeat=2)
+
+code = rcs.otp.send(to="+447700900555")  # sms, or channel="voice"
+rcs.otp.verify(to="+447700900555", code="123456").verified
+
+for vm in rcs.voicemail(unread=True):
+    print(vm.from_, vm.duration_seconds)
+    open(f"{vm.id}.mp3", "wb").write(rcs.voicemails.audio(vm.id))
+
+rcs.status()  # what this key is allowed to do
+rcs.usage()  # cost so far and quota remaining
+```
+
+Everything is available asynchronously with the same surface:
+
+```python
+from caas_client import AsyncClient
+
+async with AsyncClient() as rcs:
+    await rcs.sms(to="+447700900555", message="hello")
+```
+
+## Scheduling
+
+`sms()`, `whatsapp()`, `telegram()` and `call()` take `at` (a timezone-aware
+`datetime` or ISO-8601 string) or `delay` (seconds). Passing either defers the
+send: nothing is transmitted and nothing is charged until it fires.
+
+```python
+job = rcs.sms(to="+447700900555", message="later", delay=600)
+job.scheduled  # True
+job.id  # "sch_..."
+
+rcs.scheduled.list()  # everything queued
+rcs.scheduled.cancel(job.id)
+```
+
+A cancelled send never transmits. Once it has fired, cancelling raises
+`AlreadyFired`.
+
+## Channels
+
+| Channel | Ready to use |
+|---|---|
+| `sms` | yes |
+| `call` | yes |
+| `whatsapp` | needs a WhatsApp Business account on your number; until then `ChannelNotProvisioned` |
+| `telegram` | the recipient must open your bot's link once; until then `RecipientNotLinked`, whose message carries the link |
+
+Telegram cannot address a phone number on its own — a bot may only reply to a
+chat the recipient opened. The first send to an unknown recipient fails with
+`RecipientNotLinked`; give the person the `t.me/...` link in the error, and
+subsequent sends to that number work like any other.
+
+## Errors
+
+Every non-2xx raises a subclass of `CaaSError` carrying `.status`, `.message`
+and `.body`:
+
+`AuthError` (401), `PermissionDenied` (403), `NotFound` (404),
+`InvalidRequest` (400/422), `Conflict` (409) and its subclasses
+`ChannelNotProvisioned`, `RecipientNotLinked`, `AlreadyFired`,
+`QuotaExceeded` (429, with `.retry_after`), `ServiceUnavailable` (503),
+`ServerError` (5xx), `TransportError` (no response).
+
+`at`/`delay` are validated before the request, so a bad schedule raises
+`InvalidRequest` without spending a round trip.
+
+## Key management
+
+```python
+rcs.status().active
+new_key = rcs.api.rotate()  # the client keeps working with the new key
+```
+
+Rotation returns the only copy of the new key and the previous key stops
+working immediately — store it before doing anything else.
+
+## Configuration
+
+| Argument | Environment | Default |
+|---|---|---|
+| `api_key` | `CAAS_API_KEY` | — |
+| `base_url` | `CAAS_URL` | `https://tel.rodmena.co.uk` |
+| `timeout` | — | 30 s |
+
+Full API reference: <https://tel.rodmena.co.uk/llms.txt>

rodmena_caas_client-0.1.0/README.md

@@ -0,0 +1,107 @@
+# rodmena-caas-client
+
+Python client for the Rodmena CaaS platform — SMS, voice calls, WhatsApp,
+Telegram, OTP and voicemail, from one API key.
+
+```bash
+pip install rodmena-caas-client
+```
+
+## Quick start
+
+```python
+from caas_client import Client
+
+rcs = Client("tel_your_api_key")  # or set CAAS_API_KEY
+
+rcs.sms(to="+447700900555", message="Your order has shipped")
+rcs.sms(to="+447700900555", message="Reminder", delay=3600)  # in an hour
+rcs.sms(to="+447700900555", message="Tomorrow", at="2026-09-13T09:00:00+01:00")
+
+rcs.call(to="+447700900555", dialog="Your code is 4 2 4 2", repeat=2)
+
+code = rcs.otp.send(to="+447700900555")  # sms, or channel="voice"
+rcs.otp.verify(to="+447700900555", code="123456").verified
+
+for vm in rcs.voicemail(unread=True):
+    print(vm.from_, vm.duration_seconds)
+    open(f"{vm.id}.mp3", "wb").write(rcs.voicemails.audio(vm.id))
+
+rcs.status()  # what this key is allowed to do
+rcs.usage()  # cost so far and quota remaining
+```
+
+Everything is available asynchronously with the same surface:
+
+```python
+from caas_client import AsyncClient
+
+async with AsyncClient() as rcs:
+    await rcs.sms(to="+447700900555", message="hello")
+```
+
+## Scheduling
+
+`sms()`, `whatsapp()`, `telegram()` and `call()` take `at` (a timezone-aware
+`datetime` or ISO-8601 string) or `delay` (seconds). Passing either defers the
+send: nothing is transmitted and nothing is charged until it fires.
+
+```python
+job = rcs.sms(to="+447700900555", message="later", delay=600)
+job.scheduled  # True
+job.id  # "sch_..."
+
+rcs.scheduled.list()  # everything queued
+rcs.scheduled.cancel(job.id)
+```
+
+A cancelled send never transmits. Once it has fired, cancelling raises
+`AlreadyFired`.
+
+## Channels
+
+| Channel | Ready to use |
+|---|---|
+| `sms` | yes |
+| `call` | yes |
+| `whatsapp` | needs a WhatsApp Business account on your number; until then `ChannelNotProvisioned` |
+| `telegram` | the recipient must open your bot's link once; until then `RecipientNotLinked`, whose message carries the link |
+
+Telegram cannot address a phone number on its own — a bot may only reply to a
+chat the recipient opened. The first send to an unknown recipient fails with
+`RecipientNotLinked`; give the person the `t.me/...` link in the error, and
+subsequent sends to that number work like any other.
+
+## Errors
+
+Every non-2xx raises a subclass of `CaaSError` carrying `.status`, `.message`
+and `.body`:
+
+`AuthError` (401), `PermissionDenied` (403), `NotFound` (404),
+`InvalidRequest` (400/422), `Conflict` (409) and its subclasses
+`ChannelNotProvisioned`, `RecipientNotLinked`, `AlreadyFired`,
+`QuotaExceeded` (429, with `.retry_after`), `ServiceUnavailable` (503),
+`ServerError` (5xx), `TransportError` (no response).
+
+`at`/`delay` are validated before the request, so a bad schedule raises
+`InvalidRequest` without spending a round trip.
+
+## Key management
+
+```python
+rcs.status().active
+new_key = rcs.api.rotate()  # the client keeps working with the new key
+```
+
+Rotation returns the only copy of the new key and the previous key stops
+working immediately — store it before doing anything else.
+
+## Configuration
+
+| Argument | Environment | Default |
+|---|---|---|
+| `api_key` | `CAAS_API_KEY` | — |
+| `base_url` | `CAAS_URL` | `https://tel.rodmena.co.uk` |
+| `timeout` | — | 30 s |
+
+Full API reference: <https://tel.rodmena.co.uk/llms.txt>

rodmena_caas_client-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "rodmena-caas-client"
+version = "0.1.0"
+description = "Python client for the Rodmena CaaS platform: SMS, voice, WhatsApp, Telegram, OTP and voicemail"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [{ name = "RODMENA LIMITED", email = "hello@rodmena.co.uk" }]
+keywords = ["sms", "voice", "otp", "caas", "telephony", "rodmena"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Communications :: Telephony",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.24", "pydantic>=2.5"]
+
+[project.urls]
+Homepage = "https://tel.rodmena.co.uk"
+Documentation = "https://tel.rodmena.co.uk/llms.txt"
+Repository = "https://github.com/rodmena-limited/cass-client"
+Issues = "https://github.com/rodmena-limited/cass-client/issues"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "pytest-asyncio>=0.24", "ruff>=0.6", "mypy>=1.11", "build>=1.2", "twine>=5.0"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/caas_client"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/caas_client/py.typed" = "caas_client/py.typed"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/caas_client", "README.md", "CHANGELOG.md", "LICENSE"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "C4", "SIM", "RUF"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+files = ["src"]
+mypy_path = "src"
+explicit_package_bases = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

rodmena_caas_client-0.1.0/src/caas_client/__init__.py

@@ -0,0 +1,72 @@
+"""Python client for the Rodmena CaaS platform."""
+
+from __future__ import annotations
+
+from caas_client.aclient import AsyncClient
+from caas_client.client import Client
+from caas_client.exceptions import (
+    AlreadyFired,
+    AuthError,
+    CaaSError,
+    ChannelNotProvisioned,
+    Conflict,
+    InvalidRequest,
+    NotFound,
+    PermissionDenied,
+    QuotaExceeded,
+    RecipientNotLinked,
+    ServerError,
+    ServiceUnavailable,
+    TransportError,
+)
+from caas_client.models import (
+    Call,
+    Cost,
+    KeyStatus,
+    Message,
+    Number,
+    Otp,
+    OtpResult,
+    QuotaLine,
+    Recording,
+    RotatedKey,
+    Scheduled,
+    Subscription,
+    Usage,
+    Voicemail,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AlreadyFired",
+    "AsyncClient",
+    "AuthError",
+    "CaaSError",
+    "Call",
+    "ChannelNotProvisioned",
+    "Client",
+    "Conflict",
+    "Cost",
+    "InvalidRequest",
+    "KeyStatus",
+    "Message",
+    "NotFound",
+    "Number",
+    "Otp",
+    "OtpResult",
+    "PermissionDenied",
+    "QuotaExceeded",
+    "QuotaLine",
+    "RecipientNotLinked",
+    "Recording",
+    "RotatedKey",
+    "Scheduled",
+    "ServerError",
+    "ServiceUnavailable",
+    "Subscription",
+    "TransportError",
+    "Usage",
+    "Voicemail",
+    "__version__",
+]