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

vapi/types/server_message_voice_input.py

@@ -0,0 +1,101 @@
+# 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_extensions
+import typing
+from .server_message_voice_input_phone_number import ServerMessageVoiceInputPhoneNumber
+from ..core.serialization import FieldMetadata
+import pydantic
+from .artifact import Artifact
+from .create_assistant_dto import CreateAssistantDto
+from .create_customer_dto import CreateCustomerDto
+from .call import Call
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class ServerMessageVoiceInput(UniversalBaseModel):
+    phone_number: typing_extensions.Annotated[
+        typing.Optional[ServerMessageVoiceInputPhoneNumber], FieldMetadata(alias="phoneNumber")
+    ] = pydantic.Field(default=None)
+    """
+    This is the phone number associated with the call.
+    
+    This matches one of the following:
+    
+    - `call.phoneNumber`,
+    - `call.phoneNumberId`.
+    """
+
+    type: typing.Literal["voice-input"] = pydantic.Field(default="voice-input")
+    """
+    This is the type of the message. "voice-input" is sent when a generation is requested from voice provider.
+    """
+
+    timestamp: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the ISO-8601 formatted timestamp of when the message was sent.
+    """
+
+    artifact: typing.Optional[Artifact] = pydantic.Field(default=None)
+    """
+    This is a live version of the `call.artifact`.
+    
+    This matches what is stored on `call.artifact` after the call.
+    """
+
+    assistant: typing.Optional[CreateAssistantDto] = pydantic.Field(default=None)
+    """
+    This is the assistant that is currently active. This is provided for convenience.
+    
+    This matches one of the following:
+    
+    - `call.assistant`,
+    - `call.assistantId`,
+    - `call.squad[n].assistant`,
+    - `call.squad[n].assistantId`,
+    - `call.squadId->[n].assistant`,
+    - `call.squadId->[n].assistantId`.
+    """
+
+    customer: typing.Optional[CreateCustomerDto] = pydantic.Field(default=None)
+    """
+    This is the customer associated with the call.
+    
+    This matches one of the following:
+    
+    - `call.customer`,
+    - `call.customerId`.
+    """
+
+    call: typing.Optional[Call] = pydantic.Field(default=None)
+    """
+    This is the call object.
+    
+    This matches what was returned in POST /call.
+    
+    Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.
+    """
+
+    input: str = pydantic.Field()
+    """
+    This is the voice input content
+    """
+
+    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, ServerMessageVoiceInput=ServerMessageVoiceInput)
+update_forward_refs(CreateWorkflowBlockDto, ServerMessageVoiceInput=ServerMessageVoiceInput)
+update_forward_refs(HandoffStep, ServerMessageVoiceInput=ServerMessageVoiceInput)

vapi/types/server_message_voice_input_phone_number.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .create_byo_phone_number_dto import CreateByoPhoneNumberDto
+from .create_twilio_phone_number_dto import CreateTwilioPhoneNumberDto
+from .create_vonage_phone_number_dto import CreateVonagePhoneNumberDto
+from .create_vapi_phone_number_dto import CreateVapiPhoneNumberDto
+
+ServerMessageVoiceInputPhoneNumber = typing.Union[
+    CreateByoPhoneNumberDto, CreateTwilioPhoneNumberDto, CreateVonagePhoneNumberDto, CreateVapiPhoneNumberDto
+]

vapi/types/server_message_voice_request.py

@@ -0,0 +1,128 @@
+# 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_extensions
+import typing
+from .server_message_voice_request_phone_number import ServerMessageVoiceRequestPhoneNumber
+from ..core.serialization import FieldMetadata
+import pydantic
+from .artifact import Artifact
+from .create_assistant_dto import CreateAssistantDto
+from .create_customer_dto import CreateCustomerDto
+from .call import Call
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class ServerMessageVoiceRequest(UniversalBaseModel):
+    phone_number: typing_extensions.Annotated[
+        typing.Optional[ServerMessageVoiceRequestPhoneNumber], FieldMetadata(alias="phoneNumber")
+    ] = pydantic.Field(default=None)
+    """
+    This is the phone number associated with the call.
+    
+    This matches one of the following:
+    
+    - `call.phoneNumber`,
+    - `call.phoneNumberId`.
+    """
+
+    type: typing.Literal["voice-request"] = pydantic.Field(default="voice-request")
+    """
+    This is the type of the message. "voice-request" is sent when using `assistant.voice={ "type": "custom-voice" }`.
+    
+    Here is what the request will look like:
+    
+    POST https://{assistant.voice.server.url}
+    Content-Type: application/json
+    
+    {
+    "messsage": {
+    "type": "voice-request",
+    "text": "Hello, world!",
+    "sampleRate": 24000,
+    ...other metadata about the call...
+    }
+    }
+    
+    The expected response is 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:
+    
+    ```
+    response.on('data', (chunk: Buffer) => {
+      outputStream.write(chunk);
+    });
+    ```
+    """
+
+    timestamp: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the ISO-8601 formatted timestamp of when the message was sent.
+    """
+
+    artifact: typing.Optional[Artifact] = pydantic.Field(default=None)
+    """
+    This is a live version of the `call.artifact`.
+    
+    This matches what is stored on `call.artifact` after the call.
+    """
+
+    assistant: typing.Optional[CreateAssistantDto] = pydantic.Field(default=None)
+    """
+    This is the assistant that is currently active. This is provided for convenience.
+    
+    This matches one of the following:
+    
+    - `call.assistant`,
+    - `call.assistantId`,
+    - `call.squad[n].assistant`,
+    - `call.squad[n].assistantId`,
+    - `call.squadId->[n].assistant`,
+    - `call.squadId->[n].assistantId`.
+    """
+
+    customer: typing.Optional[CreateCustomerDto] = pydantic.Field(default=None)
+    """
+    This is the customer associated with the call.
+    
+    This matches one of the following:
+    
+    - `call.customer`,
+    - `call.customerId`.
+    """
+
+    call: typing.Optional[Call] = pydantic.Field(default=None)
+    """
+    This is the call object.
+    
+    This matches what was returned in POST /call.
+    
+    Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.
+    """
+
+    text: str = pydantic.Field()
+    """
+    This is the text to be synthesized.
+    """
+
+    sample_rate: typing_extensions.Annotated[float, FieldMetadata(alias="sampleRate")] = pydantic.Field()
+    """
+    This is the sample rate to be synthesized.
+    """
+
+    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, ServerMessageVoiceRequest=ServerMessageVoiceRequest)
+update_forward_refs(CreateWorkflowBlockDto, ServerMessageVoiceRequest=ServerMessageVoiceRequest)
+update_forward_refs(HandoffStep, ServerMessageVoiceRequest=ServerMessageVoiceRequest)

vapi/types/server_message_voice_request_phone_number.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .create_byo_phone_number_dto import CreateByoPhoneNumberDto
+from .create_twilio_phone_number_dto import CreateTwilioPhoneNumberDto
+from .create_vonage_phone_number_dto import CreateVonagePhoneNumberDto
+from .create_vapi_phone_number_dto import CreateVapiPhoneNumberDto
+
+ServerMessageVoiceRequestPhoneNumber = typing.Union[
+    CreateByoPhoneNumberDto, CreateTwilioPhoneNumberDto, CreateVonagePhoneNumberDto, CreateVapiPhoneNumberDto
+]

vapi/types/sip_trunk_gateway.py

@@ -0,0 +1,79 @@
+# 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 .sip_trunk_gateway_outbound_protocol import SipTrunkGatewayOutboundProtocol
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class SipTrunkGateway(UniversalBaseModel):
+    ip: str = pydantic.Field()
+    """
+    This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com.
+    """
+
+    port: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the port number of the gateway. Default is 5060.
+    
+    @default 5060
+    """
+
+    netmask: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the netmask of the gateway. Defaults to 32.
+    
+    @default 32
+    """
+
+    inbound_enabled: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="inboundEnabled")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is whether inbound calls are allowed from this gateway. Default is true.
+    
+    @default true
+    """
+
+    outbound_enabled: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="outboundEnabled")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is whether outbound calls should be sent to this gateway. Default is true.
+    
+    Note, if netmask is less than 32, it doesn't affect the outbound IPs that are tried. 1 attempt is made to `ip:port`.
+    
+    @default true
+    """
+
+    outbound_protocol: typing_extensions.Annotated[
+        typing.Optional[SipTrunkGatewayOutboundProtocol], FieldMetadata(alias="outboundProtocol")
+    ] = pydantic.Field(default=None)
+    """
+    This is the protocol to use for SIP signaling outbound calls. Default is udp.
+    
+    @default udp
+    """
+
+    options_ping_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="optionsPingEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This is whether to send options ping to the gateway. This can be used to check if the gateway is reachable. Default is false.
+    
+    This is useful for high availability setups where you want to check if the gateway is reachable before routing calls to it. Note, if no gateway for a trunk is reachable, outbound calls will be rejected.
+    
+    @default false
+    """
+
+    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/sip_trunk_gateway_outbound_protocol.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SipTrunkGatewayOutboundProtocol = typing.Union[typing.Literal["tls/srtp", "tcp", "tls", "udp"], typing.Any]

vapi/types/sip_trunk_outbound_authentication_plan.py

@@ -0,0 +1,35 @@
+# 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 .sip_trunk_outbound_sip_register_plan import SipTrunkOutboundSipRegisterPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class SipTrunkOutboundAuthenticationPlan(UniversalBaseModel):
+    auth_password: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="authPassword")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is not returned in the API.
+    """
+
+    auth_username: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="authUsername")] = None
+    sip_register_plan: typing_extensions.Annotated[
+        typing.Optional[SipTrunkOutboundSipRegisterPlan], FieldMetadata(alias="sipRegisterPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted.
+    """
+
+    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/sip_trunk_outbound_sip_register_plan.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class SipTrunkOutboundSipRegisterPlan(UniversalBaseModel):
+    domain: typing.Optional[str] = None
+    username: typing.Optional[str] = None
+    realm: 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/squad.py

@@ -0,0 +1,73 @@
+# 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
+import pydantic
+from .squad_member_dto import SquadMemberDto
+import typing_extensions
+from .assistant_overrides import AssistantOverrides
+from ..core.serialization import FieldMetadata
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class Squad(UniversalBaseModel):
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the squad.
+    """
+
+    members: typing.List[SquadMemberDto] = pydantic.Field()
+    """
+    This is the list of assistants that make up the squad.
+    
+    The call will start with the first assistant in the list.
+    """
+
+    members_overrides: typing_extensions.Annotated[
+        typing.Optional[AssistantOverrides], FieldMetadata(alias="membersOverrides")
+    ] = pydantic.Field(default=None)
+    """
+    This can be used to override all the assistants' settings and provide values for their template variables.
+    
+    Both `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the squad.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the org that this squad 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 squad 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 squad 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
+
+
+update_forward_refs(CallbackStep, Squad=Squad)
+update_forward_refs(CreateWorkflowBlockDto, Squad=Squad)
+update_forward_refs(HandoffStep, Squad=Squad)

vapi/types/squad_member_dto.py

@@ -0,0 +1,60 @@
+# 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_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from .create_assistant_dto import CreateAssistantDto
+from .assistant_overrides import AssistantOverrides
+from .transfer_destination_assistant import TransferDestinationAssistant
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class SquadMemberDto(UniversalBaseModel):
+    assistant_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="assistantId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead.
+    """
+
+    assistant: typing.Optional[CreateAssistantDto] = pydantic.Field(default=None)
+    """
+    This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.
+    """
+
+    assistant_overrides: typing_extensions.Annotated[
+        typing.Optional[AssistantOverrides], FieldMetadata(alias="assistantOverrides")
+    ] = pydantic.Field(default=None)
+    """
+    This can be used to override the assistant's settings and provide values for it's template variables.
+    """
+
+    assistant_destinations: typing_extensions.Annotated[
+        typing.Optional[typing.List[TransferDestinationAssistant]], FieldMetadata(alias="assistantDestinations")
+    ] = pydantic.Field(default=None)
+    """
+    These are the others assistants that this assistant can transfer to.
+    
+    If the assistant already has transfer call tool, these destinations are just appended to existing ones.
+    """
+
+    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, SquadMemberDto=SquadMemberDto)
+update_forward_refs(CreateWorkflowBlockDto, SquadMemberDto=SquadMemberDto)
+update_forward_refs(HandoffStep, SquadMemberDto=SquadMemberDto)

vapi/types/start_speaking_plan.py

@@ -0,0 +1,62 @@
+# 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 .transcription_endpointing_plan import TranscriptionEndpointingPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StartSpeakingPlan(UniversalBaseModel):
+    wait_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="waitSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is how long assistant waits before speaking. Defaults to 0.4.
+    
+    This is the minimum it will wait but if there is latency is the pipeline, this minimum will be exceeded. This is really a stopgap in case the pipeline is moving too fast.
+    
+    Example:
+    
+    - If model generates tokens and voice generates bytes within 100ms, the pipeline still waits 300ms before outputting speech.
+    
+    Usage:
+    
+    - If the customer is taking long pauses, set this to a higher value.
+    - If the assistant is accidentally jumping in too much, set this to a higher value.
+    
+    @default 0.4
+    """
+
+    smart_endpointing_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="smartEndpointingEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines if a customer speech is considered done (endpointing) using the VAP model on customer's speech. This is good for middle-of-thought detection.
+    
+    Once an endpoint is triggered, the request is sent to `assistant.model`.
+    
+    Default `false` since experimental.
+    
+    @default false
+    """
+
+    transcription_endpointing_plan: typing_extensions.Annotated[
+        typing.Optional[TranscriptionEndpointingPlan], FieldMetadata(alias="transcriptionEndpointingPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This determines how a customer speech is considered done (endpointing) using the transcription of customer's speech.
+    
+    Once an endpoint is triggered, the request is sent to `assistant.model`.
+    """
+
+    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/step_destination.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .step_destination_conditions_item import StepDestinationConditionsItem
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StepDestination(UniversalBaseModel):
+    type: typing.Literal["step"] = "step"
+    conditions: typing.Optional[typing.List[StepDestinationConditionsItem]] = pydantic.Field(default=None)
+    """
+    This is an optional array of conditions that must be met for this destination to be triggered. If empty, this is the default destination that the step transfers to.
+    """
+
+    step_name: typing_extensions.Annotated[str, FieldMetadata(alias="stepName")]
+
+    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/step_destination_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
+
+StepDestinationConditionsItem = typing.Union[ModelBasedCondition, RuleBasedCondition]