telnyx 5.68.2 → 5.69.0

data/lib/telnyx/models/pronunciation_dict_retrieve_response.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#retrieve
+    class PronunciationDictRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   A pronunciation dictionary record.
+      #
+      #   @return [Telnyx::Models::PronunciationDictRetrieveResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   Response containing a single pronunciation dictionary.
+      #
+      #   @param data [Telnyx::Models::PronunciationDictRetrieveResponse::Data] A pronunciation dictionary record.
+
+      # @see Telnyx::Models::PronunciationDictRetrieveResponse#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::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme>, nil]
+        optional :items,
+                 -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Models::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::Models::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::Data::Item::Phoneme::Alphabet]
+            required :alphabet,
+                     enum: -> { Telnyx::Models::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::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::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme)]
+        end
+
+        # Identifies the resource type.
+        #
+        # @see Telnyx::Models::PronunciationDictRetrieveResponse::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_update_params.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#update
+    class PronunciationDictUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute items
+      #   Updated list of pronunciation items (alias or phoneme type).
+      #
+      #   @return [Array<Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme>, nil]
+      optional :items,
+               -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::PronunciationDictUpdateParams::Item] }
+
+      # @!attribute name
+      #   Updated dictionary name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(id:, items: nil, name: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param items [Array<Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme>] Updated list of pronunciation items (alias or phoneme type).
+      #
+      #   @param name [String] Updated dictionary name.
+      #
+      #   @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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::Item::Phoneme::Alphabet]
+          required :alphabet, enum: -> { Telnyx::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::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::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme)]
+      end
+    end
+  end
+end

data/lib/telnyx/models/pronunciation_dict_update_response.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PronunciationDicts#update
+    class PronunciationDictUpdateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   A pronunciation dictionary record.
+      #
+      #   @return [Telnyx::Models::PronunciationDictUpdateResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PronunciationDictUpdateResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   Response containing a single pronunciation dictionary.
+      #
+      #   @param data [Telnyx::Models::PronunciationDictUpdateResponse::Data] A pronunciation dictionary record.
+
+      # @see Telnyx::Models::PronunciationDictUpdateResponse#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::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme>, nil]
+        optional :items,
+                 -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Models::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::Models::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::Data::Item::Phoneme::Alphabet]
+            required :alphabet,
+                     enum: -> { Telnyx::Models::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::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::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme)]
+        end
+
+        # Identifies the resource type.
+        #
+        # @see Telnyx::Models::PronunciationDictUpdateResponse::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