telnyx 4.5.0__py3-none-any.whl

telnyx/types/transcription_webhook_event1.py

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["TranscriptionWebhookEvent", "Data", "DataPayload", "DataPayloadTranscriptionData"]
+
+
+class DataPayloadTranscriptionData(BaseModel):
+    confidence: Optional[float] = None
+    """Speech recognition confidence level."""
+
+    is_final: Optional[bool] = None
+    """When false, it means that this is an interim result."""
+
+    transcript: Optional[str] = None
+    """Recognized text."""
+
+    transcription_track: Optional[Literal["inbound", "outbound"]] = None
+    """Indicates which leg of the call has been transcribed.
+
+    This is only available when `transcription_engine` is set to `B`.
+    """
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Unique identifier and token for controlling the call."""
+
+    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
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    transcription_data: Optional[DataPayloadTranscriptionData] = None
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.transcription"]] = 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 TranscriptionWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/transport_protocol.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["TransportProtocol"]
+
+TransportProtocol: TypeAlias = Literal["UDP", "TCP", "TLS"]

telnyx/types/unsafe_unwrap_webhook_event.py

@@ -0,0 +1,130 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .fax_failed_webhook_event import FaxFailedWebhookEvent
+from .fax_queued_webhook_event import FaxQueuedWebhookEvent
+from .call_hangup_webhook_event import CallHangupWebhookEvent
+from .call_bridged_webhook_event import CallBridgedWebhookEvent
+from .call_answered_webhook_event import CallAnsweredWebhookEvent
+from .call_enqueued_webhook_event import CallEnqueuedWebhookEvent
+from .fax_delivered_webhook_event import FaxDeliveredWebhookEvent
+from .transcription_webhook_event import TranscriptionWebhookEvent
+from .call_initiated_webhook_event import CallInitiatedWebhookEvent
+from .call_left_queue_webhook_event import CallLeftQueueWebhookEvent
+from .delivery_update_webhook_event import DeliveryUpdateWebhookEvent
+from .inbound_message_webhook_event import InboundMessageWebhookEvent
+from .call_speak_ended_webhook_event import CallSpeakEndedWebhookEvent
+from .conference_ended_webhook_event import ConferenceEndedWebhookEvent
+from .call_fork_started_webhook_event import CallForkStartedWebhookEvent
+from .call_fork_stopped_webhook_event import CallForkStoppedWebhookEvent
+from .call_gather_ended_webhook_event import CallGatherEndedWebhookEvent
+from .call_refer_failed_webhook_event import CallReferFailedWebhookEvent
+from .call_dtmf_received_webhook_event import CallDtmfReceivedWebhookEvent
+from .call_refer_started_webhook_event import CallReferStartedWebhookEvent
+from .call_siprec_failed_webhook_event import CallSiprecFailedWebhookEvent
+from .call_speak_started_webhook_event import CallSpeakStartedWebhookEvent
+from .conference_created_webhook_event import ConferenceCreatedWebhookEvent
+from .call_playback_ended_webhook_event import CallPlaybackEndedWebhookEvent
+from .call_siprec_started_webhook_event import CallSiprecStartedWebhookEvent
+from .call_siprec_stopped_webhook_event import CallSiprecStoppedWebhookEvent
+from .fax_media_processed_webhook_event import FaxMediaProcessedWebhookEvent
+from .fax_sending_started_webhook_event import FaxSendingStartedWebhookEvent
+from .replaced_link_click_webhook_event import ReplacedLinkClickWebhookEvent
+from .call_ai_gather_ended_webhook_event import CallAIGatherEndedWebhookEvent
+from .call_recording_error_webhook_event import CallRecordingErrorWebhookEvent
+from .call_recording_saved_webhook_event import CallRecordingSavedWebhookEvent
+from .call_refer_completed_webhook_event import CallReferCompletedWebhookEvent
+from .call_playback_started_webhook_event import CallPlaybackStartedWebhookEvent
+from .call_streaming_failed_webhook_event import CallStreamingFailedWebhookEvent
+from .call_streaming_started_webhook_event import CallStreamingStartedWebhookEvent
+from .call_streaming_stopped_webhook_event import CallStreamingStoppedWebhookEvent
+from .campaign_status_update_webhook_event import CampaignStatusUpdateWebhookEvent
+from .conference_speak_ended_webhook_event import ConferenceSpeakEndedWebhookEvent
+from .call_conversation_ended_webhook_event import CallConversationEndedWebhookEvent
+from .conference_floor_changed_webhook_event import ConferenceFloorChangedWebhookEvent
+from .conference_speak_started_webhook_event import ConferenceSpeakStartedWebhookEvent
+from .conference_playback_ended_webhook_event import ConferencePlaybackEndedWebhookEvent
+from .conference_recording_saved_webhook_event import ConferenceRecordingSavedWebhookEvent
+from .number_order_status_update_webhook_event import NumberOrderStatusUpdateWebhookEvent
+from .call_machine_greeting_ended_webhook_event import CallMachineGreetingEndedWebhookEvent
+from .conference_participant_left_webhook_event import ConferenceParticipantLeftWebhookEvent
+from .conference_playback_started_webhook_event import ConferencePlaybackStartedWebhookEvent
+from .call_machine_detection_ended_webhook_event import CallMachineDetectionEndedWebhookEvent
+from .conference_participant_joined_webhook_event import ConferenceParticipantJoinedWebhookEvent
+from .call_ai_gather_partial_results_webhook_event import CallAIGatherPartialResultsWebhookEvent
+from .call_recording_transcription_saved_webhook_event import CallRecordingTranscriptionSavedWebhookEvent
+from .conference_participant_speak_ended_webhook_event import ConferenceParticipantSpeakEndedWebhookEvent
+from .call_machine_premium_greeting_ended_webhook_event import CallMachinePremiumGreetingEndedWebhookEvent
+from .call_conversation_insights_generated_webhook_event import CallConversationInsightsGeneratedWebhookEvent
+from .call_machine_premium_detection_ended_webhook_event import CallMachinePremiumDetectionEndedWebhookEvent
+from .conference_participant_speak_started_webhook_event import ConferenceParticipantSpeakStartedWebhookEvent
+from .conference_participant_playback_ended_webhook_event import ConferenceParticipantPlaybackEndedWebhookEvent
+from .call_ai_gather_message_history_updated_webhook_event import CallAIGatherMessageHistoryUpdatedWebhookEvent
+from .conference_participant_playback_started_webhook_event import ConferenceParticipantPlaybackStartedWebhookEvent
+
+__all__ = ["UnsafeUnwrapWebhookEvent"]
+
+UnsafeUnwrapWebhookEvent: TypeAlias = Union[
+    CallAIGatherEndedWebhookEvent,
+    CallAIGatherMessageHistoryUpdatedWebhookEvent,
+    CallAIGatherPartialResultsWebhookEvent,
+    CallAnsweredWebhookEvent,
+    CallBridgedWebhookEvent,
+    CallConversationEndedWebhookEvent,
+    CallConversationInsightsGeneratedWebhookEvent,
+    CallDtmfReceivedWebhookEvent,
+    CallEnqueuedWebhookEvent,
+    CallForkStartedWebhookEvent,
+    CallForkStoppedWebhookEvent,
+    CallGatherEndedWebhookEvent,
+    CallHangupWebhookEvent,
+    CallInitiatedWebhookEvent,
+    CallLeftQueueWebhookEvent,
+    CallMachineDetectionEndedWebhookEvent,
+    CallMachineGreetingEndedWebhookEvent,
+    CallMachinePremiumDetectionEndedWebhookEvent,
+    CallMachinePremiumGreetingEndedWebhookEvent,
+    CallPlaybackEndedWebhookEvent,
+    CallPlaybackStartedWebhookEvent,
+    CallRecordingErrorWebhookEvent,
+    CallRecordingSavedWebhookEvent,
+    CallRecordingTranscriptionSavedWebhookEvent,
+    CallReferCompletedWebhookEvent,
+    CallReferFailedWebhookEvent,
+    CallReferStartedWebhookEvent,
+    CallSiprecFailedWebhookEvent,
+    CallSiprecStartedWebhookEvent,
+    CallSiprecStoppedWebhookEvent,
+    CallSpeakEndedWebhookEvent,
+    CallSpeakStartedWebhookEvent,
+    CallStreamingFailedWebhookEvent,
+    CallStreamingStartedWebhookEvent,
+    CallStreamingStoppedWebhookEvent,
+    CampaignStatusUpdateWebhookEvent,
+    ConferenceCreatedWebhookEvent,
+    ConferenceEndedWebhookEvent,
+    ConferenceFloorChangedWebhookEvent,
+    ConferenceParticipantJoinedWebhookEvent,
+    ConferenceParticipantLeftWebhookEvent,
+    ConferenceParticipantPlaybackEndedWebhookEvent,
+    ConferenceParticipantPlaybackStartedWebhookEvent,
+    ConferenceParticipantSpeakEndedWebhookEvent,
+    ConferenceParticipantSpeakStartedWebhookEvent,
+    ConferencePlaybackEndedWebhookEvent,
+    ConferencePlaybackStartedWebhookEvent,
+    ConferenceRecordingSavedWebhookEvent,
+    ConferenceSpeakEndedWebhookEvent,
+    ConferenceSpeakStartedWebhookEvent,
+    DeliveryUpdateWebhookEvent,
+    FaxDeliveredWebhookEvent,
+    FaxFailedWebhookEvent,
+    FaxMediaProcessedWebhookEvent,
+    FaxQueuedWebhookEvent,
+    FaxSendingStartedWebhookEvent,
+    InboundMessageWebhookEvent,
+    NumberOrderStatusUpdateWebhookEvent,
+    ReplacedLinkClickWebhookEvent,
+    TranscriptionWebhookEvent,
+]

telnyx/types/unwrap_webhook_event.py

@@ -0,0 +1,130 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .fax_failed_webhook_event import FaxFailedWebhookEvent
+from .fax_queued_webhook_event import FaxQueuedWebhookEvent
+from .call_hangup_webhook_event import CallHangupWebhookEvent
+from .call_bridged_webhook_event import CallBridgedWebhookEvent
+from .call_answered_webhook_event import CallAnsweredWebhookEvent
+from .call_enqueued_webhook_event import CallEnqueuedWebhookEvent
+from .fax_delivered_webhook_event import FaxDeliveredWebhookEvent
+from .transcription_webhook_event import TranscriptionWebhookEvent
+from .call_initiated_webhook_event import CallInitiatedWebhookEvent
+from .call_left_queue_webhook_event import CallLeftQueueWebhookEvent
+from .delivery_update_webhook_event import DeliveryUpdateWebhookEvent
+from .inbound_message_webhook_event import InboundMessageWebhookEvent
+from .call_speak_ended_webhook_event import CallSpeakEndedWebhookEvent
+from .conference_ended_webhook_event import ConferenceEndedWebhookEvent
+from .call_fork_started_webhook_event import CallForkStartedWebhookEvent
+from .call_fork_stopped_webhook_event import CallForkStoppedWebhookEvent
+from .call_gather_ended_webhook_event import CallGatherEndedWebhookEvent
+from .call_refer_failed_webhook_event import CallReferFailedWebhookEvent
+from .call_dtmf_received_webhook_event import CallDtmfReceivedWebhookEvent
+from .call_refer_started_webhook_event import CallReferStartedWebhookEvent
+from .call_siprec_failed_webhook_event import CallSiprecFailedWebhookEvent
+from .call_speak_started_webhook_event import CallSpeakStartedWebhookEvent
+from .conference_created_webhook_event import ConferenceCreatedWebhookEvent
+from .call_playback_ended_webhook_event import CallPlaybackEndedWebhookEvent
+from .call_siprec_started_webhook_event import CallSiprecStartedWebhookEvent
+from .call_siprec_stopped_webhook_event import CallSiprecStoppedWebhookEvent
+from .fax_media_processed_webhook_event import FaxMediaProcessedWebhookEvent
+from .fax_sending_started_webhook_event import FaxSendingStartedWebhookEvent
+from .replaced_link_click_webhook_event import ReplacedLinkClickWebhookEvent
+from .call_ai_gather_ended_webhook_event import CallAIGatherEndedWebhookEvent
+from .call_recording_error_webhook_event import CallRecordingErrorWebhookEvent
+from .call_recording_saved_webhook_event import CallRecordingSavedWebhookEvent
+from .call_refer_completed_webhook_event import CallReferCompletedWebhookEvent
+from .call_playback_started_webhook_event import CallPlaybackStartedWebhookEvent
+from .call_streaming_failed_webhook_event import CallStreamingFailedWebhookEvent
+from .call_streaming_started_webhook_event import CallStreamingStartedWebhookEvent
+from .call_streaming_stopped_webhook_event import CallStreamingStoppedWebhookEvent
+from .campaign_status_update_webhook_event import CampaignStatusUpdateWebhookEvent
+from .conference_speak_ended_webhook_event import ConferenceSpeakEndedWebhookEvent
+from .call_conversation_ended_webhook_event import CallConversationEndedWebhookEvent
+from .conference_floor_changed_webhook_event import ConferenceFloorChangedWebhookEvent
+from .conference_speak_started_webhook_event import ConferenceSpeakStartedWebhookEvent
+from .conference_playback_ended_webhook_event import ConferencePlaybackEndedWebhookEvent
+from .conference_recording_saved_webhook_event import ConferenceRecordingSavedWebhookEvent
+from .number_order_status_update_webhook_event import NumberOrderStatusUpdateWebhookEvent
+from .call_machine_greeting_ended_webhook_event import CallMachineGreetingEndedWebhookEvent
+from .conference_participant_left_webhook_event import ConferenceParticipantLeftWebhookEvent
+from .conference_playback_started_webhook_event import ConferencePlaybackStartedWebhookEvent
+from .call_machine_detection_ended_webhook_event import CallMachineDetectionEndedWebhookEvent
+from .conference_participant_joined_webhook_event import ConferenceParticipantJoinedWebhookEvent
+from .call_ai_gather_partial_results_webhook_event import CallAIGatherPartialResultsWebhookEvent
+from .call_recording_transcription_saved_webhook_event import CallRecordingTranscriptionSavedWebhookEvent
+from .conference_participant_speak_ended_webhook_event import ConferenceParticipantSpeakEndedWebhookEvent
+from .call_machine_premium_greeting_ended_webhook_event import CallMachinePremiumGreetingEndedWebhookEvent
+from .call_conversation_insights_generated_webhook_event import CallConversationInsightsGeneratedWebhookEvent
+from .call_machine_premium_detection_ended_webhook_event import CallMachinePremiumDetectionEndedWebhookEvent
+from .conference_participant_speak_started_webhook_event import ConferenceParticipantSpeakStartedWebhookEvent
+from .conference_participant_playback_ended_webhook_event import ConferenceParticipantPlaybackEndedWebhookEvent
+from .call_ai_gather_message_history_updated_webhook_event import CallAIGatherMessageHistoryUpdatedWebhookEvent
+from .conference_participant_playback_started_webhook_event import ConferenceParticipantPlaybackStartedWebhookEvent
+
+__all__ = ["UnwrapWebhookEvent"]
+
+UnwrapWebhookEvent: TypeAlias = Union[
+    CallAIGatherEndedWebhookEvent,
+    CallAIGatherMessageHistoryUpdatedWebhookEvent,
+    CallAIGatherPartialResultsWebhookEvent,
+    CallAnsweredWebhookEvent,
+    CallBridgedWebhookEvent,
+    CallConversationEndedWebhookEvent,
+    CallConversationInsightsGeneratedWebhookEvent,
+    CallDtmfReceivedWebhookEvent,
+    CallEnqueuedWebhookEvent,
+    CallForkStartedWebhookEvent,
+    CallForkStoppedWebhookEvent,
+    CallGatherEndedWebhookEvent,
+    CallHangupWebhookEvent,
+    CallInitiatedWebhookEvent,
+    CallLeftQueueWebhookEvent,
+    CallMachineDetectionEndedWebhookEvent,
+    CallMachineGreetingEndedWebhookEvent,
+    CallMachinePremiumDetectionEndedWebhookEvent,
+    CallMachinePremiumGreetingEndedWebhookEvent,
+    CallPlaybackEndedWebhookEvent,
+    CallPlaybackStartedWebhookEvent,
+    CallRecordingErrorWebhookEvent,
+    CallRecordingSavedWebhookEvent,
+    CallRecordingTranscriptionSavedWebhookEvent,
+    CallReferCompletedWebhookEvent,
+    CallReferFailedWebhookEvent,
+    CallReferStartedWebhookEvent,
+    CallSiprecFailedWebhookEvent,
+    CallSiprecStartedWebhookEvent,
+    CallSiprecStoppedWebhookEvent,
+    CallSpeakEndedWebhookEvent,
+    CallSpeakStartedWebhookEvent,
+    CallStreamingFailedWebhookEvent,
+    CallStreamingStartedWebhookEvent,
+    CallStreamingStoppedWebhookEvent,
+    CampaignStatusUpdateWebhookEvent,
+    ConferenceCreatedWebhookEvent,
+    ConferenceEndedWebhookEvent,
+    ConferenceFloorChangedWebhookEvent,
+    ConferenceParticipantJoinedWebhookEvent,
+    ConferenceParticipantLeftWebhookEvent,
+    ConferenceParticipantPlaybackEndedWebhookEvent,
+    ConferenceParticipantPlaybackStartedWebhookEvent,
+    ConferenceParticipantSpeakEndedWebhookEvent,
+    ConferenceParticipantSpeakStartedWebhookEvent,
+    ConferencePlaybackEndedWebhookEvent,
+    ConferencePlaybackStartedWebhookEvent,
+    ConferenceRecordingSavedWebhookEvent,
+    ConferenceSpeakEndedWebhookEvent,
+    ConferenceSpeakStartedWebhookEvent,
+    DeliveryUpdateWebhookEvent,
+    FaxDeliveredWebhookEvent,
+    FaxFailedWebhookEvent,
+    FaxMediaProcessedWebhookEvent,
+    FaxQueuedWebhookEvent,
+    FaxSendingStartedWebhookEvent,
+    InboundMessageWebhookEvent,
+    NumberOrderStatusUpdateWebhookEvent,
+    ReplacedLinkClickWebhookEvent,
+    TranscriptionWebhookEvent,
+]

telnyx/types/update_regulatory_requirement_param.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["UpdateRegulatoryRequirementParam"]
+
+
+class UpdateRegulatoryRequirementParam(TypedDict, total=False):
+    field_value: str
+    """The value of the requirement.
+
+    For address and document requirements, this should be the ID of the resource.
+    For textual, this should be the value of the requirement.
+    """
+
+    requirement_id: str
+    """Unique id for a requirement."""

telnyx/types/url_shortener_settings.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["URLShortenerSettings"]
+
+
+class URLShortenerSettings(BaseModel):
+    """
+    The URL shortener feature allows automatic replacement of URLs that were generated using
+    a public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly,
+    is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with
+    with links generated by Telnyx. The use of custom links can improve branding and message
+    deliverability.
+
+    To disable this feature, set the object field to `null`.
+    """
+
+    domain: str
+    """One of the domains provided by the Telnyx URL shortener service."""
+
+    prefix: Optional[str] = None
+    """
+    Optional prefix that can be used to identify your brand, and will appear in the
+    Telnyx generated URLs after the domain name.
+    """
+
+    replace_blacklist_only: Optional[bool] = None
+    """
+    Use the link replacement tool only for links that are specifically blacklisted
+    by Telnyx.
+    """
+
+    send_webhooks: Optional[bool] = None
+    """Receive webhooks for when your replaced links are clicked.
+
+    Webhooks are sent to the webhooks on the messaging profile.
+    """

telnyx/types/url_shortener_settings_param.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["URLShortenerSettingsParam"]
+
+
+class URLShortenerSettingsParam(TypedDict, total=False):
+    """
+    The URL shortener feature allows automatic replacement of URLs that were generated using
+    a public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly,
+    is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with
+    with links generated by Telnyx. The use of custom links can improve branding and message
+    deliverability.
+
+    To disable this feature, set the object field to `null`.
+    """
+
+    domain: Required[str]
+    """One of the domains provided by the Telnyx URL shortener service."""
+
+    prefix: str
+    """
+    Optional prefix that can be used to identify your brand, and will appear in the
+    Telnyx generated URLs after the domain name.
+    """
+
+    replace_blacklist_only: bool
+    """
+    Use the link replacement tool only for links that are specifically blacklisted
+    by Telnyx.
+    """
+
+    send_webhooks: bool
+    """Receive webhooks for when your replaced links are clicked.
+
+    Webhooks are sent to the webhooks on the messaging profile.
+    """

telnyx/types/usage_payment_method.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["UsagePaymentMethod"]
+
+UsagePaymentMethod: TypeAlias = Literal["rate-deck"]

telnyx/types/usage_report_get_options_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 TypedDict
+
+__all__ = ["UsageReportGetOptionsParams"]
+
+
+class UsageReportGetOptionsParams(TypedDict, total=False):
+    product: str
+    """Options (dimensions and metrics) for a given product.
+
+    If none specified, all products will be returned.
+    """
+
+    authorization_bearer: str
+    """Authenticates the request with your Telnyx API V2 KEY"""

telnyx/types/usage_report_get_options_response.py

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["UsageReportGetOptionsResponse", "Data", "DataRecordType"]
+
+
+class DataRecordType(BaseModel):
+    """
+    An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
+    """
+
+    product_dimensions: Optional[List[str]] = None
+    """Telnyx Product Dimensions"""
+
+    product_metrics: Optional[List[str]] = None
+    """Telnyx Product Metrics"""
+
+    record_type: Optional[str] = None
+    """Telnyx Product type"""
+
+
+class Data(BaseModel):
+    """
+    An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
+    """
+
+    product: Optional[str] = None
+    """Telnyx Product"""
+
+    product_dimensions: Optional[List[str]] = None
+    """Telnyx Product Dimensions"""
+
+    product_metrics: Optional[List[str]] = None
+    """Telnyx Product Metrics"""
+
+    record_types: Optional[List[DataRecordType]] = None
+    """Subproducts if applicable"""
+
+
+class UsageReportGetOptionsResponse(BaseModel):
+    """
+    An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
+    """
+
+    data: Optional[List[Data]] = None
+    """Collection of product description"""

telnyx/types/usage_report_list_params.py

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["UsageReportListParams"]
+
+
+class UsageReportListParams(TypedDict, total=False):
+    dimensions: Required[SequenceNotStr[str]]
+    """Breakout by specified product dimensions"""
+
+    metrics: Required[SequenceNotStr[str]]
+    """Specified product usage values"""
+
+    product: Required[str]
+    """Telnyx product"""
+
+    date_range: str
+    """A more user-friendly way to specify the timespan you want to filter by.
+
+    More options can be found in the Telnyx API Reference docs.
+    """
+
+    end_date: str
+    """The end date for the time range you are interested in.
+
+    The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ
+    """
+
+    filter: str
+    """Filter records on dimensions"""
+
+    format: Literal["csv", "json"]
+    """Specify the response format (csv or json).
+
+    JSON is returned by default, even if not specified.
+    """
+
+    managed_accounts: bool
+    """
+    Return the aggregations for all Managed Accounts under the user making the
+    request.
+    """
+
+    page_number: Annotated[int, PropertyInfo(alias="page[number]")]
+
+    page_size: Annotated[int, PropertyInfo(alias="page[size]")]
+
+    sort: SequenceNotStr[str]
+    """Specifies the sort order for results"""
+
+    start_date: str
+    """The start date for the time range you are interested in.
+
+    The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ
+    """
+
+    authorization_bearer: str
+    """Authenticates the request with your Telnyx API V2 KEY"""

telnyx/types/usage_report_list_response.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict
+from typing_extensions import TypeAlias
+
+__all__ = ["UsageReportListResponse"]
+
+UsageReportListResponse: TypeAlias = Dict[str, object]

telnyx/types/user_address.py

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["UserAddress"]
+
+
+class UserAddress(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies the user address."""
+
+    administrative_area: Optional[str] = None
+    """The locality of the user address.
+
+    For US addresses, this corresponds to the state of the address.
+    """
+
+    borough: Optional[str] = None
+    """The borough of the user address.
+
+    This field is not used for addresses in the US but is used for some
+    international addresses.
+    """
+
+    business_name: Optional[str] = None
+    """The business name associated with the user address."""
+
+    country_code: Optional[str] = None
+    """The two-character (ISO 3166-1 alpha-2) country code of the user address."""
+
+    created_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    customer_reference: Optional[str] = None
+    """A customer reference string for customer look ups."""
+
+    extended_address: Optional[str] = None
+    """
+    Additional street address information about the user address such as, but not
+    limited to, unit number or apartment number.
+    """
+
+    first_name: Optional[str] = None
+    """The first name associated with the user address."""
+
+    last_name: Optional[str] = None
+    """The last name associated with the user address."""
+
+    locality: Optional[str] = None
+    """The locality of the user address.
+
+    For US addresses, this corresponds to the city of the address.
+    """
+
+    neighborhood: Optional[str] = None
+    """The neighborhood of the user address.
+
+    This field is not used for addresses in the US but is used for some
+    international addresses.
+    """
+
+    phone_number: Optional[str] = None
+    """The phone number associated with the user address."""
+
+    postal_code: Optional[str] = None
+    """The postal code of the user address."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    street_address: Optional[str] = None
+    """The primary street address information about the user address."""
+
+    updated_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was updated."""