telnyx 4.5.0__py3-none-any.whl

telnyx/types/recording_list_params.py

@@ -0,0 +1,79 @@
+# 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__ = ["RecordingListParams", "Filter", "FilterCreatedAt"]
+
+
+class RecordingListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[conference_id], filter[created_at][gte],
+    filter[created_at][lte], filter[call_leg_id], filter[call_session_id],
+    filter[from], filter[to], filter[connection_id], filter[sip_call_id]
+    """
+
+    page_number: Annotated[int, PropertyInfo(alias="page[number]")]
+
+    page_size: Annotated[int, PropertyInfo(alias="page[size]")]
+
+
+class FilterCreatedAt(TypedDict, total=False):
+    gte: str
+    """Returns only recordings created later than or at given ISO 8601 datetime."""
+
+    lte: str
+    """Returns only recordings created earlier than or at given ISO 8601 datetime."""
+
+
+_FilterReservedKeywords = TypedDict(
+    "_FilterReservedKeywords",
+    {
+        "from": str,
+    },
+    total=False,
+)
+
+
+class Filter(_FilterReservedKeywords, total=False):
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[conference_id], filter[created_at][gte], filter[created_at][lte], filter[call_leg_id], filter[call_session_id], filter[from], filter[to], filter[connection_id], filter[sip_call_id]
+    """
+
+    call_leg_id: str
+    """If present, recordings will be filtered to those with a matching call_leg_id."""
+
+    call_session_id: str
+    """
+    If present, recordings will be filtered to those with a matching
+    call_session_id.
+    """
+
+    conference_id: str
+    """Returns only recordings associated with a given conference."""
+
+    connection_id: str
+    """
+    If present, recordings will be filtered to those with a matching `connection_id`
+    attribute (case-sensitive).
+    """
+
+    created_at: FilterCreatedAt
+
+    sip_call_id: str
+    """
+    If present, recordings will be filtered to those with a matching `sip_call_id`
+    attribute. Matching is case-sensitive
+    """
+
+    to: str
+    """
+    If present, recordings will be filtered to those with a matching `to` attribute
+    (case-sensitive).
+    """

telnyx/types/recording_response_data.py

@@ -0,0 +1,74 @@
+# 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__ = ["RecordingResponseData", "DownloadURLs"]
+
+
+class DownloadURLs(BaseModel):
+    """Links to download the recording files."""
+
+    mp3: Optional[str] = None
+    """Link to download the recording in mp3 format."""
+
+    wav: Optional[str] = None
+    """Link to download the recording in wav format."""
+
+
+class RecordingResponseData(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies the recording."""
+
+    call_control_id: Optional[str] = None
+    """Unique identifier and token for controlling the call."""
+
+    call_leg_id: Optional[str] = None
+    """ID unique to the call leg (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.
+    """
+
+    channels: Optional[Literal["single", "dual"]] = None
+    """
+    When `dual`, the final audio file has the first leg on channel A, and the rest
+    on channel B.
+    """
+
+    conference_id: Optional[str] = None
+    """Uniquely identifies the conference."""
+
+    created_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    download_urls: Optional[DownloadURLs] = None
+    """Links to download the recording files."""
+
+    duration_millis: Optional[int] = None
+    """The duration of the recording in milliseconds."""
+
+    record_type: Optional[Literal["recording"]] = None
+
+    recording_ended_at: Optional[str] = None
+    """ISO 8601 formatted date of when the recording ended."""
+
+    recording_started_at: Optional[str] = None
+    """ISO 8601 formatted date of when the recording started."""
+
+    source: Optional[Literal["conference", "call"]] = None
+    """The kind of event that led to this recording being created."""
+
+    status: Optional[Literal["completed"]] = None
+    """The status of the recording.
+
+    Only `completed` recordings are currently supported.
+    """
+
+    updated_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was updated."""

telnyx/types/recording_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 .._models import BaseModel
+from .recording_response_data import RecordingResponseData
+
+__all__ = ["RecordingRetrieveResponse"]
+
+
+class RecordingRetrieveResponse(BaseModel):
+    data: Optional[RecordingResponseData] = None

telnyx/types/recording_transcription.py

@@ -0,0 +1,36 @@
+# 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__ = ["RecordingTranscription"]
+
+
+class RecordingTranscription(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies the recording transcription."""
+
+    created_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    duration_millis: Optional[int] = None
+    """The duration of the recording transcription in milliseconds."""
+
+    record_type: Optional[Literal["recording_transcription"]] = None
+
+    recording_id: Optional[str] = None
+    """Uniquely identifies the recording associated with this transcription."""
+
+    status: Optional[Literal["in-progress", "completed"]] = None
+    """The status of the recording transcription.
+
+    Only `completed` has transcription text available.
+    """
+
+    transcription_text: Optional[str] = None
+    """The recording's transcribed text."""
+
+    updated_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was updated."""

telnyx/types/recording_transcription_delete_response.py

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

telnyx/types/recording_transcription_list_response.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .recording_transcription import RecordingTranscription
+
+__all__ = ["RecordingTranscriptionListResponse", "Meta", "MetaCursors"]
+
+
+class MetaCursors(BaseModel):
+    after: Optional[str] = None
+    """Opaque identifier of next page."""
+
+    before: Optional[str] = None
+    """Opaque identifier of previous page."""
+
+
+class Meta(BaseModel):
+    cursors: Optional[MetaCursors] = None
+
+    next: Optional[str] = None
+    """Path to next page."""
+
+    previous: Optional[str] = None
+    """Path to previous page."""
+
+
+class RecordingTranscriptionListResponse(BaseModel):
+    data: Optional[List[RecordingTranscription]] = None
+
+    meta: Optional[Meta] = None

telnyx/types/recording_transcription_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 .._models import BaseModel
+from .recording_transcription import RecordingTranscription
+
+__all__ = ["RecordingTranscriptionRetrieveResponse"]
+
+
+class RecordingTranscriptionRetrieveResponse(BaseModel):
+    data: Optional[RecordingTranscription] = None

telnyx/types/recordings/__init__.py

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

telnyx/types/recordings/action_delete_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 Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["ActionDeleteParams"]
+
+
+class ActionDeleteParams(TypedDict, total=False):
+    ids: Required[SequenceNotStr[str]]
+    """List of call recording IDs to delete."""

telnyx/types/region_list_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["RegionListResponse", "Data"]
+
+
+class Data(BaseModel):
+    code: Optional[str] = None
+    """A code for the region."""
+
+    created_at: Optional[str] = None
+    """ISO 8601 formatted date-time indicating when the resource was created."""
+
+    name: Optional[str] = None
+    """A name for the region."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    supported_interfaces: Optional[List[str]] = None
+    """List of interface types supported in this region."""
+
+    updated_at: Optional[str] = None
+    """ISO 8601 formatted date-time indicating when the resource was updated."""
+
+
+class RegionListResponse(BaseModel):
+    data: Optional[List[Data]] = None

telnyx/types/regulatory_requirement_retrieve_params.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["RegulatoryRequirementRetrieveParams", "Filter"]
+
+
+class RegulatoryRequirementRetrieveParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[phone_number], filter[requirement_group_id],
+    filter[country_code], filter[phone_number_type], filter[action]
+    """
+
+
+class Filter(TypedDict, total=False):
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[phone_number], filter[requirement_group_id], filter[country_code], filter[phone_number_type], filter[action]
+    """
+
+    action: Literal["ordering", "porting", "action"]
+    """Action to check requirements for"""
+
+    country_code: str
+    """Country code(iso2) to check requirements for"""
+
+    phone_number: str
+    """Phone number to check requirements for"""
+
+    phone_number_type: Literal["local", "toll_free", "mobile", "national", "shared_cost"]
+    """Phone number type to check requirements for"""
+
+    requirement_group_id: str
+    """ID of requirement group to check requirements for"""

telnyx/types/regulatory_requirement_retrieve_response.py

@@ -0,0 +1,58 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = [
+    "RegulatoryRequirementRetrieveResponse",
+    "Data",
+    "DataRegulatoryRequirement",
+    "DataRegulatoryRequirementAcceptanceCriteria",
+]
+
+
+class DataRegulatoryRequirementAcceptanceCriteria(BaseModel):
+    acceptable_characters: Optional[str] = None
+
+    acceptable_values: Optional[List[str]] = None
+
+    case_sensitive: Optional[str] = None
+
+    locality_limit: Optional[str] = None
+
+    max_length: Optional[str] = None
+
+    min_length: Optional[str] = None
+
+    regex: Optional[str] = None
+
+    time_limit: Optional[str] = None
+
+
+class DataRegulatoryRequirement(BaseModel):
+    id: Optional[str] = None
+
+    acceptance_criteria: Optional[DataRegulatoryRequirementAcceptanceCriteria] = None
+
+    description: Optional[str] = None
+
+    example: Optional[str] = None
+
+    field_type: Optional[str] = None
+
+    name: Optional[str] = None
+
+
+class Data(BaseModel):
+    action: Optional[str] = None
+
+    country_code: Optional[str] = None
+
+    phone_number_type: Optional[str] = None
+
+    regulatory_requirements: Optional[List[DataRegulatoryRequirement]] = None
+
+
+class RegulatoryRequirementRetrieveResponse(BaseModel):
+    data: Optional[List[Data]] = None

telnyx/types/replaced_link_click_webhook_event.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["ReplacedLinkClickWebhookEvent", "Data"]
+
+
+class Data(BaseModel):
+    message_id: Optional[str] = None
+    """The message ID associated with the clicked link."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    time_clicked: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the message request was received."""
+
+    to: Optional[str] = None
+    """
+    Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+    code).
+    """
+
+    url: Optional[str] = None
+    """The original link that was sent in the message."""
+
+
+class ReplacedLinkClickWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/replaced_link_click_webhook_event1.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["ReplacedLinkClickWebhookEvent", "Data"]
+
+
+class Data(BaseModel):
+    message_id: Optional[str] = None
+    """The message ID associated with the clicked link."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    time_clicked: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the message request was received."""
+
+    to: Optional[str] = None
+    """
+    Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+    code).
+    """
+
+    url: Optional[str] = None
+    """The original link that was sent in the message."""
+
+
+class ReplacedLinkClickWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/report_list_mdrs_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 Literal, TypedDict
+
+__all__ = ["ReportListMdrsParams"]
+
+
+class ReportListMdrsParams(TypedDict, total=False):
+    id: str
+    """Message uuid"""
+
+    cld: str
+    """Destination number"""
+
+    cli: str
+    """Origination number"""
+
+    direction: Literal["INBOUND", "OUTBOUND"]
+    """Direction (inbound or outbound)"""
+
+    end_date: str
+    """Pagination end date"""
+
+    message_type: Literal["SMS", "MMS"]
+    """Type of message"""
+
+    profile: str
+    """Name of the profile"""
+
+    start_date: str
+    """Pagination start date"""
+
+    status: Literal["GW_TIMEOUT", "DELIVERED", "DLR_UNCONFIRMED", "DLR_TIMEOUT", "RECEIVED", "GW_REJECT", "FAILED"]
+    """Message status"""

telnyx/types/report_list_mdrs_response.py

@@ -0,0 +1,65 @@
+# 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
+from .reports.pagination_meta_reporting import PaginationMetaReporting
+
+__all__ = ["ReportListMdrsResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Id of message detail record"""
+
+    cld: Optional[str] = None
+    """The destination number for a call, or the callee"""
+
+    cli: Optional[str] = None
+    """The number associated with the person initiating the call, or the caller"""
+
+    cost: Optional[str] = None
+    """Final cost. Cost is calculated as rate \\** parts"""
+
+    created_at: Optional[datetime] = None
+    """Message sent time"""
+
+    currency: Optional[Literal["AUD", "CAD", "EUR", "GBP", "USD"]] = None
+    """Currency of the rate and cost"""
+
+    direction: Optional[str] = None
+    """Direction of message - inbound or outbound."""
+
+    message_type: Optional[Literal["SMS", "MMS"]] = None
+    """Type of message"""
+
+    parts: Optional[float] = None
+    """Number of parts this message has.
+
+    Max number of character is 160. If message contains more characters then that it
+    will be broken down in multiple parts
+    """
+
+    profile_name: Optional[str] = None
+    """Configured profile name.
+
+    New profiles can be created and configured on Telnyx portal
+    """
+
+    rate: Optional[str] = None
+    """Rate applied to the message"""
+
+    record_type: Optional[str] = None
+
+    status: Optional[
+        Literal["GW_TIMEOUT", "DELIVERED", "DLR_UNCONFIRMED", "DLR_TIMEOUT", "RECEIVED", "GW_REJECT", "FAILED"]
+    ] = None
+    """Message status"""
+
+
+class ReportListMdrsResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[PaginationMetaReporting] = None

telnyx/types/report_list_wdrs_params.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["ReportListWdrsParams"]
+
+
+class ReportListWdrsParams(TypedDict, total=False):
+    id: str
+    """WDR uuid"""
+
+    end_date: str
+    """End date"""
+
+    imsi: str
+    """International mobile subscriber identity"""
+
+    mcc: str
+    """Mobile country code"""
+
+    mnc: str
+    """Mobile network code"""
+
+    page_number: Annotated[int, PropertyInfo(alias="page[number]")]
+
+    page_size: Annotated[int, PropertyInfo(alias="page[size]")]
+
+    phone_number: str
+    """Phone number"""
+
+    sim_card_id: str
+    """Sim card unique identifier"""
+
+    sim_group_id: str
+    """Sim group unique identifier"""
+
+    sim_group_name: str
+    """Sim group name"""
+
+    sort: SequenceNotStr[str]
+    """Field used to order the data.
+
+    If no field is specified, default value is 'created_at'
+    """
+
+    start_date: str
+    """Start date"""