telnyx 3.4.0a0__py3-none-any.whl → 3.5.0__py3-none-any.whl

telnyx/types/__init__.py

@@ -8,9 +8,9 @@ from .ip import IP as IP
 from .fax import Fax as Fax
 from .fqdn import Fqdn as Fqdn
 from .room import Room as Room
-from .error import Error as Error
 from .record import Record as Record
 from .shared import (
+    APIError as APIError,
     Metadata as Metadata,
     ShortCode as ShortCode,
     HostedNumber as HostedNumber,
@@ -38,10 +38,12 @@ from .conference import Conference as Conference
 from .inbound_ip import InboundIP as InboundIP
 from .sip_header import SipHeader as SipHeader
 from .entity_type import EntityType as EntityType
+from .oauth_grant import OAuthGrant as OAuthGrant
 from .outbound_ip import OutboundIP as OutboundIP
 from .task_status import TaskStatus as TaskStatus
 from .inbound_fqdn import InboundFqdn as InboundFqdn
 from .month_detail import MonthDetail as MonthDetail
+from .oauth_client import OAuthClient as OAuthClient
 from .phone_number import PhoneNumber as PhoneNumber
 from .record_param import RecordParam as RecordParam
 from .room_session import RoomSession as RoomSession
@@ -112,6 +114,7 @@ from .ip_delete_response import IPDeleteResponse as IPDeleteResponse
 from .ip_update_response import IPUpdateResponse as IPUpdateResponse
 from .number_block_order import NumberBlockOrder as NumberBlockOrder
 from .number_reservation import NumberReservation as NumberReservation
+from .oauth_token_params import OAuthTokenParams as OAuthTokenParams
 from .porting_order_misc import PortingOrderMisc as PortingOrderMisc
 from .porting_order_type import PortingOrderType as PortingOrderType
 from .rcs_agent_response import RcsAgentResponse as RcsAgentResponse
@@ -138,6 +141,7 @@ from .media_upload_params import MediaUploadParams as MediaUploadParams
 from .message_send_params import MessageSendParams as MessageSendParams
 from .messsage_rcs_params import MesssageRcsParams as MesssageRcsParams
 from .network_list_params import NetworkListParams as NetworkListParams
+from .oauth_grants_params import OAuthGrantsParams as OAuthGrantsParams
 from .outbound_fqdn_param import OutboundFqdnParam as OutboundFqdnParam
 from .portout_list_params import PortoutListParams as PortoutListParams
 from .telnyx_campaign_csp import TelnyxCampaignCsp as TelnyxCampaignCsp
@@ -156,6 +160,7 @@ from .notification_channel import NotificationChannel as NotificationChannel
 from .notification_profile import NotificationProfile as NotificationProfile
 from .notification_setting import NotificationSetting as NotificationSetting
 from .number_pool_settings import NumberPoolSettings as NumberPoolSettings
+from .oauth_token_response import OAuthTokenResponse as OAuthTokenResponse
 from .rcs_suggestion_param import RcsSuggestionParam as RcsSuggestionParam
 from .region_list_response import RegionListResponse as RegionListResponse
 from .room_create_response import RoomCreateResponse as RoomCreateResponse
@@ -178,8 +183,6 @@ from .credential_connection import CredentialConnection as CredentialConnection
 from .fax_retrieve_response import FaxRetrieveResponse as FaxRetrieveResponse
 from .global_ip_list_params import GlobalIPListParams as GlobalIPListParams
 from .invoice_list_response import InvoiceListResponse as InvoiceListResponse
-from .list_buckets_response import ListBucketsResponse as ListBucketsResponse
-from .list_objects_response import ListObjectsResponse as ListObjectsResponse
 from .media_update_response import MediaUpdateResponse as MediaUpdateResponse
 from .media_upload_response import MediaUploadResponse as MediaUploadResponse
 from .message_send_response import MessageSendResponse as MessageSendResponse
@@ -187,6 +190,8 @@ from .messsage_rcs_response import MesssageRcsResponse as MesssageRcsResponse
 from .network_create_params import NetworkCreateParams as NetworkCreateParams
 from .network_list_response import NetworkListResponse as NetworkListResponse
 from .network_update_params import NetworkUpdateParams as NetworkUpdateParams
+from .oauth_grants_response import OAuthGrantsResponse as OAuthGrantsResponse
+from .oauth_register_params import OAuthRegisterParams as OAuthRegisterParams
 from .phone_number_campaign import PhoneNumberCampaign as PhoneNumberCampaign
 from .phone_number_detailed import PhoneNumberDetailed as PhoneNumberDetailed
 from .portout_list_response import PortoutListResponse as PortoutListResponse
@@ -237,6 +242,10 @@ from .message_schedule_params import MessageScheduleParams as MessageSchedulePar
 from .network_create_response import NetworkCreateResponse as NetworkCreateResponse
 from .network_delete_response import NetworkDeleteResponse as NetworkDeleteResponse
 from .network_update_response import NetworkUpdateResponse as NetworkUpdateResponse
+from .oauth_grant_list_params import OAuthGrantListParams as OAuthGrantListParams
+from .oauth_introspect_params import OAuthIntrospectParams as OAuthIntrospectParams
+from .oauth_register_response import OAuthRegisterResponse as OAuthRegisterResponse
+from .oauth_retrieve_response import OAuthRetrieveResponse as OAuthRetrieveResponse
 from .outbound_call_recording import OutboundCallRecording as OutboundCallRecording
 from .porting_order_documents import PortingOrderDocuments as PortingOrderDocuments
 from .porting_order_messaging import PortingOrderMessaging as PortingOrderMessaging
@@ -252,8 +261,6 @@ from .azure_configuration_data import AzureConfigurationData as AzureConfigurati
 from .call_control_application import CallControlApplication as CallControlApplication
 from .call_event_list_response import CallEventListResponse as CallEventListResponse
 from .channel_zone_list_params import ChannelZoneListParams as ChannelZoneListParams
-from .client_get_object_params import ClientGetObjectParams as ClientGetObjectParams
-from .client_put_object_params import ClientPutObjectParams as ClientPutObjectParams
 from .conference_create_params import ConferenceCreateParams as ConferenceCreateParams
 from .conference_list_response import ConferenceListResponse as ConferenceListResponse
 from .connection_list_response import ConnectionListResponse as ConnectionListResponse
@@ -265,6 +272,7 @@ from .document_upload_response import DocumentUploadResponse as DocumentUploadRe
 from .fax_failed_webhook_event import FaxFailedWebhookEvent as FaxFailedWebhookEvent
 from .fax_queued_webhook_event import FaxQueuedWebhookEvent as FaxQueuedWebhookEvent
 from .number_order_list_params import NumberOrderListParams as NumberOrderListParams
+from .oauth_client_list_params import OAuthClientListParams as OAuthClientListParams
 from .ota_update_list_response import OtaUpdateListResponse as OtaUpdateListResponse
 from .outbound_message_payload import OutboundMessagePayload as OutboundMessagePayload
 from .phone_number_list_params import PhoneNumberListParams as PhoneNumberListParams
@@ -296,6 +304,8 @@ from .message_retrieve_response import MessageRetrieveResponse as MessageRetriev
 from .message_schedule_response import MessageScheduleResponse as MessageScheduleResponse
 from .network_retrieve_response import NetworkRetrieveResponse as NetworkRetrieveResponse
 from .number_order_phone_number import NumberOrderPhoneNumber as NumberOrderPhoneNumber
+from .oauth_grant_list_response import OAuthGrantListResponse as OAuthGrantListResponse
+from .oauth_introspect_response import OAuthIntrospectResponse as OAuthIntrospectResponse
 from .porting_order_list_params import PortingOrderListParams as PortingOrderListParams
 from .porting_order_requirement import PortingOrderRequirement as PortingOrderRequirement
 from .portout_retrieve_response import PortoutRetrieveResponse as PortoutRetrieveResponse
@@ -309,7 +319,6 @@ from .access_ip_address_response import AccessIPAddressResponse as AccessIPAddre
 from .call_bridged_webhook_event import CallBridgedWebhookEvent as CallBridgedWebhookEvent
 from .channel_zone_list_response import ChannelZoneListResponse as ChannelZoneListResponse
 from .channel_zone_update_params import ChannelZoneUpdateParams as ChannelZoneUpdateParams
-from .client_list_objects_params import ClientListObjectsParams as ClientListObjectsParams
 from .conference_create_response import ConferenceCreateResponse as ConferenceCreateResponse
 from .document_retrieve_response import DocumentRetrieveResponse as DocumentRetrieveResponse
 from .dynamic_emergency_endpoint import DynamicEmergencyEndpoint as DynamicEmergencyEndpoint
@@ -319,6 +328,9 @@ from .number_order_create_params import NumberOrderCreateParams as NumberOrderCr
 from .number_order_list_response import NumberOrderListResponse as NumberOrderListResponse
 from .number_order_update_params import NumberOrderUpdateParams as NumberOrderUpdateParams
 from .number_pool_settings_param import NumberPoolSettingsParam as NumberPoolSettingsParam
+from .oauth_client_create_params import OAuthClientCreateParams as OAuthClientCreateParams
+from .oauth_client_list_response import OAuthClientListResponse as OAuthClientListResponse
+from .oauth_client_update_params import OAuthClientUpdateParams as OAuthClientUpdateParams
 from .phone_number_list_response import PhoneNumberListResponse as PhoneNumberListResponse
 from .phone_number_update_params import PhoneNumberUpdateParams as PhoneNumberUpdateParams
 from .room_recording_list_params import RoomRecordingListParams as RoomRecordingListParams
@@ -341,7 +353,6 @@ from .billing_group_update_params import BillingGroupUpdateParams as BillingGrou
 from .brand_get_feedback_response import BrandGetFeedbackResponse as BrandGetFeedbackResponse
 from .call_answered_webhook_event import CallAnsweredWebhookEvent as CallAnsweredWebhookEvent
 from .call_enqueued_webhook_event import CallEnqueuedWebhookEvent as CallEnqueuedWebhookEvent
-from .client_create_bucket_params import ClientCreateBucketParams as ClientCreateBucketParams
 from .detail_record_list_response import DetailRecordListResponse as DetailRecordListResponse
 from .document_link_list_response import DocumentLinkListResponse as DocumentLinkListResponse
 from .fax_application_list_params import FaxApplicationListParams as FaxApplicationListParams
@@ -353,6 +364,7 @@ from .ip_connection_list_response import IPConnectionListResponse as IPConnectio
 from .ip_connection_update_params import IPConnectionUpdateParams as IPConnectionUpdateParams
 from .ledger_billing_group_report import LedgerBillingGroupReport as LedgerBillingGroupReport
 from .managed_account_list_params import ManagedAccountListParams as ManagedAccountListParams
+from .oauth_grant_delete_response import OAuthGrantDeleteResponse as OAuthGrantDeleteResponse
 from .porting_order_create_params import PortingOrderCreateParams as PortingOrderCreateParams
 from .porting_order_list_response import PortingOrderListResponse as PortingOrderListResponse
 from .porting_order_update_params import PortingOrderUpdateParams as PortingOrderUpdateParams
@@ -363,11 +375,9 @@ from .s3_configuration_data_param import S3ConfigurationDataParam as S3Configura
 from .transcription_webhook_event import TranscriptionWebhookEvent as TranscriptionWebhookEvent
 from .verified_number_list_params import VerifiedNumberListParams as VerifiedNumberListParams
 from .advanced_order_create_params import AdvancedOrderCreateParams as AdvancedOrderCreateParams
-from .advanced_order_update_params import AdvancedOrderUpdateParams as AdvancedOrderUpdateParams
 from .call_initiated_webhook_event import CallInitiatedWebhookEvent as CallInitiatedWebhookEvent
 from .campaign_deactivate_response import CampaignDeactivateResponse as CampaignDeactivateResponse
 from .channel_zone_update_response import ChannelZoneUpdateResponse as ChannelZoneUpdateResponse
-from .client_delete_objects_params import ClientDeleteObjectsParams as ClientDeleteObjectsParams
 from .conference_retrieve_response import ConferenceRetrieveResponse as ConferenceRetrieveResponse
 from .connection_retrieve_response import ConnectionRetrieveResponse as ConnectionRetrieveResponse
 from .create_verification_response import CreateVerificationResponse as CreateVerificationResponse
@@ -377,6 +387,9 @@ from .messaging_optout_list_params import MessagingOptoutListParams as Messaging
 from .network_coverage_list_params import NetworkCoverageListParams as NetworkCoverageListParams
 from .number_order_create_response import NumberOrderCreateResponse as NumberOrderCreateResponse
 from .number_order_update_response import NumberOrderUpdateResponse as NumberOrderUpdateResponse
+from .oauth_client_create_response import OAuthClientCreateResponse as OAuthClientCreateResponse
+from .oauth_client_update_response import OAuthClientUpdateResponse as OAuthClientUpdateResponse
+from .oauth_retrieve_jwks_response import OAuthRetrieveJwksResponse as OAuthRetrieveJwksResponse
 from .ota_update_retrieve_response import OtaUpdateRetrieveResponse as OtaUpdateRetrieveResponse
 from .partner_campaign_list_params import PartnerCampaignListParams as PartnerCampaignListParams
 from .phone_number_delete_response import PhoneNumberDeleteResponse as PhoneNumberDeleteResponse
@@ -437,6 +450,7 @@ from .message_send_long_code_params import MessageSendLongCodeParams as MessageS
 from .messaging_profile_list_params import MessagingProfileListParams as MessagingProfileListParams
 from .number_lookup_retrieve_params import NumberLookupRetrieveParams as NumberLookupRetrieveParams
 from .numbers_feature_create_params import NumbersFeatureCreateParams as NumbersFeatureCreateParams
+from .oauth_grant_retrieve_response import OAuthGrantRetrieveResponse as OAuthGrantRetrieveResponse
 from .outbound_call_recording_param import OutboundCallRecordingParam as OutboundCallRecordingParam
 from .phone_number_slim_list_params import PhoneNumberSlimListParams as PhoneNumberSlimListParams
 from .porting_order_create_response import PortingOrderCreateResponse as PortingOrderCreateResponse
@@ -465,6 +479,7 @@ from .notification_event_list_params import NotificationEventListParams as Notif
 from .number_block_order_list_params import NumberBlockOrderListParams as NumberBlockOrderListParams
 from .number_order_retrieve_response import NumberOrderRetrieveResponse as NumberOrderRetrieveResponse
 from .number_reservation_list_params import NumberReservationListParams as NumberReservationListParams
+from .oauth_client_retrieve_response import OAuthClientRetrieveResponse as OAuthClientRetrieveResponse
 from .partner_campaign_list_response import PartnerCampaignListResponse as PartnerCampaignListResponse
 from .partner_campaign_update_params import PartnerCampaignUpdateParams as PartnerCampaignUpdateParams
 from .phone_number_retrieve_response import PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse
@@ -522,6 +537,7 @@ from .messaging_profile_update_params import MessagingProfileUpdateParams as Mes
 from .number_lookup_retrieve_response import NumberLookupRetrieveResponse as NumberLookupRetrieveResponse
 from .number_order_with_phone_numbers import NumberOrderWithPhoneNumbers as NumberOrderWithPhoneNumbers
 from .numbers_feature_create_response import NumbersFeatureCreateResponse as NumbersFeatureCreateResponse
+from .oauth_retrieve_authorize_params import OAuthRetrieveAuthorizeParams as OAuthRetrieveAuthorizeParams
 from .phone_number_slim_list_response import PhoneNumberSlimListResponse as PhoneNumberSlimListResponse
 from .porting_order_end_user_location import PortingOrderEndUserLocation as PortingOrderEndUserLocation
 from .porting_order_retrieve_response import PortingOrderRetrieveResponse as PortingOrderRetrieveResponse
@@ -794,6 +810,12 @@ from .text_to_speech_generate_speech_params import TextToSpeechGenerateSpeechPar
 from .verification_trigger_flashcall_params import (
     VerificationTriggerFlashcallParams as VerificationTriggerFlashcallParams,
 )
+from .verify_profile_create_template_params import (
+    VerifyProfileCreateTemplateParams as VerifyProfileCreateTemplateParams,
+)
+from .verify_profile_update_template_params import (
+    VerifyProfileUpdateTemplateParams as VerifyProfileUpdateTemplateParams,
+)
 from .virtual_cross_connect_create_response import (
     VirtualCrossConnectCreateResponse as VirtualCrossConnectCreateResponse,
 )
@@ -932,6 +954,12 @@ from .sim_card_order_preview_preview_response import (
 from .sub_number_order_regulatory_requirement import (
     SubNumberOrderRegulatoryRequirement as SubNumberOrderRegulatoryRequirement,
 )
+from .verify_profile_create_template_response import (
+    VerifyProfileCreateTemplateResponse as VerifyProfileCreateTemplateResponse,
+)
+from .verify_profile_update_template_response import (
+    VerifyProfileUpdateTemplateResponse as VerifyProfileUpdateTemplateResponse,
+)
 from .virtual_cross_connect_retrieve_response import (
     VirtualCrossConnectRetrieveResponse as VirtualCrossConnectRetrieveResponse,
 )
@@ -989,6 +1017,9 @@ from .regulatory_requirement_retrieve_response import (
 from .sub_number_orders_report_create_response import (
     SubNumberOrdersReportCreateResponse as SubNumberOrdersReportCreateResponse,
 )
+from .verify_profile_message_template_response import (
+    VerifyProfileMessageTemplateResponse as VerifyProfileMessageTemplateResponse,
+)
 from .authentication_provider_retrieve_response import (
     AuthenticationProviderRetrieveResponse as AuthenticationProviderRetrieveResponse,
 )
@@ -1175,6 +1206,9 @@ from .seti_retrieve_black_box_test_results_response import (
 from .virtual_cross_connects_coverage_list_response import (
     VirtualCrossConnectsCoverageListResponse as VirtualCrossConnectsCoverageListResponse,
 )
+from .advanced_order_update_requirement_group_params import (
+    AdvancedOrderUpdateRequirementGroupParams as AdvancedOrderUpdateRequirementGroupParams,
+)
 from .porting_order_phone_number_configuration_param import (
     PortingOrderPhoneNumberConfigurationParam as PortingOrderPhoneNumberConfigurationParam,
 )
@@ -1295,9 +1329,15 @@ from .phone_numbers_regulatory_requirement_retrieve_response import (
 from .messaging_hosted_number_order_check_eligibility_response import (
     MessagingHostedNumberOrderCheckEligibilityResponse as MessagingHostedNumberOrderCheckEligibilityResponse,
 )
+from .well_known_retrieve_protected_resource_metadata_response import (
+    WellKnownRetrieveProtectedResourceMetadataResponse as WellKnownRetrieveProtectedResourceMetadataResponse,
+)
 from .number_order_phone_number_update_requirement_group_params import (
     NumberOrderPhoneNumberUpdateRequirementGroupParams as NumberOrderPhoneNumberUpdateRequirementGroupParams,
 )
+from .well_known_retrieve_authorization_server_metadata_response import (
+    WellKnownRetrieveAuthorizationServerMetadataResponse as WellKnownRetrieveAuthorizationServerMetadataResponse,
+)
 from .customer_service_record_verify_phone_number_coverage_params import (
     CustomerServiceRecordVerifyPhoneNumberCoverageParams as CustomerServiceRecordVerifyPhoneNumberCoverageParams,
 )

telnyx/types/addresses/action_validate_response.py

@@ -5,8 +5,8 @@ from typing_extensions import Literal
 
 from pydantic import Field as FieldInfo
 
-from ..error import Error
 from ..._models import BaseModel
+from ..shared.api_error import APIError
 
 __all__ = ["ActionValidateResponse", "Data", "DataSuggested"]
 
@@ -39,12 +39,17 @@ class DataSuggested(BaseModel):
     street_address: Optional[str] = None
     """The primary street address information about the address."""
 
-    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
     if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
         # Stub to indicate that arbitrary properties are accepted.
         # To access properties that are not valid identifiers you can use `getattr`, e.g.
         # `getattr(obj, '$type')`
         def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
 
 
 class Data(BaseModel):
@@ -54,7 +59,7 @@ class Data(BaseModel):
     suggested: DataSuggested
     """Provides normalized address when available."""
 
-    errors: Optional[List[Error]] = None
+    errors: Optional[List[APIError]] = None
 
     record_type: Optional[str] = None
     """Identifies the type of the resource."""

telnyx/types/{advanced_order_update_params.py → advanced_order_update_requirement_group_params.py}

@@ -5,10 +5,10 @@ from __future__ import annotations
 from typing import List
 from typing_extensions import Literal, TypedDict
 
-__all__ = ["AdvancedOrderUpdateParams"]
+__all__ = ["AdvancedOrderUpdateRequirementGroupParams"]
 
 
-class AdvancedOrderUpdateParams(TypedDict, total=False):
+class AdvancedOrderUpdateRequirementGroupParams(TypedDict, total=False):
     area_code: str
 
     comments: str

telnyx/types/ai/__init__.py

@@ -67,6 +67,7 @@ from .transcription_settings_param import TranscriptionSettingsParam as Transcri
 from .chat_create_completion_params import ChatCreateCompletionParams as ChatCreateCompletionParams
 from .conversation_retrieve_response import ConversationRetrieveResponse as ConversationRetrieveResponse
 from .inference_embedding_bucket_ids import InferenceEmbeddingBucketIDs as InferenceEmbeddingBucketIDs
+from .conversation_add_message_params import ConversationAddMessageParams as ConversationAddMessageParams
 from .embedding_similarity_search_params import EmbeddingSimilaritySearchParams as EmbeddingSimilaritySearchParams
 from .embedding_similarity_search_response import EmbeddingSimilaritySearchResponse as EmbeddingSimilaritySearchResponse
 from .inference_embedding_bucket_ids_param import InferenceEmbeddingBucketIDsParam as InferenceEmbeddingBucketIDsParam

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/{conversations/message_create_params.py → conversation_add_message_params.py}

@@ -6,13 +6,13 @@ from typing import Dict, Union, Iterable
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
-from ...._types import SequenceNotStr
-from ...._utils import PropertyInfo
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
 
-__all__ = ["MessageCreateParams"]
+__all__ = ["ConversationAddMessageParams"]
 
 
-class MessageCreateParams(TypedDict, total=False):
+class ConversationAddMessageParams(TypedDict, total=False):
     role: Required[str]
 
     content: str

telnyx/types/ai/conversations/__init__.py

@@ -7,7 +7,6 @@ from .insight_list_params import InsightListParams as InsightListParams
 from .insight_create_params import InsightCreateParams as InsightCreateParams
 from .insight_list_response import InsightListResponse as InsightListResponse
 from .insight_update_params import InsightUpdateParams as InsightUpdateParams
-from .message_create_params import MessageCreateParams as MessageCreateParams
 from .message_list_response import MessageListResponse as MessageListResponse
 from .insight_template_group import InsightTemplateGroup as InsightTemplateGroup
 from .insight_template_detail import InsightTemplateDetail as InsightTemplateDetail

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/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/inference_embedding_webhook_tool_params.py

@@ -27,6 +27,8 @@ class Header(BaseModel):
     Note that we support mustache templating for the value. For example you can use
     `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
     value of the integration secret as the bearer token.
+    [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
+    will be automatically added to the request.
     """
 
 

telnyx/types/ai/inference_embedding_webhook_tool_params_param.py

@@ -29,6 +29,8 @@ class Header(TypedDict, total=False):
     Note that we support mustache templating for the value. For example you can use
     `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
     value of the integration secret as the bearer token.
+    [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
+    will be automatically added to the request.
     """
 
 

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_dial_params.py

@@ -139,6 +139,14 @@ class CallDialParams(TypedDict, total=False):
     WAV or MP3 file.
     """
 
+    park_after_unbridge: str
+    """If supplied with the value `self`, the current leg will be parked after
+    unbridge.
+
+    If not set, the default behavior is to hang up the leg. When park_after_unbridge
+    is set, link_to becomes required.
+    """
+
     preferred_codecs: str
     """
     The list of comma-separated codecs in a preferred order for the forked media to
@@ -225,7 +233,7 @@ class CallDialParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
-    stream_bidirectional_sampling_rate: Literal[8000, 16000, 48000]
+    stream_bidirectional_sampling_rate: Literal[8000, 16000, 22050, 24000, 48000]
     """Audio sampling rate."""
 
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
@@ -235,8 +243,7 @@ class CallDialParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_establish_before_call_originate: bool

telnyx/types/calls/action_answer_params.py

@@ -124,8 +124,7 @@ class ActionAnswerParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]

telnyx/types/calls/action_gather_using_ai_params.py

@@ -67,20 +67,17 @@ class ActionGatherUsingAIParams(TypedDict, total=False):
     """Default is `false`.
 
     If set to `true`, the voice assistant will send updates to the message history
-    via the `call.ai_gather.message_history_updated`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as the message history is updated.
+    via the `call.ai_gather.message_history_updated` callback in real time as the
+    message history is updated.
     """
 
     send_partial_results: bool
     """Default is `false`.
 
     If set to `true`, the voice assistant will send partial results via the
-    `call.ai_gather.partial_results`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as individual fields are gathered. If set to `false`, the voice
-    assistant will only send the final result via the `call.ai_gather.ended`
-    callback.
+    `call.ai_gather.partial_results` callback in real time as individual fields are
+    gathered. If set to `false`, the voice assistant will only send the final result
+    via the `call.ai_gather.ended` callback.
     """
 
     transcription: TranscriptionConfigParam

telnyx/types/calls/action_start_streaming_params.py

@@ -41,6 +41,9 @@ class ActionStartStreamingParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
+    stream_bidirectional_sampling_rate: Literal[8000, 16000, 22050, 24000, 48000]
+    """Audio sampling rate."""
+
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
     """Specifies which call legs should receive the bidirectional stream audio."""
 
@@ -48,8 +51,7 @@ class ActionStartStreamingParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]