telnyx 5.36.0 → 5.36.2

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 (175) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +8 -0
  5. data/lib/telnyx/models/alphanumeric_sender_id_create_params.rb +38 -0
  6. data/lib/telnyx/models/alphanumeric_sender_id_create_response.rb +77 -0
  7. data/lib/telnyx/models/alphanumeric_sender_id_delete_params.rb +14 -0
  8. data/lib/telnyx/models/alphanumeric_sender_id_delete_response.rb +77 -0
  9. data/lib/telnyx/models/alphanumeric_sender_id_list_params.rb +38 -0
  10. data/lib/telnyx/models/alphanumeric_sender_id_list_response.rb +66 -0
  11. data/lib/telnyx/models/alphanumeric_sender_id_retrieve_params.rb +14 -0
  12. data/lib/telnyx/models/alphanumeric_sender_id_retrieve_response.rb +77 -0
  13. data/lib/telnyx/models/message_retrieve_group_messages_params.rb +14 -0
  14. data/lib/telnyx/models/message_retrieve_group_messages_response.rb +16 -0
  15. data/lib/telnyx/models/message_send_with_alphanumeric_sender_params.rb +70 -0
  16. data/lib/telnyx/models/message_send_with_alphanumeric_sender_response.rb +16 -0
  17. data/lib/telnyx/models/messaging_10dlc/brand_update_params.rb +1 -1
  18. data/lib/telnyx/models/messaging_10dlc/partner_campaign_list_params.rb +1 -1
  19. data/lib/telnyx/models/messaging_hosted_number_list_params.rb +71 -0
  20. data/lib/telnyx/models/messaging_hosted_number_retrieve_params.rb +14 -0
  21. data/lib/telnyx/models/messaging_hosted_number_retrieve_response.rb +16 -0
  22. data/lib/telnyx/models/messaging_hosted_number_update_params.rb +49 -0
  23. data/lib/telnyx/models/messaging_hosted_number_update_response.rb +16 -0
  24. data/lib/telnyx/models/messaging_numbers_bulk_update_create_params.rb +9 -1
  25. data/lib/telnyx/models/messaging_profile.rb +25 -1
  26. data/lib/telnyx/models/messaging_profile_create_params.rb +25 -1
  27. data/lib/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rb +26 -0
  28. data/lib/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rb +67 -0
  29. data/lib/telnyx/models/messaging_profile_list_params.rb +17 -1
  30. data/lib/telnyx/models/messaging_profile_metric_list_params.rb +37 -0
  31. data/lib/telnyx/models/messaging_profile_metric_list_response.rb +23 -0
  32. data/lib/telnyx/models/messaging_profile_retrieve_metrics_params.rb +37 -0
  33. data/lib/telnyx/models/messaging_profile_retrieve_metrics_response.rb +17 -0
  34. data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_params.rb +16 -0
  35. data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_response.rb +18 -0
  36. data/lib/telnyx/models/messaging_tollfree/verification/request_list_params.rb +9 -1
  37. data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb +38 -0
  38. data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rb +63 -0
  39. data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +9 -9
  40. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +8 -8
  41. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +8 -8
  42. data/lib/telnyx/models/mobile_phone_numbers/messaging_list_response.rb +17 -1
  43. data/lib/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rb +17 -1
  44. data/lib/telnyx/models/phone_number_with_messaging_settings.rb +17 -1
  45. data/lib/telnyx/models/phone_numbers/messaging_list_params.rb +66 -1
  46. data/lib/telnyx/models/phone_numbers/messaging_update_params.rb +9 -1
  47. data/lib/telnyx/models/verify_profile.rb +79 -2
  48. data/lib/telnyx/models/verify_profile_create_params.rb +83 -8
  49. data/lib/telnyx/models/verify_profile_update_params.rb +77 -2
  50. data/lib/telnyx/models.rb +25 -0
  51. data/lib/telnyx/resources/alphanumeric_sender_ids.rb +111 -0
  52. data/lib/telnyx/resources/messages.rb +54 -0
  53. data/lib/telnyx/resources/messaging_hosted_numbers.rb +91 -0
  54. data/lib/telnyx/resources/messaging_numbers_bulk_updates.rb +3 -1
  55. data/lib/telnyx/resources/messaging_profile_metrics.rb +37 -0
  56. data/lib/telnyx/resources/messaging_profiles/actions.rb +36 -0
  57. data/lib/telnyx/resources/messaging_profiles.rb +74 -3
  58. data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +43 -7
  59. data/lib/telnyx/resources/phone_numbers/messaging.rb +25 -3
  60. data/lib/telnyx/resources/verify_profiles.rb +5 -2
  61. data/lib/telnyx/version.rb +1 -1
  62. data/lib/telnyx.rb +30 -0
  63. data/rbi/telnyx/client.rbi +6 -0
  64. data/rbi/telnyx/models/alphanumeric_sender_id_create_params.rbi +65 -0
  65. data/rbi/telnyx/models/alphanumeric_sender_id_create_response.rbi +178 -0
  66. data/rbi/telnyx/models/alphanumeric_sender_id_delete_params.rbi +30 -0
  67. data/rbi/telnyx/models/alphanumeric_sender_id_delete_response.rbi +178 -0
  68. data/rbi/telnyx/models/alphanumeric_sender_id_list_params.rbi +71 -0
  69. data/rbi/telnyx/models/alphanumeric_sender_id_list_response.rbi +138 -0
  70. data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_params.rbi +30 -0
  71. data/rbi/telnyx/models/alphanumeric_sender_id_retrieve_response.rbi +180 -0
  72. data/rbi/telnyx/models/message_retrieve_group_messages_params.rbi +30 -0
  73. data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +37 -0
  74. data/rbi/telnyx/models/message_send_with_alphanumeric_sender_params.rbi +97 -0
  75. data/rbi/telnyx/models/message_send_with_alphanumeric_sender_response.rbi +33 -0
  76. data/rbi/telnyx/models/messaging_10dlc/partner_campaign_list_params.rbi +2 -2
  77. data/rbi/telnyx/models/messaging_hosted_number_list_params.rbi +148 -0
  78. data/rbi/telnyx/models/messaging_hosted_number_retrieve_params.rbi +30 -0
  79. data/rbi/telnyx/models/messaging_hosted_number_retrieve_response.rbi +37 -0
  80. data/rbi/telnyx/models/messaging_hosted_number_update_params.rbi +87 -0
  81. data/rbi/telnyx/models/messaging_hosted_number_update_response.rbi +37 -0
  82. data/rbi/telnyx/models/messaging_numbers_bulk_update_create_params.rbi +11 -0
  83. data/rbi/telnyx/models/messaging_profile.rbi +27 -0
  84. data/rbi/telnyx/models/messaging_profile_create_params.rbi +24 -0
  85. data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbi +52 -0
  86. data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rbi +138 -0
  87. data/rbi/telnyx/models/messaging_profile_list_params.rbi +22 -0
  88. data/rbi/telnyx/models/messaging_profile_metric_list_params.rbi +114 -0
  89. data/rbi/telnyx/models/messaging_profile_metric_list_response.rbi +47 -0
  90. data/rbi/telnyx/models/messaging_profile_retrieve_metrics_params.rbi +117 -0
  91. data/rbi/telnyx/models/messaging_profile_retrieve_metrics_response.rbi +35 -0
  92. data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_params.rbi +32 -0
  93. data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbi +35 -0
  94. data/rbi/telnyx/models/messaging_tollfree/verification/request_list_params.rbi +11 -0
  95. data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbi +58 -0
  96. data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbi +123 -0
  97. data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +8 -8
  98. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +9 -6
  99. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +9 -6
  100. data/rbi/telnyx/models/mobile_phone_numbers/messaging_list_response.rbi +22 -0
  101. data/rbi/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rbi +22 -0
  102. data/rbi/telnyx/models/phone_number_with_messaging_settings.rbi +22 -0
  103. data/rbi/telnyx/models/phone_numbers/messaging_list_params.rbi +161 -1
  104. data/rbi/telnyx/models/phone_numbers/messaging_update_params.rbi +11 -0
  105. data/rbi/telnyx/models/verify_profile.rbi +131 -4
  106. data/rbi/telnyx/models/verify_profile_create_params.rbi +143 -13
  107. data/rbi/telnyx/models/verify_profile_update_params.rbi +127 -0
  108. data/rbi/telnyx/models.rbi +36 -0
  109. data/rbi/telnyx/resources/alphanumeric_sender_ids.rbi +84 -0
  110. data/rbi/telnyx/resources/messages.rbi +46 -0
  111. data/rbi/telnyx/resources/messaging_hosted_numbers.rbi +77 -0
  112. data/rbi/telnyx/resources/messaging_numbers_bulk_updates.rbi +3 -0
  113. data/rbi/telnyx/resources/messaging_profile_metrics.rbi +28 -0
  114. data/rbi/telnyx/resources/messaging_profiles/actions.rbi +30 -0
  115. data/rbi/telnyx/resources/messaging_profiles.rbi +59 -0
  116. data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +33 -6
  117. data/rbi/telnyx/resources/phone_numbers/messaging.rbi +25 -1
  118. data/rbi/telnyx/resources/verify_profiles.rbi +4 -0
  119. data/sig/telnyx/client.rbs +4 -0
  120. data/sig/telnyx/models/alphanumeric_sender_id_create_params.rbs +38 -0
  121. data/sig/telnyx/models/alphanumeric_sender_id_create_response.rbs +88 -0
  122. data/sig/telnyx/models/alphanumeric_sender_id_delete_params.rbs +15 -0
  123. data/sig/telnyx/models/alphanumeric_sender_id_delete_response.rbs +88 -0
  124. data/sig/telnyx/models/alphanumeric_sender_id_list_params.rbs +42 -0
  125. data/sig/telnyx/models/alphanumeric_sender_id_list_response.rbs +69 -0
  126. data/sig/telnyx/models/alphanumeric_sender_id_retrieve_params.rbs +15 -0
  127. data/sig/telnyx/models/alphanumeric_sender_id_retrieve_response.rbs +88 -0
  128. data/sig/telnyx/models/message_retrieve_group_messages_params.rbs +15 -0
  129. data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +18 -0
  130. data/sig/telnyx/models/message_send_with_alphanumeric_sender_params.rbs +58 -0
  131. data/sig/telnyx/models/message_send_with_alphanumeric_sender_response.rbs +18 -0
  132. data/sig/telnyx/models/messaging_10dlc/partner_campaign_list_params.rbs +2 -2
  133. data/sig/telnyx/models/messaging_hosted_number_list_params.rbs +76 -0
  134. data/sig/telnyx/models/messaging_hosted_number_retrieve_params.rbs +15 -0
  135. data/sig/telnyx/models/messaging_hosted_number_retrieve_response.rbs +18 -0
  136. data/sig/telnyx/models/messaging_hosted_number_update_params.rbs +42 -0
  137. data/sig/telnyx/models/messaging_hosted_number_update_response.rbs +18 -0
  138. data/sig/telnyx/models/messaging_numbers_bulk_update_create_params.rbs +11 -1
  139. data/sig/telnyx/models/messaging_profile.rbs +17 -0
  140. data/sig/telnyx/models/messaging_profile_create_params.rbs +15 -0
  141. data/sig/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbs +32 -0
  142. data/sig/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rbs +69 -0
  143. data/sig/telnyx/models/messaging_profile_list_params.rbs +14 -0
  144. data/sig/telnyx/models/messaging_profile_metric_list_params.rbs +45 -0
  145. data/sig/telnyx/models/messaging_profile_metric_list_response.rbs +31 -0
  146. data/sig/telnyx/models/messaging_profile_retrieve_metrics_params.rbs +45 -0
  147. data/sig/telnyx/models/messaging_profile_retrieve_metrics_response.rbs +16 -0
  148. data/sig/telnyx/models/messaging_profiles/action_regenerate_secret_params.rbs +17 -0
  149. data/sig/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbs +18 -0
  150. data/sig/telnyx/models/messaging_tollfree/verification/request_list_params.rbs +7 -0
  151. data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbs +32 -0
  152. data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbs +56 -0
  153. data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -5
  154. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +7 -5
  155. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +7 -5
  156. data/sig/telnyx/models/mobile_phone_numbers/messaging_list_response.rbs +14 -0
  157. data/sig/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rbs +14 -0
  158. data/sig/telnyx/models/phone_number_with_messaging_settings.rbs +14 -0
  159. data/sig/telnyx/models/phone_numbers/messaging_list_params.rbs +66 -1
  160. data/sig/telnyx/models/phone_numbers/messaging_update_params.rbs +11 -1
  161. data/sig/telnyx/models/verify_profile.rbs +75 -3
  162. data/sig/telnyx/models/verify_profile_create_params.rbs +80 -8
  163. data/sig/telnyx/models/verify_profile_update_params.rbs +70 -0
  164. data/sig/telnyx/models.rbs +24 -0
  165. data/sig/telnyx/resources/alphanumeric_sender_ids.rbs +31 -0
  166. data/sig/telnyx/resources/messages.rbs +16 -0
  167. data/sig/telnyx/resources/messaging_hosted_numbers.rbs +23 -0
  168. data/sig/telnyx/resources/messaging_numbers_bulk_updates.rbs +1 -0
  169. data/sig/telnyx/resources/messaging_profile_metrics.rbs +12 -0
  170. data/sig/telnyx/resources/messaging_profiles/actions.rbs +14 -0
  171. data/sig/telnyx/resources/messaging_profiles.rbs +20 -0
  172. data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +10 -2
  173. data/sig/telnyx/resources/phone_numbers/messaging.rbs +6 -0
  174. data/sig/telnyx/resources/verify_profiles.rbs +2 -0
  175. metadata +92 -2
@@ -27,6 +27,11 @@ module Telnyx
27
27
  # @return [String, nil]
28
28
  optional :language, String
29
29
 
30
+ # @!attribute rcs
31
+ #
32
+ # @return [Telnyx::Models::VerifyProfileCreateParams::Rcs, nil]
33
+ optional :rcs, -> { Telnyx::VerifyProfileCreateParams::Rcs }
34
+
30
35
  # @!attribute sms
31
36
  #
32
37
  # @return [Telnyx::Models::VerifyProfileCreateParams::SMS, nil]
@@ -42,11 +47,12 @@ module Telnyx
42
47
  # @return [String, nil]
43
48
  optional :webhook_url, String
44
49
 
45
- # @!method initialize(name:, call: nil, flashcall: nil, language: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
50
+ # @!method initialize(name:, call: nil, flashcall: nil, language: nil, rcs: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
46
51
  # @param name [String]
47
52
  # @param call [Telnyx::Models::VerifyProfileCreateParams::Call]
48
53
  # @param flashcall [Telnyx::Models::VerifyProfileCreateParams::Flashcall]
49
54
  # @param language [String]
55
+ # @param rcs [Telnyx::Models::VerifyProfileCreateParams::Rcs]
50
56
  # @param sms [Telnyx::Models::VerifyProfileCreateParams::SMS]
51
57
  # @param webhook_failover_url [String]
52
58
  # @param webhook_url [String]
@@ -105,6 +111,13 @@ module Telnyx
105
111
  end
106
112
 
107
113
  class Flashcall < Telnyx::Internal::Type::BaseModel
114
+ # @!attribute app_name
115
+ # The name that identifies the application requesting 2fa in the verification
116
+ # message.
117
+ #
118
+ # @return [String, nil]
119
+ optional :app_name, String
120
+
108
121
  # @!attribute default_verification_timeout_secs
109
122
  # For every request that is initiated via this Verify profile, this sets the
110
123
  # number of seconds before a verification request code expires. Once the
@@ -122,24 +135,78 @@ module Telnyx
122
135
  # @return [Array<String>, nil]
123
136
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
124
137
 
125
- # @!method initialize(default_verification_timeout_secs: nil, whitelisted_destinations: nil)
138
+ # @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
126
139
  # Some parameter documentations has been truncated, see
127
140
  # {Telnyx::Models::VerifyProfileCreateParams::Flashcall} for more details.
128
141
  #
142
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
143
+ #
129
144
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
130
145
  #
131
146
  # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
132
147
  end
133
148
 
134
- class SMS < Telnyx::Internal::Type::BaseModel
149
+ class Rcs < Telnyx::Internal::Type::BaseModel
150
+ # @!attribute app_name
151
+ # The name that identifies the application requesting 2fa in the verification
152
+ # message.
153
+ #
154
+ # @return [String, nil]
155
+ optional :app_name, String
156
+
157
+ # @!attribute code_length
158
+ # The length of the verify code to generate.
159
+ #
160
+ # @return [Integer, nil]
161
+ optional :code_length, Integer
162
+
163
+ # @!attribute default_verification_timeout_secs
164
+ # For every request that is initiated via this Verify profile, this sets the
165
+ # number of seconds before a verification request code expires. Once the
166
+ # verification request expires, the user cannot use the code to verify their
167
+ # identity.
168
+ #
169
+ # @return [Integer, nil]
170
+ optional :default_verification_timeout_secs, Integer
171
+
172
+ # @!attribute messaging_template_id
173
+ # The message template identifier selected from /verify_profiles/templates
174
+ #
175
+ # @return [String, nil]
176
+ optional :messaging_template_id, String
177
+
178
+ # @!attribute sms_fallback
179
+ # Enable SMS fallback when RCS delivery fails.
180
+ #
181
+ # @return [Boolean, nil]
182
+ optional :sms_fallback, Telnyx::Internal::Type::Boolean
183
+
135
184
  # @!attribute whitelisted_destinations
136
185
  # Enabled country destinations to send verification codes. The elements in the
137
186
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
138
187
  # destinations will be allowed.
139
188
  #
140
- # @return [Array<String>]
141
- required :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
189
+ # @return [Array<String>, nil]
190
+ optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
142
191
 
192
+ # @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
193
+ # Some parameter documentations has been truncated, see
194
+ # {Telnyx::Models::VerifyProfileCreateParams::Rcs} for more details.
195
+ #
196
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
197
+ #
198
+ # @param code_length [Integer] The length of the verify code to generate.
199
+ #
200
+ # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
201
+ #
202
+ # @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
203
+ #
204
+ # @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
205
+ #
206
+ # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
207
+ end
208
+
209
+ class SMS < Telnyx::Internal::Type::BaseModel
143
210
  # @!attribute alpha_sender
144
211
  # The alphanumeric sender ID to use when sending to destinations that require an
145
212
  # alphanumeric sender ID.
@@ -175,12 +242,18 @@ module Telnyx
175
242
  # @return [String, nil]
176
243
  optional :messaging_template_id, String
177
244
 
178
- # @!method initialize(whitelisted_destinations:, alpha_sender: nil, app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil)
245
+ # @!attribute whitelisted_destinations
246
+ # Enabled country destinations to send verification codes. The elements in the
247
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
248
+ # destinations will be allowed.
249
+ #
250
+ # @return [Array<String>, nil]
251
+ optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
252
+
253
+ # @!method initialize(alpha_sender: nil, app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, whitelisted_destinations: nil)
179
254
  # Some parameter documentations has been truncated, see
180
255
  # {Telnyx::Models::VerifyProfileCreateParams::SMS} for more details.
181
256
  #
182
- # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
183
- #
184
257
  # @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
185
258
  #
186
259
  # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
@@ -190,6 +263,8 @@ module Telnyx
190
263
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
191
264
  #
192
265
  # @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
266
+ #
267
+ # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
193
268
  end
194
269
  end
195
270
  end
@@ -27,6 +27,11 @@ module Telnyx
27
27
  # @return [String, nil]
28
28
  optional :name, String
29
29
 
30
+ # @!attribute rcs
31
+ #
32
+ # @return [Telnyx::Models::VerifyProfileUpdateParams::Rcs, nil]
33
+ optional :rcs, -> { Telnyx::VerifyProfileUpdateParams::Rcs }
34
+
30
35
  # @!attribute sms
31
36
  #
32
37
  # @return [Telnyx::Models::VerifyProfileUpdateParams::SMS, nil]
@@ -42,11 +47,12 @@ module Telnyx
42
47
  # @return [String, nil]
43
48
  optional :webhook_url, String
44
49
 
45
- # @!method initialize(call: nil, flashcall: nil, language: nil, name: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
50
+ # @!method initialize(call: nil, flashcall: nil, language: nil, name: nil, rcs: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
46
51
  # @param call [Telnyx::Models::VerifyProfileUpdateParams::Call]
47
52
  # @param flashcall [Telnyx::Models::VerifyProfileUpdateParams::Flashcall]
48
53
  # @param language [String]
49
54
  # @param name [String]
55
+ # @param rcs [Telnyx::Models::VerifyProfileUpdateParams::Rcs]
50
56
  # @param sms [Telnyx::Models::VerifyProfileUpdateParams::SMS]
51
57
  # @param webhook_failover_url [String]
52
58
  # @param webhook_url [String]
@@ -105,6 +111,13 @@ module Telnyx
105
111
  end
106
112
 
107
113
  class Flashcall < Telnyx::Internal::Type::BaseModel
114
+ # @!attribute app_name
115
+ # The name that identifies the application requesting 2fa in the verification
116
+ # message.
117
+ #
118
+ # @return [String, nil]
119
+ optional :app_name, String
120
+
108
121
  # @!attribute default_verification_timeout_secs
109
122
  # For every request that is initiated via this Verify profile, this sets the
110
123
  # number of seconds before a verification request code expires. Once the
@@ -122,15 +135,77 @@ module Telnyx
122
135
  # @return [Array<String>, nil]
123
136
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
124
137
 
125
- # @!method initialize(default_verification_timeout_secs: nil, whitelisted_destinations: nil)
138
+ # @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
126
139
  # Some parameter documentations has been truncated, see
127
140
  # {Telnyx::Models::VerifyProfileUpdateParams::Flashcall} for more details.
128
141
  #
142
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
143
+ #
129
144
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
130
145
  #
131
146
  # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
132
147
  end
133
148
 
149
+ class Rcs < Telnyx::Internal::Type::BaseModel
150
+ # @!attribute app_name
151
+ # The name that identifies the application requesting 2fa in the verification
152
+ # message.
153
+ #
154
+ # @return [String, nil]
155
+ optional :app_name, String
156
+
157
+ # @!attribute code_length
158
+ # The length of the verify code to generate.
159
+ #
160
+ # @return [Integer, nil]
161
+ optional :code_length, Integer
162
+
163
+ # @!attribute default_verification_timeout_secs
164
+ # For every request that is initiated via this Verify profile, this sets the
165
+ # number of seconds before a verification request code expires. Once the
166
+ # verification request expires, the user cannot use the code to verify their
167
+ # identity.
168
+ #
169
+ # @return [Integer, nil]
170
+ optional :default_verification_timeout_secs, Integer
171
+
172
+ # @!attribute messaging_template_id
173
+ # The message template identifier selected from /verify_profiles/templates
174
+ #
175
+ # @return [String, nil]
176
+ optional :messaging_template_id, String
177
+
178
+ # @!attribute sms_fallback
179
+ # Enable SMS fallback when RCS delivery fails.
180
+ #
181
+ # @return [Boolean, nil]
182
+ optional :sms_fallback, Telnyx::Internal::Type::Boolean
183
+
184
+ # @!attribute whitelisted_destinations
185
+ # Enabled country destinations to send verification codes. The elements in the
186
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
187
+ # destinations will be allowed.
188
+ #
189
+ # @return [Array<String>, nil]
190
+ optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
191
+
192
+ # @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
193
+ # Some parameter documentations has been truncated, see
194
+ # {Telnyx::Models::VerifyProfileUpdateParams::Rcs} for more details.
195
+ #
196
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
197
+ #
198
+ # @param code_length [Integer] The length of the verify code to generate.
199
+ #
200
+ # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
201
+ #
202
+ # @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
203
+ #
204
+ # @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
205
+ #
206
+ # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
207
+ end
208
+
134
209
  class SMS < Telnyx::Internal::Type::BaseModel
135
210
  # @!attribute alpha_sender
136
211
  # The alphanumeric sender ID to use when sending to destinations that require an
data/lib/telnyx/models.rb CHANGED
@@ -87,6 +87,14 @@ module Telnyx
87
87
 
88
88
  AISummarizeParams = Telnyx::Models::AISummarizeParams
89
89
 
90
+ AlphanumericSenderIDCreateParams = Telnyx::Models::AlphanumericSenderIDCreateParams
91
+
92
+ AlphanumericSenderIDDeleteParams = Telnyx::Models::AlphanumericSenderIDDeleteParams
93
+
94
+ AlphanumericSenderIDListParams = Telnyx::Models::AlphanumericSenderIDListParams
95
+
96
+ AlphanumericSenderIDRetrieveParams = Telnyx::Models::AlphanumericSenderIDRetrieveParams
97
+
90
98
  AnchorsiteOverride = Telnyx::Models::AnchorsiteOverride
91
99
 
92
100
  APIError = Telnyx::Models::APIError
@@ -750,6 +758,8 @@ module Telnyx
750
758
 
751
759
  MessageCancelScheduledParams = Telnyx::Models::MessageCancelScheduledParams
752
760
 
761
+ MessageRetrieveGroupMessagesParams = Telnyx::Models::MessageRetrieveGroupMessagesParams
762
+
753
763
  MessageRetrieveParams = Telnyx::Models::MessageRetrieveParams
754
764
 
755
765
  Messages = Telnyx::Models::Messages
@@ -768,6 +778,8 @@ module Telnyx
768
778
 
769
779
  MessageSendWhatsappParams = Telnyx::Models::MessageSendWhatsappParams
770
780
 
781
+ MessageSendWithAlphanumericSenderParams = Telnyx::Models::MessageSendWithAlphanumericSenderParams
782
+
771
783
  MessageTemplate = Telnyx::Models::MessageTemplate
772
784
 
773
785
  Messaging = Telnyx::Models::Messaging
@@ -782,6 +794,8 @@ module Telnyx
782
794
 
783
795
  MessagingHostedNumberDeleteParams = Telnyx::Models::MessagingHostedNumberDeleteParams
784
796
 
797
+ MessagingHostedNumberListParams = Telnyx::Models::MessagingHostedNumberListParams
798
+
785
799
  MessagingHostedNumberOrder = Telnyx::Models::MessagingHostedNumberOrder
786
800
 
787
801
  MessagingHostedNumberOrderCheckEligibilityParams =
@@ -803,6 +817,10 @@ module Telnyx
803
817
  MessagingHostedNumberOrderValidateCodesParams =
804
818
  Telnyx::Models::MessagingHostedNumberOrderValidateCodesParams
805
819
 
820
+ MessagingHostedNumberRetrieveParams = Telnyx::Models::MessagingHostedNumberRetrieveParams
821
+
822
+ MessagingHostedNumberUpdateParams = Telnyx::Models::MessagingHostedNumberUpdateParams
823
+
806
824
  MessagingNumbersBulkUpdateCreateParams = Telnyx::Models::MessagingNumbersBulkUpdateCreateParams
807
825
 
808
826
  MessagingNumbersBulkUpdateRetrieveParams = Telnyx::Models::MessagingNumbersBulkUpdateRetrieveParams
@@ -817,12 +835,19 @@ module Telnyx
817
835
 
818
836
  MessagingProfileDeleteParams = Telnyx::Models::MessagingProfileDeleteParams
819
837
 
838
+ MessagingProfileListAlphanumericSenderIDsParams =
839
+ Telnyx::Models::MessagingProfileListAlphanumericSenderIDsParams
840
+
820
841
  MessagingProfileListParams = Telnyx::Models::MessagingProfileListParams
821
842
 
822
843
  MessagingProfileListPhoneNumbersParams = Telnyx::Models::MessagingProfileListPhoneNumbersParams
823
844
 
824
845
  MessagingProfileListShortCodesParams = Telnyx::Models::MessagingProfileListShortCodesParams
825
846
 
847
+ MessagingProfileMetricListParams = Telnyx::Models::MessagingProfileMetricListParams
848
+
849
+ MessagingProfileRetrieveMetricsParams = Telnyx::Models::MessagingProfileRetrieveMetricsParams
850
+
826
851
  MessagingProfileRetrieveParams = Telnyx::Models::MessagingProfileRetrieveParams
827
852
 
828
853
  MessagingProfiles = Telnyx::Models::MessagingProfiles
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class AlphanumericSenderIDs
6
+ # Create a new alphanumeric sender ID associated with a messaging profile.
7
+ #
8
+ # @overload create(alphanumeric_sender_id:, messaging_profile_id:, us_long_code_fallback: nil, request_options: {})
9
+ #
10
+ # @param alphanumeric_sender_id [String] The alphanumeric sender ID string.
11
+ #
12
+ # @param messaging_profile_id [String] The messaging profile to associate the sender ID with.
13
+ #
14
+ # @param us_long_code_fallback [String] A US long code number to use as fallback when sending to US destinations.
15
+ #
16
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
17
+ #
18
+ # @return [Telnyx::Models::AlphanumericSenderIDCreateResponse]
19
+ #
20
+ # @see Telnyx::Models::AlphanumericSenderIDCreateParams
21
+ def create(params)
22
+ parsed, options = Telnyx::AlphanumericSenderIDCreateParams.dump_request(params)
23
+ @client.request(
24
+ method: :post,
25
+ path: "alphanumeric_sender_ids",
26
+ body: parsed,
27
+ model: Telnyx::Models::AlphanumericSenderIDCreateResponse,
28
+ options: options
29
+ )
30
+ end
31
+
32
+ # Retrieve a specific alphanumeric sender ID.
33
+ #
34
+ # @overload retrieve(id, request_options: {})
35
+ #
36
+ # @param id [String] The identifier of the alphanumeric sender ID.
37
+ #
38
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
39
+ #
40
+ # @return [Telnyx::Models::AlphanumericSenderIDRetrieveResponse]
41
+ #
42
+ # @see Telnyx::Models::AlphanumericSenderIDRetrieveParams
43
+ def retrieve(id, params = {})
44
+ @client.request(
45
+ method: :get,
46
+ path: ["alphanumeric_sender_ids/%1$s", id],
47
+ model: Telnyx::Models::AlphanumericSenderIDRetrieveResponse,
48
+ options: params[:request_options]
49
+ )
50
+ end
51
+
52
+ # List all alphanumeric sender IDs for the authenticated user.
53
+ #
54
+ # @overload list(filter_messaging_profile_id: nil, page_number: nil, page_size: nil, request_options: {})
55
+ #
56
+ # @param filter_messaging_profile_id [String] Filter by messaging profile ID.
57
+ #
58
+ # @param page_number [Integer] Page number.
59
+ #
60
+ # @param page_size [Integer] Page size.
61
+ #
62
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
63
+ #
64
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AlphanumericSenderIDListResponse>]
65
+ #
66
+ # @see Telnyx::Models::AlphanumericSenderIDListParams
67
+ def list(params = {})
68
+ parsed, options = Telnyx::AlphanumericSenderIDListParams.dump_request(params)
69
+ @client.request(
70
+ method: :get,
71
+ path: "alphanumeric_sender_ids",
72
+ query: parsed.transform_keys(
73
+ filter_messaging_profile_id: "filter[messaging_profile_id]",
74
+ page_number: "page[number]",
75
+ page_size: "page[size]"
76
+ ),
77
+ page: Telnyx::Internal::DefaultFlatPagination,
78
+ model: Telnyx::Models::AlphanumericSenderIDListResponse,
79
+ options: options
80
+ )
81
+ end
82
+
83
+ # Delete an alphanumeric sender ID and disassociate it from its messaging profile.
84
+ #
85
+ # @overload delete(id, request_options: {})
86
+ #
87
+ # @param id [String] The identifier of the alphanumeric sender ID.
88
+ #
89
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
90
+ #
91
+ # @return [Telnyx::Models::AlphanumericSenderIDDeleteResponse]
92
+ #
93
+ # @see Telnyx::Models::AlphanumericSenderIDDeleteParams
94
+ def delete(id, params = {})
95
+ @client.request(
96
+ method: :delete,
97
+ path: ["alphanumeric_sender_ids/%1$s", id],
98
+ model: Telnyx::Models::AlphanumericSenderIDDeleteResponse,
99
+ options: params[:request_options]
100
+ )
101
+ end
102
+
103
+ # @api private
104
+ #
105
+ # @param client [Telnyx::Client]
106
+ def initialize(client:)
107
+ @client = client
108
+ end
109
+ end
110
+ end
111
+ end
@@ -50,6 +50,26 @@ module Telnyx
50
50
  )
51
51
  end
52
52
 
53
+ # Retrieve all messages in a group MMS conversation by the group message ID.
54
+ #
55
+ # @overload retrieve_group_messages(message_id, request_options: {})
56
+ #
57
+ # @param message_id [String] The group message ID.
58
+ #
59
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
60
+ #
61
+ # @return [Telnyx::Models::MessageRetrieveGroupMessagesResponse]
62
+ #
63
+ # @see Telnyx::Models::MessageRetrieveGroupMessagesParams
64
+ def retrieve_group_messages(message_id, params = {})
65
+ @client.request(
66
+ method: :get,
67
+ path: ["messages/group/%1$s", message_id],
68
+ model: Telnyx::Models::MessageRetrieveGroupMessagesResponse,
69
+ options: params[:request_options]
70
+ )
71
+ end
72
+
53
73
  # Some parameter documentations has been truncated, see
54
74
  # {Telnyx::Models::MessageScheduleParams} for more details.
55
75
  #
@@ -360,6 +380,40 @@ module Telnyx
360
380
  )
361
381
  end
362
382
 
383
+ # Send an SMS message using an alphanumeric sender ID. This is SMS only.
384
+ #
385
+ # @overload send_with_alphanumeric_sender(from:, messaging_profile_id:, text:, to:, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
386
+ #
387
+ # @param from [String] A valid alphanumeric sender ID on the user's account.
388
+ #
389
+ # @param messaging_profile_id [String] The messaging profile ID to use.
390
+ #
391
+ # @param text [String] The message body.
392
+ #
393
+ # @param to [String] Receiving address (+E.164 formatted phone number).
394
+ #
395
+ # @param use_profile_webhooks [Boolean] If true, use the messaging profile's webhook settings.
396
+ #
397
+ # @param webhook_failover_url [String, nil] Failover callback URL for delivery status updates.
398
+ #
399
+ # @param webhook_url [String, nil] Callback URL for delivery status updates.
400
+ #
401
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
402
+ #
403
+ # @return [Telnyx::Models::MessageSendWithAlphanumericSenderResponse]
404
+ #
405
+ # @see Telnyx::Models::MessageSendWithAlphanumericSenderParams
406
+ def send_with_alphanumeric_sender(params)
407
+ parsed, options = Telnyx::MessageSendWithAlphanumericSenderParams.dump_request(params)
408
+ @client.request(
409
+ method: :post,
410
+ path: "messages/alphanumeric_sender_id",
411
+ body: parsed,
412
+ model: Telnyx::Models::MessageSendWithAlphanumericSenderResponse,
413
+ options: options
414
+ )
415
+ end
416
+
363
417
  # @api private
364
418
  #
365
419
  # @param client [Telnyx::Client]
@@ -3,6 +3,97 @@
3
3
  module Telnyx
4
4
  module Resources
5
5
  class MessagingHostedNumbers
6
+ # Retrieve a specific messaging hosted number by its ID or phone number.
7
+ #
8
+ # @overload retrieve(id, request_options: {})
9
+ #
10
+ # @param id [String] The ID or phone number of the hosted number.
11
+ #
12
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
13
+ #
14
+ # @return [Telnyx::Models::MessagingHostedNumberRetrieveResponse]
15
+ #
16
+ # @see Telnyx::Models::MessagingHostedNumberRetrieveParams
17
+ def retrieve(id, params = {})
18
+ @client.request(
19
+ method: :get,
20
+ path: ["messaging_hosted_numbers/%1$s", id],
21
+ model: Telnyx::Models::MessagingHostedNumberRetrieveResponse,
22
+ options: params[:request_options]
23
+ )
24
+ end
25
+
26
+ # Some parameter documentations has been truncated, see
27
+ # {Telnyx::Models::MessagingHostedNumberUpdateParams} for more details.
28
+ #
29
+ # Update the messaging settings for a hosted number.
30
+ #
31
+ # @overload update(id, messaging_product: nil, messaging_profile_id: nil, tags: nil, request_options: {})
32
+ #
33
+ # @param id [String] The ID or phone number of the hosted number.
34
+ #
35
+ # @param messaging_product [String] Configure the messaging product for this number:
36
+ #
37
+ # @param messaging_profile_id [String] Configure the messaging profile this phone number is assigned to:
38
+ #
39
+ # @param tags [Array<String>] Tags to set on this phone number.
40
+ #
41
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
42
+ #
43
+ # @return [Telnyx::Models::MessagingHostedNumberUpdateResponse]
44
+ #
45
+ # @see Telnyx::Models::MessagingHostedNumberUpdateParams
46
+ def update(id, params = {})
47
+ parsed, options = Telnyx::MessagingHostedNumberUpdateParams.dump_request(params)
48
+ @client.request(
49
+ method: :patch,
50
+ path: ["messaging_hosted_numbers/%1$s", id],
51
+ body: parsed,
52
+ model: Telnyx::Models::MessagingHostedNumberUpdateResponse,
53
+ options: options
54
+ )
55
+ end
56
+
57
+ # List all hosted numbers associated with the authenticated user.
58
+ #
59
+ # @overload list(filter_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {})
60
+ #
61
+ # @param filter_messaging_profile_id [String] Filter by messaging profile ID.
62
+ #
63
+ # @param filter_phone_number [String] Filter by exact phone number.
64
+ #
65
+ # @param filter_phone_number_contains [String] Filter by phone number substring.
66
+ #
67
+ # @param page_number [Integer]
68
+ #
69
+ # @param page_size [Integer]
70
+ #
71
+ # @param sort_phone_number [Symbol, Telnyx::Models::MessagingHostedNumberListParams::SortPhoneNumber] Sort by phone number.
72
+ #
73
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
74
+ #
75
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PhoneNumberWithMessagingSettings>]
76
+ #
77
+ # @see Telnyx::Models::MessagingHostedNumberListParams
78
+ def list(params = {})
79
+ parsed, options = Telnyx::MessagingHostedNumberListParams.dump_request(params)
80
+ @client.request(
81
+ method: :get,
82
+ path: "messaging_hosted_numbers",
83
+ query: parsed.transform_keys(
84
+ filter_messaging_profile_id: "filter[messaging_profile_id]",
85
+ filter_phone_number: "filter[phone_number]",
86
+ filter_phone_number_contains: "filter[phone_number][contains]",
87
+ page_number: "page[number]",
88
+ page_size: "page[size]",
89
+ sort_phone_number: "sort[phone_number]"
90
+ ),
91
+ page: Telnyx::Internal::DefaultFlatPagination,
92
+ model: Telnyx::PhoneNumberWithMessagingSettings,
93
+ options: options
94
+ )
95
+ end
96
+
6
97
  # Delete a messaging hosted number
7
98
  #
8
99
  # @overload delete(id, request_options: {})
@@ -8,12 +8,14 @@ module Telnyx
8
8
  #
9
9
  # Bulk update phone number profiles
10
10
  #
11
- # @overload create(messaging_profile_id:, numbers:, request_options: {})
11
+ # @overload create(messaging_profile_id:, numbers:, assign_only: nil, request_options: {})
12
12
  #
13
13
  # @param messaging_profile_id [String] Configure the messaging profile these phone numbers are assigned to:
14
14
  #
15
15
  # @param numbers [Array<String>] The list of phone numbers to update.
16
16
  #
17
+ # @param assign_only [Boolean] If true, only assign numbers to the profile without changing other settings.
18
+ #
17
19
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
18
20
  #
19
21
  # @return [Telnyx::Models::MessagingNumbersBulkUpdateCreateResponse]
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class MessagingProfileMetrics
6
+ # List high-level metrics for all messaging profiles belonging to the
7
+ # authenticated user.
8
+ #
9
+ # @overload list(time_frame: nil, request_options: {})
10
+ #
11
+ # @param time_frame [Symbol, Telnyx::Models::MessagingProfileMetricListParams::TimeFrame] The time frame for metrics.
12
+ #
13
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
14
+ #
15
+ # @return [Telnyx::Models::MessagingProfileMetricListResponse]
16
+ #
17
+ # @see Telnyx::Models::MessagingProfileMetricListParams
18
+ def list(params = {})
19
+ parsed, options = Telnyx::MessagingProfileMetricListParams.dump_request(params)
20
+ @client.request(
21
+ method: :get,
22
+ path: "messaging_profile_metrics",
23
+ query: parsed,
24
+ model: Telnyx::Models::MessagingProfileMetricListResponse,
25
+ options: options
26
+ )
27
+ end
28
+
29
+ # @api private
30
+ #
31
+ # @param client [Telnyx::Client]
32
+ def initialize(client:)
33
+ @client = client
34
+ end
35
+ end
36
+ end
37
+ end