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

vapi/types/groq_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 GroqCredential(UniversalBaseModel):
+    provider: typing.Literal["groq"] = "groq"
+    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/groq_model.py

@@ -0,0 +1,91 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .open_ai_message import OpenAiMessage
+import pydantic
+from .groq_model_tools_item import GroqModelToolsItem
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .groq_model_model import GroqModelModel
+from .knowledge_base import KnowledgeBase
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GroqModel(UniversalBaseModel):
+    messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
+    """
+    This is the starting state for the conversation.
+    """
+
+    tools: typing.Optional[typing.List[GroqModelToolsItem]] = pydantic.Field(default=None)
+    """
+    These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.
+    
+    Both `tools` and `toolIds` can be used together.
+    """
+
+    tool_ids: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="toolIds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    These are the tools that the assistant can use during the call. To use transient tools, use `tools`.
+    
+    Both `tools` and `toolIds` can be used together.
+    """
+
+    model: GroqModelModel = pydantic.Field()
+    """
+    This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
+    """
+
+    provider: typing.Literal["groq"] = "groq"
+    temperature: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.
+    """
+
+    knowledge_base: typing_extensions.Annotated[
+        typing.Optional[KnowledgeBase], FieldMetadata(alias="knowledgeBase")
+    ] = pydantic.Field(default=None)
+    """
+    These are the options for the knowledge base.
+    """
+
+    max_tokens: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="maxTokens")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.
+    """
+
+    emotion_recognition_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="emotionRecognitionEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether we detect user's emotion while they speak and send it as an additional info to model.
+    
+    Default `false` because the model is usually are good at understanding the user's emotion from text.
+    
+    @default false
+    """
+
+    num_fast_turns: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="numFastTurns")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.
+    
+    Default is 0.
+    
+    @default 0
+    """
+
+    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/groq_model_model.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GroqModelModel = typing.Union[
+    typing.Literal[
+        "llama-3.1-405b-reasoning",
+        "llama-3.1-70b-versatile",
+        "llama-3.1-8b-instant",
+        "mixtral-8x7b-32768",
+        "llama3-8b-8192",
+        "llama3-70b-8192",
+        "llama3-groq-8b-8192-tool-use-preview",
+        "llama3-groq-70b-8192-tool-use-preview",
+        "gemma-7b-it",
+        "gemma2-9b-it",
+    ],
+    typing.Any,
+]

vapi/types/groq_model_tools_item.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .create_dtmf_tool_dto import CreateDtmfToolDto
+from .create_end_call_tool_dto import CreateEndCallToolDto
+from .create_voicemail_tool_dto import CreateVoicemailToolDto
+from .create_function_tool_dto import CreateFunctionToolDto
+from .create_ghl_tool_dto import CreateGhlToolDto
+from .create_make_tool_dto import CreateMakeToolDto
+from .create_transfer_call_tool_dto import CreateTransferCallToolDto
+
+GroqModelToolsItem = typing.Union[
+    CreateDtmfToolDto,
+    CreateEndCallToolDto,
+    CreateVoicemailToolDto,
+    CreateFunctionToolDto,
+    CreateGhlToolDto,
+    CreateMakeToolDto,
+    CreateTransferCallToolDto,
+]

vapi/types/handoff_step.py

@@ -0,0 +1,116 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .step_destination import StepDestination
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class HandoffStep(UniversalBaseModel):
+    block: typing.Optional["HandoffStepBlock"] = pydantic.Field(default=None)
+    """
+    This is the block to use. To use an existing block, use `blockId`.
+    """
+
+    type: typing.Literal["handoff"] = pydantic.Field(default="handoff")
+    """
+    This is a step that takes a handoff from the previous step. This means it won't return to the calling step. The workflow execution will continue linearly.
+    
+    Use case:
+    
+    - You want to collect information linearly (e.g. a form, provide information, etc).
+    """
+
+    destinations: typing.Optional[typing.List[StepDestination]] = pydantic.Field(default=None)
+    """
+    These are the destinations that the step can go to after it's done.
+    """
+
+    name: str = pydantic.Field()
+    """
+    This is the name of the step.
+    """
+
+    block_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="blockId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the id of the block to use. To use a transient block, use `block`.
+    """
+
+    input: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is the input to the block. You can use any key-value map as input to the block.
+    
+    Example:
+    {
+    "name": "John Doe",
+    "age": 20
+    }
+    
+    You can reference any variable in the context of the current block:
+    
+    - "{{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
+    
+    Example:
+    {
+    "name": "{{my-tool-call-step.output.name}}",
+    "age": "{{my-tool-call-step.input.age}}",
+    "date": "{{workflow.input.date}}"
+    }
+    
+    You can dynamically change the key name.
+    
+    Example:
+    {
+    "{{my-tool-call-step.output.key-name-for-name}}": "{{name}}",
+    "{{my-tool-call-step.input.key-name-for-age}}": "{{age}}",
+    "{{workflow.input.key-name-for-date}}": "{{date}}"
+    }
+    
+    You can represent the value as a string, number, boolean, array, or object.
+    
+    Example:
+    {
+    "name": "john",
+    "age": 20,
+    "date": "2021-01-01",
+    "metadata": {
+    "unique-key": "{{my-tool-call-step.output.unique-key}}"
+    },
+    "array": ["A", "B", "C"],
+    }
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.input/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.input/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.
+    """
+
+    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
+
+
+from .callback_step import CallbackStep  # noqa: E402
+from .create_workflow_block_dto import CreateWorkflowBlockDto  # noqa: E402
+from .handoff_step_block import HandoffStepBlock  # noqa: E402
+
+update_forward_refs(CallbackStep, HandoffStep=HandoffStep)
+update_forward_refs(CreateWorkflowBlockDto, HandoffStep=HandoffStep)
+update_forward_refs(HandoffStep)

vapi/types/handoff_step_block.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+import typing
+from .create_conversation_block_dto import CreateConversationBlockDto
+from .create_tool_call_block_dto import CreateToolCallBlockDto
+import typing
+
+if typing.TYPE_CHECKING:
+    from .create_workflow_block_dto import CreateWorkflowBlockDto
+HandoffStepBlock = typing.Union[CreateConversationBlockDto, CreateToolCallBlockDto, "CreateWorkflowBlockDto"]

vapi/types/import_twilio_phone_number_dto.py

@@ -0,0 +1,91 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .import_twilio_phone_number_dto_fallback_destination import ImportTwilioPhoneNumberDtoFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ImportTwilioPhoneNumberDto(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[ImportTwilioPhoneNumberDtoFallbackDestination], 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.
+    """
+
+    twilio_phone_number: typing_extensions.Annotated[str, FieldMetadata(alias="twilioPhoneNumber")] = pydantic.Field()
+    """
+    These are the digits of the phone number you own on your Twilio.
+    """
+
+    twilio_account_sid: typing_extensions.Annotated[str, FieldMetadata(alias="twilioAccountSid")] = pydantic.Field()
+    """
+    This is your Twilio Account SID that will be used to handle this phone number.
+    """
+
+    twilio_auth_token: typing_extensions.Annotated[str, FieldMetadata(alias="twilioAuthToken")] = pydantic.Field()
+    """
+    This is the Twilio Auth Token that will be used to handle this phone number.
+    """
+
+    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/import_twilio_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
+
+ImportTwilioPhoneNumberDtoFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/import_vonage_phone_number_dto.py

@@ -0,0 +1,88 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .import_vonage_phone_number_dto_fallback_destination import ImportVonagePhoneNumberDtoFallbackDestination
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ImportVonagePhoneNumberDto(UniversalBaseModel):
+    fallback_destination: typing_extensions.Annotated[
+        typing.Optional[ImportVonagePhoneNumberDtoFallbackDestination], 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.
+    """
+
+    vonage_phone_number: typing_extensions.Annotated[str, FieldMetadata(alias="vonagePhoneNumber")] = pydantic.Field()
+    """
+    These are the digits of the phone number you own on your Vonage.
+    """
+
+    credential_id: typing_extensions.Annotated[str, FieldMetadata(alias="credentialId")] = pydantic.Field()
+    """
+    This is the credential that is used to make outgoing calls, and do operations like call transfer and hang up.
+    
+    You can add the Vonage 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/import_vonage_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
+
+ImportVonagePhoneNumberDtoFallbackDestination = typing.Union[TransferDestinationNumber, TransferDestinationSip]

vapi/types/invite_user_dto.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .invite_user_dto_role import InviteUserDtoRole
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class InviteUserDto(UniversalBaseModel):
+    email: str
+    role: InviteUserDtoRole
+
+    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/invite_user_dto_role.py

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

vapi/types/json_schema.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .json_schema_type import JsonSchemaType
+import pydantic
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class JsonSchema(UniversalBaseModel):
+    type: JsonSchemaType = pydantic.Field()
+    """
+    This is the type of output you'd like.
+    
+    `string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.
+    
+    `array` and `object` are more interesting and quite powerful. They allow you to define nested structures.
+    
+    For `array`, you can define the schema of the items in the array using the `items` property.
+    
+    For `object`, you can define the properties of the object using the `properties` property.
+    """
+
+    items: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is required if the type is "array". This is the schema of the items in the array.
+    
+    This is of type JsonSchema. However, Swagger doesn't support circular references.
+    """
+
+    properties: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    This is required if the type is "object". This specifies the properties of the object.
+    
+    This is a map of string to JsonSchema. However, Swagger doesn't support circular references.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the description to help the model understand what it needs to output.
+    """
+
+    required: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    This is a list of properties that are required.
+    
+    This only makes sense if the type is "object".
+    """
+
+    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/json_schema_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+JsonSchemaType = typing.Union[typing.Literal["string", "number", "integer", "boolean", "array", "object"], typing.Any]

vapi/types/knowledge_base.py

@@ -0,0 +1,23 @@
+# 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
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class KnowledgeBase(UniversalBaseModel):
+    provider: typing.Literal["canonical"] = "canonical"
+    top_k: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="topK")] = None
+    file_ids: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="fileIds")]
+
+    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/lmnt_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 LmntCredential(UniversalBaseModel):
+    provider: typing.Literal["lmnt"] = "lmnt"
+    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