vapi-server-sdk 0.0.0a7__py3-none-any.whl

vapi/types/voice_library.py

@@ -0,0 +1,126 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .voice_library_gender import VoiceLibraryGender
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class VoiceLibrary(UniversalBaseModel):
+    provider: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is the voice provider that will be used.
+    """
+
+    provider_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="providerId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The ID of the voice provided by the provider.
+    """
+
+    slug: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The unique slug of the voice.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the voice.
+    """
+
+    language: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The language of the voice.
+    """
+
+    language_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="languageCode")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The language code of the voice.
+    """
+
+    model: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The model of the voice.
+    """
+
+    supported_models: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="supportedModels")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The supported models of the voice.
+    """
+
+    gender: typing.Optional[VoiceLibraryGender] = pydantic.Field(default=None)
+    """
+    The gender of the voice.
+    """
+
+    accent: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The accent of the voice.
+    """
+
+    preview_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="previewUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    The preview URL of the voice.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the voice.
+    """
+
+    credential_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="credentialId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The credential ID of the voice.
+    """
+
+    id: str = pydantic.Field()
+    """
+    The unique identifier for the voice library.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    The unique identifier for the organization that this voice library belongs to.
+    """
+
+    is_public: typing_extensions.Annotated[bool, FieldMetadata(alias="isPublic")] = pydantic.Field()
+    """
+    The Public voice is shared accross all the organizations.
+    """
+
+    is_deleted: typing_extensions.Annotated[bool, FieldMetadata(alias="isDeleted")] = pydantic.Field()
+    """
+    The deletion status of the voice.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    The ISO 8601 date-time string of when the voice library was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    The ISO 8601 date-time string of when the voice library was last updated.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/voice_library_gender.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+VoiceLibraryGender = typing.Union[typing.Literal["male", "female"], typing.Any]

vapi/types/voice_library_voice_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class VoiceLibraryVoiceResponse(UniversalBaseModel):
+    voice_id: typing_extensions.Annotated[str, FieldMetadata(alias="voiceId")]
+    name: str
+    public_owner_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="publicOwnerId")] = None
+    description: typing.Optional[str] = None
+    gender: typing.Optional[str] = None
+    age: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    accent: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/vonage_credential.py

@@ -0,0 +1,64 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+import typing
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class VonageCredential(UniversalBaseModel):
+    vonage_application_private_key: typing_extensions.Annotated[
+        str, FieldMetadata(alias="vonageApplicationPrivateKey")
+    ] = pydantic.Field()
+    """
+    This is not returned in the API.
+    """
+
+    provider: typing.Literal["vonage"] = "vonage"
+    api_secret: typing_extensions.Annotated[str, FieldMetadata(alias="apiSecret")] = pydantic.Field()
+    """
+    This is not returned in the API.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the credential.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the org that this credential belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the credential was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the assistant was last updated.
+    """
+
+    vonage_application_id: typing_extensions.Annotated[str, FieldMetadata(alias="vonageApplicationId")] = (
+        pydantic.Field()
+    )
+    """
+    This is the Vonage Application ID for the credential.
+    
+    Only relevant for Vonage credentials.
+    """
+
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/vonage_phone_number.py

@@ -0,0 +1,108 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .vonage_phone_number_fallback_destination import VonagePhoneNumberFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class VonagePhoneNumber(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[VonagePhoneNumberFallbackDestination], FieldMetadata(alias="fallbackDestination")
+    ] = pydantic.Field(default=None)
+    """
+    This is the fallback destination an inbound call will be transferred to if:
+    
+    1. `assistantId` is not set
+    2. `squadId` is not set
+    3. and, `assistant-request` message to the `serverUrl` fails
+    
+    If this is not set and above conditions are met, the inbound call is hung up with an error message.
+    """
+
+    provider: typing.Literal["vonage"] = "vonage"
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the phone number.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the org that this phone number belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the phone number was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the phone number was last updated.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the phone number. This is just for your own reference.
+    """
+
+    assistant_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="assistantId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the assistant that will be used for incoming calls to this phone number.
+    
+    If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
+    """
+
+    squad_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="squadId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the squad that will be used for incoming calls to this phone number.
+    
+    If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
+    """
+
+    server_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="serverUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.
+    
+    You can see the shape of the messages sent in `ServerMessage`.
+    
+    This overrides the `org.serverUrl`. Order of precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
+    """
+
+    server_url_secret: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="serverUrlSecret")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.
+    
+    Same precedence logic as serverUrl.
+    """
+
+    number: str = pydantic.Field()
+    """
+    These are the digits of the phone number you own on your Vonage.
+    """
+
+    credential_id: typing_extensions.Annotated[str, FieldMetadata(alias="credentialId")] = pydantic.Field()
+    """
+    This is the credential that is used to make outgoing calls, and do operations like call transfer and hang up.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/vonage_phone_number_fallback_destination.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .transfer_destination_number import TransferDestinationNumber
+from .transfer_destination_sip import TransferDestinationSip
+
+VonagePhoneNumberFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/workflow_block.py

@@ -0,0 +1,99 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+from .callback_step import CallbackStep
+from .create_workflow_block_dto import CreateWorkflowBlockDto
+from .handoff_step import HandoffStep
+import typing
+from .workflow_block_messages_item import WorkflowBlockMessagesItem
+import pydantic
+import typing_extensions
+from .json_schema import JsonSchema
+from ..core.serialization import FieldMetadata
+from .workflow_block_steps_item import WorkflowBlockStepsItem
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class WorkflowBlock(UniversalBaseModel):
+    messages: typing.Optional[typing.List[WorkflowBlockMessagesItem]] = pydantic.Field(default=None)
+    """
+    These are the pre-configured messages that will be spoken to the user while the block is running.
+    """
+
+    input_schema: typing_extensions.Annotated[typing.Optional[JsonSchema], FieldMetadata(alias="inputSchema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the input schema for the block. This is the input the block needs to run. It's given to the block as `steps[0].input`
+    
+    These are accessible as variables:
+    
+    - ({{input.propertyName}}) in context of the block execution (step)
+    - ({{stepName.input.propertyName}}) in context of the workflow
+    """
+
+    output_schema: typing_extensions.Annotated[typing.Optional[JsonSchema], FieldMetadata(alias="outputSchema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the output schema for the block. This is the output the block will return to the workflow (`{{stepName.output}}`).
+    
+    These are accessible as variables:
+    
+    - ({{output.propertyName}}) in context of the block execution (step)
+    - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    - ({{blockName.output.propertyName}}) in context of the workflow (read caveat #2)
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step.
+    2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.
+    """
+
+    type: typing.Literal["workflow"] = "workflow"
+    steps: typing.Optional[typing.List[WorkflowBlockStepsItem]] = pydantic.Field(default=None)
+    """
+    These are the steps in the workflow.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the block.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the organization that this block belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the block was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the block was last updated.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the block. This is just for your reference.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+update_forward_refs(CallbackStep, WorkflowBlock=WorkflowBlock)
+update_forward_refs(CreateWorkflowBlockDto, WorkflowBlock=WorkflowBlock)
+update_forward_refs(HandoffStep, WorkflowBlock=WorkflowBlock)

vapi/types/workflow_block_messages_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .block_start_message import BlockStartMessage
+from .block_complete_message import BlockCompleteMessage
+
+WorkflowBlockMessagesItem = typing.Union[BlockStartMessage, BlockCompleteMessage]

vapi/types/workflow_block_steps_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .handoff_step import HandoffStep
+from .callback_step import CallbackStep
+
+WorkflowBlockStepsItem = typing.Union[HandoffStep, CallbackStep]

vapi/version.py

@@ -0,0 +1,3 @@
+from importlib import metadata
+
+__version__ = metadata.version("vapi_server_sdk")

vapi_server_sdk-0.0.0a7.dist-info/METADATA

@@ -0,0 +1,179 @@
+Metadata-Version: 2.1
+Name: vapi-server-sdk
+Version: 0.0.0a7
+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!
+