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

vapi/types/gcp_credential.py

@@ -0,0 +1,62 @@
+# 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 .gcp_key import GcpKey
+from .bucket_plan import BucketPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GcpCredential(UniversalBaseModel):
+    provider: typing.Literal["gcp"] = "gcp"
+    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.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the GCP credential. This is just for your reference.
+    """
+
+    gcp_key: typing_extensions.Annotated[GcpKey, FieldMetadata(alias="gcpKey")] = pydantic.Field()
+    """
+    This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys.
+    
+    The schema is identical to the JSON that GCP outputs.
+    """
+
+    bucket_plan: typing_extensions.Annotated[typing.Optional[BucketPlan], FieldMetadata(alias="bucketPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the bucket plan that can be provided to store call artifacts in GCP.
+    """
+
+    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/gcp_key.py

@@ -0,0 +1,78 @@
+# 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
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class GcpKey(UniversalBaseModel):
+    type: str = pydantic.Field()
+    """
+    This is the type of the key. Most likely, this is "service_account".
+    """
+
+    project_id: typing_extensions.Annotated[str, FieldMetadata(alias="projectId")] = pydantic.Field()
+    """
+    This is the ID of the Google Cloud project associated with this key.
+    """
+
+    private_key_id: typing_extensions.Annotated[str, FieldMetadata(alias="privateKeyId")] = pydantic.Field()
+    """
+    This is the unique identifier for the private key.
+    """
+
+    private_key: typing_extensions.Annotated[str, FieldMetadata(alias="privateKey")] = pydantic.Field()
+    """
+    This is the private key in PEM format.
+    
+    Note: This is not returned in the API.
+    """
+
+    client_email: typing_extensions.Annotated[str, FieldMetadata(alias="clientEmail")] = pydantic.Field()
+    """
+    This is the email address associated with the service account.
+    """
+
+    client_id: typing_extensions.Annotated[str, FieldMetadata(alias="clientId")] = pydantic.Field()
+    """
+    This is the unique identifier for the client.
+    """
+
+    auth_uri: typing_extensions.Annotated[str, FieldMetadata(alias="authUri")] = pydantic.Field()
+    """
+    This is the URI for the auth provider's authorization endpoint.
+    """
+
+    token_uri: typing_extensions.Annotated[str, FieldMetadata(alias="tokenUri")] = pydantic.Field()
+    """
+    This is the URI for the auth provider's token endpoint.
+    """
+
+    auth_provider_x_509_cert_url: typing_extensions.Annotated[str, FieldMetadata(alias="authProviderX509CertUrl")] = (
+        pydantic.Field()
+    )
+    """
+    This is the URL of the public x509 certificate for the auth provider.
+    """
+
+    client_x_509_cert_url: typing_extensions.Annotated[str, FieldMetadata(alias="clientX509CertUrl")] = pydantic.Field()
+    """
+    This is the URL of the public x509 certificate for the client.
+    """
+
+    universe_domain: typing_extensions.Annotated[str, FieldMetadata(alias="universeDomain")] = pydantic.Field()
+    """
+    This is the domain associated with the universe this service account belongs to.
+    """
+
+    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/ghl_tool.py

@@ -0,0 +1,85 @@
+# 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 .ghl_tool_messages_item import GhlToolMessagesItem
+import datetime as dt
+from .open_ai_function import OpenAiFunction
+from .server import Server
+from .ghl_tool_metadata import GhlToolMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GhlTool(UniversalBaseModel):
+    async_: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="async")] = pydantic.Field(
+        default=None
+    )
+    """
+    This determines if the tool is async.
+    
+    If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.
+    
+    If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.
+    
+    Defaults to synchronous (`false`).
+    """
+
+    messages: typing.Optional[typing.List[GhlToolMessagesItem]] = pydantic.Field(default=None)
+    """
+    These are the messages that will be spoken to the user as the tool is running.
+    
+    For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
+    """
+
+    type: typing.Literal["ghl"] = "ghl"
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the tool.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the organization that this tool 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 tool 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 tool was last updated.
+    """
+
+    function: typing.Optional[OpenAiFunction] = pydantic.Field(default=None)
+    """
+    This is the function definition of the tool.
+    
+    For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.
+    
+    An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
+    """
+
+    server: typing.Optional[Server] = pydantic.Field(default=None)
+    """
+    This is the server that will be hit when this tool is requested by the model.
+    
+    All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
+    
+    This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
+    """
+
+    metadata: GhlToolMetadata
+
+    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/ghl_tool_messages_item.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .tool_message_start import ToolMessageStart
+from .tool_message_complete import ToolMessageComplete
+from .tool_message_failed import ToolMessageFailed
+from .tool_message_delayed import ToolMessageDelayed
+
+GhlToolMessagesItem = typing.Union[ToolMessageStart, ToolMessageComplete, ToolMessageFailed, ToolMessageDelayed]

vapi/types/ghl_tool_metadata.py

@@ -0,0 +1,22 @@
+# 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
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GhlToolMetadata(UniversalBaseModel):
+    workflow_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workflowId")] = None
+    location_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="locationId")] = 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/ghl_tool_provider_details.py

@@ -0,0 +1,41 @@
+# 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 .tool_template_setup import ToolTemplateSetup
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GhlToolProviderDetails(UniversalBaseModel):
+    template_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="templateUrl")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the Template URL or the Snapshot URL corresponding to the Template.
+    """
+
+    setup_instructions: typing_extensions.Annotated[
+        typing.Optional[typing.List[ToolTemplateSetup]], FieldMetadata(alias="setupInstructions")
+    ] = None
+    type: typing.Literal["ghl"] = pydantic.Field(default="ghl")
+    """
+    The type of tool. "ghl" for GHL tool.
+    """
+
+    workflow_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workflowId")] = None
+    workflow_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workflowName")] = None
+    webhook_hook_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="webhookHookId")] = None
+    webhook_hook_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="webhookHookName")] = None
+    location_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="locationId")] = 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/ghl_tool_with_tool_call.py

@@ -0,0 +1,69 @@
+# 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 .ghl_tool_with_tool_call_messages_item import GhlToolWithToolCallMessagesItem
+from .tool_call import ToolCall
+from .ghl_tool_metadata import GhlToolMetadata
+from .open_ai_function import OpenAiFunction
+from .server import Server
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GhlToolWithToolCall(UniversalBaseModel):
+    async_: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="async")] = pydantic.Field(
+        default=None
+    )
+    """
+    This determines if the tool is async.
+    
+    If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.
+    
+    If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.
+    
+    Defaults to synchronous (`false`).
+    """
+
+    messages: typing.Optional[typing.List[GhlToolWithToolCallMessagesItem]] = pydantic.Field(default=None)
+    """
+    These are the messages that will be spoken to the user as the tool is running.
+    
+    For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
+    """
+
+    type: typing.Literal["ghl"] = pydantic.Field(default="ghl")
+    """
+    The type of tool. "ghl" for GHL tool.
+    """
+
+    tool_call: typing_extensions.Annotated[ToolCall, FieldMetadata(alias="toolCall")]
+    metadata: GhlToolMetadata
+    function: typing.Optional[OpenAiFunction] = pydantic.Field(default=None)
+    """
+    This is the function definition of the tool.
+    
+    For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.
+    
+    An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
+    """
+
+    server: typing.Optional[Server] = pydantic.Field(default=None)
+    """
+    This is the server that will be hit when this tool is requested by the model.
+    
+    All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
+    
+    This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.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/ghl_tool_with_tool_call_messages_item.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .tool_message_start import ToolMessageStart
+from .tool_message_complete import ToolMessageComplete
+from .tool_message_failed import ToolMessageFailed
+from .tool_message_delayed import ToolMessageDelayed
+
+GhlToolWithToolCallMessagesItem = typing.Union[
+    ToolMessageStart, ToolMessageComplete, ToolMessageFailed, ToolMessageDelayed
+]

vapi/types/gladia_credential.py

@@ -0,0 +1,46 @@
+# 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
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GladiaCredential(UniversalBaseModel):
+    provider: typing.Literal["gladia"] = "gladia"
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")] = 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.
+    """
+
+    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/gladia_transcriber.py

@@ -0,0 +1,56 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .gladia_transcriber_model import GladiaTranscriberModel
+import typing_extensions
+from .gladia_transcriber_language_behaviour import GladiaTranscriberLanguageBehaviour
+from ..core.serialization import FieldMetadata
+from .gladia_transcriber_language import GladiaTranscriberLanguage
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GladiaTranscriber(UniversalBaseModel):
+    provider: typing.Literal["gladia"] = pydantic.Field(default="gladia")
+    """
+    This is the transcription provider that will be used.
+    """
+
+    model: typing.Optional[GladiaTranscriberModel] = None
+    language_behaviour: typing_extensions.Annotated[
+        typing.Optional[GladiaTranscriberLanguageBehaviour], FieldMetadata(alias="languageBehaviour")
+    ] = None
+    language: typing.Optional[GladiaTranscriberLanguage] = pydantic.Field(default=None)
+    """
+    Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.
+    """
+
+    transcription_hint: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="transcriptionHint")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.
+    ⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.
+    """
+
+    prosody: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.
+    """
+
+    audio_enhancer: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="audioEnhancer")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is 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/gladia_transcriber_language.py

@@ -0,0 +1,109 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GladiaTranscriberLanguage = typing.Union[
+    typing.Literal[
+        "af",
+        "sq",
+        "am",
+        "ar",
+        "hy",
+        "as",
+        "az",
+        "ba",
+        "eu",
+        "be",
+        "bn",
+        "bs",
+        "br",
+        "bg",
+        "ca",
+        "zh",
+        "hr",
+        "cs",
+        "da",
+        "nl",
+        "en",
+        "et",
+        "fo",
+        "fi",
+        "fr",
+        "gl",
+        "ka",
+        "de",
+        "el",
+        "gu",
+        "ht",
+        "ha",
+        "haw",
+        "he",
+        "hi",
+        "hu",
+        "is",
+        "id",
+        "it",
+        "ja",
+        "jp",
+        "jv",
+        "kn",
+        "kk",
+        "km",
+        "ko",
+        "lo",
+        "la",
+        "lv",
+        "ln",
+        "lt",
+        "lb",
+        "mk",
+        "mg",
+        "ms",
+        "ml",
+        "mt",
+        "mi",
+        "mr",
+        "mn",
+        "mymr",
+        "ne",
+        "no",
+        "nn",
+        "oc",
+        "ps",
+        "fa",
+        "pl",
+        "pt",
+        "pa",
+        "ro",
+        "ru",
+        "sa",
+        "sr",
+        "sn",
+        "sd",
+        "si",
+        "sk",
+        "sl",
+        "so",
+        "es",
+        "su",
+        "sw",
+        "sv",
+        "tl",
+        "tg",
+        "ta",
+        "tt",
+        "te",
+        "th",
+        "bo",
+        "tr",
+        "tk",
+        "uk",
+        "ur",
+        "uz",
+        "vi",
+        "cy",
+        "yi",
+        "yo",
+    ],
+    typing.Any,
+]

vapi/types/gladia_transcriber_language_behaviour.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GladiaTranscriberLanguageBehaviour = typing.Union[
+    typing.Literal["manual", "automatic single language", "automatic multiple languages"], typing.Any
+]

vapi/types/gladia_transcriber_model.py

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

vapi/types/go_high_level_credential.py

@@ -0,0 +1,46 @@
+# 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
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GoHighLevelCredential(UniversalBaseModel):
+    provider: typing.Literal["gohighlevel"] = "gohighlevel"
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")] = 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.
+    """
+
+    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