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

vapi/types/create_assistant_dto.py

@@ -0,0 +1,309 @@
+# 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 .create_assistant_dto_transcriber import CreateAssistantDtoTranscriber
+import pydantic
+from .create_assistant_dto_model import CreateAssistantDtoModel
+from .create_assistant_dto_voice import CreateAssistantDtoVoice
+import typing_extensions
+from .create_assistant_dto_first_message_mode import CreateAssistantDtoFirstMessageMode
+from ..core.serialization import FieldMetadata
+from .create_assistant_dto_client_messages_item import CreateAssistantDtoClientMessagesItem
+from .create_assistant_dto_server_messages_item import CreateAssistantDtoServerMessagesItem
+from .create_assistant_dto_background_sound import CreateAssistantDtoBackgroundSound
+from .transport_configuration_twilio import TransportConfigurationTwilio
+from .twilio_voicemail_detection import TwilioVoicemailDetection
+from .analysis_plan import AnalysisPlan
+from .artifact_plan import ArtifactPlan
+from .message_plan import MessagePlan
+from .start_speaking_plan import StartSpeakingPlan
+from .stop_speaking_plan import StopSpeakingPlan
+from .monitor_plan import MonitorPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class CreateAssistantDto(UniversalBaseModel):
+    transcriber: typing.Optional[CreateAssistantDtoTranscriber] = pydantic.Field(default=None)
+    """
+    These are the options for the assistant's transcriber.
+    """
+
+    model: typing.Optional[CreateAssistantDtoModel] = pydantic.Field(default=None)
+    """
+    These are the options for the assistant's LLM.
+    """
+
+    voice: typing.Optional[CreateAssistantDtoVoice] = pydantic.Field(default=None)
+    """
+    These are the options for the assistant's voice.
+    """
+
+    first_message_mode: typing_extensions.Annotated[
+        typing.Optional[CreateAssistantDtoFirstMessageMode], FieldMetadata(alias="firstMessageMode")
+    ] = pydantic.Field(default=None)
+    """
+    This is the mode for the first message. Default is 'assistant-speaks-first'.
+    
+    Use:
+    
+    - 'assistant-speaks-first' to have the assistant speak first.
+    - 'assistant-waits-for-user' to have the assistant wait for the user to speak first.
+    - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).
+    
+    @default 'assistant-speaks-first'
+    """
+
+    hipaa_enabled: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="hipaaEnabled")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.
+    """
+
+    client_messages: typing_extensions.Annotated[
+        typing.Optional[typing.List[CreateAssistantDtoClientMessagesItem]], FieldMetadata(alias="clientMessages")
+    ] = pydantic.Field(default=None)
+    """
+    These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transcript,tool-calls,user-interrupted,voice-input. You can check the shape of the messages in ClientMessage schema.
+    """
+
+    server_messages: typing_extensions.Annotated[
+        typing.Optional[typing.List[CreateAssistantDtoServerMessagesItem]], FieldMetadata(alias="serverMessages")
+    ] = pydantic.Field(default=None)
+    """
+    These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.
+    """
+
+    silence_timeout_seconds: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="silenceTimeoutSeconds")
+    ] = pydantic.Field(default=None)
+    """
+    How many seconds of silence to wait before ending the call. Defaults to 30.
+    
+    @default 30
+    """
+
+    max_duration_seconds: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="maxDurationSeconds")
+    ] = pydantic.Field(default=None)
+    """
+    This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
+    
+    @default 600 (10 minutes)
+    """
+
+    background_sound: typing_extensions.Annotated[
+        typing.Optional[CreateAssistantDtoBackgroundSound], FieldMetadata(alias="backgroundSound")
+    ] = pydantic.Field(default=None)
+    """
+    This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
+    """
+
+    backchanneling_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="backchannelingEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether the model says 'mhmm', 'ahem' etc. while user is speaking.
+    
+    Default `false` while in beta.
+    
+    @default false
+    """
+
+    background_denoising_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="backgroundDenoisingEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This enables filtering of noise and background speech while the user is talking.
+    
+    Default `false` while in beta.
+    
+    @default false
+    """
+
+    model_output_in_messages_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="modelOutputInMessagesEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
+    
+    Default `false` while in beta.
+    
+    @default false
+    """
+
+    transport_configurations: typing_extensions.Annotated[
+        typing.Optional[typing.List[TransportConfigurationTwilio]], FieldMetadata(alias="transportConfigurations")
+    ] = pydantic.Field(default=None)
+    """
+    These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the assistant.
+    
+    This is required when you want to transfer between assistants in a call.
+    """
+
+    first_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="firstMessage")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
+    
+    If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
+    """
+
+    voicemail_detection: typing_extensions.Annotated[
+        typing.Optional[TwilioVoicemailDetection], FieldMetadata(alias="voicemailDetection")
+    ] = pydantic.Field(default=None)
+    """
+    These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].
+    This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.
+    You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.
+    """
+
+    voicemail_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="voicemailMessage")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the message that the assistant will say if the call is forwarded to voicemail.
+    
+    If unspecified, it will hang up.
+    """
+
+    end_call_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="endCallMessage")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the message that the assistant will say if it ends the call.
+    
+    If unspecified, it will hang up without saying anything.
+    """
+
+    end_call_phrases: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="endCallPhrases")
+    ] = pydantic.Field(default=None)
+    """
+    This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is for metadata you want to store on the assistant.
+    """
+
+    server_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="serverUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.
+    
+    All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
+    
+    This overrides the serverUrl set on the org and the phoneNumber. 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 you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
+    
+    Same precedence logic as serverUrl.
+    """
+
+    analysis_plan: typing_extensions.Annotated[typing.Optional[AnalysisPlan], FieldMetadata(alias="analysisPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
+    """
+
+    artifact_plan: typing_extensions.Annotated[typing.Optional[ArtifactPlan], FieldMetadata(alias="artifactPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.
+    
+    Note: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.
+    """
+
+    message_plan: typing_extensions.Annotated[typing.Optional[MessagePlan], FieldMetadata(alias="messagePlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.
+    
+    Note: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.
+    """
+
+    start_speaking_plan: typing_extensions.Annotated[
+        typing.Optional[StartSpeakingPlan], FieldMetadata(alias="startSpeakingPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This is the plan for when the assistant should start talking.
+    
+    You should configure this if you're running into these issues:
+    
+    - The assistant is too slow to start talking after the customer is done speaking.
+    - The assistant is too fast to start talking after the customer is done speaking.
+    - The assistant is so fast that it's actually interrupting the customer.
+    """
+
+    stop_speaking_plan: typing_extensions.Annotated[
+        typing.Optional[StopSpeakingPlan], FieldMetadata(alias="stopSpeakingPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This is the plan for when assistant should stop talking on customer interruption.
+    
+    You should configure this if you're running into these issues:
+    
+    - The assistant is too slow to recognize customer's interruption.
+    - The assistant is too fast to recognize customer's interruption.
+    - The assistant is getting interrupted by phrases that are just acknowledgments.
+    - The assistant is getting interrupted by background noises.
+    - The assistant is not properly stopping -- it starts talking right after getting interrupted.
+    """
+
+    monitor_plan: typing_extensions.Annotated[typing.Optional[MonitorPlan], FieldMetadata(alias="monitorPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for real-time monitoring of the assistant's calls.
+    
+    Usage:
+    
+    - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.
+    - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.
+    
+    Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible
+    """
+
+    credential_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="credentialIds")
+    ] = pydantic.Field(default=None)
+    """
+    These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.
+    """
+
+    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, CreateAssistantDto=CreateAssistantDto)
+update_forward_refs(CreateWorkflowBlockDto, CreateAssistantDto=CreateAssistantDto)
+update_forward_refs(HandoffStep, CreateAssistantDto=CreateAssistantDto)

vapi/types/create_assistant_dto_background_sound.py

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

vapi/types/create_assistant_dto_client_messages_item.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAssistantDtoClientMessagesItem = typing.Union[
+    typing.Literal[
+        "conversation-update",
+        "function-call",
+        "function-call-result",
+        "hang",
+        "language-changed",
+        "metadata",
+        "model-output",
+        "speech-update",
+        "status-update",
+        "transcript",
+        "tool-calls",
+        "tool-calls-result",
+        "user-interrupted",
+        "voice-input",
+    ],
+    typing.Any,
+]

vapi/types/create_assistant_dto_first_message_mode.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAssistantDtoFirstMessageMode = typing.Union[
+    typing.Literal[
+        "assistant-speaks-first", "assistant-speaks-first-with-model-generated-message", "assistant-waits-for-user"
+    ],
+    typing.Any,
+]

vapi/types/create_assistant_dto_model.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .anyscale_model import AnyscaleModel
+from .anthropic_model import AnthropicModel
+from .custom_llm_model import CustomLlmModel
+from .deep_infra_model import DeepInfraModel
+from .groq_model import GroqModel
+from .open_ai_model import OpenAiModel
+from .open_router_model import OpenRouterModel
+from .perplexity_ai_model import PerplexityAiModel
+from .together_ai_model import TogetherAiModel
+from .vapi_model import VapiModel
+
+CreateAssistantDtoModel = typing.Union[
+    AnyscaleModel,
+    AnthropicModel,
+    CustomLlmModel,
+    DeepInfraModel,
+    GroqModel,
+    OpenAiModel,
+    OpenRouterModel,
+    PerplexityAiModel,
+    TogetherAiModel,
+    VapiModel,
+]

vapi/types/create_assistant_dto_server_messages_item.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAssistantDtoServerMessagesItem = typing.Union[
+    typing.Literal[
+        "conversation-update",
+        "end-of-call-report",
+        "function-call",
+        "hang",
+        "language-changed",
+        "model-output",
+        "phone-call-control",
+        "speech-update",
+        "status-update",
+        "transcript",
+        "tool-calls",
+        "transfer-destination-request",
+        "transfer-update",
+        "user-interrupted",
+        "voice-input",
+    ],
+    typing.Any,
+]

vapi/types/create_assistant_dto_transcriber.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .deepgram_transcriber import DeepgramTranscriber
+from .gladia_transcriber import GladiaTranscriber
+from .talkscriber_transcriber import TalkscriberTranscriber
+
+CreateAssistantDtoTranscriber = typing.Union[DeepgramTranscriber, GladiaTranscriber, TalkscriberTranscriber]

vapi/types/create_assistant_dto_voice.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .azure_voice import AzureVoice
+from .cartesia_voice import CartesiaVoice
+from .deepgram_voice import DeepgramVoice
+from .eleven_labs_voice import ElevenLabsVoice
+from .lmnt_voice import LmntVoice
+from .neets_voice import NeetsVoice
+from .open_ai_voice import OpenAiVoice
+from .play_ht_voice import PlayHtVoice
+from .rime_ai_voice import RimeAiVoice
+
+CreateAssistantDtoVoice = typing.Union[
+    AzureVoice,
+    CartesiaVoice,
+    DeepgramVoice,
+    ElevenLabsVoice,
+    LmntVoice,
+    NeetsVoice,
+    OpenAiVoice,
+    PlayHtVoice,
+    RimeAiVoice,
+]

vapi/types/create_azure_open_ai_credential_dto.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .create_azure_open_ai_credential_dto_region import CreateAzureOpenAiCredentialDtoRegion
+from .create_azure_open_ai_credential_dto_models_item import CreateAzureOpenAiCredentialDtoModelsItem
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CreateAzureOpenAiCredentialDto(UniversalBaseModel):
+    provider: typing.Literal["azure-openai"] = "azure-openai"
+    region: CreateAzureOpenAiCredentialDtoRegion
+    models: typing.List[CreateAzureOpenAiCredentialDtoModelsItem]
+    open_ai_key: typing_extensions.Annotated[str, FieldMetadata(alias="openAIKey")] = pydantic.Field()
+    """
+    This is not returned in the API.
+    """
+
+    open_ai_endpoint: typing_extensions.Annotated[str, FieldMetadata(alias="openAIEndpoint")]
+
+    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/create_azure_open_ai_credential_dto_models_item.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAzureOpenAiCredentialDtoModelsItem = typing.Union[
+    typing.Literal[
+        "gpt-4o-mini-2024-07-18",
+        "gpt-4o-2024-05-13",
+        "gpt-4-turbo-2024-04-09",
+        "gpt-4-0125-preview",
+        "gpt-4-1106-preview",
+        "gpt-4-0613",
+        "gpt-35-turbo-0125",
+        "gpt-35-turbo-1106",
+    ],
+    typing.Any,
+]

vapi/types/create_azure_open_ai_credential_dto_region.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAzureOpenAiCredentialDtoRegion = typing.Union[
+    typing.Literal[
+        "australia",
+        "canada",
+        "eastus2",
+        "eastus",
+        "france",
+        "india",
+        "japan",
+        "northcentralus",
+        "norway",
+        "southcentralus",
+        "sweden",
+        "switzerland",
+        "uk",
+        "westus",
+        "westus3",
+    ],
+    typing.Any,
+]

vapi/types/create_byo_phone_number_dto.py

@@ -0,0 +1,105 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .create_byo_phone_number_dto_fallback_destination import CreateByoPhoneNumberDtoFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CreateByoPhoneNumberDto(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[CreateByoPhoneNumberDtoFallbackDestination], 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)
+    """
+
+    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.
+    """
+
+    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/create_byo_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
+
+CreateByoPhoneNumberDtoFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]