telnyx 5.171.0 → 5.174.0

data/lib/telnyx/resources/fqdn_connections.rb

@@ -14,7 +14,7 @@ module Telnyx
       # Creates a new FQDN-based SIP connection. FQDN connections authenticate by your
       # registered domain names rather than static IP addresses.
       #
-      # @overload create(connection_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, microsoft_teams_sbc: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload create(connection_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, microsoft_teams_sbc: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
       #
@@ -24,6 +24,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
@@ -32,7 +34,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::InboundFqdn]
       #
@@ -105,7 +107,7 @@ module Telnyx
       #
       # Updates settings of an existing FQDN connection.
       #
-      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param id [String] Identifies the resource.
       #
@@ -115,6 +117,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
@@ -127,7 +131,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::InboundFqdn]
       #

data/lib/telnyx/resources/ip_connections.rb

@@ -10,7 +10,7 @@ module Telnyx
       # Creates a new IP-based SIP connection, which authenticates traffic by source IP
       # address.
       #
-      # @overload create(active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload create(active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param active [Boolean] Defaults to true
       #
@@ -18,6 +18,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param connection_name [String]
@@ -28,7 +30,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::IPConnectionCreateParams::Inbound]
       #
@@ -99,7 +101,7 @@ module Telnyx
       #
       # Updates settings of an existing IP connection.
       #
-      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param id [String] Identifies the type of resource.
       #
@@ -109,6 +111,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param connection_name [String]
@@ -121,7 +125,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::InboundIP]
       #

data/lib/telnyx/resources/meeting_sessions/actions.rb

@@ -33,12 +33,15 @@ module Telnyx
         # {Telnyx::Models::MeetingSessions::ActionSpeakParams} for more details.
         #
         # Sends audio / text-to-speech into a meeting session. With a Telnyx AI Assistant
-        # (or avatar) attached, the bot is a webpage-output bot: the speak audio routes
-        # through the assistant's output page rather than the bot mic and plays once the
-        # assistant is connected -- it is not refused. If that page cannot be reached,
-        # delivery fails with the 502 below, which may arrive without an error envelope,
-        # so branch on the status code before parsing a body. The assistant is designed to
-        # own the conversation, so prefer letting it speak or use `send_chat`.
+        # attached, the bot is a webpage-output bot: the speak audio routes through the
+        # assistant's output page rather than the bot mic and plays once the assistant is
+        # connected -- it is not refused. If that page cannot be reached, delivery fails
+        # with the 502 below, which may arrive without an error envelope, so branch on the
+        # status code before parsing a body. The assistant is designed to own the
+        # conversation, so prefer letting it speak or use `send_chat`. With a digital
+        # avatar (`assistant.avatar: true`), speak is refused with 409 `invalid_state`
+        # (message prefix `avatar_requires_assistant_speech:`): the avatar renders only
+        # the assistant's own speech.
         #
         # @overload speak(id, text:, interrupt: nil, voice: nil, request_options: {})
         #
@@ -66,7 +69,10 @@ module Telnyx
           )
         end
 
-        # Stops any active text-to-speech playback in a meeting session.
+        # Stops any active text-to-speech playback in a meeting session. Sessions with a
+        # digital avatar (`assistant.avatar: true`) return 409 `invalid_state` (message
+        # prefix `avatar_requires_assistant_speech:`): the avatar renders only the
+        # assistant's own speech.
         #
         # @overload stop_speaking(id, request_options: {})
         #

data/lib/telnyx/resources/meeting_sessions.rb

@@ -18,22 +18,25 @@ module Telnyx
       # request body, replay lookup is scoped to the authenticated account and compares
       # only the key; the request payload is not fingerprinted or compared. If a session
       # with that key already exists for the account, the existing session is replayed
-      # (200); otherwise a new session is created (201). Supports bring-your-own-key
-      # (BYOK) configuration. The session may enter asynchronous states (e.g. joining,
-      # waiting_for_admission) before becoming active. Optional `camera_image` input is
-      # write-only and applies only when no Avatar or Assistant webpage output takes
-      # precedence. An ignored URL is not fetched. An effective URL source is resolved
-      # before bot creation; neither the source URL nor image bytes are persisted,
-      # returned, or logged. Treat signed URLs as credentials.
-      #
-      # @overload create(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, chat_on_enter: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
+      # (200); otherwise a new session is created (201). The session may enter
+      # asynchronous states (e.g. joining, waiting_for_admission) before becoming
+      # active. Optional `camera_image` input is write-only and applies only when no
+      # avatar or Assistant webpage output takes precedence. An ignored URL is not
+      # fetched. An effective URL source is resolved before bot creation; neither the
+      # source URL nor image bytes are persisted, returned, or logged. Treat signed URLs
+      # as credentials. With `assistant.avatar: true`, the assistant is read before the
+      # bot is created: an assistant without a Telnyx avatar configured is rejected with
+      # 400 `invalid_request` (message prefix `assistant_avatar_not_configured:`), an
+      # unknown assistant with 400 `invalid_request` (prefix `assistant_not_found:`),
+      # and a failed lookup with 503 `assistant_lookup_unavailable`; no bot is created
+      # in any of these cases.
+      #
+      # @overload create(meeting_url:, assistant: nil, barge_in: nil, bot_name: nil, camera_image: nil, chat_on_enter: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
       #
       # @param meeting_url [String] The meeting URL the bot should join.
       #
       # @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the Meet
       #
-      # @param avatar [Telnyx::Models::MeetingSessionCreateParams::Avatar] Request options for attaching a bring-your-own-key avatar to the session.
-      #
       # @param barge_in [Boolean] When enabled, a human participant `speech_on` event interrupts and stops the cur
       #
       # @param bot_name [String] Display name for the bot in the meeting. Defaults to "Meeting Bot".
@@ -172,8 +175,8 @@ module Telnyx
       # The operation retains the Telnyx-local Meeting session, transcript segments,
       # events, artifacts, and usage records. It is separate from
       # `DELETE /meeting_sessions/{id}`, which stops or cancels participation without
-      # deleting the persisted session. A missing/foreign session returns 404; provider
-      # deletion failures return 502.
+      # deleting the persisted session. A missing/foreign session returns 404; a
+      # deletion request whose outcome is unknown returns 502.
       #
       # @overload delete_recording_media(id, request_options: {})
       #
@@ -223,26 +226,6 @@ module Telnyx
         )
       end
 
-      # Returns recordings for a meeting session.
-      #
-      # @overload retrieve_recordings(id, request_options: {})
-      #
-      # @param id [String] Unique identifier for the meeting session.
-      #
-      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Telnyx::Models::MeetingSessionRetrieveRecordingsResponse]
-      #
-      # @see Telnyx::Models::MeetingSessionRetrieveRecordingsParams
-      def retrieve_recordings(id, params = {})
-        @client.request(
-          method: :get,
-          path: ["meeting_sessions/%1$s/recordings", id],
-          model: Telnyx::Models::MeetingSessionRetrieveRecordingsResponse,
-          options: params[:request_options]
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MeetingSessionRetrieveTranscriptParams} for more details.
       #

data/lib/telnyx/resources/messages/rcs.rb

@@ -33,26 +33,31 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Messages::RcSendParams} for more details.
+        #
         # Queues an outbound RCS message through the selected RCS agent. Check recipient
         # capabilities before sending features that require RCS support.
         #
-        # @overload send_(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, request_options: {})
+        # @overload send_(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param agent_id [String] Body param: RCS Agent ID
         #
-        # @param agent_id [String] RCS Agent ID
+        # @param agent_message [Telnyx::Models::RcsAgentMessage] Body param
         #
-        # @param agent_message [Telnyx::Models::RcsAgentMessage]
+        # @param messaging_profile_id [String] Body param: A valid messaging profile ID
         #
-        # @param messaging_profile_id [String] A valid messaging profile ID
+        # @param to [String] Body param: Phone number in +E.164 format
         #
-        # @param to [String] Phone number in +E.164 format
+        # @param mms_fallback [Telnyx::Models::Messages::RcSendParams::MmsFallback] Body param
         #
-        # @param mms_fallback [Telnyx::Models::Messages::RcSendParams::MmsFallback]
+        # @param sms_fallback [Telnyx::Models::Messages::RcSendParams::SMSFallback] Body param
         #
-        # @param sms_fallback [Telnyx::Models::Messages::RcSendParams::SMSFallback]
+        # @param type [Symbol, Telnyx::Models::Messages::RcSendParams::Type] Body param: Message type - must be set to "RCS"
         #
-        # @param type [Symbol, Telnyx::Models::Messages::RcSendParams::Type] Message type - must be set to "RCS"
+        # @param webhook_url [String] Body param: The URL where webhooks related to this message will be sent.
         #
-        # @param webhook_url [String] The URL where webhooks related to this message will be sent.
+        # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -61,10 +66,12 @@ module Telnyx
         # @see Telnyx::Models::Messages::RcSendParams
         def send_(params)
           parsed, options = Telnyx::Messages::RcSendParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key"}
           @client.request(
             method: :post,
             path: "messages/rcs",
-            body: parsed,
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
             model: Telnyx::Models::Messages::RcSendResponse,
             options: options
           )