vapi-server-sdk 1.4.2__tar.gz → 1.5.0__tar.gz

vapi_server_sdk-1.5.0/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.1
+Name: vapi-server-sdk
+Version: 1.5.0
+Summary: 
+Requires-Python: >=3.8,<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.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+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
+
+```sh
+pip install vapi_server_sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from vapi import Vapi
+
+client = Vapi(
+    token="YOUR_TOKEN",
+)
+client.calls.create()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from vapi import AsyncVapi
+
+client = AsyncVapi(
+    token="YOUR_TOKEN",
+)
+
+
+async def main() -> None:
+    await client.calls.create()
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from vapi.core.api_error import ApiError
+
+try:
+    client.calls.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from vapi import Vapi
+
+client = Vapi(
+    token="YOUR_TOKEN",
+)
+response = client.logs.get()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.calls.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from vapi import Vapi
+
+client = Vapi(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.calls.create(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from vapi import Vapi
+
+client = Vapi(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## 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-1.5.0/pyproject.toml

@@ -0,0 +1,84 @@
+[project]
+name = "vapi_server_sdk"
+
+[tool.poetry]
+name = "vapi_server_sdk"
+version = "1.5.0"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "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"}
+]
+
+[project.urls]
+Repository = 'https://github.com/VapiAI/server-sdk-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+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"
+
+[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"

vapi_server_sdk-1.5.0/src/vapi/analytics/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

vapi_server_sdk-1.5.0/src/vapi/analytics/client.py

@@ -0,0 +1,103 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.analytics_query import AnalyticsQuery
+from ..types.analytics_query_result import AnalyticsQueryResult
+from .raw_client import AsyncRawAnalyticsClient, RawAnalyticsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AnalyticsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAnalyticsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAnalyticsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAnalyticsClient
+        """
+        return self._raw_client
+
+    def get(
+        self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[AnalyticsQueryResult]:
+        """
+        Parameters
+        ----------
+        queries : typing.Sequence[AnalyticsQuery]
+            This is the list of metric queries you want to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[AnalyticsQueryResult]
+
+
+        Examples
+        --------
+        from vapi import Vapi
+        from vapi import AnalyticsQuery
+        from vapi import AnalyticsOperation
+        client = Vapi(token="YOUR_TOKEN", )
+        client.analytics.get(queries=[AnalyticsQuery(table="call", name='name', operations=[AnalyticsOperation(operation="sum", column="id", )], )], )
+        """
+        _response = self._raw_client.get(queries=queries, request_options=request_options)
+        return _response.data
+
+
+class AsyncAnalyticsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAnalyticsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAnalyticsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAnalyticsClient
+        """
+        return self._raw_client
+
+    async def get(
+        self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[AnalyticsQueryResult]:
+        """
+        Parameters
+        ----------
+        queries : typing.Sequence[AnalyticsQuery]
+            This is the list of metric queries you want to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[AnalyticsQueryResult]
+
+
+        Examples
+        --------
+        from vapi import AsyncVapi
+        from vapi import AnalyticsQuery
+        from vapi import AnalyticsOperation
+        import asyncio
+        client = AsyncVapi(token="YOUR_TOKEN", )
+        async def main() -> None:
+            await client.analytics.get(queries=[AnalyticsQuery(table="call", name='name', operations=[AnalyticsOperation(operation="sum", column="id", )], )], )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(queries=queries, request_options=request_options)
+        return _response.data

vapi_server_sdk-1.5.0/src/vapi/analytics/raw_client.py

@@ -0,0 +1,118 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..core.unchecked_base_model import construct_type
+from ..types.analytics_query import AnalyticsQuery
+from ..types.analytics_query_result import AnalyticsQueryResult
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawAnalyticsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get(
+        self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.List[AnalyticsQueryResult]]:
+        """
+        Parameters
+        ----------
+        queries : typing.Sequence[AnalyticsQuery]
+            This is the list of metric queries you want to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[AnalyticsQueryResult]]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "analytics",
+            method="POST",
+            json={
+                "queries": convert_and_respect_annotation_metadata(
+                    object_=queries, annotation=typing.Sequence[AnalyticsQuery], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[AnalyticsQueryResult],
+                    construct_type(
+                        type_=typing.List[AnalyticsQueryResult],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawAnalyticsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get(
+        self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.List[AnalyticsQueryResult]]:
+        """
+        Parameters
+        ----------
+        queries : typing.Sequence[AnalyticsQuery]
+            This is the list of metric queries you want to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[AnalyticsQueryResult]]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "analytics",
+            method="POST",
+            json={
+                "queries": convert_and_respect_annotation_metadata(
+                    object_=queries, annotation=typing.Sequence[AnalyticsQuery], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[AnalyticsQueryResult],
+                    construct_type(
+                        type_=typing.List[AnalyticsQueryResult],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

vapi_server_sdk-1.5.0/src/vapi/assistants/__init__.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    UpdateAssistantDtoBackgroundSound,
+    UpdateAssistantDtoBackgroundSoundZero,
+    UpdateAssistantDtoClientMessagesItem,
+    UpdateAssistantDtoCredentialsItem,
+    UpdateAssistantDtoFirstMessageMode,
+    UpdateAssistantDtoHooksItem,
+    UpdateAssistantDtoModel,
+    UpdateAssistantDtoServerMessagesItem,
+    UpdateAssistantDtoTranscriber,
+    UpdateAssistantDtoVoice,
+    UpdateAssistantDtoVoicemailDetection,
+)
+
+__all__ = [
+    "UpdateAssistantDtoBackgroundSound",
+    "UpdateAssistantDtoBackgroundSoundZero",
+    "UpdateAssistantDtoClientMessagesItem",
+    "UpdateAssistantDtoCredentialsItem",
+    "UpdateAssistantDtoFirstMessageMode",
+    "UpdateAssistantDtoHooksItem",
+    "UpdateAssistantDtoModel",
+    "UpdateAssistantDtoServerMessagesItem",
+    "UpdateAssistantDtoTranscriber",
+    "UpdateAssistantDtoVoice",
+    "UpdateAssistantDtoVoicemailDetection",
+]