vapi-server-sdk 1.11.1__tar.gz → 3.0.0__tar.gz

vapi_server_sdk-3.0.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.1
+Name: vapi-server-sdk
+Version: 3.0.0
+Summary: 
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp (>=3.10.0,<4) ; extra == "aiohttp"
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: httpx-aiohttp (==0.1.8) ; extra == "aiohttp"
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<2.44.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/VapiAI/server-sdk-python
+Description-Content-Type: text/markdown
+
+# Vapi Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FVapiAI%2Fserver-sdk-python)
+[![pypi](https://img.shields.io/pypi/v/vapi_server_sdk)](https://pypi.python.org/pypi/vapi_server_sdk)
+
+The Vapi Python library provides convenient access to the Vapi API from Python.
+
+## Installation
+
+This release supports Python 3.10 through 3.14.
+
+```bash
+python -m pip install vapi_server_sdk
+```
+
+Install the optional async transport:
+
+```bash
+python -m pip install "vapi_server_sdk[aiohttp]"
+```
+
+## Upgrade to 3.0.0
+
+Version 3.0.0 updates the generated types to the current Vapi API definition. Review the [3.0.0 migration notes](./changelog.md) before upgrading from 1.x. Public helper imports, declared model fields, and structured-output run response types have changed.
+
+```bash
+python -m pip install --upgrade "vapi_server_sdk>=3.0.0,<4"
+```
+
+## Reference
+
+See the [Python SDK reference](./reference.md) for methods, parameters, and response types.
+
+## Usage
+
+Set the `VAPI_API_KEY` environment variable to your Vapi private API key. Create a client and list up to 10 assistants in your organization:
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+assistants = client.assistants.list(limit=10)
+for assistant in assistants:
+    print(assistant.id)
+```
+
+## Async Client
+
+Use `AsyncVapi` to await API requests:
+
+```python
+import asyncio
+import os
+
+from vapi import AsyncVapi
+
+
+async def main() -> None:
+    client = AsyncVapi(token=os.environ["VAPI_API_KEY"])
+    assistants = await client.assistants.list(limit=10)
+    for assistant in assistants:
+        print(assistant.id)
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+Catch `ApiError` to inspect an unsuccessful API response:
+
+```python
+import os
+
+from vapi import Vapi
+from vapi.core.api_error import ApiError
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+try:
+    client.assistants.list(limit=10)
+except ApiError as error:
+    print(error.status_code)
+    print(error.body)
+```
+
+## List Resources
+
+`client.assistants.list()` returns a Python list. Use its `limit` and timestamp filters to select results. Other endpoints have their own response types and pagination parameters; consult the [SDK reference](./reference.md) for the endpoint you use.
+
+## Advanced
+
+### Retries
+
+The SDK retries HTTP 408, 409, 429, and 5xx responses with backoff. The default maximum is two retries. Set `max_retries` for an individual request:
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+client.assistants.list(limit=10, request_options={"max_retries": 1})
+```
+
+### Timeouts
+
+The default client timeout is 60 seconds. Set `timeout` when creating the client or override it with `timeout_in_seconds` for a request. When you supply a custom HTTPX client, its read timeout becomes the default unless you set `timeout` explicitly.
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"], timeout=20.0)
+client.assistants.list(limit=10, request_options={"timeout_in_seconds": 1})
+```
+
+### Custom Client
+
+Pass an HTTPX client to configure its transport. This example sets `HTTPTransport.local_address` and closes the custom client when the block finishes:
+
+```python
+import os
+
+import httpx
+from vapi import Vapi
+
+with httpx.Client(transport=httpx.HTTPTransport(local_address="0.0.0.0")) as http:
+    client = Vapi(token=os.environ["VAPI_API_KEY"], httpx_client=http)
+    assistants = client.assistants.list(limit=10)
+    for assistant in assistants:
+        print(assistant.id)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

vapi_server_sdk-3.0.0/README.md

@@ -0,0 +1,145 @@
+# Vapi Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FVapiAI%2Fserver-sdk-python)
+[![pypi](https://img.shields.io/pypi/v/vapi_server_sdk)](https://pypi.python.org/pypi/vapi_server_sdk)
+
+The Vapi Python library provides convenient access to the Vapi API from Python.
+
+## Installation
+
+This release supports Python 3.10 through 3.14.
+
+```bash
+python -m pip install vapi_server_sdk
+```
+
+Install the optional async transport:
+
+```bash
+python -m pip install "vapi_server_sdk[aiohttp]"
+```
+
+## Upgrade to 3.0.0
+
+Version 3.0.0 updates the generated types to the current Vapi API definition. Review the [3.0.0 migration notes](./changelog.md) before upgrading from 1.x. Public helper imports, declared model fields, and structured-output run response types have changed.
+
+```bash
+python -m pip install --upgrade "vapi_server_sdk>=3.0.0,<4"
+```
+
+## Reference
+
+See the [Python SDK reference](./reference.md) for methods, parameters, and response types.
+
+## Usage
+
+Set the `VAPI_API_KEY` environment variable to your Vapi private API key. Create a client and list up to 10 assistants in your organization:
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+assistants = client.assistants.list(limit=10)
+for assistant in assistants:
+    print(assistant.id)
+```
+
+## Async Client
+
+Use `AsyncVapi` to await API requests:
+
+```python
+import asyncio
+import os
+
+from vapi import AsyncVapi
+
+
+async def main() -> None:
+    client = AsyncVapi(token=os.environ["VAPI_API_KEY"])
+    assistants = await client.assistants.list(limit=10)
+    for assistant in assistants:
+        print(assistant.id)
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+Catch `ApiError` to inspect an unsuccessful API response:
+
+```python
+import os
+
+from vapi import Vapi
+from vapi.core.api_error import ApiError
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+try:
+    client.assistants.list(limit=10)
+except ApiError as error:
+    print(error.status_code)
+    print(error.body)
+```
+
+## List Resources
+
+`client.assistants.list()` returns a Python list. Use its `limit` and timestamp filters to select results. Other endpoints have their own response types and pagination parameters; consult the [SDK reference](./reference.md) for the endpoint you use.
+
+## Advanced
+
+### Retries
+
+The SDK retries HTTP 408, 409, 429, and 5xx responses with backoff. The default maximum is two retries. Set `max_retries` for an individual request:
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"])
+client.assistants.list(limit=10, request_options={"max_retries": 1})
+```
+
+### Timeouts
+
+The default client timeout is 60 seconds. Set `timeout` when creating the client or override it with `timeout_in_seconds` for a request. When you supply a custom HTTPX client, its read timeout becomes the default unless you set `timeout` explicitly.
+
+```python
+import os
+
+from vapi import Vapi
+
+client = Vapi(token=os.environ["VAPI_API_KEY"], timeout=20.0)
+client.assistants.list(limit=10, request_options={"timeout_in_seconds": 1})
+```
+
+### Custom Client
+
+Pass an HTTPX client to configure its transport. This example sets `HTTPTransport.local_address` and closes the custom client when the block finishes:
+
+```python
+import os
+
+import httpx
+from vapi import Vapi
+
+with httpx.Client(transport=httpx.HTTPTransport(local_address="0.0.0.0")) as http:
+    client = Vapi(token=os.environ["VAPI_API_KEY"], httpx_client=http)
+    assistants = client.assistants.list(limit=10)
+    for assistant in assistants:
+        print(assistant.id)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

vapi_server_sdk-3.0.0/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "vapi_server_sdk"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "vapi_server_sdk"
+version = "3.0.0"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "vapi", from = "src"}
+]
+
+[tool.poetry.urls]
+Repository = 'https://github.com/VapiAI/server-sdk-python'
+
+[tool.poetry.dependencies]
+python = "^3.10"
+aiohttp = { version = ">=3.10.0,<4", optional = true}
+httpx = ">=0.21.2"
+httpx-aiohttp = { version = "0.1.8", optional = true}
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2,<2.44.0"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^8.2.0"
+pytest-asyncio = "^1.0.0"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+markers = [
+    "aiohttp: tests that require httpx_aiohttp to be installed",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+aiohttp=["aiohttp", "httpx-aiohttp"]