telnyx 4.2.0 → 4.3.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 (48) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/internal/util.rb +5 -5
  5. data/lib/telnyx/models/ai/assistant_import_params.rb +1 -0
  6. data/lib/telnyx/models/ai/import_metadata.rb +1 -0
  7. data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +114 -1
  8. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +99 -1
  9. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +99 -1
  10. data/lib/telnyx/models/network_coverage_list_response.rb +1 -2
  11. data/lib/telnyx/models/outbound_voice_profile.rb +47 -1
  12. data/lib/telnyx/models/outbound_voice_profile_create_params.rb +47 -1
  13. data/lib/telnyx/models/outbound_voice_profile_list_params.rb +5 -5
  14. data/lib/telnyx/models/outbound_voice_profile_update_params.rb +47 -1
  15. data/lib/telnyx/models/requirement_group.rb +2 -0
  16. data/lib/telnyx/models/requirement_group_list_params.rb +1 -0
  17. data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +46 -2
  18. data/lib/telnyx/resources/outbound_voice_profiles.rb +7 -3
  19. data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
  20. data/lib/telnyx/version.rb +1 -1
  21. data/rbi/telnyx/models/ai/assistant_import_params.rbi +5 -0
  22. data/rbi/telnyx/models/ai/import_metadata.rbi +5 -0
  23. data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +165 -0
  24. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +164 -0
  25. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +164 -0
  26. data/rbi/telnyx/models/network_coverage_list_response.rbi +4 -8
  27. data/rbi/telnyx/models/outbound_voice_profile.rbi +81 -0
  28. data/rbi/telnyx/models/outbound_voice_profile_create_params.rbi +88 -0
  29. data/rbi/telnyx/models/outbound_voice_profile_list_params.rbi +6 -6
  30. data/rbi/telnyx/models/outbound_voice_profile_update_params.rbi +88 -0
  31. data/rbi/telnyx/models/requirement_group.rbi +7 -0
  32. data/rbi/telnyx/models/requirement_group_list_params.rbi +5 -0
  33. data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +84 -0
  34. data/rbi/telnyx/resources/outbound_voice_profiles.rbi +12 -2
  35. data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
  36. data/sig/telnyx/models/ai/assistant_import_params.rbs +2 -1
  37. data/sig/telnyx/models/ai/import_metadata.rbs +2 -1
  38. data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +76 -0
  39. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +98 -0
  40. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +98 -0
  41. data/sig/telnyx/models/outbound_voice_profile.rbs +38 -0
  42. data/sig/telnyx/models/outbound_voice_profile_create_params.rbs +38 -0
  43. data/sig/telnyx/models/outbound_voice_profile_update_params.rbs +38 -0
  44. data/sig/telnyx/models/requirement_group.rbs +6 -2
  45. data/sig/telnyx/models/requirement_group_list_params.rbs +3 -1
  46. data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +22 -0
  47. data/sig/telnyx/resources/outbound_voice_profiles.rbs +2 -0
  48. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2b7c31e9fc32bb50530cc852a0e2d8d6377aeae899da65b030b44da6524f76a2
4
- data.tar.gz: 218d2b3e11ef031f1920d1d3f634b8366d86652457590aa70d97ee7ba7db20d3
3
+ metadata.gz: b014a21b8d1c242d92ea5800d88a7d3ea0cc02bc7c1ed30372ce09fd2519a6e4
4
+ data.tar.gz: d61f21934afc98933044cbcb88383c29ab6069823f8dae8245372e6c4fc3b14c
5
5
  SHA512:
6
- metadata.gz: 4c030eb455cd1ef96d81c701773085034172375d75e20e52318c62aca5dd4d536430f265ff387308b89ffc89ce6f1de2c20dc25194a2ddd1caaf2e7a1e2e7c5f
7
- data.tar.gz: 5194a8d571c2aa2d3bfbbb4643054a7a6c11017f5f917c0d9f00cf85e0af6c33f180d350f2176eca4ab75b3cf2640b2cb6f7ebb26dca3eea6bfa4e3b6d577b88
6
+ metadata.gz: 98eee4d0f19c56951b57f7f37c74b6adb912f5e4193396e8b32c33e31feade3fc637967fa988dcfa731851fc3745422b872b953b20b42d0c42378c4209d5a2b5
7
+ data.tar.gz: 15d7a5baefa69caa266a7921fd5ec4e948fa5a170b1a849dcc6a11b4ea2071337dfb591b6972cc9e192649540d5725bbe8e80c7fbe403325f6fe98382aa6ef9e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # Changelog
2
2
 
3
+ ## 4.3.0 (2025-10-16)
4
+
5
+ Full Changelog: [v4.2.0...v4.3.0](https://github.com/team-telnyx/telnyx-ruby/compare/v4.2.0...v4.3.0)
6
+
7
+ ### Features
8
+
9
+ * ENGDESK-45836: Document private endpoint for republishing account events ([3dc8f26](https://github.com/team-telnyx/telnyx-ruby/commit/3dc8f262508aeb51a03b9dd45ffad74a3c5549a9))
10
+ * Fix broken link to List SIM card action ([743a217](https://github.com/team-telnyx/telnyx-ruby/commit/743a2177c49ed45fef13b1109f301c32a857f58c))
11
+ * MSG-5978: Add BRN fields to toll-free verification OpenAPI specs ([aa3e232](https://github.com/team-telnyx/telnyx-ruby/commit/aa3e232f11e83ec7a8dd873d755f331101d63ec8))
12
+ * Retell assistants import ([432388a](https://github.com/team-telnyx/telnyx-ruby/commit/432388ad8cd23ff535b3eceeda26ca3d320eeb1a))
13
+
14
+
15
+ ### Bug Fixes
16
+
17
+ * absolutely qualified uris should always override the default ([12809be](https://github.com/team-telnyx/telnyx-ruby/commit/12809bebb9177e7ac3f48bfa7d80860d90bde7e9))
18
+ * should not reuse buffers for `IO.copy_stream` interop ([2e35266](https://github.com/team-telnyx/telnyx-ruby/commit/2e3526691c82d412beb27418e7d55ffad5449c12))
19
+
20
+
21
+ ### Chores
22
+
23
+ * ignore linter error for tests having large collections ([8d69855](https://github.com/team-telnyx/telnyx-ruby/commit/8d6985599250a4e429445c1369d809f5c0346ecf))
24
+ * simplify model references ([d2c4915](https://github.com/team-telnyx/telnyx-ruby/commit/d2c491501c248ea07dc8502c7b1a5aa662b7ac25))
25
+
3
26
  ## 4.2.0 (2025-10-08)
4
27
 
5
28
  Full Changelog: [v4.1.0...v4.2.0](https://github.com/team-telnyx/telnyx-ruby/compare/v4.1.0...v4.2.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "telnyx", "~> 4.2.0"
18
+ gem "telnyx", "~> 4.3.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -346,8 +346,9 @@ module Telnyx
346
346
  base_path, base_query = lhs.fetch_values(:path, :query)
347
347
  slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
348
348
 
349
- parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
350
- override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
349
+ merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
350
+ parsed_path, parsed_query = merged.fetch_values(:path, :query)
351
+ override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
351
352
 
352
353
  joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
353
354
  query = deep_merge(
@@ -473,10 +474,9 @@ module Telnyx
473
474
  # @return [Enumerable<String>]
474
475
  def writable_enum(&blk)
475
476
  Enumerator.new do |y|
476
- buf = String.new
477
477
  y.define_singleton_method(:write) do
478
- self << buf.replace(_1)
479
- buf.bytesize
478
+ self << _1.dup
479
+ _1.bytesize
480
480
  end
481
481
 
482
482
  blk.call(y)
@@ -38,6 +38,7 @@ module Telnyx
38
38
 
39
39
  ELEVENLABS = :elevenlabs
40
40
  VAPI = :vapi
41
+ RETELL = :retell
41
42
 
42
43
  # @!method self.values
43
44
  # @return [Array<Symbol>]
@@ -29,6 +29,7 @@ module Telnyx
29
29
 
30
30
  ELEVENLABS = :elevenlabs
31
31
  VAPI = :vapi
32
+ RETELL = :retell
32
33
 
33
34
  # @!method self.values
34
35
  # @return [Array<Symbol>]
@@ -133,19 +133,94 @@ module Telnyx
133
133
  # @return [String]
134
134
  required :use_case_summary, String, api_name: :useCaseSummary
135
135
 
136
+ # @!attribute age_gated_content
137
+ # Indicates if messaging content requires age gating (e.g., 18+). Defaults to
138
+ # false if not provided.
139
+ #
140
+ # @return [Boolean, nil]
141
+ optional :age_gated_content, Telnyx::Internal::Type::Boolean, api_name: :ageGatedContent
142
+
136
143
  # @!attribute business_addr2
137
144
  # Line 2 of the business address
138
145
  #
139
146
  # @return [String, nil]
140
147
  optional :business_addr2, String, api_name: :businessAddr2
141
148
 
149
+ # @!attribute business_registration_country
150
+ # ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
151
+ # exactly 2 letters. Automatically converted to uppercase. Required from
152
+ # January 2026.
153
+ #
154
+ # @return [String, nil]
155
+ optional :business_registration_country, String, api_name: :businessRegistrationCountry, nil?: true
156
+
157
+ # @!attribute business_registration_number
158
+ # Official business registration number (e.g., Employer Identification Number
159
+ # (EIN) in the U.S.). Required from January 2026.
160
+ #
161
+ # @return [String, nil]
162
+ optional :business_registration_number, String, api_name: :businessRegistrationNumber, nil?: true
163
+
164
+ # @!attribute business_registration_type
165
+ # Type of business registration being provided. Required from January 2026.
166
+ #
167
+ # @return [String, nil]
168
+ optional :business_registration_type, String, api_name: :businessRegistrationType, nil?: true
169
+
170
+ # @!attribute doing_business_as
171
+ # Doing Business As (DBA) name if different from legal name
172
+ #
173
+ # @return [String, nil]
174
+ optional :doing_business_as, String, api_name: :doingBusinessAs, nil?: true
175
+
176
+ # @!attribute entity_type
177
+ # Business entity classification
178
+ #
179
+ # @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil]
180
+ optional :entity_type,
181
+ enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationRequest::EntityType },
182
+ api_name: :entityType,
183
+ nil?: true
184
+
185
+ # @!attribute help_message_response
186
+ # The message returned when users text 'HELP'
187
+ #
188
+ # @return [String, nil]
189
+ optional :help_message_response, String, api_name: :helpMessageResponse, nil?: true
190
+
191
+ # @!attribute opt_in_confirmation_response
192
+ # Message sent to users confirming their opt-in to receive messages
193
+ #
194
+ # @return [String, nil]
195
+ optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse, nil?: true
196
+
197
+ # @!attribute opt_in_keywords
198
+ # Keywords used to collect and process consumer opt-ins
199
+ #
200
+ # @return [String, nil]
201
+ optional :opt_in_keywords, String, api_name: :optInKeywords, nil?: true
202
+
203
+ # @!attribute privacy_policy_url
204
+ # URL pointing to the business's privacy policy. Plain string, no URL format
205
+ # validation.
206
+ #
207
+ # @return [String, nil]
208
+ optional :privacy_policy_url, String, api_name: :privacyPolicyURL, nil?: true
209
+
210
+ # @!attribute terms_and_condition_url
211
+ # URL pointing to the business's terms and conditions. Plain string, no URL format
212
+ # validation.
213
+ #
214
+ # @return [String, nil]
215
+ optional :terms_and_condition_url, String, api_name: :termsAndConditionURL, nil?: true
216
+
142
217
  # @!attribute webhook_url
143
218
  # URL that should receive webhooks relating to this verification request
144
219
  #
145
220
  # @return [String, nil]
146
221
  optional :webhook_url, String, api_name: :webhookUrl
147
222
 
148
- # @!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:, business_addr2: nil, webhook_url: nil)
223
+ # @!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, 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)
149
224
  # Some parameter documentations has been truncated, see
150
225
  # {Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest} for
151
226
  # more details.
@@ -190,9 +265,47 @@ module Telnyx
190
265
  #
191
266
  # @param use_case_summary [String] Human-readable summary of the desired use-case
192
267
  #
268
+ # @param age_gated_content [Boolean] Indicates if messaging content requires age gating (e.g., 18+). Defaults to fals
269
+ #
193
270
  # @param business_addr2 [String] Line 2 of the business address
194
271
  #
272
+ # @param business_registration_country [String, nil] ISO 3166-1 alpha-2 country code of the issuing business authority. Must be exact
273
+ #
274
+ # @param business_registration_number [String, nil] Official business registration number (e.g., Employer Identification Number (EIN
275
+ #
276
+ # @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
277
+ #
278
+ # @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
279
+ #
280
+ # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil] Business entity classification
281
+ #
282
+ # @param help_message_response [String, nil] The message returned when users text 'HELP'
283
+ #
284
+ # @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
285
+ #
286
+ # @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
287
+ #
288
+ # @param privacy_policy_url [String, nil] URL pointing to the business's privacy policy. Plain string, no URL format valid
289
+ #
290
+ # @param terms_and_condition_url [String, nil] URL pointing to the business's terms and conditions. Plain string, no URL format
291
+ #
195
292
  # @param webhook_url [String] URL that should receive webhooks relating to this verification request
293
+
294
+ # Business entity classification
295
+ #
296
+ # @see Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest#entity_type
297
+ module EntityType
298
+ extend Telnyx::Internal::Type::Enum
299
+
300
+ SOLE_PROPRIETOR = :SOLE_PROPRIETOR
301
+ PRIVATE_PROFIT = :PRIVATE_PROFIT
302
+ PUBLIC_PROFIT = :PUBLIC_PROFIT
303
+ NON_PROFIT = :NON_PROFIT
304
+ GOVERNMENT = :GOVERNMENT
305
+
306
+ # @!method self.values
307
+ # @return [Array<Symbol>]
308
+ end
196
309
  end
197
310
  end
198
311
  end
@@ -123,11 +123,71 @@ module Telnyx
123
123
  # @return [String]
124
124
  required :verification_request_id, String, api_name: :verificationRequestId
125
125
 
126
+ # @!attribute age_gated_content
127
+ #
128
+ # @return [Boolean, nil]
129
+ optional :age_gated_content, Telnyx::Internal::Type::Boolean, api_name: :ageGatedContent
130
+
126
131
  # @!attribute business_addr2
127
132
  #
128
133
  # @return [String, nil]
129
134
  optional :business_addr2, String, api_name: :businessAddr2
130
135
 
136
+ # @!attribute business_registration_country
137
+ #
138
+ # @return [String, nil]
139
+ optional :business_registration_country, String, api_name: :businessRegistrationCountry
140
+
141
+ # @!attribute business_registration_number
142
+ #
143
+ # @return [String, nil]
144
+ optional :business_registration_number, String, api_name: :businessRegistrationNumber
145
+
146
+ # @!attribute business_registration_type
147
+ #
148
+ # @return [String, nil]
149
+ optional :business_registration_type, String, api_name: :businessRegistrationType
150
+
151
+ # @!attribute doing_business_as
152
+ #
153
+ # @return [String, nil]
154
+ optional :doing_business_as, String, api_name: :doingBusinessAs
155
+
156
+ # @!attribute entity_type
157
+ # Business entity classification
158
+ #
159
+ # @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress::EntityType, nil]
160
+ optional :entity_type,
161
+ enum: -> {
162
+ Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType
163
+ },
164
+ api_name: :entityType
165
+
166
+ # @!attribute help_message_response
167
+ #
168
+ # @return [String, nil]
169
+ optional :help_message_response, String, api_name: :helpMessageResponse
170
+
171
+ # @!attribute opt_in_confirmation_response
172
+ #
173
+ # @return [String, nil]
174
+ optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse
175
+
176
+ # @!attribute opt_in_keywords
177
+ #
178
+ # @return [String, nil]
179
+ optional :opt_in_keywords, String, api_name: :optInKeywords
180
+
181
+ # @!attribute privacy_policy_url
182
+ #
183
+ # @return [String, nil]
184
+ optional :privacy_policy_url, String, api_name: :privacyPolicyURL
185
+
186
+ # @!attribute terms_and_condition_url
187
+ #
188
+ # @return [String, nil]
189
+ optional :terms_and_condition_url, String, api_name: :termsAndConditionURL
190
+
131
191
  # @!attribute verification_status
132
192
  # Tollfree verification status
133
193
  #
@@ -141,7 +201,7 @@ module Telnyx
141
201
  # @return [String, nil]
142
202
  optional :webhook_url, String, api_name: :webhookUrl
143
203
 
144
- # @!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:, business_addr2: nil, verification_status: nil, webhook_url: nil)
204
+ # @!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, 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)
145
205
  # A verification request as it comes out of the database
146
206
  #
147
207
  # @param id [String]
@@ -186,11 +246,49 @@ module Telnyx
186
246
  #
187
247
  # @param verification_request_id [String]
188
248
  #
249
+ # @param age_gated_content [Boolean]
250
+ #
189
251
  # @param business_addr2 [String]
190
252
  #
253
+ # @param business_registration_country [String]
254
+ #
255
+ # @param business_registration_number [String]
256
+ #
257
+ # @param business_registration_type [String]
258
+ #
259
+ # @param doing_business_as [String]
260
+ #
261
+ # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress::EntityType] Business entity classification
262
+ #
263
+ # @param help_message_response [String]
264
+ #
265
+ # @param opt_in_confirmation_response [String]
266
+ #
267
+ # @param opt_in_keywords [String]
268
+ #
269
+ # @param privacy_policy_url [String]
270
+ #
271
+ # @param terms_and_condition_url [String]
272
+ #
191
273
  # @param verification_status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Tollfree verification status
192
274
  #
193
275
  # @param webhook_url [String]
276
+
277
+ # Business entity classification
278
+ #
279
+ # @see Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress#entity_type
280
+ module EntityType
281
+ extend Telnyx::Internal::Type::Enum
282
+
283
+ SOLE_PROPRIETOR = :SOLE_PROPRIETOR
284
+ PRIVATE_PROFIT = :PRIVATE_PROFIT
285
+ PUBLIC_PROFIT = :PUBLIC_PROFIT
286
+ NON_PROFIT = :NON_PROFIT
287
+ GOVERNMENT = :GOVERNMENT
288
+
289
+ # @!method self.values
290
+ # @return [Array<Symbol>]
291
+ end
194
292
  end
195
293
  end
196
294
 
@@ -126,21 +126,81 @@ module Telnyx
126
126
  enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus },
127
127
  api_name: :verificationStatus
128
128
 
129
+ # @!attribute age_gated_content
130
+ #
131
+ # @return [Boolean, nil]
132
+ optional :age_gated_content, Telnyx::Internal::Type::Boolean, api_name: :ageGatedContent
133
+
129
134
  # @!attribute business_addr2
130
135
  #
131
136
  # @return [String, nil]
132
137
  optional :business_addr2, String, api_name: :businessAddr2
133
138
 
139
+ # @!attribute business_registration_country
140
+ #
141
+ # @return [String, nil]
142
+ optional :business_registration_country, String, api_name: :businessRegistrationCountry
143
+
144
+ # @!attribute business_registration_number
145
+ #
146
+ # @return [String, nil]
147
+ optional :business_registration_number, String, api_name: :businessRegistrationNumber
148
+
149
+ # @!attribute business_registration_type
150
+ #
151
+ # @return [String, nil]
152
+ optional :business_registration_type, String, api_name: :businessRegistrationType
153
+
134
154
  # @!attribute created_at
135
155
  #
136
156
  # @return [Time, nil]
137
157
  optional :created_at, Time, api_name: :createdAt
138
158
 
159
+ # @!attribute doing_business_as
160
+ #
161
+ # @return [String, nil]
162
+ optional :doing_business_as, String, api_name: :doingBusinessAs
163
+
164
+ # @!attribute entity_type
165
+ # Business entity classification
166
+ #
167
+ # @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus::EntityType, nil]
168
+ optional :entity_type,
169
+ enum: -> {
170
+ Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType
171
+ },
172
+ api_name: :entityType
173
+
174
+ # @!attribute help_message_response
175
+ #
176
+ # @return [String, nil]
177
+ optional :help_message_response, String, api_name: :helpMessageResponse
178
+
179
+ # @!attribute opt_in_confirmation_response
180
+ #
181
+ # @return [String, nil]
182
+ optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse
183
+
184
+ # @!attribute opt_in_keywords
185
+ #
186
+ # @return [String, nil]
187
+ optional :opt_in_keywords, String, api_name: :optInKeywords
188
+
189
+ # @!attribute privacy_policy_url
190
+ #
191
+ # @return [String, nil]
192
+ optional :privacy_policy_url, String, api_name: :privacyPolicyURL
193
+
139
194
  # @!attribute reason
140
195
  #
141
196
  # @return [String, nil]
142
197
  optional :reason, String
143
198
 
199
+ # @!attribute terms_and_condition_url
200
+ #
201
+ # @return [String, nil]
202
+ optional :terms_and_condition_url, String, api_name: :termsAndConditionURL
203
+
144
204
  # @!attribute updated_at
145
205
  #
146
206
  # @return [Time, nil]
@@ -151,7 +211,7 @@ module Telnyx
151
211
  # @return [String, nil]
152
212
  optional :webhook_url, String, api_name: :webhookUrl
153
213
 
154
- # @!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:, business_addr2: nil, created_at: nil, reason: nil, updated_at: nil, webhook_url: nil)
214
+ # @!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, 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)
155
215
  # A verification request and its status, suitable for returning to users
156
216
  #
157
217
  # @param id [String]
@@ -196,15 +256,53 @@ module Telnyx
196
256
  #
197
257
  # @param verification_status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Tollfree verification status
198
258
  #
259
+ # @param age_gated_content [Boolean]
260
+ #
199
261
  # @param business_addr2 [String]
200
262
  #
263
+ # @param business_registration_country [String]
264
+ #
265
+ # @param business_registration_number [String]
266
+ #
267
+ # @param business_registration_type [String]
268
+ #
201
269
  # @param created_at [Time]
202
270
  #
271
+ # @param doing_business_as [String]
272
+ #
273
+ # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus::EntityType] Business entity classification
274
+ #
275
+ # @param help_message_response [String]
276
+ #
277
+ # @param opt_in_confirmation_response [String]
278
+ #
279
+ # @param opt_in_keywords [String]
280
+ #
281
+ # @param privacy_policy_url [String]
282
+ #
203
283
  # @param reason [String]
204
284
  #
285
+ # @param terms_and_condition_url [String]
286
+ #
205
287
  # @param updated_at [Time]
206
288
  #
207
289
  # @param webhook_url [String]
290
+
291
+ # Business entity classification
292
+ #
293
+ # @see Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus#entity_type
294
+ module EntityType
295
+ extend Telnyx::Internal::Type::Enum
296
+
297
+ SOLE_PROPRIETOR = :SOLE_PROPRIETOR
298
+ PRIVATE_PROFIT = :PRIVATE_PROFIT
299
+ PUBLIC_PROFIT = :PUBLIC_PROFIT
300
+ NON_PROFIT = :NON_PROFIT
301
+ GOVERNMENT = :GOVERNMENT
302
+
303
+ # @!method self.values
304
+ # @return [Array<Symbol>]
305
+ end
208
306
  end
209
307
  end
210
308
 
@@ -23,8 +23,7 @@ module Telnyx
23
23
  # List of interface types supported in this region.
24
24
  #
25
25
  # @return [Array<Symbol, Telnyx::Models::AvailableService>, nil]
26
- optional :available_services,
27
- -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::Models::AvailableService] }
26
+ optional :available_services, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AvailableService] }
28
27
 
29
28
  # @!attribute location
30
29
  #
@@ -27,6 +27,13 @@ module Telnyx
27
27
  # @return [Telnyx::Models::OutboundCallRecording, nil]
28
28
  optional :call_recording, -> { Telnyx::OutboundCallRecording }
29
29
 
30
+ # @!attribute calling_window
31
+ # (BETA) Specifies the time window and call limits for calls made using this
32
+ # outbound voice profile. Note that all times are UTC in 24-hour clock time.
33
+ #
34
+ # @return [Telnyx::Models::OutboundVoiceProfile::CallingWindow, nil]
35
+ optional :calling_window, -> { Telnyx::OutboundVoiceProfile::CallingWindow }
36
+
30
37
  # @!attribute concurrent_call_limit
31
38
  # Must be no more than your global concurrent call limit. Null means no limit.
32
39
  #
@@ -115,7 +122,7 @@ module Telnyx
115
122
  # @return [Array<String>, nil]
116
123
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
117
124
 
118
- # @!method initialize(name:, id: nil, billing_group_id: nil, call_recording: nil, concurrent_call_limit: nil, connections_count: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, record_type: nil, service_plan: nil, tags: nil, traffic_type: nil, updated_at: nil, usage_payment_method: nil, whitelisted_destinations: nil)
125
+ # @!method initialize(name:, id: nil, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, connections_count: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, record_type: nil, service_plan: nil, tags: nil, traffic_type: nil, updated_at: nil, usage_payment_method: nil, whitelisted_destinations: nil)
119
126
  # Some parameter documentations has been truncated, see
120
127
  # {Telnyx::Models::OutboundVoiceProfile} for more details.
121
128
  #
@@ -127,6 +134,8 @@ module Telnyx
127
134
  #
128
135
  # @param call_recording [Telnyx::Models::OutboundCallRecording]
129
136
  #
137
+ # @param calling_window [Telnyx::Models::OutboundVoiceProfile::CallingWindow] (BETA) Specifies the time window and call limits for calls made using this outbo
138
+ #
130
139
  # @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
131
140
  #
132
141
  # @param connections_count [Integer] Amount of connections associated with this outbound voice profile.
@@ -154,6 +163,43 @@ module Telnyx
154
163
  # @param usage_payment_method [Symbol, Telnyx::Models::UsagePaymentMethod] Setting for how costs for outbound profile are calculated.
155
164
  #
156
165
  # @param whitelisted_destinations [Array<String>] The list of destinations you want to be able to call using this outbound voice p
166
+
167
+ # @see Telnyx::Models::OutboundVoiceProfile#calling_window
168
+ class CallingWindow < Telnyx::Internal::Type::BaseModel
169
+ # @!attribute calls_per_cld
170
+ # (BETA) The maximum number of calls that can be initiated to a single called
171
+ # party (CLD) within the calling window. A null value means no limit.
172
+ #
173
+ # @return [Integer, nil]
174
+ optional :calls_per_cld, Integer
175
+
176
+ # @!attribute end_time
177
+ # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
178
+ # longer allowed to start.
179
+ #
180
+ # @return [String, nil]
181
+ optional :end_time, String
182
+
183
+ # @!attribute start_time
184
+ # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
185
+ # allowed to start.
186
+ #
187
+ # @return [String, nil]
188
+ optional :start_time, String
189
+
190
+ # @!method initialize(calls_per_cld: nil, end_time: nil, start_time: nil)
191
+ # Some parameter documentations has been truncated, see
192
+ # {Telnyx::Models::OutboundVoiceProfile::CallingWindow} for more details.
193
+ #
194
+ # (BETA) Specifies the time window and call limits for calls made using this
195
+ # outbound voice profile. Note that all times are UTC in 24-hour clock time.
196
+ #
197
+ # @param calls_per_cld [Integer] (BETA) The maximum number of calls that can be initiated to a single called part
198
+ #
199
+ # @param end_time [String] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no lo
200
+ #
201
+ # @param start_time [String] (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are allow
202
+ end
157
203
  end
158
204
  end
159
205
  end