telnyx 3.5.0a0__py3-none-any.whl → 3.7.0a0__py3-none-any.whl

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/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/{error.py → api_error.py}

@@ -4,7 +4,7 @@ from typing import Dict, Optional
 
 from .._models import BaseModel
 
-__all__ = ["Error", "Source"]
+__all__ = ["APIError", "Source"]
 
 
 class Source(BaseModel):
@@ -15,7 +15,7 @@ class Source(BaseModel):
     """JSON pointer (RFC6901) to the offending entity."""
 
 
-class Error(BaseModel):
+class APIError(BaseModel):
     code: str
 
     title: str

telnyx/types/call_dial_params.py

@@ -225,7 +225,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 +235,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"]

telnyx/types/calls/action_transfer_params.py

@@ -102,6 +102,56 @@ class ActionTransferParams(TypedDict, total=False):
     behavior is to hang up the leg.
     """
 
+    record: Literal["record-from-answer"]
+    """Start recording automatically after an event. Disabled by default."""
+
+    record_channels: Literal["single", "dual"]
+    """
+    Defines which channel should be recorded ('single' or 'dual') when `record` is
+    specified.
+    """
+
+    record_custom_file_name: str
+    """The custom recording file name to be used instead of the default `call_leg_id`.
+
+    Telnyx will still add a Unix timestamp suffix.
+    """
+
+    record_format: Literal["wav", "mp3"]
+    """
+    Defines the format of the recording ('wav' or 'mp3') when `record` is specified.
+    """
+
+    record_max_length: int
+    """
+    Defines the maximum length for the recording in seconds when `record` is
+    specified. The minimum value is 0. The maximum value is 43200. The default value
+    is 0 (infinite).
+    """
+
+    record_timeout_secs: int
+    """
+    The number of seconds that Telnyx will wait for the recording to be stopped if
+    silence is detected when `record` is specified. The timer only starts when the
+    speech is detected. Please note that call transcription is used to detect
+    silence and the related charge will be applied. The minimum value is 0. The
+    default value is 0 (infinite).
+    """
+
+    record_track: Literal["both", "inbound", "outbound"]
+    """The audio track to be recorded.
+
+    Can be either `both`, `inbound` or `outbound`. If only single track is specified
+    (`inbound`, `outbound`), `channels` configuration is ignored and it will be
+    recorded as mono (single channel).
+    """
+
+    record_trim: Literal["trim-silence"]
+    """
+    When set to `trim-silence`, silence will be removed from the beginning and end
+    of the recording.
+    """
+
     sip_auth_password: str
     """SIP Authentication password used for SIP challenges."""
 

telnyx/types/campaign_submit_appeal_response.py

@@ -11,6 +11,3 @@ __all__ = ["CampaignSubmitAppealResponse"]
 class CampaignSubmitAppealResponse(BaseModel):
     appealed_at: Optional[datetime] = None
     """Timestamp when the appeal was submitted"""
-
-    previous_status: Optional[str] = None
-    """Previous campaign status (currently always null)"""

telnyx/types/legacy/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations

telnyx/types/legacy/reporting/__init__.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .usage_report_retrieve_speech_to_text_params import (
+    UsageReportRetrieveSpeechToTextParams as UsageReportRetrieveSpeechToTextParams,
+)
+from .usage_report_retrieve_speech_to_text_response import (
+    UsageReportRetrieveSpeechToTextResponse as UsageReportRetrieveSpeechToTextResponse,
+)

telnyx/types/legacy/reporting/batch_detail_records/__init__.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .voice_create_params import VoiceCreateParams as VoiceCreateParams
+from .voice_list_response import VoiceListResponse as VoiceListResponse
+from .voice_create_response import VoiceCreateResponse as VoiceCreateResponse
+from .voice_delete_response import VoiceDeleteResponse as VoiceDeleteResponse
+from .messaging_create_params import MessagingCreateParams as MessagingCreateParams
+from .messaging_list_response import MessagingListResponse as MessagingListResponse
+from .voice_retrieve_response import VoiceRetrieveResponse as VoiceRetrieveResponse
+from .messaging_create_response import MessagingCreateResponse as MessagingCreateResponse
+from .messaging_delete_response import MessagingDeleteResponse as MessagingDeleteResponse
+from .messaging_retrieve_response import MessagingRetrieveResponse as MessagingRetrieveResponse
+from .speech_to_text_create_params import SpeechToTextCreateParams as SpeechToTextCreateParams
+from .speech_to_text_list_response import SpeechToTextListResponse as SpeechToTextListResponse
+from .speech_to_text_create_response import SpeechToTextCreateResponse as SpeechToTextCreateResponse
+from .speech_to_text_delete_response import SpeechToTextDeleteResponse as SpeechToTextDeleteResponse
+from .voice_retrieve_fields_response import VoiceRetrieveFieldsResponse as VoiceRetrieveFieldsResponse
+from .speech_to_text_retrieve_response import SpeechToTextRetrieveResponse as SpeechToTextRetrieveResponse

telnyx/types/legacy/reporting/batch_detail_records/messaging_create_params.py

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ....._types import SequenceNotStr
+from ....._utils import PropertyInfo
+
+__all__ = ["MessagingCreateParams", "Filter"]
+
+
+class MessagingCreateParams(TypedDict, total=False):
+    end_time: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """End time in ISO format.
+
+    Note: If end time includes the last 4 hours, some MDRs might not appear in this
+    report, due to wait time for downstream message delivery confirmation
+    """
+
+    start_time: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start time in ISO format"""
+
+    connections: Iterable[int]
+    """List of connections to filter by"""
+
+    directions: Iterable[int]
+    """List of directions to filter by (Inbound = 1, Outbound = 2)"""
+
+    filters: Iterable[Filter]
+    """List of filters to apply"""
+
+    include_message_body: bool
+    """Whether to include message body in the report"""
+
+    managed_accounts: SequenceNotStr[str]
+    """List of managed accounts to include"""
+
+    profiles: SequenceNotStr[str]
+    """List of messaging profile IDs to filter by"""
+
+    record_types: Iterable[int]
+    """List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)"""
+
+    report_name: str
+    """Name of the report"""
+
+    select_all_managed_accounts: bool
+    """Whether to select all managed accounts"""
+
+    timezone: str
+    """Timezone for the report"""
+
+
+class Filter(TypedDict, total=False):
+    billing_group: str
+    """Billing group UUID to filter by"""
+
+    cld: str
+    """Called line identification (destination number)"""
+
+    cld_filter: Literal["contains", "starts_with", "ends_with"]
+    """Filter type for CLD matching"""
+
+    cli: str
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Literal["contains", "starts_with", "ends_with"]
+    """Filter type for CLI matching"""
+
+    filter_type: Literal["and", "or"]
+    """Logical operator for combining filters"""
+
+    tags_list: str
+    """Tag name to filter by"""

telnyx/types/legacy/reporting/batch_detail_records/messaging_create_response.py

@@ -0,0 +1,68 @@
+# 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 ....._models import BaseModel
+
+__all__ = ["MessagingCreateResponse", "Data", "DataFilter"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
+
+    end_date: Optional[datetime] = None
+
+    filters: Optional[List[DataFilter]] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
+
+    report_name: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingCreateResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_delete_response.py

@@ -0,0 +1,68 @@
+# 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 ....._models import BaseModel
+
+__all__ = ["MessagingDeleteResponse", "Data", "DataFilter"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
+
+    end_date: Optional[datetime] = None
+
+    filters: Optional[List[DataFilter]] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
+
+    report_name: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingDeleteResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_list_response.py

@@ -0,0 +1,80 @@
+# 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 ....._models import BaseModel
+
+__all__ = ["MessagingListResponse", "Data", "DataFilter", "Meta"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
+
+    end_date: Optional[datetime] = None
+
+    filters: Optional[List[DataFilter]] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
+
+    report_name: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+    updated_at: Optional[datetime] = None
+
+
+class Meta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None
+
+
+class MessagingListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[Meta] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_retrieve_response.py

@@ -0,0 +1,68 @@
+# 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 ....._models import BaseModel
+
+__all__ = ["MessagingRetrieveResponse", "Data", "DataFilter"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
+
+    end_date: Optional[datetime] = None
+
+    filters: Optional[List[DataFilter]] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
+
+    report_name: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingRetrieveResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_params.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from ....._utils import PropertyInfo
+
+__all__ = ["SpeechToTextCreateParams"]
+
+
+class SpeechToTextCreateParams(TypedDict, total=False):
+    end_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """End date in ISO format with timezone (date range must be up to one month)"""
+
+    start_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start date in ISO format with timezone"""

telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_response.py

@@ -0,0 +1,31 @@
+# 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__ = ["SpeechToTextCreateResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    created_at: Optional[datetime] = None
+
+    download_link: Optional[str] = None
+    """URL to download the report"""
+
+    end_date: Optional[datetime] = None
+
+    record_type: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+
+class SpeechToTextCreateResponse(BaseModel):
+    data: Optional[Data] = None