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

vapi/types/azure_voice.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from .azure_voice_id import AzureVoiceId
+from .chunk_plan import ChunkPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AzureVoice(UniversalBaseModel):
+    filler_injection_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="fillerInjectionEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether fillers are injected into the model output before inputting it into the voice provider.
+    
+    Default `false` because you can achieve better results with prompting the model.
+    """
+
+    provider: typing.Literal["azure"] = pydantic.Field(default="azure")
+    """
+    This is the voice provider that will be used.
+    """
+
+    voice_id: typing_extensions.Annotated[AzureVoiceId, FieldMetadata(alias="voiceId")] = pydantic.Field()
+    """
+    This is the provider-specific ID that will be used.
+    """
+
+    speed: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the speed multiplier that will be used.
+    """
+
+    chunk_plan: typing_extensions.Annotated[typing.Optional[ChunkPlan], FieldMetadata(alias="chunkPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for chunking the model output before it is sent to the voice provider.
+    """
+
+    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/azure_voice_id.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .azure_voice_id_enum import AzureVoiceIdEnum
+
+AzureVoiceId = typing.Union[AzureVoiceIdEnum, str]

vapi/types/azure_voice_id_enum.py

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

vapi/types/block_complete_message.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .block_complete_message_conditions_item import BlockCompleteMessageConditionsItem
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BlockCompleteMessage(UniversalBaseModel):
+    conditions: typing.Optional[typing.List[BlockCompleteMessageConditionsItem]] = pydantic.Field(default=None)
+    """
+    This is an optional array of conditions that must be met for this message to be triggered.
+    """
+
+    type: typing.Literal["block-complete"] = pydantic.Field(default="block-complete")
+    """
+    This is the message type that is triggered when the block completes.
+    """
+
+    content: str = pydantic.Field()
+    """
+    This is the content that the assistant will say when this message is triggered.
+    """
+
+    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/block_complete_message_conditions_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .model_based_condition import ModelBasedCondition
+from .rule_based_condition import RuleBasedCondition
+
+BlockCompleteMessageConditionsItem = typing.Union[ModelBasedCondition, RuleBasedCondition]

vapi/types/block_start_message.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .block_start_message_conditions_item import BlockStartMessageConditionsItem
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BlockStartMessage(UniversalBaseModel):
+    conditions: typing.Optional[typing.List[BlockStartMessageConditionsItem]] = pydantic.Field(default=None)
+    """
+    This is an optional array of conditions that must be met for this message to be triggered.
+    """
+
+    type: typing.Literal["block-start"] = pydantic.Field(default="block-start")
+    """
+    This is the message type that is triggered when the block starts.
+    """
+
+    content: str = pydantic.Field()
+    """
+    This is the content that the assistant will say when this message is triggered.
+    """
+
+    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/block_start_message_conditions_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .model_based_condition import ModelBasedCondition
+from .rule_based_condition import RuleBasedCondition
+
+BlockStartMessageConditionsItem = typing.Union[ModelBasedCondition, RuleBasedCondition]

vapi/types/bot_message.py

@@ -0,0 +1,54 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BotMessage(UniversalBaseModel):
+    role: str = pydantic.Field()
+    """
+    The role of the bot in the conversation.
+    """
+
+    message: str = pydantic.Field()
+    """
+    The message content from the bot.
+    """
+
+    time: float = pydantic.Field()
+    """
+    The timestamp when the message was sent.
+    """
+
+    end_time: typing_extensions.Annotated[float, FieldMetadata(alias="endTime")] = pydantic.Field()
+    """
+    The timestamp when the message ended.
+    """
+
+    seconds_from_start: typing_extensions.Annotated[float, FieldMetadata(alias="secondsFromStart")] = pydantic.Field()
+    """
+    The number of seconds from the start of the conversation.
+    """
+
+    source: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The source of the message.
+    """
+
+    duration: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The duration of the message in seconds.
+    """
+
+    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/bucket_plan.py

@@ -0,0 +1,72 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BucketPlan(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    This is the name of the bucket.
+    """
+
+    region: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the region of the bucket.
+    
+    Usage:
+    
+    - If `credential.type` is `aws`, then this is required.
+    - If `credential.type` is `gcp`, then this is optional since GCP allows buckets to be accessed without a region but region is required for data residency requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints
+    """
+
+    path: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the path where call artifacts will be stored.
+    
+    Usage:
+    
+    - To store call artifacts in a specific folder, set this to the full path. Eg. "/folder-name1/folder-name2".
+    - To store call artifacts in the root of the bucket, leave this blank.
+    
+    @default "/"
+    """
+
+    hmac_access_key: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hmacAccessKey")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the HMAC access key offered by GCP for interoperability with S3 clients. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console
+    
+    Usage:
+    
+    - If `credential.type` is `gcp`, then this is required.
+    - If `credential.type` is `aws`, then this is not required since credential.awsAccessKeyId is used instead.
+    """
+
+    hmac_secret: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hmacSecret")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the secret for the HMAC access key. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console
+    
+    Usage:
+    
+    - If `credential.type` is `gcp`, then this is required.
+    - If `credential.type` is `aws`, then this is not required since credential.awsSecretAccessKey is used instead.
+    
+    Note: This is not returned in the API.
+    """
+
+    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/buy_phone_number_dto.py

@@ -0,0 +1,81 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .buy_phone_number_dto_fallback_destination import BuyPhoneNumberDtoFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BuyPhoneNumberDto(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[BuyPhoneNumberDtoFallbackDestination], 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.
+    """
+
+    area_code: typing_extensions.Annotated[str, FieldMetadata(alias="areaCode")] = pydantic.Field()
+    """
+    This is the area code of the phone number to purchase.
+    """
+
+    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.
+    """
+
+    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/buy_phone_number_dto_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
+
+BuyPhoneNumberDtoFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/byo_phone_number.py

@@ -0,0 +1,126 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .byo_phone_number_fallback_destination import ByoPhoneNumberFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ByoPhoneNumber(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[ByoPhoneNumberFallbackDestination], 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["byo-phone-number"] = "byo-phone-number"
+    number_e_164_check_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="numberE164CheckEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.
+    
+    Use cases:
+    
+    - `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.
+    - `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.
+    
+    If `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\+?[a-zA-Z0-9]+$/`).
+    
+    @default true (E164 check is enabled)
+    """
+
+    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: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the number of the customer.
+    """
+
+    credential_id: typing_extensions.Annotated[str, FieldMetadata(alias="credentialId")] = pydantic.Field()
+    """
+    This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.
+    
+    You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.
+    """
+
+    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/byo_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
+
+ByoPhoneNumberFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/byo_sip_trunk_credential.py

@@ -0,0 +1,85 @@
+# 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
+import datetime as dt
+from .sip_trunk_gateway import SipTrunkGateway
+from .sip_trunk_outbound_authentication_plan import SipTrunkOutboundAuthenticationPlan
+from .sbc_configuration import SbcConfiguration
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ByoSipTrunkCredential(UniversalBaseModel):
+    provider: typing.Optional[typing.Literal["byo-sip-trunk"]] = pydantic.Field(default=None)
+    """
+    This can be used to bring your own SIP trunks or to connect to a Carrier.
+    """
+
+    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.
+    """
+
+    gateways: typing.List[SipTrunkGateway] = pydantic.Field()
+    """
+    This is the list of SIP trunk's gateways.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the SIP trunk. This is just for your reference.
+    """
+
+    outbound_authentication_plan: typing_extensions.Annotated[
+        typing.Optional[SipTrunkOutboundAuthenticationPlan], FieldMetadata(alias="outboundAuthenticationPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This can be used to configure the outbound authentication if required by the SIP trunk.
+    """
+
+    outbound_leading_plus_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="outboundLeadingPlusEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This ensures the outbound origination attempts have a leading plus. Defaults to false to match conventional telecom behavior.
+    
+    Usage:
+    
+    - Vonage/Twilio requires leading plus for all outbound calls. Set this to true.
+    
+    @default false
+    """
+
+    sbc_configuration: typing_extensions.Annotated[
+        typing.Optional[SbcConfiguration], FieldMetadata(alias="sbcConfiguration")
+    ] = pydantic.Field(default=None)
+    """
+    This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi.
+    """
+
+    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