telnyx 5.88.0 → 5.90.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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +12 -12
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +12 -12
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +12 -12
  7. data/lib/telnyx/models/ai/inference_embedding.rb +12 -12
  8. data/lib/telnyx/models/call_assistant_request.rb +12 -12
  9. data/lib/telnyx/models/message_send_whatsapp_params.rb +9 -1
  10. data/lib/telnyx/models/whatsapp/phone_numbers/profile_update_params.rb +17 -1
  11. data/lib/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rb +8 -1
  12. data/lib/telnyx/resources/messages.rb +3 -1
  13. data/lib/telnyx/resources/whatsapp/phone_numbers/profile.rb +3 -1
  14. data/lib/telnyx/version.rb +1 -1
  15. data/rbi/telnyx/models/ai/assistant_create_params.rbi +20 -20
  16. data/rbi/telnyx/models/ai/assistant_update_params.rbi +20 -20
  17. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +20 -20
  18. data/rbi/telnyx/models/ai/inference_embedding.rbi +20 -20
  19. data/rbi/telnyx/models/call_assistant_request.rbi +20 -20
  20. data/rbi/telnyx/models/message_send_whatsapp_params.rbi +11 -0
  21. data/rbi/telnyx/models/whatsapp/phone_numbers/profile_update_params.rbi +11 -0
  22. data/rbi/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rbi +9 -0
  23. data/rbi/telnyx/resources/messages.rbi +3 -0
  24. data/rbi/telnyx/resources/whatsapp/phone_numbers/profile.rbi +3 -0
  25. data/sig/telnyx/models/message_send_whatsapp_params.rbs +7 -0
  26. data/sig/telnyx/models/whatsapp/phone_numbers/profile_update_params.rbs +7 -0
  27. data/sig/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rbs +7 -0
  28. data/sig/telnyx/resources/messages.rbs +1 -0
  29. data/sig/telnyx/resources/whatsapp/phone_numbers/profile.rbs +1 -0
  30. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b8aa2bce90cfd6f5d0bf6a8c94ac119be05760fc219960f369d5b7f928530a69
4
- data.tar.gz: b9b7a489e52443c9362ae674bc482cdd0c62e54a16d2c209c1b1ef2aa08efc17
3
+ metadata.gz: c7831db6252f7443f94b6b2b33387b62f3cd05bdd417fea3d01d10123e6243b5
4
+ data.tar.gz: c2731964c66d934121a13a9c026fcd9ffd49ba747a9c449c58116f27ccd37e9f
5
5
  SHA512:
6
- metadata.gz: b4e19f28a9b7795a1e5c1755af50a6607fc89575ec58aa1b8d5e50b37af7c143cb541f336413361b87005adbd1201e38a67f105f2dcd592405f32367987d6cc1
7
- data.tar.gz: a3f92c589ffcaae6209038921fabee803070633e37b219f135322467612af448ed2bcbae5daa8397c2b5aed8fad20432441b59589dfc4f6a0a387f546e1593b5
6
+ metadata.gz: da94381863d975125a701a4c15d2e7a40d0c782302c33f85e6694a69d3cd38a1cf247115dc66c646645c03609eee2cccedd16a02f3adb693487862b41ece3ac7
7
+ data.tar.gz: 3faf331ff5ff89c4f4b75b78c131aeee6b546916674d63364b7811e49e0611527d8ad532ec7af77407a3c144559f84885fbdd47ac7e4275439846127f496d1c7
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.90.0 (2026-04-28)
4
+
5
+ Full Changelog: [v5.89.0...v5.90.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.89.0...v5.90.0)
6
+
7
+ ### Features
8
+
9
+ * ENGDESK-51445: added profile ID fields to Whatsapp messages ([d29a4f1](https://github.com/team-telnyx/telnyx-ruby/commit/d29a4f1063b8c4db96c46a1215a7f3cb5d4e1aab))
10
+
11
+ ## 5.89.0 (2026-04-28)
12
+
13
+ Full Changelog: [v5.88.0...v5.89.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.88.0...v5.89.0)
14
+
15
+ ### Features
16
+
17
+ * Correct external LLM forwarded metadata docs ([c9b69a1](https://github.com/team-telnyx/telnyx-ruby/commit/c9b69a1078a5c7c21caa37286c967692081c8aa8))
18
+
3
19
  ## 5.88.0 (2026-04-28)
4
20
 
5
21
  Full Changelog: [v5.87.0...v5.88.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.87.0...v5.88.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.88.0"
27
+ gem "telnyx", "~> 5.90.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -226,11 +226,11 @@ module Telnyx
226
226
  optional :certificate_ref, String
227
227
 
228
228
  # @!attribute forward_metadata
229
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
230
- # external LLM endpoint. Defaults to false. The external endpoint receives the
231
- # standard chat completions payload with top-level `metadata` and
232
- # `dynamic_variables` objects when values are available. For example:
233
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
229
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
230
+ # LLM endpoint. Defaults to false. The chat completion request includes a
231
+ # top-level `extra_metadata` object when dynamic variables are available. For
232
+ # example:
233
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
234
234
  #
235
235
  # @return [Boolean, nil]
236
236
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -259,7 +259,7 @@ module Telnyx
259
259
  #
260
260
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
261
261
  #
262
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
262
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
263
263
  #
264
264
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
265
265
  #
@@ -337,11 +337,11 @@ module Telnyx
337
337
  optional :certificate_ref, String
338
338
 
339
339
  # @!attribute forward_metadata
340
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
341
- # external LLM endpoint. Defaults to false. The external endpoint receives the
342
- # standard chat completions payload with top-level `metadata` and
343
- # `dynamic_variables` objects when values are available. For example:
344
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
340
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
341
+ # LLM endpoint. Defaults to false. The chat completion request includes a
342
+ # top-level `extra_metadata` object when dynamic variables are available. For
343
+ # example:
344
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
345
345
  #
346
346
  # @return [Boolean, nil]
347
347
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -371,7 +371,7 @@ module Telnyx
371
371
  #
372
372
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
373
373
  #
374
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
374
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
375
375
  #
376
376
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
377
377
  #
@@ -242,11 +242,11 @@ module Telnyx
242
242
  optional :certificate_ref, String
243
243
 
244
244
  # @!attribute forward_metadata
245
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
246
- # external LLM endpoint. Defaults to false. The external endpoint receives the
247
- # standard chat completions payload with top-level `metadata` and
248
- # `dynamic_variables` objects when values are available. For example:
249
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
245
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
246
+ # LLM endpoint. Defaults to false. The chat completion request includes a
247
+ # top-level `extra_metadata` object when dynamic variables are available. For
248
+ # example:
249
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
250
250
  #
251
251
  # @return [Boolean, nil]
252
252
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -275,7 +275,7 @@ module Telnyx
275
275
  #
276
276
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
277
277
  #
278
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
278
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
279
279
  #
280
280
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
281
281
  #
@@ -353,11 +353,11 @@ module Telnyx
353
353
  optional :certificate_ref, String
354
354
 
355
355
  # @!attribute forward_metadata
356
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
357
- # external LLM endpoint. Defaults to false. The external endpoint receives the
358
- # standard chat completions payload with top-level `metadata` and
359
- # `dynamic_variables` objects when values are available. For example:
360
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
356
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
357
+ # LLM endpoint. Defaults to false. The chat completion request includes a
358
+ # top-level `extra_metadata` object when dynamic variables are available. For
359
+ # example:
360
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
361
361
  #
362
362
  # @return [Boolean, nil]
363
363
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -387,7 +387,7 @@ module Telnyx
387
387
  #
388
388
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
389
389
  #
390
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
390
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
391
391
  #
392
392
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
393
393
  #
@@ -223,11 +223,11 @@ module Telnyx
223
223
  optional :certificate_ref, String
224
224
 
225
225
  # @!attribute forward_metadata
226
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
227
- # external LLM endpoint. Defaults to false. The external endpoint receives the
228
- # standard chat completions payload with top-level `metadata` and
229
- # `dynamic_variables` objects when values are available. For example:
230
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
226
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
227
+ # LLM endpoint. Defaults to false. The chat completion request includes a
228
+ # top-level `extra_metadata` object when dynamic variables are available. For
229
+ # example:
230
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
231
231
  #
232
232
  # @return [Boolean, nil]
233
233
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -256,7 +256,7 @@ module Telnyx
256
256
  #
257
257
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
258
258
  #
259
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
259
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
260
260
  #
261
261
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
262
262
  #
@@ -336,11 +336,11 @@ module Telnyx
336
336
  optional :certificate_ref, String
337
337
 
338
338
  # @!attribute forward_metadata
339
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
340
- # external LLM endpoint. Defaults to false. The external endpoint receives the
341
- # standard chat completions payload with top-level `metadata` and
342
- # `dynamic_variables` objects when values are available. For example:
343
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
339
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
340
+ # LLM endpoint. Defaults to false. The chat completion request includes a
341
+ # top-level `extra_metadata` object when dynamic variables are available. For
342
+ # example:
343
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
344
344
  #
345
345
  # @return [Boolean, nil]
346
346
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -370,7 +370,7 @@ module Telnyx
370
370
  #
371
371
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
372
372
  #
373
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
373
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
374
374
  #
375
375
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
376
376
  #
@@ -236,11 +236,11 @@ module Telnyx
236
236
  optional :certificate_ref, String
237
237
 
238
238
  # @!attribute forward_metadata
239
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
240
- # external LLM endpoint. Defaults to false. The external endpoint receives the
241
- # standard chat completions payload with top-level `metadata` and
242
- # `dynamic_variables` objects when values are available. For example:
243
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
239
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
240
+ # LLM endpoint. Defaults to false. The chat completion request includes a
241
+ # top-level `extra_metadata` object when dynamic variables are available. For
242
+ # example:
243
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
244
244
  #
245
245
  # @return [Boolean, nil]
246
246
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -269,7 +269,7 @@ module Telnyx
269
269
  #
270
270
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
271
271
  #
272
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
272
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
273
273
  #
274
274
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
275
275
  #
@@ -348,11 +348,11 @@ module Telnyx
348
348
  optional :certificate_ref, String
349
349
 
350
350
  # @!attribute forward_metadata
351
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
352
- # external LLM endpoint. Defaults to false. The external endpoint receives the
353
- # standard chat completions payload with top-level `metadata` and
354
- # `dynamic_variables` objects when values are available. For example:
355
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
351
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
352
+ # LLM endpoint. Defaults to false. The chat completion request includes a
353
+ # top-level `extra_metadata` object when dynamic variables are available. For
354
+ # example:
355
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
356
356
  #
357
357
  # @return [Boolean, nil]
358
358
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -382,7 +382,7 @@ module Telnyx
382
382
  #
383
383
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
384
384
  #
385
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
385
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
386
386
  #
387
387
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
388
388
  #
@@ -174,11 +174,11 @@ module Telnyx
174
174
  optional :certificate_ref, String
175
175
 
176
176
  # @!attribute forward_metadata
177
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
178
- # external LLM endpoint. Defaults to false. The external endpoint receives the
179
- # standard chat completions payload with top-level `metadata` and
180
- # `dynamic_variables` objects when values are available. For example:
181
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
177
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
178
+ # LLM endpoint. Defaults to false. The chat completion request includes a
179
+ # top-level `extra_metadata` object when dynamic variables are available. For
180
+ # example:
181
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
182
182
  #
183
183
  # @return [Boolean, nil]
184
184
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -213,7 +213,7 @@ module Telnyx
213
213
  #
214
214
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
215
215
  #
216
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
216
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
217
217
  #
218
218
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
219
219
  #
@@ -291,11 +291,11 @@ module Telnyx
291
291
  optional :certificate_ref, String
292
292
 
293
293
  # @!attribute forward_metadata
294
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
295
- # external LLM endpoint. Defaults to false. The external endpoint receives the
296
- # standard chat completions payload with top-level `metadata` and
297
- # `dynamic_variables` objects when values are available. For example:
298
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
294
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
295
+ # LLM endpoint. Defaults to false. The chat completion request includes a
296
+ # top-level `extra_metadata` object when dynamic variables are available. For
297
+ # example:
298
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
299
299
  #
300
300
  # @return [Boolean, nil]
301
301
  optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -331,7 +331,7 @@ module Telnyx
331
331
  #
332
332
  # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
333
333
  #
334
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
334
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
335
335
  #
336
336
  # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
337
337
  #
@@ -24,6 +24,12 @@ module Telnyx
24
24
  # @return [Telnyx::Models::WhatsappMessageContent]
25
25
  required :whatsapp_message, -> { Telnyx::WhatsappMessageContent }
26
26
 
27
+ # @!attribute messaging_profile_id
28
+ # Messaging profile ID - required if the 'from' number is not SMS-enabled
29
+ #
30
+ # @return [String, nil]
31
+ optional :messaging_profile_id, String
32
+
27
33
  # @!attribute type
28
34
  # Message type - must be set to "WHATSAPP"
29
35
  #
@@ -36,13 +42,15 @@ module Telnyx
36
42
  # @return [String, nil]
37
43
  optional :webhook_url, String
38
44
 
39
- # @!method initialize(from:, to:, whatsapp_message:, type: nil, webhook_url: nil, request_options: {})
45
+ # @!method initialize(from:, to:, whatsapp_message:, messaging_profile_id: nil, type: nil, webhook_url: nil, request_options: {})
40
46
  # @param from [String] Phone number in +E.164 format associated with Whatsapp account
41
47
  #
42
48
  # @param to [String] Phone number in +E.164 format
43
49
  #
44
50
  # @param whatsapp_message [Telnyx::Models::WhatsappMessageContent]
45
51
  #
52
+ # @param messaging_profile_id [String] Messaging profile ID - required if the 'from' number is not SMS-enabled
53
+ #
46
54
  # @param type [Symbol, Telnyx::Models::MessageSendWhatsappParams::Type] Message type - must be set to "WHATSAPP"
47
55
  #
48
56
  # @param webhook_url [String] The URL where webhooks related to this message will be sent.
@@ -44,20 +44,36 @@ module Telnyx
44
44
  # @return [String, nil]
45
45
  optional :email, String
46
46
 
47
+ # @!attribute profile_id
48
+ # Messaging profile ID for inbound messages
49
+ #
50
+ # @return [String, nil]
51
+ optional :profile_id, String
52
+
47
53
  # @!attribute website
48
54
  #
49
55
  # @return [String, nil]
50
56
  optional :website, String
51
57
 
52
- # @!method initialize(phone_number:, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, website: nil, request_options: {})
58
+ # @!method initialize(phone_number:, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, profile_id: nil, website: nil, request_options: {})
53
59
  # @param phone_number [String]
60
+ #
54
61
  # @param about [String]
62
+ #
55
63
  # @param address [String]
64
+ #
56
65
  # @param category [String]
66
+ #
57
67
  # @param description [String]
68
+ #
58
69
  # @param display_name [String]
70
+ #
59
71
  # @param email [String]
72
+ #
73
+ # @param profile_id [String] Messaging profile ID for inbound messages
74
+ #
60
75
  # @param website [String]
76
+ #
61
77
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
62
78
  end
63
79
  end
@@ -51,6 +51,11 @@ module Telnyx
51
51
  # @return [String, nil]
52
52
  optional :phone_number_id, String
53
53
 
54
+ # @!attribute profile_id
55
+ #
56
+ # @return [String, nil]
57
+ optional :profile_id, String
58
+
54
59
  # @!attribute profile_photo_url
55
60
  #
56
61
  # @return [String, nil]
@@ -71,7 +76,7 @@ module Telnyx
71
76
  # @return [String, nil]
72
77
  optional :website, String
73
78
 
74
- # @!method initialize(id: nil, about: nil, address: nil, category: nil, created_at: nil, description: nil, display_name: nil, email: nil, phone_number_id: nil, profile_photo_url: nil, record_type: nil, updated_at: nil, website: nil)
79
+ # @!method initialize(id: nil, about: nil, address: nil, category: nil, created_at: nil, description: nil, display_name: nil, email: nil, phone_number_id: nil, profile_id: nil, profile_photo_url: nil, record_type: nil, updated_at: nil, website: nil)
75
80
  # @param id [String]
76
81
  #
77
82
  # @param about [String]
@@ -90,6 +95,8 @@ module Telnyx
90
95
  #
91
96
  # @param phone_number_id [String] Whatsapp phone number ID
92
97
  #
98
+ # @param profile_id [String]
99
+ #
93
100
  # @param profile_photo_url [String]
94
101
  #
95
102
  # @param record_type [String]
@@ -353,7 +353,7 @@ module Telnyx
353
353
 
354
354
  # Send a Whatsapp message
355
355
  #
356
- # @overload send_whatsapp(from:, to:, whatsapp_message:, type: nil, webhook_url: nil, request_options: {})
356
+ # @overload send_whatsapp(from:, to:, whatsapp_message:, messaging_profile_id: nil, type: nil, webhook_url: nil, request_options: {})
357
357
  #
358
358
  # @param from [String] Phone number in +E.164 format associated with Whatsapp account
359
359
  #
@@ -361,6 +361,8 @@ module Telnyx
361
361
  #
362
362
  # @param whatsapp_message [Telnyx::Models::WhatsappMessageContent]
363
363
  #
364
+ # @param messaging_profile_id [String] Messaging profile ID - required if the 'from' number is not SMS-enabled
365
+ #
364
366
  # @param type [Symbol, Telnyx::Models::MessageSendWhatsappParams::Type] Message type - must be set to "WHATSAPP"
365
367
  #
366
368
  # @param webhook_url [String] The URL where webhooks related to this message will be sent.
@@ -32,7 +32,7 @@ module Telnyx
32
32
 
33
33
  # Update phone number business profile
34
34
  #
35
- # @overload update(phone_number, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, website: nil, request_options: {})
35
+ # @overload update(phone_number, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, profile_id: nil, website: nil, request_options: {})
36
36
  #
37
37
  # @param phone_number [String] Phone number (E.164 format)
38
38
  #
@@ -48,6 +48,8 @@ module Telnyx
48
48
  #
49
49
  # @param email [String]
50
50
  #
51
+ # @param profile_id [String] Messaging profile ID for inbound messages
52
+ #
51
53
  # @param website [String]
52
54
  #
53
55
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.88.0"
4
+ VERSION = "5.90.0"
5
5
  end
@@ -438,11 +438,11 @@ module Telnyx
438
438
  sig { params(certificate_ref: String).void }
439
439
  attr_writer :certificate_ref
440
440
 
441
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
442
- # external LLM endpoint. Defaults to false. The external endpoint receives the
443
- # standard chat completions payload with top-level `metadata` and
444
- # `dynamic_variables` objects when values are available. For example:
445
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
441
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
442
+ # LLM endpoint. Defaults to false. The chat completion request includes a
443
+ # top-level `extra_metadata` object when dynamic variables are available. For
444
+ # example:
445
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
446
446
  sig { returns(T.nilable(T::Boolean)) }
447
447
  attr_reader :forward_metadata
448
448
 
@@ -485,11 +485,11 @@ module Telnyx
485
485
  # Integration secret identifier for the client certificate used with certificate
486
486
  # authentication.
487
487
  certificate_ref: nil,
488
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
489
- # external LLM endpoint. Defaults to false. The external endpoint receives the
490
- # standard chat completions payload with top-level `metadata` and
491
- # `dynamic_variables` objects when values are available. For example:
492
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
488
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
489
+ # LLM endpoint. Defaults to false. The chat completion request includes a
490
+ # top-level `extra_metadata` object when dynamic variables are available. For
491
+ # example:
492
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
493
493
  forward_metadata: nil,
494
494
  # Integration secret identifier for the external LLM API key.
495
495
  llm_api_key_ref: nil,
@@ -666,11 +666,11 @@ module Telnyx
666
666
  sig { params(certificate_ref: String).void }
667
667
  attr_writer :certificate_ref
668
668
 
669
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
670
- # external LLM endpoint. Defaults to false. The external endpoint receives the
671
- # standard chat completions payload with top-level `metadata` and
672
- # `dynamic_variables` objects when values are available. For example:
673
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
669
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
670
+ # LLM endpoint. Defaults to false. The chat completion request includes a
671
+ # top-level `extra_metadata` object when dynamic variables are available. For
672
+ # example:
673
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
674
674
  sig { returns(T.nilable(T::Boolean)) }
675
675
  attr_reader :forward_metadata
676
676
 
@@ -713,11 +713,11 @@ module Telnyx
713
713
  # Integration secret identifier for the client certificate used with certificate
714
714
  # authentication.
715
715
  certificate_ref: nil,
716
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
717
- # external LLM endpoint. Defaults to false. The external endpoint receives the
718
- # standard chat completions payload with top-level `metadata` and
719
- # `dynamic_variables` objects when values are available. For example:
720
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
716
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
717
+ # LLM endpoint. Defaults to false. The chat completion request includes a
718
+ # top-level `extra_metadata` object when dynamic variables are available. For
719
+ # example:
720
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
721
721
  forward_metadata: nil,
722
722
  # Integration secret identifier for the external LLM API key.
723
723
  llm_api_key_ref: nil,
@@ -466,11 +466,11 @@ module Telnyx
466
466
  sig { params(certificate_ref: String).void }
467
467
  attr_writer :certificate_ref
468
468
 
469
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
470
- # external LLM endpoint. Defaults to false. The external endpoint receives the
471
- # standard chat completions payload with top-level `metadata` and
472
- # `dynamic_variables` objects when values are available. For example:
473
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
469
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
470
+ # LLM endpoint. Defaults to false. The chat completion request includes a
471
+ # top-level `extra_metadata` object when dynamic variables are available. For
472
+ # example:
473
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
474
474
  sig { returns(T.nilable(T::Boolean)) }
475
475
  attr_reader :forward_metadata
476
476
 
@@ -513,11 +513,11 @@ module Telnyx
513
513
  # Integration secret identifier for the client certificate used with certificate
514
514
  # authentication.
515
515
  certificate_ref: nil,
516
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
517
- # external LLM endpoint. Defaults to false. The external endpoint receives the
518
- # standard chat completions payload with top-level `metadata` and
519
- # `dynamic_variables` objects when values are available. For example:
520
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
516
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
517
+ # LLM endpoint. Defaults to false. The chat completion request includes a
518
+ # top-level `extra_metadata` object when dynamic variables are available. For
519
+ # example:
520
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
521
521
  forward_metadata: nil,
522
522
  # Integration secret identifier for the external LLM API key.
523
523
  llm_api_key_ref: nil,
@@ -694,11 +694,11 @@ module Telnyx
694
694
  sig { params(certificate_ref: String).void }
695
695
  attr_writer :certificate_ref
696
696
 
697
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
698
- # external LLM endpoint. Defaults to false. The external endpoint receives the
699
- # standard chat completions payload with top-level `metadata` and
700
- # `dynamic_variables` objects when values are available. For example:
701
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
697
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
698
+ # LLM endpoint. Defaults to false. The chat completion request includes a
699
+ # top-level `extra_metadata` object when dynamic variables are available. For
700
+ # example:
701
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
702
702
  sig { returns(T.nilable(T::Boolean)) }
703
703
  attr_reader :forward_metadata
704
704
 
@@ -741,11 +741,11 @@ module Telnyx
741
741
  # Integration secret identifier for the client certificate used with certificate
742
742
  # authentication.
743
743
  certificate_ref: nil,
744
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
745
- # external LLM endpoint. Defaults to false. The external endpoint receives the
746
- # standard chat completions payload with top-level `metadata` and
747
- # `dynamic_variables` objects when values are available. For example:
748
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
744
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
745
+ # LLM endpoint. Defaults to false. The chat completion request includes a
746
+ # top-level `extra_metadata` object when dynamic variables are available. For
747
+ # example:
748
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
749
749
  forward_metadata: nil,
750
750
  # Integration secret identifier for the external LLM API key.
751
751
  llm_api_key_ref: nil,
@@ -462,11 +462,11 @@ module Telnyx
462
462
  sig { params(certificate_ref: String).void }
463
463
  attr_writer :certificate_ref
464
464
 
465
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
466
- # external LLM endpoint. Defaults to false. The external endpoint receives the
467
- # standard chat completions payload with top-level `metadata` and
468
- # `dynamic_variables` objects when values are available. For example:
469
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
465
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
466
+ # LLM endpoint. Defaults to false. The chat completion request includes a
467
+ # top-level `extra_metadata` object when dynamic variables are available. For
468
+ # example:
469
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
470
470
  sig { returns(T.nilable(T::Boolean)) }
471
471
  attr_reader :forward_metadata
472
472
 
@@ -509,11 +509,11 @@ module Telnyx
509
509
  # Integration secret identifier for the client certificate used with certificate
510
510
  # authentication.
511
511
  certificate_ref: nil,
512
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
513
- # external LLM endpoint. Defaults to false. The external endpoint receives the
514
- # standard chat completions payload with top-level `metadata` and
515
- # `dynamic_variables` objects when values are available. For example:
516
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
512
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
513
+ # LLM endpoint. Defaults to false. The chat completion request includes a
514
+ # top-level `extra_metadata` object when dynamic variables are available. For
515
+ # example:
516
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
517
517
  forward_metadata: nil,
518
518
  # Integration secret identifier for the external LLM API key.
519
519
  llm_api_key_ref: nil,
@@ -690,11 +690,11 @@ module Telnyx
690
690
  sig { params(certificate_ref: String).void }
691
691
  attr_writer :certificate_ref
692
692
 
693
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
694
- # external LLM endpoint. Defaults to false. The external endpoint receives the
695
- # standard chat completions payload with top-level `metadata` and
696
- # `dynamic_variables` objects when values are available. For example:
697
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
693
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
694
+ # LLM endpoint. Defaults to false. The chat completion request includes a
695
+ # top-level `extra_metadata` object when dynamic variables are available. For
696
+ # example:
697
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
698
698
  sig { returns(T.nilable(T::Boolean)) }
699
699
  attr_reader :forward_metadata
700
700
 
@@ -737,11 +737,11 @@ module Telnyx
737
737
  # Integration secret identifier for the client certificate used with certificate
738
738
  # authentication.
739
739
  certificate_ref: nil,
740
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
741
- # external LLM endpoint. Defaults to false. The external endpoint receives the
742
- # standard chat completions payload with top-level `metadata` and
743
- # `dynamic_variables` objects when values are available. For example:
744
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
740
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
741
+ # LLM endpoint. Defaults to false. The chat completion request includes a
742
+ # top-level `extra_metadata` object when dynamic variables are available. For
743
+ # example:
744
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
745
745
  forward_metadata: nil,
746
746
  # Integration secret identifier for the external LLM API key.
747
747
  llm_api_key_ref: nil,
@@ -408,11 +408,11 @@ module Telnyx
408
408
  sig { params(certificate_ref: String).void }
409
409
  attr_writer :certificate_ref
410
410
 
411
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
412
- # external LLM endpoint. Defaults to false. The external endpoint receives the
413
- # standard chat completions payload with top-level `metadata` and
414
- # `dynamic_variables` objects when values are available. For example:
415
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
411
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
412
+ # LLM endpoint. Defaults to false. The chat completion request includes a
413
+ # top-level `extra_metadata` object when dynamic variables are available. For
414
+ # example:
415
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
416
416
  sig { returns(T.nilable(T::Boolean)) }
417
417
  attr_reader :forward_metadata
418
418
 
@@ -455,11 +455,11 @@ module Telnyx
455
455
  # Integration secret identifier for the client certificate used with certificate
456
456
  # authentication.
457
457
  certificate_ref: nil,
458
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
459
- # external LLM endpoint. Defaults to false. The external endpoint receives the
460
- # standard chat completions payload with top-level `metadata` and
461
- # `dynamic_variables` objects when values are available. For example:
462
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
458
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
459
+ # LLM endpoint. Defaults to false. The chat completion request includes a
460
+ # top-level `extra_metadata` object when dynamic variables are available. For
461
+ # example:
462
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
463
463
  forward_metadata: nil,
464
464
  # Integration secret identifier for the external LLM API key.
465
465
  llm_api_key_ref: nil,
@@ -636,11 +636,11 @@ module Telnyx
636
636
  sig { params(certificate_ref: String).void }
637
637
  attr_writer :certificate_ref
638
638
 
639
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
640
- # external LLM endpoint. Defaults to false. The external endpoint receives the
641
- # standard chat completions payload with top-level `metadata` and
642
- # `dynamic_variables` objects when values are available. For example:
643
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
639
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
640
+ # LLM endpoint. Defaults to false. The chat completion request includes a
641
+ # top-level `extra_metadata` object when dynamic variables are available. For
642
+ # example:
643
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
644
644
  sig { returns(T.nilable(T::Boolean)) }
645
645
  attr_reader :forward_metadata
646
646
 
@@ -683,11 +683,11 @@ module Telnyx
683
683
  # Integration secret identifier for the client certificate used with certificate
684
684
  # authentication.
685
685
  certificate_ref: nil,
686
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
687
- # external LLM endpoint. Defaults to false. The external endpoint receives the
688
- # standard chat completions payload with top-level `metadata` and
689
- # `dynamic_variables` objects when values are available. For example:
690
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
686
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
687
+ # LLM endpoint. Defaults to false. The chat completion request includes a
688
+ # top-level `extra_metadata` object when dynamic variables are available. For
689
+ # example:
690
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
691
691
  forward_metadata: nil,
692
692
  # Integration secret identifier for the external LLM API key.
693
693
  llm_api_key_ref: nil,
@@ -344,11 +344,11 @@ module Telnyx
344
344
  sig { params(certificate_ref: String).void }
345
345
  attr_writer :certificate_ref
346
346
 
347
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
348
- # external LLM endpoint. Defaults to false. The external endpoint receives the
349
- # standard chat completions payload with top-level `metadata` and
350
- # `dynamic_variables` objects when values are available. For example:
351
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
347
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
348
+ # LLM endpoint. Defaults to false. The chat completion request includes a
349
+ # top-level `extra_metadata` object when dynamic variables are available. For
350
+ # example:
351
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
352
352
  sig { returns(T.nilable(T::Boolean)) }
353
353
  attr_reader :forward_metadata
354
354
 
@@ -397,11 +397,11 @@ module Telnyx
397
397
  # Integration secret identifier for the client certificate used with certificate
398
398
  # authentication.
399
399
  certificate_ref: nil,
400
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
401
- # external LLM endpoint. Defaults to false. The external endpoint receives the
402
- # standard chat completions payload with top-level `metadata` and
403
- # `dynamic_variables` objects when values are available. For example:
404
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
400
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
401
+ # LLM endpoint. Defaults to false. The chat completion request includes a
402
+ # top-level `extra_metadata` object when dynamic variables are available. For
403
+ # example:
404
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
405
405
  forward_metadata: nil,
406
406
  # Integration secret identifier for the external LLM API key.
407
407
  llm_api_key_ref: nil,
@@ -580,11 +580,11 @@ module Telnyx
580
580
  sig { params(certificate_ref: String).void }
581
581
  attr_writer :certificate_ref
582
582
 
583
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
584
- # external LLM endpoint. Defaults to false. The external endpoint receives the
585
- # standard chat completions payload with top-level `metadata` and
586
- # `dynamic_variables` objects when values are available. For example:
587
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
583
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
584
+ # LLM endpoint. Defaults to false. The chat completion request includes a
585
+ # top-level `extra_metadata` object when dynamic variables are available. For
586
+ # example:
587
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
588
588
  sig { returns(T.nilable(T::Boolean)) }
589
589
  attr_reader :forward_metadata
590
590
 
@@ -633,11 +633,11 @@ module Telnyx
633
633
  # Integration secret identifier for the client certificate used with certificate
634
634
  # authentication.
635
635
  certificate_ref: nil,
636
- # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
637
- # external LLM endpoint. Defaults to false. The external endpoint receives the
638
- # standard chat completions payload with top-level `metadata` and
639
- # `dynamic_variables` objects when values are available. For example:
640
- # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
636
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
637
+ # LLM endpoint. Defaults to false. The chat completion request includes a
638
+ # top-level `extra_metadata` object when dynamic variables are available. For
639
+ # example:
640
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
641
641
  forward_metadata: nil,
642
642
  # Integration secret identifier for the external LLM API key.
643
643
  llm_api_key_ref: nil,
@@ -27,6 +27,13 @@ module Telnyx
27
27
  end
28
28
  attr_writer :whatsapp_message
29
29
 
30
+ # Messaging profile ID - required if the 'from' number is not SMS-enabled
31
+ sig { returns(T.nilable(String)) }
32
+ attr_reader :messaging_profile_id
33
+
34
+ sig { params(messaging_profile_id: String).void }
35
+ attr_writer :messaging_profile_id
36
+
30
37
  # Message type - must be set to "WHATSAPP"
31
38
  sig do
32
39
  returns(T.nilable(Telnyx::MessageSendWhatsappParams::Type::OrSymbol))
@@ -50,6 +57,7 @@ module Telnyx
50
57
  from: String,
51
58
  to: String,
52
59
  whatsapp_message: Telnyx::WhatsappMessageContent::OrHash,
60
+ messaging_profile_id: String,
53
61
  type: Telnyx::MessageSendWhatsappParams::Type::OrSymbol,
54
62
  webhook_url: String,
55
63
  request_options: Telnyx::RequestOptions::OrHash
@@ -61,6 +69,8 @@ module Telnyx
61
69
  # Phone number in +E.164 format
62
70
  to:,
63
71
  whatsapp_message:,
72
+ # Messaging profile ID - required if the 'from' number is not SMS-enabled
73
+ messaging_profile_id: nil,
64
74
  # Message type - must be set to "WHATSAPP"
65
75
  type: nil,
66
76
  # The URL where webhooks related to this message will be sent.
@@ -75,6 +85,7 @@ module Telnyx
75
85
  from: String,
76
86
  to: String,
77
87
  whatsapp_message: Telnyx::WhatsappMessageContent,
88
+ messaging_profile_id: String,
78
89
  type: Telnyx::MessageSendWhatsappParams::Type::OrSymbol,
79
90
  webhook_url: String,
80
91
  request_options: Telnyx::RequestOptions
@@ -55,6 +55,13 @@ module Telnyx
55
55
  sig { params(email: String).void }
56
56
  attr_writer :email
57
57
 
58
+ # Messaging profile ID for inbound messages
59
+ sig { returns(T.nilable(String)) }
60
+ attr_reader :profile_id
61
+
62
+ sig { params(profile_id: String).void }
63
+ attr_writer :profile_id
64
+
58
65
  sig { returns(T.nilable(String)) }
59
66
  attr_reader :website
60
67
 
@@ -70,6 +77,7 @@ module Telnyx
70
77
  description: String,
71
78
  display_name: String,
72
79
  email: String,
80
+ profile_id: String,
73
81
  website: String,
74
82
  request_options: Telnyx::RequestOptions::OrHash
75
83
  ).returns(T.attached_class)
@@ -82,6 +90,8 @@ module Telnyx
82
90
  description: nil,
83
91
  display_name: nil,
84
92
  email: nil,
93
+ # Messaging profile ID for inbound messages
94
+ profile_id: nil,
85
95
  website: nil,
86
96
  request_options: {}
87
97
  )
@@ -97,6 +107,7 @@ module Telnyx
97
107
  description: String,
98
108
  display_name: String,
99
109
  email: String,
110
+ profile_id: String,
100
111
  website: String,
101
112
  request_options: Telnyx::RequestOptions
102
113
  }
@@ -68,6 +68,12 @@ module Telnyx
68
68
  sig { params(phone_number_id: String).void }
69
69
  attr_writer :phone_number_id
70
70
 
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :profile_id
73
+
74
+ sig { params(profile_id: String).void }
75
+ attr_writer :profile_id
76
+
71
77
  sig { returns(T.nilable(String)) }
72
78
  attr_reader :profile_photo_url
73
79
 
@@ -103,6 +109,7 @@ module Telnyx
103
109
  display_name: String,
104
110
  email: String,
105
111
  phone_number_id: String,
112
+ profile_id: String,
106
113
  profile_photo_url: String,
107
114
  record_type: String,
108
115
  updated_at: Time,
@@ -120,6 +127,7 @@ module Telnyx
120
127
  email: nil,
121
128
  # Whatsapp phone number ID
122
129
  phone_number_id: nil,
130
+ profile_id: nil,
123
131
  profile_photo_url: nil,
124
132
  record_type: nil,
125
133
  updated_at: nil,
@@ -139,6 +147,7 @@ module Telnyx
139
147
  display_name: String,
140
148
  email: String,
141
149
  phone_number_id: String,
150
+ profile_id: String,
142
151
  profile_photo_url: String,
143
152
  record_type: String,
144
153
  updated_at: Time,
@@ -406,6 +406,7 @@ module Telnyx
406
406
  from: String,
407
407
  to: String,
408
408
  whatsapp_message: Telnyx::WhatsappMessageContent::OrHash,
409
+ messaging_profile_id: String,
409
410
  type: Telnyx::MessageSendWhatsappParams::Type::OrSymbol,
410
411
  webhook_url: String,
411
412
  request_options: Telnyx::RequestOptions::OrHash
@@ -417,6 +418,8 @@ module Telnyx
417
418
  # Phone number in +E.164 format
418
419
  to:,
419
420
  whatsapp_message:,
421
+ # Messaging profile ID - required if the 'from' number is not SMS-enabled
422
+ messaging_profile_id: nil,
420
423
  # Message type - must be set to "WHATSAPP"
421
424
  type: nil,
422
425
  # The URL where webhooks related to this message will be sent.
@@ -38,6 +38,7 @@ module Telnyx
38
38
  description: String,
39
39
  display_name: String,
40
40
  email: String,
41
+ profile_id: String,
41
42
  website: String,
42
43
  request_options: Telnyx::RequestOptions::OrHash
43
44
  ).returns(
@@ -53,6 +54,8 @@ module Telnyx
53
54
  description: nil,
54
55
  display_name: nil,
55
56
  email: nil,
57
+ # Messaging profile ID for inbound messages
58
+ profile_id: nil,
56
59
  website: nil,
57
60
  request_options: {}
58
61
  )
@@ -5,6 +5,7 @@ module Telnyx
5
5
  from: String,
6
6
  to: String,
7
7
  whatsapp_message: Telnyx::WhatsappMessageContent,
8
+ messaging_profile_id: String,
8
9
  type: Telnyx::Models::MessageSendWhatsappParams::type_,
9
10
  webhook_url: String
10
11
  }
@@ -20,6 +21,10 @@ module Telnyx
20
21
 
21
22
  attr_accessor whatsapp_message: Telnyx::WhatsappMessageContent
22
23
 
24
+ attr_reader messaging_profile_id: String?
25
+
26
+ def messaging_profile_id=: (String) -> String
27
+
23
28
  attr_reader type: Telnyx::Models::MessageSendWhatsappParams::type_?
24
29
 
25
30
  def type=: (
@@ -34,6 +39,7 @@ module Telnyx
34
39
  from: String,
35
40
  to: String,
36
41
  whatsapp_message: Telnyx::WhatsappMessageContent,
42
+ ?messaging_profile_id: String,
37
43
  ?type: Telnyx::Models::MessageSendWhatsappParams::type_,
38
44
  ?webhook_url: String,
39
45
  ?request_options: Telnyx::request_opts
@@ -43,6 +49,7 @@ module Telnyx
43
49
  from: String,
44
50
  to: String,
45
51
  whatsapp_message: Telnyx::WhatsappMessageContent,
52
+ messaging_profile_id: String,
46
53
  type: Telnyx::Models::MessageSendWhatsappParams::type_,
47
54
  webhook_url: String,
48
55
  request_options: Telnyx::RequestOptions
@@ -11,6 +11,7 @@ module Telnyx
11
11
  description: String,
12
12
  display_name: String,
13
13
  email: String,
14
+ profile_id: String,
14
15
  website: String
15
16
  }
16
17
  & Telnyx::Internal::Type::request_parameters
@@ -45,6 +46,10 @@ module Telnyx
45
46
 
46
47
  def email=: (String) -> String
47
48
 
49
+ attr_reader profile_id: String?
50
+
51
+ def profile_id=: (String) -> String
52
+
48
53
  attr_reader website: String?
49
54
 
50
55
  def website=: (String) -> String
@@ -57,6 +62,7 @@ module Telnyx
57
62
  ?description: String,
58
63
  ?display_name: String,
59
64
  ?email: String,
65
+ ?profile_id: String,
60
66
  ?website: String,
61
67
  ?request_options: Telnyx::request_opts
62
68
  ) -> void
@@ -69,6 +75,7 @@ module Telnyx
69
75
  description: String,
70
76
  display_name: String,
71
77
  email: String,
78
+ profile_id: String,
72
79
  website: String,
73
80
  request_options: Telnyx::RequestOptions
74
81
  }
@@ -13,6 +13,7 @@ module Telnyx
13
13
  display_name: String,
14
14
  email: String,
15
15
  phone_number_id: String,
16
+ profile_id: String,
16
17
  profile_photo_url: String,
17
18
  record_type: String,
18
19
  updated_at: Time,
@@ -56,6 +57,10 @@ module Telnyx
56
57
 
57
58
  def phone_number_id=: (String) -> String
58
59
 
60
+ attr_reader profile_id: String?
61
+
62
+ def profile_id=: (String) -> String
63
+
59
64
  attr_reader profile_photo_url: String?
60
65
 
61
66
  def profile_photo_url=: (String) -> String
@@ -82,6 +87,7 @@ module Telnyx
82
87
  ?display_name: String,
83
88
  ?email: String,
84
89
  ?phone_number_id: String,
90
+ ?profile_id: String,
85
91
  ?profile_photo_url: String,
86
92
  ?record_type: String,
87
93
  ?updated_at: Time,
@@ -98,6 +104,7 @@ module Telnyx
98
104
  display_name: String,
99
105
  email: String,
100
106
  phone_number_id: String,
107
+ profile_id: String,
101
108
  profile_photo_url: String,
102
109
  record_type: String,
103
110
  updated_at: Time,
@@ -112,6 +112,7 @@ module Telnyx
112
112
  from: String,
113
113
  to: String,
114
114
  whatsapp_message: Telnyx::WhatsappMessageContent,
115
+ ?messaging_profile_id: String,
115
116
  ?type: Telnyx::Models::MessageSendWhatsappParams::type_,
116
117
  ?webhook_url: String,
117
118
  ?request_options: Telnyx::request_opts
@@ -18,6 +18,7 @@ module Telnyx
18
18
  ?description: String,
19
19
  ?display_name: String,
20
20
  ?email: String,
21
+ ?profile_id: String,
21
22
  ?website: String,
22
23
  ?request_options: Telnyx::request_opts
23
24
  ) -> Telnyx::Models::Whatsapp::PhoneNumbers::ProfileUpdateResponse
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.88.0
4
+ version: 5.90.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx