telnyx 5.173.0 → 5.174.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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +0 -4
  5. data/lib/telnyx/lib/access_token.rb +141 -0
  6. data/lib/telnyx/lib/telephony_credentials.rb +87 -0
  7. data/lib/telnyx/lib.rb +2 -0
  8. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings.rb +26 -0
  9. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +3 -41
  10. data/lib/telnyx/models/ai/memory/namespaces/summary_settings.rb +33 -0
  11. data/lib/telnyx/models/ai/transcription_challenger.rb +148 -0
  12. data/lib/telnyx/models/ai/transcription_fallback_model.rb +78 -0
  13. data/lib/telnyx/models/ai/transcription_settings.rb +6 -219
  14. data/lib/telnyx/models/compute/funcs/func_log_export_config.rb +96 -0
  15. data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +3 -89
  16. data/lib/telnyx/models/email_template_common.rb +5 -26
  17. data/lib/telnyx/models/email_template_create_params.rb +5 -26
  18. data/lib/telnyx/models/messaging_outbound_message_payload.rb +22 -1
  19. data/lib/telnyx/models/messaging_profile_features.rb +16 -1
  20. data/lib/telnyx/models/model_metadata.rb +10 -1
  21. data/lib/telnyx/models/outbound_message_payload.rb +22 -1
  22. data/lib/telnyx/models/phone_numbers/numbers_phone_numbers_job.rb +6 -50
  23. data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +6 -50
  24. data/lib/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rb +28 -0
  25. data/lib/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rb +28 -0
  26. data/lib/telnyx/models/update_email_template_request.rb +5 -26
  27. data/lib/telnyx/models/variable_schema_entry.rb +28 -0
  28. data/lib/telnyx/models/whatsapp/hosted_signup_create_response.rb +3 -83
  29. data/lib/telnyx/models/whatsapp/hosted_signup_retrieve_response.rb +3 -84
  30. data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +3 -191
  31. data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +3 -192
  32. data/lib/telnyx/models/whatsapp/{hosted_signup_list_response.rb → whatsapp_hosted_signup.rb} +8 -6
  33. data/lib/telnyx/models/whatsapp/{phone_number_list_response.rb → whatsapp_phone_response.rb} +12 -12
  34. data/lib/telnyx/models.rb +2 -0
  35. data/lib/telnyx/resources/email_templates.rb +3 -3
  36. data/lib/telnyx/resources/portouts.rb +2 -1
  37. data/lib/telnyx/resources/whatsapp/business_accounts/phone_numbers.rb +2 -2
  38. data/lib/telnyx/resources/whatsapp/hosted_signups.rb +2 -2
  39. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +2 -2
  40. data/lib/telnyx/version.rb +1 -1
  41. data/lib/telnyx.rb +10 -5
  42. data/rbi/telnyx/client.rbi +0 -3
  43. data/rbi/telnyx/lib/access_token.rbi +73 -0
  44. data/rbi/telnyx/lib/telephony_credentials.rbi +50 -0
  45. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings.rbi +58 -0
  46. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +4 -107
  47. data/rbi/telnyx/models/ai/memory/namespaces/summary_settings.rbi +51 -0
  48. data/rbi/telnyx/models/ai/transcription_challenger.rbi +318 -0
  49. data/rbi/telnyx/models/ai/transcription_fallback_model.rbi +171 -0
  50. data/rbi/telnyx/models/ai/transcription_settings.rbi +7 -531
  51. data/rbi/telnyx/models/compute/funcs/func_log_export_config.rbi +175 -0
  52. data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +4 -176
  53. data/rbi/telnyx/models/email_template_common.rbi +3 -56
  54. data/rbi/telnyx/models/email_template_create_params.rbi +3 -59
  55. data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +26 -0
  56. data/rbi/telnyx/models/messaging_profile_features.rbi +36 -5
  57. data/rbi/telnyx/models/model_metadata.rbi +13 -0
  58. data/rbi/telnyx/models/outbound_message_payload.rbi +26 -0
  59. data/rbi/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbi +8 -96
  60. data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +8 -94
  61. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbi +49 -0
  62. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbi +49 -0
  63. data/rbi/telnyx/models/update_email_template_request.rbi +3 -59
  64. data/rbi/telnyx/models/variable_schema_entry.rbi +40 -0
  65. data/rbi/telnyx/models/whatsapp/hosted_signup_create_response.rbi +6 -173
  66. data/rbi/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbi +6 -175
  67. data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +4 -366
  68. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +6 -368
  69. data/rbi/telnyx/models/whatsapp/{hosted_signup_list_response.rbi → whatsapp_hosted_signup.rbi} +11 -12
  70. data/rbi/telnyx/models/whatsapp/{phone_number_list_response.rbi → whatsapp_phone_response.rbi} +23 -23
  71. data/rbi/telnyx/models.rbi +2 -0
  72. data/rbi/telnyx/resources/email_templates.rbi +3 -18
  73. data/rbi/telnyx/resources/portouts.rbi +2 -1
  74. data/rbi/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbi +1 -1
  75. data/rbi/telnyx/resources/whatsapp/hosted_signups.rbi +1 -1
  76. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +1 -1
  77. data/sig/telnyx/client.rbs +0 -2
  78. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings.rbs +30 -0
  79. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +4 -37
  80. data/sig/telnyx/models/ai/memory/namespaces/summary_settings.rbs +19 -0
  81. data/sig/telnyx/models/ai/transcription_challenger.rbs +98 -0
  82. data/sig/telnyx/models/ai/transcription_fallback_model.rbs +63 -0
  83. data/sig/telnyx/models/ai/transcription_settings.rbs +8 -159
  84. data/sig/telnyx/models/compute/funcs/func_log_export_config.rbs +96 -0
  85. data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +6 -95
  86. data/sig/telnyx/models/email_template_common.rbs +4 -18
  87. data/sig/telnyx/models/email_template_create_params.rbs +4 -18
  88. data/sig/telnyx/models/messaging_outbound_message_payload.rbs +10 -0
  89. data/sig/telnyx/models/messaging_profile_features.rbs +14 -3
  90. data/sig/telnyx/models/model_metadata.rbs +7 -0
  91. data/sig/telnyx/models/outbound_message_payload.rbs +10 -0
  92. data/sig/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbs +12 -44
  93. data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +12 -44
  94. data/sig/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbs +24 -0
  95. data/sig/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbs +24 -0
  96. data/sig/telnyx/models/update_email_template_request.rbs +4 -18
  97. data/sig/telnyx/models/variable_schema_entry.rbs +17 -0
  98. data/sig/telnyx/models/whatsapp/hosted_signup_create_response.rbs +6 -90
  99. data/sig/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbs +6 -90
  100. data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +6 -185
  101. data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +4 -189
  102. data/sig/telnyx/models/whatsapp/{hosted_signup_list_response.rbs → whatsapp_hosted_signup.rbs} +11 -9
  103. data/sig/telnyx/models/whatsapp/{phone_number_list_response.rbs → whatsapp_phone_response.rbs} +13 -11
  104. data/sig/telnyx/models.rbs +2 -0
  105. data/sig/telnyx/resources/email_templates.rbs +3 -3
  106. data/sig/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbs +1 -1
  107. data/sig/telnyx/resources/whatsapp/hosted_signups.rbs +1 -1
  108. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +1 -1
  109. metadata +36 -17
  110. data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +0 -198
  111. data/lib/telnyx/resources/tts_integrations/actions.rb +0 -16
  112. data/lib/telnyx/resources/tts_integrations.rb +0 -18
  113. data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +0 -358
  114. data/rbi/telnyx/resources/tts_integrations/actions.rbi +0 -14
  115. data/rbi/telnyx/resources/tts_integrations.rbi +0 -15
  116. data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +0 -186
  117. data/sig/telnyx/resources/tts_integrations/actions.rbs +0 -9
  118. data/sig/telnyx/resources/tts_integrations.rbs +0 -9
@@ -72,6 +72,13 @@ module Telnyx
72
72
  # @return [String, nil]
73
73
  optional :base_model, String, nil?: true
74
74
 
75
+ # @!attribute beta
76
+ # Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
77
+ # the label is removed once the model is established.
78
+ #
79
+ # @return [Boolean, nil]
80
+ optional :beta, Telnyx::Internal::Type::Boolean
81
+
75
82
  # @!attribute description
76
83
  # Short, human-readable summary of what the model is best suited for.
77
84
  #
@@ -156,7 +163,7 @@ module Telnyx
156
163
  # @return [String, nil]
157
164
  optional :task, String
158
165
 
159
- # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, service_tiers: nil, task: nil)
166
+ # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, beta: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, service_tiers: nil, task: nil)
160
167
  # Some parameter documentations has been truncated, see
161
168
  # {Telnyx::Models::ModelMetadata} for more details.
162
169
  #
@@ -186,6 +193,8 @@ module Telnyx
186
193
  #
187
194
  # @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
188
195
  #
196
+ # @param beta [Boolean] Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
197
+ #
189
198
  # @param description [String, nil] Short, human-readable summary of what the model is best suited for.
190
199
  #
191
200
  # @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f
@@ -21,6 +21,14 @@ module Telnyx
21
21
  # @return [Array<Telnyx::Models::OutboundMessagePayload::Cc>, nil]
22
22
  optional :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::OutboundMessagePayload::Cc] }
23
23
 
24
+ # @!attribute child_message_id
25
+ # Identifies the next chunk when server-side SMS chunking
26
+ # (`auto_chunk_long_messages` on the messaging profile) split this message. Always
27
+ # present; null on non-chunked messages and on the final chunk.
28
+ #
29
+ # @return [String, nil]
30
+ optional :child_message_id, String, nil?: true
31
+
24
32
  # @!attribute completed_at
25
33
  # ISO 8601 formatted date indicating when the message was finalized.
26
34
  #
@@ -86,6 +94,15 @@ module Telnyx
86
94
  # @return [String, nil]
87
95
  optional :organization_id, String
88
96
 
97
+ # @!attribute parent_message_id
98
+ # Identifies the original request's message when server-side SMS chunking
99
+ # (`auto_chunk_long_messages` on the messaging profile) split it into chunks. The
100
+ # first chunk's ID is the original request's message ID. Always present; null when
101
+ # this message is not part of a chunked send.
102
+ #
103
+ # @return [String, nil]
104
+ optional :parent_message_id, String, nil?: true
105
+
89
106
  # @!attribute parts
90
107
  # Number of parts into which the message's body must be split.
91
108
  #
@@ -210,7 +227,7 @@ module Telnyx
210
227
  # @return [String, nil]
211
228
  optional :webhook_url, String, nil?: true
212
229
 
213
- # @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, template_id: nil, template_name: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
230
+ # @!method initialize(id: nil, body: nil, cc: nil, child_message_id: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parent_message_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, template_id: nil, template_name: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
214
231
  # Some parameter documentations has been truncated, see
215
232
  # {Telnyx::Models::OutboundMessagePayload} for more details.
216
233
  #
@@ -220,6 +237,8 @@ module Telnyx
220
237
  #
221
238
  # @param cc [Array<Telnyx::Models::OutboundMessagePayload::Cc>]
222
239
  #
240
+ # @param child_message_id [String, nil] Identifies the next chunk when server-side SMS chunking (`auto_chunk_long_messag
241
+ #
223
242
  # @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
224
243
  #
225
244
  # @param cost [Telnyx::Models::OutboundMessagePayload::Cost, nil]
@@ -242,6 +261,8 @@ module Telnyx
242
261
  #
243
262
  # @param organization_id [String] The id of the organization the messaging profile belongs to.
244
263
  #
264
+ # @param parent_message_id [String, nil] Identifies the original request's message when server-side SMS chunking (`auto_c
265
+ #
245
266
  # @param parts [Integer] Number of parts into which the message's body must be split.
246
267
  #
247
268
  # @param received_at [Time] ISO 8601 formatted date indicating when the message request was received.
@@ -50,9 +50,9 @@ module Telnyx
50
50
 
51
51
  # @!attribute pending_operations
52
52
  #
53
- # @return [Array<Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation>, nil]
53
+ # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobPendingOperation>, nil]
54
54
  optional :pending_operations,
55
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation] }
55
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation] }
56
56
 
57
57
  # @!attribute record_type
58
58
  # Identifies the type of the resource.
@@ -68,9 +68,9 @@ module Telnyx
68
68
 
69
69
  # @!attribute successful_operations
70
70
  #
71
- # @return [Array<Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation>, nil]
71
+ # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobSuccessfulOperation>, nil]
72
72
  optional :successful_operations,
73
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation] }
73
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation] }
74
74
 
75
75
  # @!attribute type
76
76
  # Identifies the type of the background job.
@@ -99,7 +99,7 @@ module Telnyx
99
99
  #
100
100
  # @param parameters [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::Parameters] Effective parameters saved when the job was created, not a snapshot of the origi
101
101
  #
102
- # @param pending_operations [Array<Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation>]
102
+ # @param pending_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobPendingOperation>]
103
103
  #
104
104
  # @param phone_numbers [Array<Telnyx::Models::PhoneNumbersJobPhoneNumber>]
105
105
  #
@@ -107,7 +107,7 @@ module Telnyx
107
107
  #
108
108
  # @param status [Symbol, Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::Status] Indicates the completion status of the background update.
109
109
  #
110
- # @param successful_operations [Array<Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation>]
110
+ # @param successful_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobSuccessfulOperation>]
111
111
  #
112
112
  # @param type [Symbol, Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob::Type] Identifies the type of the background job.
113
113
  #
@@ -461,29 +461,6 @@ module Telnyx
461
461
  end
462
462
  end
463
463
 
464
- class PendingOperation < Telnyx::Internal::Type::BaseModel
465
- # @!attribute id
466
- # The phone number's ID
467
- #
468
- # @return [String, nil]
469
- optional :id, String
470
-
471
- # @!attribute phone_number
472
- # The phone number in e164 format.
473
- #
474
- # @return [String, nil]
475
- optional :phone_number, String
476
-
477
- # @!method initialize(id: nil, phone_number: nil)
478
- # The phone numbers pending confirmation on update results. Entries in this list
479
- # are transient, and will be moved to either successful_operations or
480
- # failed_operations once the processing is done.
481
- #
482
- # @param id [String] The phone number's ID
483
- #
484
- # @param phone_number [String] The phone number in e164 format.
485
- end
486
-
487
464
  # Indicates the completion status of the background update.
488
465
  #
489
466
  # @see Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob#status
@@ -500,27 +477,6 @@ module Telnyx
500
477
  # @return [Array<Symbol>]
501
478
  end
502
479
 
503
- class SuccessfulOperation < Telnyx::Internal::Type::BaseModel
504
- # @!attribute id
505
- # The phone number's ID
506
- #
507
- # @return [String, nil]
508
- optional :id, String
509
-
510
- # @!attribute phone_number
511
- # The phone number in e164 format.
512
- #
513
- # @return [String, nil]
514
- optional :phone_number, String
515
-
516
- # @!method initialize(id: nil, phone_number: nil)
517
- # The phone numbers successfully updated.
518
- #
519
- # @param id [String] The phone number's ID
520
- #
521
- # @param phone_number [String] The phone number in e164 format.
522
- end
523
-
524
480
  # Identifies the type of the background job.
525
481
  #
526
482
  # @see Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob#type
@@ -37,9 +37,9 @@ module Telnyx
37
37
 
38
38
  # @!attribute pending_operations
39
39
  #
40
- # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJob::PendingOperation>, nil]
40
+ # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobPendingOperation>, nil]
41
41
  optional :pending_operations,
42
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation] }
42
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation] }
43
43
 
44
44
  # @!attribute record_type
45
45
  # Identifies the type of the resource.
@@ -55,9 +55,9 @@ module Telnyx
55
55
 
56
56
  # @!attribute successful_operations
57
57
  #
58
- # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation>, nil]
58
+ # @return [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobSuccessfulOperation>, nil]
59
59
  optional :successful_operations,
60
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation] }
60
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation] }
61
61
 
62
62
  # @!attribute type
63
63
  # Identifies the type of the background job.
@@ -84,7 +84,7 @@ module Telnyx
84
84
  #
85
85
  # @param failed_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJob::FailedOperation>]
86
86
  #
87
- # @param pending_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJob::PendingOperation>]
87
+ # @param pending_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobPendingOperation>]
88
88
  #
89
89
  # @param phone_numbers [Array<Telnyx::Models::PhoneNumbersJobPhoneNumber>]
90
90
  #
@@ -92,7 +92,7 @@ module Telnyx
92
92
  #
93
93
  # @param status [Symbol, Telnyx::Models::PhoneNumbers::PhoneNumbersJob::Status] Indicates the completion status of the background update.
94
94
  #
95
- # @param successful_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation>]
95
+ # @param successful_operations [Array<Telnyx::Models::PhoneNumbers::PhoneNumbersJobSuccessfulOperation>]
96
96
  #
97
97
  # @param type [Symbol, Telnyx::Models::PhoneNumbers::PhoneNumbersJob::Type] Identifies the type of the background job.
98
98
  #
@@ -124,29 +124,6 @@ module Telnyx
124
124
  # @param phone_number [String] The phone number in e164 format.
125
125
  end
126
126
 
127
- class PendingOperation < Telnyx::Internal::Type::BaseModel
128
- # @!attribute id
129
- # The phone number's ID
130
- #
131
- # @return [String, nil]
132
- optional :id, String
133
-
134
- # @!attribute phone_number
135
- # The phone number in e164 format.
136
- #
137
- # @return [String, nil]
138
- optional :phone_number, String
139
-
140
- # @!method initialize(id: nil, phone_number: nil)
141
- # The phone numbers pending confirmation on update results. Entries in this list
142
- # are transient, and will be moved to either successful_operations or
143
- # failed_operations once the processing is done.
144
- #
145
- # @param id [String] The phone number's ID
146
- #
147
- # @param phone_number [String] The phone number in e164 format.
148
- end
149
-
150
127
  # Indicates the completion status of the background update.
151
128
  #
152
129
  # @see Telnyx::Models::PhoneNumbers::PhoneNumbersJob#status
@@ -163,27 +140,6 @@ module Telnyx
163
140
  # @return [Array<Symbol>]
164
141
  end
165
142
 
166
- class SuccessfulOperation < Telnyx::Internal::Type::BaseModel
167
- # @!attribute id
168
- # The phone number's ID
169
- #
170
- # @return [String, nil]
171
- optional :id, String
172
-
173
- # @!attribute phone_number
174
- # The phone number in e164 format.
175
- #
176
- # @return [String, nil]
177
- optional :phone_number, String
178
-
179
- # @!method initialize(id: nil, phone_number: nil)
180
- # The phone numbers successfully updated.
181
- #
182
- # @param id [String] The phone number's ID
183
- #
184
- # @param phone_number [String] The phone number in e164 format.
185
- end
186
-
187
143
  # Identifies the type of the background job.
188
144
  #
189
145
  # @see Telnyx::Models::PhoneNumbers::PhoneNumbersJob#type
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module PhoneNumbers
6
+ class PhoneNumbersJobPendingOperation < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The phone number's ID
9
+ #
10
+ # @return [String, nil]
11
+ optional :id, String
12
+
13
+ # @!attribute phone_number
14
+ # The phone number in e164 format.
15
+ #
16
+ # @return [String, nil]
17
+ optional :phone_number, String
18
+
19
+ # @!method initialize(id: nil, phone_number: nil)
20
+ # @param id [String] The phone number's ID
21
+ #
22
+ # @param phone_number [String] The phone number in e164 format.
23
+ end
24
+ end
25
+
26
+ PhoneNumbersJobPendingOperation = PhoneNumbers::PhoneNumbersJobPendingOperation
27
+ end
28
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module PhoneNumbers
6
+ class PhoneNumbersJobSuccessfulOperation < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The phone number's ID
9
+ #
10
+ # @return [String, nil]
11
+ optional :id, String
12
+
13
+ # @!attribute phone_number
14
+ # The phone number in e164 format.
15
+ #
16
+ # @return [String, nil]
17
+ optional :phone_number, String
18
+
19
+ # @!method initialize(id: nil, phone_number: nil)
20
+ # @param id [String] The phone number's ID
21
+ #
22
+ # @param phone_number [String] The phone number in e164 format.
23
+ end
24
+ end
25
+
26
+ PhoneNumbersJobSuccessfulOperation = PhoneNumbers::PhoneNumbersJobSuccessfulOperation
27
+ end
28
+ end
@@ -42,9 +42,11 @@ module Telnyx
42
42
  # Structured variable requirements. Required variables cannot define defaults;
43
43
  # invalid combinations return 422. Set to `null` to clear the schema.
44
44
  #
45
- # @return [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil]
45
+ # @return [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil]
46
46
  optional :variable_schema,
47
- -> { Telnyx::Internal::Type::HashOf[Telnyx::UpdateEmailTemplateRequest::VariableSchema] },
47
+ -> {
48
+ Telnyx::Internal::Type::HashOf[Telnyx::VariableSchemaEntry]
49
+ },
48
50
  nil?: true
49
51
 
50
52
  # @!attribute variables
@@ -82,35 +84,12 @@ module Telnyx
82
84
  #
83
85
  # @param text_body [String, nil] Liquid template text body.
84
86
  #
85
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
87
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Structured variable requirements. Required variables cannot define defaults; inv
86
88
  #
87
89
  # @param variables [Array<String>, nil] Persisted variable names. In `automatic` mode a non-null array is rejected; in `
88
90
  #
89
91
  # @param variables_mode [Symbol, Telnyx::Models::UpdateEmailTemplateRequest::VariablesMode] Controls how `variables` is maintained. Setting `automatic` re-extracts immediat
90
92
 
91
- class VariableSchema < Telnyx::Internal::Type::BaseModel
92
- # @!attribute required
93
- # Whether the variable must be supplied when strict variable validation is
94
- # enabled.
95
- #
96
- # @return [Boolean]
97
- required :required, Telnyx::Internal::Type::Boolean
98
-
99
- # @!attribute default
100
- # Default value for an optional variable. Rejected when `required` is `true`.
101
- #
102
- # @return [String, nil]
103
- optional :default, String
104
-
105
- # @!method initialize(required:, default: nil)
106
- # Some parameter documentations has been truncated, see
107
- # {Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema} for more details.
108
- #
109
- # @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
110
- #
111
- # @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
112
- end
113
-
114
93
  # Controls how `variables` is maintained. Setting `automatic` re-extracts
115
94
  # immediately from the effective subject, HTML body, and text body and rejects a
116
95
  # simultaneous non-null array. Setting `explicit` requires the exact non-null
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class VariableSchemaEntry < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute required
7
+ # Whether the variable must be supplied when strict variable validation is
8
+ # enabled.
9
+ #
10
+ # @return [Boolean]
11
+ required :required, Telnyx::Internal::Type::Boolean
12
+
13
+ # @!attribute default
14
+ # Default value for an optional variable. Rejected when `required` is `true`.
15
+ #
16
+ # @return [String, nil]
17
+ optional :default, String
18
+
19
+ # @!method initialize(required:, default: nil)
20
+ # Some parameter documentations has been truncated, see
21
+ # {Telnyx::Models::VariableSchemaEntry} for more details.
22
+ #
23
+ # @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
24
+ #
25
+ # @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
26
+ end
27
+ end
28
+ end
@@ -7,91 +7,11 @@ module Telnyx
7
7
  class HostedSignupCreateResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
- # @return [Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data, nil]
11
- optional :data, -> { Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data }
10
+ # @return [Telnyx::Models::Whatsapp::WhatsappHostedSignup, nil]
11
+ optional :data, -> { Telnyx::Whatsapp::WhatsappHostedSignup }
12
12
 
13
13
  # @!method initialize(data: nil)
14
- # @param data [Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data]
15
-
16
- # @see Telnyx::Models::Whatsapp::HostedSignupCreateResponse#data
17
- class Data < Telnyx::Internal::Type::BaseModel
18
- # @!attribute id
19
- # Hosted signup ID
20
- #
21
- # @return [String, nil]
22
- optional :id, String
23
-
24
- # @!attribute app_id
25
- # Meta App ID the hosted signup onboards customers into
26
- #
27
- # @return [String, nil]
28
- optional :app_id, String
29
-
30
- # @!attribute created_at
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute expires_at
36
- # When the onboarding URL stops working
37
- #
38
- # @return [Time, nil]
39
- optional :expires_at, Time
40
-
41
- # @!attribute jwt
42
- # Signed token embedded in `url`
43
- #
44
- # @return [String, nil]
45
- optional :jwt, String
46
-
47
- # @!attribute record_type
48
- #
49
- # @return [Symbol, Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data::RecordType, nil]
50
- optional :record_type, enum: -> { Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data::RecordType }
51
-
52
- # @!attribute solution_id
53
- # Meta Partner Solution ID linked to the app. Returned only when creating a hosted
54
- # signup.
55
- #
56
- # @return [String, nil]
57
- optional :solution_id, String
58
-
59
- # @!attribute url
60
- # Hosted onboarding URL to share with the end customer
61
- #
62
- # @return [String, nil]
63
- optional :url, String
64
-
65
- # @!method initialize(id: nil, app_id: nil, created_at: nil, expires_at: nil, jwt: nil, record_type: nil, solution_id: nil, url: nil)
66
- # Some parameter documentations has been truncated, see
67
- # {Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data} for more details.
68
- #
69
- # @param id [String] Hosted signup ID
70
- #
71
- # @param app_id [String] Meta App ID the hosted signup onboards customers into
72
- #
73
- # @param created_at [Time]
74
- #
75
- # @param expires_at [Time] When the onboarding URL stops working
76
- #
77
- # @param jwt [String] Signed token embedded in `url`
78
- #
79
- # @param record_type [Symbol, Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data::RecordType]
80
- #
81
- # @param solution_id [String] Meta Partner Solution ID linked to the app. Returned only when creating a hosted
82
- #
83
- # @param url [String] Hosted onboarding URL to share with the end customer
84
-
85
- # @see Telnyx::Models::Whatsapp::HostedSignupCreateResponse::Data#record_type
86
- module RecordType
87
- extend Telnyx::Internal::Type::Enum
88
-
89
- WHATSAPP_JWT = :whatsapp_jwt
90
-
91
- # @!method self.values
92
- # @return [Array<Symbol>]
93
- end
94
- end
14
+ # @param data [Telnyx::Models::Whatsapp::WhatsappHostedSignup]
95
15
  end
96
16
  end
97
17
  end
@@ -7,92 +7,11 @@ module Telnyx
7
7
  class HostedSignupRetrieveResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
- # @return [Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data, nil]
11
- optional :data, -> { Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data }
10
+ # @return [Telnyx::Models::Whatsapp::WhatsappHostedSignup, nil]
11
+ optional :data, -> { Telnyx::Whatsapp::WhatsappHostedSignup }
12
12
 
13
13
  # @!method initialize(data: nil)
14
- # @param data [Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data]
15
-
16
- # @see Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse#data
17
- class Data < Telnyx::Internal::Type::BaseModel
18
- # @!attribute id
19
- # Hosted signup ID
20
- #
21
- # @return [String, nil]
22
- optional :id, String
23
-
24
- # @!attribute app_id
25
- # Meta App ID the hosted signup onboards customers into
26
- #
27
- # @return [String, nil]
28
- optional :app_id, String
29
-
30
- # @!attribute created_at
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute expires_at
36
- # When the onboarding URL stops working
37
- #
38
- # @return [Time, nil]
39
- optional :expires_at, Time
40
-
41
- # @!attribute jwt
42
- # Signed token embedded in `url`
43
- #
44
- # @return [String, nil]
45
- optional :jwt, String
46
-
47
- # @!attribute record_type
48
- #
49
- # @return [Symbol, Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data::RecordType, nil]
50
- optional :record_type,
51
- enum: -> { Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data::RecordType }
52
-
53
- # @!attribute solution_id
54
- # Meta Partner Solution ID linked to the app. Returned only when creating a hosted
55
- # signup.
56
- #
57
- # @return [String, nil]
58
- optional :solution_id, String
59
-
60
- # @!attribute url
61
- # Hosted onboarding URL to share with the end customer
62
- #
63
- # @return [String, nil]
64
- optional :url, String
65
-
66
- # @!method initialize(id: nil, app_id: nil, created_at: nil, expires_at: nil, jwt: nil, record_type: nil, solution_id: nil, url: nil)
67
- # Some parameter documentations has been truncated, see
68
- # {Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data} for more details.
69
- #
70
- # @param id [String] Hosted signup ID
71
- #
72
- # @param app_id [String] Meta App ID the hosted signup onboards customers into
73
- #
74
- # @param created_at [Time]
75
- #
76
- # @param expires_at [Time] When the onboarding URL stops working
77
- #
78
- # @param jwt [String] Signed token embedded in `url`
79
- #
80
- # @param record_type [Symbol, Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data::RecordType]
81
- #
82
- # @param solution_id [String] Meta Partner Solution ID linked to the app. Returned only when creating a hosted
83
- #
84
- # @param url [String] Hosted onboarding URL to share with the end customer
85
-
86
- # @see Telnyx::Models::Whatsapp::HostedSignupRetrieveResponse::Data#record_type
87
- module RecordType
88
- extend Telnyx::Internal::Type::Enum
89
-
90
- WHATSAPP_JWT = :whatsapp_jwt
91
-
92
- # @!method self.values
93
- # @return [Array<Symbol>]
94
- end
95
- end
14
+ # @param data [Telnyx::Models::Whatsapp::WhatsappHostedSignup]
96
15
  end
97
16
  end
98
17
  end