telnyx 5.68.1 → 5.69.0

data/lib/telnyx/models/ai/inference_embedding.rb

@@ -96,6 +96,11 @@ module Telnyx
         #   @return [Telnyx::Models::AI::MessagingSettings, nil]
         optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
 
+        # @!attribute observability_settings
+        #
+        #   @return [Telnyx::Models::AI::InferenceEmbedding::ObservabilitySettings, nil]
+        optional :observability_settings, -> { Telnyx::AI::InferenceEmbedding::ObservabilitySettings }
+
         # @!attribute privacy_settings
         #
         #   @return [Telnyx::Models::AI::PrivacySettings, nil]
@@ -129,7 +134,7 @@ module Telnyx
         #   @return [Telnyx::Models::AI::WidgetSettings, nil]
         optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
 
-        # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
+        # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::InferenceEmbedding} for more details.
         #
@@ -161,6 +166,8 @@ module Telnyx
         #
         #   @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
         #
+        #   @param observability_settings [Telnyx::Models::AI::InferenceEmbedding::ObservabilitySettings]
+        #
         #   @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
         #
         #   @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
@@ -172,6 +179,46 @@ module Telnyx
         #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
         #
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
+
+        # @see Telnyx::Models::AI::InferenceEmbedding#observability_settings
+        class ObservabilitySettings < Telnyx::Internal::Type::BaseModel
+          # @!attribute host
+          #
+          #   @return [String, nil]
+          optional :host, String
+
+          # @!attribute public_key_ref
+          #
+          #   @return [String, nil]
+          optional :public_key_ref, String
+
+          # @!attribute secret_key_ref
+          #
+          #   @return [String, nil]
+          optional :secret_key_ref, String
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::ObservabilitySettings::Status, nil]
+          optional :status, enum: -> { Telnyx::AI::InferenceEmbedding::ObservabilitySettings::Status }
+
+          # @!method initialize(host: nil, public_key_ref: nil, secret_key_ref: nil, status: nil)
+          #   @param host [String]
+          #   @param public_key_ref [String]
+          #   @param secret_key_ref [String]
+          #   @param status [Symbol, Telnyx::Models::AI::InferenceEmbedding::ObservabilitySettings::Status]
+
+          # @see Telnyx::Models::AI::InferenceEmbedding::ObservabilitySettings#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end

data/lib/telnyx/models/ai/telephony_settings.rb

@@ -146,6 +146,13 @@ module Telnyx
           #   @return [Symbol, Telnyx::Models::AI::TelephonySettings::RecordingSettings::Channels, nil]
           optional :channels, enum: -> { Telnyx::AI::TelephonySettings::RecordingSettings::Channels }
 
+          # @!attribute enabled
+          #   Whether call recording is enabled. When set to false, calls will not be recorded
+          #   regardless of other recording configuration.
+          #
+          #   @return [Boolean, nil]
+          optional :enabled, Telnyx::Internal::Type::Boolean
+
           # @!attribute file_format
           #   The format of the recording file.
           #
@@ -154,11 +161,16 @@ module Telnyx
                    enum: -> { Telnyx::AI::TelephonySettings::RecordingSettings::Format },
                    api_name: :format
 
-          # @!method initialize(channels: nil, file_format: nil)
+          # @!method initialize(channels: nil, enabled: nil, file_format: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::TelephonySettings::RecordingSettings} for more details.
+          #
           #   Configuration for call recording format and channel settings.
           #
           #   @param channels [Symbol, Telnyx::Models::AI::TelephonySettings::RecordingSettings::Channels] The number of channels for the recording. 'single' for mono, 'dual' for stereo.
           #
+          #   @param enabled [Boolean] Whether call recording is enabled. When set to false, calls will not be recorded
+          #
           #   @param file_format [Symbol, Telnyx::Models::AI::TelephonySettings::RecordingSettings::Format] The format of the recording file.
 
           # The number of channels for the recording. 'single' for mono, 'dual' for stereo.

data/lib/telnyx/models/pronunciation_dict_create_params.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#create
+    class PronunciationDictCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute items
+      #   List of pronunciation items (alias or phoneme type). At least one item is
+      #   required.
+      #
+      #   @return [Array<Telnyx::Models::PronunciationDictCreateParams::Item::Alias, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme>]
+      required :items,
+               -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::PronunciationDictCreateParams::Item] }
+
+      # @!attribute name
+      #   Human-readable name. Must be unique within the organization.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(items:, name:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::PronunciationDictCreateParams} for more details.
+      #
+      #   @param items [Array<Telnyx::Models::PronunciationDictCreateParams::Item::Alias, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme>] List of pronunciation items (alias or phoneme type). At least one item is requir
+      #
+      #   @param name [String] Human-readable name. Must be unique within the organization.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # A single pronunciation dictionary item. Use type 'alias' to replace matched text
+      # with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA
+      # notation.
+      module Item
+        extend Telnyx::Internal::Type::Union
+
+        discriminator :type
+
+        # An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.
+        variant :alias, -> { Telnyx::PronunciationDictCreateParams::Item::Alias }
+
+        # A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.
+        variant :phoneme, -> { Telnyx::PronunciationDictCreateParams::Item::Phoneme }
+
+        class Alias < Telnyx::Internal::Type::BaseModel
+          # @!attribute alias_
+          #   The replacement text that will be spoken instead.
+          #
+          #   @return [String]
+          required :alias_, String, api_name: :alias
+
+          # @!attribute text
+          #   The text to match in the input. Case-insensitive matching is used during
+          #   synthesis.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The item type.
+          #
+          #   @return [Symbol, :alias]
+          required :type, const: :alias
+
+          # @!method initialize(alias_:, text:, type: :alias)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::PronunciationDictCreateParams::Item::Alias} for more details.
+          #
+          #   An alias pronunciation item. When the `text` value is found in input, it is
+          #   replaced with the `alias` before speech synthesis.
+          #
+          #   @param alias_ [String] The replacement text that will be spoken instead.
+          #
+          #   @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
+          #
+          #   @param type [Symbol, :alias] The item type.
+        end
+
+        class Phoneme < Telnyx::Internal::Type::BaseModel
+          # @!attribute alphabet
+          #   The phonetic alphabet used for the phoneme notation.
+          #
+          #   @return [Symbol, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme::Alphabet]
+          required :alphabet, enum: -> { Telnyx::PronunciationDictCreateParams::Item::Phoneme::Alphabet }
+
+          # @!attribute phoneme
+          #   The phoneme notation representing the desired pronunciation.
+          #
+          #   @return [String]
+          required :phoneme, String
+
+          # @!attribute text
+          #   The text to match in the input. Case-insensitive matching is used during
+          #   synthesis.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The item type.
+          #
+          #   @return [Symbol, :phoneme]
+          required :type, const: :phoneme
+
+          # @!method initialize(alphabet:, phoneme:, text:, type: :phoneme)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme} for more details.
+          #
+          #   A phoneme pronunciation item. When the `text` value is found in input, it is
+          #   pronounced using the specified IPA phoneme notation.
+          #
+          #   @param alphabet [Symbol, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme::Alphabet] The phonetic alphabet used for the phoneme notation.
+          #
+          #   @param phoneme [String] The phoneme notation representing the desired pronunciation.
+          #
+          #   @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
+          #
+          #   @param type [Symbol, :phoneme] The item type.
+
+          # The phonetic alphabet used for the phoneme notation.
+          #
+          # @see Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme#alphabet
+          module Alphabet
+            extend Telnyx::Internal::Type::Enum
+
+            IPA = :ipa
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::PronunciationDictCreateParams::Item::Alias, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme)]
+      end
+    end
+  end
+end

data/lib/telnyx/models/pronunciation_dict_create_response.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#create
+    class PronunciationDictCreateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   A pronunciation dictionary record.
+      #
+      #   @return [Telnyx::Models::PronunciationDictCreateResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PronunciationDictCreateResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   Response containing a single pronunciation dictionary.
+      #
+      #   @param data [Telnyx::Models::PronunciationDictCreateResponse::Data] A pronunciation dictionary record.
+
+      # @see Telnyx::Models::PronunciationDictCreateResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the pronunciation dictionary.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 timestamp with millisecond precision.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute items
+        #   List of pronunciation items (alias or phoneme type).
+        #
+        #   @return [Array<Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme>, nil]
+        optional :items,
+                 -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Models::PronunciationDictCreateResponse::Data::Item] }
+
+        # @!attribute name
+        #   Human-readable name for the dictionary. Must be unique within the organization.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute record_type
+        #   Identifies the resource type.
+        #
+        #   @return [Symbol, Telnyx::Models::PronunciationDictCreateResponse::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::Models::PronunciationDictCreateResponse::Data::RecordType }
+
+        # @!attribute updated_at
+        #   ISO 8601 timestamp with millisecond precision.
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!attribute version
+        #   Auto-incrementing version number. Increases by 1 on each update. Used for
+        #   optimistic concurrency control and cache invalidation.
+        #
+        #   @return [Integer, nil]
+        optional :version, Integer
+
+        # @!method initialize(id: nil, created_at: nil, items: nil, name: nil, record_type: nil, updated_at: nil, version: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::PronunciationDictCreateResponse::Data} for more details.
+        #
+        #   A pronunciation dictionary record.
+        #
+        #   @param id [String] Unique identifier for the pronunciation dictionary.
+        #
+        #   @param created_at [Time] ISO 8601 timestamp with millisecond precision.
+        #
+        #   @param items [Array<Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme>] List of pronunciation items (alias or phoneme type).
+        #
+        #   @param name [String] Human-readable name for the dictionary. Must be unique within the organization.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::PronunciationDictCreateResponse::Data::RecordType] Identifies the resource type.
+        #
+        #   @param updated_at [Time] ISO 8601 timestamp with millisecond precision.
+        #
+        #   @param version [Integer] Auto-incrementing version number. Increases by 1 on each update. Used for optimi
+
+        # A single pronunciation dictionary item. Use type 'alias' to replace matched text
+        # with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA
+        # notation.
+        module Item
+          extend Telnyx::Internal::Type::Union
+
+          discriminator :type
+
+          # An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.
+          variant :alias, -> { Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Alias }
+
+          # A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.
+          variant :phoneme, -> { Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme }
+
+          class Alias < Telnyx::Internal::Type::BaseModel
+            # @!attribute alias_
+            #   The replacement text that will be spoken instead.
+            #
+            #   @return [String]
+            required :alias_, String, api_name: :alias
+
+            # @!attribute text
+            #   The text to match in the input. Case-insensitive matching is used during
+            #   synthesis.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The item type.
+            #
+            #   @return [Symbol, :alias]
+            required :type, const: :alias
+
+            # @!method initialize(alias_:, text:, type: :alias)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Alias} for more
+            #   details.
+            #
+            #   An alias pronunciation item. When the `text` value is found in input, it is
+            #   replaced with the `alias` before speech synthesis.
+            #
+            #   @param alias_ [String] The replacement text that will be spoken instead.
+            #
+            #   @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
+            #
+            #   @param type [Symbol, :alias] The item type.
+          end
+
+          class Phoneme < Telnyx::Internal::Type::BaseModel
+            # @!attribute alphabet
+            #   The phonetic alphabet used for the phoneme notation.
+            #
+            #   @return [Symbol, Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme::Alphabet]
+            required :alphabet,
+                     enum: -> { Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme::Alphabet }
+
+            # @!attribute phoneme
+            #   The phoneme notation representing the desired pronunciation.
+            #
+            #   @return [String]
+            required :phoneme, String
+
+            # @!attribute text
+            #   The text to match in the input. Case-insensitive matching is used during
+            #   synthesis.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The item type.
+            #
+            #   @return [Symbol, :phoneme]
+            required :type, const: :phoneme
+
+            # @!method initialize(alphabet:, phoneme:, text:, type: :phoneme)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme} for more
+            #   details.
+            #
+            #   A phoneme pronunciation item. When the `text` value is found in input, it is
+            #   pronounced using the specified IPA phoneme notation.
+            #
+            #   @param alphabet [Symbol, Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme::Alphabet] The phonetic alphabet used for the phoneme notation.
+            #
+            #   @param phoneme [String] The phoneme notation representing the desired pronunciation.
+            #
+            #   @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
+            #
+            #   @param type [Symbol, :phoneme] The item type.
+
+            # The phonetic alphabet used for the phoneme notation.
+            #
+            # @see Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme#alphabet
+            module Alphabet
+              extend Telnyx::Internal::Type::Enum
+
+              IPA = :ipa
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictCreateResponse::Data::Item::Phoneme)]
+        end
+
+        # Identifies the resource type.
+        #
+        # @see Telnyx::Models::PronunciationDictCreateResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          PRONUNCIATION_DICT = :pronunciation_dict
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/pronunciation_dict_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#delete
+    class PronunciationDictDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/pronunciation_dict_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#list
+    class PronunciationDictListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute page_number
+      #   Page number (1-based). Defaults to 1.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Defaults to 20, maximum 250.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @param page_number [Integer] Page number (1-based). Defaults to 1.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to 20, maximum 250.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end