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

telnyx/types/conference_participant_playback_ended_webhook_event.py

@@ -0,0 +1,65 @@
+# 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__ = ["ConferenceParticipantPlaybackEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.playback.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantPlaybackEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_playback_started_webhook_event.py

@@ -0,0 +1,65 @@
+# 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__ = ["ConferenceParticipantPlaybackStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.playback.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantPlaybackStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_speak_ended_webhook_event.py

@@ -0,0 +1,56 @@
+# 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__ = ["ConferenceParticipantSpeakEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.speak.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_speak_started_webhook_event.py

@@ -0,0 +1,56 @@
+# 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__ = ["ConferenceParticipantSpeakStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.speak.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_playback_ended_webhook_event.py

@@ -0,0 +1,49 @@
+# 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__ = ["ConferencePlaybackEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.playback.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferencePlaybackEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_playback_started_webhook_event.py

@@ -0,0 +1,49 @@
+# 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__ = ["ConferencePlaybackStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.playback.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferencePlaybackStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_recording_saved_webhook_event.py

@@ -0,0 +1,103 @@
+# 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__ = [
+    "ConferenceRecordingSavedWebhookEvent",
+    "Data",
+    "DataPayload",
+    "DataPayloadPublicRecordingURLs",
+    "DataPayloadRecordingURLs",
+]
+
+
+class DataPayloadPublicRecordingURLs(BaseModel):
+    mp3: Optional[str] = None
+    """Recording URL in requested `mp3` format."""
+
+    wav: Optional[str] = None
+    """Recording URL in requested `wav` format."""
+
+
+class DataPayloadRecordingURLs(BaseModel):
+    mp3: Optional[str] = None
+    """Recording URL in requested `mp3` format."""
+
+    wav: Optional[str] = None
+    """Recording URL in requested `wav` format."""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    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
+    """Whether recording was recorded in `single` or `dual` channel."""
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference that is being recorded."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    format: Optional[Literal["wav", "mp3"]] = None
+    """The audio file format used when storing the call recording.
+
+    Can be either `mp3` or `wav`.
+    """
+
+    public_recording_urls: Optional[DataPayloadPublicRecordingURLs] = None
+    """Recording URLs in requested format.
+
+    The URL is valid for as long as the file exists. For security purposes, this
+    feature is activated on a per request basis. Please contact customer support
+    with your Account ID to request activation.
+    """
+
+    recording_ended_at: Optional[datetime] = None
+    """ISO 8601 datetime of when recording ended."""
+
+    recording_id: Optional[str] = None
+    """ID of the conference recording."""
+
+    recording_started_at: Optional[datetime] = None
+    """ISO 8601 datetime of when recording started."""
+
+    recording_urls: Optional[DataPayloadRecordingURLs] = None
+    """Recording URLs in requested format.
+
+    These URLs are valid for 10 minutes. After 10 minutes, you may retrieve
+    recordings via API using Reports -> Call Recordings documentation, or via
+    Mission Control under Reporting -> Recordings.
+    """
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.recording.saved"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceRecordingSavedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_speak_ended_webhook_event.py

@@ -0,0 +1,40 @@
+# 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__ = ["ConferenceSpeakEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.speak.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_speak_started_webhook_event.py

@@ -0,0 +1,40 @@
+# 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__ = ["ConferenceSpeakStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.speak.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conferences/action_hold_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionHoldParams"]
 
 
@@ -15,7 +16,7 @@ class ActionHoldParams(TypedDict, total=False):
     media_name and audio_url cannot be used together in one request.
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """List of unique identifiers and tokens for controlling the call.
 
     When empty all participants will be placed on hold.

telnyx/types/conferences/action_join_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionJoinParams"]
 
 
@@ -92,7 +93,7 @@ class ActionJoinParams(TypedDict, total=False):
     Defaults to "none".
     """
 
-    whisper_call_control_ids: List[str]
+    whisper_call_control_ids: SequenceNotStr[str]
     """Array of unique call_control_ids the joining supervisor can whisper to.
 
     If none provided, the supervisor will join the conference as a monitoring

telnyx/types/conferences/action_mute_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionMuteParams"]
 
 
 class ActionMuteParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Array of unique identifiers and tokens for controlling the call.
 
     When empty all participants will be muted.

telnyx/types/conferences/action_play_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.loopcount_param import LoopcountParam
 
 __all__ = ["ActionPlayParams"]
@@ -17,7 +17,7 @@ class ActionPlayParams(TypedDict, total=False):
     media_name and audio_url cannot be used together in one request.
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should be
     played to. If not given, the audio file will be played to the entire conference.

telnyx/types/conferences/action_speak_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.aws_voice_settings_param import AwsVoiceSettingsParam
 from ..calls.telnyx_voice_settings_param import TelnyxVoiceSettingsParam
 from ..calls.eleven_labs_voice_settings_param import ElevenLabsVoiceSettingsParam
@@ -47,7 +48,7 @@ class ActionSpeakParams(TypedDict, total=False):
     female).
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Call Control IDs of participants who will hear the spoken text.
 
     When empty all participants will hear the spoken text.

telnyx/types/conferences/action_stop_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionStopParams"]
 
 
 class ActionStopParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should stop be
     played to. If not given, the audio will be stoped to the entire conference.

telnyx/types/conferences/action_unhold_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUnholdParams"]
 
 
 class ActionUnholdParams(TypedDict, total=False):
-    call_control_ids: Required[List[str]]
+    call_control_ids: Required[SequenceNotStr[str]]
     """List of unique identifiers and tokens for controlling the call.
 
     Enter each call control ID to be unheld.