telnyx 5.70.0 → 5.72.0

data/rbi/telnyx/resources/voice_clones.rbi

@@ -9,17 +9,17 @@ module Telnyx
       # design. The clone can then be used for text-to-speech synthesis.
       sig do
         params(
-          body:
+          params:
             T.any(
-              Telnyx::VoiceCloneCreateParams::Body::TelnyxDesignClone::OrHash,
-              Telnyx::VoiceCloneCreateParams::Body::MinimaxDesignClone::OrHash
+              Telnyx::VoiceCloneCreateParams::Params::TelnyxDesignClone::OrHash,
+              Telnyx::VoiceCloneCreateParams::Params::MinimaxDesignClone::OrHash
             ),
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(Telnyx::Models::VoiceCloneCreateResponse)
       end
       def create(
         # Request body for creating a voice clone from an existing voice design.
-        body:,
+        params:,
         request_options: {}
       )
       end
@@ -92,11 +92,11 @@ module Telnyx
       # clear speech. Maximum file size: 5MB for Telnyx, 20MB for Minimax.
       sig do
         params(
-          body:
+          upload_params:
             T.any(
-              Telnyx::VoiceCloneCreateFromUploadParams::Body::TelnyxQwen3TtsClone::OrHash,
-              Telnyx::VoiceCloneCreateFromUploadParams::Body::TelnyxUltraClone::OrHash,
-              Telnyx::VoiceCloneCreateFromUploadParams::Body::MinimaxClone::OrHash
+              Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::OrHash,
+              Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::OrHash,
+              Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::OrHash
             ),
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(Telnyx::Models::VoiceCloneCreateFromUploadResponse)
@@ -104,7 +104,7 @@ module Telnyx
       def create_from_upload(
         # Multipart form data for creating a voice clone from a direct audio upload.
         # Maximum file size: 5MB for Telnyx, 20MB for Minimax.
-        body:,
+        upload_params:,
         request_options: {}
       )
       end

data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi

@@ -7,6 +7,22 @@ module Telnyx
         class Profile
           # Manage Whatsapp phone numbers
           class Photo
+            # Get Whatsapp profile photo
+            sig do
+              params(
+                phone_number: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::Whatsapp::PhoneNumbers::Profile::PhotoRetrieveResponse
+              )
+            end
+            def retrieve(
+              # Phone number (E.164 format)
+              phone_number,
+              request_options: {}
+            )
+            end
+
             # Delete Whatsapp profile photo
             sig do
               params(

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

@@ -43,155 +43,16 @@ module Telnyx
         }
 
         type tool =
-          Telnyx::AI::Assistant::Tool::BookAppointment
-          | Telnyx::AI::Assistant::Tool::CheckAvailability
+          Telnyx::BookAppointmentTool
+          | Telnyx::CheckAvailabilityTool
           | Telnyx::AI::WebhookTool
           | Telnyx::AI::HangupTool
           | Telnyx::AI::TransferTool
-          | Telnyx::AI::Assistant::Tool::Retrieval
+          | Telnyx::CallControlRetrievalTool
 
         module Tool
           extend Telnyx::Internal::Type::Union
 
-          type book_appointment =
-            {
-              book_appointment: Telnyx::AI::Assistant::Tool::BookAppointment::BookAppointment,
-              type: :book_appointment
-            }
-
-          class BookAppointment < Telnyx::Internal::Type::BaseModel
-            attr_accessor book_appointment: Telnyx::AI::Assistant::Tool::BookAppointment::BookAppointment
-
-            attr_accessor type: :book_appointment
-
-            def initialize: (
-              book_appointment: Telnyx::AI::Assistant::Tool::BookAppointment::BookAppointment,
-              ?type: :book_appointment
-            ) -> void
-
-            def to_hash: -> {
-              book_appointment: Telnyx::AI::Assistant::Tool::BookAppointment::BookAppointment,
-              type: :book_appointment
-            }
-
-            type book_appointment =
-              {
-                api_key_ref: String,
-                event_type_id: Integer,
-                attendee_name: String,
-                attendee_timezone: String
-              }
-
-            class BookAppointment < Telnyx::Internal::Type::BaseModel
-              attr_accessor api_key_ref: String
-
-              attr_accessor event_type_id: Integer
-
-              attr_reader attendee_name: String?
-
-              def attendee_name=: (String) -> String
-
-              attr_reader attendee_timezone: String?
-
-              def attendee_timezone=: (String) -> String
-
-              def initialize: (
-                api_key_ref: String,
-                event_type_id: Integer,
-                ?attendee_name: String,
-                ?attendee_timezone: String
-              ) -> void
-
-              def to_hash: -> {
-                api_key_ref: String,
-                event_type_id: Integer,
-                attendee_name: String,
-                attendee_timezone: String
-              }
-            end
-          end
-
-          type check_availability =
-            {
-              check_availability: Telnyx::AI::Assistant::Tool::CheckAvailability::CheckAvailability,
-              type: :check_availability
-            }
-
-          class CheckAvailability < Telnyx::Internal::Type::BaseModel
-            attr_accessor check_availability: Telnyx::AI::Assistant::Tool::CheckAvailability::CheckAvailability
-
-            attr_accessor type: :check_availability
-
-            def initialize: (
-              check_availability: Telnyx::AI::Assistant::Tool::CheckAvailability::CheckAvailability,
-              ?type: :check_availability
-            ) -> void
-
-            def to_hash: -> {
-              check_availability: Telnyx::AI::Assistant::Tool::CheckAvailability::CheckAvailability,
-              type: :check_availability
-            }
-
-            type check_availability =
-              { api_key_ref: String, event_type_id: Integer }
-
-            class CheckAvailability < Telnyx::Internal::Type::BaseModel
-              attr_accessor api_key_ref: String
-
-              attr_accessor event_type_id: Integer
-
-              def initialize: (
-                api_key_ref: String,
-                event_type_id: Integer
-              ) -> void
-
-              def to_hash: -> { api_key_ref: String, event_type_id: Integer }
-            end
-          end
-
-          type retrieval =
-            {
-              retrieval: Telnyx::AI::Assistant::Tool::Retrieval::Retrieval,
-              type: :retrieval
-            }
-
-          class Retrieval < Telnyx::Internal::Type::BaseModel
-            attr_accessor retrieval: Telnyx::AI::Assistant::Tool::Retrieval::Retrieval
-
-            attr_accessor type: :retrieval
-
-            def initialize: (
-              retrieval: Telnyx::AI::Assistant::Tool::Retrieval::Retrieval,
-              ?type: :retrieval
-            ) -> void
-
-            def to_hash: -> {
-              retrieval: Telnyx::AI::Assistant::Tool::Retrieval::Retrieval,
-              type: :retrieval
-            }
-
-            type retrieval =
-              { bucket_ids: ::Array[String], max_num_results: Integer }
-
-            class Retrieval < Telnyx::Internal::Type::BaseModel
-              attr_accessor bucket_ids: ::Array[String]
-
-              attr_reader max_num_results: Integer?
-
-              def max_num_results=: (Integer) -> Integer
-
-              def initialize: (
-                bucket_ids: ::Array[String],
-                ?max_num_results: Integer
-              ) -> void
-
-              def to_hash: -> {
-                bucket_ids: ::Array[String],
-                max_num_results: Integer
-              }
-            end
-          end
-
           def self?.variants: -> ::Array[Telnyx::Models::AI::Assistant::tool]
         end
       end

data/sig/telnyx/models/book_appointment_tool.rbs

@@ -0,0 +1,35 @@
+module Telnyx
+  module Models
+    type book_appointment_tool =
+      {
+        book_appointment: Telnyx::BookAppointmentToolParams,
+        type: Telnyx::Models::BookAppointmentTool::type_
+      }
+
+    class BookAppointmentTool < Telnyx::Internal::Type::BaseModel
+      attr_accessor book_appointment: Telnyx::BookAppointmentToolParams
+
+      attr_accessor type: Telnyx::Models::BookAppointmentTool::type_
+
+      def initialize: (
+        book_appointment: Telnyx::BookAppointmentToolParams,
+        type: Telnyx::Models::BookAppointmentTool::type_
+      ) -> void
+
+      def to_hash: -> {
+        book_appointment: Telnyx::BookAppointmentToolParams,
+        type: Telnyx::Models::BookAppointmentTool::type_
+      }
+
+      type type_ = :book_appointment
+
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        BOOK_APPOINTMENT: :book_appointment
+
+        def self?.values: -> ::Array[Telnyx::Models::BookAppointmentTool::type_]
+      end
+    end
+  end
+end

data/sig/telnyx/models/book_appointment_tool_params.rbs

@@ -0,0 +1,39 @@
+module Telnyx
+  module Models
+    type book_appointment_tool_params =
+      {
+        api_key_ref: String,
+        event_type_id: Integer,
+        attendee_name: String,
+        attendee_timezone: String
+      }
+
+    class BookAppointmentToolParams < Telnyx::Internal::Type::BaseModel
+      attr_accessor api_key_ref: String
+
+      attr_accessor event_type_id: Integer
+
+      attr_reader attendee_name: String?
+
+      def attendee_name=: (String) -> String
+
+      attr_reader attendee_timezone: String?
+
+      def attendee_timezone=: (String) -> String
+
+      def initialize: (
+        api_key_ref: String,
+        event_type_id: Integer,
+        ?attendee_name: String,
+        ?attendee_timezone: String
+      ) -> void
+
+      def to_hash: -> {
+        api_key_ref: String,
+        event_type_id: Integer,
+        attendee_name: String,
+        attendee_timezone: String
+      }
+    end
+  end
+end

data/sig/telnyx/models/call_assistant_request.rbs

@@ -0,0 +1,132 @@
+module Telnyx
+  module Models
+    type call_assistant_request =
+      {
+        id: String,
+        dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
+        external_llm: ::Hash[Symbol, top],
+        fallback_config: ::Hash[Symbol, top],
+        greeting: String,
+        instructions: String,
+        llm_api_key_ref: String,
+        mcp_servers: ::Array[::Hash[Symbol, top]],
+        model: String,
+        name: String,
+        observability_settings: ::Hash[Symbol, top],
+        openai_api_key_ref: String,
+        tools: ::Array[Telnyx::Models::CallAssistantRequest::tool]
+      }
+
+    class CallAssistantRequest < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_reader dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable]?
+
+      def dynamic_variables=: (
+        ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable]
+      ) -> ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable]
+
+      attr_reader external_llm: ::Hash[Symbol, top]?
+
+      def external_llm=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader fallback_config: ::Hash[Symbol, top]?
+
+      def fallback_config=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader greeting: String?
+
+      def greeting=: (String) -> String
+
+      attr_reader instructions: String?
+
+      def instructions=: (String) -> String
+
+      attr_reader llm_api_key_ref: String?
+
+      def llm_api_key_ref=: (String) -> String
+
+      attr_reader mcp_servers: ::Array[::Hash[Symbol, top]]?
+
+      def mcp_servers=: (
+        ::Array[::Hash[Symbol, top]]
+      ) -> ::Array[::Hash[Symbol, top]]
+
+      attr_reader model: String?
+
+      def model=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader observability_settings: ::Hash[Symbol, top]?
+
+      def observability_settings=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader openai_api_key_ref: String?
+
+      def openai_api_key_ref=: (String) -> String
+
+      attr_reader tools: ::Array[Telnyx::Models::CallAssistantRequest::tool]?
+
+      def tools=: (
+        ::Array[Telnyx::Models::CallAssistantRequest::tool]
+      ) -> ::Array[Telnyx::Models::CallAssistantRequest::tool]
+
+      def initialize: (
+        id: String,
+        ?dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
+        ?external_llm: ::Hash[Symbol, top],
+        ?fallback_config: ::Hash[Symbol, top],
+        ?greeting: String,
+        ?instructions: String,
+        ?llm_api_key_ref: String,
+        ?mcp_servers: ::Array[::Hash[Symbol, top]],
+        ?model: String,
+        ?name: String,
+        ?observability_settings: ::Hash[Symbol, top],
+        ?openai_api_key_ref: String,
+        ?tools: ::Array[Telnyx::Models::CallAssistantRequest::tool]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
+        external_llm: ::Hash[Symbol, top],
+        fallback_config: ::Hash[Symbol, top],
+        greeting: String,
+        instructions: String,
+        llm_api_key_ref: String,
+        mcp_servers: ::Array[::Hash[Symbol, top]],
+        model: String,
+        name: String,
+        observability_settings: ::Hash[Symbol, top],
+        openai_api_key_ref: String,
+        tools: ::Array[Telnyx::Models::CallAssistantRequest::tool]
+      }
+
+      type dynamic_variable = String | Float | bool
+
+      module DynamicVariable
+        extend Telnyx::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Telnyx::Models::CallAssistantRequest::dynamic_variable]
+      end
+
+      type tool =
+        Telnyx::BookAppointmentTool
+        | Telnyx::CheckAvailabilityTool
+        | Telnyx::AI::WebhookTool
+        | Telnyx::AI::HangupTool
+        | Telnyx::AI::TransferTool
+        | Telnyx::CallControlRetrievalTool
+
+      module Tool
+        extend Telnyx::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Telnyx::Models::CallAssistantRequest::tool]
+      end
+    end
+  end
+end

data/sig/telnyx/models/call_control_bucket_ids.rbs

@@ -0,0 +1,21 @@
+module Telnyx
+  module Models
+    type call_control_bucket_ids =
+      { bucket_ids: ::Array[String], max_num_results: Integer }
+
+    class CallControlBucketIDs < Telnyx::Internal::Type::BaseModel
+      attr_accessor bucket_ids: ::Array[String]
+
+      attr_reader max_num_results: Integer?
+
+      def max_num_results=: (Integer) -> Integer
+
+      def initialize: (
+        bucket_ids: ::Array[String],
+        ?max_num_results: Integer
+      ) -> void
+
+      def to_hash: -> { bucket_ids: ::Array[String], max_num_results: Integer }
+    end
+  end
+end

data/sig/telnyx/models/call_control_retrieval_tool.rbs

@@ -0,0 +1,35 @@
+module Telnyx
+  module Models
+    type call_control_retrieval_tool =
+      {
+        retrieval: Telnyx::CallControlBucketIDs,
+        type: Telnyx::Models::CallControlRetrievalTool::type_
+      }
+
+    class CallControlRetrievalTool < Telnyx::Internal::Type::BaseModel
+      attr_accessor retrieval: Telnyx::CallControlBucketIDs
+
+      attr_accessor type: Telnyx::Models::CallControlRetrievalTool::type_
+
+      def initialize: (
+        retrieval: Telnyx::CallControlBucketIDs,
+        type: Telnyx::Models::CallControlRetrievalTool::type_
+      ) -> void
+
+      def to_hash: -> {
+        retrieval: Telnyx::CallControlBucketIDs,
+        type: Telnyx::Models::CallControlRetrievalTool::type_
+      }
+
+      type type_ = :retrieval
+
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        RETRIEVAL: :retrieval
+
+        def self?.values: -> ::Array[Telnyx::Models::CallControlRetrievalTool::type_]
+      end
+    end
+  end
+end

data/sig/telnyx/models/call_dial_params.rbs

@@ -7,6 +7,7 @@ module Telnyx
         to: Telnyx::Models::CallDialParams::to,
         answering_machine_detection: Telnyx::Models::CallDialParams::answering_machine_detection,
         answering_machine_detection_config: Telnyx::CallDialParams::AnsweringMachineDetectionConfig,
+        assistant: Telnyx::CallAssistantRequest,
         audio_url: String,
         billing_group_id: String,
         bridge_intent: bool,
@@ -82,6 +83,12 @@ module Telnyx
         Telnyx::CallDialParams::AnsweringMachineDetectionConfig
       ) -> Telnyx::CallDialParams::AnsweringMachineDetectionConfig
 
+      attr_reader assistant: Telnyx::CallAssistantRequest?
+
+      def assistant=: (
+        Telnyx::CallAssistantRequest
+      ) -> Telnyx::CallAssistantRequest
+
       attr_reader audio_url: String?
 
       def audio_url=: (String) -> String
@@ -334,6 +341,7 @@ module Telnyx
         to: Telnyx::Models::CallDialParams::to,
         ?answering_machine_detection: Telnyx::Models::CallDialParams::answering_machine_detection,
         ?answering_machine_detection_config: Telnyx::CallDialParams::AnsweringMachineDetectionConfig,
+        ?assistant: Telnyx::CallAssistantRequest,
         ?audio_url: String,
         ?billing_group_id: String,
         ?bridge_intent: bool,
@@ -393,6 +401,7 @@ module Telnyx
         to: Telnyx::Models::CallDialParams::to,
         answering_machine_detection: Telnyx::Models::CallDialParams::answering_machine_detection,
         answering_machine_detection_config: Telnyx::CallDialParams::AnsweringMachineDetectionConfig,
+        assistant: Telnyx::CallAssistantRequest,
         audio_url: String,
         billing_group_id: String,
         bridge_intent: bool,

data/sig/telnyx/models/calls/action_answer_params.rbs

@@ -4,6 +4,7 @@ module Telnyx
       type action_answer_params =
         {
           call_control_id: String,
+          assistant: Telnyx::CallAssistantRequest,
           billing_group_id: String,
           client_state: String,
           command_id: String,
@@ -42,6 +43,12 @@ module Telnyx
 
         attr_accessor call_control_id: String
 
+        attr_reader assistant: Telnyx::CallAssistantRequest?
+
+        def assistant=: (
+          Telnyx::CallAssistantRequest
+        ) -> Telnyx::CallAssistantRequest
+
         attr_reader billing_group_id: String?
 
         def billing_group_id=: (String) -> String
@@ -196,6 +203,7 @@ module Telnyx
 
         def initialize: (
           call_control_id: String,
+          ?assistant: Telnyx::CallAssistantRequest,
           ?billing_group_id: String,
           ?client_state: String,
           ?command_id: String,
@@ -230,6 +238,7 @@ module Telnyx
 
         def to_hash: -> {
           call_control_id: String,
+          assistant: Telnyx::CallAssistantRequest,
           billing_group_id: String,
           client_state: String,
           command_id: String,

data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs

@@ -4,7 +4,7 @@ module Telnyx
       type action_start_ai_assistant_params =
         {
           call_control_id: String,
-          assistant: Telnyx::Calls::ActionStartAIAssistantParams::Assistant,
+          assistant: Telnyx::CallAssistantRequest,
           client_state: String,
           command_id: String,
           greeting: String,
@@ -24,11 +24,11 @@ module Telnyx
 
         attr_accessor call_control_id: String
 
-        attr_reader assistant: Telnyx::Calls::ActionStartAIAssistantParams::Assistant?
+        attr_reader assistant: Telnyx::CallAssistantRequest?
 
         def assistant=: (
-          Telnyx::Calls::ActionStartAIAssistantParams::Assistant
-        ) -> Telnyx::Calls::ActionStartAIAssistantParams::Assistant
+          Telnyx::CallAssistantRequest
+        ) -> Telnyx::CallAssistantRequest
 
         attr_reader client_state: String?
 
@@ -82,7 +82,7 @@ module Telnyx
 
         def initialize: (
           call_control_id: String,
-          ?assistant: Telnyx::Calls::ActionStartAIAssistantParams::Assistant,
+          ?assistant: Telnyx::CallAssistantRequest,
           ?client_state: String,
           ?command_id: String,
           ?greeting: String,
@@ -98,7 +98,7 @@ module Telnyx
 
         def to_hash: -> {
           call_control_id: String,
-          assistant: Telnyx::Calls::ActionStartAIAssistantParams::Assistant,
+          assistant: Telnyx::CallAssistantRequest,
           client_state: String,
           command_id: String,
           greeting: String,
@@ -112,35 +112,6 @@ module Telnyx
           request_options: Telnyx::RequestOptions
         }
 
-        type assistant =
-          { id: String, instructions: String, openai_api_key_ref: String }
-
-        class Assistant < Telnyx::Internal::Type::BaseModel
-          attr_reader id: String?
-
-          def id=: (String) -> String
-
-          attr_reader instructions: String?
-
-          def instructions=: (String) -> String
-
-          attr_reader openai_api_key_ref: String?
-
-          def openai_api_key_ref=: (String) -> String
-
-          def initialize: (
-            ?id: String,
-            ?instructions: String,
-            ?openai_api_key_ref: String
-          ) -> void
-
-          def to_hash: -> {
-            id: String,
-            instructions: String,
-            openai_api_key_ref: String
-          }
-        end
-
         type message_history =
           Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::User
           | Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant

data/sig/telnyx/models/check_availability_tool.rbs

@@ -0,0 +1,35 @@
+module Telnyx
+  module Models
+    type check_availability_tool =
+      {
+        check_availability: Telnyx::CheckAvailabilityToolParams,
+        type: Telnyx::Models::CheckAvailabilityTool::type_
+      }
+
+    class CheckAvailabilityTool < Telnyx::Internal::Type::BaseModel
+      attr_accessor check_availability: Telnyx::CheckAvailabilityToolParams
+
+      attr_accessor type: Telnyx::Models::CheckAvailabilityTool::type_
+
+      def initialize: (
+        check_availability: Telnyx::CheckAvailabilityToolParams,
+        type: Telnyx::Models::CheckAvailabilityTool::type_
+      ) -> void
+
+      def to_hash: -> {
+        check_availability: Telnyx::CheckAvailabilityToolParams,
+        type: Telnyx::Models::CheckAvailabilityTool::type_
+      }
+
+      type type_ = :check_availability
+
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        CHECK_AVAILABILITY: :check_availability
+
+        def self?.values: -> ::Array[Telnyx::Models::CheckAvailabilityTool::type_]
+      end
+    end
+  end
+end