warevoyant 0.1.0__tar.gz

warevoyant-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+.env
+.env.local
+
+# Generated SDK files (rebuilt from OpenAPI spec)
+sdk/typescript/src/schema.d.ts
+sdk/python/warevoyant/

warevoyant-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: warevoyant
+Version: 0.1.0
+Summary: Python SDK for the WareVoyant API — typed endpoints, Pydantic models, zero guesswork.
+Project-URL: Homepage, https://developers.warevoyant.com
+Project-URL: Documentation, https://developers.warevoyant.com/getting-started
+Project-URL: Repository, https://github.com/JonathanCioffi/warevoyant-platform
+License-Expression: MIT
+Keywords: api,av,commissioning,openapi,sdk,warevoyant
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Description-Content-Type: text/markdown
+
+# warevoyant
+
+Python SDK for the WareVoyant API -- typed endpoints, Pydantic models, zero guesswork.
+
+## Install
+
+```bash
+pip install warevoyant
+```
+
+## Quick Start
+
+> **Note:** The Python SDK is generated from the OpenAPI spec at publish time.
+> The exact client API depends on the generated output. Below is the expected
+> usage pattern:
+
+```python
+from warevoyant import Client
+
+client = Client(
+    base_url="https://api-production-566c.up.railway.app",
+    token="wv_live_YOUR_KEY",
+)
+
+sites = client.get_sites()
+for site in sites:
+    print(f"{site.name} — {site.address}")
+```
+
+## Documentation
+
+- [Getting Started](https://developers.warevoyant.com/getting-started)
+- [API Reference](https://developers.warevoyant.com/docs)
+
+## License
+
+MIT

warevoyant-0.1.0/README.md

@@ -0,0 +1,37 @@
+# warevoyant
+
+Python SDK for the WareVoyant API -- typed endpoints, Pydantic models, zero guesswork.
+
+## Install
+
+```bash
+pip install warevoyant
+```
+
+## Quick Start
+
+> **Note:** The Python SDK is generated from the OpenAPI spec at publish time.
+> The exact client API depends on the generated output. Below is the expected
+> usage pattern:
+
+```python
+from warevoyant import Client
+
+client = Client(
+    base_url="https://api-production-566c.up.railway.app",
+    token="wv_live_YOUR_KEY",
+)
+
+sites = client.get_sites()
+for site in sites:
+    print(f"{site.name} — {site.address}")
+```
+
+## Documentation
+
+- [Getting Started](https://developers.warevoyant.com/getting-started)
+- [API Reference](https://developers.warevoyant.com/docs)
+
+## License
+
+MIT

warevoyant-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "warevoyant"
+version = "0.1.0"
+description = "Python SDK for the WareVoyant API — typed endpoints, Pydantic models, zero guesswork."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+keywords = ["warevoyant", "api", "sdk", "openapi", "av", "commissioning"]
+dependencies = [
+    "httpx>=0.25.0",
+    "pydantic>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://developers.warevoyant.com"
+Documentation = "https://developers.warevoyant.com/getting-started"
+Repository = "https://github.com/JonathanCioffi/warevoyant-platform"

warevoyant-0.1.0/warevoyant/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing WareVoyant API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

warevoyant-0.1.0/warevoyant/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

warevoyant-0.1.0/warevoyant/api/audits/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

warevoyant-0.1.0/warevoyant/api/audits/delete_api_audits_by_id.py

@@ -0,0 +1,123 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/audits/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 200:
+        return None
+
+    if response.status_code == 404:
+        return None
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete an audit session
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Company member
+    - **Permission:** `audits.delete`
+    - **Tier:** Base (free)
+
+    ---
+
+    Permanently deletes an audit and all related entities via cascade.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete an audit session
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Company member
+    - **Permission:** `audits.delete`
+    - **Tier:** Base (free)
+
+    ---
+
+    Permanently deletes an audit and all related entities via cascade.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

warevoyant-0.1.0/warevoyant/api/audits/delete_api_audits_by_id_checklist_by_item_id.py

@@ -0,0 +1,123 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+    item_id: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/audits/{id}/checklist/{item_id}".format(
+            id=quote(str(id), safe=""),
+            item_id=quote(str(item_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 200:
+        return None
+
+    if response.status_code == 404:
+        return None
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    item_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete a checklist item
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Company member
+    - **Permission:** `audits.edit`
+    - **Tier:** Base (free)
+
+    Args:
+        id (str):
+        item_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        item_id=item_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    id: str,
+    item_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete a checklist item
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Company member
+    - **Permission:** `audits.edit`
+    - **Tier:** Base (free)
+
+    Args:
+        id (str):
+        item_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        item_id=item_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

warevoyant-0.1.0/warevoyant/api/audits/delete_api_template_bundles_by_name.py

@@ -0,0 +1,121 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    name: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/template-bundles/{name}".format(
+            name=quote(str(name), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 200:
+        return None
+
+    if response.status_code == 401:
+        return None
+
+    if response.status_code == 403:
+        return None
+
+    if response.status_code == 422:
+        return None
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    name: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete all custom templates belonging to a bundle (non-protected only)
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Portal admin
+    - **Permission:** `templates.manage`
+    - **Tier:** Plus
+
+    Args:
+        name (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        name=name,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    name: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete all custom templates belonging to a bundle (non-protected only)
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Portal admin
+    - **Permission:** `templates.manage`
+    - **Tier:** Plus
+
+    Args:
+        name (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        name=name,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

warevoyant-0.1.0/warevoyant/api/audits/delete_api_templates_by_id.py

@@ -0,0 +1,121 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/templates/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 200:
+        return None
+
+    if response.status_code == 401:
+        return None
+
+    if response.status_code == 403:
+        return None
+
+    if response.status_code == 404:
+        return None
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete a checklist template
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Portal admin
+    - **Permission:** `templates.manage`
+    - **Tier:** Plus
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any]:
+    """Delete a checklist template
+
+     **Access requirements**
+
+    - **Auth:** Bearer JWT (user session)
+    - **Role:** Portal admin
+    - **Permission:** `templates.manage`
+    - **Tier:** Plus
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)