telnyx 5.150.0 → 5.152.0

data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs

@@ -1,116 +1,25 @@
 module Telnyx
   module Models
     type advanced_order_update_requirement_group_params =
-      {
-        advanced_order_id: String,
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String
-      }
-      & Telnyx::Internal::Type::request_parameters
+      { advanced_order_id: String } & Telnyx::Internal::Type::request_parameters
 
     class AdvancedOrderUpdateRequirementGroupParams < Telnyx::Models::AdvancedOrderRequest
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      attr_accessor advanced_order_id: String
-
-      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::AdvancedOrderUpdateRequirementGroupParams::feature]?
-
-      def features=: (
-        ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]
-      ) -> ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]
-
-      attr_reader phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type?
+      def advanced_order_id: -> String
 
-      def phone_number_type=: (
-        Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type
-      ) -> Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type
-
-      attr_reader quantity: Integer?
-
-      def quantity=: (Integer) -> Integer
-
-      attr_reader requirement_group_id: String?
-
-      def requirement_group_id=: (String) -> String
+      def advanced_order_id=: (String _) -> String
 
       def initialize: (
         advanced_order_id: String,
-        ?area_code: String,
-        ?comments: String,
-        ?country_code: String,
-        ?customer_reference: String,
-        ?features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        ?phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type,
-        ?quantity: Integer,
-        ?requirement_group_id: String,
         ?request_options: Telnyx::request_opts
       ) -> void
 
       def to_hash: -> {
         advanced_order_id: String,
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::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::AdvancedOrderUpdateRequirementGroupParams::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::AdvancedOrderUpdateRequirementGroupParams::phone_number_type]
-      end
     end
   end
 end

data/sig/telnyx/models/ai_retrieve_conversation_histories_params.rbs

@@ -3,8 +3,6 @@ module Telnyx
     type ai_retrieve_conversation_histories_params =
       {
         q: String,
-        record_type: Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type,
-        filter_document_id: String,
         filter_ingested_at_gte: Time,
         filter_ingested_at_lte: Time,
         filter_record_created_at_gte: Time,
@@ -14,8 +12,9 @@ module Telnyx
         filter_retention: String,
         filter_user_id: String,
         min_score: Float,
-        region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region,
-        top_k: Integer
+        page_number: Integer,
+        page_size: Integer,
+        region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region
       }
       & Telnyx::Internal::Type::request_parameters
 
@@ -25,12 +24,6 @@ module Telnyx
 
       attr_accessor q: String
 
-      attr_accessor record_type: Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type
-
-      attr_reader filter_document_id: String?
-
-      def filter_document_id=: (String) -> String
-
       attr_reader filter_ingested_at_gte: Time?
 
       def filter_ingested_at_gte=: (Time) -> Time
@@ -67,20 +60,22 @@ module Telnyx
 
       def min_score=: (Float) -> Float
 
+      attr_reader page_number: Integer?
+
+      def page_number=: (Integer) -> Integer
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
       attr_reader region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region?
 
       def region=: (
         Telnyx::Models::AIRetrieveConversationHistoriesParams::region
       ) -> Telnyx::Models::AIRetrieveConversationHistoriesParams::region
 
-      attr_reader top_k: Integer?
-
-      def top_k=: (Integer) -> Integer
-
       def initialize: (
         q: String,
-        record_type: Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type,
-        ?filter_document_id: String,
         ?filter_ingested_at_gte: Time,
         ?filter_ingested_at_lte: Time,
         ?filter_record_created_at_gte: Time,
@@ -90,15 +85,14 @@ module Telnyx
         ?filter_retention: String,
         ?filter_user_id: String,
         ?min_score: Float,
+        ?page_number: Integer,
+        ?page_size: Integer,
         ?region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region,
-        ?top_k: Integer,
         ?request_options: Telnyx::request_opts
       ) -> void
 
       def to_hash: -> {
         q: String,
-        record_type: Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type,
-        filter_document_id: String,
         filter_ingested_at_gte: Time,
         filter_ingested_at_lte: Time,
         filter_record_created_at_gte: Time,
@@ -108,25 +102,12 @@ module Telnyx
         filter_retention: String,
         filter_user_id: String,
         min_score: Float,
+        page_number: Integer,
+        page_size: Integer,
         region: Telnyx::Models::AIRetrieveConversationHistoriesParams::region,
-        top_k: Integer,
         request_options: Telnyx::RequestOptions
       }
 
-      type record_type =
-        :voice | :message | :ai_pipeline_storage | :knowledge_base
-
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
-
-        VOICE: :voice
-        MESSAGE: :message
-        AI_PIPELINE_STORAGE: :ai_pipeline_storage
-        KNOWLEDGE_BASE: :knowledge_base
-
-        def self?.values: -> ::Array[Telnyx::Models::AIRetrieveConversationHistoriesParams::record_type]
-      end
-
       type region = :USA | :DEU | :AUS | :UAE
 
       module Region

data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs

@@ -26,12 +26,10 @@ module Telnyx
           id: String,
           chunk_index: Integer,
           chunk_total: Integer,
-          document_id: String?,
           ingested_at: Time,
           organization_id: String,
           record_created_at: Time,
           record_id: String,
-          record_type: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::record_type,
           region: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::region,
           score: Float,
           text: String,
@@ -46,8 +44,6 @@ module Telnyx
 
         attr_accessor chunk_total: Integer
 
-        attr_accessor document_id: String?
-
         attr_accessor ingested_at: Time
 
         attr_accessor organization_id: String
@@ -56,8 +52,6 @@ module Telnyx
 
         attr_accessor record_id: String
 
-        attr_accessor record_type: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::record_type
-
         attr_accessor region: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::region
 
         attr_accessor score: Float
@@ -74,12 +68,10 @@ module Telnyx
           id: String,
           chunk_index: Integer,
           chunk_total: Integer,
-          document_id: String?,
           ingested_at: Time,
           organization_id: String,
           record_created_at: Time,
           record_id: String,
-          record_type: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::record_type,
           region: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::region,
           score: Float,
           text: String,
@@ -91,12 +83,10 @@ module Telnyx
           id: String,
           chunk_index: Integer,
           chunk_total: Integer,
-          document_id: String?,
           ingested_at: Time,
           organization_id: String,
           record_created_at: Time,
           record_id: String,
-          record_type: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::record_type,
           region: Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::region,
           score: Float,
           text: String,
@@ -104,20 +94,6 @@ module Telnyx
           metadata: ::Hash[Symbol, top]
         }
 
-        type record_type =
-          :voice | :message | :ai_pipeline_storage | :knowledge_base
-
-        module RecordType
-          extend Telnyx::Internal::Type::Enum
-
-          VOICE: :voice
-          MESSAGE: :message
-          AI_PIPELINE_STORAGE: :ai_pipeline_storage
-          KNOWLEDGE_BASE: :knowledge_base
-
-          def self?.values: -> ::Array[Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::record_type]
-        end
-
         type region = :USA | :DEU | :AUS | :UAE
 
         module Region

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

@@ -5,9 +5,11 @@ module Telnyx
         {
           transcription_engine: Telnyx::Models::Calls::DeepgramNova2Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova2Config::transcription_model,
+          hints: ::Array[String],
           interim_results: bool,
           keywords_boosting: ::Hash[Symbol, Float],
           language: Telnyx::Models::Calls::DeepgramNova2Config::language,
+          smart_format: bool,
           utterance_end_ms: Integer
         }
 
@@ -16,6 +18,10 @@ module Telnyx
 
         attr_accessor transcription_model: Telnyx::Models::Calls::DeepgramNova2Config::transcription_model
 
+        attr_reader hints: ::Array[String]?
+
+        def hints=: (::Array[String]) -> ::Array[String]
+
         attr_reader interim_results: bool?
 
         def interim_results=: (bool) -> bool
@@ -30,6 +36,10 @@ module Telnyx
           Telnyx::Models::Calls::DeepgramNova2Config::language
         ) -> Telnyx::Models::Calls::DeepgramNova2Config::language
 
+        attr_reader smart_format: bool?
+
+        def smart_format=: (bool) -> bool
+
         attr_reader utterance_end_ms: Integer?
 
         def utterance_end_ms=: (Integer) -> Integer
@@ -37,18 +47,22 @@ module Telnyx
         def initialize: (
           transcription_engine: Telnyx::Models::Calls::DeepgramNova2Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova2Config::transcription_model,
+          ?hints: ::Array[String],
           ?interim_results: bool,
           ?keywords_boosting: ::Hash[Symbol, Float],
           ?language: Telnyx::Models::Calls::DeepgramNova2Config::language,
+          ?smart_format: bool,
           ?utterance_end_ms: Integer
         ) -> void
 
         def to_hash: -> {
           transcription_engine: Telnyx::Models::Calls::DeepgramNova2Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova2Config::transcription_model,
+          hints: ::Array[String],
           interim_results: bool,
           keywords_boosting: ::Hash[Symbol, Float],
           language: Telnyx::Models::Calls::DeepgramNova2Config::language,
+          smart_format: bool,
           utterance_end_ms: Integer
         }
 

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

@@ -6,8 +6,10 @@ module Telnyx
           transcription_engine: Telnyx::Models::Calls::DeepgramNova3Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova3Config::transcription_model,
           interim_results: bool,
+          keyterms: ::Array[String],
           keywords_boosting: ::Hash[Symbol, Float],
           language: Telnyx::Models::Calls::DeepgramNova3Config::language,
+          smart_format: bool,
           utterance_end_ms: Integer
         }
 
@@ -20,6 +22,10 @@ module Telnyx
 
         def interim_results=: (bool) -> bool
 
+        attr_reader keyterms: ::Array[String]?
+
+        def keyterms=: (::Array[String]) -> ::Array[String]
+
         attr_reader keywords_boosting: ::Hash[Symbol, Float]?
 
         def keywords_boosting=: (::Hash[Symbol, Float]) -> ::Hash[Symbol, Float]
@@ -30,6 +36,10 @@ module Telnyx
           Telnyx::Models::Calls::DeepgramNova3Config::language
         ) -> Telnyx::Models::Calls::DeepgramNova3Config::language
 
+        attr_reader smart_format: bool?
+
+        def smart_format=: (bool) -> bool
+
         attr_reader utterance_end_ms: Integer?
 
         def utterance_end_ms=: (Integer) -> Integer
@@ -38,8 +48,10 @@ module Telnyx
           transcription_engine: Telnyx::Models::Calls::DeepgramNova3Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova3Config::transcription_model,
           ?interim_results: bool,
+          ?keyterms: ::Array[String],
           ?keywords_boosting: ::Hash[Symbol, Float],
           ?language: Telnyx::Models::Calls::DeepgramNova3Config::language,
+          ?smart_format: bool,
           ?utterance_end_ms: Integer
         ) -> void
 
@@ -47,8 +59,10 @@ module Telnyx
           transcription_engine: Telnyx::Models::Calls::DeepgramNova3Config::transcription_engine,
           transcription_model: Telnyx::Models::Calls::DeepgramNova3Config::transcription_model,
           interim_results: bool,
+          keyterms: ::Array[String],
           keywords_boosting: ::Hash[Symbol, Float],
           language: Telnyx::Models::Calls::DeepgramNova3Config::language,
+          smart_format: bool,
           utterance_end_ms: Integer
         }
 

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

@@ -90,6 +90,7 @@ module Telnyx
           | Telnyx::Calls::TranscriptionEngineAssemblyaiConfig
           | Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig
           | Telnyx::Calls::TranscriptionEngineSonioxConfig
+          | Telnyx::Calls::TranscriptionEngineParakeetConfig
           | Telnyx::Calls::TranscriptionEngineAConfig
           | Telnyx::Calls::TranscriptionEngineBConfig
           | Telnyx::Calls::DeepgramNova2Config

data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs

@@ -0,0 +1,69 @@
+module Telnyx
+  module Models
+    module Dir
+      type email_verification_status_wrapped =
+        { data: Telnyx::Dir::EmailVerificationStatusWrapped::Data }
+
+      class EmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+
+        def initialize: (
+          data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+        ) -> void
+
+        def to_hash: -> {
+          data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+        }
+
+        type data =
+          {
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          }
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          attr_accessor email_verified: bool
+
+          attr_accessor status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+
+          attr_accessor record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type
+
+          def initialize: (
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          ) -> void
+
+          def to_hash: -> {
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          }
+
+          type record_type = :email_verification
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_VERIFICATION: :email_verification
+
+            def self?.values: -> ::Array[Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type]
+          end
+
+          type status = :sent | :verified | :unverified
+
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SENT: :sent
+            VERIFIED: :verified
+            UNVERIFIED: :unverified
+
+            def self?.values: -> ::Array[Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference.rbs

@@ -0,0 +1,88 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference =
+        {
+          full_name: String,
+          :phone_e164 => String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          email: String?,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+      class Reference < Telnyx::Internal::Type::BaseModel
+        attr_accessor full_name: String
+
+        attr_accessor phone_e164: String
+
+        attr_accessor ref_type: Telnyx::Models::Dir::Reference::ref_type
+
+        attr_accessor slot: Integer
+
+        attr_accessor timezone: String
+
+        attr_accessor email: String?
+
+        attr_accessor job_title: String?
+
+        attr_accessor organization: String?
+
+        attr_accessor relationship_to_registrant: String?
+
+        attr_accessor record_type: Telnyx::Models::Dir::Reference::record_type
+
+        def initialize: (
+          full_name: String,
+          phone_e164: String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          ?email: String?,
+          ?job_title: String?,
+          ?organization: String?,
+          ?relationship_to_registrant: String?
+        ) -> void
+
+        def to_hash: -> {
+          full_name: String,
+          :phone_e164 => String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          email: String?,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+        type record_type = :dir_reference
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          DIR_REFERENCE: :dir_reference
+
+          def self?.values: -> ::Array[Telnyx::Models::Dir::Reference::record_type]
+        end
+
+        type ref_type = :business | :financial
+
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS: :business
+          FINANCIAL: :financial
+
+          def self?.values: -> ::Array[Telnyx::Models::Dir::Reference::ref_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_create_params.rbs

@@ -0,0 +1,38 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_create_params =
+        {
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ReferenceCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor dir_id: String
+
+        attr_accessor business_references: ::Array[Telnyx::Dir::ReferenceInput]
+
+        attr_accessor financial_reference: Telnyx::Dir::ReferenceInput
+
+        def initialize: (
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_input.rbs

@@ -0,0 +1,52 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_input =
+        {
+          email: String,
+          full_name: String,
+          :phone_e164 => String,
+          timezone: String,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+      class ReferenceInput < Telnyx::Internal::Type::BaseModel
+        attr_accessor email: String
+
+        attr_accessor full_name: String
+
+        attr_accessor phone_e164: String
+
+        attr_accessor timezone: String
+
+        attr_accessor job_title: String?
+
+        attr_accessor organization: String?
+
+        attr_accessor relationship_to_registrant: String?
+
+        def initialize: (
+          email: String,
+          full_name: String,
+          phone_e164: String,
+          timezone: String,
+          ?job_title: String?,
+          ?organization: String?,
+          ?relationship_to_registrant: String?
+        ) -> void
+
+        def to_hash: -> {
+          email: String,
+          full_name: String,
+          :phone_e164 => String,
+          timezone: String,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_list.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_list = { data: ::Array[Telnyx::Dir::Reference] }
+
+      class ReferenceList < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Telnyx::Dir::Reference]
+
+        def initialize: (data: ::Array[Telnyx::Dir::Reference]) -> void
+
+        def to_hash: -> { data: ::Array[Telnyx::Dir::Reference] }
+      end
+    end
+  end
+end