telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/tailscale_subnet_router.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#list
+    class TailscaleSubnetRouter < Telnyx::Internal::Type::BaseModel
+      # @!attribute advertised_routes
+      #   IPv4 subnets of the Network that the router advertises to the tailnet. Each
+      #   entry is a canonical CIDR that the Network routes. Default, loopback,
+      #   link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+      #   are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+      #
+      #   @return [Array<String>, nil]
+      optional :advertised_routes, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute name
+      #   A user specified name for the router.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute network_id
+      #   The id of the Network the router is attached to.
+      #
+      #   @return [String, nil]
+      optional :network_id, String
+
+      # @!attribute region_code
+      #   The code of the region the router is created in. `GET /network_coverage` lists
+      #   the regions whose `available_services` include `tailscale_subnet_router`.
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      response_only do
+        # @!attribute id
+        #   Identifies the resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date-time indicating when the resource was created.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_address
+        #   The router's address on the Network, from `172.27.254.0/24`. Tailnet traffic
+        #   enters the Network from this address.
+        #
+        #   @return [String, nil]
+        optional :customer_address, String
+
+        # @!attribute device_id
+        #   The router's node id on the tailnet. Set once the router has enrolled.
+        #
+        #   @return [String, nil]
+        optional :device_id, String, nil?: true
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute status
+        #   `provisioning`: Telnyx is creating the router or applying a change.
+        #   `provisioned`: the router is on the tailnet and advertises its routes; the
+        #   tailnet still approves them. `failed`: enrollment did not complete, and `PATCH`
+        #   retries it. `deleting`: the router is being removed.
+        #
+        #   @return [Symbol, Telnyx::Models::TailscaleSubnetRouter::Status, nil]
+        optional :status, enum: -> { Telnyx::TailscaleSubnetRouter::Status }
+
+        # @!attribute tailnet_name
+        #   The name of the tailnet the router is enrolled in. Set once the router has
+        #   enrolled.
+        #
+        #   @return [String, nil]
+        optional :tailnet_name, String, nil?: true
+
+        # @!attribute tailscale_ips
+        #   The router's addresses on the tailnet. Empty until the router has enrolled.
+        #
+        #   @return [Array<String>, nil]
+        optional :tailscale_ips, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date-time indicating when the resource was updated.
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+      end
+
+      # @!method initialize(id: nil, advertised_routes: nil, created_at: nil, customer_address: nil, device_id: nil, name: nil, network_id: nil, record_type: nil, region_code: nil, status: nil, tailnet_name: nil, tailscale_ips: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::TailscaleSubnetRouter} for more details.
+      #
+      #   @param id [String] Identifies the resource.
+      #
+      #   @param advertised_routes [Array<String>] IPv4 subnets of the Network that the router advertises to the tailnet. Each entr
+      #
+      #   @param created_at [Time] ISO 8601 formatted date-time indicating when the resource was created.
+      #
+      #   @param customer_address [String] The router's address on the Network, from `172.27.254.0/24`. Tailnet traffic ent
+      #
+      #   @param device_id [String, nil] The router's node id on the tailnet. Set once the router has enrolled.
+      #
+      #   @param name [String] A user specified name for the router.
+      #
+      #   @param network_id [String] The id of the Network the router is attached to.
+      #
+      #   @param record_type [String] Identifies the type of the resource.
+      #
+      #   @param region_code [String] The code of the region the router is created in. `GET /network_coverage` lists t
+      #
+      #   @param status [Symbol, Telnyx::Models::TailscaleSubnetRouter::Status] `provisioning`: Telnyx is creating the router or applying a change. `provisioned
+      #
+      #   @param tailnet_name [String, nil] The name of the tailnet the router is enrolled in. Set once the router has enrol
+      #
+      #   @param tailscale_ips [Array<String>] The router's addresses on the tailnet. Empty until the router has enrolled.
+      #
+      #   @param updated_at [Time] ISO 8601 formatted date-time indicating when the resource was updated.
+
+      # `provisioning`: Telnyx is creating the router or applying a change.
+      # `provisioned`: the router is on the tailnet and advertises its routes; the
+      # tailnet still approves them. `failed`: enrollment did not complete, and `PATCH`
+      # retries it. `deleting`: the router is being removed.
+      #
+      # @see Telnyx::Models::TailscaleSubnetRouter#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        PROVISIONING = :provisioning
+        PROVISIONED = :provisioned
+        FAILED = :failed
+        DELETING = :deleting
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_create_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#create
+    class TailscaleSubnetRouterCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute advertised_routes
+      #   IPv4 subnets of the Network that the router advertises to the tailnet. Each
+      #   entry is a canonical CIDR that the Network routes. Default, loopback,
+      #   link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+      #   are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+      #
+      #   @return [Array<String>]
+      required :advertised_routes, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute auth_key
+      #   A Tailscale auth key that enrolls the router in the user's tailnet: reusable,
+      #   pre-approved, tagged, and not ephemeral. Telnyx stores it encrypted until
+      #   enrollment succeeds, then discards it. It is never returned.
+      #
+      #   @return [String]
+      required :auth_key, String
+
+      # @!attribute name
+      #   A user specified name for the router.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute network_id
+      #   The id of the Network to attach the router to.
+      #
+      #   @return [String]
+      required :network_id, String
+
+      # @!attribute region_code
+      #   The code of the region to create the router in. `GET /network_coverage` lists
+      #   the regions whose `available_services` include `tailscale_subnet_router`.
+      #
+      #   @return [String]
+      required :region_code, String
+
+      # @!method initialize(advertised_routes:, auth_key:, name:, network_id:, region_code:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::TailscaleSubnetRouterCreateParams} for more details.
+      #
+      #   @param advertised_routes [Array<String>] IPv4 subnets of the Network that the router advertises to the tailnet. Each entr
+      #
+      #   @param auth_key [String] A Tailscale auth key that enrolls the router in the user's tailnet: reusable, pr
+      #
+      #   @param name [String] A user specified name for the router.
+      #
+      #   @param network_id [String] The id of the Network to attach the router to.
+      #
+      #   @param region_code [String] The code of the region to create the router in. `GET /network_coverage` lists th
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#create
+    class TailscaleSubnetRouterCreateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::TailscaleSubnetRouter, nil]
+      optional :data, -> { Telnyx::TailscaleSubnetRouter }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::TailscaleSubnetRouter]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#delete
+    class TailscaleSubnetRouterDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#delete
+    class TailscaleSubnetRouterDeleteResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::TailscaleSubnetRouter, nil]
+      optional :data, -> { Telnyx::TailscaleSubnetRouter }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::TailscaleSubnetRouter]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_list_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#list
+    class TailscaleSubnetRouterListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter
+      #   Consolidated filter parameter (deepObject style). Originally: filter[network_id]
+      #
+      #   @return [Telnyx::Models::TailscaleSubnetRouterListParams::Filter, nil]
+      optional :filter, -> { Telnyx::TailscaleSubnetRouterListParams::Filter }
+
+      # @!attribute page_number
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(filter: nil, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::TailscaleSubnetRouterListParams} for more details.
+      #
+      #   @param filter [Telnyx::Models::TailscaleSubnetRouterListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[network_id]
+      #
+      #   @param page_number [Integer]
+      #
+      #   @param page_size [Integer]
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class Filter < Telnyx::Internal::Type::BaseModel
+        # @!attribute network_id
+        #   The id of the Network to filter on.
+        #
+        #   @return [String, nil]
+        optional :network_id, String
+
+        # @!method initialize(network_id: nil)
+        #   Consolidated filter parameter (deepObject style). Originally: filter[network_id]
+        #
+        #   @param network_id [String] The id of the Network to filter on.
+      end
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#retrieve
+    class TailscaleSubnetRouterRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#retrieve
+    class TailscaleSubnetRouterRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::TailscaleSubnetRouter, nil]
+      optional :data, -> { Telnyx::TailscaleSubnetRouter }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::TailscaleSubnetRouter]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#update
+    class TailscaleSubnetRouterUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute advertised_routes
+      #   IPv4 subnets of the Network that the router advertises to the tailnet. Each
+      #   entry is a canonical CIDR that the Network routes. Default, loopback,
+      #   link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+      #   are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+      #
+      #   @return [Array<String>, nil]
+      optional :advertised_routes, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute auth_key
+      #   A replacement Tailscale auth key. Accepted only while the router has never
+      #   enrolled, for example after a `failed` enrollment. Never returned.
+      #
+      #   @return [String, nil]
+      optional :auth_key, String
+
+      # @!attribute name
+      #   A user specified name for the router.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(id:, advertised_routes: nil, auth_key: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::TailscaleSubnetRouterUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param advertised_routes [Array<String>] IPv4 subnets of the Network that the router advertises to the tailnet. Each entr
+      #
+      #   @param auth_key [String] A replacement Tailscale auth key. Accepted only while the router has never enrol
+      #
+      #   @param name [String] A user specified name for the router.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/tailscale_subnet_router_update_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::TailscaleSubnetRouters#update
+    class TailscaleSubnetRouterUpdateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::TailscaleSubnetRouter, nil]
+      optional :data, -> { Telnyx::TailscaleSubnetRouter }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::TailscaleSubnetRouter]
+    end
+  end
+end

data/lib/telnyx/models/telephony_credential_create_token_params.rb

@@ -12,8 +12,14 @@ module Telnyx
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(id:, idempotency_key: nil, request_options: {})
       #   @param id [String]
+      #   @param idempotency_key [String]
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/telnyx/models/texml/accounts/call_calls_params.rb

@@ -43,7 +43,12 @@ module Telnyx
               required :url, String, api_name: :Url
 
               # @!attribute application_sid
-              #   The ID of the TeXML Application.
+              #   The ID of the TeXML Application that will handle the call, for example
+              #   `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              #   compatibility, but the value is the numeric ID of one of your TeXML Applications
+              #   (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              #   `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              #   the XML Request URL configured on this application.
               #
               #   @return [String, nil]
               optional :application_sid, String, api_name: :ApplicationSid
@@ -483,7 +488,7 @@ module Telnyx
               #
               #   @param url [String] The URL from which Telnyx will retrieve the TeXML call instructions.
               #
-              #   @param application_sid [String] The ID of the TeXML Application.
+              #   @param application_sid [String] The ID of the TeXML Application that will handle the call, for example `12933842
               #
               #   @param async_amd [Boolean] Select whether to perform answering machine detection in the background. By defa
               #
@@ -833,7 +838,12 @@ module Telnyx
               required :texml, String, api_name: :Texml
 
               # @!attribute application_sid
-              #   The ID of the TeXML Application.
+              #   The ID of the TeXML Application that will handle the call, for example
+              #   `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              #   compatibility, but the value is the numeric ID of one of your TeXML Applications
+              #   (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              #   `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              #   the XML Request URL configured on this application.
               #
               #   @return [String, nil]
               optional :application_sid, String, api_name: :ApplicationSid
@@ -1279,7 +1289,7 @@ module Telnyx
               #
               #   @param texml [String] TeXML to be used as instructions for the call. If provided, the call will execut
               #
-              #   @param application_sid [String] The ID of the TeXML Application.
+              #   @param application_sid [String] The ID of the TeXML Application that will handle the call, for example `12933842
               #
               #   @param async_amd [Boolean] Select whether to perform answering machine detection in the background. By defa
               #
@@ -1622,7 +1632,12 @@ module Telnyx
 
             class ApplicationDefault < Telnyx::Internal::Type::BaseModel
               # @!attribute application_sid
-              #   The ID of the TeXML Application.
+              #   The ID of the TeXML Application that will handle the call, for example
+              #   `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              #   compatibility, but the value is the numeric ID of one of your TeXML Applications
+              #   (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              #   `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              #   the XML Request URL configured on this application.
               #
               #   @return [String, nil]
               optional :application_sid, String, api_name: :ApplicationSid
@@ -2079,7 +2094,7 @@ module Telnyx
               #   {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault} for
               #   more details.
               #
-              #   @param application_sid [String] The ID of the TeXML Application.
+              #   @param application_sid [String] The ID of the TeXML Application that will handle the call, for example `12933842
               #
               #   @param async_amd [Boolean] Select whether to perform answering machine detection in the background. By defa
               #

data/lib/telnyx/models/texml_application.rb

@@ -186,8 +186,8 @@ module Telnyx
         #   in the same way a phone number is used, from a SIP endpoint. Example: the
         #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-        #   subdomain calls.
+        #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        #   TLS transport.
         #
         #   @return [String, nil]
         optional :sip_subdomain, String

data/lib/telnyx/models/texml_application_create_params.rb

@@ -158,8 +158,8 @@ module Telnyx
         #   in the same way a phone number is used, from a SIP endpoint. Example: the
         #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-        #   subdomain calls.
+        #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        #   TLS transport.
         #
         #   @return [String, nil]
         optional :sip_subdomain, String

data/lib/telnyx/models/texml_application_update_params.rb

@@ -165,8 +165,8 @@ module Telnyx
         #   in the same way a phone number is used, from a SIP endpoint. Example: the
         #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-        #   subdomain calls.
+        #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        #   TLS transport.
         #
         #   @return [String, nil]
         optional :sip_subdomain, String

data/lib/telnyx/models/text_to_speech_generate_speech_params.rb

@@ -80,7 +80,10 @@ module Telnyx
       # @!attribute telnyx
       #   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
+      #   or `emotion`. `Bayan` accepts `voice_speed` from 0.5 to 2.0; `Sukhan` doesn't
+      #   support it. `Bayan` synthesizes at a native 16 kHz: `sampling_rate` `8000`,
+      #   `22050`, or `24000` is resampled, needs `response_format: pcm`, and isn't
+      #   available with `output_type: audio_id`. `Sukhan`'s `response_format` is
       #   restricted to `mp3` or `pcm` (no `wav`).
       #
       #   @return [::Telnyx::Models::TextToSpeechGenerateSpeechParams::Telnyx, nil]
@@ -447,12 +450,6 @@ module Telnyx
       end
 
       class Resemble < ::Telnyx::Internal::Type::BaseModel
-        # @!attribute api_key
-        #   Custom Resemble API key.
-        #
-        #   @return [String, nil]
-        optional :api_key, String
-
         # @!attribute file_format
         #   Audio output format.
         #
@@ -471,11 +468,9 @@ module Telnyx
         #   @return [String, nil]
         optional :sample_rate, String
 
-        # @!method initialize(api_key: nil, file_format: nil, precision: nil, sample_rate: nil)
+        # @!method initialize(file_format: nil, precision: nil, sample_rate: nil)
         #   Resemble AI provider-specific parameters.
         #
-        #   @param api_key [String] Custom Resemble API key.
-        #
         #   @param file_format [String] Audio output format.
         #
         #   @param precision [String] Synthesis precision.
@@ -611,16 +606,19 @@ module Telnyx
         optional :response_format, String
 
         # @!attribute sampling_rate
-        #   Audio sampling rate in Hz.
+        #   Audio sampling rate in Hz. `Bayan` ignores the default and synthesizes at its
+        #   native 16 kHz unless `8000`, `22050`, or `24000` is set explicitly with
+        #   `response_format: pcm`. Resampled rates aren't available with
+        #   `output_type: audio_id`.
         #
         #   @return [Integer, nil]
         optional :sampling_rate, Integer
 
         # @!attribute voice_speed
         #   Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 —
-        #   requests outside that range are rejected by the synthesis engine. `KokoroTTS`
-        #   and `Qwen3TTS` accept the field but do not apply it. `Bayan` and `Sukhan` don't
-        #   support it.
+        #   requests outside that range are rejected by the synthesis engine. `Bayan`
+        #   accepts values from 0.5 to 2.0. `KokoroTTS` and `Qwen3TTS` accept the field but
+        #   do not apply it. `Sukhan` doesn't support it.
         #
         #   @return [Float, nil]
         optional :voice_speed, Float
@@ -640,14 +638,17 @@ module Telnyx
         #
         #   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
+        #   or `emotion`. `Bayan` accepts `voice_speed` from 0.5 to 2.0; `Sukhan` doesn't
+        #   support it. `Bayan` synthesizes at a native 16 kHz: `sampling_rate` `8000`,
+        #   `22050`, or `24000` is resampled, needs `response_format: pcm`, and isn't
+        #   available with `output_type: audio_id`. `Sukhan`'s `response_format` is
         #   restricted to `mp3` or `pcm` (no `wav`).
         #
         #   @param emotion [Symbol, ::Telnyx::Models::TextToSpeechGenerateSpeechParams::Telnyx::Emotion] Emotion control for the Ultra model. Adjusts the emotional tone of the synthesiz
         #
         #   @param response_format [String] Audio response format.
         #
-        #   @param sampling_rate [Integer] Audio sampling rate in Hz.
+        #   @param sampling_rate [Integer] Audio sampling rate in Hz. `Bayan` ignores the default and synthesizes at its na
         #
         #   @param voice_speed [Float] Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 — re
         #