telnyx 3.0.0__py3-none-any.whl

telnyx/types/address_list_params.py

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Literal, TypeAlias, TypedDict
+
+__all__ = [
+    "AddressListParams",
+    "Filter",
+    "FilterAddressBook",
+    "FilterCustomerReference",
+    "FilterCustomerReferenceUnionMember1",
+    "FilterStreetAddress",
+    "Page",
+]
+
+
+class AddressListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[customer_reference][eq],
+    filter[customer_reference][contains], filter[used_as_emergency],
+    filter[street_address][contains], filter[address_book][eq]
+    """
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[number], page[size]
+    """
+
+    sort: Literal["created_at", "first_name", "last_name", "business_name", "street_address"]
+    """Specifies the sort order for results.
+
+    By default sorting direction is ascending. To have the results sorted in
+    descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>
+
+      <li>
+        <code>street_address</code>: sorts the result by the
+        <code>street_address</code> field in ascending order.
+      </li>
+
+      <li>
+        <code>-street_address</code>: sorts the result by the
+        <code>street_address</code> field in descending order.
+      </li>
+    </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
+    """
+
+
+class FilterAddressBook(TypedDict, total=False):
+    eq: str
+    """
+    If present, only returns results with the <code>address_book</code> flag equal
+    to the given value.
+    """
+
+
+class FilterCustomerReferenceUnionMember1(TypedDict, total=False):
+    contains: str
+    """Partial match for customer_reference. Matching is not case-sensitive."""
+
+    eq: str
+    """Exact match for customer_reference."""
+
+
+FilterCustomerReference: TypeAlias = Union[str, FilterCustomerReferenceUnionMember1]
+
+
+class FilterStreetAddress(TypedDict, total=False):
+    contains: str
+    """
+    If present, addresses with <code>street_address</code> containing the given
+    value will be returned. Matching is not case-sensitive. Requires at least three
+    characters.
+    """
+
+
+class Filter(TypedDict, total=False):
+    address_book: FilterAddressBook
+
+    customer_reference: FilterCustomerReference
+    """
+    If present, addresses with <code>customer_reference</code> containing the given
+    value will be returned. Matching is not case-sensitive.
+    """
+
+    street_address: FilterStreetAddress
+
+    used_as_emergency: str
+    """
+    If set as 'true', only addresses used as the emergency address for at least one
+    active phone-number will be returned. When set to 'false', the opposite happens:
+    only addresses not used as the emergency address from phone-numbers will be
+    returned.
+    """
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/address_list_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .address import Address
+from .._models import BaseModel
+from .pagination_meta import PaginationMeta
+
+__all__ = ["AddressListResponse"]
+
+
+class AddressListResponse(BaseModel):
+    data: Optional[List[Address]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/address_retrieve_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .address import Address
+from .._models import BaseModel
+
+__all__ = ["AddressRetrieveResponse"]
+
+
+class AddressRetrieveResponse(BaseModel):
+    data: Optional[Address] = None

telnyx/types/addresses/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .action_validate_params import ActionValidateParams as ActionValidateParams
+from .action_validate_response import ActionValidateResponse as ActionValidateResponse
+from .action_accept_suggestions_params import ActionAcceptSuggestionsParams as ActionAcceptSuggestionsParams
+from .action_accept_suggestions_response import ActionAcceptSuggestionsResponse as ActionAcceptSuggestionsResponse

telnyx/types/addresses/action_accept_suggestions_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ActionAcceptSuggestionsParams"]
+
+
+class ActionAcceptSuggestionsParams(TypedDict, total=False):
+    body_id: Annotated[str, PropertyInfo(alias="id")]
+    """The ID of the address."""

telnyx/types/addresses/action_accept_suggestions_response.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ActionAcceptSuggestionsResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """The UUID of the location."""
+
+    accepted: Optional[bool] = None
+    """Indicates if the address suggestions are accepted."""
+
+    record_type: Optional[Literal["address_suggestion"]] = None
+
+
+class ActionAcceptSuggestionsResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/addresses/action_validate_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionValidateParams"]
+
+
+class ActionValidateParams(TypedDict, total=False):
+    country_code: Required[str]
+    """The two-character (ISO 3166-1 alpha-2) country code of the address."""
+
+    postal_code: Required[str]
+    """The postal code of the address."""
+
+    street_address: Required[str]
+    """The primary street address information about the address."""
+
+    administrative_area: str
+    """The locality of the address.
+
+    For US addresses, this corresponds to the state of the address.
+    """
+
+    extended_address: str
+    """
+    Additional street address information about the address such as, but not limited
+    to, unit number or apartment number.
+    """
+
+    locality: str
+    """The locality of the address.
+
+    For US addresses, this corresponds to the city of the address.
+    """

telnyx/types/addresses/action_validate_response.py

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import TYPE_CHECKING, Dict, List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from ..api_error import APIError
+
+__all__ = ["ActionValidateResponse", "Data", "DataSuggested"]
+
+
+class DataSuggested(BaseModel):
+    administrative_area: Optional[str] = None
+    """The locality of the address.
+
+    For US addresses, this corresponds to the state of the address.
+    """
+
+    country_code: Optional[str] = None
+    """The two-character (ISO 3166-1 alpha-2) country code of the address."""
+
+    extended_address: Optional[str] = None
+    """
+    Additional street address information about the address such as, but not limited
+    to, unit number or apartment number.
+    """
+
+    locality: Optional[str] = None
+    """The locality of the address.
+
+    For US addresses, this corresponds to the city of the address.
+    """
+
+    postal_code: Optional[str] = None
+    """The postal code of the address."""
+
+    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:
+        # 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: ...
+
+
+class Data(BaseModel):
+    result: Literal["valid", "invalid"]
+    """Indicates whether an address is valid or invalid."""
+
+    suggested: DataSuggested
+    """Provides normalized address when available."""
+
+    errors: Optional[List[APIError]] = None
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class ActionValidateResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/advanced_order_create_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["AdvancedOrderCreateParams"]
+
+
+class AdvancedOrderCreateParams(TypedDict, total=False):
+    area_code: str
+
+    comments: str
+
+    country_code: str
+
+    customer_reference: str
+
+    features: List[Literal["sms", "mms", "voice", "fax", "emergency"]]
+
+    phone_number_type: Literal["local", "mobile", "toll_free", "shared_cost", "national", "landline"]
+
+    quantity: int
+
+    requirement_group_id: str
+    """The ID of the requirement group to associate with this advanced order"""

telnyx/types/advanced_order_update_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["AdvancedOrderUpdateParams"]
+
+
+class AdvancedOrderUpdateParams(TypedDict, total=False):
+    area_code: str
+
+    comments: str
+
+    country_code: str
+
+    customer_reference: str
+
+    features: List[Literal["sms", "mms", "voice", "fax", "emergency"]]
+
+    phone_number_type: Literal["local", "mobile", "toll_free", "shared_cost", "national", "landline"]
+
+    quantity: int
+
+    requirement_group_id: str
+    """The ID of the requirement group to associate with this advanced order"""

telnyx/types/ai/__init__.py

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .hangup_tool import HangupTool as HangupTool
+from .conversation import Conversation as Conversation
+from .webhook_tool import WebhookTool as WebhookTool
+from .transfer_tool import TransferTool as TransferTool
+from .assistant_tool import AssistantTool as AssistantTool
+from .retrieval_tool import RetrievalTool as RetrievalTool
+from .voice_settings import VoiceSettings as VoiceSettings
+from .assistant_param import AssistantParam as AssistantParam
+from .assistants_list import AssistantsList as AssistantsList
+from .import_metadata import ImportMetadata as ImportMetadata
+from .enabled_features import EnabledFeatures as EnabledFeatures
+from .insight_settings import InsightSettings as InsightSettings
+from .privacy_settings import PrivacySettings as PrivacySettings
+from .hangup_tool_param import HangupToolParam as HangupToolParam
+from .recursive_cluster import RecursiveCluster as RecursiveCluster
+from .embedding_response import EmbeddingResponse as EmbeddingResponse
+from .hangup_tool_params import HangupToolParams as HangupToolParams
+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 .transfer_tool_param import TransferToolParam as TransferToolParam
+from .assistant_tool_param import AssistantToolParam as AssistantToolParam
+from .embedding_url_params import EmbeddingURLParams as EmbeddingURLParams
+from .retrieval_tool_param import RetrievalToolParam as RetrievalToolParam
+from .voice_settings_param import VoiceSettingsParam as VoiceSettingsParam
+from .assistant_chat_params import AssistantChatParams as AssistantChatParams
+from .cluster_list_response import ClusterListResponse as ClusterListResponse
+from .embedding_list_params import EmbeddingListParams as EmbeddingListParams
+from .background_task_status import BackgroundTaskStatus as BackgroundTaskStatus
+from .cluster_compute_params import ClusterComputeParams as ClusterComputeParams
+from .insight_settings_param import InsightSettingsParam as InsightSettingsParam
+from .privacy_settings_param import PrivacySettingsParam as PrivacySettingsParam
+from .transcription_settings import TranscriptionSettings as TranscriptionSettings
+from .assistant_chat_response import AssistantChatResponse as AssistantChatResponse
+from .assistant_create_params import AssistantCreateParams as AssistantCreateParams
+from .assistant_import_params import AssistantImportParams as AssistantImportParams
+from .assistant_update_params import AssistantUpdateParams as AssistantUpdateParams
+from .audio_transcribe_params import AudioTranscribeParams as AudioTranscribeParams
+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
+from .cluster_retrieve_response import ClusterRetrieveResponse as ClusterRetrieveResponse
+from .cluster_fetch_graph_params import ClusterFetchGraphParams as ClusterFetchGraphParams
+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
+from .transcription_settings_param import TranscriptionSettingsParam as TranscriptionSettingsParam
+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
+from .inference_embedding_webhook_tool_params import (
+    InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams,
+)
+from .inference_embedding_transfer_tool_params import (
+    InferenceEmbeddingTransferToolParams as InferenceEmbeddingTransferToolParams,
+)
+from .inference_embedding_webhook_tool_params_param import (
+    InferenceEmbeddingWebhookToolParamsParam as InferenceEmbeddingWebhookToolParamsParam,
+)
+from .inference_embedding_transfer_tool_params_param import (
+    InferenceEmbeddingTransferToolParamsParam as InferenceEmbeddingTransferToolParamsParam,
+)
+from .conversation_retrieve_conversations_insights_response import (
+    ConversationRetrieveConversationsInsightsResponse as ConversationRetrieveConversationsInsightsResponse,
+)

telnyx/types/ai/assistant_chat_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["AssistantChatParams"]
+
+
+class AssistantChatParams(TypedDict, total=False):
+    content: Required[str]
+    """The message content sent by the client to the assistant"""
+
+    conversation_id: Required[str]
+    """A unique identifier for the conversation thread, used to maintain context"""
+
+    name: str
+    """The optional display name of the user sending the message"""

telnyx/types/ai/assistant_chat_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["AssistantChatResponse"]
+
+
+class AssistantChatResponse(BaseModel):
+    content: str
+    """The assistant's generated response based on the input message and context."""

telnyx/types/ai/assistant_clone_response.py

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+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
+
+__all__ = ["AssistantCloneResponse"]
+
+
+class AssistantCloneResponse(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

telnyx/types/ai/assistant_create_params.py

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Iterable
+from typing_extensions import Required, TypedDict
+
+from .enabled_features import EnabledFeatures
+from .assistant_tool_param import AssistantToolParam
+from .voice_settings_param import VoiceSettingsParam
+from .insight_settings_param import InsightSettingsParam
+from .privacy_settings_param import PrivacySettingsParam
+from .messaging_settings_param import MessagingSettingsParam
+from .telephony_settings_param import TelephonySettingsParam
+from .transcription_settings_param import TranscriptionSettingsParam
+
+__all__ = ["AssistantCreateParams"]
+
+
+class AssistantCreateParams(TypedDict, total=False):
+    instructions: Required[str]
+    """System instructions for the assistant.
+
+    These may be templated with
+    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
+    """
+
+    model: Required[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: Required[str]
+
+    description: str
+
+    dynamic_variables: Dict[str, object]
+    """Map of dynamic variables and their default values"""
+
+    dynamic_variables_webhook_url: str
+    """
+    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: List[EnabledFeatures]
+
+    greeting: str
+    """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)
+    """
+
+    insight_settings: InsightSettingsParam
+
+    llm_api_key_ref: str
+    """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: MessagingSettingsParam
+
+    privacy_settings: PrivacySettingsParam
+
+    telephony_settings: TelephonySettingsParam
+
+    tools: Iterable[AssistantToolParam]
+    """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: TranscriptionSettingsParam
+
+    voice_settings: VoiceSettingsParam