telnyx 3.1.0a0__py3-none-any.whl → 3.2.0__py3-none-any.whl

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

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Iterable
+from typing import Dict, Union, Iterable
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
 from .inference_embedding_bucket_ids_param import InferenceEmbeddingBucketIDsParam
 
 __all__ = [
@@ -48,7 +49,7 @@ class ChatCreateCompletionParams(TypedDict, total=False):
     frequency_penalty: float
     """Higher values will penalize the model from repeating the same output tokens."""
 
-    guided_choice: List[str]
+    guided_choice: SequenceNotStr[str]
     """If specified, the output will be exactly one of the choices."""
 
     guided_json: Dict[str, object]

telnyx/types/ai/cluster_compute_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ClusterComputeParams"]
 
 
@@ -16,7 +17,7 @@ class ClusterComputeParams(TypedDict, total=False):
     [embedded](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding).
     """
 
-    files: List[str]
+    files: SequenceNotStr[str]
     """Array of files to filter which are included."""
 
     min_cluster_size: int

telnyx/types/ai/{conversations/message_create_params.py → conversation_add_message_params.py}

@@ -2,21 +2,22 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Iterable
+from typing import Dict, Union, Iterable
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
-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
 
-    metadata: Dict[str, Union[str, int, bool, List[Union[str, int, bool]]]]
+    metadata: Dict[str, Union[str, int, bool, SequenceNotStr[Union[str, int, bool]]]]
 
     name: 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/embedding_list_params.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["EmbeddingListParams"]
 
 
 class EmbeddingListParams(TypedDict, total=False):
-    status: List[str]
+    status: SequenceNotStr[str]
     """List of task statuses i.e. `status=queued&status=processing`"""

telnyx/types/ai/inference_embedding_bucket_ids_param.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["InferenceEmbeddingBucketIDsParam"]
 
 
 class InferenceEmbeddingBucketIDsParam(TypedDict, total=False):
-    bucket_ids: Required[List[str]]
+    bucket_ids: Required[SequenceNotStr[str]]
     """
     List of
     [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)

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

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Iterable
+from typing import Dict, Iterable
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["InferenceEmbeddingWebhookToolParamsParam", "BodyParameters", "Header", "PathParameters", "QueryParameters"]
 
 
@@ -12,7 +14,7 @@ class BodyParameters(TypedDict, total=False):
     properties: Dict[str, object]
     """The properties of the body parameters."""
 
-    required: List[str]
+    required: SequenceNotStr[str]
     """The required properties of the body parameters."""
 
     type: Literal["object"]
@@ -27,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.
     """
 
 
@@ -34,7 +38,7 @@ class PathParameters(TypedDict, total=False):
     properties: Dict[str, object]
     """The properties of the path parameters."""
 
-    required: List[str]
+    required: SequenceNotStr[str]
     """The required properties of the path parameters."""
 
     type: Literal["object"]
@@ -44,7 +48,7 @@ class QueryParameters(TypedDict, total=False):
     properties: Dict[str, object]
     """The properties of the query parameters."""
 
-    required: List[str]
+    required: SequenceNotStr[str]
     """The required properties of the query parameters."""
 
     type: Literal["object"]

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/bundle_pricing/billing_bundle_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["BillingBundleListParams", "Filter", "Page"]
 
 
@@ -27,10 +28,10 @@ class BillingBundleListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""
 
 

telnyx/types/bundle_pricing/user_bundle_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["UserBundleListParams", "Filter", "Page"]
 
 
@@ -27,10 +28,10 @@ class UserBundleListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""
 
 

telnyx/types/bundle_pricing/user_bundle_list_unused_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["UserBundleListUnusedParams", "Filter"]
 
 
@@ -21,8 +22,8 @@ class UserBundleListUnusedParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""

telnyx/types/call_ai_gather_ended_webhook_event.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_event.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