telnyx 3.5.0a0__py3-none-any.whl → 3.6.0__py3-none-any.whl
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.
Potentially problematic release.
This version of telnyx might be problematic. Click here for more details.
- telnyx/_client.py +56 -756
- telnyx/_version.py +1 -1
- telnyx/resources/__init__.py +70 -0
- telnyx/resources/advanced_orders.py +63 -63
- telnyx/resources/ai/assistants/assistants.py +15 -17
- telnyx/resources/ai/assistants/versions.py +13 -15
- telnyx/resources/ai/conversations/conversations.py +137 -3
- telnyx/resources/ai/conversations/messages.py +1 -134
- telnyx/resources/brand/brand.py +8 -4
- telnyx/resources/calls/actions.py +154 -150
- telnyx/resources/calls/calls.py +18 -10
- telnyx/resources/conferences/actions.py +8 -24
- telnyx/resources/conferences/conferences.py +2 -6
- telnyx/resources/documents.py +242 -37
- telnyx/resources/legacy/__init__.py +33 -0
- telnyx/resources/legacy/legacy.py +102 -0
- telnyx/resources/legacy/reporting/__init__.py +47 -0
- telnyx/resources/legacy/reporting/batch_detail_records/__init__.py +61 -0
- telnyx/resources/legacy/reporting/batch_detail_records/batch_detail_records.py +166 -0
- telnyx/resources/legacy/reporting/batch_detail_records/messaging.py +482 -0
- telnyx/resources/legacy/reporting/batch_detail_records/speech_to_text.py +399 -0
- telnyx/resources/legacy/reporting/batch_detail_records/voice.py +539 -0
- telnyx/resources/legacy/reporting/reporting.py +134 -0
- telnyx/resources/legacy/reporting/usage_reports/__init__.py +61 -0
- telnyx/resources/legacy/reporting/usage_reports/messaging.py +471 -0
- telnyx/resources/legacy/reporting/usage_reports/number_lookup.py +464 -0
- telnyx/resources/legacy/reporting/usage_reports/usage_reports.py +288 -0
- telnyx/resources/legacy/reporting/usage_reports/voice.py +493 -0
- telnyx/resources/messaging_profiles/messaging_profiles.py +16 -0
- telnyx/resources/messaging_tollfree/verification/requests.py +203 -1
- telnyx/resources/oauth.py +855 -0
- telnyx/resources/oauth_clients.py +711 -0
- telnyx/resources/oauth_grants.py +349 -0
- telnyx/resources/outbound_voice_profiles.py +24 -4
- telnyx/resources/phone_numbers/jobs.py +12 -0
- telnyx/resources/porting_orders/porting_orders.py +20 -8
- telnyx/resources/sim_cards/actions.py +12 -12
- telnyx/resources/sim_cards/sim_cards.py +3 -2
- telnyx/resources/texml/accounts/calls/calls.py +11 -0
- telnyx/resources/texml/accounts/conferences/participants.py +11 -0
- telnyx/resources/verifications/verifications.py +10 -0
- telnyx/resources/verified_numbers/verified_numbers.py +25 -4
- telnyx/resources/verify_profiles.py +182 -1
- telnyx/resources/well_known.py +198 -0
- telnyx/types/__init__.py +51 -9
- telnyx/types/access_ip_address_list_response.py +3 -12
- telnyx/types/access_ip_range_list_response.py +3 -12
- telnyx/types/addresses/action_validate_response.py +8 -3
- telnyx/types/{advanced_order_update_params.py → advanced_order_update_requirement_group_params.py} +2 -2
- telnyx/types/ai/__init__.py +2 -3
- telnyx/types/ai/assistant_import_params.py +1 -1
- telnyx/types/ai/assistants/__init__.py +0 -3
- telnyx/types/ai/assistants_list.py +4 -88
- telnyx/types/ai/{conversations/message_create_params.py → conversation_add_message_params.py} +4 -4
- telnyx/types/ai/conversations/__init__.py +0 -1
- telnyx/types/ai/import_metadata.py +1 -1
- telnyx/types/ai/{assistant_clone_response.py → inference_embedding.py} +2 -2
- telnyx/types/ai/inference_embedding_transfer_tool_params.py +6 -0
- telnyx/types/ai/inference_embedding_transfer_tool_params_param.py +6 -0
- telnyx/types/ai/inference_embedding_webhook_tool_params.py +2 -0
- telnyx/types/ai/inference_embedding_webhook_tool_params_param.py +2 -0
- telnyx/types/ai/voice_settings.py +49 -2
- telnyx/types/ai/voice_settings_param.py +49 -2
- telnyx/types/brand_create_params.py +2 -1
- telnyx/types/brand_update_params.py +2 -1
- telnyx/types/call_dial_params.py +11 -3
- telnyx/types/calls/__init__.py +1 -0
- telnyx/types/calls/action_answer_params.py +1 -2
- telnyx/types/calls/action_gather_using_ai_params.py +5 -8
- telnyx/types/calls/action_start_streaming_params.py +5 -2
- telnyx/types/calls/action_start_transcription_params.py +160 -6
- telnyx/types/calls/action_transfer_params.py +50 -0
- telnyx/types/calls/telnyx_transcription_language.py +108 -0
- telnyx/types/calls/transcription_engine_b_config_param.py +3 -102
- telnyx/types/calls/transcription_start_request_param.py +161 -6
- telnyx/types/campaign_submit_appeal_response.py +0 -3
- telnyx/types/country_coverage_retrieve_country_response.py +7 -0
- telnyx/types/country_coverage_retrieve_response.py +7 -0
- telnyx/types/document_upload_json_params.py +39 -0
- telnyx/types/document_upload_json_response.py +12 -0
- telnyx/types/legacy/__init__.py +3 -0
- telnyx/types/legacy/reporting/__init__.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/__init__.py +24 -0
- telnyx/types/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.py +17 -0
- telnyx/types/legacy/reporting/batch_detail_records/cdr_detailed_req_response.py +63 -0
- telnyx/types/legacy/reporting/batch_detail_records/mdr_detail_report_response.py +42 -0
- telnyx/types/legacy/reporting/batch_detail_records/messaging_create_params.py +55 -0
- telnyx/types/legacy/reporting/batch_detail_records/messaging_create_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/messaging_delete_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/messaging_list_response.py +15 -0
- telnyx/types/legacy/reporting/batch_detail_records/messaging_retrieve_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_params.py +19 -0
- telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_delete_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_list_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_retrieve_response.py +12 -0
- telnyx/types/legacy/reporting/batch_detail_records/stt_detail_report_response.py +27 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_create_params.py +57 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_create_response.py +13 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_delete_response.py +13 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_list_response.py +15 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_fields_response.py +23 -0
- telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_response.py +13 -0
- telnyx/types/legacy/reporting/filter.py +31 -0
- telnyx/types/legacy/reporting/filter_param.py +30 -0
- telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_params.py +17 -0
- telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_response.py +11 -0
- telnyx/types/legacy/reporting/usage_reports/__init__.py +21 -0
- telnyx/types/legacy/reporting/usage_reports/cdr_usage_report_response_legacy.py +43 -0
- telnyx/types/legacy/reporting/usage_reports/mdr_usage_report_response_legacy.py +38 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_create_params.py +29 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_create_response.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_delete_response.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_list_params.py +15 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_list_response.py +15 -0
- telnyx/types/legacy/reporting/usage_reports/messaging_retrieve_response.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/number_lookup_create_params.py +26 -0
- telnyx/types/legacy/reporting/usage_reports/number_lookup_list_params.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/standard_pagination_meta.py +17 -0
- telnyx/types/legacy/reporting/usage_reports/voice_create_params.py +40 -0
- telnyx/types/legacy/reporting/usage_reports/voice_create_response.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/voice_delete_response.py +13 -0
- telnyx/types/legacy/reporting/usage_reports/voice_list_params.py +15 -0
- telnyx/types/legacy/reporting/usage_reports/voice_list_response.py +15 -0
- telnyx/types/legacy/reporting/usage_reports/voice_retrieve_response.py +13 -0
- telnyx/types/message_template.py +12 -0
- telnyx/types/messaging_profile.py +3 -0
- telnyx/types/messaging_profile_create_params.py +3 -0
- telnyx/types/messaging_profile_update_params.py +3 -0
- telnyx/types/messaging_tollfree/verification/__init__.py +1 -0
- telnyx/types/messaging_tollfree/verification/request_create_params.py +51 -1
- telnyx/types/messaging_tollfree/verification/request_update_params.py +51 -1
- telnyx/types/messaging_tollfree/verification/toll_free_verification_entity_type.py +9 -0
- telnyx/types/messaging_tollfree/verification/verification_request_egress.py +24 -0
- telnyx/types/messaging_tollfree/verification/verification_request_status.py +24 -0
- telnyx/types/number_order_status_update_webhook_event.py +30 -4
- telnyx/types/oauth_client.py +59 -0
- telnyx/types/oauth_client_create_params.py +39 -0
- telnyx/types/oauth_client_create_response.py +12 -0
- telnyx/types/oauth_client_list_params.py +38 -0
- telnyx/types/oauth_client_list_response.py +15 -0
- telnyx/types/oauth_client_retrieve_response.py +12 -0
- telnyx/types/oauth_client_update_params.py +36 -0
- telnyx/types/oauth_client_update_response.py +12 -0
- telnyx/types/oauth_grant.py +29 -0
- telnyx/types/oauth_grant_delete_response.py +12 -0
- telnyx/types/oauth_grant_list_params.py +17 -0
- telnyx/types/oauth_grant_list_response.py +15 -0
- telnyx/types/oauth_grant_retrieve_response.py +12 -0
- telnyx/types/oauth_grants_params.py +15 -0
- telnyx/types/oauth_grants_response.py +10 -0
- telnyx/types/oauth_introspect_params.py +12 -0
- telnyx/types/oauth_introspect_response.py +30 -0
- telnyx/types/oauth_register_params.py +39 -0
- telnyx/types/oauth_register_response.py +45 -0
- telnyx/types/oauth_retrieve_authorize_params.py +30 -0
- telnyx/types/oauth_retrieve_jwks_response.py +25 -0
- telnyx/types/oauth_retrieve_response.py +47 -0
- telnyx/types/oauth_token_params.py +33 -0
- telnyx/types/oauth_token_response.py +25 -0
- telnyx/types/outbound_voice_profile.py +27 -1
- telnyx/types/outbound_voice_profile_create_params.py +27 -1
- telnyx/types/outbound_voice_profile_list_params.py +1 -1
- telnyx/types/outbound_voice_profile_update_params.py +27 -1
- telnyx/types/pagination_meta_cloudflare_ip_list_sync.py +15 -0
- telnyx/types/pagination_meta_oauth.py +21 -0
- telnyx/types/phone_number_blocks/__init__.py +1 -0
- telnyx/types/phone_number_blocks/job.py +3 -34
- telnyx/types/phone_number_blocks/job_error.py +32 -0
- telnyx/types/phone_number_delete_response.py +7 -0
- telnyx/types/phone_number_detailed.py +7 -0
- telnyx/types/phone_number_list_params.py +6 -0
- telnyx/types/phone_numbers/job_update_batch_params.py +7 -0
- telnyx/types/phone_numbers/phone_numbers_job.py +3 -36
- telnyx/types/porting_order.py +3 -0
- telnyx/types/porting_order_create_params.py +3 -0
- telnyx/types/porting_order_list_params.py +52 -31
- telnyx/types/porting_order_update_params.py +2 -0
- telnyx/types/porting_orders/phone_number_configuration_list_params.py +19 -19
- telnyx/types/report_list_mdrs_response.py +3 -12
- telnyx/types/reports/__init__.py +1 -0
- telnyx/types/reports/mdr_usage_report_list_response.py +3 -12
- telnyx/types/reports/pagination_meta_reporting.py +17 -0
- telnyx/types/requirement_group.py +2 -2
- telnyx/types/requirement_group_list_params.py +1 -1
- telnyx/types/shared/__init__.py +1 -0
- telnyx/types/{error.py → shared/api_error.py} +3 -3
- telnyx/types/shared/simple_sim_card.py +15 -0
- telnyx/types/sim_card.py +12 -0
- telnyx/types/sim_card_update_params.py +2 -1
- telnyx/types/stream_bidirectional_codec.py +1 -1
- telnyx/types/stream_bidirectional_sampling_rate.py +7 -0
- telnyx/types/stream_codec.py +1 -1
- telnyx/types/texml/accounts/call_calls_params.py +16 -1
- telnyx/types/texml/accounts/conferences/participant_participants_params.py +16 -1
- telnyx/types/verification_trigger_call_params.py +7 -0
- telnyx/types/verifications/__init__.py +1 -0
- telnyx/types/verifications/by_phone_number_list_response.py +4 -13
- telnyx/types/verifications/verify_meta.py +17 -0
- telnyx/types/verified_number_create_params.py +10 -0
- telnyx/types/verify_profile.py +18 -3
- telnyx/types/verify_profile_create_template_params.py +12 -0
- telnyx/types/verify_profile_list_response.py +4 -13
- telnyx/types/verify_profile_message_template_response.py +13 -0
- telnyx/types/verify_profile_retrieve_templates_response.py +4 -9
- telnyx/types/verify_profile_update_template_params.py +12 -0
- telnyx/types/well_known_retrieve_authorization_server_metadata_response.py +42 -0
- telnyx/types/well_known_retrieve_protected_resource_metadata_response.py +15 -0
- {telnyx-3.5.0a0.dist-info → telnyx-3.6.0.dist-info}/METADATA +4 -4
- {telnyx-3.5.0a0.dist-info → telnyx-3.6.0.dist-info}/RECORD +212 -121
- telnyx/types/ai/assistant_create_response.py +0 -92
- telnyx/types/ai/assistant_retrieve_response.py +0 -92
- telnyx/types/ai/assistants/version_promote_response.py +0 -92
- telnyx/types/ai/assistants/version_retrieve_response.py +0 -92
- telnyx/types/ai/assistants/version_update_response.py +0 -92
- telnyx/types/client_create_bucket_params.py +0 -13
- telnyx/types/client_delete_objects_params.py +0 -20
- telnyx/types/client_get_object_params.py +0 -15
- telnyx/types/client_list_objects_params.py +0 -13
- telnyx/types/client_put_object_params.py +0 -20
- telnyx/types/list_buckets_response.py +0 -20
- telnyx/types/list_objects_response.py +0 -24
- {telnyx-3.5.0a0.dist-info → telnyx-3.6.0.dist-info}/WHEEL +0 -0
- {telnyx-3.5.0a0.dist-info → telnyx-3.6.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
|
-
from typing import Union, Iterable
|
|
5
|
+
from typing import Union, Iterable, Optional
|
|
6
6
|
from datetime import datetime
|
|
7
7
|
|
|
8
8
|
import httpx
|
|
@@ -22,6 +22,7 @@ from ....types.messaging_tollfree.verification import (
|
|
|
22
22
|
Volume,
|
|
23
23
|
UseCaseCategories,
|
|
24
24
|
TfVerificationStatus,
|
|
25
|
+
TollFreeVerificationEntityType,
|
|
25
26
|
request_list_params,
|
|
26
27
|
request_create_params,
|
|
27
28
|
request_update_params,
|
|
@@ -34,6 +35,7 @@ from ....types.messaging_tollfree.verification.tf_phone_number_param import TfPh
|
|
|
34
35
|
from ....types.messaging_tollfree.verification.tf_verification_status import TfVerificationStatus
|
|
35
36
|
from ....types.messaging_tollfree.verification.verification_request_egress import VerificationRequestEgress
|
|
36
37
|
from ....types.messaging_tollfree.verification.verification_request_status import VerificationRequestStatus
|
|
38
|
+
from ....types.messaging_tollfree.verification.toll_free_verification_entity_type import TollFreeVerificationEntityType
|
|
37
39
|
|
|
38
40
|
__all__ = ["RequestsResource", "AsyncRequestsResource"]
|
|
39
41
|
|
|
@@ -80,7 +82,18 @@ class RequestsResource(SyncAPIResource):
|
|
|
80
82
|
production_message_content: str,
|
|
81
83
|
use_case: UseCaseCategories,
|
|
82
84
|
use_case_summary: str,
|
|
85
|
+
age_gated_content: bool | Omit = omit,
|
|
83
86
|
business_addr2: str | Omit = omit,
|
|
87
|
+
business_registration_country: Optional[str] | Omit = omit,
|
|
88
|
+
business_registration_number: Optional[str] | Omit = omit,
|
|
89
|
+
business_registration_type: Optional[str] | Omit = omit,
|
|
90
|
+
doing_business_as: Optional[str] | Omit = omit,
|
|
91
|
+
entity_type: Optional[TollFreeVerificationEntityType] | Omit = omit,
|
|
92
|
+
help_message_response: Optional[str] | Omit = omit,
|
|
93
|
+
opt_in_confirmation_response: Optional[str] | Omit = omit,
|
|
94
|
+
opt_in_keywords: Optional[str] | Omit = omit,
|
|
95
|
+
privacy_policy_url: Optional[str] | Omit = omit,
|
|
96
|
+
terms_and_condition_url: Optional[str] | Omit = omit,
|
|
84
97
|
webhook_url: str | Omit = omit,
|
|
85
98
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
86
99
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
@@ -135,8 +148,36 @@ class RequestsResource(SyncAPIResource):
|
|
|
135
148
|
|
|
136
149
|
use_case_summary: Human-readable summary of the desired use-case
|
|
137
150
|
|
|
151
|
+
age_gated_content: Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
152
|
+
false if not provided.
|
|
153
|
+
|
|
138
154
|
business_addr2: Line 2 of the business address
|
|
139
155
|
|
|
156
|
+
business_registration_country: ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
157
|
+
exactly 2 letters. Automatically converted to uppercase. Required from
|
|
158
|
+
January 2026.
|
|
159
|
+
|
|
160
|
+
business_registration_number: Official business registration number (e.g., Employer Identification Number
|
|
161
|
+
(EIN) in the U.S.). Required from January 2026.
|
|
162
|
+
|
|
163
|
+
business_registration_type: Type of business registration being provided. Required from January 2026.
|
|
164
|
+
|
|
165
|
+
doing_business_as: Doing Business As (DBA) name if different from legal name
|
|
166
|
+
|
|
167
|
+
entity_type: Business entity classification
|
|
168
|
+
|
|
169
|
+
help_message_response: The message returned when users text 'HELP'
|
|
170
|
+
|
|
171
|
+
opt_in_confirmation_response: Message sent to users confirming their opt-in to receive messages
|
|
172
|
+
|
|
173
|
+
opt_in_keywords: Keywords used to collect and process consumer opt-ins
|
|
174
|
+
|
|
175
|
+
privacy_policy_url: URL pointing to the business's privacy policy. Plain string, no URL format
|
|
176
|
+
validation.
|
|
177
|
+
|
|
178
|
+
terms_and_condition_url: URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
179
|
+
validation.
|
|
180
|
+
|
|
140
181
|
webhook_url: URL that should receive webhooks relating to this verification request
|
|
141
182
|
|
|
142
183
|
extra_headers: Send extra headers
|
|
@@ -170,7 +211,18 @@ class RequestsResource(SyncAPIResource):
|
|
|
170
211
|
"production_message_content": production_message_content,
|
|
171
212
|
"use_case": use_case,
|
|
172
213
|
"use_case_summary": use_case_summary,
|
|
214
|
+
"age_gated_content": age_gated_content,
|
|
173
215
|
"business_addr2": business_addr2,
|
|
216
|
+
"business_registration_country": business_registration_country,
|
|
217
|
+
"business_registration_number": business_registration_number,
|
|
218
|
+
"business_registration_type": business_registration_type,
|
|
219
|
+
"doing_business_as": doing_business_as,
|
|
220
|
+
"entity_type": entity_type,
|
|
221
|
+
"help_message_response": help_message_response,
|
|
222
|
+
"opt_in_confirmation_response": opt_in_confirmation_response,
|
|
223
|
+
"opt_in_keywords": opt_in_keywords,
|
|
224
|
+
"privacy_policy_url": privacy_policy_url,
|
|
225
|
+
"terms_and_condition_url": terms_and_condition_url,
|
|
174
226
|
"webhook_url": webhook_url,
|
|
175
227
|
},
|
|
176
228
|
request_create_params.RequestCreateParams,
|
|
@@ -237,7 +289,18 @@ class RequestsResource(SyncAPIResource):
|
|
|
237
289
|
production_message_content: str,
|
|
238
290
|
use_case: UseCaseCategories,
|
|
239
291
|
use_case_summary: str,
|
|
292
|
+
age_gated_content: bool | Omit = omit,
|
|
240
293
|
business_addr2: str | Omit = omit,
|
|
294
|
+
business_registration_country: Optional[str] | Omit = omit,
|
|
295
|
+
business_registration_number: Optional[str] | Omit = omit,
|
|
296
|
+
business_registration_type: Optional[str] | Omit = omit,
|
|
297
|
+
doing_business_as: Optional[str] | Omit = omit,
|
|
298
|
+
entity_type: Optional[TollFreeVerificationEntityType] | Omit = omit,
|
|
299
|
+
help_message_response: Optional[str] | Omit = omit,
|
|
300
|
+
opt_in_confirmation_response: Optional[str] | Omit = omit,
|
|
301
|
+
opt_in_keywords: Optional[str] | Omit = omit,
|
|
302
|
+
privacy_policy_url: Optional[str] | Omit = omit,
|
|
303
|
+
terms_and_condition_url: Optional[str] | Omit = omit,
|
|
241
304
|
webhook_url: str | Omit = omit,
|
|
242
305
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
243
306
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
@@ -294,8 +357,36 @@ class RequestsResource(SyncAPIResource):
|
|
|
294
357
|
|
|
295
358
|
use_case_summary: Human-readable summary of the desired use-case
|
|
296
359
|
|
|
360
|
+
age_gated_content: Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
361
|
+
false if not provided.
|
|
362
|
+
|
|
297
363
|
business_addr2: Line 2 of the business address
|
|
298
364
|
|
|
365
|
+
business_registration_country: ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
366
|
+
exactly 2 letters. Automatically converted to uppercase. Required from
|
|
367
|
+
January 2026.
|
|
368
|
+
|
|
369
|
+
business_registration_number: Official business registration number (e.g., Employer Identification Number
|
|
370
|
+
(EIN) in the U.S.). Required from January 2026.
|
|
371
|
+
|
|
372
|
+
business_registration_type: Type of business registration being provided. Required from January 2026.
|
|
373
|
+
|
|
374
|
+
doing_business_as: Doing Business As (DBA) name if different from legal name
|
|
375
|
+
|
|
376
|
+
entity_type: Business entity classification
|
|
377
|
+
|
|
378
|
+
help_message_response: The message returned when users text 'HELP'
|
|
379
|
+
|
|
380
|
+
opt_in_confirmation_response: Message sent to users confirming their opt-in to receive messages
|
|
381
|
+
|
|
382
|
+
opt_in_keywords: Keywords used to collect and process consumer opt-ins
|
|
383
|
+
|
|
384
|
+
privacy_policy_url: URL pointing to the business's privacy policy. Plain string, no URL format
|
|
385
|
+
validation.
|
|
386
|
+
|
|
387
|
+
terms_and_condition_url: URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
388
|
+
validation.
|
|
389
|
+
|
|
299
390
|
webhook_url: URL that should receive webhooks relating to this verification request
|
|
300
391
|
|
|
301
392
|
extra_headers: Send extra headers
|
|
@@ -331,7 +422,18 @@ class RequestsResource(SyncAPIResource):
|
|
|
331
422
|
"production_message_content": production_message_content,
|
|
332
423
|
"use_case": use_case,
|
|
333
424
|
"use_case_summary": use_case_summary,
|
|
425
|
+
"age_gated_content": age_gated_content,
|
|
334
426
|
"business_addr2": business_addr2,
|
|
427
|
+
"business_registration_country": business_registration_country,
|
|
428
|
+
"business_registration_number": business_registration_number,
|
|
429
|
+
"business_registration_type": business_registration_type,
|
|
430
|
+
"doing_business_as": doing_business_as,
|
|
431
|
+
"entity_type": entity_type,
|
|
432
|
+
"help_message_response": help_message_response,
|
|
433
|
+
"opt_in_confirmation_response": opt_in_confirmation_response,
|
|
434
|
+
"opt_in_keywords": opt_in_keywords,
|
|
435
|
+
"privacy_policy_url": privacy_policy_url,
|
|
436
|
+
"terms_and_condition_url": terms_and_condition_url,
|
|
335
437
|
"webhook_url": webhook_url,
|
|
336
438
|
},
|
|
337
439
|
request_update_params.RequestUpdateParams,
|
|
@@ -480,7 +582,18 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
480
582
|
production_message_content: str,
|
|
481
583
|
use_case: UseCaseCategories,
|
|
482
584
|
use_case_summary: str,
|
|
585
|
+
age_gated_content: bool | Omit = omit,
|
|
483
586
|
business_addr2: str | Omit = omit,
|
|
587
|
+
business_registration_country: Optional[str] | Omit = omit,
|
|
588
|
+
business_registration_number: Optional[str] | Omit = omit,
|
|
589
|
+
business_registration_type: Optional[str] | Omit = omit,
|
|
590
|
+
doing_business_as: Optional[str] | Omit = omit,
|
|
591
|
+
entity_type: Optional[TollFreeVerificationEntityType] | Omit = omit,
|
|
592
|
+
help_message_response: Optional[str] | Omit = omit,
|
|
593
|
+
opt_in_confirmation_response: Optional[str] | Omit = omit,
|
|
594
|
+
opt_in_keywords: Optional[str] | Omit = omit,
|
|
595
|
+
privacy_policy_url: Optional[str] | Omit = omit,
|
|
596
|
+
terms_and_condition_url: Optional[str] | Omit = omit,
|
|
484
597
|
webhook_url: str | Omit = omit,
|
|
485
598
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
486
599
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
@@ -535,8 +648,36 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
535
648
|
|
|
536
649
|
use_case_summary: Human-readable summary of the desired use-case
|
|
537
650
|
|
|
651
|
+
age_gated_content: Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
652
|
+
false if not provided.
|
|
653
|
+
|
|
538
654
|
business_addr2: Line 2 of the business address
|
|
539
655
|
|
|
656
|
+
business_registration_country: ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
657
|
+
exactly 2 letters. Automatically converted to uppercase. Required from
|
|
658
|
+
January 2026.
|
|
659
|
+
|
|
660
|
+
business_registration_number: Official business registration number (e.g., Employer Identification Number
|
|
661
|
+
(EIN) in the U.S.). Required from January 2026.
|
|
662
|
+
|
|
663
|
+
business_registration_type: Type of business registration being provided. Required from January 2026.
|
|
664
|
+
|
|
665
|
+
doing_business_as: Doing Business As (DBA) name if different from legal name
|
|
666
|
+
|
|
667
|
+
entity_type: Business entity classification
|
|
668
|
+
|
|
669
|
+
help_message_response: The message returned when users text 'HELP'
|
|
670
|
+
|
|
671
|
+
opt_in_confirmation_response: Message sent to users confirming their opt-in to receive messages
|
|
672
|
+
|
|
673
|
+
opt_in_keywords: Keywords used to collect and process consumer opt-ins
|
|
674
|
+
|
|
675
|
+
privacy_policy_url: URL pointing to the business's privacy policy. Plain string, no URL format
|
|
676
|
+
validation.
|
|
677
|
+
|
|
678
|
+
terms_and_condition_url: URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
679
|
+
validation.
|
|
680
|
+
|
|
540
681
|
webhook_url: URL that should receive webhooks relating to this verification request
|
|
541
682
|
|
|
542
683
|
extra_headers: Send extra headers
|
|
@@ -570,7 +711,18 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
570
711
|
"production_message_content": production_message_content,
|
|
571
712
|
"use_case": use_case,
|
|
572
713
|
"use_case_summary": use_case_summary,
|
|
714
|
+
"age_gated_content": age_gated_content,
|
|
573
715
|
"business_addr2": business_addr2,
|
|
716
|
+
"business_registration_country": business_registration_country,
|
|
717
|
+
"business_registration_number": business_registration_number,
|
|
718
|
+
"business_registration_type": business_registration_type,
|
|
719
|
+
"doing_business_as": doing_business_as,
|
|
720
|
+
"entity_type": entity_type,
|
|
721
|
+
"help_message_response": help_message_response,
|
|
722
|
+
"opt_in_confirmation_response": opt_in_confirmation_response,
|
|
723
|
+
"opt_in_keywords": opt_in_keywords,
|
|
724
|
+
"privacy_policy_url": privacy_policy_url,
|
|
725
|
+
"terms_and_condition_url": terms_and_condition_url,
|
|
574
726
|
"webhook_url": webhook_url,
|
|
575
727
|
},
|
|
576
728
|
request_create_params.RequestCreateParams,
|
|
@@ -637,7 +789,18 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
637
789
|
production_message_content: str,
|
|
638
790
|
use_case: UseCaseCategories,
|
|
639
791
|
use_case_summary: str,
|
|
792
|
+
age_gated_content: bool | Omit = omit,
|
|
640
793
|
business_addr2: str | Omit = omit,
|
|
794
|
+
business_registration_country: Optional[str] | Omit = omit,
|
|
795
|
+
business_registration_number: Optional[str] | Omit = omit,
|
|
796
|
+
business_registration_type: Optional[str] | Omit = omit,
|
|
797
|
+
doing_business_as: Optional[str] | Omit = omit,
|
|
798
|
+
entity_type: Optional[TollFreeVerificationEntityType] | Omit = omit,
|
|
799
|
+
help_message_response: Optional[str] | Omit = omit,
|
|
800
|
+
opt_in_confirmation_response: Optional[str] | Omit = omit,
|
|
801
|
+
opt_in_keywords: Optional[str] | Omit = omit,
|
|
802
|
+
privacy_policy_url: Optional[str] | Omit = omit,
|
|
803
|
+
terms_and_condition_url: Optional[str] | Omit = omit,
|
|
641
804
|
webhook_url: str | Omit = omit,
|
|
642
805
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
643
806
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
@@ -694,8 +857,36 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
694
857
|
|
|
695
858
|
use_case_summary: Human-readable summary of the desired use-case
|
|
696
859
|
|
|
860
|
+
age_gated_content: Indicates if messaging content requires age gating (e.g., 18+). Defaults to
|
|
861
|
+
false if not provided.
|
|
862
|
+
|
|
697
863
|
business_addr2: Line 2 of the business address
|
|
698
864
|
|
|
865
|
+
business_registration_country: ISO 3166-1 alpha-2 country code of the issuing business authority. Must be
|
|
866
|
+
exactly 2 letters. Automatically converted to uppercase. Required from
|
|
867
|
+
January 2026.
|
|
868
|
+
|
|
869
|
+
business_registration_number: Official business registration number (e.g., Employer Identification Number
|
|
870
|
+
(EIN) in the U.S.). Required from January 2026.
|
|
871
|
+
|
|
872
|
+
business_registration_type: Type of business registration being provided. Required from January 2026.
|
|
873
|
+
|
|
874
|
+
doing_business_as: Doing Business As (DBA) name if different from legal name
|
|
875
|
+
|
|
876
|
+
entity_type: Business entity classification
|
|
877
|
+
|
|
878
|
+
help_message_response: The message returned when users text 'HELP'
|
|
879
|
+
|
|
880
|
+
opt_in_confirmation_response: Message sent to users confirming their opt-in to receive messages
|
|
881
|
+
|
|
882
|
+
opt_in_keywords: Keywords used to collect and process consumer opt-ins
|
|
883
|
+
|
|
884
|
+
privacy_policy_url: URL pointing to the business's privacy policy. Plain string, no URL format
|
|
885
|
+
validation.
|
|
886
|
+
|
|
887
|
+
terms_and_condition_url: URL pointing to the business's terms and conditions. Plain string, no URL format
|
|
888
|
+
validation.
|
|
889
|
+
|
|
699
890
|
webhook_url: URL that should receive webhooks relating to this verification request
|
|
700
891
|
|
|
701
892
|
extra_headers: Send extra headers
|
|
@@ -731,7 +922,18 @@ class AsyncRequestsResource(AsyncAPIResource):
|
|
|
731
922
|
"production_message_content": production_message_content,
|
|
732
923
|
"use_case": use_case,
|
|
733
924
|
"use_case_summary": use_case_summary,
|
|
925
|
+
"age_gated_content": age_gated_content,
|
|
734
926
|
"business_addr2": business_addr2,
|
|
927
|
+
"business_registration_country": business_registration_country,
|
|
928
|
+
"business_registration_number": business_registration_number,
|
|
929
|
+
"business_registration_type": business_registration_type,
|
|
930
|
+
"doing_business_as": doing_business_as,
|
|
931
|
+
"entity_type": entity_type,
|
|
932
|
+
"help_message_response": help_message_response,
|
|
933
|
+
"opt_in_confirmation_response": opt_in_confirmation_response,
|
|
934
|
+
"opt_in_keywords": opt_in_keywords,
|
|
935
|
+
"privacy_policy_url": privacy_policy_url,
|
|
936
|
+
"terms_and_condition_url": terms_and_condition_url,
|
|
735
937
|
"webhook_url": webhook_url,
|
|
736
938
|
},
|
|
737
939
|
request_update_params.RequestUpdateParams,
|