telnyx 5.70.0 → 5.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant.rb +6 -149
  5. data/lib/telnyx/models/book_appointment_tool.rb +31 -0
  6. data/lib/telnyx/models/book_appointment_tool_params.rb +51 -0
  7. data/lib/telnyx/models/call_assistant_request.rb +176 -0
  8. data/lib/telnyx/models/call_control_bucket_ids.rb +23 -0
  9. data/lib/telnyx/models/call_control_retrieval_tool.rb +31 -0
  10. data/lib/telnyx/models/call_dial_params.rb +11 -1
  11. data/lib/telnyx/models/calls/action_answer_params.rb +11 -1
  12. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +6 -39
  13. data/lib/telnyx/models/check_availability_tool.rb +31 -0
  14. data/lib/telnyx/models/check_availability_tool_params.rb +31 -0
  15. data/lib/telnyx/models/pronunciation_dict_alias_item.rb +51 -0
  16. data/lib/telnyx/models/pronunciation_dict_create_params.rb +5 -93
  17. data/lib/telnyx/models/pronunciation_dict_create_response.rb +3 -191
  18. data/lib/telnyx/models/pronunciation_dict_data.rb +101 -0
  19. data/lib/telnyx/models/pronunciation_dict_phoneme_item.rb +71 -0
  20. data/lib/telnyx/models/pronunciation_dict_retrieve_response.rb +3 -191
  21. data/lib/telnyx/models/pronunciation_dict_update_params.rb +5 -93
  22. data/lib/telnyx/models/pronunciation_dict_update_response.rb +3 -191
  23. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +203 -191
  24. data/lib/telnyx/models/voice_clone_create_from_design_params.rb +3 -3
  25. data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +61 -54
  26. data/lib/telnyx/models/voice_clone_create_params.rb +28 -28
  27. data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rb +26 -0
  28. data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rb +54 -0
  29. data/lib/telnyx/models.rb +20 -0
  30. data/lib/telnyx/resources/calls/actions.rb +4 -2
  31. data/lib/telnyx/resources/calls.rb +3 -1
  32. data/lib/telnyx/resources/pronunciation_dicts.rb +4 -4
  33. data/lib/telnyx/resources/texml/accounts/calls.rb +3 -3
  34. data/lib/telnyx/resources/voice_clones.rb +6 -6
  35. data/lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb +20 -0
  36. data/lib/telnyx/version.rb +1 -1
  37. data/lib/telnyx.rb +12 -1
  38. data/rbi/telnyx/models/ai/assistant.rbi +15 -329
  39. data/rbi/telnyx/models/book_appointment_tool.rbi +65 -0
  40. data/rbi/telnyx/models/book_appointment_tool_params.rbi +83 -0
  41. data/rbi/telnyx/models/call_assistant_request.rbi +322 -0
  42. data/rbi/telnyx/models/call_control_bucket_ids.rbi +42 -0
  43. data/rbi/telnyx/models/call_control_retrieval_tool.rbi +63 -0
  44. data/rbi/telnyx/models/call_dial_params.rbi +15 -0
  45. data/rbi/telnyx/models/calls/action_answer_params.rbi +15 -0
  46. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +10 -77
  47. data/rbi/telnyx/models/check_availability_tool.rbi +67 -0
  48. data/rbi/telnyx/models/check_availability_tool_params.rbi +45 -0
  49. data/rbi/telnyx/models/pronunciation_dict_alias_item.rbi +79 -0
  50. data/rbi/telnyx/models/pronunciation_dict_create_params.rbi +8 -154
  51. data/rbi/telnyx/models/pronunciation_dict_create_response.rbi +6 -366
  52. data/rbi/telnyx/models/pronunciation_dict_data.rbi +186 -0
  53. data/rbi/telnyx/models/pronunciation_dict_phoneme_item.rbi +117 -0
  54. data/rbi/telnyx/models/pronunciation_dict_retrieve_response.rbi +6 -366
  55. data/rbi/telnyx/models/pronunciation_dict_update_params.rbi +10 -156
  56. data/rbi/telnyx/models/pronunciation_dict_update_response.rbi +6 -366
  57. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +391 -403
  58. data/rbi/telnyx/models/voice_clone_create_from_design_params.rbi +10 -10
  59. data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +94 -92
  60. data/rbi/telnyx/models/voice_clone_create_params.rbi +53 -53
  61. data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbi +47 -0
  62. data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbi +118 -0
  63. data/rbi/telnyx/models.rbi +20 -0
  64. data/rbi/telnyx/resources/calls/actions.rbi +9 -3
  65. data/rbi/telnyx/resources/calls.rbi +5 -0
  66. data/rbi/telnyx/resources/pronunciation_dicts.rbi +5 -7
  67. data/rbi/telnyx/resources/texml/accounts/calls.rbi +5 -5
  68. data/rbi/telnyx/resources/voice_clones.rbi +9 -9
  69. data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi +16 -0
  70. data/sig/telnyx/models/ai/assistant.rbs +3 -142
  71. data/sig/telnyx/models/book_appointment_tool.rbs +35 -0
  72. data/sig/telnyx/models/book_appointment_tool_params.rbs +39 -0
  73. data/sig/telnyx/models/call_assistant_request.rbs +132 -0
  74. data/sig/telnyx/models/call_control_bucket_ids.rbs +21 -0
  75. data/sig/telnyx/models/call_control_retrieval_tool.rbs +35 -0
  76. data/sig/telnyx/models/call_dial_params.rbs +9 -0
  77. data/sig/telnyx/models/calls/action_answer_params.rbs +9 -0
  78. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +6 -35
  79. data/sig/telnyx/models/check_availability_tool.rbs +35 -0
  80. data/sig/telnyx/models/check_availability_tool_params.rbs +16 -0
  81. data/sig/telnyx/models/pronunciation_dict_alias_item.rbs +40 -0
  82. data/sig/telnyx/models/pronunciation_dict_create_params.rbs +2 -58
  83. data/sig/telnyx/models/pronunciation_dict_create_response.rbs +6 -155
  84. data/sig/telnyx/models/pronunciation_dict_data.rbs +88 -0
  85. data/sig/telnyx/models/pronunciation_dict_phoneme_item.rbs +55 -0
  86. data/sig/telnyx/models/pronunciation_dict_retrieve_response.rbs +6 -155
  87. data/sig/telnyx/models/pronunciation_dict_update_params.rbs +2 -58
  88. data/sig/telnyx/models/pronunciation_dict_update_response.rbs +6 -155
  89. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +317 -325
  90. data/sig/telnyx/models/voice_clone_create_from_design_params.rbs +7 -7
  91. data/sig/telnyx/models/voice_clone_create_from_upload_params.rbs +63 -61
  92. data/sig/telnyx/models/voice_clone_create_params.rbs +35 -35
  93. data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbs +30 -0
  94. data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbs +63 -0
  95. data/sig/telnyx/models.rbs +20 -0
  96. data/sig/telnyx/resources/calls/actions.rbs +2 -1
  97. data/sig/telnyx/resources/calls.rbs +1 -0
  98. data/sig/telnyx/resources/pronunciation_dicts.rbs +1 -1
  99. data/sig/telnyx/resources/texml/accounts/calls.rbs +1 -1
  100. data/sig/telnyx/resources/voice_clones.rbs +2 -2
  101. data/sig/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbs +5 -0
  102. metadata +38 -5
  103. data/lib/telnyx/models/pronunciation_dict_list_response.rb +0 -190
  104. data/rbi/telnyx/models/pronunciation_dict_list_response.rbi +0 -353
  105. data/sig/telnyx/models/pronunciation_dict_list_response.rbs +0 -144
@@ -7,201 +7,13 @@ module Telnyx
7
7
  # @!attribute data
8
8
  # A pronunciation dictionary record.
9
9
  #
10
- # @return [Telnyx::Models::PronunciationDictRetrieveResponse::Data, nil]
11
- optional :data, -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data }
10
+ # @return [Telnyx::Models::PronunciationDictData, nil]
11
+ optional :data, -> { Telnyx::PronunciationDictData }
12
12
 
13
13
  # @!method initialize(data: nil)
14
14
  # Response containing a single pronunciation dictionary.
15
15
  #
16
- # @param data [Telnyx::Models::PronunciationDictRetrieveResponse::Data] A pronunciation dictionary record.
17
-
18
- # @see Telnyx::Models::PronunciationDictRetrieveResponse#data
19
- class Data < Telnyx::Internal::Type::BaseModel
20
- # @!attribute id
21
- # Unique identifier for the pronunciation dictionary.
22
- #
23
- # @return [String, nil]
24
- optional :id, String
25
-
26
- # @!attribute created_at
27
- # ISO 8601 timestamp with millisecond precision.
28
- #
29
- # @return [Time, nil]
30
- optional :created_at, Time
31
-
32
- # @!attribute items
33
- # List of pronunciation items (alias or phoneme type).
34
- #
35
- # @return [Array<Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme>, nil]
36
- optional :items,
37
- -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item] }
38
-
39
- # @!attribute name
40
- # Human-readable name for the dictionary. Must be unique within the organization.
41
- #
42
- # @return [String, nil]
43
- optional :name, String
44
-
45
- # @!attribute record_type
46
- # Identifies the resource type.
47
- #
48
- # @return [Symbol, Telnyx::Models::PronunciationDictRetrieveResponse::Data::RecordType, nil]
49
- optional :record_type, enum: -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data::RecordType }
50
-
51
- # @!attribute updated_at
52
- # ISO 8601 timestamp with millisecond precision.
53
- #
54
- # @return [Time, nil]
55
- optional :updated_at, Time
56
-
57
- # @!attribute version
58
- # Auto-incrementing version number. Increases by 1 on each update. Used for
59
- # optimistic concurrency control and cache invalidation.
60
- #
61
- # @return [Integer, nil]
62
- optional :version, Integer
63
-
64
- # @!method initialize(id: nil, created_at: nil, items: nil, name: nil, record_type: nil, updated_at: nil, version: nil)
65
- # Some parameter documentations has been truncated, see
66
- # {Telnyx::Models::PronunciationDictRetrieveResponse::Data} for more details.
67
- #
68
- # A pronunciation dictionary record.
69
- #
70
- # @param id [String] Unique identifier for the pronunciation dictionary.
71
- #
72
- # @param created_at [Time] ISO 8601 timestamp with millisecond precision.
73
- #
74
- # @param items [Array<Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme>] List of pronunciation items (alias or phoneme type).
75
- #
76
- # @param name [String] Human-readable name for the dictionary. Must be unique within the organization.
77
- #
78
- # @param record_type [Symbol, Telnyx::Models::PronunciationDictRetrieveResponse::Data::RecordType] Identifies the resource type.
79
- #
80
- # @param updated_at [Time] ISO 8601 timestamp with millisecond precision.
81
- #
82
- # @param version [Integer] Auto-incrementing version number. Increases by 1 on each update. Used for optimi
83
-
84
- # A single pronunciation dictionary item. Use type 'alias' to replace matched text
85
- # with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA
86
- # notation.
87
- module Item
88
- extend Telnyx::Internal::Type::Union
89
-
90
- discriminator :type
91
-
92
- # An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.
93
- variant :alias, -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Alias }
94
-
95
- # A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.
96
- variant :phoneme, -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme }
97
-
98
- class Alias < Telnyx::Internal::Type::BaseModel
99
- # @!attribute alias_
100
- # The replacement text that will be spoken instead.
101
- #
102
- # @return [String]
103
- required :alias_, String, api_name: :alias
104
-
105
- # @!attribute text
106
- # The text to match in the input. Case-insensitive matching is used during
107
- # synthesis.
108
- #
109
- # @return [String]
110
- required :text, String
111
-
112
- # @!attribute type
113
- # The item type.
114
- #
115
- # @return [Symbol, :alias]
116
- required :type, const: :alias
117
-
118
- # @!method initialize(alias_:, text:, type: :alias)
119
- # Some parameter documentations has been truncated, see
120
- # {Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Alias} for more
121
- # details.
122
- #
123
- # An alias pronunciation item. When the `text` value is found in input, it is
124
- # replaced with the `alias` before speech synthesis.
125
- #
126
- # @param alias_ [String] The replacement text that will be spoken instead.
127
- #
128
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
129
- #
130
- # @param type [Symbol, :alias] The item type.
131
- end
132
-
133
- class Phoneme < Telnyx::Internal::Type::BaseModel
134
- # @!attribute alphabet
135
- # The phonetic alphabet used for the phoneme notation.
136
- #
137
- # @return [Symbol, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme::Alphabet]
138
- required :alphabet,
139
- enum: -> { Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme::Alphabet }
140
-
141
- # @!attribute phoneme
142
- # The phoneme notation representing the desired pronunciation.
143
- #
144
- # @return [String]
145
- required :phoneme, String
146
-
147
- # @!attribute text
148
- # The text to match in the input. Case-insensitive matching is used during
149
- # synthesis.
150
- #
151
- # @return [String]
152
- required :text, String
153
-
154
- # @!attribute type
155
- # The item type.
156
- #
157
- # @return [Symbol, :phoneme]
158
- required :type, const: :phoneme
159
-
160
- # @!method initialize(alphabet:, phoneme:, text:, type: :phoneme)
161
- # Some parameter documentations has been truncated, see
162
- # {Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme} for
163
- # more details.
164
- #
165
- # A phoneme pronunciation item. When the `text` value is found in input, it is
166
- # pronounced using the specified IPA phoneme notation.
167
- #
168
- # @param alphabet [Symbol, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme::Alphabet] The phonetic alphabet used for the phoneme notation.
169
- #
170
- # @param phoneme [String] The phoneme notation representing the desired pronunciation.
171
- #
172
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
173
- #
174
- # @param type [Symbol, :phoneme] The item type.
175
-
176
- # The phonetic alphabet used for the phoneme notation.
177
- #
178
- # @see Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme#alphabet
179
- module Alphabet
180
- extend Telnyx::Internal::Type::Enum
181
-
182
- IPA = :ipa
183
-
184
- # @!method self.values
185
- # @return [Array<Symbol>]
186
- end
187
- end
188
-
189
- # @!method self.variants
190
- # @return [Array(Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictRetrieveResponse::Data::Item::Phoneme)]
191
- end
192
-
193
- # Identifies the resource type.
194
- #
195
- # @see Telnyx::Models::PronunciationDictRetrieveResponse::Data#record_type
196
- module RecordType
197
- extend Telnyx::Internal::Type::Enum
198
-
199
- PRONUNCIATION_DICT = :pronunciation_dict
200
-
201
- # @!method self.values
202
- # @return [Array<Symbol>]
203
- end
204
- end
16
+ # @param data [Telnyx::Models::PronunciationDictData] A pronunciation dictionary record.
205
17
  end
206
18
  end
207
19
  end
@@ -15,7 +15,7 @@ module Telnyx
15
15
  # @!attribute items
16
16
  # Updated list of pronunciation items (alias or phoneme type).
17
17
  #
18
- # @return [Array<Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme>, nil]
18
+ # @return [Array<Telnyx::Models::PronunciationDictAliasItem, Telnyx::Models::PronunciationDictPhonemeItem>, nil]
19
19
  optional :items,
20
20
  -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::PronunciationDictUpdateParams::Item] }
21
21
 
@@ -28,7 +28,7 @@ module Telnyx
28
28
  # @!method initialize(id:, items: nil, name: nil, request_options: {})
29
29
  # @param id [String]
30
30
  #
31
- # @param items [Array<Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme>] Updated list of pronunciation items (alias or phoneme type).
31
+ # @param items [Array<Telnyx::Models::PronunciationDictAliasItem, Telnyx::Models::PronunciationDictPhonemeItem>] Updated list of pronunciation items (alias or phoneme type).
32
32
  #
33
33
  # @param name [String] Updated dictionary name.
34
34
  #
@@ -43,101 +43,13 @@ module Telnyx
43
43
  discriminator :type
44
44
 
45
45
  # An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.
46
- variant :alias, -> { Telnyx::PronunciationDictUpdateParams::Item::Alias }
46
+ variant :alias, -> { Telnyx::PronunciationDictAliasItem }
47
47
 
48
48
  # A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.
49
- variant :phoneme, -> { Telnyx::PronunciationDictUpdateParams::Item::Phoneme }
50
-
51
- class Alias < Telnyx::Internal::Type::BaseModel
52
- # @!attribute alias_
53
- # The replacement text that will be spoken instead.
54
- #
55
- # @return [String]
56
- required :alias_, String, api_name: :alias
57
-
58
- # @!attribute text
59
- # The text to match in the input. Case-insensitive matching is used during
60
- # synthesis.
61
- #
62
- # @return [String]
63
- required :text, String
64
-
65
- # @!attribute type
66
- # The item type.
67
- #
68
- # @return [Symbol, :alias]
69
- required :type, const: :alias
70
-
71
- # @!method initialize(alias_:, text:, type: :alias)
72
- # Some parameter documentations has been truncated, see
73
- # {Telnyx::Models::PronunciationDictUpdateParams::Item::Alias} for more details.
74
- #
75
- # An alias pronunciation item. When the `text` value is found in input, it is
76
- # replaced with the `alias` before speech synthesis.
77
- #
78
- # @param alias_ [String] The replacement text that will be spoken instead.
79
- #
80
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
81
- #
82
- # @param type [Symbol, :alias] The item type.
83
- end
84
-
85
- class Phoneme < Telnyx::Internal::Type::BaseModel
86
- # @!attribute alphabet
87
- # The phonetic alphabet used for the phoneme notation.
88
- #
89
- # @return [Symbol, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme::Alphabet]
90
- required :alphabet, enum: -> { Telnyx::PronunciationDictUpdateParams::Item::Phoneme::Alphabet }
91
-
92
- # @!attribute phoneme
93
- # The phoneme notation representing the desired pronunciation.
94
- #
95
- # @return [String]
96
- required :phoneme, String
97
-
98
- # @!attribute text
99
- # The text to match in the input. Case-insensitive matching is used during
100
- # synthesis.
101
- #
102
- # @return [String]
103
- required :text, String
104
-
105
- # @!attribute type
106
- # The item type.
107
- #
108
- # @return [Symbol, :phoneme]
109
- required :type, const: :phoneme
110
-
111
- # @!method initialize(alphabet:, phoneme:, text:, type: :phoneme)
112
- # Some parameter documentations has been truncated, see
113
- # {Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme} for more details.
114
- #
115
- # A phoneme pronunciation item. When the `text` value is found in input, it is
116
- # pronounced using the specified IPA phoneme notation.
117
- #
118
- # @param alphabet [Symbol, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme::Alphabet] The phonetic alphabet used for the phoneme notation.
119
- #
120
- # @param phoneme [String] The phoneme notation representing the desired pronunciation.
121
- #
122
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
123
- #
124
- # @param type [Symbol, :phoneme] The item type.
125
-
126
- # The phonetic alphabet used for the phoneme notation.
127
- #
128
- # @see Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme#alphabet
129
- module Alphabet
130
- extend Telnyx::Internal::Type::Enum
131
-
132
- IPA = :ipa
133
-
134
- # @!method self.values
135
- # @return [Array<Symbol>]
136
- end
137
- end
49
+ variant :phoneme, -> { Telnyx::PronunciationDictPhonemeItem }
138
50
 
139
51
  # @!method self.variants
140
- # @return [Array(Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme)]
52
+ # @return [Array(Telnyx::Models::PronunciationDictAliasItem, Telnyx::Models::PronunciationDictPhonemeItem)]
141
53
  end
142
54
  end
143
55
  end
@@ -7,201 +7,13 @@ module Telnyx
7
7
  # @!attribute data
8
8
  # A pronunciation dictionary record.
9
9
  #
10
- # @return [Telnyx::Models::PronunciationDictUpdateResponse::Data, nil]
11
- optional :data, -> { Telnyx::Models::PronunciationDictUpdateResponse::Data }
10
+ # @return [Telnyx::Models::PronunciationDictData, nil]
11
+ optional :data, -> { Telnyx::PronunciationDictData }
12
12
 
13
13
  # @!method initialize(data: nil)
14
14
  # Response containing a single pronunciation dictionary.
15
15
  #
16
- # @param data [Telnyx::Models::PronunciationDictUpdateResponse::Data] A pronunciation dictionary record.
17
-
18
- # @see Telnyx::Models::PronunciationDictUpdateResponse#data
19
- class Data < Telnyx::Internal::Type::BaseModel
20
- # @!attribute id
21
- # Unique identifier for the pronunciation dictionary.
22
- #
23
- # @return [String, nil]
24
- optional :id, String
25
-
26
- # @!attribute created_at
27
- # ISO 8601 timestamp with millisecond precision.
28
- #
29
- # @return [Time, nil]
30
- optional :created_at, Time
31
-
32
- # @!attribute items
33
- # List of pronunciation items (alias or phoneme type).
34
- #
35
- # @return [Array<Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme>, nil]
36
- optional :items,
37
- -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Models::PronunciationDictUpdateResponse::Data::Item] }
38
-
39
- # @!attribute name
40
- # Human-readable name for the dictionary. Must be unique within the organization.
41
- #
42
- # @return [String, nil]
43
- optional :name, String
44
-
45
- # @!attribute record_type
46
- # Identifies the resource type.
47
- #
48
- # @return [Symbol, Telnyx::Models::PronunciationDictUpdateResponse::Data::RecordType, nil]
49
- optional :record_type, enum: -> { Telnyx::Models::PronunciationDictUpdateResponse::Data::RecordType }
50
-
51
- # @!attribute updated_at
52
- # ISO 8601 timestamp with millisecond precision.
53
- #
54
- # @return [Time, nil]
55
- optional :updated_at, Time
56
-
57
- # @!attribute version
58
- # Auto-incrementing version number. Increases by 1 on each update. Used for
59
- # optimistic concurrency control and cache invalidation.
60
- #
61
- # @return [Integer, nil]
62
- optional :version, Integer
63
-
64
- # @!method initialize(id: nil, created_at: nil, items: nil, name: nil, record_type: nil, updated_at: nil, version: nil)
65
- # Some parameter documentations has been truncated, see
66
- # {Telnyx::Models::PronunciationDictUpdateResponse::Data} for more details.
67
- #
68
- # A pronunciation dictionary record.
69
- #
70
- # @param id [String] Unique identifier for the pronunciation dictionary.
71
- #
72
- # @param created_at [Time] ISO 8601 timestamp with millisecond precision.
73
- #
74
- # @param items [Array<Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme>] List of pronunciation items (alias or phoneme type).
75
- #
76
- # @param name [String] Human-readable name for the dictionary. Must be unique within the organization.
77
- #
78
- # @param record_type [Symbol, Telnyx::Models::PronunciationDictUpdateResponse::Data::RecordType] Identifies the resource type.
79
- #
80
- # @param updated_at [Time] ISO 8601 timestamp with millisecond precision.
81
- #
82
- # @param version [Integer] Auto-incrementing version number. Increases by 1 on each update. Used for optimi
83
-
84
- # A single pronunciation dictionary item. Use type 'alias' to replace matched text
85
- # with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA
86
- # notation.
87
- module Item
88
- extend Telnyx::Internal::Type::Union
89
-
90
- discriminator :type
91
-
92
- # An alias pronunciation item. When the `text` value is found in input, it is replaced with the `alias` before speech synthesis.
93
- variant :alias, -> { Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Alias }
94
-
95
- # A phoneme pronunciation item. When the `text` value is found in input, it is pronounced using the specified IPA phoneme notation.
96
- variant :phoneme, -> { Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme }
97
-
98
- class Alias < Telnyx::Internal::Type::BaseModel
99
- # @!attribute alias_
100
- # The replacement text that will be spoken instead.
101
- #
102
- # @return [String]
103
- required :alias_, String, api_name: :alias
104
-
105
- # @!attribute text
106
- # The text to match in the input. Case-insensitive matching is used during
107
- # synthesis.
108
- #
109
- # @return [String]
110
- required :text, String
111
-
112
- # @!attribute type
113
- # The item type.
114
- #
115
- # @return [Symbol, :alias]
116
- required :type, const: :alias
117
-
118
- # @!method initialize(alias_:, text:, type: :alias)
119
- # Some parameter documentations has been truncated, see
120
- # {Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Alias} for more
121
- # details.
122
- #
123
- # An alias pronunciation item. When the `text` value is found in input, it is
124
- # replaced with the `alias` before speech synthesis.
125
- #
126
- # @param alias_ [String] The replacement text that will be spoken instead.
127
- #
128
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
129
- #
130
- # @param type [Symbol, :alias] The item type.
131
- end
132
-
133
- class Phoneme < Telnyx::Internal::Type::BaseModel
134
- # @!attribute alphabet
135
- # The phonetic alphabet used for the phoneme notation.
136
- #
137
- # @return [Symbol, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme::Alphabet]
138
- required :alphabet,
139
- enum: -> { Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme::Alphabet }
140
-
141
- # @!attribute phoneme
142
- # The phoneme notation representing the desired pronunciation.
143
- #
144
- # @return [String]
145
- required :phoneme, String
146
-
147
- # @!attribute text
148
- # The text to match in the input. Case-insensitive matching is used during
149
- # synthesis.
150
- #
151
- # @return [String]
152
- required :text, String
153
-
154
- # @!attribute type
155
- # The item type.
156
- #
157
- # @return [Symbol, :phoneme]
158
- required :type, const: :phoneme
159
-
160
- # @!method initialize(alphabet:, phoneme:, text:, type: :phoneme)
161
- # Some parameter documentations has been truncated, see
162
- # {Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme} for more
163
- # details.
164
- #
165
- # A phoneme pronunciation item. When the `text` value is found in input, it is
166
- # pronounced using the specified IPA phoneme notation.
167
- #
168
- # @param alphabet [Symbol, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme::Alphabet] The phonetic alphabet used for the phoneme notation.
169
- #
170
- # @param phoneme [String] The phoneme notation representing the desired pronunciation.
171
- #
172
- # @param text [String] The text to match in the input. Case-insensitive matching is used during synthes
173
- #
174
- # @param type [Symbol, :phoneme] The item type.
175
-
176
- # The phonetic alphabet used for the phoneme notation.
177
- #
178
- # @see Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme#alphabet
179
- module Alphabet
180
- extend Telnyx::Internal::Type::Enum
181
-
182
- IPA = :ipa
183
-
184
- # @!method self.values
185
- # @return [Array<Symbol>]
186
- end
187
- end
188
-
189
- # @!method self.variants
190
- # @return [Array(Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Alias, Telnyx::Models::PronunciationDictUpdateResponse::Data::Item::Phoneme)]
191
- end
192
-
193
- # Identifies the resource type.
194
- #
195
- # @see Telnyx::Models::PronunciationDictUpdateResponse::Data#record_type
196
- module RecordType
197
- extend Telnyx::Internal::Type::Enum
198
-
199
- PRONUNCIATION_DICT = :pronunciation_dict
200
-
201
- # @!method self.values
202
- # @return [Array<Symbol>]
203
- end
204
- end
16
+ # @param data [Telnyx::Models::PronunciationDictData] A pronunciation dictionary record.
205
17
  end
206
18
  end
207
19
  end