telnyx 3.7.0a0__py3-none-any.whl → 3.9.0__py3-none-any.whl

telnyx/types/ai/__init__.py

@@ -23,6 +23,7 @@ from .messaging_settings import MessagingSettings as MessagingSettings
 from .telephony_settings import TelephonySettings as TelephonySettings
 from .webhook_tool_param import WebhookToolParam as WebhookToolParam
 from .cluster_list_params import ClusterListParams as ClusterListParams
+from .inference_embedding import InferenceEmbedding as InferenceEmbedding
 from .transfer_tool_param import TransferToolParam as TransferToolParam
 from .assistant_tool_param import AssistantToolParam as AssistantToolParam
 from .embedding_url_params import EmbeddingURLParams as EmbeddingURLParams
@@ -44,13 +45,11 @@ from .audio_transcribe_params import AudioTranscribeParams as AudioTranscribePar
 from .cluster_retrieve_params import ClusterRetrieveParams as ClusterRetrieveParams
 from .embedding_create_params import EmbeddingCreateParams as EmbeddingCreateParams
 from .embedding_list_response import EmbeddingListResponse as EmbeddingListResponse
-from .assistant_clone_response import AssistantCloneResponse as AssistantCloneResponse
 from .cluster_compute_response import ClusterComputeResponse as ClusterComputeResponse
 from .conversation_list_params import ConversationListParams as ConversationListParams
 from .hangup_tool_params_param import HangupToolParamsParam as HangupToolParamsParam
 from .messaging_settings_param import MessagingSettingsParam as MessagingSettingsParam
 from .telephony_settings_param import TelephonySettingsParam as TelephonySettingsParam
-from .assistant_create_response import AssistantCreateResponse as AssistantCreateResponse
 from .assistant_delete_response import AssistantDeleteResponse as AssistantDeleteResponse
 from .assistant_retrieve_params import AssistantRetrieveParams as AssistantRetrieveParams
 from .audio_transcribe_response import AudioTranscribeResponse as AudioTranscribeResponse
@@ -59,7 +58,6 @@ from .cluster_fetch_graph_params import ClusterFetchGraphParams as ClusterFetchG
 from .conversation_create_params import ConversationCreateParams as ConversationCreateParams
 from .conversation_list_response import ConversationListResponse as ConversationListResponse
 from .conversation_update_params import ConversationUpdateParams as ConversationUpdateParams
-from .assistant_retrieve_response import AssistantRetrieveResponse as AssistantRetrieveResponse
 from .embedding_retrieve_response import EmbeddingRetrieveResponse as EmbeddingRetrieveResponse
 from .assistant_get_texml_response import AssistantGetTexmlResponse as AssistantGetTexmlResponse
 from .conversation_update_response import ConversationUpdateResponse as ConversationUpdateResponse

telnyx/types/ai/assistant_import_params.py

@@ -15,5 +15,5 @@ class AssistantImportParams(TypedDict, total=False):
     /v2/integration_secrets.
     """
 
-    provider: Required[Literal["elevenlabs", "vapi"]]
+    provider: Required[Literal["elevenlabs", "vapi", "retell"]]
     """The external provider to import assistants from."""

telnyx/types/ai/assistants/__init__.py

@@ -15,11 +15,8 @@ from .version_config_param import VersionConfigParam as VersionConfigParam
 from .version_update_params import VersionUpdateParams as VersionUpdateParams
 from .canary_deploy_response import CanaryDeployResponse as CanaryDeployResponse
 from .version_retrieve_params import VersionRetrieveParams as VersionRetrieveParams
-from .version_update_response import VersionUpdateResponse as VersionUpdateResponse
 from .scheduled_event_response import ScheduledEventResponse as ScheduledEventResponse
-from .version_promote_response import VersionPromoteResponse as VersionPromoteResponse
 from .conversation_channel_type import ConversationChannelType as ConversationChannelType
-from .version_retrieve_response import VersionRetrieveResponse as VersionRetrieveResponse
 from .canary_deploy_create_params import CanaryDeployCreateParams as CanaryDeployCreateParams
 from .canary_deploy_update_params import CanaryDeployUpdateParams as CanaryDeployUpdateParams
 from .scheduled_event_list_params import ScheduledEventListParams as ScheduledEventListParams

telnyx/types/ai/assistants_list.py

@@ -1,96 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
-from datetime import datetime
+from typing import List
 
 from ..._models import BaseModel
-from .assistant_tool import AssistantTool
-from .voice_settings import VoiceSettings
-from .import_metadata import ImportMetadata
-from .enabled_features import EnabledFeatures
-from .insight_settings import InsightSettings
-from .privacy_settings import PrivacySettings
-from .messaging_settings import MessagingSettings
-from .telephony_settings import TelephonySettings
-from .transcription_settings import TranscriptionSettings
+from .inference_embedding import InferenceEmbedding
 
-__all__ = ["AssistantsList", "Data"]
-
-
-class Data(BaseModel):
-    id: str
-
-    created_at: datetime
-
-    instructions: str
-    """System instructions for the assistant.
-
-    These may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    model: str
-    """ID of the model to use.
-
-    You can use the
-    [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
-    to see all of your available models,
-    """
-
-    name: str
-
-    description: Optional[str] = None
-
-    dynamic_variables: Optional[Dict[str, object]] = None
-    """Map of dynamic variables and their values"""
-
-    dynamic_variables_webhook_url: Optional[str] = None
-    """
-    If the dynamic_variables_webhook_url is set for the assistant, we will send a
-    request at the start of the conversation. See our
-    [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    for more information.
-    """
-
-    enabled_features: Optional[List[EnabledFeatures]] = None
-
-    greeting: Optional[str] = None
-    """Text that the assistant will use to start the conversation.
-
-    This may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    import_metadata: Optional[ImportMetadata] = None
-
-    insight_settings: Optional[InsightSettings] = None
-
-    llm_api_key_ref: Optional[str] = None
-    """This is only needed when using third-party inference providers.
-
-    The `identifier` for an integration secret
-    [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-    that refers to your LLM provider's API key. Warning: Free plans are unlikely to
-    work with this integration.
-    """
-
-    messaging_settings: Optional[MessagingSettings] = None
-
-    privacy_settings: Optional[PrivacySettings] = None
-
-    telephony_settings: Optional[TelephonySettings] = None
-
-    tools: Optional[List[AssistantTool]] = None
-    """The tools that the assistant can use.
-
-    These may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    transcription: Optional[TranscriptionSettings] = None
-
-    voice_settings: Optional[VoiceSettings] = None
+__all__ = ["AssistantsList"]
 
 
 class AssistantsList(BaseModel):
-    data: List[Data]
+    data: List[InferenceEmbedding]

telnyx/types/ai/import_metadata.py

@@ -12,5 +12,5 @@ class ImportMetadata(BaseModel):
     import_id: Optional[str] = None
     """ID of the assistant in the provider's system."""
 
-    import_provider: Optional[Literal["elevenlabs", "vapi"]] = None
+    import_provider: Optional[Literal["elevenlabs", "vapi", "retell"]] = None
     """Provider the assistant was imported from."""

telnyx/types/ai/{assistant_clone_response.py → inference_embedding.py}

@@ -14,10 +14,10 @@ from .messaging_settings import MessagingSettings
 from .telephony_settings import TelephonySettings
 from .transcription_settings import TranscriptionSettings
 
-__all__ = ["AssistantCloneResponse"]
+__all__ = ["InferenceEmbedding"]
 
 
-class AssistantCloneResponse(BaseModel):
+class InferenceEmbedding(BaseModel):
     id: str
 
     created_at: datetime

telnyx/types/ai/inference_embedding_transfer_tool_params.py

@@ -41,3 +41,9 @@ class InferenceEmbeddingTransferToolParams(BaseModel):
 
     custom_headers: Optional[List[CustomHeader]] = None
     """Custom headers to be added to the SIP INVITE for the transfer command."""
+
+    warm_transfer_instructions: Optional[str] = None
+    """
+    Natural language instructions for your agent for how to provide context for the
+    transfer recipient.
+    """

telnyx/types/ai/inference_embedding_transfer_tool_params_param.py

@@ -48,3 +48,9 @@ class InferenceEmbeddingTransferToolParamsParam(
 
     custom_headers: Iterable[CustomHeader]
     """Custom headers to be added to the SIP INVITE for the transfer command."""
+
+    warm_transfer_instructions: str
+    """
+    Natural language instructions for your agent for how to provide context for the
+    transfer recipient.
+    """

telnyx/types/ai/voice_settings.py

@@ -1,10 +1,50 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+from typing import Union, Optional
+from typing_extensions import Literal, TypeAlias
 
 from ..._models import BaseModel
 
-__all__ = ["VoiceSettings"]
+__all__ = [
+    "VoiceSettings",
+    "BackgroundAudio",
+    "BackgroundAudioUnionMember0",
+    "BackgroundAudioUnionMember1",
+    "BackgroundAudioUnionMember2",
+]
+
+
+class BackgroundAudioUnionMember0(BaseModel):
+    type: Literal["predefined_media"]
+    """Select from predefined media options."""
+
+    value: Literal["silence", "office"]
+    """The predefined media to use. `silence` disables background audio."""
+
+
+class BackgroundAudioUnionMember1(BaseModel):
+    type: Literal["media_url"]
+    """Provide a direct URL to an MP3 file. The audio will loop during the call."""
+
+    value: str
+    """HTTPS URL to an MP3 file."""
+
+
+class BackgroundAudioUnionMember2(BaseModel):
+    type: Literal["media_name"]
+    """Reference a previously uploaded media by its name from Telnyx Media Storage."""
+
+    value: str
+    """
+    The `name` of a media asset created via
+    [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+    The audio will loop during the call.
+    """
+
+
+BackgroundAudio: TypeAlias = Union[
+    BackgroundAudioUnionMember0, BackgroundAudioUnionMember1, BackgroundAudioUnionMember2
+]
 
 
 class VoiceSettings(BaseModel):
@@ -28,6 +68,13 @@ class VoiceSettings(BaseModel):
     with this integration.
     """
 
+    background_audio: Optional[BackgroundAudio] = None
+    """Optional background audio to play on the call.
+
+    Use a predefined media bed, or supply a looped MP3 URL. If a media URL is chosen
+    in the portal, customers can preview it before saving.
+    """
+
     voice_speed: Optional[float] = None
     """The speed of the voice in the range [0.25, 2.0].
 

telnyx/types/ai/voice_settings_param.py

@@ -2,9 +2,49 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
-__all__ = ["VoiceSettingsParam"]
+__all__ = [
+    "VoiceSettingsParam",
+    "BackgroundAudio",
+    "BackgroundAudioUnionMember0",
+    "BackgroundAudioUnionMember1",
+    "BackgroundAudioUnionMember2",
+]
+
+
+class BackgroundAudioUnionMember0(TypedDict, total=False):
+    type: Required[Literal["predefined_media"]]
+    """Select from predefined media options."""
+
+    value: Required[Literal["silence", "office"]]
+    """The predefined media to use. `silence` disables background audio."""
+
+
+class BackgroundAudioUnionMember1(TypedDict, total=False):
+    type: Required[Literal["media_url"]]
+    """Provide a direct URL to an MP3 file. The audio will loop during the call."""
+
+    value: Required[str]
+    """HTTPS URL to an MP3 file."""
+
+
+class BackgroundAudioUnionMember2(TypedDict, total=False):
+    type: Required[Literal["media_name"]]
+    """Reference a previously uploaded media by its name from Telnyx Media Storage."""
+
+    value: Required[str]
+    """
+    The `name` of a media asset created via
+    [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+    The audio will loop during the call.
+    """
+
+
+BackgroundAudio: TypeAlias = Union[
+    BackgroundAudioUnionMember0, BackgroundAudioUnionMember1, BackgroundAudioUnionMember2
+]
 
 
 class VoiceSettingsParam(TypedDict, total=False):
@@ -28,6 +68,13 @@ class VoiceSettingsParam(TypedDict, total=False):
     with this integration.
     """
 
+    background_audio: BackgroundAudio
+    """Optional background audio to play on the call.
+
+    Use a predefined media bed, or supply a looped MP3 URL. If a media URL is chosen
+    in the portal, customers can preview it before saving.
+    """
+
     voice_speed: float
     """The speed of the voice in the range [0.25, 2.0].
 

telnyx/types/brand_create_params.py

@@ -31,7 +31,8 @@ class BrandCreateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` is `PUBLIC_PROFIT`.
+    Required if `entityType` is `PUBLIC_PROFIT`. Otherwise, it is recommended to
+    either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/brand_update_params.py

@@ -39,7 +39,8 @@ class BrandUpdateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` will be changed to `PUBLIC_PROFIT`.
+    Required if `entityType` will be changed to `PUBLIC_PROFIT`. Otherwise, it is
+    recommended to either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/call_ai_gather_ended_webhook_event1.py

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallAIGatherEndedWebhookEvent", "Data", "DataPayload", "DataPayloadMessageHistory"]
+
+
+class DataPayloadMessageHistory(BaseModel):
+    content: Optional[str] = None
+    """The content of the message"""
+
+    role: Optional[Literal["assistant", "user"]] = None
+    """The role of the message sender"""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Telnyx connection ID used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    message_history: Optional[List[DataPayloadMessageHistory]] = None
+    """The history of the messages exchanged during the AI gather"""
+
+    result: Optional[object] = None
+    """
+    The result of the AI gather, its type depends of the `parameters` provided in
+    the command
+    """
+
+    status: Optional[Literal["valid", "invalid"]] = None
+    """Reflects how command ended."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.ai_gather.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallAIGatherEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_ai_gather_message_history_updated_webhook_event1.py

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallAIGatherMessageHistoryUpdatedWebhookEvent", "Data", "DataPayload", "DataPayloadMessageHistory"]
+
+
+class DataPayloadMessageHistory(BaseModel):
+    content: Optional[str] = None
+    """The content of the message"""
+
+    role: Optional[Literal["assistant", "user"]] = None
+    """The role of the message sender"""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Telnyx connection ID used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    message_history: Optional[List[DataPayloadMessageHistory]] = None
+    """The history of the messages exchanged during the AI gather"""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.ai_gather.message_history_updated"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallAIGatherMessageHistoryUpdatedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_ai_gather_partial_results_webhook_event1.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallAIGatherPartialResultsWebhookEvent", "Data", "DataPayload", "DataPayloadMessageHistory"]
+
+
+class DataPayloadMessageHistory(BaseModel):
+    content: Optional[str] = None
+    """The content of the message"""
+
+    role: Optional[Literal["assistant", "user"]] = None
+    """The role of the message sender"""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Telnyx connection ID used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    message_history: Optional[List[DataPayloadMessageHistory]] = None
+    """The history of the messages exchanged during the AI gather"""
+
+    partial_results: Optional[object] = None
+    """
+    The partial result of the AI gather, its type depends of the `parameters`
+    provided in the command
+    """
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.ai_gather.partial_results"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallAIGatherPartialResultsWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_answered_webhook_event1.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .sip_header import SipHeader
+from .custom_sip_header import CustomSipHeader
+
+__all__ = ["CallAnsweredWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    custom_headers: Optional[List[CustomSipHeader]] = None
+    """Custom headers set on answer command"""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    sip_headers: Optional[List[SipHeader]] = None
+    """User-to-User and Diversion headers from sip invite."""
+
+    start_time: Optional[datetime] = None
+    """ISO 8601 datetime of when the call started."""
+
+    state: Optional[Literal["answered"]] = None
+    """State received from a command."""
+
+    tags: Optional[List[str]] = None
+    """Array of tags associated to number."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.answered"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallAnsweredWebhookEvent(BaseModel):
+    data: Optional[Data] = None