telnyx 3.3.0a0__py3-none-any.whl → 3.4.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.

Files changed (501) hide show
  1. telnyx/__init__.py +3 -1
  2. telnyx/_base_client.py +12 -12
  3. telnyx/_client.py +63 -762
  4. telnyx/_compat.py +48 -48
  5. telnyx/_models.py +50 -44
  6. telnyx/_qs.py +7 -7
  7. telnyx/_types.py +53 -12
  8. telnyx/_utils/__init__.py +9 -2
  9. telnyx/_utils/_compat.py +45 -0
  10. telnyx/_utils/_datetime_parse.py +136 -0
  11. telnyx/_utils/_transform.py +13 -3
  12. telnyx/_utils/_typing.py +6 -1
  13. telnyx/_utils/_utils.py +4 -5
  14. telnyx/_version.py +1 -1
  15. telnyx/resources/__init__.py +70 -0
  16. telnyx/resources/access_ip_address.py +15 -15
  17. telnyx/resources/access_ip_ranges.py +13 -13
  18. telnyx/resources/actions/purchase.py +13 -14
  19. telnyx/resources/actions/register.py +11 -12
  20. telnyx/resources/addresses/actions.py +13 -13
  21. telnyx/resources/addresses/addresses.py +33 -35
  22. telnyx/resources/advanced_orders.py +102 -106
  23. telnyx/resources/ai/ai.py +7 -7
  24. telnyx/resources/ai/assistants/assistants.py +89 -89
  25. telnyx/resources/ai/assistants/canary_deploys.py +9 -9
  26. telnyx/resources/ai/assistants/scheduled_events.py +21 -21
  27. telnyx/resources/ai/assistants/tests/runs.py +13 -13
  28. telnyx/resources/ai/assistants/tests/test_suites/runs.py +13 -13
  29. telnyx/resources/ai/assistants/tests/test_suites/test_suites.py +3 -3
  30. telnyx/resources/ai/assistants/tests/tests.py +43 -43
  31. telnyx/resources/ai/assistants/tools.py +7 -7
  32. telnyx/resources/ai/assistants/versions.py +45 -45
  33. telnyx/resources/ai/audio.py +11 -11
  34. telnyx/resources/ai/chat.py +48 -48
  35. telnyx/resources/ai/clusters.py +27 -29
  36. telnyx/resources/ai/conversations/conversations.py +179 -45
  37. telnyx/resources/ai/conversations/insight_groups/insight_groups.py +23 -23
  38. telnyx/resources/ai/conversations/insight_groups/insights.py +5 -5
  39. telnyx/resources/ai/conversations/insights.py +25 -25
  40. telnyx/resources/ai/conversations/messages.py +3 -136
  41. telnyx/resources/ai/embeddings/buckets.py +7 -7
  42. telnyx/resources/ai/embeddings/embeddings.py +23 -24
  43. telnyx/resources/ai/fine_tuning/jobs.py +13 -13
  44. telnyx/resources/audit_events.py +9 -9
  45. telnyx/resources/authentication_providers.py +29 -29
  46. telnyx/resources/available_phone_number_blocks.py +5 -5
  47. telnyx/resources/available_phone_numbers.py +5 -5
  48. telnyx/resources/balance.py +3 -3
  49. telnyx/resources/billing_groups.py +17 -17
  50. telnyx/resources/brand/brand.py +121 -117
  51. telnyx/resources/brand/external_vetting.py +9 -9
  52. telnyx/resources/bulk_sim_card_actions.py +11 -11
  53. telnyx/resources/bundle_pricing/billing_bundles.py +13 -13
  54. telnyx/resources/bundle_pricing/user_bundles.py +35 -35
  55. telnyx/resources/call_control_applications.py +64 -68
  56. telnyx/resources/call_events.py +7 -7
  57. telnyx/resources/calls/actions.py +699 -699
  58. telnyx/resources/calls/calls.py +116 -110
  59. telnyx/resources/campaign/campaign.py +47 -47
  60. telnyx/resources/campaign/osr.py +3 -3
  61. telnyx/resources/campaign/usecase.py +3 -3
  62. telnyx/resources/campaign_builder/brand.py +3 -3
  63. telnyx/resources/campaign_builder/campaign_builder.py +68 -68
  64. telnyx/resources/channel_zones.py +7 -7
  65. telnyx/resources/charges_breakdown.py +7 -7
  66. telnyx/resources/charges_summary.py +3 -3
  67. telnyx/resources/comments.py +17 -17
  68. telnyx/resources/conferences/actions.py +123 -140
  69. telnyx/resources/conferences/conferences.py +37 -41
  70. telnyx/resources/connections.py +15 -15
  71. telnyx/resources/country_coverage.py +5 -5
  72. telnyx/resources/credential_connections/actions.py +3 -3
  73. telnyx/resources/credential_connections/credential_connections.py +96 -96
  74. telnyx/resources/custom_storage_credentials.py +9 -9
  75. telnyx/resources/customer_service_records.py +21 -23
  76. telnyx/resources/detail_records.py +9 -11
  77. telnyx/resources/dialogflow_connections.py +25 -25
  78. telnyx/resources/document_links.py +7 -7
  79. telnyx/resources/documents.py +45 -45
  80. telnyx/resources/dynamic_emergency_addresses.py +23 -23
  81. telnyx/resources/dynamic_emergency_endpoints.py +13 -13
  82. telnyx/resources/enum.py +3 -3
  83. telnyx/resources/external_connections/civic_addresses.py +7 -7
  84. telnyx/resources/external_connections/external_connections.py +42 -42
  85. telnyx/resources/external_connections/log_messages.py +11 -11
  86. telnyx/resources/external_connections/phone_numbers.py +13 -13
  87. telnyx/resources/external_connections/releases.py +9 -9
  88. telnyx/resources/external_connections/uploads.py +27 -29
  89. telnyx/resources/fax_applications.py +48 -48
  90. telnyx/resources/faxes/actions.py +5 -5
  91. telnyx/resources/faxes/faxes.py +35 -35
  92. telnyx/resources/fqdn_connections.py +94 -94
  93. telnyx/resources/fqdns.py +25 -25
  94. telnyx/resources/global_ip_allowed_ports.py +3 -3
  95. telnyx/resources/global_ip_assignment_health.py +5 -5
  96. telnyx/resources/global_ip_assignments.py +19 -19
  97. telnyx/resources/global_ip_assignments_usage.py +5 -5
  98. telnyx/resources/global_ip_health_check_types.py +3 -3
  99. telnyx/resources/global_ip_health_checks.py +17 -17
  100. telnyx/resources/global_ip_latency.py +5 -5
  101. telnyx/resources/global_ip_protocols.py +3 -3
  102. telnyx/resources/global_ip_usage.py +5 -5
  103. telnyx/resources/global_ips.py +17 -17
  104. telnyx/resources/inbound_channels.py +5 -5
  105. telnyx/resources/integration_secrets.py +17 -17
  106. telnyx/resources/inventory_coverage.py +5 -5
  107. telnyx/resources/invoices.py +11 -11
  108. telnyx/resources/ip_connections.py +94 -94
  109. telnyx/resources/ips.py +23 -23
  110. telnyx/resources/ledger_billing_group_reports.py +9 -9
  111. telnyx/resources/legacy/__init__.py +33 -0
  112. telnyx/resources/legacy/legacy.py +102 -0
  113. telnyx/resources/legacy/reporting/__init__.py +47 -0
  114. telnyx/resources/legacy/reporting/batch_detail_records/__init__.py +61 -0
  115. telnyx/resources/legacy/reporting/batch_detail_records/batch_detail_records.py +166 -0
  116. telnyx/resources/legacy/reporting/batch_detail_records/messaging.py +482 -0
  117. telnyx/resources/legacy/reporting/batch_detail_records/speech_to_text.py +399 -0
  118. telnyx/resources/legacy/reporting/batch_detail_records/voice.py +539 -0
  119. telnyx/resources/legacy/reporting/reporting.py +134 -0
  120. telnyx/resources/legacy/reporting/usage_reports/__init__.py +61 -0
  121. telnyx/resources/legacy/reporting/usage_reports/messaging.py +471 -0
  122. telnyx/resources/legacy/reporting/usage_reports/number_lookup.py +464 -0
  123. telnyx/resources/legacy/reporting/usage_reports/usage_reports.py +288 -0
  124. telnyx/resources/legacy/reporting/usage_reports/voice.py +493 -0
  125. telnyx/resources/list.py +5 -5
  126. telnyx/resources/managed_accounts/actions.py +7 -7
  127. telnyx/resources/managed_accounts/managed_accounts.py +33 -33
  128. telnyx/resources/media.py +23 -23
  129. telnyx/resources/messages/messages.py +124 -124
  130. telnyx/resources/messages/rcs.py +7 -7
  131. telnyx/resources/messaging/rcs/agents.py +15 -15
  132. telnyx/resources/messaging/rcs/rcs.py +9 -11
  133. telnyx/resources/messaging_hosted_number_orders/actions.py +7 -7
  134. telnyx/resources/messaging_hosted_number_orders/messaging_hosted_number_orders.py +26 -26
  135. telnyx/resources/messaging_hosted_numbers.py +3 -3
  136. telnyx/resources/messaging_numbers_bulk_updates.py +7 -9
  137. telnyx/resources/messaging_optouts.py +11 -11
  138. telnyx/resources/messaging_profiles/autoresp_configs.py +25 -26
  139. telnyx/resources/messaging_profiles/messaging_profiles.py +92 -76
  140. telnyx/resources/messaging_tollfree/verification/requests.py +27 -27
  141. telnyx/resources/messaging_url_domains.py +5 -5
  142. telnyx/resources/messsages.py +11 -11
  143. telnyx/resources/mobile_network_operators.py +7 -7
  144. telnyx/resources/mobile_push_credentials.py +23 -23
  145. telnyx/resources/network_coverage.py +9 -9
  146. telnyx/resources/networks/default_gateway.py +9 -9
  147. telnyx/resources/networks/networks.py +21 -21
  148. telnyx/resources/notification_channels.py +27 -27
  149. telnyx/resources/notification_event_conditions.py +7 -7
  150. telnyx/resources/notification_events.py +5 -5
  151. telnyx/resources/notification_profiles.py +17 -17
  152. telnyx/resources/notification_settings.py +21 -21
  153. telnyx/resources/number_block_orders.py +17 -17
  154. telnyx/resources/number_lookup.py +5 -5
  155. telnyx/resources/number_order_phone_numbers.py +13 -13
  156. telnyx/resources/number_orders.py +27 -27
  157. telnyx/resources/number_reservations/actions.py +3 -3
  158. telnyx/resources/number_reservations/number_reservations.py +15 -15
  159. telnyx/resources/numbers_features.py +5 -7
  160. telnyx/resources/oauth.py +855 -0
  161. telnyx/resources/oauth_clients.py +711 -0
  162. telnyx/resources/oauth_grants.py +349 -0
  163. telnyx/resources/operator_connect/actions.py +3 -3
  164. telnyx/resources/ota_updates.py +9 -9
  165. telnyx/resources/outbound_voice_profiles.py +66 -66
  166. telnyx/resources/partner_campaigns.py +25 -25
  167. telnyx/resources/payment/auto_recharge_prefs.py +15 -15
  168. telnyx/resources/phone_number_assignment_by_profile.py +15 -15
  169. telnyx/resources/phone_number_blocks/jobs.py +13 -13
  170. telnyx/resources/phone_number_campaigns.py +19 -19
  171. telnyx/resources/phone_numbers/actions.py +9 -11
  172. telnyx/resources/phone_numbers/csv_downloads.py +13 -13
  173. telnyx/resources/phone_numbers/jobs.py +54 -42
  174. telnyx/resources/phone_numbers/messaging.py +13 -13
  175. telnyx/resources/phone_numbers/phone_numbers.py +39 -40
  176. telnyx/resources/phone_numbers/voice.py +31 -31
  177. telnyx/resources/phone_numbers/voicemail.py +15 -15
  178. telnyx/resources/phone_numbers_regulatory_requirements.py +5 -5
  179. telnyx/resources/portability_checks.py +5 -7
  180. telnyx/resources/porting/events.py +11 -11
  181. telnyx/resources/porting/loa_configurations.py +17 -17
  182. telnyx/resources/porting/porting.py +3 -3
  183. telnyx/resources/porting/reports.py +11 -11
  184. telnyx/resources/porting_orders/action_requirements.py +11 -11
  185. telnyx/resources/porting_orders/actions.py +13 -13
  186. telnyx/resources/porting_orders/activation_jobs.py +11 -11
  187. telnyx/resources/porting_orders/additional_documents.py +15 -15
  188. telnyx/resources/porting_orders/associated_phone_numbers.py +13 -13
  189. telnyx/resources/porting_orders/comments.py +9 -9
  190. telnyx/resources/porting_orders/phone_number_blocks.py +13 -13
  191. telnyx/resources/porting_orders/phone_number_configurations.py +13 -13
  192. telnyx/resources/porting_orders/phone_number_extensions.py +13 -13
  193. telnyx/resources/porting_orders/porting_orders.py +82 -70
  194. telnyx/resources/porting_orders/verification_codes.py +20 -20
  195. telnyx/resources/porting_phone_numbers.py +7 -7
  196. telnyx/resources/portouts/comments.py +7 -7
  197. telnyx/resources/portouts/events.py +11 -11
  198. telnyx/resources/portouts/portouts.py +17 -17
  199. telnyx/resources/portouts/reports.py +11 -11
  200. telnyx/resources/portouts/supporting_documents.py +7 -7
  201. telnyx/resources/private_wireless_gateways.py +25 -25
  202. telnyx/resources/public_internet_gateways.py +19 -19
  203. telnyx/resources/queues/calls.py +7 -7
  204. telnyx/resources/queues/queues.py +3 -3
  205. telnyx/resources/recording_transcriptions.py +7 -7
  206. telnyx/resources/recordings/actions.py +5 -7
  207. telnyx/resources/recordings/recordings.py +11 -11
  208. telnyx/resources/regions.py +3 -3
  209. telnyx/resources/regulatory_requirements.py +5 -5
  210. telnyx/resources/reports/cdr_usage_reports.py +9 -9
  211. telnyx/resources/reports/mdr_usage_reports.py +22 -22
  212. telnyx/resources/reports/reports.py +47 -48
  213. telnyx/resources/requirement_groups.py +23 -23
  214. telnyx/resources/requirement_types.py +9 -11
  215. telnyx/resources/requirements.py +11 -11
  216. telnyx/resources/room_compositions.py +27 -27
  217. telnyx/resources/room_participants.py +9 -9
  218. telnyx/resources/room_recordings.py +17 -17
  219. telnyx/resources/rooms/actions.py +11 -11
  220. telnyx/resources/rooms/rooms.py +43 -43
  221. telnyx/resources/rooms/sessions/actions.py +22 -22
  222. telnyx/resources/rooms/sessions/sessions.py +27 -27
  223. telnyx/resources/seti.py +5 -5
  224. telnyx/resources/short_codes.py +11 -11
  225. telnyx/resources/sim_card_data_usage_notifications.py +21 -21
  226. telnyx/resources/sim_card_groups/actions.py +23 -23
  227. telnyx/resources/sim_card_groups/sim_card_groups.py +29 -29
  228. telnyx/resources/sim_card_order_preview.py +3 -3
  229. telnyx/resources/sim_card_orders.py +11 -11
  230. telnyx/resources/sim_cards/actions.py +29 -31
  231. telnyx/resources/sim_cards/sim_cards.py +48 -48
  232. telnyx/resources/siprec_connectors.py +13 -13
  233. telnyx/resources/storage/buckets/buckets.py +5 -5
  234. telnyx/resources/storage/buckets/ssl_certificate.py +11 -11
  235. telnyx/resources/storage/buckets/usage.py +5 -5
  236. telnyx/resources/storage/migration_sources.py +11 -11
  237. telnyx/resources/storage/migrations/actions.py +3 -3
  238. telnyx/resources/storage/migrations/migrations.py +9 -9
  239. telnyx/resources/storage/storage.py +3 -3
  240. telnyx/resources/sub_number_orders.py +17 -17
  241. telnyx/resources/sub_number_orders_report.py +19 -19
  242. telnyx/resources/telephony_credentials.py +31 -31
  243. telnyx/resources/texml/accounts/accounts.py +15 -15
  244. telnyx/resources/texml/accounts/calls/calls.py +156 -145
  245. telnyx/resources/texml/accounts/calls/recordings.py +5 -5
  246. telnyx/resources/texml/accounts/calls/recordings_json.py +19 -19
  247. telnyx/resources/texml/accounts/calls/siprec.py +5 -5
  248. telnyx/resources/texml/accounts/calls/streams.py +5 -5
  249. telnyx/resources/texml/accounts/conferences/conferences.py +31 -31
  250. telnyx/resources/texml/accounts/conferences/participants.py +134 -123
  251. telnyx/resources/texml/accounts/recordings/json.py +5 -5
  252. telnyx/resources/texml/accounts/transcriptions/json.py +5 -5
  253. telnyx/resources/texml/calls.py +79 -79
  254. telnyx/resources/texml/texml.py +3 -3
  255. telnyx/resources/texml_applications.py +65 -66
  256. telnyx/resources/text_to_speech.py +9 -9
  257. telnyx/resources/usage_reports.py +31 -32
  258. telnyx/resources/user_addresses.py +29 -31
  259. telnyx/resources/user_tags.py +5 -5
  260. telnyx/resources/verifications/actions.py +7 -7
  261. telnyx/resources/verifications/by_phone_number/actions.py +3 -3
  262. telnyx/resources/verifications/by_phone_number/by_phone_number.py +3 -3
  263. telnyx/resources/verifications/verifications.py +29 -19
  264. telnyx/resources/verified_numbers/actions.py +3 -3
  265. telnyx/resources/verified_numbers/verified_numbers.py +36 -15
  266. telnyx/resources/verify_profiles.py +226 -44
  267. telnyx/resources/virtual_cross_connects.py +45 -45
  268. telnyx/resources/virtual_cross_connects_coverage.py +9 -9
  269. telnyx/resources/webhook_deliveries.py +9 -9
  270. telnyx/resources/well_known.py +198 -0
  271. telnyx/resources/wireguard_interfaces.py +17 -17
  272. telnyx/resources/wireguard_peers.py +21 -21
  273. telnyx/resources/wireless/detail_records_reports.py +17 -17
  274. telnyx/resources/wireless/wireless.py +3 -3
  275. telnyx/resources/wireless_blocklist_values.py +3 -3
  276. telnyx/resources/wireless_blocklists.py +29 -30
  277. telnyx/types/__init__.py +53 -13
  278. telnyx/types/actions/purchase_create_params.py +3 -2
  279. telnyx/types/actions/register_create_params.py +4 -3
  280. telnyx/types/addresses/action_validate_response.py +8 -3
  281. telnyx/types/{advanced_order_update_params.py → advanced_order_update_requirement_group_params.py} +2 -2
  282. telnyx/types/ai/__init__.py +1 -0
  283. telnyx/types/ai/chat_create_completion_params.py +3 -2
  284. telnyx/types/ai/cluster_compute_params.py +3 -2
  285. telnyx/types/ai/{conversations/message_create_params.py → conversation_add_message_params.py} +6 -5
  286. telnyx/types/ai/conversations/__init__.py +0 -1
  287. telnyx/types/ai/embedding_list_params.py +3 -2
  288. telnyx/types/ai/inference_embedding_bucket_ids_param.py +3 -2
  289. telnyx/types/ai/inference_embedding_transfer_tool_params.py +6 -0
  290. telnyx/types/ai/inference_embedding_transfer_tool_params_param.py +6 -0
  291. telnyx/types/ai/inference_embedding_webhook_tool_params.py +2 -0
  292. telnyx/types/ai/inference_embedding_webhook_tool_params_param.py +8 -4
  293. telnyx/types/ai/voice_settings.py +49 -2
  294. telnyx/types/ai/voice_settings_param.py +49 -2
  295. telnyx/types/brand_create_params.py +2 -1
  296. telnyx/types/brand_update_params.py +2 -1
  297. telnyx/types/bundle_pricing/billing_bundle_list_params.py +4 -3
  298. telnyx/types/bundle_pricing/user_bundle_list_params.py +4 -3
  299. telnyx/types/bundle_pricing/user_bundle_list_unused_params.py +4 -3
  300. telnyx/types/call_control_application_update_params.py +3 -2
  301. telnyx/types/call_dial_params.py +14 -6
  302. telnyx/types/calls/action_answer_params.py +1 -2
  303. telnyx/types/calls/action_gather_using_ai_params.py +5 -8
  304. telnyx/types/calls/action_start_streaming_params.py +4 -2
  305. telnyx/types/calls/action_start_transcription_params.py +260 -6
  306. telnyx/types/calls/action_transfer_params.py +50 -0
  307. telnyx/types/calls/transcription_engine_a_config_param.py +4 -3
  308. telnyx/types/calls/transcription_start_request_param.py +261 -6
  309. telnyx/types/campaign_builder_create_params.py +4 -3
  310. telnyx/types/campaign_submit_appeal_response.py +0 -3
  311. telnyx/types/conferences/action_hold_params.py +3 -2
  312. telnyx/types/conferences/action_join_params.py +3 -2
  313. telnyx/types/conferences/action_mute_params.py +3 -2
  314. telnyx/types/conferences/action_play_params.py +2 -2
  315. telnyx/types/conferences/action_speak_params.py +3 -2
  316. telnyx/types/conferences/action_stop_params.py +3 -2
  317. telnyx/types/conferences/action_unhold_params.py +3 -2
  318. telnyx/types/conferences/action_unmute_params.py +3 -2
  319. telnyx/types/conferences/action_update_params.py +3 -2
  320. telnyx/types/country_coverage_retrieve_country_response.py +7 -0
  321. telnyx/types/country_coverage_retrieve_response.py +7 -0
  322. telnyx/types/credential_connection_create_params.py +3 -2
  323. telnyx/types/credential_connection_update_params.py +3 -2
  324. telnyx/types/credential_inbound_param.py +3 -2
  325. telnyx/types/customer_service_record_list_params.py +2 -1
  326. telnyx/types/customer_service_record_verify_phone_number_coverage_params.py +3 -2
  327. telnyx/types/detail_record_list_params.py +4 -2
  328. telnyx/types/document_list_params.py +2 -1
  329. telnyx/types/external_connection_create_params.py +4 -2
  330. telnyx/types/external_connection_update_params.py +4 -2
  331. telnyx/types/external_connections/civic_address_list_params.py +3 -2
  332. telnyx/types/external_connections/upload_create_params.py +3 -1
  333. telnyx/types/fax_application_create_params.py +3 -2
  334. telnyx/types/fax_application_update_params.py +3 -2
  335. telnyx/types/fqdn_connection_create_params.py +3 -2
  336. telnyx/types/fqdn_connection_update_params.py +3 -2
  337. telnyx/types/global_ip_latency_retrieve_response.py +7 -7
  338. telnyx/types/inbound_fqdn_param.py +4 -2
  339. telnyx/types/inbound_ip_param.py +3 -2
  340. telnyx/types/ip_connection_create_params.py +4 -3
  341. telnyx/types/ip_connection_update_params.py +3 -2
  342. telnyx/types/legacy/__init__.py +3 -0
  343. telnyx/types/legacy/reporting/__init__.py +12 -0
  344. telnyx/types/legacy/reporting/batch_detail_records/__init__.py +23 -0
  345. telnyx/types/legacy/reporting/batch_detail_records/cdr_detailed_req_response.py +63 -0
  346. telnyx/types/legacy/reporting/batch_detail_records/mdr_detail_report_response.py +42 -0
  347. telnyx/types/legacy/reporting/batch_detail_records/messaging_create_params.py +55 -0
  348. telnyx/types/legacy/reporting/batch_detail_records/messaging_create_response.py +12 -0
  349. telnyx/types/legacy/reporting/batch_detail_records/messaging_delete_response.py +12 -0
  350. telnyx/types/legacy/reporting/batch_detail_records/messaging_list_response.py +24 -0
  351. telnyx/types/legacy/reporting/batch_detail_records/messaging_retrieve_response.py +12 -0
  352. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_params.py +19 -0
  353. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_response.py +12 -0
  354. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_delete_response.py +12 -0
  355. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_list_response.py +12 -0
  356. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_retrieve_response.py +12 -0
  357. telnyx/types/legacy/reporting/batch_detail_records/stt_detail_report_response.py +27 -0
  358. telnyx/types/legacy/reporting/batch_detail_records/voice_create_params.py +57 -0
  359. telnyx/types/legacy/reporting/batch_detail_records/voice_create_response.py +13 -0
  360. telnyx/types/legacy/reporting/batch_detail_records/voice_delete_response.py +13 -0
  361. telnyx/types/legacy/reporting/batch_detail_records/voice_list_response.py +24 -0
  362. telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_fields_response.py +23 -0
  363. telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_response.py +13 -0
  364. telnyx/types/legacy/reporting/filter.py +31 -0
  365. telnyx/types/legacy/reporting/filter_param.py +30 -0
  366. telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_params.py +17 -0
  367. telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_response.py +11 -0
  368. telnyx/types/legacy/reporting/usage_reports/__init__.py +20 -0
  369. telnyx/types/legacy/reporting/usage_reports/cdr_usage_report_response_legacy.py +43 -0
  370. telnyx/types/legacy/reporting/usage_reports/mdr_usage_report_response_legacy.py +38 -0
  371. telnyx/types/legacy/reporting/usage_reports/messaging_create_params.py +29 -0
  372. telnyx/types/legacy/reporting/usage_reports/messaging_create_response.py +13 -0
  373. telnyx/types/legacy/reporting/usage_reports/messaging_delete_response.py +13 -0
  374. telnyx/types/legacy/reporting/usage_reports/messaging_list_params.py +15 -0
  375. telnyx/types/legacy/reporting/usage_reports/messaging_list_response.py +24 -0
  376. telnyx/types/legacy/reporting/usage_reports/messaging_retrieve_response.py +13 -0
  377. telnyx/types/legacy/reporting/usage_reports/number_lookup_create_params.py +26 -0
  378. telnyx/types/legacy/reporting/usage_reports/number_lookup_list_params.py +13 -0
  379. telnyx/types/legacy/reporting/usage_reports/voice_create_params.py +40 -0
  380. telnyx/types/legacy/reporting/usage_reports/voice_create_response.py +13 -0
  381. telnyx/types/legacy/reporting/usage_reports/voice_delete_response.py +13 -0
  382. telnyx/types/legacy/reporting/usage_reports/voice_list_params.py +15 -0
  383. telnyx/types/legacy/reporting/usage_reports/voice_list_response.py +24 -0
  384. telnyx/types/legacy/reporting/usage_reports/voice_retrieve_response.py +13 -0
  385. telnyx/types/media_list_params.py +3 -2
  386. telnyx/types/message_schedule_params.py +3 -2
  387. telnyx/types/message_send_group_mms_params.py +3 -3
  388. telnyx/types/message_send_long_code_params.py +2 -2
  389. telnyx/types/message_send_number_pool_params.py +3 -2
  390. telnyx/types/message_send_params.py +3 -2
  391. telnyx/types/message_send_short_code_params.py +2 -2
  392. telnyx/types/messaging/rc_list_bulk_capabilities_params.py +3 -2
  393. telnyx/types/messaging_hosted_number_order_check_eligibility_params.py +3 -2
  394. telnyx/types/messaging_hosted_number_order_create_params.py +3 -2
  395. telnyx/types/messaging_hosted_number_order_create_verification_codes_params.py +3 -2
  396. telnyx/types/messaging_numbers_bulk_update_create_params.py +3 -2
  397. telnyx/types/messaging_profile.py +3 -0
  398. telnyx/types/messaging_profile_create_params.py +6 -2
  399. telnyx/types/messaging_profile_update_params.py +6 -2
  400. telnyx/types/messaging_profiles/autoresp_config_create_params.py +3 -2
  401. telnyx/types/messaging_profiles/autoresp_config_update_params.py +3 -2
  402. telnyx/types/messsage_rcs_params.py +2 -2
  403. telnyx/types/number_order_status_update_webhook_event.py +30 -4
  404. telnyx/types/numbers_feature_create_params.py +3 -2
  405. telnyx/types/oauth_client.py +59 -0
  406. telnyx/types/oauth_client_create_params.py +39 -0
  407. telnyx/types/oauth_client_create_response.py +12 -0
  408. telnyx/types/oauth_client_list_params.py +38 -0
  409. telnyx/types/oauth_client_list_response.py +28 -0
  410. telnyx/types/oauth_client_retrieve_response.py +12 -0
  411. telnyx/types/oauth_client_update_params.py +36 -0
  412. telnyx/types/oauth_client_update_response.py +12 -0
  413. telnyx/types/oauth_grant.py +29 -0
  414. telnyx/types/oauth_grant_delete_response.py +12 -0
  415. telnyx/types/oauth_grant_list_params.py +17 -0
  416. telnyx/types/oauth_grant_list_response.py +28 -0
  417. telnyx/types/oauth_grant_retrieve_response.py +12 -0
  418. telnyx/types/oauth_grants_params.py +15 -0
  419. telnyx/types/oauth_grants_response.py +10 -0
  420. telnyx/types/oauth_introspect_params.py +12 -0
  421. telnyx/types/oauth_introspect_response.py +30 -0
  422. telnyx/types/oauth_register_params.py +39 -0
  423. telnyx/types/oauth_register_response.py +45 -0
  424. telnyx/types/oauth_retrieve_authorize_params.py +30 -0
  425. telnyx/types/oauth_retrieve_jwks_response.py +25 -0
  426. telnyx/types/oauth_retrieve_response.py +47 -0
  427. telnyx/types/oauth_token_params.py +33 -0
  428. telnyx/types/oauth_token_response.py +25 -0
  429. telnyx/types/outbound_call_recording_param.py +3 -2
  430. telnyx/types/outbound_voice_profile_create_params.py +4 -3
  431. telnyx/types/outbound_voice_profile_update_params.py +4 -3
  432. telnyx/types/phone_number_delete_response.py +7 -0
  433. telnyx/types/phone_number_detailed.py +7 -0
  434. telnyx/types/phone_number_list_params.py +9 -2
  435. telnyx/types/phone_number_slim_list_params.py +3 -2
  436. telnyx/types/phone_number_update_params.py +3 -2
  437. telnyx/types/phone_numbers/action_verify_ownership_params.py +3 -2
  438. telnyx/types/phone_numbers/job_delete_batch_params.py +3 -2
  439. telnyx/types/phone_numbers/job_update_batch_params.py +10 -3
  440. telnyx/types/phone_numbers/job_update_emergency_settings_batch_params.py +4 -2
  441. telnyx/types/portability_check_run_params.py +3 -2
  442. telnyx/types/porting/export_porting_orders_csv_report_param.py +2 -1
  443. telnyx/types/porting_order.py +3 -0
  444. telnyx/types/porting_order_create_params.py +6 -2
  445. telnyx/types/porting_order_list_params.py +52 -31
  446. telnyx/types/porting_order_phone_number_configuration_param.py +3 -2
  447. telnyx/types/porting_order_update_params.py +2 -0
  448. telnyx/types/porting_orders/action_requirement_list_params.py +3 -2
  449. telnyx/types/porting_orders/phone_number_block_list_params.py +5 -3
  450. telnyx/types/porting_orders/phone_number_configuration_list_params.py +22 -21
  451. telnyx/types/porting_orders/verification_code_send_params.py +3 -2
  452. telnyx/types/portout_list_params.py +2 -1
  453. telnyx/types/portouts/export_portouts_csv_report_param.py +3 -2
  454. telnyx/types/recordings/action_delete_params.py +3 -2
  455. telnyx/types/report_list_wdrs_params.py +3 -2
  456. telnyx/types/reports/mdr_usage_report_fetch_sync_params.py +3 -2
  457. telnyx/types/rooms/sessions/action_kick_params.py +5 -3
  458. telnyx/types/rooms/sessions/action_mute_params.py +5 -3
  459. telnyx/types/rooms/sessions/action_unmute_params.py +5 -3
  460. telnyx/types/shared/__init__.py +1 -0
  461. telnyx/types/{error.py → shared/api_error.py} +3 -3
  462. telnyx/types/shared/simple_sim_card.py +15 -0
  463. telnyx/types/sim_card.py +12 -0
  464. telnyx/types/sim_card_list_params.py +2 -1
  465. telnyx/types/sim_card_update_params.py +4 -3
  466. telnyx/types/sim_cards/action_bulk_set_public_ips_params.py +3 -2
  467. telnyx/types/sim_cards/action_validate_registration_codes_params.py +3 -2
  468. telnyx/types/stream_bidirectional_codec.py +1 -1
  469. telnyx/types/stream_codec.py +1 -1
  470. telnyx/types/texml/accounts/call_calls_params.py +16 -1
  471. telnyx/types/texml/accounts/conferences/participant_participants_params.py +16 -1
  472. telnyx/types/texml_application_create_params.py +2 -2
  473. telnyx/types/texml_application_update_params.py +2 -2
  474. telnyx/types/usage_report_list_params.py +5 -4
  475. telnyx/types/verification_trigger_call_params.py +7 -0
  476. telnyx/types/verified_number_create_params.py +10 -0
  477. telnyx/types/verify_profile.py +18 -3
  478. telnyx/types/verify_profile_create_params.py +6 -4
  479. telnyx/types/verify_profile_create_template_params.py +12 -0
  480. telnyx/types/verify_profile_create_template_response.py +12 -0
  481. telnyx/types/verify_profile_message_template_response.py +13 -0
  482. telnyx/types/verify_profile_retrieve_templates_response.py +4 -9
  483. telnyx/types/verify_profile_update_params.py +6 -4
  484. telnyx/types/verify_profile_update_template_params.py +12 -0
  485. telnyx/types/verify_profile_update_template_response.py +12 -0
  486. telnyx/types/video_region_param.py +4 -2
  487. telnyx/types/well_known_retrieve_authorization_server_metadata_response.py +42 -0
  488. telnyx/types/well_known_retrieve_protected_resource_metadata_response.py +15 -0
  489. telnyx/types/wireless_blocklist_create_params.py +3 -2
  490. telnyx/types/wireless_blocklist_update_params.py +3 -2
  491. {telnyx-3.3.0a0.dist-info → telnyx-3.4.0.dist-info}/METADATA +60 -19
  492. {telnyx-3.3.0a0.dist-info → telnyx-3.4.0.dist-info}/RECORD +494 -407
  493. telnyx/types/client_create_bucket_params.py +0 -13
  494. telnyx/types/client_delete_objects_params.py +0 -20
  495. telnyx/types/client_get_object_params.py +0 -15
  496. telnyx/types/client_list_objects_params.py +0 -13
  497. telnyx/types/client_put_object_params.py +0 -20
  498. telnyx/types/list_buckets_response.py +0 -20
  499. telnyx/types/list_objects_response.py +0 -24
  500. {telnyx-3.3.0a0.dist-info → telnyx-3.4.0.dist-info}/WHEEL +0 -0
  501. {telnyx-3.3.0a0.dist-info → telnyx-3.4.0.dist-info}/licenses/LICENSE +0 -0
@@ -16,7 +16,7 @@ from ...types import (
16
16
  brand_create_params,
17
17
  brand_update_params,
18
18
  )
19
- from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
19
+ from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
20
20
  from ..._utils import maybe_transform, async_maybe_transform
21
21
  from ..._compat import cached_property
22
22
  from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -80,31 +80,31 @@ class BrandResource(SyncAPIResource):
80
80
  email: str,
81
81
  entity_type: EntityType,
82
82
  vertical: Vertical,
83
- business_contact_email: str | NotGiven = NOT_GIVEN,
84
- city: str | NotGiven = NOT_GIVEN,
85
- company_name: str | NotGiven = NOT_GIVEN,
86
- ein: str | NotGiven = NOT_GIVEN,
87
- first_name: str | NotGiven = NOT_GIVEN,
88
- ip_address: str | NotGiven = NOT_GIVEN,
89
- is_reseller: bool | NotGiven = NOT_GIVEN,
90
- last_name: str | NotGiven = NOT_GIVEN,
91
- mobile_phone: str | NotGiven = NOT_GIVEN,
92
- mock: bool | NotGiven = NOT_GIVEN,
93
- phone: str | NotGiven = NOT_GIVEN,
94
- postal_code: str | NotGiven = NOT_GIVEN,
95
- state: str | NotGiven = NOT_GIVEN,
96
- stock_exchange: StockExchange | NotGiven = NOT_GIVEN,
97
- stock_symbol: str | NotGiven = NOT_GIVEN,
98
- street: str | NotGiven = NOT_GIVEN,
99
- webhook_failover_url: str | NotGiven = NOT_GIVEN,
100
- webhook_url: str | NotGiven = NOT_GIVEN,
101
- website: str | NotGiven = NOT_GIVEN,
83
+ business_contact_email: str | Omit = omit,
84
+ city: str | Omit = omit,
85
+ company_name: str | Omit = omit,
86
+ ein: str | Omit = omit,
87
+ first_name: str | Omit = omit,
88
+ ip_address: str | Omit = omit,
89
+ is_reseller: bool | Omit = omit,
90
+ last_name: str | Omit = omit,
91
+ mobile_phone: str | Omit = omit,
92
+ mock: bool | Omit = omit,
93
+ phone: str | Omit = omit,
94
+ postal_code: str | Omit = omit,
95
+ state: str | Omit = omit,
96
+ stock_exchange: StockExchange | Omit = omit,
97
+ stock_symbol: str | Omit = omit,
98
+ street: str | Omit = omit,
99
+ webhook_failover_url: str | Omit = omit,
100
+ webhook_url: str | Omit = omit,
101
+ website: str | Omit = omit,
102
102
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
103
103
  # The extra values given here take precedence over values defined on the client or passed to this method.
104
104
  extra_headers: Headers | None = None,
105
105
  extra_query: Query | None = None,
106
106
  extra_body: Body | None = None,
107
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
107
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
108
108
  ) -> TelnyxBrand:
109
109
  """This endpoint is used to create a new brand.
110
110
 
@@ -126,7 +126,8 @@ class BrandResource(SyncAPIResource):
126
126
 
127
127
  business_contact_email: Business contact email.
128
128
 
129
- Required if `entityType` is `PUBLIC_PROFIT`.
129
+ Required if `entityType` is `PUBLIC_PROFIT`. Otherwise, it is recommended to
130
+ either omit this field or set it to `null`.
130
131
 
131
132
  city: City name
132
133
 
@@ -217,7 +218,7 @@ class BrandResource(SyncAPIResource):
217
218
  extra_headers: Headers | None = None,
218
219
  extra_query: Query | None = None,
219
220
  extra_body: Body | None = None,
220
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
221
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
221
222
  ) -> BrandRetrieveResponse:
222
223
  """
223
224
  Retrieve a brand by `brandId`.
@@ -250,32 +251,32 @@ class BrandResource(SyncAPIResource):
250
251
  email: str,
251
252
  entity_type: EntityType,
252
253
  vertical: Vertical,
253
- alt_business_id: str | NotGiven = NOT_GIVEN,
254
- alt_business_id_type: AltBusinessIDType | NotGiven = NOT_GIVEN,
255
- business_contact_email: str | NotGiven = NOT_GIVEN,
256
- city: str | NotGiven = NOT_GIVEN,
257
- company_name: str | NotGiven = NOT_GIVEN,
258
- ein: str | NotGiven = NOT_GIVEN,
259
- first_name: str | NotGiven = NOT_GIVEN,
260
- identity_status: BrandIdentityStatus | NotGiven = NOT_GIVEN,
261
- ip_address: str | NotGiven = NOT_GIVEN,
262
- is_reseller: bool | NotGiven = NOT_GIVEN,
263
- last_name: str | NotGiven = NOT_GIVEN,
264
- phone: str | NotGiven = NOT_GIVEN,
265
- postal_code: str | NotGiven = NOT_GIVEN,
266
- state: str | NotGiven = NOT_GIVEN,
267
- stock_exchange: StockExchange | NotGiven = NOT_GIVEN,
268
- stock_symbol: str | NotGiven = NOT_GIVEN,
269
- street: str | NotGiven = NOT_GIVEN,
270
- webhook_failover_url: str | NotGiven = NOT_GIVEN,
271
- webhook_url: str | NotGiven = NOT_GIVEN,
272
- website: str | NotGiven = NOT_GIVEN,
254
+ alt_business_id: str | Omit = omit,
255
+ alt_business_id_type: AltBusinessIDType | Omit = omit,
256
+ business_contact_email: str | Omit = omit,
257
+ city: str | Omit = omit,
258
+ company_name: str | Omit = omit,
259
+ ein: str | Omit = omit,
260
+ first_name: str | Omit = omit,
261
+ identity_status: BrandIdentityStatus | Omit = omit,
262
+ ip_address: str | Omit = omit,
263
+ is_reseller: bool | Omit = omit,
264
+ last_name: str | Omit = omit,
265
+ phone: str | Omit = omit,
266
+ postal_code: str | Omit = omit,
267
+ state: str | Omit = omit,
268
+ stock_exchange: StockExchange | Omit = omit,
269
+ stock_symbol: str | Omit = omit,
270
+ street: str | Omit = omit,
271
+ webhook_failover_url: str | Omit = omit,
272
+ webhook_url: str | Omit = omit,
273
+ website: str | Omit = omit,
273
274
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
274
275
  # The extra values given here take precedence over values defined on the client or passed to this method.
275
276
  extra_headers: Headers | None = None,
276
277
  extra_query: Query | None = None,
277
278
  extra_body: Body | None = None,
278
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
279
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
279
280
  ) -> TelnyxBrand:
280
281
  """
281
282
  Update a brand's attributes by `brandId`.
@@ -297,7 +298,8 @@ class BrandResource(SyncAPIResource):
297
298
 
298
299
  business_contact_email: Business contact email.
299
300
 
300
- Required if `entityType` will be changed to `PUBLIC_PROFIT`.
301
+ Required if `entityType` will be changed to `PUBLIC_PROFIT`. Otherwise, it is
302
+ recommended to either omit this field or set it to `null`.
301
303
 
302
304
  city: City name
303
305
 
@@ -383,12 +385,12 @@ class BrandResource(SyncAPIResource):
383
385
  def list(
384
386
  self,
385
387
  *,
386
- brand_id: str | NotGiven = NOT_GIVEN,
387
- country: str | NotGiven = NOT_GIVEN,
388
- display_name: str | NotGiven = NOT_GIVEN,
389
- entity_type: str | NotGiven = NOT_GIVEN,
390
- page: int | NotGiven = NOT_GIVEN,
391
- records_per_page: int | NotGiven = NOT_GIVEN,
388
+ brand_id: str | Omit = omit,
389
+ country: str | Omit = omit,
390
+ display_name: str | Omit = omit,
391
+ entity_type: str | Omit = omit,
392
+ page: int | Omit = omit,
393
+ records_per_page: int | Omit = omit,
392
394
  sort: Literal[
393
395
  "assignedCampaignsCount",
394
396
  "-assignedCampaignsCount",
@@ -405,15 +407,15 @@ class BrandResource(SyncAPIResource):
405
407
  "tcrBrandId",
406
408
  "-tcrBrandId",
407
409
  ]
408
- | NotGiven = NOT_GIVEN,
409
- state: str | NotGiven = NOT_GIVEN,
410
- tcr_brand_id: str | NotGiven = NOT_GIVEN,
410
+ | Omit = omit,
411
+ state: str | Omit = omit,
412
+ tcr_brand_id: str | Omit = omit,
411
413
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
412
414
  # The extra values given here take precedence over values defined on the client or passed to this method.
413
415
  extra_headers: Headers | None = None,
414
416
  extra_query: Query | None = None,
415
417
  extra_body: Body | None = None,
416
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
418
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
417
419
  ) -> BrandListResponse:
418
420
  """
419
421
  This endpoint is used to list all brands associated with your organization.
@@ -470,7 +472,7 @@ class BrandResource(SyncAPIResource):
470
472
  extra_headers: Headers | None = None,
471
473
  extra_query: Query | None = None,
472
474
  extra_body: Body | None = None,
473
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
475
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
474
476
  ) -> object:
475
477
  """Delete Brand.
476
478
 
@@ -506,7 +508,7 @@ class BrandResource(SyncAPIResource):
506
508
  extra_headers: Headers | None = None,
507
509
  extra_query: Query | None = None,
508
510
  extra_body: Body | None = None,
509
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
511
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
510
512
  ) -> BrandGetFeedbackResponse:
511
513
  """Get feedback about a brand by ID.
512
514
 
@@ -552,7 +554,7 @@ class BrandResource(SyncAPIResource):
552
554
  extra_headers: Headers | None = None,
553
555
  extra_query: Query | None = None,
554
556
  extra_body: Body | None = None,
555
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
557
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
556
558
  ) -> None:
557
559
  """
558
560
  Resend brand 2FA email
@@ -586,7 +588,7 @@ class BrandResource(SyncAPIResource):
586
588
  extra_headers: Headers | None = None,
587
589
  extra_query: Query | None = None,
588
590
  extra_body: Body | None = None,
589
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
591
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
590
592
  ) -> object:
591
593
  """This operation allows you to revet the brand.
592
594
 
@@ -646,31 +648,31 @@ class AsyncBrandResource(AsyncAPIResource):
646
648
  email: str,
647
649
  entity_type: EntityType,
648
650
  vertical: Vertical,
649
- business_contact_email: str | NotGiven = NOT_GIVEN,
650
- city: str | NotGiven = NOT_GIVEN,
651
- company_name: str | NotGiven = NOT_GIVEN,
652
- ein: str | NotGiven = NOT_GIVEN,
653
- first_name: str | NotGiven = NOT_GIVEN,
654
- ip_address: str | NotGiven = NOT_GIVEN,
655
- is_reseller: bool | NotGiven = NOT_GIVEN,
656
- last_name: str | NotGiven = NOT_GIVEN,
657
- mobile_phone: str | NotGiven = NOT_GIVEN,
658
- mock: bool | NotGiven = NOT_GIVEN,
659
- phone: str | NotGiven = NOT_GIVEN,
660
- postal_code: str | NotGiven = NOT_GIVEN,
661
- state: str | NotGiven = NOT_GIVEN,
662
- stock_exchange: StockExchange | NotGiven = NOT_GIVEN,
663
- stock_symbol: str | NotGiven = NOT_GIVEN,
664
- street: str | NotGiven = NOT_GIVEN,
665
- webhook_failover_url: str | NotGiven = NOT_GIVEN,
666
- webhook_url: str | NotGiven = NOT_GIVEN,
667
- website: str | NotGiven = NOT_GIVEN,
651
+ business_contact_email: str | Omit = omit,
652
+ city: str | Omit = omit,
653
+ company_name: str | Omit = omit,
654
+ ein: str | Omit = omit,
655
+ first_name: str | Omit = omit,
656
+ ip_address: str | Omit = omit,
657
+ is_reseller: bool | Omit = omit,
658
+ last_name: str | Omit = omit,
659
+ mobile_phone: str | Omit = omit,
660
+ mock: bool | Omit = omit,
661
+ phone: str | Omit = omit,
662
+ postal_code: str | Omit = omit,
663
+ state: str | Omit = omit,
664
+ stock_exchange: StockExchange | Omit = omit,
665
+ stock_symbol: str | Omit = omit,
666
+ street: str | Omit = omit,
667
+ webhook_failover_url: str | Omit = omit,
668
+ webhook_url: str | Omit = omit,
669
+ website: str | Omit = omit,
668
670
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
669
671
  # The extra values given here take precedence over values defined on the client or passed to this method.
670
672
  extra_headers: Headers | None = None,
671
673
  extra_query: Query | None = None,
672
674
  extra_body: Body | None = None,
673
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
675
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
674
676
  ) -> TelnyxBrand:
675
677
  """This endpoint is used to create a new brand.
676
678
 
@@ -692,7 +694,8 @@ class AsyncBrandResource(AsyncAPIResource):
692
694
 
693
695
  business_contact_email: Business contact email.
694
696
 
695
- Required if `entityType` is `PUBLIC_PROFIT`.
697
+ Required if `entityType` is `PUBLIC_PROFIT`. Otherwise, it is recommended to
698
+ either omit this field or set it to `null`.
696
699
 
697
700
  city: City name
698
701
 
@@ -783,7 +786,7 @@ class AsyncBrandResource(AsyncAPIResource):
783
786
  extra_headers: Headers | None = None,
784
787
  extra_query: Query | None = None,
785
788
  extra_body: Body | None = None,
786
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
789
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
787
790
  ) -> BrandRetrieveResponse:
788
791
  """
789
792
  Retrieve a brand by `brandId`.
@@ -816,32 +819,32 @@ class AsyncBrandResource(AsyncAPIResource):
816
819
  email: str,
817
820
  entity_type: EntityType,
818
821
  vertical: Vertical,
819
- alt_business_id: str | NotGiven = NOT_GIVEN,
820
- alt_business_id_type: AltBusinessIDType | NotGiven = NOT_GIVEN,
821
- business_contact_email: str | NotGiven = NOT_GIVEN,
822
- city: str | NotGiven = NOT_GIVEN,
823
- company_name: str | NotGiven = NOT_GIVEN,
824
- ein: str | NotGiven = NOT_GIVEN,
825
- first_name: str | NotGiven = NOT_GIVEN,
826
- identity_status: BrandIdentityStatus | NotGiven = NOT_GIVEN,
827
- ip_address: str | NotGiven = NOT_GIVEN,
828
- is_reseller: bool | NotGiven = NOT_GIVEN,
829
- last_name: str | NotGiven = NOT_GIVEN,
830
- phone: str | NotGiven = NOT_GIVEN,
831
- postal_code: str | NotGiven = NOT_GIVEN,
832
- state: str | NotGiven = NOT_GIVEN,
833
- stock_exchange: StockExchange | NotGiven = NOT_GIVEN,
834
- stock_symbol: str | NotGiven = NOT_GIVEN,
835
- street: str | NotGiven = NOT_GIVEN,
836
- webhook_failover_url: str | NotGiven = NOT_GIVEN,
837
- webhook_url: str | NotGiven = NOT_GIVEN,
838
- website: str | NotGiven = NOT_GIVEN,
822
+ alt_business_id: str | Omit = omit,
823
+ alt_business_id_type: AltBusinessIDType | Omit = omit,
824
+ business_contact_email: str | Omit = omit,
825
+ city: str | Omit = omit,
826
+ company_name: str | Omit = omit,
827
+ ein: str | Omit = omit,
828
+ first_name: str | Omit = omit,
829
+ identity_status: BrandIdentityStatus | Omit = omit,
830
+ ip_address: str | Omit = omit,
831
+ is_reseller: bool | Omit = omit,
832
+ last_name: str | Omit = omit,
833
+ phone: str | Omit = omit,
834
+ postal_code: str | Omit = omit,
835
+ state: str | Omit = omit,
836
+ stock_exchange: StockExchange | Omit = omit,
837
+ stock_symbol: str | Omit = omit,
838
+ street: str | Omit = omit,
839
+ webhook_failover_url: str | Omit = omit,
840
+ webhook_url: str | Omit = omit,
841
+ website: str | Omit = omit,
839
842
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
840
843
  # The extra values given here take precedence over values defined on the client or passed to this method.
841
844
  extra_headers: Headers | None = None,
842
845
  extra_query: Query | None = None,
843
846
  extra_body: Body | None = None,
844
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
847
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
845
848
  ) -> TelnyxBrand:
846
849
  """
847
850
  Update a brand's attributes by `brandId`.
@@ -863,7 +866,8 @@ class AsyncBrandResource(AsyncAPIResource):
863
866
 
864
867
  business_contact_email: Business contact email.
865
868
 
866
- Required if `entityType` will be changed to `PUBLIC_PROFIT`.
869
+ Required if `entityType` will be changed to `PUBLIC_PROFIT`. Otherwise, it is
870
+ recommended to either omit this field or set it to `null`.
867
871
 
868
872
  city: City name
869
873
 
@@ -949,12 +953,12 @@ class AsyncBrandResource(AsyncAPIResource):
949
953
  async def list(
950
954
  self,
951
955
  *,
952
- brand_id: str | NotGiven = NOT_GIVEN,
953
- country: str | NotGiven = NOT_GIVEN,
954
- display_name: str | NotGiven = NOT_GIVEN,
955
- entity_type: str | NotGiven = NOT_GIVEN,
956
- page: int | NotGiven = NOT_GIVEN,
957
- records_per_page: int | NotGiven = NOT_GIVEN,
956
+ brand_id: str | Omit = omit,
957
+ country: str | Omit = omit,
958
+ display_name: str | Omit = omit,
959
+ entity_type: str | Omit = omit,
960
+ page: int | Omit = omit,
961
+ records_per_page: int | Omit = omit,
958
962
  sort: Literal[
959
963
  "assignedCampaignsCount",
960
964
  "-assignedCampaignsCount",
@@ -971,15 +975,15 @@ class AsyncBrandResource(AsyncAPIResource):
971
975
  "tcrBrandId",
972
976
  "-tcrBrandId",
973
977
  ]
974
- | NotGiven = NOT_GIVEN,
975
- state: str | NotGiven = NOT_GIVEN,
976
- tcr_brand_id: str | NotGiven = NOT_GIVEN,
978
+ | Omit = omit,
979
+ state: str | Omit = omit,
980
+ tcr_brand_id: str | Omit = omit,
977
981
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
978
982
  # The extra values given here take precedence over values defined on the client or passed to this method.
979
983
  extra_headers: Headers | None = None,
980
984
  extra_query: Query | None = None,
981
985
  extra_body: Body | None = None,
982
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
986
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
983
987
  ) -> BrandListResponse:
984
988
  """
985
989
  This endpoint is used to list all brands associated with your organization.
@@ -1036,7 +1040,7 @@ class AsyncBrandResource(AsyncAPIResource):
1036
1040
  extra_headers: Headers | None = None,
1037
1041
  extra_query: Query | None = None,
1038
1042
  extra_body: Body | None = None,
1039
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1043
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
1040
1044
  ) -> object:
1041
1045
  """Delete Brand.
1042
1046
 
@@ -1072,7 +1076,7 @@ class AsyncBrandResource(AsyncAPIResource):
1072
1076
  extra_headers: Headers | None = None,
1073
1077
  extra_query: Query | None = None,
1074
1078
  extra_body: Body | None = None,
1075
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1079
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
1076
1080
  ) -> BrandGetFeedbackResponse:
1077
1081
  """Get feedback about a brand by ID.
1078
1082
 
@@ -1118,7 +1122,7 @@ class AsyncBrandResource(AsyncAPIResource):
1118
1122
  extra_headers: Headers | None = None,
1119
1123
  extra_query: Query | None = None,
1120
1124
  extra_body: Body | None = None,
1121
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1125
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
1122
1126
  ) -> None:
1123
1127
  """
1124
1128
  Resend brand 2FA email
@@ -1152,7 +1156,7 @@ class AsyncBrandResource(AsyncAPIResource):
1152
1156
  extra_headers: Headers | None = None,
1153
1157
  extra_query: Query | None = None,
1154
1158
  extra_body: Body | None = None,
1155
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1159
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
1156
1160
  ) -> object:
1157
1161
  """This operation allows you to revet the brand.
1158
1162
 
@@ -4,7 +4,7 @@ from __future__ import annotations
4
4
 
5
5
  import httpx
6
6
 
7
- from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
7
+ from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
8
8
  from ..._utils import maybe_transform, async_maybe_transform
9
9
  from ..._compat import cached_property
10
10
  from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -50,7 +50,7 @@ class ExternalVettingResource(SyncAPIResource):
50
50
  extra_headers: Headers | None = None,
51
51
  extra_query: Query | None = None,
52
52
  extra_body: Body | None = None,
53
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
53
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
54
54
  ) -> object:
55
55
  """
56
56
  Get list of valid external vetting record for a given brand
@@ -80,13 +80,13 @@ class ExternalVettingResource(SyncAPIResource):
80
80
  *,
81
81
  evp_id: str,
82
82
  vetting_id: str,
83
- vetting_token: str | NotGiven = NOT_GIVEN,
83
+ vetting_token: str | Omit = omit,
84
84
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
85
85
  # The extra values given here take precedence over values defined on the client or passed to this method.
86
86
  extra_headers: Headers | None = None,
87
87
  extra_query: Query | None = None,
88
88
  extra_body: Body | None = None,
89
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
89
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
90
90
  ) -> ExternalVettingImportResponse:
91
91
  """
92
92
  This operation can be used to import an external vetting record from a
@@ -139,7 +139,7 @@ class ExternalVettingResource(SyncAPIResource):
139
139
  extra_headers: Headers | None = None,
140
140
  extra_query: Query | None = None,
141
141
  extra_body: Body | None = None,
142
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
142
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
143
143
  ) -> object:
144
144
  """
145
145
  Order new external vetting for a brand
@@ -204,7 +204,7 @@ class AsyncExternalVettingResource(AsyncAPIResource):
204
204
  extra_headers: Headers | None = None,
205
205
  extra_query: Query | None = None,
206
206
  extra_body: Body | None = None,
207
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
207
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
208
208
  ) -> object:
209
209
  """
210
210
  Get list of valid external vetting record for a given brand
@@ -234,13 +234,13 @@ class AsyncExternalVettingResource(AsyncAPIResource):
234
234
  *,
235
235
  evp_id: str,
236
236
  vetting_id: str,
237
- vetting_token: str | NotGiven = NOT_GIVEN,
237
+ vetting_token: str | Omit = omit,
238
238
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
239
239
  # The extra values given here take precedence over values defined on the client or passed to this method.
240
240
  extra_headers: Headers | None = None,
241
241
  extra_query: Query | None = None,
242
242
  extra_body: Body | None = None,
243
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
243
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
244
244
  ) -> ExternalVettingImportResponse:
245
245
  """
246
246
  This operation can be used to import an external vetting record from a
@@ -293,7 +293,7 @@ class AsyncExternalVettingResource(AsyncAPIResource):
293
293
  extra_headers: Headers | None = None,
294
294
  extra_query: Query | None = None,
295
295
  extra_body: Body | None = None,
296
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
296
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
297
297
  ) -> object:
298
298
  """
299
299
  Order new external vetting for a brand
@@ -7,7 +7,7 @@ from typing_extensions import Literal
7
7
  import httpx
8
8
 
9
9
  from ..types import bulk_sim_card_action_list_params
10
- from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
10
+ from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
11
11
  from .._utils import maybe_transform, async_maybe_transform
12
12
  from .._compat import cached_property
13
13
  from .._resource import SyncAPIResource, AsyncAPIResource
@@ -53,7 +53,7 @@ class BulkSimCardActionsResource(SyncAPIResource):
53
53
  extra_headers: Headers | None = None,
54
54
  extra_query: Query | None = None,
55
55
  extra_body: Body | None = None,
56
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
56
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
57
57
  ) -> BulkSimCardActionRetrieveResponse:
58
58
  """This API fetches information about a bulk SIM card action.
59
59
 
@@ -82,15 +82,15 @@ class BulkSimCardActionsResource(SyncAPIResource):
82
82
  def list(
83
83
  self,
84
84
  *,
85
- filter_action_type: Literal["bulk_set_public_ips"] | NotGiven = NOT_GIVEN,
86
- page_number: int | NotGiven = NOT_GIVEN,
87
- page_size: int | NotGiven = NOT_GIVEN,
85
+ filter_action_type: Literal["bulk_set_public_ips"] | Omit = omit,
86
+ page_number: int | Omit = omit,
87
+ page_size: int | Omit = omit,
88
88
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
89
89
  # The extra values given here take precedence over values defined on the client or passed to this method.
90
90
  extra_headers: Headers | None = None,
91
91
  extra_query: Query | None = None,
92
92
  extra_body: Body | None = None,
93
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
93
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
94
94
  ) -> BulkSimCardActionListResponse:
95
95
  """This API lists a paginated collection of bulk SIM card actions.
96
96
 
@@ -161,7 +161,7 @@ class AsyncBulkSimCardActionsResource(AsyncAPIResource):
161
161
  extra_headers: Headers | None = None,
162
162
  extra_query: Query | None = None,
163
163
  extra_body: Body | None = None,
164
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
164
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
165
165
  ) -> BulkSimCardActionRetrieveResponse:
166
166
  """This API fetches information about a bulk SIM card action.
167
167
 
@@ -190,15 +190,15 @@ class AsyncBulkSimCardActionsResource(AsyncAPIResource):
190
190
  async def list(
191
191
  self,
192
192
  *,
193
- filter_action_type: Literal["bulk_set_public_ips"] | NotGiven = NOT_GIVEN,
194
- page_number: int | NotGiven = NOT_GIVEN,
195
- page_size: int | NotGiven = NOT_GIVEN,
193
+ filter_action_type: Literal["bulk_set_public_ips"] | Omit = omit,
194
+ page_number: int | Omit = omit,
195
+ page_size: int | Omit = omit,
196
196
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
197
197
  # The extra values given here take precedence over values defined on the client or passed to this method.
198
198
  extra_headers: Headers | None = None,
199
199
  extra_query: Query | None = None,
200
200
  extra_body: Body | None = None,
201
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
201
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
202
202
  ) -> BulkSimCardActionListResponse:
203
203
  """This API lists a paginated collection of bulk SIM card actions.
204
204
 
@@ -4,7 +4,7 @@ from __future__ import annotations
4
4
 
5
5
  import httpx
6
6
 
7
- from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
7
+ from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
8
8
  from ..._utils import maybe_transform, strip_not_given, async_maybe_transform
9
9
  from ..._compat import cached_property
10
10
  from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -46,13 +46,13 @@ class BillingBundlesResource(SyncAPIResource):
46
46
  self,
47
47
  bundle_id: str,
48
48
  *,
49
- authorization_bearer: str | NotGiven = NOT_GIVEN,
49
+ authorization_bearer: str | Omit = omit,
50
50
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
51
51
  # The extra values given here take precedence over values defined on the client or passed to this method.
52
52
  extra_headers: Headers | None = None,
53
53
  extra_query: Query | None = None,
54
54
  extra_body: Body | None = None,
55
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
55
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
56
56
  ) -> BillingBundleRetrieveResponse:
57
57
  """
58
58
  Get a single bundle by ID.
@@ -84,15 +84,15 @@ class BillingBundlesResource(SyncAPIResource):
84
84
  def list(
85
85
  self,
86
86
  *,
87
- filter: billing_bundle_list_params.Filter | NotGiven = NOT_GIVEN,
88
- page: billing_bundle_list_params.Page | NotGiven = NOT_GIVEN,
89
- authorization_bearer: str | NotGiven = NOT_GIVEN,
87
+ filter: billing_bundle_list_params.Filter | Omit = omit,
88
+ page: billing_bundle_list_params.Page | Omit = omit,
89
+ authorization_bearer: str | Omit = omit,
90
90
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
91
91
  # The extra values given here take precedence over values defined on the client or passed to this method.
92
92
  extra_headers: Headers | None = None,
93
93
  extra_query: Query | None = None,
94
94
  extra_body: Body | None = None,
95
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
95
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
96
96
  ) -> BillingBundleListResponse:
97
97
  """
98
98
  Get all allowed bundles.
@@ -159,13 +159,13 @@ class AsyncBillingBundlesResource(AsyncAPIResource):
159
159
  self,
160
160
  bundle_id: str,
161
161
  *,
162
- authorization_bearer: str | NotGiven = NOT_GIVEN,
162
+ authorization_bearer: str | Omit = omit,
163
163
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
164
164
  # The extra values given here take precedence over values defined on the client or passed to this method.
165
165
  extra_headers: Headers | None = None,
166
166
  extra_query: Query | None = None,
167
167
  extra_body: Body | None = None,
168
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
168
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
169
169
  ) -> BillingBundleRetrieveResponse:
170
170
  """
171
171
  Get a single bundle by ID.
@@ -197,15 +197,15 @@ class AsyncBillingBundlesResource(AsyncAPIResource):
197
197
  async def list(
198
198
  self,
199
199
  *,
200
- filter: billing_bundle_list_params.Filter | NotGiven = NOT_GIVEN,
201
- page: billing_bundle_list_params.Page | NotGiven = NOT_GIVEN,
202
- authorization_bearer: str | NotGiven = NOT_GIVEN,
200
+ filter: billing_bundle_list_params.Filter | Omit = omit,
201
+ page: billing_bundle_list_params.Page | Omit = omit,
202
+ authorization_bearer: str | Omit = omit,
203
203
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
204
204
  # The extra values given here take precedence over values defined on the client or passed to this method.
205
205
  extra_headers: Headers | None = None,
206
206
  extra_query: Query | None = None,
207
207
  extra_body: Body | None = None,
208
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
208
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
209
209
  ) -> BillingBundleListResponse:
210
210
  """
211
211
  Get all allowed bundles.