telnyx 5.171.0 → 5.173.0

data/lib/telnyx/resources/texml/accounts.rb

@@ -30,7 +30,7 @@ module Telnyx
         #
         # @overload retrieve_recordings_json(account_sid, date_created: nil, page: nil, page_size: nil, request_options: {})
         #
-        # @param account_sid [String] The id of the account the resource belongs to.
+        # @param account_sid [String] The UUID of the Telnyx account that owns the resource, for example `f5586561-8ff
         #
         # @param date_created [Time] Filters recording by the creation date. Expected format is ISO8601 date or date-
         #
@@ -55,11 +55,15 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Texml::AccountRetrieveTranscriptionsJsonParams} for more
+        # details.
+        #
         # Returns multiple recording transcription resources for an account.
         #
         # @overload retrieve_transcriptions_json(account_sid, page_size: nil, page_token: nil, request_options: {})
         #
-        # @param account_sid [String] The id of the account the resource belongs to.
+        # @param account_sid [String] The UUID of the Telnyx account that owns the resource, for example `f5586561-8ff
         #
         # @param page_size [Integer] The number of records to be displayed on a page
         #

data/lib/telnyx/resources/text_to_speech.rb

@@ -82,7 +82,7 @@ module Telnyx
       # `provider` is specified, returns voices for that provider only. Otherwise,
       # returns voices from all providers.
       #
-      # Some providers (ElevenLabs, Resemble) require an API key to list voices.
+      # Some providers (ElevenLabs) require an API key to list voices.
       #
       # @overload list_voices(api_key: nil, provider: nil, request_options: {})
       #

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class TtsIntegrations
+      class Actions
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/tts_integrations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class TtsIntegrations
+      # @return [Telnyx::Resources::TtsIntegrations::Actions]
+      attr_reader :actions
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @actions = Telnyx::Resources::TtsIntegrations::Actions.new(client: client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Tunnels
+      # Tunnels connect a Network to hosts behind a tunnel process within the user's
+      # network.
+      class Actions
+        # Issues a new `tunnel_token` and invalidates the previous one. Tunnel processes
+        # already connected stay connected until they reconnect, and are then refused
+        # until they use the new token.
+        #
+        # @overload rotate_token(id, request_options: {})
+        #
+        # @param id [String] The id of the tunnel.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Tunnels::ActionRotateTokenResponse]
+        #
+        # @see Telnyx::Models::Tunnels::ActionRotateTokenParams
+        def rotate_token(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["tunnels/%1$s/actions/rotate_token", id],
+            model: Telnyx::Models::Tunnels::ActionRotateTokenResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/tunnels.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Tunnels connect a Network to hosts behind a tunnel process within the user's
+    # network.
+    class Tunnels
+      # Tunnels connect a Network to hosts behind a tunnel process within the user's
+      # network.
+      # @return [Telnyx::Resources::Tunnels::Actions]
+      attr_reader :actions
+
+      # Creates a tunnel and returns its `tunnel_token`. The token is the only
+      # credential the tunnel process needs, and this response and
+      # `POST /tunnels/{id}/actions/rotate_token` are the only ones that return it. A
+      # new tunnel is `inactive` until a tunnel process connects with the token.
+      #
+      # @overload create(name:, request_options: {})
+      #
+      # @param name [String] A user specified name for the tunnel.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::TunnelCreateResponse]
+      #
+      # @see Telnyx::Models::TunnelCreateParams
+      def create(params)
+        parsed, options = Telnyx::TunnelCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "tunnels",
+          body: parsed,
+          model: Telnyx::Models::TunnelCreateResponse,
+          options: options
+        )
+      end
+
+      # Retrieves a tunnel with its status and the tunnel processes connected to it. The
+      # response never includes `tunnel_token`.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The id of the tunnel.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::TunnelRetrieveResponse]
+      #
+      # @see Telnyx::Models::TunnelRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["tunnels/%1$s", id],
+          model: Telnyx::Models::TunnelRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::TunnelListParams} for more details.
+      #
+      # Lists the tunnels on the account with their status and connected tunnel
+      # processes. Responses never include `tunnel_token`.
+      #
+      # @overload list(filter: nil, page: nil, sort: nil, request_options: {})
+      #
+      # @param filter [Telnyx::Models::TunnelListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[name], filt
+      #
+      # @param page [Telnyx::Models::TunnelListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[li
+      #
+      # @param sort [Symbol, Telnyx::Models::TunnelListParams::Sort] Sorts the results by a field, ascending, or descending with a leading `-`. The d
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::TunnelListResponse]
+      #
+      # @see Telnyx::Models::TunnelListParams
+      def list(params = {})
+        parsed, options = Telnyx::TunnelListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "tunnels",
+          query: query,
+          model: Telnyx::Models::TunnelListResponse,
+          options: options
+        )
+      end
+
+      # Deletes a tunnel. A tunnel that a route names as its next hop cannot be deleted;
+      # delete those routes first. Connected tunnel processes are disconnected and
+      # cannot reconnect with the tunnel's token.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The id of the tunnel.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::TunnelDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["tunnels/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @actions = Telnyx::Resources::Tunnels::Actions.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/uac_connections.rb

@@ -16,7 +16,7 @@ module Telnyx
       # Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you
       # need Telnyx to maintain the registration.
       #
-      # @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, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: 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, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: 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.
       #
@@ -26,6 +26,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
@@ -34,7 +36,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 external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
       #
@@ -113,7 +115,7 @@ module Telnyx
       #
       # Updates settings of an existing UAC connection.
       #
-      # @overload update(id, 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, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: 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, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: 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.
       #
@@ -123,6 +125,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.
@@ -133,7 +137,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 external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
       #

data/lib/telnyx/resources/voice_clones.rb

@@ -58,7 +58,9 @@ module Telnyx
 
       # Returns a paginated list of voice clones belonging to the authenticated account.
       #
-      # @overload list(filter_name: nil, filter_provider: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      # @overload list(filter_model_id: nil, filter_name: nil, filter_provider: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #
+      # @param filter_model_id [Symbol, Telnyx::Models::VoiceCloneListParams::FilterModelID] Filter by TTS model. Case-insensitive.
       #
       # @param filter_name [String] Case-insensitive substring filter on the name field.
       #
@@ -82,6 +84,7 @@ module Telnyx
           method: :get,
           path: "voice_clones",
           query: query.transform_keys(
+            filter_model_id: "filter[model_id]",
             filter_name: "filter[name]",
             filter_provider: "filter[provider]",
             page_number: "page[number]",
@@ -117,14 +120,17 @@ module Telnyx
       # {Telnyx::Models::VoiceCloneCreateFromUploadParams} for more details.
       #
       # Creates a new voice clone by uploading an audio file directly. Supported
-      # formats: WAV, MP3, FLAC, OGG, M4A. For best results, provide 5–60 seconds of
-      # clear speech (Ultra accepts up to 60 seconds; Qwen3TTS auto-trims to 10 seconds;
-      # Minimax accepts up to 5 minutes). Maximum file size: 5MB for Telnyx, 20MB for
-      # Minimax.
+      # formats: WAV, MP3, FLAC, OGG, M4A. Maximum file size: 20MB. Reference audio is
+      # trimmed per model: Qwen3TTS, Bayan, and Resemble use the first 10 seconds, Ultra
+      # uses up to 60 seconds, and Minimax accepts 10 seconds to 5 minutes. Ultra clones
+      # return `202` with status `pending`; all other models return `201` with status
+      # `active`. Bayan clones require `ref_text` (the exact transcript of the reference
+      # audio) and support `ar` (default) and `en` only. Resemble clones
+      # (`provider: resemble`) take `model_id` `Pro`, `Turbo`, or `Urdu`.
       #
       # @overload create_from_upload(voice_clone_upload_request:, request_options: {})
       #
-      # @param voice_clone_upload_request [Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::TelnyxQwen3TtsClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::TelnyxUltraClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::MinimaxClone] Multipart form data for creating a voice clone from a direct audio upload. Maxim
+      # @param voice_clone_upload_request [Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::TelnyxQwen3TtsClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::TelnyxUltraClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::TelnyxBayanClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::MinimaxClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::VoiceCloneUploadRequest::ResembleClone] Multipart form data for creating a voice clone from a direct audio upload. Maxim
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/webhooks.rb

@@ -5,7 +5,7 @@ module Telnyx
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnalyzedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
       def unsafe_unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -17,7 +17,7 @@ module Telnyx
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnalyzedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
       def unwrap(payload, headers:, key: @client.public_key)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")

data/lib/telnyx/resources/whatsapp/hosted_signups.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Whatsapp
+      class HostedSignups
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Whatsapp::HostedSignupCreateParams} for more details.
+        #
+        # Create a time-limited onboarding URL on the Telnyx-hosted Embedded Signup page
+        # for a Tech Provider's end customer. Set `signup_type` to `coexistence` to launch
+        # Meta's WhatsApp Business app coexistence flow instead of standard Cloud API
+        # onboarding.
+        #
+        # @overload create(app_id:, expires_at: nil, signup_type: nil, request_options: {})
+        #
+        # @param app_id [String] Meta App ID linked to the Telnyx account or its manager account. The app must be
+        #
+        # @param expires_at [Time] When the onboarding URL expires, in RFC 3339 format. Must be in the future and a
+        #
+        # @param signup_type [Symbol, Telnyx::Models::Whatsapp::HostedSignupCreateParams::SignupType] Onboarding flow the hosted page launches. Use `coexistence` for a number that re
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Whatsapp::HostedSignupCreateResponse]
+        #
+        # @see Telnyx::Models::Whatsapp::HostedSignupCreateParams
+        def create(params)
+          parsed, options = Telnyx::Whatsapp::HostedSignupCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "whatsapp/hosted_signups",
+            body: parsed,
+            model: Telnyx::Models::Whatsapp::HostedSignupCreateResponse,
+            options: options
+          )
+        end
+
+        # Retrieve a hosted signup and its onboarding URL.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Hosted signup ID returned when the hosted signup was created
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse]
+        #
+        # @see Telnyx::Models::Whatsapp::HostedSignupRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["whatsapp/hosted_signups/%1$s", id],
+            model: Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # List hosted signups created by the account, newest first. Expired hosted signups
+        # are included.
+        #
+        # @overload list(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer]
+        # @param page_size [Integer]
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::HostedSignupListResponse>]
+        #
+        # @see Telnyx::Models::Whatsapp::HostedSignupListParams
+        def list(params = {})
+          parsed, options = Telnyx::Whatsapp::HostedSignupListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "whatsapp/hosted_signups",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Models::Whatsapp::HostedSignupListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/whatsapp.rb

@@ -22,6 +22,9 @@ module Telnyx
       # @return [Telnyx::Resources::Whatsapp::Signup]
       attr_reader :signup
 
+      # @return [Telnyx::Resources::Whatsapp::HostedSignups]
+      attr_reader :hosted_signups
+
       # @api private
       #
       # @param client [Telnyx::Client]
@@ -32,6 +35,7 @@ module Telnyx
         @phone_numbers = Telnyx::Resources::Whatsapp::PhoneNumbers.new(client: client)
         @user_data = Telnyx::Resources::Whatsapp::UserData.new(client: client)
         @signup = Telnyx::Resources::Whatsapp::Signup.new(client: client)
+        @hosted_signups = Telnyx::Resources::Whatsapp::HostedSignups.new(client: client)
       end
     end
   end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.171.0"
+  VERSION = "5.173.0"
 end