nimvox-sdk 1.0.0__tar.gz

nimvox_sdk-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+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 2026 Nimvox LLC
+
+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.

nimvox_sdk-1.0.0/NOTICE

@@ -0,0 +1,4 @@
+Nimvox SDK
+Copyright 2026 Nimvox LLC
+
+This product includes software developed by Nimvox LLC (https://nimvox.dev).

nimvox_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: nimvox-sdk
+Version: 1.0.0
+Summary: Official Nimvox Platform SDK — a typed async client for the Nimvox API (auth, email, payments, notifications, messaging). Every call is scoped to your project.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://nimvox.dev
+Project-URL: Repository, https://github.com/nimvox-hq/nimvox-platform
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0; extra == "dev"
+Requires-Dist: respx>=0.22.0; extra == "dev"
+Requires-Dist: mypy>=1.13; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# nimvox-sdk
+
+Official Python SDK for the **Nimvox Platform** API — auth, email, payments, notifications, and messaging — behind one typed async client.
+
+> Built & maintained by **Nimvox** · [github.com/nimvox-hq](https://github.com/nimvox-hq) · [nimvox.dev](https://nimvox.dev)
+
+## Install
+
+```bash
+pip install nimvox-sdk
+```
+
+## Usage
+
+```python
+from nimvox_sdk import NimvoxClient
+
+async with NimvoxClient(project_id="proj_...", api_key="key_...") as client:
+    result = await client.auth.register(email="a@b.com", password="secret")
+```
+
+`BuildvoxClient` is exported as an alias of `NimvoxClient` — Buildvox is powered by the Nimvox platform:
+
+```python
+from nimvox_sdk import BuildvoxClient
+```
+
+## Access & security
+
+Your API key is **scoped to your project**. Every method only ever reads or writes your own tenant's data — the gateway cryptographically binds the key to your project, so a key can never reach another tenant. Which services a key may call is governed by your plan: a call to a service you aren't entitled to returns `403`; rate-limit overages return `429`.
+
+## License
+
+Apache-2.0 — the client library is open source and carries an explicit patent grant; the Nimvox service it talks to is proprietary and API-key gated.

nimvox_sdk-1.0.0/README.md

@@ -0,0 +1,34 @@
+# nimvox-sdk
+
+Official Python SDK for the **Nimvox Platform** API — auth, email, payments, notifications, and messaging — behind one typed async client.
+
+> Built & maintained by **Nimvox** · [github.com/nimvox-hq](https://github.com/nimvox-hq) · [nimvox.dev](https://nimvox.dev)
+
+## Install
+
+```bash
+pip install nimvox-sdk
+```
+
+## Usage
+
+```python
+from nimvox_sdk import NimvoxClient
+
+async with NimvoxClient(project_id="proj_...", api_key="key_...") as client:
+    result = await client.auth.register(email="a@b.com", password="secret")
+```
+
+`BuildvoxClient` is exported as an alias of `NimvoxClient` — Buildvox is powered by the Nimvox platform:
+
+```python
+from nimvox_sdk import BuildvoxClient
+```
+
+## Access & security
+
+Your API key is **scoped to your project**. Every method only ever reads or writes your own tenant's data — the gateway cryptographically binds the key to your project, so a key can never reach another tenant. Which services a key may call is governed by your plan: a call to a service you aren't entitled to returns `403`; rate-limit overages return `429`.
+
+## License
+
+Apache-2.0 — the client library is open source and carries an explicit patent grant; the Nimvox service it talks to is proprietary and API-key gated.

nimvox_sdk-1.0.0/nimvox_sdk/__init__.py

@@ -0,0 +1,23 @@
+"""Nimvox Platform — Python client for the shared gateway and microservices API."""
+
+from .client import NimvoxClient
+from .exceptions import (
+    NimvoxAuthError,
+    NimvoxError,
+    NimvoxNotFoundError,
+    NimvoxRateLimitError,
+    NimvoxServerError,
+)
+
+# Buildvox is powered by the Nimvox platform — BuildvoxClient is an alias of NimvoxClient.
+BuildvoxClient = NimvoxClient
+
+__all__ = [
+    "NimvoxClient",
+    "BuildvoxClient",
+    "NimvoxError",
+    "NimvoxAuthError",
+    "NimvoxNotFoundError",
+    "NimvoxRateLimitError",
+    "NimvoxServerError",
+]

nimvox_sdk-1.0.0/nimvox_sdk/_types.py

@@ -0,0 +1,117 @@
+"""TypedDict definitions for Nimvox Platform API responses."""
+
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class User(TypedDict, total=False):
+    id: str
+    email: str
+    name: str | None
+    emailVerified: bool
+    createdAt: str
+    updatedAt: str
+
+
+class AuthResponse(TypedDict):
+    token: str
+    user: User
+
+
+class TokenValidation(TypedDict):
+    valid: bool
+    user: User
+
+
+class MessageResponse(TypedDict):
+    message: str
+
+
+class EmailAttachment(TypedDict, total=False):
+    """A file attachment. ``filename`` and ``content`` are required; ``content`` is base64-encoded."""
+
+    filename: str
+    content: str
+    contentType: str
+
+
+class EmailResult(TypedDict, total=False):
+    id: str
+    status: str
+    # RFC822 Message-ID from the transport — pass to a later send's inReplyTo/references to thread.
+    messageId: str
+    sentAt: str
+    templateUsed: str
+
+
+class EmailTemplate(TypedDict):
+    name: str
+    subject: str
+
+
+class EmailLog(TypedDict, total=False):
+    id: str
+    to: str
+    subject: str
+    status: str
+    createdAt: str
+
+
+class EmailLogList(TypedDict):
+    logs: list[EmailLog]
+    total: int
+
+
+class DnsRecord(TypedDict, total=False):
+    type: str
+    name: str
+    value: str
+
+
+class DomainVerification(TypedDict):
+    records: list[DnsRecord]
+
+
+class CheckoutResponse(TypedDict):
+    url: str
+
+
+class PortalResponse(TypedDict):
+    url: str
+
+
+class PaymentTransaction(TypedDict, total=False):
+    id: str
+    amount: int
+    currency: str
+    status: str
+    createdAt: str
+
+
+class BillingHistory(TypedDict):
+    transactions: list[PaymentTransaction]
+
+
+class Notification(TypedDict, total=False):
+    id: str
+    userId: str
+    type: str
+    title: str
+    body: str
+    read: bool
+    createdAt: str
+
+
+class NotificationList(TypedDict):
+    notifications: list[Notification]
+    total: int
+
+
+class UnreadCount(TypedDict):
+    count: int
+
+
+class UserList(TypedDict):
+    users: list[User]
+    total: int

nimvox_sdk-1.0.0/nimvox_sdk/auth.py

@@ -0,0 +1,102 @@
+"""Auth sub-client for user management and authentication."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from .client import NimvoxClient
+
+
+class AuthClient:
+    """Wraps the Nimvox auth service endpoints."""
+
+    def __init__(self, client: NimvoxClient) -> None:
+        self._client = client
+
+    async def register(
+        self,
+        email: str,
+        password: str,
+        name: str | None = None,
+    ) -> dict[str, Any]:
+        """Register a new user. Returns ``{user, token}``."""
+        payload: dict[str, Any] = {"email": email, "password": password}
+        if name:
+            payload["name"] = name
+        return await self._client._request("POST", "/api/auth/register", json=payload)
+
+    async def login(self, email: str, password: str) -> dict[str, Any]:
+        """Authenticate a user. Returns ``{token, user}``."""
+        return await self._client._request(
+            "POST", "/api/auth/login", json={"email": email, "password": password},
+        )
+
+    async def validate_token(self, token: str) -> dict[str, Any]:
+        """Validate a JWT token. Returns ``{valid, user}``."""
+        return await self._client._request(
+            "POST", "/api/auth/validate-token", json={"token": token},
+        )
+
+    async def oauth(
+        self,
+        provider: str,
+        email: str,
+        name: str,
+        provider_account_id: str,
+    ) -> dict[str, Any]:
+        """Authenticate via OAuth provider. Returns ``{token, user}``."""
+        return await self._client._request(
+            "POST",
+            f"/api/auth/oauth/{provider}",
+            json={
+                "email": email,
+                "name": name,
+                "provider_account_id": provider_account_id,
+            },
+        )
+
+    async def list_users(
+        self,
+        *,
+        search: str | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
+    ) -> dict[str, Any]:
+        """List users. Returns ``{users, total}``."""
+        params: dict[str, Any] = {}
+        if search is not None:
+            params["search"] = search
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        return await self._client._request("GET", "/api/auth/users", params=params or None)
+
+    async def get_user(self, user_id: str) -> dict[str, Any]:
+        """Get a single user by ID."""
+        return await self._client._request("GET", f"/api/auth/users/{user_id}")
+
+    async def forgot_password(self, email: str) -> dict[str, Any]:
+        """Send a password-reset email. Returns ``{message}``."""
+        return await self._client._request(
+            "POST", "/api/auth/forgot-password", json={"email": email},
+        )
+
+    async def reset_password(self, token: str, password: str) -> dict[str, Any]:
+        """Reset password with a reset token. Returns ``{message}``."""
+        return await self._client._request(
+            "POST", "/api/auth/reset-password", json={"token": token, "password": password},
+        )
+
+    async def verify_email(self, token: str) -> dict[str, Any]:
+        """Verify a user's email address. Returns ``{message}``."""
+        return await self._client._request(
+            "POST", "/api/auth/verify-email", json={"token": token},
+        )
+
+    async def resend_verification(self, email: str) -> dict[str, Any]:
+        """Resend the email-verification message. Returns ``{message}``."""
+        return await self._client._request(
+            "POST", "/api/auth/resend-verification", json={"email": email},
+        )

nimvox_sdk-1.0.0/nimvox_sdk/client.py

@@ -0,0 +1,120 @@
+"""Core NimvoxClient — entry point for all Nimvox Platform API interactions."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from .exceptions import (
+    NimvoxAuthError,
+    NimvoxError,
+    NimvoxNotFoundError,
+    NimvoxRateLimitError,
+    NimvoxServerError,
+)
+
+
+class NimvoxClient:
+    """Async client for the Nimvox Platform API.
+
+    Usage::
+
+        async with NimvoxClient(project_id="proj_...", api_key="key_...") as client:
+            result = await client.auth.register(email="a@b.com", password="secret")
+    """
+
+    def __init__(
+        self,
+        project_id: str,
+        api_key: str,
+        gateway_url: str = "https://api.nimvox.dev",
+        *,
+        timeout: float = 10.0,
+    ) -> None:
+        self.project_id = project_id
+        self.api_key = api_key
+        self.gateway_url = gateway_url.rstrip("/")
+        self._timeout = timeout
+        self._client: httpx.AsyncClient | None = None
+
+        # Lazy imports to avoid circular dependencies
+        from .auth import AuthClient
+        from .email import EmailClient
+        from .messaging import MessagingClient
+        from .notifications import NotificationsClient
+        from .payments import PaymentsClient
+
+        self.auth = AuthClient(self)
+        self.email = EmailClient(self)
+        self.payments = PaymentsClient(self)
+        self.notifications = NotificationsClient(self)
+        self.messaging = MessagingClient(self)
+
+    async def _get_client(self) -> httpx.AsyncClient:
+        if self._client is None or self._client.is_closed:
+            self._client = httpx.AsyncClient(timeout=self._timeout)
+        return self._client
+
+    def _headers(self, user_id: str | None = None) -> dict[str, str]:
+        h: dict[str, str] = {
+            "X-Project-ID": self.project_id,
+            "X-API-Key": self.api_key,
+            "Content-Type": "application/json",
+        }
+        if user_id:
+            h["X-User-ID"] = user_id
+        return h
+
+    async def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        user_id: str | None = None,
+        json: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        client = await self._get_client()
+        url = f"{self.gateway_url}{path}"
+        resp = await client.request(
+            method,
+            url,
+            headers=self._headers(user_id),
+            json=json,
+            params=params,
+        )
+
+        if resp.status_code >= 400:
+            try:
+                body = resp.json()
+            except Exception:
+                body = None
+            message = ""
+            if body and isinstance(body, dict):
+                message = body.get("error", body.get("message", "")) or ""
+            if not message:
+                message = f"HTTP {resp.status_code}"
+
+            if resp.status_code == 401:
+                raise NimvoxAuthError(message, status_code=401, body=body)
+            if resp.status_code == 404:
+                raise NimvoxNotFoundError(message, status_code=404, body=body)
+            if resp.status_code == 429:
+                raise NimvoxRateLimitError(message, status_code=429, body=body)
+            if resp.status_code >= 500:
+                raise NimvoxServerError(message, status_code=resp.status_code, body=body)
+            raise NimvoxError(message, status_code=resp.status_code, body=body)
+
+        return resp.json()
+
+    async def close(self) -> None:
+        """Close the underlying HTTP client."""
+        if self._client and not self._client.is_closed:
+            await self._client.aclose()
+
+    async def __aenter__(self) -> NimvoxClient:
+        return self
+
+    async def __aexit__(self, *exc: object) -> None:
+        await self.close()