telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/conference_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 .conference import Conference
+
+__all__ = ["ConferenceRetrieveResponse"]
+
+
+class ConferenceRetrieveResponse(BaseModel):
+    data: Optional[Conference] = None

telnyx/types/conferences/__init__.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .action_hold_params import ActionHoldParams as ActionHoldParams
+from .action_join_params import ActionJoinParams as ActionJoinParams
+from .action_mute_params import ActionMuteParams as ActionMuteParams
+from .action_play_params import ActionPlayParams as ActionPlayParams
+from .action_stop_params import ActionStopParams as ActionStopParams
+from .action_leave_params import ActionLeaveParams as ActionLeaveParams
+from .action_speak_params import ActionSpeakParams as ActionSpeakParams
+from .action_hold_response import ActionHoldResponse as ActionHoldResponse
+from .action_join_response import ActionJoinResponse as ActionJoinResponse
+from .action_mute_response import ActionMuteResponse as ActionMuteResponse
+from .action_play_response import ActionPlayResponse as ActionPlayResponse
+from .action_stop_response import ActionStopResponse as ActionStopResponse
+from .action_unhold_params import ActionUnholdParams as ActionUnholdParams
+from .action_unmute_params import ActionUnmuteParams as ActionUnmuteParams
+from .action_update_params import ActionUpdateParams as ActionUpdateParams
+from .action_leave_response import ActionLeaveResponse as ActionLeaveResponse
+from .action_speak_response import ActionSpeakResponse as ActionSpeakResponse
+from .action_unhold_response import ActionUnholdResponse as ActionUnholdResponse
+from .action_unmute_response import ActionUnmuteResponse as ActionUnmuteResponse
+from .action_update_response import ActionUpdateResponse as ActionUpdateResponse
+from .action_record_stop_params import ActionRecordStopParams as ActionRecordStopParams
+from .conference_command_result import ConferenceCommandResult as ConferenceCommandResult
+from .action_record_pause_params import ActionRecordPauseParams as ActionRecordPauseParams
+from .action_record_start_params import ActionRecordStartParams as ActionRecordStartParams
+from .action_record_resume_params import ActionRecordResumeParams as ActionRecordResumeParams
+from .action_record_stop_response import ActionRecordStopResponse as ActionRecordStopResponse
+from .action_record_pause_response import ActionRecordPauseResponse as ActionRecordPauseResponse
+from .action_record_start_response import ActionRecordStartResponse as ActionRecordStartResponse
+from .action_record_resume_response import ActionRecordResumeResponse as ActionRecordResumeResponse

telnyx/types/conferences/action_hold_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+__all__ = ["ActionHoldParams"]
+
+
+class ActionHoldParams(TypedDict, total=False):
+    audio_url: str
+    """The URL of a file to be played to the participants when they are put on hold.
+
+    media_name and audio_url cannot be used together in one request.
+    """
+
+    call_control_ids: List[str]
+    """List of unique identifiers and tokens for controlling the call.
+
+    When empty all participants will be placed on hold.
+    """
+
+    media_name: str
+    """
+    The media_name of a file to be played to the participants when they are put on
+    hold. The media_name must point to a file previously uploaded to
+    api.telnyx.com/v2/media by the same user/organization. The file must either be a
+    WAV or MP3 file.
+    """

telnyx/types/conferences/action_hold_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionHoldResponse"]
+
+
+class ActionHoldResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_join_params.py

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ActionJoinParams"]
+
+
+class ActionJoinParams(TypedDict, total=False):
+    call_control_id: Required[str]
+    """Unique identifier and token for controlling the call"""
+
+    beep_enabled: Literal["always", "never", "on_enter", "on_exit"]
+    """
+    Whether a beep sound should be played when the participant joins and/or leaves
+    the conference. Can be used to override the conference-level setting.
+    """
+
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string. Please note that the client_state
+    will be updated for the participient call leg and the change will not affect
+    conferencing webhooks unless the participient is the owner of the conference.
+    """
+
+    command_id: str
+    """Use this field to avoid execution of duplicate commands.
+
+    Telnyx will ignore subsequent commands with the same `command_id` as one that
+    has already been executed.
+    """
+
+    end_conference_on_exit: bool
+    """
+    Whether the conference should end and all remaining participants be hung up
+    after the participant leaves the conference. Defaults to "false".
+    """
+
+    hold: bool
+    """
+    Whether the participant should be put on hold immediately after joining the
+    conference. Defaults to "false".
+    """
+
+    hold_audio_url: str
+    """
+    The URL of a file to be played to the participant when they are put on hold
+    after joining the conference. hold_media_name and hold_audio_url cannot be used
+    together in one request. Takes effect only when "start_conference_on_create" is
+    set to "false". This property takes effect only if "hold" is set to "true".
+    """
+
+    hold_media_name: str
+    """
+    The media_name of a file to be played to the participant when they are put on
+    hold after joining the conference. The media_name must point to a file
+    previously uploaded to api.telnyx.com/v2/media by the same user/organization.
+    The file must either be a WAV or MP3 file. Takes effect only when
+    "start_conference_on_create" is set to "false". This property takes effect only
+    if "hold" is set to "true".
+    """
+
+    mute: bool
+    """Whether the participant should be muted immediately after joining the
+    conference.
+
+    Defaults to "false".
+    """
+
+    soft_end_conference_on_exit: bool
+    """Whether the conference should end after the participant leaves the conference.
+
+    NOTE this doesn't hang up the other participants. Defaults to "false".
+    """
+
+    start_conference_on_enter: bool
+    """
+    Whether the conference should be started after the participant joins the
+    conference. Defaults to "false".
+    """
+
+    supervisor_role: Literal["barge", "monitor", "none", "whisper"]
+    """Sets the joining participant as a supervisor for the conference.
+
+    A conference can have multiple supervisors. "barge" means the supervisor enters
+    the conference as a normal participant. This is the same as "none". "monitor"
+    means the supervisor is muted but can hear all participants. "whisper" means
+    that only the specified "whisper_call_control_ids" can hear the supervisor.
+    Defaults to "none".
+    """
+
+    whisper_call_control_ids: List[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
+    participant only.
+    """

telnyx/types/conferences/action_join_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionJoinResponse"]
+
+
+class ActionJoinResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_leave_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ActionLeaveParams"]
+
+
+class ActionLeaveParams(TypedDict, total=False):
+    call_control_id: Required[str]
+    """Unique identifier and token for controlling the call"""
+
+    beep_enabled: Literal["always", "never", "on_enter", "on_exit"]
+    """Whether a beep sound should be played when the participant leaves the
+    conference.
+
+    Can be used to override the conference-level setting.
+    """
+
+    command_id: str
+    """Use this field to avoid execution of duplicate commands.
+
+    Telnyx will ignore subsequent commands with the same `command_id` as one that
+    has already been executed.
+    """

telnyx/types/conferences/action_leave_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionLeaveResponse"]
+
+
+class ActionLeaveResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_mute_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+__all__ = ["ActionMuteParams"]
+
+
+class ActionMuteParams(TypedDict, total=False):
+    call_control_ids: List[str]
+    """Array of unique identifiers and tokens for controlling the call.
+
+    When empty all participants will be muted.
+    """

telnyx/types/conferences/action_mute_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionMuteResponse"]
+
+
+class ActionMuteResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_play_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+from ..calls.loopcount_param import LoopcountParam
+
+__all__ = ["ActionPlayParams"]
+
+
+class ActionPlayParams(TypedDict, total=False):
+    audio_url: str
+    """The URL of a file to be played back in the conference.
+
+    media_name and audio_url cannot be used together in one request.
+    """
+
+    call_control_ids: List[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.
+    """
+
+    loop: LoopcountParam
+    """The number of times the audio file should be played.
+
+    If supplied, the value must be an integer between 1 and 100, or the special
+    string `infinity` for an endless loop.
+    """
+
+    media_name: str
+    """The media_name of a file to be played back in the conference.
+
+    The media_name must point to a file previously uploaded to
+    api.telnyx.com/v2/media by the same user/organization. The file must either be a
+    WAV or MP3 file.
+    """

telnyx/types/conferences/action_play_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionPlayResponse"]
+
+
+class ActionPlayResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_record_pause_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_extensions import TypedDict
+
+__all__ = ["ActionRecordPauseParams"]
+
+
+class ActionRecordPauseParams(TypedDict, total=False):
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    recording_id: str
+    """Use this field to pause specific recording."""

telnyx/types/conferences/action_record_pause_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionRecordPauseResponse"]
+
+
+class ActionRecordPauseResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_record_resume_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_extensions import TypedDict
+
+__all__ = ["ActionRecordResumeParams"]
+
+
+class ActionRecordResumeParams(TypedDict, total=False):
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    recording_id: str
+    """Use this field to resume specific recording."""

telnyx/types/conferences/action_record_resume_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionRecordResumeResponse"]
+
+
+class ActionRecordResumeResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_record_start_params.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ActionRecordStartParams"]
+
+
+class ActionRecordStartParams(TypedDict, total=False):
+    format: Required[Literal["wav", "mp3"]]
+    """The audio file format used when storing the conference recording.
+
+    Can be either `mp3` or `wav`.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `conference_id`.
+    """
+
+    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.
+    """
+
+    play_beep: bool
+    """If enabled, a beep sound will be played at the start of a recording."""
+
+    trim: Literal["trim-silence"]
+    """
+    When set to `trim-silence`, silence will be removed from the beginning and end
+    of the recording.
+    """

telnyx/types/conferences/action_record_start_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionRecordStartResponse"]
+
+
+class ActionRecordStartResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_record_stop_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ActionRecordStopParams"]
+
+
+class ActionRecordStopParams(TypedDict, total=False):
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    recording_id: str
+    """Uniquely identifies the resource."""

telnyx/types/conferences/action_record_stop_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionRecordStopResponse"]
+
+
+class ActionRecordStopResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_speak_params.py

@@ -0,0 +1,110 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+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
+
+__all__ = ["ActionSpeakParams", "VoiceSettings"]
+
+
+class ActionSpeakParams(TypedDict, total=False):
+    payload: Required[str]
+    """The text or SSML to be converted into speech. There is a 3,000 character limit."""
+
+    voice: Required[str]
+    """Specifies the voice used in speech synthesis.
+
+    - Define voices using the format `<Provider>.<Model>.<VoiceId>`. Specifying only
+      the provider will give default values for voice_id and model_id.
+
+      **Supported Providers:**
+
+    - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
+      voices, which provide more realistic, human-like speech, append `-Neural` to
+      the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
+      [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
+      for compatibility.
+    - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
+      Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
+      Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
+      [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+    - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
+      `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part
+      is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an
+      integration identifier secret in
+      `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. See
+      [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+      for details. Check
+      [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
+    - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
+
+    For service_level basic, you may define the gender of the speaker (male or
+    female).
+    """
+
+    call_control_ids: List[str]
+    """Call Control IDs of participants who will hear the spoken text.
+
+    When empty all participants will hear the spoken text.
+    """
+
+    command_id: str
+    """Use this field to avoid execution of duplicate commands.
+
+    Telnyx will ignore subsequent commands with the same `command_id` as one that
+    has already been executed.
+    """
+
+    language: Literal[
+        "arb",
+        "cmn-CN",
+        "cy-GB",
+        "da-DK",
+        "de-DE",
+        "en-AU",
+        "en-GB",
+        "en-GB-WLS",
+        "en-IN",
+        "en-US",
+        "es-ES",
+        "es-MX",
+        "es-US",
+        "fr-CA",
+        "fr-FR",
+        "hi-IN",
+        "is-IS",
+        "it-IT",
+        "ja-JP",
+        "ko-KR",
+        "nb-NO",
+        "nl-NL",
+        "pl-PL",
+        "pt-BR",
+        "pt-PT",
+        "ro-RO",
+        "ru-RU",
+        "sv-SE",
+        "tr-TR",
+    ]
+    """The language you want spoken.
+
+    This parameter is ignored when a `Polly.*` voice is specified.
+    """
+
+    payload_type: Literal["text", "ssml"]
+    """The type of the provided payload.
+
+    The payload can either be plain text, or Speech Synthesis Markup Language
+    (SSML).
+    """
+
+    voice_settings: VoiceSettings
+    """The settings associated with the voice selected"""
+
+
+VoiceSettings: TypeAlias = Union[ElevenLabsVoiceSettingsParam, TelnyxVoiceSettingsParam, AwsVoiceSettingsParam]

telnyx/types/conferences/action_speak_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionSpeakResponse"]
+
+
+class ActionSpeakResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_stop_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+__all__ = ["ActionStopParams"]
+
+
+class ActionStopParams(TypedDict, total=False):
+    call_control_ids: List[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_stop_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 .conference_command_result import ConferenceCommandResult
+
+__all__ = ["ActionStopResponse"]
+
+
+class ActionStopResponse(BaseModel):
+    data: Optional[ConferenceCommandResult] = None

telnyx/types/conferences/action_unhold_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionUnholdParams"]
+
+
+class ActionUnholdParams(TypedDict, total=False):
+    call_control_ids: Required[List[str]]
+    """List of unique identifiers and tokens for controlling the call.
+
+    Enter each call control ID to be unheld.
+    """