bookivox 0.1.0__tar.gz

bookivox-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+# Python build/runtime artifacts
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+
+# Node build artifacts
+node_modules/
+typescript/dist/
+
+# Local SDK build outputs
+*.whl
+*.tgz

bookivox-0.1.0/LICENSE

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

bookivox-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.5
+Name: bookivox
+Version: 0.1.0
+Summary: Official Python SDK and CLI for the Bookivox API
+Project-URL: Homepage, https://bookivox.com
+Project-URL: Documentation, https://docs.bookivox.com
+Project-URL: Repository, https://github.com/limitless-influence-ai/bookivox-sdk
+Project-URL: Issues, https://github.com/limitless-influence-ai/bookivox-sdk/issues
+License: MIT
+License-File: LICENSE
+Keywords: ai,bookivox,sdk,telephony,voice,workflows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Bookivox Python SDK
+
+Official Python client **and CLI** for the [Bookivox](https://bookivox.com) API:
+typed access to agents, node types, tools, knowledge-base documents, recordings,
+credentials and test calls.
+
+- **Typed** — generated `TypedDict` models and typed method signatures (`py.typed`).
+- **Safe by default** — timeouts, retries on idempotent verbs only, typed errors, no secret logging.
+- **One install** — `pip install bookivox` gives you both the SDK and the `bookivox` CLI.
+- **Single runtime dependency** — `httpx`.
+
+## Requirements
+
+- Python **3.11 or newer**.
+- A Bookivox API key (`bookeys_sk-...`), created in
+  [API keys](https://docs.bookivox.com/workspace/api-keys).
+
+## Install
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\Activate.ps1
+pip install bookivox
+```
+
+```bash
+uv add bookivox      # or: poetry add bookivox
+```
+
+Verify the installation:
+
+```bash
+python -c "import bookivox_sdk; print(bookivox_sdk.__version__)"
+bookivox --version
+```
+
+## Authenticate
+
+The API key is read from the `api_key` argument, then from `BOOKIVOX_API_KEY`:
+
+```bash
+export BOOKIVOX_API_KEY="bookeys_sk-..."
+```
+
+```python
+import os
+from bookivox_sdk import Bookivox
+
+client = Bookivox(
+    api_key=os.environ["BOOKIVOX_API_KEY"],  # or omit to use the env var
+    timeout=30.0,
+    max_retries=2,                           # idempotent requests only
+)
+```
+
+| Parameter | Env var | Default |
+| --- | --- | --- |
+| `api_key` | `BOOKIVOX_API_KEY` | — (required) |
+| `timeout` | — | `30.0` |
+| `max_retries` | — | `2` |
+
+The API origin is `https://api.bookivox.com` and is not configurable.
+
+## Quick start
+
+```python
+import os
+from bookivox_sdk import Bookivox
+
+with Bookivox(api_key=os.environ["BOOKIVOX_API_KEY"]) as client:
+    for workflow in client.list_workflows():
+        print(workflow["id"], workflow.get("name"))
+```
+
+`Bookivox` is a context manager: `with` closes the underlying connection pool.
+
+## Methods
+
+| Method | HTTP | Description |
+| --- | --- | --- |
+| `list_workflows(*, status=None)` | `GET /workflow/fetch` | List the organization's agents |
+| `get_workflow(workflow_id)` | `GET /workflow/fetch/{id}` | Fetch one agent |
+| `create_workflow(body)` | `POST /workflow/create/definition` | Create an agent |
+| `update_workflow(workflow_id, body)` | `PUT /workflow/{id}` | Update an agent |
+| `list_node_types()` | `GET /node-types` | List node types and their specs |
+| `get_node_type(name)` | `GET /node-types/{name}` | Fetch one node type spec |
+| `list_tools(*, status=None, category=None)` | `GET /tools/` | List tools |
+| `create_tool(body)` | `POST /tools/` | Create a tool |
+| `list_documents(*, status=None, limit=None, offset=None)` | `GET /knowledge-base/documents` | List knowledge-base documents |
+| `list_recordings(*, workflow_id=None, ...)` | `GET /workflow-recordings/` | List recordings |
+| `list_credentials()` | `GET /credentials/` | List credentials |
+| `test_phone_call(body)` | `POST /telephony/initiate-call` | Start a test call (**billable**) |
+
+## Errors
+
+```python
+from bookivox_sdk import (
+    Bookivox,
+    AuthenticationError,
+    NotFoundError,
+    RateLimitError,
+    ValidationError,
+)
+
+try:
+    with Bookivox() as client:
+        client.get_workflow("wf_123")
+except AuthenticationError:
+    ...  # 401 — invalid or revoked key
+except NotFoundError:
+    ...  # 404 — unknown agent, or outside your organization
+except ValidationError as exc:
+    print(exc.status_code, exc.body)
+except RateLimitError as exc:
+    print("retry in", exc.retry_after, "s")
+```
+
+Every `APIStatusError` exposes `status_code`, `request_id` and `body`.
+
+## CLI
+
+```bash
+bookivox login --api-key "$BOOKIVOX_API_KEY"
+bookivox config
+bookivox workflows list --json
+```
+
+Exit codes: `0` ok, `1` error, `2` usage, `3` auth, `4` not found,
+`5` rate limit, `6` connection.
+
+## Security
+
+- Never commit `.env` files; load the key from your platform's secret manager.
+- `test_phone_call` triggers a **real, billable phone call**.
+
+## Generated code
+
+`src/bookivox_sdk/models.py` and `src/bookivox_sdk/_generated.py` are generated
+from the API OpenAPI schema and must never be edited by hand. Regenerate them
+with `./generate_sdk.sh` from the repository root.
+
+Full documentation: <https://docs.bookivox.com/sdk/overview>.

bookivox-0.1.0/README.md

@@ -0,0 +1,142 @@
+# Bookivox Python SDK
+
+Official Python client **and CLI** for the [Bookivox](https://bookivox.com) API:
+typed access to agents, node types, tools, knowledge-base documents, recordings,
+credentials and test calls.
+
+- **Typed** — generated `TypedDict` models and typed method signatures (`py.typed`).
+- **Safe by default** — timeouts, retries on idempotent verbs only, typed errors, no secret logging.
+- **One install** — `pip install bookivox` gives you both the SDK and the `bookivox` CLI.
+- **Single runtime dependency** — `httpx`.
+
+## Requirements
+
+- Python **3.11 or newer**.
+- A Bookivox API key (`bookeys_sk-...`), created in
+  [API keys](https://docs.bookivox.com/workspace/api-keys).
+
+## Install
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\Activate.ps1
+pip install bookivox
+```
+
+```bash
+uv add bookivox      # or: poetry add bookivox
+```
+
+Verify the installation:
+
+```bash
+python -c "import bookivox_sdk; print(bookivox_sdk.__version__)"
+bookivox --version
+```
+
+## Authenticate
+
+The API key is read from the `api_key` argument, then from `BOOKIVOX_API_KEY`:
+
+```bash
+export BOOKIVOX_API_KEY="bookeys_sk-..."
+```
+
+```python
+import os
+from bookivox_sdk import Bookivox
+
+client = Bookivox(
+    api_key=os.environ["BOOKIVOX_API_KEY"],  # or omit to use the env var
+    timeout=30.0,
+    max_retries=2,                           # idempotent requests only
+)
+```
+
+| Parameter | Env var | Default |
+| --- | --- | --- |
+| `api_key` | `BOOKIVOX_API_KEY` | — (required) |
+| `timeout` | — | `30.0` |
+| `max_retries` | — | `2` |
+
+The API origin is `https://api.bookivox.com` and is not configurable.
+
+## Quick start
+
+```python
+import os
+from bookivox_sdk import Bookivox
+
+with Bookivox(api_key=os.environ["BOOKIVOX_API_KEY"]) as client:
+    for workflow in client.list_workflows():
+        print(workflow["id"], workflow.get("name"))
+```
+
+`Bookivox` is a context manager: `with` closes the underlying connection pool.
+
+## Methods
+
+| Method | HTTP | Description |
+| --- | --- | --- |
+| `list_workflows(*, status=None)` | `GET /workflow/fetch` | List the organization's agents |
+| `get_workflow(workflow_id)` | `GET /workflow/fetch/{id}` | Fetch one agent |
+| `create_workflow(body)` | `POST /workflow/create/definition` | Create an agent |
+| `update_workflow(workflow_id, body)` | `PUT /workflow/{id}` | Update an agent |
+| `list_node_types()` | `GET /node-types` | List node types and their specs |
+| `get_node_type(name)` | `GET /node-types/{name}` | Fetch one node type spec |
+| `list_tools(*, status=None, category=None)` | `GET /tools/` | List tools |
+| `create_tool(body)` | `POST /tools/` | Create a tool |
+| `list_documents(*, status=None, limit=None, offset=None)` | `GET /knowledge-base/documents` | List knowledge-base documents |
+| `list_recordings(*, workflow_id=None, ...)` | `GET /workflow-recordings/` | List recordings |
+| `list_credentials()` | `GET /credentials/` | List credentials |
+| `test_phone_call(body)` | `POST /telephony/initiate-call` | Start a test call (**billable**) |
+
+## Errors
+
+```python
+from bookivox_sdk import (
+    Bookivox,
+    AuthenticationError,
+    NotFoundError,
+    RateLimitError,
+    ValidationError,
+)
+
+try:
+    with Bookivox() as client:
+        client.get_workflow("wf_123")
+except AuthenticationError:
+    ...  # 401 — invalid or revoked key
+except NotFoundError:
+    ...  # 404 — unknown agent, or outside your organization
+except ValidationError as exc:
+    print(exc.status_code, exc.body)
+except RateLimitError as exc:
+    print("retry in", exc.retry_after, "s")
+```
+
+Every `APIStatusError` exposes `status_code`, `request_id` and `body`.
+
+## CLI
+
+```bash
+bookivox login --api-key "$BOOKIVOX_API_KEY"
+bookivox config
+bookivox workflows list --json
+```
+
+Exit codes: `0` ok, `1` error, `2` usage, `3` auth, `4` not found,
+`5` rate limit, `6` connection.
+
+## Security
+
+- Never commit `.env` files; load the key from your platform's secret manager.
+- `test_phone_call` triggers a **real, billable phone call**.
+
+## Generated code
+
+`src/bookivox_sdk/models.py` and `src/bookivox_sdk/_generated.py` are generated
+from the API OpenAPI schema and must never be edited by hand. Regenerate them
+with `./generate_sdk.sh` from the repository root.
+
+Full documentation: <https://docs.bookivox.com/sdk/overview>.

bookivox-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bookivox"
+version = "0.1.0"
+description = "Official Python SDK and CLI for the Bookivox API"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+keywords = ["bookivox", "voice", "ai", "sdk", "workflows", "telephony"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Typing :: Typed",
+]
+dependencies = ["httpx>=0.27,<1"]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "mypy>=1.10", "ruff>=0.5"]
+
+[project.urls]
+Homepage = "https://bookivox.com"
+Documentation = "https://docs.bookivox.com"
+Repository = "https://github.com/limitless-influence-ai/bookivox-sdk"
+Issues = "https://github.com/limitless-influence-ai/bookivox-sdk/issues"
+
+[project.scripts]
+bookivox = "bookivox_sdk.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bookivox_sdk"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/bookivox_sdk/py.typed" = "bookivox_sdk/py.typed"
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+files = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "S", "SIM"]
+ignore = ["S101"]

bookivox-0.1.0/src/bookivox_sdk/__init__.py

@@ -0,0 +1,43 @@
+"""Bookivox Python SDK."""
+
+from __future__ import annotations
+
+from ._generated import GeneratedMethods
+from .client import DEFAULT_BASE_URL, Bookivox
+from .errors import (
+    APIConnectionError,
+    APIStatusError,
+    APITimeoutError,
+    AuthenticationError,
+    BadRequestError,
+    BookivoxError,
+    ConflictError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    ServerError,
+    ValidationError,
+)
+from .models import *  # noqa: F401,F403
+from .models import __all__ as _model_exports
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Bookivox",
+    "GeneratedMethods",
+    "DEFAULT_BASE_URL",
+    "BookivoxError",
+    "APIConnectionError",
+    "APITimeoutError",
+    "APIStatusError",
+    "BadRequestError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "ValidationError",
+    "RateLimitError",
+    "ServerError",
+    *_model_exports,
+]

bookivox-0.1.0/src/bookivox_sdk/_generated.py

@@ -0,0 +1,121 @@
+# AUTO-GENERATED by sdk/generate_sdk.py — DO NOT EDIT.
+# Run `sdk/generate_sdk.sh` to refresh from the live OpenAPI schema.
+
+"""Typed client methods for the Bookivox API (generated)."""
+
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import quote
+
+from .models import *  # noqa: F401,F403
+
+
+class GeneratedMethods:
+    """HTTP methods generated from the OpenAPI `x-sdk-method` tags."""
+
+    def create_tool(self, body: CreateToolRequest) -> ToolResponse:
+        """Create a reusable tool for the authenticated organization."""
+        return self._request(
+            "POST",
+            "/api/v1/tools/",
+            json_body=body,
+        )
+
+    def create_workflow(self, body: CreateWorkflowRequest) -> WorkflowResponse:
+        """Create a new workflow from a workflow definition."""
+        return self._request(
+            "POST",
+            "/api/v1/workflow/create/definition",
+            json_body=body,
+        )
+
+    def get_node_type(self, name: str) -> NodeSpec:
+        """Fetch a single node spec by name."""
+        return self._request(
+            "GET",
+            f"/api/v1/node-types/{quote(str(name), safe='')}",
+        )
+
+    def get_workflow(self, workflow_id: str) -> WorkflowResponse:
+        """Get a single workflow by ID (returns draft if one exists, else published)."""
+        return self._request(
+            "GET",
+            f"/api/v1/workflow/fetch/{quote(str(workflow_id), safe='')}",
+        )
+
+    def list_credentials(self) -> list[CredentialResponse]:
+        """List webhook credentials available to the authenticated organization."""
+        return self._request(
+            "GET",
+            "/api/v1/credentials/",
+        )
+
+    def list_documents(self, *, status: str | None = None, limit: int | None = None, offset: int | None = None) -> DocumentListResponseSchema:
+        """List knowledge base documents available to the authenticated organization."""
+        return self._request(
+            "GET",
+            "/api/v1/knowledge-base/documents",
+            params={
+                "status": status,
+                "limit": limit,
+                "offset": offset,
+            },
+        )
+
+    def list_node_types(self) -> NodeTypesResponse:
+        """List every registered node type with its spec. Pinned to spec_version."""
+        return self._request(
+            "GET",
+            "/api/v1/node-types",
+        )
+
+    def list_recordings(self, *, workflow_id: int | None = None, tts_provider: str | None = None, tts_model: str | None = None, tts_voice_id: str | None = None) -> RecordingListResponseSchema:
+        """List workflow recordings available to the authenticated organization."""
+        return self._request(
+            "GET",
+            "/api/v1/workflow-recordings/",
+            params={
+                "workflow_id": workflow_id,
+                "tts_provider": tts_provider,
+                "tts_model": tts_model,
+                "tts_voice_id": tts_voice_id,
+            },
+        )
+
+    def list_tools(self, *, status: str | None = None, category: str | None = None) -> list[ToolResponse]:
+        """List tools available to the authenticated organization."""
+        return self._request(
+            "GET",
+            "/api/v1/tools/",
+            params={
+                "status": status,
+                "category": category,
+            },
+        )
+
+    def list_workflows(self, *, status: str | None = None) -> list[WorkflowListResponse]:
+        """List all workflows in the authenticated organization."""
+        return self._request(
+            "GET",
+            "/api/v1/workflow/fetch",
+            params={
+                "status": status,
+            },
+        )
+
+    def test_phone_call(self, body: InitiateCallRequest) -> InitiateCallResponse:
+        """Place a test call from a workflow to a phone number."""
+        return self._request(
+            "POST",
+            "/api/v1/telephony/initiate-call",
+            json_body=body,
+        )
+
+    def update_workflow(self, workflow_id: str, body: UpdateWorkflowRequest) -> WorkflowResponse:
+        """Update a workflow's name and/or definition. Saves as a new draft."""
+        return self._request(
+            "PUT",
+            f"/api/v1/workflow/{quote(str(workflow_id), safe='')}",
+            json_body=body,
+        )