telnyx 5.75.0 → 5.77.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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/conversations/message_list_params.rb +18 -1
  5. data/lib/telnyx/models/ai/conversations/message_list_response.rb +91 -109
  6. data/lib/telnyx/models/call_dial_params.rb +6 -2
  7. data/lib/telnyx/models/calls/action_transfer_params.rb +6 -2
  8. data/lib/telnyx/models/sim_card_list_params.rb +1 -1
  9. data/lib/telnyx/models/traffic_policy_profile_list_params.rb +2 -2
  10. data/lib/telnyx/models/verify_profile.rb +9 -3
  11. data/lib/telnyx/models/verify_profile_create_params.rb +15 -5
  12. data/lib/telnyx/models/verify_profile_update_params.rb +15 -5
  13. data/lib/telnyx/resources/ai/conversations/messages.rb +12 -3
  14. data/lib/telnyx/version.rb +1 -1
  15. data/rbi/telnyx/models/ai/conversations/message_list_params.rbi +26 -1
  16. data/rbi/telnyx/models/ai/conversations/message_list_response.rbi +176 -231
  17. data/rbi/telnyx/models/call_dial_params.rbi +9 -3
  18. data/rbi/telnyx/models/calls/action_transfer_params.rbi +9 -3
  19. data/rbi/telnyx/models/sim_card_list_params.rbi +1 -1
  20. data/rbi/telnyx/models/traffic_policy_profile_list_params.rbi +2 -2
  21. data/rbi/telnyx/models/verify_profile.rbi +18 -6
  22. data/rbi/telnyx/models/verify_profile_create_params.rbi +30 -10
  23. data/rbi/telnyx/models/verify_profile_update_params.rbi +30 -10
  24. data/rbi/telnyx/resources/ai/conversations/messages.rbi +15 -2
  25. data/rbi/telnyx/resources/calls/actions.rbi +3 -1
  26. data/rbi/telnyx/resources/calls.rbi +3 -1
  27. data/sig/telnyx/models/ai/conversations/message_list_params.rbs +13 -1
  28. data/sig/telnyx/models/ai/conversations/message_list_response.rbs +67 -89
  29. data/sig/telnyx/models/sim_card_list_params.rbs +1 -1
  30. data/sig/telnyx/models/traffic_policy_profile_list_params.rbs +2 -2
  31. data/sig/telnyx/resources/ai/conversations/messages.rbs +3 -1
  32. metadata +2 -2
@@ -13,328 +13,273 @@ module Telnyx
13
13
  )
14
14
  end
15
15
 
16
+ # The role of the message sender.
16
17
  sig do
17
18
  returns(
18
- T::Array[
19
- Telnyx::Models::AI::Conversations::MessageListResponse::Data
20
- ]
19
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol
21
20
  )
22
21
  end
23
- attr_accessor :data
22
+ attr_accessor :role
24
23
 
25
- sig { returns(Telnyx::AI::Assistants::Tests::TestSuites::Meta) }
26
- attr_reader :meta
24
+ # The message content. Can be null for tool calls.
25
+ sig { returns(String) }
26
+ attr_accessor :text
27
+
28
+ # The datetime the message was created on the conversation. This does not
29
+ # necesarily correspond to the time the message was sent. The best field to use to
30
+ # determine the time the end user experienced the message is `sent_at`.
31
+ sig { returns(T.nilable(Time)) }
32
+ attr_reader :created_at
33
+
34
+ sig { params(created_at: Time).void }
35
+ attr_writer :created_at
36
+
37
+ # The datetime the message was sent to the end user.
38
+ sig { returns(T.nilable(Time)) }
39
+ attr_reader :sent_at
40
+
41
+ sig { params(sent_at: Time).void }
42
+ attr_writer :sent_at
43
+
44
+ # Optional tool calls made by the assistant.
45
+ sig do
46
+ returns(
47
+ T.nilable(
48
+ T::Array[
49
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall
50
+ ]
51
+ )
52
+ )
53
+ end
54
+ attr_reader :tool_calls
27
55
 
28
56
  sig do
29
57
  params(
30
- meta: Telnyx::AI::Assistants::Tests::TestSuites::Meta::OrHash
58
+ tool_calls:
59
+ T::Array[
60
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::OrHash
61
+ ]
31
62
  ).void
32
63
  end
33
- attr_writer :meta
64
+ attr_writer :tool_calls
34
65
 
35
66
  sig do
36
67
  params(
37
- data:
68
+ role:
69
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::OrSymbol,
70
+ text: String,
71
+ created_at: Time,
72
+ sent_at: Time,
73
+ tool_calls:
38
74
  T::Array[
39
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::OrHash
40
- ],
41
- meta: Telnyx::AI::Assistants::Tests::TestSuites::Meta::OrHash
75
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::OrHash
76
+ ]
42
77
  ).returns(T.attached_class)
43
78
  end
44
- def self.new(data:, meta:)
79
+ def self.new(
80
+ # The role of the message sender.
81
+ role:,
82
+ # The message content. Can be null for tool calls.
83
+ text:,
84
+ # The datetime the message was created on the conversation. This does not
85
+ # necesarily correspond to the time the message was sent. The best field to use to
86
+ # determine the time the end user experienced the message is `sent_at`.
87
+ created_at: nil,
88
+ # The datetime the message was sent to the end user.
89
+ sent_at: nil,
90
+ # Optional tool calls made by the assistant.
91
+ tool_calls: nil
92
+ )
45
93
  end
46
94
 
47
95
  sig do
48
96
  override.returns(
49
97
  {
50
- data:
98
+ role:
99
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol,
100
+ text: String,
101
+ created_at: Time,
102
+ sent_at: Time,
103
+ tool_calls:
51
104
  T::Array[
52
- Telnyx::Models::AI::Conversations::MessageListResponse::Data
53
- ],
54
- meta: Telnyx::AI::Assistants::Tests::TestSuites::Meta
105
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall
106
+ ]
55
107
  }
56
108
  )
57
109
  end
58
110
  def to_hash
59
111
  end
60
112
 
61
- class Data < Telnyx::Internal::Type::BaseModel
62
- OrHash =
113
+ # The role of the message sender.
114
+ module Role
115
+ extend Telnyx::Internal::Type::Enum
116
+
117
+ TaggedSymbol =
63
118
  T.type_alias do
64
- T.any(
65
- Telnyx::Models::AI::Conversations::MessageListResponse::Data,
66
- Telnyx::Internal::AnyHash
119
+ T.all(
120
+ Symbol,
121
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role
67
122
  )
68
123
  end
124
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
125
+
126
+ USER =
127
+ T.let(
128
+ :user,
129
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol
130
+ )
131
+ ASSISTANT =
132
+ T.let(
133
+ :assistant,
134
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol
135
+ )
136
+ TOOL =
137
+ T.let(
138
+ :tool,
139
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol
140
+ )
69
141
 
70
- # The role of the message sender.
71
142
  sig do
72
- returns(
73
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol
143
+ override.returns(
144
+ T::Array[
145
+ Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol
146
+ ]
74
147
  )
75
148
  end
76
- attr_accessor :role
77
-
78
- # The message content. Can be null for tool calls.
79
- sig { returns(String) }
80
- attr_accessor :text
81
-
82
- # The datetime the message was created on the conversation. This does not
83
- # necesarily correspond to the time the message was sent. The best field to use to
84
- # determine the time the end user experienced the message is `sent_at`.
85
- sig { returns(T.nilable(Time)) }
86
- attr_reader :created_at
87
-
88
- sig { params(created_at: Time).void }
89
- attr_writer :created_at
149
+ def self.values
150
+ end
151
+ end
90
152
 
91
- # The datetime the message was sent to the end user.
92
- sig { returns(T.nilable(Time)) }
93
- attr_reader :sent_at
153
+ class ToolCall < Telnyx::Internal::Type::BaseModel
154
+ OrHash =
155
+ T.type_alias do
156
+ T.any(
157
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall,
158
+ Telnyx::Internal::AnyHash
159
+ )
160
+ end
94
161
 
95
- sig { params(sent_at: Time).void }
96
- attr_writer :sent_at
162
+ # Unique identifier for the tool call.
163
+ sig { returns(String) }
164
+ attr_accessor :id
97
165
 
98
- # Optional tool calls made by the assistant.
99
166
  sig do
100
167
  returns(
101
- T.nilable(
102
- T::Array[
103
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall
104
- ]
105
- )
168
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Function
106
169
  )
107
170
  end
108
- attr_reader :tool_calls
171
+ attr_reader :function
109
172
 
110
173
  sig do
111
174
  params(
112
- tool_calls:
113
- T::Array[
114
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::OrHash
115
- ]
175
+ function:
176
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Function::OrHash
116
177
  ).void
117
178
  end
118
- attr_writer :tool_calls
179
+ attr_writer :function
180
+
181
+ # Type of the tool call.
182
+ sig do
183
+ returns(
184
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type::TaggedSymbol
185
+ )
186
+ end
187
+ attr_accessor :type
119
188
 
120
189
  sig do
121
190
  params(
122
- role:
123
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::OrSymbol,
124
- text: String,
125
- created_at: Time,
126
- sent_at: Time,
127
- tool_calls:
128
- T::Array[
129
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::OrHash
130
- ]
191
+ id: String,
192
+ function:
193
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Function::OrHash,
194
+ type:
195
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type::OrSymbol
131
196
  ).returns(T.attached_class)
132
197
  end
133
198
  def self.new(
134
- # The role of the message sender.
135
- role:,
136
- # The message content. Can be null for tool calls.
137
- text:,
138
- # The datetime the message was created on the conversation. This does not
139
- # necesarily correspond to the time the message was sent. The best field to use to
140
- # determine the time the end user experienced the message is `sent_at`.
141
- created_at: nil,
142
- # The datetime the message was sent to the end user.
143
- sent_at: nil,
144
- # Optional tool calls made by the assistant.
145
- tool_calls: nil
199
+ # Unique identifier for the tool call.
200
+ id:,
201
+ function:,
202
+ # Type of the tool call.
203
+ type:
146
204
  )
147
205
  end
148
206
 
149
207
  sig do
150
208
  override.returns(
151
209
  {
152
- role:
153
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol,
154
- text: String,
155
- created_at: Time,
156
- sent_at: Time,
157
- tool_calls:
158
- T::Array[
159
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall
160
- ]
210
+ id: String,
211
+ function:
212
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Function,
213
+ type:
214
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type::TaggedSymbol
161
215
  }
162
216
  )
163
217
  end
164
218
  def to_hash
165
219
  end
166
220
 
167
- # The role of the message sender.
168
- module Role
169
- extend Telnyx::Internal::Type::Enum
170
-
171
- TaggedSymbol =
172
- T.type_alias do
173
- T.all(
174
- Symbol,
175
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role
176
- )
177
- end
178
- OrSymbol = T.type_alias { T.any(Symbol, String) }
179
-
180
- USER =
181
- T.let(
182
- :user,
183
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol
184
- )
185
- ASSISTANT =
186
- T.let(
187
- :assistant,
188
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol
189
- )
190
- TOOL =
191
- T.let(
192
- :tool,
193
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol
194
- )
195
-
196
- sig do
197
- override.returns(
198
- T::Array[
199
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::Role::TaggedSymbol
200
- ]
201
- )
202
- end
203
- def self.values
204
- end
205
- end
206
-
207
- class ToolCall < Telnyx::Internal::Type::BaseModel
221
+ class Function < Telnyx::Internal::Type::BaseModel
208
222
  OrHash =
209
223
  T.type_alias do
210
224
  T.any(
211
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall,
225
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Function,
212
226
  Telnyx::Internal::AnyHash
213
227
  )
214
228
  end
215
229
 
216
- # Unique identifier for the tool call.
230
+ # JSON-formatted arguments to pass to the function.
217
231
  sig { returns(String) }
218
- attr_accessor :id
219
-
220
- sig do
221
- returns(
222
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Function
223
- )
224
- end
225
- attr_reader :function
232
+ attr_accessor :arguments
226
233
 
227
- sig do
228
- params(
229
- function:
230
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Function::OrHash
231
- ).void
232
- end
233
- attr_writer :function
234
+ # Name of the function to call.
235
+ sig { returns(String) }
236
+ attr_accessor :name
234
237
 
235
- # Type of the tool call.
236
238
  sig do
237
- returns(
238
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type::TaggedSymbol
239
+ params(arguments: String, name: String).returns(
240
+ T.attached_class
239
241
  )
240
242
  end
241
- attr_accessor :type
242
-
243
- sig do
244
- params(
245
- id: String,
246
- function:
247
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Function::OrHash,
248
- type:
249
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type::OrSymbol
250
- ).returns(T.attached_class)
251
- end
252
243
  def self.new(
253
- # Unique identifier for the tool call.
254
- id:,
255
- function:,
256
- # Type of the tool call.
257
- type:
244
+ # JSON-formatted arguments to pass to the function.
245
+ arguments:,
246
+ # Name of the function to call.
247
+ name:
258
248
  )
259
249
  end
260
250
 
261
- sig do
262
- override.returns(
263
- {
264
- id: String,
265
- function:
266
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Function,
267
- type:
268
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type::TaggedSymbol
269
- }
270
- )
271
- end
251
+ sig { override.returns({ arguments: String, name: String }) }
272
252
  def to_hash
273
253
  end
254
+ end
274
255
 
275
- class Function < Telnyx::Internal::Type::BaseModel
276
- OrHash =
277
- T.type_alias do
278
- T.any(
279
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Function,
280
- Telnyx::Internal::AnyHash
281
- )
282
- end
283
-
284
- # JSON-formatted arguments to pass to the function.
285
- sig { returns(String) }
286
- attr_accessor :arguments
287
-
288
- # Name of the function to call.
289
- sig { returns(String) }
290
- attr_accessor :name
256
+ # Type of the tool call.
257
+ module Type
258
+ extend Telnyx::Internal::Type::Enum
291
259
 
292
- sig do
293
- params(arguments: String, name: String).returns(
294
- T.attached_class
260
+ TaggedSymbol =
261
+ T.type_alias do
262
+ T.all(
263
+ Symbol,
264
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type
295
265
  )
296
266
  end
297
- def self.new(
298
- # JSON-formatted arguments to pass to the function.
299
- arguments:,
300
- # Name of the function to call.
301
- name:
267
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
268
+
269
+ FUNCTION =
270
+ T.let(
271
+ :function,
272
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type::TaggedSymbol
302
273
  )
303
- end
304
274
 
305
- sig { override.returns({ arguments: String, name: String }) }
306
- def to_hash
307
- end
275
+ sig do
276
+ override.returns(
277
+ T::Array[
278
+ Telnyx::Models::AI::Conversations::MessageListResponse::ToolCall::Type::TaggedSymbol
279
+ ]
280
+ )
308
281
  end
309
-
310
- # Type of the tool call.
311
- module Type
312
- extend Telnyx::Internal::Type::Enum
313
-
314
- TaggedSymbol =
315
- T.type_alias do
316
- T.all(
317
- Symbol,
318
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type
319
- )
320
- end
321
- OrSymbol = T.type_alias { T.any(Symbol, String) }
322
-
323
- FUNCTION =
324
- T.let(
325
- :function,
326
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type::TaggedSymbol
327
- )
328
-
329
- sig do
330
- override.returns(
331
- T::Array[
332
- Telnyx::Models::AI::Conversations::MessageListResponse::Data::ToolCall::Type::TaggedSymbol
333
- ]
334
- )
335
- end
336
- def self.values
337
- end
282
+ def self.values
338
283
  end
339
284
  end
340
285
  end
@@ -59,7 +59,9 @@ module Telnyx
59
59
  attr_writer :answering_machine_detection
60
60
 
61
61
  # Optional configuration parameters to modify 'answering_machine_detection'
62
- # performance.
62
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
63
+ # parameters are applicable when `premium` is selected as
64
+ # answering_machine_detection.
63
65
  sig do
64
66
  returns(
65
67
  T.nilable(Telnyx::CallDialParams::AnsweringMachineDetectionConfig)
@@ -730,7 +732,9 @@ module Telnyx
730
732
  # receive `call.machine.greeting.ended` if a beep is detected.
731
733
  answering_machine_detection: nil,
732
734
  # Optional configuration parameters to modify 'answering_machine_detection'
733
- # performance.
735
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
736
+ # parameters are applicable when `premium` is selected as
737
+ # answering_machine_detection.
734
738
  answering_machine_detection_config: nil,
735
739
  # AI Assistant configuration. All fields except `id` are optional — the
736
740
  # assistant's stored configuration will be used as fallback for any omitted
@@ -1155,7 +1159,9 @@ module Telnyx
1155
1159
  attr_writer :total_analysis_time_millis
1156
1160
 
1157
1161
  # Optional configuration parameters to modify 'answering_machine_detection'
1158
- # performance.
1162
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
1163
+ # parameters are applicable when `premium` is selected as
1164
+ # answering_machine_detection.
1159
1165
  sig do
1160
1166
  params(
1161
1167
  after_greeting_silence_millis: Integer,
@@ -47,7 +47,9 @@ module Telnyx
47
47
  attr_writer :answering_machine_detection
48
48
 
49
49
  # Optional configuration parameters to modify 'answering_machine_detection'
50
- # performance.
50
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
51
+ # parameters are applicable when `premium` is selected as
52
+ # answering_machine_detection.
51
53
  sig do
52
54
  returns(
53
55
  T.nilable(
@@ -568,7 +570,9 @@ module Telnyx
568
570
  # receive 'call.machine.greeting.ended' if a beep is detected.
569
571
  answering_machine_detection: nil,
570
572
  # Optional configuration parameters to modify 'answering_machine_detection'
571
- # performance.
573
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
574
+ # parameters are applicable when `premium` is selected as
575
+ # answering_machine_detection.
572
576
  answering_machine_detection_config: nil,
573
577
  # The URL of a file to be played back when the transfer destination answers before
574
578
  # bridging the call. The URL can point to either a WAV or MP3 file. media_name and
@@ -901,7 +905,9 @@ module Telnyx
901
905
  attr_writer :total_analysis_time_millis
902
906
 
903
907
  # Optional configuration parameters to modify 'answering_machine_detection'
904
- # performance.
908
+ # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
909
+ # parameters are applicable when `premium` is selected as
910
+ # answering_machine_detection.
905
911
  sig do
906
912
  params(
907
913
  after_greeting_silence_millis: Integer,
@@ -254,7 +254,7 @@ module Telnyx
254
254
  :"current_billing_period_consumed_data.amount",
255
255
  Telnyx::SimCardListParams::Sort::TaggedSymbol
256
256
  )
257
- MINUS_CURRENT_BILLING_PERIOD_CONSUMED_DATA_AMOUNT =
257
+ DESC_CURRENT_BILLING_PERIOD_CONSUMED_DATA_AMOUNT =
258
258
  T.let(
259
259
  :"-current_billing_period_consumed_data.amount",
260
260
  Telnyx::SimCardListParams::Sort::TaggedSymbol
@@ -165,7 +165,7 @@ module Telnyx
165
165
  :service,
166
166
  Telnyx::TrafficPolicyProfileListParams::Sort::TaggedSymbol
167
167
  )
168
- MINUS_SERVICE =
168
+ DESC_SERVICE =
169
169
  T.let(
170
170
  :"-service",
171
171
  Telnyx::TrafficPolicyProfileListParams::Sort::TaggedSymbol
@@ -175,7 +175,7 @@ module Telnyx
175
175
  :type,
176
176
  Telnyx::TrafficPolicyProfileListParams::Sort::TaggedSymbol
177
177
  )
178
- MINUS_TYPE =
178
+ DESC_TYPE =
179
179
  T.let(
180
180
  :"-type",
181
181
  Telnyx::TrafficPolicyProfileListParams::Sort::TaggedSymbol
@@ -177,7 +177,9 @@ module Telnyx
177
177
 
178
178
  # Enabled country destinations to send verification codes. The elements in the
179
179
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
180
- # destinations will be allowed.
180
+ # destinations will be allowed. **Conditionally required:** this field must be
181
+ # provided when your organization is configured to require explicit whitelisted
182
+ # destinations; otherwise it is optional.
181
183
  sig { returns(T.nilable(T::Array[String])) }
182
184
  attr_reader :whitelisted_destinations
183
185
 
@@ -208,7 +210,9 @@ module Telnyx
208
210
  messaging_template_id: nil,
209
211
  # Enabled country destinations to send verification codes. The elements in the
210
212
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
211
- # destinations will be allowed.
213
+ # destinations will be allowed. **Conditionally required:** this field must be
214
+ # provided when your organization is configured to require explicit whitelisted
215
+ # destinations; otherwise it is optional.
212
216
  whitelisted_destinations: nil
213
217
  )
214
218
  end
@@ -326,7 +330,9 @@ module Telnyx
326
330
 
327
331
  # Enabled country destinations to send verification codes. The elements in the
328
332
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
329
- # destinations will be allowed.
333
+ # destinations will be allowed. **Conditionally required:** this field must be
334
+ # provided when your organization is configured to require explicit whitelisted
335
+ # destinations; otherwise it is optional.
330
336
  sig { returns(T.nilable(T::Array[String])) }
331
337
  attr_reader :whitelisted_destinations
332
338
 
@@ -360,7 +366,9 @@ module Telnyx
360
366
  sms_fallback: nil,
361
367
  # Enabled country destinations to send verification codes. The elements in the
362
368
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
363
- # destinations will be allowed.
369
+ # destinations will be allowed. **Conditionally required:** this field must be
370
+ # provided when your organization is configured to require explicit whitelisted
371
+ # destinations; otherwise it is optional.
364
372
  whitelisted_destinations: nil
365
373
  )
366
374
  end
@@ -449,7 +457,9 @@ module Telnyx
449
457
 
450
458
  # Enabled country destinations to send verification codes. The elements in the
451
459
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
452
- # destinations will be allowed.
460
+ # destinations will be allowed. **Conditionally required:** this field must be
461
+ # provided when your organization is configured to require explicit whitelisted
462
+ # destinations; otherwise it is optional.
453
463
  sig { returns(T.nilable(T::Array[String])) }
454
464
  attr_reader :whitelisted_destinations
455
465
 
@@ -484,7 +494,9 @@ module Telnyx
484
494
  messaging_template_id: nil,
485
495
  # Enabled country destinations to send verification codes. The elements in the
486
496
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
487
- # destinations will be allowed.
497
+ # destinations will be allowed. **Conditionally required:** this field must be
498
+ # provided when your organization is configured to require explicit whitelisted
499
+ # destinations; otherwise it is optional.
488
500
  whitelisted_destinations: nil
489
501
  )
490
502
  end