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

vapi/types/client_message_tool_calls_result.py

@@ -0,0 +1,31 @@
+# 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 ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageToolCallsResult(UniversalBaseModel):
+    type: typing.Literal["tool-calls-result"] = pydantic.Field(default="tool-calls-result")
+    """
+    This is the type of the message. "tool-calls-result" is sent to forward the result of a tool call to the client.
+    """
+
+    tool_call_result: typing_extensions.Annotated[
+        typing.Dict[str, typing.Optional[typing.Any]], FieldMetadata(alias="toolCallResult")
+    ] = pydantic.Field()
+    """
+    This is the result of the tool call.
+    """
+
+    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/client_message_tool_calls_tool_with_tool_call_list_item.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .function_tool_with_tool_call import FunctionToolWithToolCall
+from .ghl_tool_with_tool_call import GhlToolWithToolCall
+from .make_tool_with_tool_call import MakeToolWithToolCall
+
+ClientMessageToolCallsToolWithToolCallListItem = typing.Union[
+    FunctionToolWithToolCall, GhlToolWithToolCall, MakeToolWithToolCall
+]

vapi/types/client_message_transcript.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .client_message_transcript_role import ClientMessageTranscriptRole
+import typing_extensions
+from .client_message_transcript_transcript_type import ClientMessageTranscriptTranscriptType
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageTranscript(UniversalBaseModel):
+    type: typing.Literal["transcript"] = pydantic.Field(default="transcript")
+    """
+    This is the type of the message. "transcript" is sent as transcriber outputs partial or final transcript.
+    """
+
+    role: ClientMessageTranscriptRole = pydantic.Field()
+    """
+    This is the role for which the transcript is for.
+    """
+
+    transcript_type: typing_extensions.Annotated[
+        ClientMessageTranscriptTranscriptType, FieldMetadata(alias="transcriptType")
+    ] = pydantic.Field()
+    """
+    This is the type of the transcript.
+    """
+
+    transcript: str = pydantic.Field()
+    """
+    This is the transcript 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

vapi/types/client_message_transcript_role.py

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

vapi/types/client_message_transcript_transcript_type.py

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

vapi/types/client_message_user_interrupted.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageUserInterrupted(UniversalBaseModel):
+    type: typing.Literal["user-interrupted"] = pydantic.Field(default="user-interrupted")
+    """
+    This is the type of the message. "user-interrupted" is sent when the user interrupts the assistant.
+    """
+
+    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/client_message_voice_input.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageVoiceInput(UniversalBaseModel):
+    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.
+    """
+
+    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

vapi/types/clone_voice_dto.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CloneVoiceDto(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    This is the name of the cloned voice in the provider account.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the description of your cloned voice.
+    """
+
+    labels: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Serialized labels dictionary for the voice.
+    """
+
+    files: typing.List[str] = pydantic.Field()
+    """
+    These are the files you want to use to clone your voice. Only Audio files are supported.
+    """
+
+    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/condition.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+from .condition_operator import ConditionOperator
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class Condition(UniversalBaseModel):
+    value: str = pydantic.Field()
+    """
+    This is the value you want to compare against the parameter.
+    """
+
+    operator: ConditionOperator = pydantic.Field()
+    """
+    This is the operator you want to use to compare the parameter and value.
+    """
+
+    param: str = pydantic.Field()
+    """
+    This is the name of the parameter that you want to check.
+    """
+
+    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/condition_operator.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ConditionOperator = typing.Union[typing.Literal["eq", "neq", "gt", "gte", "lt", "lte"], typing.Any]

vapi/types/conversation_block.py

@@ -0,0 +1,109 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .conversation_block_messages_item import ConversationBlockMessagesItem
+import pydantic
+import typing_extensions
+from .json_schema import JsonSchema
+from ..core.serialization import FieldMetadata
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ConversationBlock(UniversalBaseModel):
+    messages: typing.Optional[typing.List[ConversationBlockMessagesItem]] = 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["conversation"] = "conversation"
+    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.
+    """
+
+    instruction: str = pydantic.Field()
+    """
+    This is the instruction to the model.
+    
+    You can reference any variable in the context of the current block execution (step):
+    
+    - "{{input.your-property-name}}" for the current step's input
+    - "{{your-step-name.output.your-property-name}}" for another step's output (in the same workflow; read caveat #1)
+    - "{{your-step-name.input.your-property-name}}" for another step's input (in the same workflow; read caveat #1)
+    - "{{your-block-name.output.your-property-name}}" for another block's output (in the same workflow; read caveat #2)
+    - "{{your-block-name.input.your-property-name}}" for another block's input (in the same workflow; read caveat #2)
+    - "{{workflow.input.your-property-name}}" for the current workflow's input
+    - "{{global.your-property-name}}" for the global context
+    
+    This can be as simple or as complex as you want it to be.
+    
+    - "say hello and ask the user about their day!"
+    - "collect the user's first and last name"
+    - "user is {{input.firstName}} {{input.lastName}}. their age is {{input.age}}. ask them about their salary and if they might be interested in buying a house. we offer {{input.offer}}"
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output/input.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/input.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.
+    """
+
+    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/conversation_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
+
+ConversationBlockMessagesItem = typing.Union[BlockStartMessage, BlockCompleteMessage]

vapi/types/cost_breakdown.py

@@ -0,0 +1,78 @@
+# 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 .analysis_cost_breakdown import AnalysisCostBreakdown
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CostBreakdown(UniversalBaseModel):
+    transport: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of the transport provider, like Twilio or Vonage.
+    """
+
+    stt: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of the speech-to-text service.
+    """
+
+    llm: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of the language model.
+    """
+
+    tts: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of the text-to-speech service.
+    """
+
+    vapi: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost of Vapi.
+    """
+
+    total: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the total cost of the call.
+    """
+
+    llm_prompt_tokens: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="llmPromptTokens")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the LLM prompt tokens used for the call.
+    """
+
+    llm_completion_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="llmCompletionTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the LLM completion tokens used for the call.
+    """
+
+    tts_characters: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="ttsCharacters")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the TTS characters used for the call.
+    """
+
+    analysis_cost_breakdown: typing_extensions.Annotated[
+        typing.Optional[AnalysisCostBreakdown], FieldMetadata(alias="analysisCostBreakdown")
+    ] = pydantic.Field(default=None)
+    """
+    This is the cost of the analysis.
+    """
+
+    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_anthropic_credential_dto.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CreateAnthropicCredentialDto(UniversalBaseModel):
+    provider: typing.Literal["anthropic"] = "anthropic"
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")] = pydantic.Field()
+    """
+    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/create_anyscale_credential_dto.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CreateAnyscaleCredentialDto(UniversalBaseModel):
+    provider: typing.Literal["anyscale"] = "anyscale"
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")] = pydantic.Field()
+    """
+    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