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
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MessagingTollfree
6
+ module Verification
7
+ # @see Telnyx::Resources::MessagingTollfree::Verification::Requests#retrieve_status_history
8
+ class RequestRetrieveStatusHistoryParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute page_number
13
+ #
14
+ # @return [Integer]
15
+ required :page_number, Integer
16
+
17
+ # @!attribute page_size
18
+ # Request this many records per page. This value is automatically clamped if the
19
+ # provided value is too large.
20
+ #
21
+ # @return [Integer]
22
+ required :page_size, Integer
23
+
24
+ # @!method initialize(page_number:, page_size:, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams}
27
+ # for more details.
28
+ #
29
+ # @param page_number [Integer]
30
+ #
31
+ # @param page_size [Integer] Request this many records per page. This value is automatically clamped if the p
32
+ #
33
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MessagingTollfree
6
+ module Verification
7
+ # @see Telnyx::Resources::MessagingTollfree::Verification::Requests#retrieve_status_history
8
+ class RequestRetrieveStatusHistoryResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute records
10
+ # The records yielded by this request
11
+ #
12
+ # @return [Array<Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record>]
13
+ required :records,
14
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record] }
15
+
16
+ # @!attribute total_records
17
+ # The total amount of records for these query parameters
18
+ #
19
+ # @return [Integer]
20
+ required :total_records, Integer
21
+
22
+ # @!method initialize(records:, total_records:)
23
+ # A paginated response
24
+ #
25
+ # @param records [Array<Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record>] The records yielded by this request
26
+ #
27
+ # @param total_records [Integer] The total amount of records for these query parameters
28
+
29
+ class Record < Telnyx::Internal::Type::BaseModel
30
+ # @!attribute updated_at
31
+ # The timestamp at which this status change occurred
32
+ #
33
+ # @return [Time]
34
+ required :updated_at, Time, api_name: :updatedAt
35
+
36
+ # @!attribute verification_status
37
+ # Tollfree verification status
38
+ #
39
+ # @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus]
40
+ required :verification_status,
41
+ enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus },
42
+ api_name: :verificationStatus
43
+
44
+ # @!attribute reason
45
+ # An explanation of why this request has its current status.
46
+ #
47
+ # @return [String, nil]
48
+ optional :reason, String, nil?: true
49
+
50
+ # @!method initialize(updated_at:, verification_status:, reason: nil)
51
+ # A single entry in the verification request status history
52
+ #
53
+ # @param updated_at [Time] The timestamp at which this status change occurred
54
+ #
55
+ # @param verification_status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Tollfree verification status
56
+ #
57
+ # @param reason [String, nil] An explanation of why this request has its current status.
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
63
+ end
@@ -74,12 +74,6 @@ module Telnyx
74
74
  # @return [String]
75
75
  required :corporate_website, String, api_name: :corporateWebsite
76
76
 
77
- # @!attribute isv_reseller
78
- # ISV name
79
- #
80
- # @return [String]
81
- required :isv_reseller, String, api_name: :isvReseller
82
-
83
77
  # @!attribute message_volume
84
78
  # Message Volume Enums
85
79
  #
@@ -199,6 +193,12 @@ module Telnyx
199
193
  # @return [String, nil]
200
194
  optional :help_message_response, String, api_name: :helpMessageResponse, nil?: true
201
195
 
196
+ # @!attribute isv_reseller
197
+ # ISV name
198
+ #
199
+ # @return [String, nil]
200
+ optional :isv_reseller, String, api_name: :isvReseller, nil?: true
201
+
202
202
  # @!attribute opt_in_confirmation_response
203
203
  # Message sent to users confirming their opt-in to receive messages
204
204
  #
@@ -231,7 +231,7 @@ module Telnyx
231
231
  # @return [String, nil]
232
232
  optional :webhook_url, String, api_name: :webhookUrl
233
233
 
234
- # @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil)
234
+ # @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil)
235
235
  # Some parameter documentations has been truncated, see
236
236
  # {Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest} for
237
237
  # more details.
@@ -260,8 +260,6 @@ module Telnyx
260
260
  #
261
261
  # @param corporate_website [String] A URL, including the scheme, pointing to the corporate website
262
262
  #
263
- # @param isv_reseller [String] ISV name
264
- #
265
263
  # @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
266
264
  #
267
265
  # @param opt_in_workflow [String] Human-readable description of how end users will opt into receiving messages fro
@@ -294,6 +292,8 @@ module Telnyx
294
292
  #
295
293
  # @param help_message_response [String, nil] The message returned when users text 'HELP'
296
294
  #
295
+ # @param isv_reseller [String, nil] ISV name
296
+ #
297
297
  # @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
298
298
  #
299
299
  # @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
@@ -66,11 +66,6 @@ module Telnyx
66
66
  # @return [String]
67
67
  required :corporate_website, String, api_name: :corporateWebsite
68
68
 
69
- # @!attribute isv_reseller
70
- #
71
- # @return [String]
72
- required :isv_reseller, String, api_name: :isvReseller
73
-
74
69
  # @!attribute message_volume
75
70
  # Message Volume Enums
76
71
  #
@@ -176,6 +171,11 @@ module Telnyx
176
171
  # @return [String, nil]
177
172
  optional :help_message_response, String, api_name: :helpMessageResponse
178
173
 
174
+ # @!attribute isv_reseller
175
+ #
176
+ # @return [String, nil]
177
+ optional :isv_reseller, String, api_name: :isvReseller
178
+
179
179
  # @!attribute opt_in_confirmation_response
180
180
  #
181
181
  # @return [String, nil]
@@ -209,7 +209,7 @@ module Telnyx
209
209
  # @return [String, nil]
210
210
  optional :webhook_url, String, api_name: :webhookUrl
211
211
 
212
- # @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_request_id:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, verification_status: nil, webhook_url: nil)
212
+ # @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_request_id:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, verification_status: nil, webhook_url: nil)
213
213
  # Some parameter documentations has been truncated, see
214
214
  # {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress} for
215
215
  # more details.
@@ -240,8 +240,6 @@ module Telnyx
240
240
  #
241
241
  # @param corporate_website [String]
242
242
  #
243
- # @param isv_reseller [String]
244
- #
245
243
  # @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
246
244
  #
247
245
  # @param opt_in_workflow [String]
@@ -276,6 +274,8 @@ module Telnyx
276
274
  #
277
275
  # @param help_message_response [String]
278
276
  #
277
+ # @param isv_reseller [String]
278
+ #
279
279
  # @param opt_in_confirmation_response [String]
280
280
  #
281
281
  # @param opt_in_keywords [String]
@@ -66,11 +66,6 @@ module Telnyx
66
66
  # @return [String]
67
67
  required :corporate_website, String, api_name: :corporateWebsite
68
68
 
69
- # @!attribute isv_reseller
70
- #
71
- # @return [String]
72
- required :isv_reseller, String, api_name: :isvReseller
73
-
74
69
  # @!attribute message_volume
75
70
  # Message Volume Enums
76
71
  #
@@ -184,6 +179,11 @@ module Telnyx
184
179
  # @return [String, nil]
185
180
  optional :help_message_response, String, api_name: :helpMessageResponse
186
181
 
182
+ # @!attribute isv_reseller
183
+ #
184
+ # @return [String, nil]
185
+ optional :isv_reseller, String, api_name: :isvReseller
186
+
187
187
  # @!attribute opt_in_confirmation_response
188
188
  #
189
189
  # @return [String, nil]
@@ -219,7 +219,7 @@ module Telnyx
219
219
  # @return [String, nil]
220
220
  optional :webhook_url, String, api_name: :webhookUrl
221
221
 
222
- # @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil)
222
+ # @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil)
223
223
  # Some parameter documentations has been truncated, see
224
224
  # {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus} for
225
225
  # more details.
@@ -250,8 +250,6 @@ module Telnyx
250
250
  #
251
251
  # @param corporate_website [String]
252
252
  #
253
- # @param isv_reseller [String]
254
- #
255
253
  # @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
256
254
  #
257
255
  # @param opt_in_workflow [String]
@@ -288,6 +286,8 @@ module Telnyx
288
286
  #
289
287
  # @param help_message_response [String]
290
288
  #
289
+ # @param isv_reseller [String]
290
+ #
291
291
  # @param opt_in_confirmation_response [String]
292
292
  #
293
293
  # @param opt_in_keywords [String]
@@ -17,6 +17,18 @@ module Telnyx
17
17
  # @return [String, nil]
18
18
  optional :messaging_profile_id, String, nil?: true
19
19
 
20
+ # @!attribute organization_id
21
+ # The organization that owns this phone number.
22
+ #
23
+ # @return [String, nil]
24
+ optional :organization_id, String
25
+
26
+ # @!attribute tags
27
+ # Tags associated with this phone number.
28
+ #
29
+ # @return [Array<String>, nil]
30
+ optional :tags, Telnyx::Internal::Type::ArrayOf[String]
31
+
20
32
  response_only do
21
33
  # @!attribute id
22
34
  # Identifies the type of resource.
@@ -72,7 +84,7 @@ module Telnyx
72
84
  optional :updated_at, Time
73
85
  end
74
86
 
75
- # @!method initialize(id: nil, country_code: nil, created_at: nil, features: nil, messaging_product: nil, messaging_profile_id: nil, phone_number: nil, record_type: nil, traffic_type: nil, type: nil, updated_at: nil)
87
+ # @!method initialize(id: nil, country_code: nil, created_at: nil, features: nil, messaging_product: nil, messaging_profile_id: nil, organization_id: nil, phone_number: nil, record_type: nil, tags: nil, traffic_type: nil, type: nil, updated_at: nil)
76
88
  # @param id [String] Identifies the type of resource.
77
89
  #
78
90
  # @param country_code [String] ISO 3166-1 alpha-2 country code.
@@ -85,10 +97,14 @@ module Telnyx
85
97
  #
86
98
  # @param messaging_profile_id [String, nil] Unique identifier for a messaging profile.
87
99
  #
100
+ # @param organization_id [String] The organization that owns this phone number.
101
+ #
88
102
  # @param phone_number [String] +E.164 formatted phone number.
89
103
  #
90
104
  # @param record_type [Symbol, Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::RecordType] Identifies the type of the resource.
91
105
  #
106
+ # @param tags [Array<String>] Tags associated with this phone number.
107
+ #
92
108
  # @param traffic_type [String] The messaging traffic or use case for which the number is currently configured.
93
109
  #
94
110
  # @param type [Symbol, Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::Type] The type of the phone number
@@ -27,6 +27,18 @@ module Telnyx
27
27
  # @return [String, nil]
28
28
  optional :messaging_profile_id, String, nil?: true
29
29
 
30
+ # @!attribute organization_id
31
+ # The organization that owns this phone number.
32
+ #
33
+ # @return [String, nil]
34
+ optional :organization_id, String
35
+
36
+ # @!attribute tags
37
+ # Tags associated with this phone number.
38
+ #
39
+ # @return [Array<String>, nil]
40
+ optional :tags, Telnyx::Internal::Type::ArrayOf[String]
41
+
30
42
  response_only do
31
43
  # @!attribute id
32
44
  # Identifies the type of resource.
@@ -83,7 +95,7 @@ module Telnyx
83
95
  optional :updated_at, Time
84
96
  end
85
97
 
86
- # @!method initialize(id: nil, country_code: nil, created_at: nil, features: nil, messaging_product: nil, messaging_profile_id: nil, phone_number: nil, record_type: nil, traffic_type: nil, type: nil, updated_at: nil)
98
+ # @!method initialize(id: nil, country_code: nil, created_at: nil, features: nil, messaging_product: nil, messaging_profile_id: nil, organization_id: nil, phone_number: nil, record_type: nil, tags: nil, traffic_type: nil, type: nil, updated_at: nil)
87
99
  # @param id [String] Identifies the type of resource.
88
100
  #
89
101
  # @param country_code [String] ISO 3166-1 alpha-2 country code.
@@ -96,10 +108,14 @@ module Telnyx
96
108
  #
97
109
  # @param messaging_profile_id [String, nil] Unique identifier for a messaging profile.
98
110
  #
111
+ # @param organization_id [String] The organization that owns this phone number.
112
+ #
99
113
  # @param phone_number [String] +E.164 formatted phone number.
100
114
  #
101
115
  # @param record_type [Symbol, Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::RecordType] Identifies the type of the resource.
102
116
  #
117
+ # @param tags [Array<String>] Tags associated with this phone number.
118
+ #
103
119
  # @param traffic_type [String] The messaging traffic or use case for which the number is currently configured.
104
120
  #
105
121
  # @param type [Symbol, Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::Type] The type of the phone number
@@ -21,6 +21,18 @@ module Telnyx
21
21
  # @return [String, nil]
22
22
  optional :messaging_profile_id, String, nil?: true
23
23
 
24
+ # @!attribute organization_id
25
+ # The organization that owns this phone number.
26
+ #
27
+ # @return [String, nil]
28
+ optional :organization_id, String
29
+
30
+ # @!attribute tags
31
+ # Tags associated with this phone number.
32
+ #
33
+ # @return [Array<String>, nil]
34
+ optional :tags, Telnyx::Internal::Type::ArrayOf[String]
35
+
24
36
  response_only do
25
37
  # @!attribute id
26
38
  # Identifies the type of resource.
@@ -82,7 +94,7 @@ module Telnyx
82
94
  optional :updated_at, Time
83
95
  end
84
96
 
85
- # @!method initialize(id: nil, country_code: nil, created_at: nil, eligible_messaging_products: nil, features: nil, health: nil, messaging_product: nil, messaging_profile_id: nil, phone_number: nil, record_type: nil, traffic_type: nil, type: nil, updated_at: nil)
97
+ # @!method initialize(id: nil, country_code: nil, created_at: nil, eligible_messaging_products: nil, features: nil, health: nil, messaging_product: nil, messaging_profile_id: nil, organization_id: nil, phone_number: nil, record_type: nil, tags: nil, traffic_type: nil, type: nil, updated_at: nil)
86
98
  # Some parameter documentations has been truncated, see
87
99
  # {Telnyx::Models::PhoneNumberWithMessagingSettings} for more details.
88
100
  #
@@ -102,10 +114,14 @@ module Telnyx
102
114
  #
103
115
  # @param messaging_profile_id [String, nil] Unique identifier for a messaging profile.
104
116
  #
117
+ # @param organization_id [String] The organization that owns this phone number.
118
+ #
105
119
  # @param phone_number [String] +E.164 formatted phone number.
106
120
  #
107
121
  # @param record_type [Symbol, Telnyx::Models::PhoneNumberWithMessagingSettings::RecordType] Identifies the type of the resource.
108
122
  #
123
+ # @param tags [Array<String>] Tags associated with this phone number.
124
+ #
109
125
  # @param traffic_type [String] The messaging traffic or use case for which the number is currently configured.
110
126
  #
111
127
  # @param type [Symbol, Telnyx::Models::PhoneNumberWithMessagingSettings::Type] The type of the phone number
@@ -8,6 +8,30 @@ module Telnyx
8
8
  extend Telnyx::Internal::Type::RequestParameters::Converter
9
9
  include Telnyx::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute filter_messaging_profile_id
12
+ # Filter by messaging profile ID.
13
+ #
14
+ # @return [String, nil]
15
+ optional :filter_messaging_profile_id, String
16
+
17
+ # @!attribute filter_phone_number
18
+ # Filter by exact phone number (supports comma-separated list).
19
+ #
20
+ # @return [String, nil]
21
+ optional :filter_phone_number, String
22
+
23
+ # @!attribute filter_phone_number_contains
24
+ # Filter by phone number substring.
25
+ #
26
+ # @return [String, nil]
27
+ optional :filter_phone_number_contains, String
28
+
29
+ # @!attribute filter_type
30
+ # Filter by phone number type.
31
+ #
32
+ # @return [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::FilterType, nil]
33
+ optional :filter_type, enum: -> { Telnyx::PhoneNumbers::MessagingListParams::FilterType }
34
+
11
35
  # @!attribute page_number
12
36
  #
13
37
  # @return [Integer, nil]
@@ -18,10 +42,51 @@ module Telnyx
18
42
  # @return [Integer, nil]
19
43
  optional :page_size, Integer
20
44
 
21
- # @!method initialize(page_number: nil, page_size: nil, request_options: {})
45
+ # @!attribute sort_phone_number
46
+ # Sort by phone number.
47
+ #
48
+ # @return [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::SortPhoneNumber, nil]
49
+ optional :sort_phone_number, enum: -> { Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber }
50
+
51
+ # @!method initialize(filter_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, filter_type: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {})
52
+ # @param filter_messaging_profile_id [String] Filter by messaging profile ID.
53
+ #
54
+ # @param filter_phone_number [String] Filter by exact phone number (supports comma-separated list).
55
+ #
56
+ # @param filter_phone_number_contains [String] Filter by phone number substring.
57
+ #
58
+ # @param filter_type [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::FilterType] Filter by phone number type.
59
+ #
22
60
  # @param page_number [Integer]
61
+ #
23
62
  # @param page_size [Integer]
63
+ #
64
+ # @param sort_phone_number [Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::SortPhoneNumber] Sort by phone number.
65
+ #
24
66
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
67
+
68
+ # Filter by phone number type.
69
+ module FilterType
70
+ extend Telnyx::Internal::Type::Enum
71
+
72
+ TOLLFREE = :tollfree
73
+ LONGCODE = :longcode
74
+ SHORTCODE = :shortcode
75
+
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
78
+ end
79
+
80
+ # Sort by phone number.
81
+ module SortPhoneNumber
82
+ extend Telnyx::Internal::Type::Enum
83
+
84
+ ASC = :asc
85
+ DESC = :desc
86
+
87
+ # @!method self.values
88
+ # @return [Array<Symbol>]
89
+ end
25
90
  end
26
91
  end
27
92
  end
@@ -28,7 +28,13 @@ module Telnyx
28
28
  # @return [String, nil]
29
29
  optional :messaging_profile_id, String
30
30
 
31
- # @!method initialize(messaging_product: nil, messaging_profile_id: nil, request_options: {})
31
+ # @!attribute tags
32
+ # Tags to set on this phone number.
33
+ #
34
+ # @return [Array<String>, nil]
35
+ optional :tags, Telnyx::Internal::Type::ArrayOf[String]
36
+
37
+ # @!method initialize(messaging_product: nil, messaging_profile_id: nil, tags: nil, request_options: {})
32
38
  # Some parameter documentations has been truncated, see
33
39
  # {Telnyx::Models::PhoneNumbers::MessagingUpdateParams} for more details.
34
40
  #
@@ -36,6 +42,8 @@ module Telnyx
36
42
  #
37
43
  # @param messaging_profile_id [String] Configure the messaging profile this phone number is assigned to:
38
44
  #
45
+ # @param tags [Array<String>] Tags to set on this phone number.
46
+ #
39
47
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
40
48
  end
41
49
  end
@@ -34,6 +34,11 @@ module Telnyx
34
34
  # @return [String, nil]
35
35
  optional :name, String
36
36
 
37
+ # @!attribute rcs
38
+ #
39
+ # @return [Telnyx::Models::VerifyProfile::Rcs, nil]
40
+ optional :rcs, -> { Telnyx::VerifyProfile::Rcs }
41
+
37
42
  # @!attribute record_type
38
43
  # The possible verification profile record types.
39
44
  #
@@ -60,7 +65,7 @@ module Telnyx
60
65
  # @return [String, nil]
61
66
  optional :webhook_url, String
62
67
 
63
- # @!method initialize(id: nil, call: nil, created_at: nil, flashcall: nil, language: nil, name: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
68
+ # @!method initialize(id: nil, call: nil, created_at: nil, flashcall: nil, language: nil, name: nil, rcs: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
64
69
  # @param id [String]
65
70
  #
66
71
  # @param call [Telnyx::Models::VerifyProfile::Call]
@@ -73,6 +78,8 @@ module Telnyx
73
78
  #
74
79
  # @param name [String]
75
80
  #
81
+ # @param rcs [Telnyx::Models::VerifyProfile::Rcs]
82
+ #
76
83
  # @param record_type [Symbol, Telnyx::Models::VerifyProfile::RecordType] The possible verification profile record types.
77
84
  #
78
85
  # @param sms [Telnyx::Models::VerifyProfile::SMS]
@@ -138,6 +145,13 @@ module Telnyx
138
145
 
139
146
  # @see Telnyx::Models::VerifyProfile#flashcall
140
147
  class Flashcall < Telnyx::Internal::Type::BaseModel
148
+ # @!attribute app_name
149
+ # The name that identifies the application requesting 2fa in the verification
150
+ # message.
151
+ #
152
+ # @return [String, nil]
153
+ optional :app_name, String
154
+
141
155
  # @!attribute default_verification_timeout_secs
142
156
  # For every request that is initiated via this Verify profile, this sets the
143
157
  # number of seconds before a verification request code expires. Once the
@@ -147,11 +161,74 @@ module Telnyx
147
161
  # @return [Integer, nil]
148
162
  optional :default_verification_timeout_secs, Integer
149
163
 
150
- # @!method initialize(default_verification_timeout_secs: nil)
164
+ # @!method initialize(app_name: nil, default_verification_timeout_secs: nil)
151
165
  # Some parameter documentations has been truncated, see
152
166
  # {Telnyx::Models::VerifyProfile::Flashcall} for more details.
153
167
  #
168
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
169
+ #
170
+ # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
171
+ end
172
+
173
+ # @see Telnyx::Models::VerifyProfile#rcs
174
+ class Rcs < Telnyx::Internal::Type::BaseModel
175
+ # @!attribute app_name
176
+ # The name that identifies the application requesting 2fa in the verification
177
+ # message.
178
+ #
179
+ # @return [String, nil]
180
+ optional :app_name, String
181
+
182
+ # @!attribute code_length
183
+ # The length of the verify code to generate.
184
+ #
185
+ # @return [Integer, nil]
186
+ optional :code_length, Integer
187
+
188
+ # @!attribute default_verification_timeout_secs
189
+ # For every request that is initiated via this Verify profile, this sets the
190
+ # number of seconds before a verification request code expires. Once the
191
+ # verification request expires, the user cannot use the code to verify their
192
+ # identity.
193
+ #
194
+ # @return [Integer, nil]
195
+ optional :default_verification_timeout_secs, Integer
196
+
197
+ # @!attribute messaging_template_id
198
+ # The message template identifier selected from /verify_profiles/templates
199
+ #
200
+ # @return [String, nil]
201
+ optional :messaging_template_id, String
202
+
203
+ # @!attribute sms_fallback
204
+ # Enable SMS fallback when RCS delivery fails.
205
+ #
206
+ # @return [Boolean, nil]
207
+ optional :sms_fallback, Telnyx::Internal::Type::Boolean
208
+
209
+ # @!attribute whitelisted_destinations
210
+ # Enabled country destinations to send verification codes. The elements in the
211
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
212
+ # destinations will be allowed.
213
+ #
214
+ # @return [Array<String>, nil]
215
+ optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
216
+
217
+ # @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
218
+ # Some parameter documentations has been truncated, see
219
+ # {Telnyx::Models::VerifyProfile::Rcs} for more details.
220
+ #
221
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
222
+ #
223
+ # @param code_length [Integer] The length of the verify code to generate.
224
+ #
154
225
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
226
+ #
227
+ # @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
228
+ #
229
+ # @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
230
+ #
231
+ # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
155
232
  end
156
233
 
157
234
  # The possible verification profile record types.