telnyx 4.3.0 → 4.4.0

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -12,7 +12,7 @@ module Telnyx
               assistant_id: String,
               include_mcp_servers: T::Boolean,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::Models::AI::Assistants::VersionRetrieveResponse)
+            ).returns(Telnyx::AI::InferenceEmbedding)
           end
           def retrieve(
             # Path param:
@@ -59,7 +59,7 @@ module Telnyx
               transcription: Telnyx::AI::TranscriptionSettings::OrHash,
               voice_settings: Telnyx::AI::VoiceSettings::OrHash,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::Models::AI::Assistants::VersionUpdateResponse)
+            ).returns(Telnyx::AI::InferenceEmbedding)
           end
           def update(
             # Path param:
@@ -146,7 +146,7 @@ module Telnyx
               version_id: String,
               assistant_id: String,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::Models::AI::Assistants::VersionPromoteResponse)
+            ).returns(Telnyx::AI::InferenceEmbedding)
           end
           def promote(version_id, assistant_id:, request_options: {})
           end

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -50,7 +50,7 @@ module Telnyx
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             voice_settings: Telnyx::AI::VoiceSettings::OrHash,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::AI::AssistantCreateResponse)
+          ).returns(Telnyx::AI::InferenceEmbedding)
         end
         def create(
           # System instructions for the assistant. These may be templated with
@@ -102,7 +102,7 @@ module Telnyx
             from: String,
             to: String,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::AI::AssistantRetrieveResponse)
+          ).returns(Telnyx::AI::InferenceEmbedding)
         end
         def retrieve(
           assistant_id,
@@ -247,7 +247,7 @@ module Telnyx
           params(
             assistant_id: String,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::AI::AssistantCloneResponse)
+          ).returns(Telnyx::AI::InferenceEmbedding)
         end
         def clone_(assistant_id, request_options: {})
         end

data/rbi/telnyx/resources/calls/actions.rbi

@@ -1373,7 +1373,7 @@ module Telnyx
             stream_bidirectional_mode:
               Telnyx::StreamBidirectionalMode::OrSymbol,
             stream_bidirectional_sampling_rate:
-              Telnyx::Calls::ActionStartStreamingParams::StreamBidirectionalSamplingRate::OrInteger,
+              Telnyx::StreamBidirectionalSamplingRate::OrInteger,
             stream_bidirectional_target_legs:
               Telnyx::StreamBidirectionalTargetLegs::OrSymbol,
             stream_codec: Telnyx::StreamCodec::OrSymbol,

data/rbi/telnyx/resources/calls.rbi

@@ -70,7 +70,7 @@ module Telnyx
             Telnyx::StreamBidirectionalCodec::OrSymbol,
           stream_bidirectional_mode: Telnyx::StreamBidirectionalMode::OrSymbol,
           stream_bidirectional_sampling_rate:
-            Telnyx::CallDialParams::StreamBidirectionalSamplingRate::OrInteger,
+            Telnyx::StreamBidirectionalSamplingRate::OrInteger,
           stream_bidirectional_target_legs:
             Telnyx::StreamBidirectionalTargetLegs::OrSymbol,
           stream_codec: Telnyx::StreamCodec::OrSymbol,

data/rbi/telnyx/resources/documents.rbi

@@ -130,6 +130,31 @@ module Telnyx
       )
       end
 
+      # Upload a document.<br /><br />Uploaded files must be linked to a service within
+      # 30 minutes or they will be automatically deleted.
+      sig do
+        params(
+          url: String,
+          file: String,
+          customer_reference: String,
+          filename: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::DocumentUploadJsonResponse)
+      end
+      def upload_json(
+        # If the file is already hosted publicly, you can provide a URL and have the
+        # documents service fetch it for you.
+        url:,
+        # The Base64 encoded contents of the file you are uploading.
+        file:,
+        # A customer reference string for customer look ups.
+        customer_reference: nil,
+        # The filename of the document.
+        filename: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi

@@ -41,7 +41,7 @@ module Telnyx
               doing_business_as: T.nilable(String),
               entity_type:
                 T.nilable(
-                  Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::OrSymbol
+                  Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
               opt_in_confirmation_response: T.nilable(String),
@@ -183,7 +183,7 @@ module Telnyx
               doing_business_as: T.nilable(String),
               entity_type:
                 T.nilable(
-                  Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType::OrSymbol
+                  Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
               opt_in_confirmation_response: T.nilable(String),

data/rbi/telnyx/resources/verify_profiles.rbi

@@ -107,7 +107,7 @@ module Telnyx
         params(
           text: String,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::VerifyProfileCreateTemplateResponse)
+        ).returns(Telnyx::MessageTemplate)
       end
       def create_template(
         # The text content of the message template.
@@ -131,7 +131,7 @@ module Telnyx
           template_id: String,
           text: String,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::VerifyProfileUpdateTemplateResponse)
+        ).returns(Telnyx::MessageTemplate)
       end
       def update_template(
         # The identifier of the message template to update.

data/rbi/telnyx/resources/webhooks.rbi

@@ -3,6 +3,82 @@
 module Telnyx
   module Resources
     class Webhooks
+      sig do
+        params(payload: String).returns(
+          T.any(
+            Telnyx::CallAIGatherEndedWebhookEvent,
+            Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent,
+            Telnyx::CallAIGatherPartialResultsWebhookEvent,
+            Telnyx::CustomerServiceRecordStatusChangedWebhookEvent,
+            Telnyx::CallAnsweredWebhookEvent,
+            Telnyx::CallBridgedWebhookEvent,
+            Telnyx::CallConversationEndedWebhookEvent,
+            Telnyx::CallConversationInsightsGeneratedWebhookEvent,
+            Telnyx::CallDtmfReceivedWebhookEvent,
+            Telnyx::CallEnqueuedWebhookEvent,
+            Telnyx::CallForkStartedWebhookEvent,
+            Telnyx::CallForkStoppedWebhookEvent,
+            Telnyx::CallGatherEndedWebhookEvent,
+            Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallInitiatedWebhookEvent,
+            Telnyx::CallLeftQueueWebhookEvent,
+            Telnyx::CallMachineDetectionEndedWebhookEvent,
+            Telnyx::CallMachineGreetingEndedWebhookEvent,
+            Telnyx::CallMachinePremiumDetectionEndedWebhookEvent,
+            Telnyx::CallMachinePremiumGreetingEndedWebhookEvent,
+            Telnyx::CallPlaybackEndedWebhookEvent,
+            Telnyx::CallPlaybackStartedWebhookEvent,
+            Telnyx::CallRecordingErrorWebhookEvent,
+            Telnyx::CallRecordingSavedWebhookEvent,
+            Telnyx::CallRecordingTranscriptionSavedWebhookEvent,
+            Telnyx::CallReferCompletedWebhookEvent,
+            Telnyx::CallReferFailedWebhookEvent,
+            Telnyx::CallReferStartedWebhookEvent,
+            Telnyx::CallSiprecFailedWebhookEvent,
+            Telnyx::CallSiprecStartedWebhookEvent,
+            Telnyx::CallSiprecStoppedWebhookEvent,
+            Telnyx::CallSpeakEndedWebhookEvent,
+            Telnyx::CallSpeakStartedWebhookEvent,
+            Telnyx::CallStreamingFailedWebhookEvent,
+            Telnyx::CallStreamingStartedWebhookEvent,
+            Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CampaignStatusUpdateWebhookEvent,
+            Telnyx::ConferenceCreatedWebhookEvent,
+            Telnyx::ConferenceEndedWebhookEvent,
+            Telnyx::ConferenceFloorChangedWebhookEvent,
+            Telnyx::ConferenceParticipantJoinedWebhookEvent,
+            Telnyx::ConferenceParticipantLeftWebhookEvent,
+            Telnyx::ConferenceParticipantPlaybackEndedWebhookEvent,
+            Telnyx::ConferenceParticipantPlaybackStartedWebhookEvent,
+            Telnyx::ConferenceParticipantSpeakEndedWebhookEvent,
+            Telnyx::ConferenceParticipantSpeakStartedWebhookEvent,
+            Telnyx::ConferencePlaybackEndedWebhookEvent,
+            Telnyx::ConferencePlaybackStartedWebhookEvent,
+            Telnyx::ConferenceRecordingSavedWebhookEvent,
+            Telnyx::ConferenceSpeakEndedWebhookEvent,
+            Telnyx::ConferenceSpeakStartedWebhookEvent,
+            Telnyx::DeliveryUpdateWebhookEvent,
+            Telnyx::FaxDeliveredWebhookEvent,
+            Telnyx::FaxFailedWebhookEvent,
+            Telnyx::FaxMediaProcessedWebhookEvent,
+            Telnyx::FaxQueuedWebhookEvent,
+            Telnyx::FaxSendingStartedWebhookEvent,
+            Telnyx::InboundMessageWebhookEvent,
+            Telnyx::NumberOrderStatusUpdateWebhookEvent,
+            Telnyx::ReplacedLinkClickWebhookEvent,
+            Telnyx::StreamingFailedWebhookEvent,
+            Telnyx::StreamingStartedWebhookEvent,
+            Telnyx::StreamingStoppedWebhookEvent,
+            Telnyx::TranscriptionWebhookEvent
+          )
+        )
+      end
+      def unsafe_unwrap(
+        # The raw webhook payload as a string
+        payload
+      )
+      end
+
       sig do
         params(payload: String).returns(
           T.any(

data/sig/telnyx/client.rbs

@@ -10,6 +10,8 @@ module Telnyx
 
     attr_reader api_key: String
 
+    attr_reader public_key: String?
+
     attr_reader legacy: Telnyx::Resources::Legacy
 
     attr_reader oauth: Telnyx::Resources::OAuth
@@ -322,6 +324,7 @@ module Telnyx
 
     def initialize: (
       ?api_key: String?,
+      ?public_key: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

data/sig/telnyx/models/access_ip_address_list_response.rbs

@@ -3,55 +3,23 @@ module Telnyx
     type access_ip_address_list_response =
       {
         data: ::Array[Telnyx::AccessIPAddressResponse],
-        meta: Telnyx::Models::AccessIPAddressListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       }
 
     class AccessIPAddressListResponse < Telnyx::Internal::Type::BaseModel
       attr_accessor data: ::Array[Telnyx::AccessIPAddressResponse]
 
-      attr_accessor meta: Telnyx::Models::AccessIPAddressListResponse::Meta
+      attr_accessor meta: Telnyx::PaginationMetaCloudflareIPListSync
 
       def initialize: (
         data: ::Array[Telnyx::AccessIPAddressResponse],
-        meta: Telnyx::Models::AccessIPAddressListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       ) -> void
 
       def to_hash: -> {
         data: ::Array[Telnyx::AccessIPAddressResponse],
-        meta: Telnyx::Models::AccessIPAddressListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       }
-
-      type meta =
-        {
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        }
-
-      class Meta < Telnyx::Internal::Type::BaseModel
-        attr_accessor page_number: Integer
-
-        attr_accessor page_size: Integer
-
-        attr_accessor total_pages: Integer
-
-        attr_accessor total_results: Integer
-
-        def initialize: (
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        ) -> void
-
-        def to_hash: -> {
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        }
-      end
     end
   end
 end

data/sig/telnyx/models/access_ip_range_list_response.rbs

@@ -3,55 +3,23 @@ module Telnyx
     type access_ip_range_list_response =
       {
         data: ::Array[Telnyx::AccessIPRange],
-        meta: Telnyx::Models::AccessIPRangeListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       }
 
     class AccessIPRangeListResponse < Telnyx::Internal::Type::BaseModel
       attr_accessor data: ::Array[Telnyx::AccessIPRange]
 
-      attr_accessor meta: Telnyx::Models::AccessIPRangeListResponse::Meta
+      attr_accessor meta: Telnyx::PaginationMetaCloudflareIPListSync
 
       def initialize: (
         data: ::Array[Telnyx::AccessIPRange],
-        meta: Telnyx::Models::AccessIPRangeListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       ) -> void
 
       def to_hash: -> {
         data: ::Array[Telnyx::AccessIPRange],
-        meta: Telnyx::Models::AccessIPRangeListResponse::Meta
+        meta: Telnyx::PaginationMetaCloudflareIPListSync
       }
-
-      type meta =
-        {
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        }
-
-      class Meta < Telnyx::Internal::Type::BaseModel
-        attr_accessor page_number: Integer
-
-        attr_accessor page_size: Integer
-
-        attr_accessor total_pages: Integer
-
-        attr_accessor total_results: Integer
-
-        def initialize: (
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        ) -> void
-
-        def to_hash: -> {
-          page_number: Integer,
-          page_size: Integer,
-          total_pages: Integer,
-          total_results: Integer
-        }
-      end
     end
   end
 end

data/sig/telnyx/models/advanced_order.rbs

@@ -0,0 +1,105 @@
+module Telnyx
+  module Models
+    type advanced_order =
+      {
+        area_code: String,
+        comments: String,
+        country_code: String,
+        customer_reference: String,
+        features: ::Array[Telnyx::Models::AdvancedOrder::feature],
+        phone_number_type: Telnyx::Models::AdvancedOrder::phone_number_type,
+        quantity: Integer,
+        requirement_group_id: String
+      }
+
+    class AdvancedOrder < Telnyx::Internal::Type::BaseModel
+      attr_reader area_code: String?
+
+      def area_code=: (String) -> String
+
+      attr_reader comments: String?
+
+      def comments=: (String) -> String
+
+      attr_reader country_code: String?
+
+      def country_code=: (String) -> String
+
+      attr_reader customer_reference: String?
+
+      def customer_reference=: (String) -> String
+
+      attr_reader features: ::Array[Telnyx::Models::AdvancedOrder::feature]?
+
+      def features=: (
+        ::Array[Telnyx::Models::AdvancedOrder::feature]
+      ) -> ::Array[Telnyx::Models::AdvancedOrder::feature]
+
+      attr_reader phone_number_type: Telnyx::Models::AdvancedOrder::phone_number_type?
+
+      def phone_number_type=: (
+        Telnyx::Models::AdvancedOrder::phone_number_type
+      ) -> Telnyx::Models::AdvancedOrder::phone_number_type
+
+      attr_reader quantity: Integer?
+
+      def quantity=: (Integer) -> Integer
+
+      attr_reader requirement_group_id: String?
+
+      def requirement_group_id=: (String) -> String
+
+      def initialize: (
+        ?area_code: String,
+        ?comments: String,
+        ?country_code: String,
+        ?customer_reference: String,
+        ?features: ::Array[Telnyx::Models::AdvancedOrder::feature],
+        ?phone_number_type: Telnyx::Models::AdvancedOrder::phone_number_type,
+        ?quantity: Integer,
+        ?requirement_group_id: String
+      ) -> void
+
+      def to_hash: -> {
+        area_code: String,
+        comments: String,
+        country_code: String,
+        customer_reference: String,
+        features: ::Array[Telnyx::Models::AdvancedOrder::feature],
+        phone_number_type: Telnyx::Models::AdvancedOrder::phone_number_type,
+        quantity: Integer,
+        requirement_group_id: String
+      }
+
+      type feature = :sms | :mms | :voice | :fax | :emergency
+
+      module Feature
+        extend Telnyx::Internal::Type::Enum
+
+        SMS: :sms
+        MMS: :mms
+        VOICE: :voice
+        FAX: :fax
+        EMERGENCY: :emergency
+
+        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrder::feature]
+      end
+
+      type phone_number_type =
+        :local | :mobile | :toll_free | :shared_cost | :national | :landline
+
+      module PhoneNumberType
+        extend Telnyx::Internal::Type::Enum
+
+        LOCAL: :local
+        MOBILE: :mobile
+        TOLL_FREE: :toll_free
+        SHARED_COST: :shared_cost
+        NATIONAL: :national
+        LANDLINE: :landline
+
+        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrder::phone_number_type]
+      end
+    end
+  end
+end

data/sig/telnyx/models/advanced_order_create_params.rbs

@@ -1,111 +1,15 @@
 module Telnyx
   module Models
     type advanced_order_create_params =
-      {
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String
-      }
-      & Telnyx::Internal::Type::request_parameters
+      {  } & Telnyx::Internal::Type::request_parameters
 
-    class AdvancedOrderCreateParams < Telnyx::Internal::Type::BaseModel
+    class AdvancedOrderCreateParams < Telnyx::Models::AdvancedOrder
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      attr_reader area_code: String?
+      def initialize: (?request_options: Telnyx::request_opts) -> void
 
-      def area_code=: (String) -> String
-
-      attr_reader comments: String?
-
-      def comments=: (String) -> String
-
-      attr_reader country_code: String?
-
-      def country_code=: (String) -> String
-
-      attr_reader customer_reference: String?
-
-      def customer_reference=: (String) -> String
-
-      attr_reader features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]?
-
-      def features=: (
-        ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-      ) -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-
-      attr_reader phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type?
-
-      def phone_number_type=: (
-        Telnyx::Models::AdvancedOrderCreateParams::phone_number_type
-      ) -> Telnyx::Models::AdvancedOrderCreateParams::phone_number_type
-
-      attr_reader quantity: Integer?
-
-      def quantity=: (Integer) -> Integer
-
-      attr_reader requirement_group_id: String?
-
-      def requirement_group_id=: (String) -> String
-
-      def initialize: (
-        ?area_code: String,
-        ?comments: String,
-        ?country_code: String,
-        ?customer_reference: String,
-        ?features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        ?phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        ?quantity: Integer,
-        ?requirement_group_id: String,
-        ?request_options: Telnyx::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String,
-        request_options: Telnyx::RequestOptions
-      }
-
-      type feature = :sms | :mms | :voice | :fax | :emergency
-
-      module Feature
-        extend Telnyx::Internal::Type::Enum
-
-        SMS: :sms
-        MMS: :mms
-        VOICE: :voice
-        FAX: :fax
-        EMERGENCY: :emergency
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-      end
-
-      type phone_number_type =
-        :local | :mobile | :toll_free | :shared_cost | :national | :landline
-
-      module PhoneNumberType
-        extend Telnyx::Internal::Type::Enum
-
-        LOCAL: :local
-        MOBILE: :mobile
-        TOLL_FREE: :toll_free
-        SHARED_COST: :shared_cost
-        NATIONAL: :national
-        LANDLINE: :landline
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::phone_number_type]
-      end
+      def to_hash: -> { request_options: Telnyx::RequestOptions }
     end
   end
 end