telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi

@@ -7,7 +7,8 @@ module Telnyx
         class Conferences
           # TeXML REST Commands
           class Participants
-            # Gets conference participant resource
+            # Returns a single conference participant resource by call SID or participant
+            # label.
             sig do
               params(
                 call_sid_or_participant_label: String,
@@ -29,7 +30,8 @@ module Telnyx
             )
             end
 
-            # Updates a conference participant
+            # Updates the specified conference participant, for example muting or holding
+            # them, and returns the updated participant.
             sig do
               params(
                 call_sid_or_participant_label: String,
@@ -96,7 +98,8 @@ module Telnyx
             )
             end
 
-            # Deletes a conference participant
+            # Removes the specified participant from the conference, ending their leg of the
+            # call.
             sig do
               params(
                 call_sid_or_participant_label: String,
@@ -116,7 +119,8 @@ module Telnyx
             )
             end
 
-            # Dials a new conference participant
+            # Dials a new participant into the specified conference and returns the created
+            # participant resource.
             sig do
               params(
                 conference_sid: String,
@@ -354,7 +358,7 @@ module Telnyx
             )
             end
 
-            # Lists conference participants
+            # Returns the list of participants currently in the specified conference.
             sig do
               params(
                 conference_sid: String,

data/rbi/telnyx/resources/texml/accounts/conferences.rbi

@@ -14,7 +14,7 @@ module Telnyx
           end
           attr_reader :participants
 
-          # Returns a conference resource.
+          # Returns a single conference resource for the account by its ConferenceSid.
           sig do
             params(
               conference_sid: String,
@@ -31,7 +31,8 @@ module Telnyx
           )
           end
 
-          # Updates a conference resource.
+          # Updates the specified conference resource, for example to modify its status, and
+          # returns the updated conference.
           sig do
             params(
               conference_sid: String,
@@ -61,7 +62,8 @@ module Telnyx
           )
           end
 
-          # Lists conference resources.
+          # Returns a paginated list of conference resources for the account, with support
+          # for filtering by friendly name, status, and creation or update dates.
           sig do
             params(
               account_sid: String,
@@ -102,7 +104,7 @@ module Telnyx
           )
           end
 
-          # Lists conference recordings
+          # Returns the list of recordings made for the specified conference.
           sig do
             params(
               conference_sid: String,

data/rbi/telnyx/resources/texml/accounts/queues.rbi

@@ -6,7 +6,8 @@ module Telnyx
       class Accounts
         # TeXML REST Commands
         class Queues
-          # Creates a new queue resource.
+          # Creates a new queue resource for the account with the provided settings and
+          # returns it.
           sig do
             params(
               account_sid: String,
@@ -26,7 +27,7 @@ module Telnyx
           )
           end
 
-          # Returns a queue resource.
+          # Returns a single queue resource for the account by its QueueSid.
           sig do
             params(
               queue_sid: String,
@@ -43,7 +44,7 @@ module Telnyx
           )
           end
 
-          # Updates a queue resource.
+          # Updates the specified queue resource's settings and returns the updated queue.
           sig do
             params(
               queue_sid: String,
@@ -63,7 +64,8 @@ module Telnyx
           )
           end
 
-          # Lists queue resources.
+          # Returns a paginated list of queue resources for the account, with support for
+          # filtering by creation or update dates.
           sig do
             params(
               account_sid: String,
@@ -99,7 +101,7 @@ module Telnyx
           )
           end
 
-          # Delete a queue resource.
+          # Permanently deletes the specified queue resource from the account.
           sig do
             params(
               queue_sid: String,

data/rbi/telnyx/resources/texml_applications.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # TeXML Applications operations
     class TexmlApplications
-      # Creates a TeXML Application.
+      # Creates a TeXML application, which defines the voice URLs and settings used to
+      # serve TeXML instructions for calls, and returns the created application.
       sig do
         params(
           friendly_name: String,
@@ -184,7 +185,7 @@ module Telnyx
       )
       end
 
-      # Deletes a TeXML Application.
+      # Permanently deletes the specified TeXML application from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/text_to_speech.rbi

@@ -12,11 +12,11 @@ module Telnyx
       # header.
       #
       # The `voice` parameter provides a convenient shorthand to specify provider,
-      # model, and voice in a single string (e.g. `telnyx.NaturalHD.Alloy` or
-      # `Telnyx.Ultra.<voice_id>`). Alternatively, specify `provider` explicitly along
-      # with provider-specific parameters.
+      # model, and voice in a single string (e.g. `Telnyx.Ultra.<voice_id>`).
+      # Alternatively, specify `provider` explicitly along with provider-specific
+      # parameters.
       #
-      # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
+      # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`,
       # `resemble`, `xai`, `humain`.
       #
       # The Telnyx `Ultra` model supports 44 languages with emotion control, speed
@@ -38,7 +38,6 @@ module Telnyx
             ::Telnyx::TextToSpeechGenerateSpeechParams::Provider::OrSymbol,
           resemble:
             ::Telnyx::TextToSpeechGenerateSpeechParams::Resemble::OrHash,
-          rime: ::Telnyx::TextToSpeechGenerateSpeechParams::Rime::OrHash,
           telnyx: ::Telnyx::TextToSpeechGenerateSpeechParams::Telnyx::OrHash,
           text: String,
           text_type:
@@ -73,10 +72,7 @@ module Telnyx
         provider: nil,
         # Resemble AI provider-specific parameters.
         resemble: nil,
-        # Rime provider-specific parameters.
-        rime: nil,
-        # Telnyx provider-specific parameters. Use `voice_speed` and `temperature` for
-        # `Natural` and `NaturalHD` models. For the `Ultra` model, use `voice_speed`,
+        # Telnyx provider-specific parameters. For the `Ultra` model, use `voice_speed`,
         # `volume`, and `emotion`. `Bayan` and `Sukhan` don't use `temperature`, `volume`,
         # or `emotion`, and don't support `voice_speed`. `Sukhan`'s `response_format` is
         # restricted to `mp3` or `pcm` (no `wav`).
@@ -86,11 +82,11 @@ module Telnyx
         # Text type. Use `ssml` for SSML-formatted input (supported by AWS and Azure).
         text_type: nil,
         # Voice identifier in the format `provider.model_id.voice_id` or
-        # `provider.voice_id`. Examples: `telnyx.NaturalHD.Alloy`,
-        # `Telnyx.Ultra.<voice_id>`, `Telnyx.Bayan.Ahmed`, `Telnyx.Sukhan.urdu-professor`,
-        # `azure.en-US-AvaMultilingualNeural`, `aws.Polly.Generative.Lucia`. When
-        # provided, `provider`, `model_id`, and `voice_id` are extracted automatically and
-        # take precedence over individual parameters.
+        # `provider.voice_id`. Examples: `Telnyx.Ultra.<voice_id>`, `Telnyx.Bayan.Ahmed`,
+        # `Telnyx.Sukhan.urdu-professor`, `azure.en-US-AvaMultilingualNeural`,
+        # `aws.Polly.Generative.Lucia`. When provided, `provider`, `model_id`, and
+        # `voice_id` are extracted automatically and take precedence over individual
+        # parameters.
         voice: nil,
         # Provider-specific voice settings. Contents vary by provider — see
         # provider-specific parameter objects below.
@@ -127,8 +123,8 @@ module Telnyx
       # `Authorization: Bearer <API_KEY>` header. Send JSON frames with text to
       # synthesize; receive JSON frames containing base64-encoded audio chunks.
       #
-      # Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`,
-      # `resemble`, `elevenlabs`, `xai`, `humain`.
+      # Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `resemble`,
+      # `elevenlabs`, `xai`, `humain`.
       #
       # **Connection flow:**
       #
@@ -160,14 +156,13 @@ module Telnyx
         ).void
       end
       def retrieve_speech(
-        # Audio output format override. Supported for Telnyx models. `pcm` and `wav` are
-        # available for `Natural`/`NaturalHD` models. The `Ultra` model outputs PCM at
-        # 24kHz s16le or MP3 at 128kbps 24kHz.
+        # Audio output format override. Supported for Telnyx models. The `Ultra` model
+        # outputs PCM at 24kHz s16le or MP3 at 128kbps 24kHz.
         audio_format: nil,
         # When `true`, bypass the audio cache and generate fresh audio.
         disable_cache: nil,
-        # Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD`,
-        # `Ultra` (Telnyx); `Polly.Generative` (AWS).
+        # Model identifier for the chosen provider. Examples: `Ultra`, `KokoroTTS`
+        # (Telnyx); `Polly.Generative` (AWS).
         model_id: nil,
         # TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is
         # provided.
@@ -176,11 +171,11 @@ module Telnyx
         # generated server-side.
         socket_id: nil,
         # Voice identifier in the format `provider.model_id.voice_id` or
-        # `provider.voice_id` (e.g. `telnyx.NaturalHD.Telnyx_Alloy`,
-        # `Telnyx.Ultra.<voice_id>`, `Telnyx.Bayan.Ahmed`, `Telnyx.Sukhan.urdu-professor`,
-        # or `azure.en-US-AvaMultilingualNeural`). When provided, the `provider`,
-        # `model_id`, and `voice_id` are extracted automatically. Takes precedence over
-        # individual `provider`/`model_id`/`voice_id` parameters.
+        # `provider.voice_id` (e.g. `Telnyx.Ultra.<voice_id>`, `Telnyx.Bayan.Ahmed`,
+        # `Telnyx.Sukhan.urdu-professor`, or `azure.en-US-AvaMultilingualNeural`). When
+        # provided, the `provider`, `model_id`, and `voice_id` are extracted
+        # automatically. Takes precedence over individual `provider`/`model_id`/`voice_id`
+        # parameters.
         voice: nil,
         # Voice identifier for the chosen provider.
         voice_id: nil,

data/rbi/telnyx/resources/traffic_policy_profiles.rbi

@@ -46,7 +46,7 @@ module Telnyx
       )
       end
 
-      # Updates a traffic policy profile.
+      # Updates the specified traffic policy profile and returns the updated profile.
       sig do
         params(
           id: String,
@@ -109,7 +109,7 @@ module Telnyx
       )
       end
 
-      # Deletes the traffic policy profile.
+      # Permanently deletes the specified traffic policy profile from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/uac_connections.rbi

@@ -317,7 +317,7 @@ module Telnyx
       )
       end
 
-      # Deletes an existing UAC connection.
+      # Permanently deletes the specified UAC connection from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/user_addresses.rbi

@@ -8,7 +8,8 @@ module Telnyx
     # cannot be used for emergency calling and are distinct from Address records,
     # which are used on phone numbers.
     class UserAddresses
-      # Creates a user address.
+      # Creates a new user address from the provided details and returns the created
+      # address.
       sig do
         params(
           business_name: String,
@@ -90,7 +91,8 @@ module Telnyx
       )
       end
 
-      # Returns a list of your user addresses.
+      # Returns a paginated list of your user addresses, with support for filtering and
+      # sorting.
       sig do
         params(
           filter: Telnyx::UserAddressListParams::Filter::OrHash,

data/rbi/telnyx/resources/user_tags.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # User-defined tags for Telnyx resources
     class UserTags
-      # List all user tags.
+      # Returns the user tags defined on your account, with support for filtering. Tags
+      # help organize resources such as phone numbers.
       sig do
         params(
           filter: Telnyx::UserTagListParams::Filter::OrHash,

data/rbi/telnyx/resources/verify_profiles.rbi

@@ -37,7 +37,8 @@ module Telnyx
       )
       end
 
-      # Gets a single Verify profile.
+      # Returns the details of a single Verify profile by its ID, including its
+      # verification channel configuration.
       sig do
         params(
           verify_profile_id: String,

data/rbi/telnyx/resources/virtual_cross_connects.rbi

@@ -87,7 +87,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a Virtual Cross Connect.
+      # Returns the details of a single virtual cross connect by its identifier.
       sig do
         params(
           id: String,
@@ -145,7 +145,8 @@ module Telnyx
       )
       end
 
-      # List all Virtual Cross Connects.
+      # Returns a paginated list of the virtual cross connects on your account, with
+      # support for filtering.
       sig do
         params(
           filter: Telnyx::VirtualCrossConnectListParams::Filter::OrHash,
@@ -167,7 +168,7 @@ module Telnyx
       )
       end
 
-      # Delete a Virtual Cross Connect.
+      # Deletes the specified virtual cross connect from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/wireguard_interfaces.rbi

@@ -15,7 +15,7 @@ module Telnyx
       def create(body:, request_options: {})
       end
 
-      # Retrieve a WireGuard Interfaces.
+      # Returns the details of a single WireGuard interface by its identifier.
       sig do
         params(
           id: String,
@@ -29,7 +29,8 @@ module Telnyx
       )
       end
 
-      # List all WireGuard Interfaces.
+      # Returns a paginated list of the WireGuard interfaces on your account, with
+      # support for filtering.
       sig do
         params(
           filter: Telnyx::WireguardInterfaceListParams::Filter::OrHash,
@@ -51,7 +52,7 @@ module Telnyx
       )
       end
 
-      # Delete a WireGuard Interface.
+      # Deletes the specified WireGuard interface from its network.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/wireguard_peers.rbi

@@ -15,7 +15,7 @@ module Telnyx
       def create(body:, request_options: {})
       end
 
-      # Retrieve the WireGuard peer.
+      # Returns the details of a single WireGuard peer by its identifier.
       sig do
         params(
           id: String,
@@ -29,7 +29,7 @@ module Telnyx
       )
       end
 
-      # Update the WireGuard peer.
+      # Updates the specified WireGuard peer and returns the updated peer.
       sig do
         params(
           id: String,
@@ -47,7 +47,7 @@ module Telnyx
       )
       end
 
-      # List all WireGuard peers.
+      # Returns a paginated list of your WireGuard peers, with support for filtering.
       sig do
         params(
           filter: Telnyx::WireguardPeerListParams::Filter::OrHash,
@@ -68,7 +68,7 @@ module Telnyx
       )
       end
 
-      # Delete the WireGuard peer.
+      # Deletes the specified WireGuard peer from its interface.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/wireless/detail_records_reports.rbi

@@ -23,7 +23,8 @@ module Telnyx
         )
         end
 
-        # Returns one specific WDR report
+        # Returns a single Wireless Detail Record (WDR) report by its identifier,
+        # including its parameters and current status.
         sig do
           params(
             id: String,
@@ -56,7 +57,7 @@ module Telnyx
         )
         end
 
-        # Deletes one specific WDR report.
+        # Permanently deletes the specified Wireless Detail Record (WDR) report.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/wireless_blocklist_values.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Wireless Blocklists operations
     class WirelessBlocklistValues
-      # Retrieve all wireless blocklist values for a given blocklist type.
+      # Retrieve all wireless blocklist values for a given blocklist type. The request
+      # returns `422` when `type` is missing or invalid.
       sig do
         params(
           type: Telnyx::WirelessBlocklistValueListParams::Type::OrSymbol,

data/rbi/telnyx/resources/wireless_blocklists.rbi

@@ -38,7 +38,8 @@ module Telnyx
       )
       end
 
-      # Update a Wireless Blocklist.
+      # Updates the specified wireless blocklist. The update is processed
+      # asynchronously, so the request is accepted and completes in the background.
       sig do
         params(
           id: String,
@@ -63,12 +64,13 @@ module Telnyx
         params(
           filter_name: String,
           filter_type: String,
-          filter_values: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(
-          Telnyx::Internal::DefaultFlatPagination[Telnyx::WirelessBlocklist]
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::WirelessWirelessBlocklist
+          ]
         )
       end
       def list(
@@ -76,8 +78,6 @@ module Telnyx
         filter_name: nil,
         # When the Private Wireless Gateway was last updated.
         filter_type: nil,
-        # Values to filter on (inclusive).
-        filter_values: nil,
         # The page number to load.
         page_number: nil,
         # The size of the page.
@@ -86,12 +86,11 @@ module Telnyx
       )
       end
 
-      # Deletes the Wireless Blocklist.
+      # Permanently deletes the specified wireless blocklist from your account. The
+      # request returns `422` when the wireless blocklist is assigned to a SIM Card
+      # Group.
       sig do
-        params(
-          id: String,
-          request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::WirelessBlocklistDeleteResponse)
+        params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end
       def delete(
         # Identifies the wireless blocklist.

data/sig/telnyx/internal/cloudfs_cursor_pagination.rbs

@@ -0,0 +1,36 @@
+module Telnyx
+  module Internal
+    class CloudfsCursorPagination[Elem]
+      include Telnyx::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor meta: Meta
+
+      def inspect: -> String
+
+      type meta = { cursors: Meta::Cursors }
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_reader cursors: Meta::Cursors?
+
+        def cursors=: (Meta::Cursors) -> Meta::Cursors
+
+        def initialize: (?cursors: Meta::Cursors) -> void
+
+        def to_hash: -> { cursors: Meta::Cursors }
+
+        type cursors = { after: String }
+
+        class Cursors < Telnyx::Internal::Type::BaseModel
+          attr_reader after: String?
+
+          def after=: (String) -> String
+
+          def initialize: (?after: String) -> void
+
+          def to_hash: -> { after: String }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/internal/email_bracket_cursor_pagination.rbs

@@ -0,0 +1,24 @@
+module Telnyx
+  module Internal
+    class EmailBracketCursorPagination[Elem]
+      include Telnyx::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor meta: Meta
+
+      def inspect: -> String
+
+      type meta = { page_cursor: String }
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_reader page_cursor: String?
+
+        def page_cursor=: (String) -> String
+
+        def initialize: (?page_cursor: String) -> void
+
+        def to_hash: -> { page_cursor: String }
+      end
+    end
+  end
+end

data/sig/telnyx/internal/email_cursor_pagination.rbs

@@ -0,0 +1,24 @@
+module Telnyx
+  module Internal
+    class EmailCursorPagination[Elem]
+      include Telnyx::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor meta: Meta
+
+      def inspect: -> String
+
+      type meta = { page_cursor: String }
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_reader page_cursor: String?
+
+        def page_cursor=: (String) -> String
+
+        def initialize: (?page_cursor: String) -> void
+
+        def to_hash: -> { page_cursor: String }
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistant_clone_params.rbs

@@ -2,7 +2,8 @@ module Telnyx
   module Models
     module AI
       type assistant_clone_params =
-        { assistant_id: String } & Telnyx::Internal::Type::request_parameters
+        { assistant_id: String, idempotency_key: String }
+        & Telnyx::Internal::Type::request_parameters
 
       class AssistantCloneParams < Telnyx::Internal::Type::BaseModel
         extend Telnyx::Internal::Type::RequestParameters::Converter
@@ -10,13 +11,19 @@ module Telnyx
 
         attr_accessor assistant_id: String
 
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
         def initialize: (
           assistant_id: String,
+          ?idempotency_key: String,
           ?request_options: Telnyx::request_opts
         ) -> void
 
         def to_hash: -> {
           assistant_id: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions
         }
       end

data/sig/telnyx/models/ai/assistant_create_params.rbs

@@ -30,7 +30,8 @@ module Telnyx
           tools: ::Array[Telnyx::Models::AI::assistant_tool],
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,
-          widget_settings: Telnyx::AI::WidgetSettings
+          widget_settings: Telnyx::AI::WidgetSettings,
+          idempotency_key: String
         }
         & Telnyx::Internal::Type::request_parameters
 
@@ -180,6 +181,10 @@ module Telnyx
           Telnyx::AI::WidgetSettings
         ) -> Telnyx::AI::WidgetSettings
 
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
         def initialize: (
           instructions: String,
           name: String,
@@ -209,6 +214,7 @@ module Telnyx
           ?transcription: Telnyx::AI::TranscriptionSettings,
           ?voice_settings: Telnyx::AI::VoiceSettings,
           ?widget_settings: Telnyx::AI::WidgetSettings,
+          ?idempotency_key: String,
           ?request_options: Telnyx::request_opts
         ) -> void
 
@@ -241,6 +247,7 @@ module Telnyx
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,
           widget_settings: Telnyx::AI::WidgetSettings,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions
         }
       end