telnyx 3.1.0a0__py3-none-any.whl → 3.2.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 (564) hide show
  1. telnyx/__init__.py +3 -1
  2. telnyx/_base_client.py +12 -12
  3. telnyx/_client.py +68 -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 +73 -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 +695 -697
  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 +124 -43
  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 +76 -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 +145 -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 +123 -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/webhooks.py +34 -0
  271. telnyx/resources/well_known.py +198 -0
  272. telnyx/resources/wireguard_interfaces.py +17 -17
  273. telnyx/resources/wireguard_peers.py +21 -21
  274. telnyx/resources/wireless/detail_records_reports.py +17 -17
  275. telnyx/resources/wireless/wireless.py +3 -3
  276. telnyx/resources/wireless_blocklist_values.py +3 -3
  277. telnyx/resources/wireless_blocklists.py +29 -30
  278. telnyx/types/__init__.py +167 -13
  279. telnyx/types/actions/purchase_create_params.py +3 -2
  280. telnyx/types/actions/register_create_params.py +4 -3
  281. telnyx/types/addresses/action_validate_response.py +8 -3
  282. telnyx/types/{advanced_order_update_params.py → advanced_order_update_requirement_group_params.py} +2 -2
  283. telnyx/types/ai/__init__.py +1 -0
  284. telnyx/types/ai/chat_create_completion_params.py +3 -2
  285. telnyx/types/ai/cluster_compute_params.py +3 -2
  286. telnyx/types/ai/{conversations/message_create_params.py → conversation_add_message_params.py} +6 -5
  287. telnyx/types/ai/conversations/__init__.py +0 -1
  288. telnyx/types/ai/embedding_list_params.py +3 -2
  289. telnyx/types/ai/inference_embedding_bucket_ids_param.py +3 -2
  290. telnyx/types/ai/inference_embedding_transfer_tool_params.py +6 -0
  291. telnyx/types/ai/inference_embedding_transfer_tool_params_param.py +6 -0
  292. telnyx/types/ai/inference_embedding_webhook_tool_params.py +2 -0
  293. telnyx/types/ai/inference_embedding_webhook_tool_params_param.py +8 -4
  294. telnyx/types/ai/voice_settings.py +49 -2
  295. telnyx/types/ai/voice_settings_param.py +49 -2
  296. telnyx/types/brand_create_params.py +2 -1
  297. telnyx/types/brand_update_params.py +2 -1
  298. telnyx/types/bundle_pricing/billing_bundle_list_params.py +4 -3
  299. telnyx/types/bundle_pricing/user_bundle_list_params.py +4 -3
  300. telnyx/types/bundle_pricing/user_bundle_list_unused_params.py +4 -3
  301. telnyx/types/call_ai_gather_ended_webhook_event.py +78 -0
  302. telnyx/types/call_ai_gather_message_history_updated_webhook_event.py +69 -0
  303. telnyx/types/call_ai_gather_partial_results_webhook_event.py +75 -0
  304. telnyx/types/call_answered_webhook_event.py +75 -0
  305. telnyx/types/call_bridged_webhook_event.py +58 -0
  306. telnyx/types/call_control_application_update_params.py +3 -2
  307. telnyx/types/call_conversation_ended_webhook_event.py +84 -0
  308. telnyx/types/call_conversation_insights_generated_webhook_event.py +67 -0
  309. telnyx/types/call_dial_params.py +14 -6
  310. telnyx/types/call_dtmf_received_webhook_event.py +61 -0
  311. telnyx/types/call_enqueued_webhook_event.py +59 -0
  312. telnyx/types/call_fork_started_webhook_event.py +53 -0
  313. telnyx/types/call_fork_stopped_webhook_event.py +53 -0
  314. telnyx/types/call_gather_ended_webhook_event.py +64 -0
  315. telnyx/types/call_hangup_webhook_event.py +150 -0
  316. telnyx/types/call_initiated_webhook_event.py +96 -0
  317. telnyx/types/call_left_queue_webhook_event.py +62 -0
  318. telnyx/types/call_machine_detection_ended_webhook_event.py +61 -0
  319. telnyx/types/call_machine_greeting_ended_webhook_event.py +61 -0
  320. telnyx/types/call_machine_premium_detection_ended_webhook_event.py +63 -0
  321. telnyx/types/call_machine_premium_greeting_ended_webhook_event.py +61 -0
  322. telnyx/types/call_playback_ended_webhook_event.py +70 -0
  323. telnyx/types/call_playback_started_webhook_event.py +62 -0
  324. telnyx/types/call_recording_error_webhook_event.py +60 -0
  325. telnyx/types/call_recording_saved_webhook_event.py +94 -0
  326. telnyx/types/call_recording_transcription_saved_webhook_event.py +71 -0
  327. telnyx/types/call_refer_completed_webhook_event.py +61 -0
  328. telnyx/types/call_refer_failed_webhook_event.py +61 -0
  329. telnyx/types/call_refer_started_webhook_event.py +61 -0
  330. telnyx/types/call_siprec_failed_webhook_event.py +53 -0
  331. telnyx/types/call_siprec_started_webhook_event.py +50 -0
  332. telnyx/types/call_siprec_stopped_webhook_event.py +53 -0
  333. telnyx/types/call_speak_ended_webhook_event.py +53 -0
  334. telnyx/types/call_speak_started_webhook_event.py +50 -0
  335. telnyx/types/call_streaming_failed_webhook_event.py +70 -0
  336. telnyx/types/call_streaming_started_webhook_event.py +53 -0
  337. telnyx/types/call_streaming_stopped_webhook_event.py +53 -0
  338. telnyx/types/calls/action_answer_params.py +1 -2
  339. telnyx/types/calls/action_gather_using_ai_params.py +5 -8
  340. telnyx/types/calls/action_start_streaming_params.py +4 -2
  341. telnyx/types/calls/action_transfer_params.py +50 -0
  342. telnyx/types/calls/transcription_engine_a_config_param.py +4 -3
  343. telnyx/types/campaign_builder_create_params.py +4 -3
  344. telnyx/types/campaign_status_update_webhook_event.py +26 -0
  345. telnyx/types/campaign_submit_appeal_response.py +0 -3
  346. telnyx/types/conference_created_webhook_event.py +53 -0
  347. telnyx/types/conference_ended_webhook_event.py +56 -0
  348. telnyx/types/conference_floor_changed_webhook_event.py +45 -0
  349. telnyx/types/conference_participant_joined_webhook_event.py +53 -0
  350. telnyx/types/conference_participant_left_webhook_event.py +53 -0
  351. telnyx/types/conference_participant_playback_ended_webhook_event.py +65 -0
  352. telnyx/types/conference_participant_playback_started_webhook_event.py +65 -0
  353. telnyx/types/conference_participant_speak_ended_webhook_event.py +56 -0
  354. telnyx/types/conference_participant_speak_started_webhook_event.py +56 -0
  355. telnyx/types/conference_playback_ended_webhook_event.py +49 -0
  356. telnyx/types/conference_playback_started_webhook_event.py +49 -0
  357. telnyx/types/conference_recording_saved_webhook_event.py +103 -0
  358. telnyx/types/conference_speak_ended_webhook_event.py +40 -0
  359. telnyx/types/conference_speak_started_webhook_event.py +40 -0
  360. telnyx/types/conferences/action_hold_params.py +3 -2
  361. telnyx/types/conferences/action_join_params.py +3 -2
  362. telnyx/types/conferences/action_mute_params.py +3 -2
  363. telnyx/types/conferences/action_play_params.py +2 -2
  364. telnyx/types/conferences/action_speak_params.py +3 -2
  365. telnyx/types/conferences/action_stop_params.py +3 -2
  366. telnyx/types/conferences/action_unhold_params.py +3 -2
  367. telnyx/types/conferences/action_unmute_params.py +3 -2
  368. telnyx/types/conferences/action_update_params.py +3 -2
  369. telnyx/types/country_coverage_retrieve_country_response.py +7 -0
  370. telnyx/types/country_coverage_retrieve_response.py +7 -0
  371. telnyx/types/credential_connection_create_params.py +3 -2
  372. telnyx/types/credential_connection_update_params.py +3 -2
  373. telnyx/types/credential_inbound_param.py +3 -2
  374. telnyx/types/custom_sip_header.py +13 -0
  375. telnyx/types/customer_service_record_list_params.py +2 -1
  376. telnyx/types/customer_service_record_status_changed_webhook_event.py +55 -0
  377. telnyx/types/customer_service_record_verify_phone_number_coverage_params.py +3 -2
  378. telnyx/types/delivery_update_webhook_event.py +40 -0
  379. telnyx/types/detail_record_list_params.py +4 -2
  380. telnyx/types/document_generate_download_link_response.py +14 -0
  381. telnyx/types/document_list_params.py +2 -1
  382. telnyx/types/external_connection_create_params.py +4 -2
  383. telnyx/types/external_connection_update_params.py +4 -2
  384. telnyx/types/external_connections/civic_address_list_params.py +3 -2
  385. telnyx/types/external_connections/upload_create_params.py +3 -1
  386. telnyx/types/fax_application_create_params.py +3 -2
  387. telnyx/types/fax_application_update_params.py +3 -2
  388. telnyx/types/fax_delivered_webhook_event.py +69 -0
  389. telnyx/types/fax_failed_webhook_event.py +66 -0
  390. telnyx/types/fax_media_processed_webhook_event.py +63 -0
  391. telnyx/types/fax_queued_webhook_event.py +63 -0
  392. telnyx/types/fax_sending_started_webhook_event.py +63 -0
  393. telnyx/types/fqdn_connection_create_params.py +3 -2
  394. telnyx/types/fqdn_connection_update_params.py +3 -2
  395. telnyx/types/global_ip_latency_retrieve_response.py +7 -7
  396. telnyx/types/inbound_fqdn_param.py +4 -2
  397. telnyx/types/inbound_ip_param.py +3 -2
  398. telnyx/types/inbound_message_webhook_event.py +227 -0
  399. telnyx/types/ip_connection_create_params.py +4 -3
  400. telnyx/types/ip_connection_update_params.py +3 -2
  401. telnyx/types/legacy/__init__.py +3 -0
  402. telnyx/types/legacy/reporting/__init__.py +12 -0
  403. telnyx/types/legacy/reporting/batch_detail_records/__init__.py +23 -0
  404. telnyx/types/legacy/reporting/batch_detail_records/cdr_detailed_req_response.py +63 -0
  405. telnyx/types/legacy/reporting/batch_detail_records/mdr_detail_report_response.py +42 -0
  406. telnyx/types/legacy/reporting/batch_detail_records/messaging_create_params.py +55 -0
  407. telnyx/types/legacy/reporting/batch_detail_records/messaging_create_response.py +12 -0
  408. telnyx/types/legacy/reporting/batch_detail_records/messaging_delete_response.py +12 -0
  409. telnyx/types/legacy/reporting/batch_detail_records/messaging_list_response.py +24 -0
  410. telnyx/types/legacy/reporting/batch_detail_records/messaging_retrieve_response.py +12 -0
  411. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_params.py +19 -0
  412. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_create_response.py +12 -0
  413. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_delete_response.py +12 -0
  414. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_list_response.py +12 -0
  415. telnyx/types/legacy/reporting/batch_detail_records/speech_to_text_retrieve_response.py +12 -0
  416. telnyx/types/legacy/reporting/batch_detail_records/stt_detail_report_response.py +27 -0
  417. telnyx/types/legacy/reporting/batch_detail_records/voice_create_params.py +57 -0
  418. telnyx/types/legacy/reporting/batch_detail_records/voice_create_response.py +13 -0
  419. telnyx/types/legacy/reporting/batch_detail_records/voice_delete_response.py +13 -0
  420. telnyx/types/legacy/reporting/batch_detail_records/voice_list_response.py +24 -0
  421. telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_fields_response.py +23 -0
  422. telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_response.py +13 -0
  423. telnyx/types/legacy/reporting/filter.py +31 -0
  424. telnyx/types/legacy/reporting/filter_param.py +30 -0
  425. telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_params.py +17 -0
  426. telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_response.py +11 -0
  427. telnyx/types/legacy/reporting/usage_reports/__init__.py +20 -0
  428. telnyx/types/legacy/reporting/usage_reports/cdr_usage_report_response_legacy.py +43 -0
  429. telnyx/types/legacy/reporting/usage_reports/mdr_usage_report_response_legacy.py +38 -0
  430. telnyx/types/legacy/reporting/usage_reports/messaging_create_params.py +29 -0
  431. telnyx/types/legacy/reporting/usage_reports/messaging_create_response.py +13 -0
  432. telnyx/types/legacy/reporting/usage_reports/messaging_delete_response.py +13 -0
  433. telnyx/types/legacy/reporting/usage_reports/messaging_list_params.py +15 -0
  434. telnyx/types/legacy/reporting/usage_reports/messaging_list_response.py +24 -0
  435. telnyx/types/legacy/reporting/usage_reports/messaging_retrieve_response.py +13 -0
  436. telnyx/types/legacy/reporting/usage_reports/number_lookup_create_params.py +26 -0
  437. telnyx/types/legacy/reporting/usage_reports/number_lookup_list_params.py +13 -0
  438. telnyx/types/legacy/reporting/usage_reports/voice_create_params.py +40 -0
  439. telnyx/types/legacy/reporting/usage_reports/voice_create_response.py +13 -0
  440. telnyx/types/legacy/reporting/usage_reports/voice_delete_response.py +13 -0
  441. telnyx/types/legacy/reporting/usage_reports/voice_list_params.py +15 -0
  442. telnyx/types/legacy/reporting/usage_reports/voice_list_response.py +24 -0
  443. telnyx/types/legacy/reporting/usage_reports/voice_retrieve_response.py +13 -0
  444. telnyx/types/media_list_params.py +3 -2
  445. telnyx/types/message_schedule_params.py +3 -2
  446. telnyx/types/message_send_group_mms_params.py +3 -3
  447. telnyx/types/message_send_long_code_params.py +2 -2
  448. telnyx/types/message_send_number_pool_params.py +3 -2
  449. telnyx/types/message_send_params.py +3 -2
  450. telnyx/types/message_send_short_code_params.py +2 -2
  451. telnyx/types/messaging/rc_list_bulk_capabilities_params.py +3 -2
  452. telnyx/types/messaging_hosted_number_order_check_eligibility_params.py +3 -2
  453. telnyx/types/messaging_hosted_number_order_create_params.py +3 -2
  454. telnyx/types/messaging_hosted_number_order_create_verification_codes_params.py +3 -2
  455. telnyx/types/messaging_numbers_bulk_update_create_params.py +3 -2
  456. telnyx/types/messaging_profile_create_params.py +3 -2
  457. telnyx/types/messaging_profile_update_params.py +3 -2
  458. telnyx/types/messaging_profiles/autoresp_config_create_params.py +3 -2
  459. telnyx/types/messaging_profiles/autoresp_config_update_params.py +3 -2
  460. telnyx/types/messsage_rcs_params.py +2 -2
  461. telnyx/types/number_order_status_update_webhook_event.py +38 -0
  462. telnyx/types/numbers_feature_create_params.py +3 -2
  463. telnyx/types/oauth_client.py +59 -0
  464. telnyx/types/oauth_client_create_params.py +39 -0
  465. telnyx/types/oauth_client_create_response.py +12 -0
  466. telnyx/types/oauth_client_list_params.py +38 -0
  467. telnyx/types/oauth_client_list_response.py +28 -0
  468. telnyx/types/oauth_client_retrieve_response.py +12 -0
  469. telnyx/types/oauth_client_update_params.py +36 -0
  470. telnyx/types/oauth_client_update_response.py +12 -0
  471. telnyx/types/oauth_grant.py +29 -0
  472. telnyx/types/oauth_grant_delete_response.py +12 -0
  473. telnyx/types/oauth_grant_list_params.py +17 -0
  474. telnyx/types/oauth_grant_list_response.py +28 -0
  475. telnyx/types/oauth_grant_retrieve_response.py +12 -0
  476. telnyx/types/oauth_grants_params.py +15 -0
  477. telnyx/types/oauth_grants_response.py +10 -0
  478. telnyx/types/oauth_introspect_params.py +12 -0
  479. telnyx/types/oauth_introspect_response.py +30 -0
  480. telnyx/types/oauth_register_params.py +39 -0
  481. telnyx/types/oauth_register_response.py +45 -0
  482. telnyx/types/oauth_retrieve_authorize_params.py +30 -0
  483. telnyx/types/oauth_retrieve_jwks_response.py +25 -0
  484. telnyx/types/oauth_retrieve_response.py +47 -0
  485. telnyx/types/oauth_token_params.py +33 -0
  486. telnyx/types/oauth_token_response.py +25 -0
  487. telnyx/types/outbound_call_recording_param.py +3 -2
  488. telnyx/types/outbound_voice_profile_create_params.py +4 -3
  489. telnyx/types/outbound_voice_profile_update_params.py +4 -3
  490. telnyx/types/phone_number_delete_response.py +7 -0
  491. telnyx/types/phone_number_detailed.py +7 -0
  492. telnyx/types/phone_number_list_params.py +9 -2
  493. telnyx/types/phone_number_slim_list_params.py +3 -2
  494. telnyx/types/phone_number_update_params.py +3 -2
  495. telnyx/types/phone_numbers/action_verify_ownership_params.py +3 -2
  496. telnyx/types/phone_numbers/job_delete_batch_params.py +3 -2
  497. telnyx/types/phone_numbers/job_update_batch_params.py +10 -3
  498. telnyx/types/phone_numbers/job_update_emergency_settings_batch_params.py +4 -2
  499. telnyx/types/portability_check_run_params.py +3 -2
  500. telnyx/types/porting/export_porting_orders_csv_report_param.py +2 -1
  501. telnyx/types/porting_order.py +3 -0
  502. telnyx/types/porting_order_create_params.py +6 -2
  503. telnyx/types/porting_order_list_params.py +52 -31
  504. telnyx/types/porting_order_phone_number_configuration_param.py +3 -2
  505. telnyx/types/porting_order_update_params.py +2 -0
  506. telnyx/types/porting_orders/action_requirement_list_params.py +3 -2
  507. telnyx/types/porting_orders/phone_number_block_list_params.py +5 -3
  508. telnyx/types/porting_orders/phone_number_configuration_list_params.py +22 -21
  509. telnyx/types/porting_orders/verification_code_send_params.py +3 -2
  510. telnyx/types/portout_list_params.py +2 -1
  511. telnyx/types/portouts/export_portouts_csv_report_param.py +3 -2
  512. telnyx/types/recordings/action_delete_params.py +3 -2
  513. telnyx/types/replaced_link_click_webhook_event.py +32 -0
  514. telnyx/types/report_list_wdrs_params.py +3 -2
  515. telnyx/types/reports/mdr_usage_report_fetch_sync_params.py +3 -2
  516. telnyx/types/rooms/sessions/action_kick_params.py +5 -3
  517. telnyx/types/rooms/sessions/action_mute_params.py +5 -3
  518. telnyx/types/rooms/sessions/action_unmute_params.py +5 -3
  519. telnyx/types/shared/__init__.py +1 -0
  520. telnyx/types/{error.py → shared/api_error.py} +3 -3
  521. telnyx/types/shared/simple_sim_card.py +15 -0
  522. telnyx/types/sim_card.py +12 -0
  523. telnyx/types/sim_card_list_params.py +2 -1
  524. telnyx/types/sim_card_update_params.py +4 -3
  525. telnyx/types/sim_cards/action_bulk_set_public_ips_params.py +3 -2
  526. telnyx/types/sim_cards/action_validate_registration_codes_params.py +3 -2
  527. telnyx/types/sip_header.py +15 -0
  528. telnyx/types/stream_bidirectional_codec.py +1 -1
  529. telnyx/types/stream_codec.py +1 -1
  530. telnyx/types/streaming_failed_webhook_event.py +70 -0
  531. telnyx/types/streaming_started_webhook_event.py +53 -0
  532. telnyx/types/streaming_stopped_webhook_event.py +53 -0
  533. telnyx/types/texml_application_create_params.py +2 -2
  534. telnyx/types/texml_application_update_params.py +2 -2
  535. telnyx/types/transcription_webhook_event.py +72 -0
  536. telnyx/types/unwrap_webhook_event.py +138 -0
  537. telnyx/types/usage_report_list_params.py +5 -4
  538. telnyx/types/verification_trigger_call_params.py +7 -0
  539. telnyx/types/verified_number_create_params.py +10 -0
  540. telnyx/types/verify_profile.py +18 -3
  541. telnyx/types/verify_profile_create_params.py +6 -4
  542. telnyx/types/verify_profile_create_template_params.py +12 -0
  543. telnyx/types/verify_profile_create_template_response.py +12 -0
  544. telnyx/types/verify_profile_message_template_response.py +13 -0
  545. telnyx/types/verify_profile_retrieve_templates_response.py +4 -9
  546. telnyx/types/verify_profile_update_params.py +6 -4
  547. telnyx/types/verify_profile_update_template_params.py +12 -0
  548. telnyx/types/verify_profile_update_template_response.py +12 -0
  549. telnyx/types/video_region_param.py +4 -2
  550. telnyx/types/well_known_retrieve_authorization_server_metadata_response.py +42 -0
  551. telnyx/types/well_known_retrieve_protected_resource_metadata_response.py +15 -0
  552. telnyx/types/wireless_blocklist_create_params.py +3 -2
  553. telnyx/types/wireless_blocklist_update_params.py +3 -2
  554. {telnyx-3.1.0a0.dist-info → telnyx-3.2.0.dist-info}/METADATA +60 -19
  555. {telnyx-3.1.0a0.dist-info → telnyx-3.2.0.dist-info}/RECORD +557 -401
  556. telnyx/types/client_create_bucket_params.py +0 -13
  557. telnyx/types/client_delete_objects_params.py +0 -20
  558. telnyx/types/client_get_object_params.py +0 -15
  559. telnyx/types/client_list_objects_params.py +0 -13
  560. telnyx/types/client_put_object_params.py +0 -20
  561. telnyx/types/list_buckets_response.py +0 -20
  562. telnyx/types/list_objects_response.py +0 -24
  563. {telnyx-3.1.0a0.dist-info → telnyx-3.2.0.dist-info}/WHEEL +0 -0
  564. {telnyx-3.1.0a0.dist-info → telnyx-3.2.0.dist-info}/licenses/LICENSE +0 -0
@@ -8,7 +8,7 @@ from typing_extensions import Literal
8
8
  import httpx
9
9
 
10
10
  from ..types import dialogflow_connection_create_params, dialogflow_connection_update_params
11
- from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
11
+ from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
12
12
  from .._utils import maybe_transform, async_maybe_transform
13
13
  from .._compat import cached_property
14
14
  from .._resource import SyncAPIResource, AsyncAPIResource
@@ -51,16 +51,16 @@ class DialogflowConnectionsResource(SyncAPIResource):
51
51
  connection_id: str,
52
52
  *,
53
53
  service_account: Dict[str, object],
54
- conversation_profile_id: str | NotGiven = NOT_GIVEN,
55
- dialogflow_api: Literal["cx", "es"] | NotGiven = NOT_GIVEN,
56
- environment: str | NotGiven = NOT_GIVEN,
57
- location: str | NotGiven = NOT_GIVEN,
54
+ conversation_profile_id: str | Omit = omit,
55
+ dialogflow_api: Literal["cx", "es"] | Omit = omit,
56
+ environment: str | Omit = omit,
57
+ location: str | Omit = omit,
58
58
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
59
59
  # The extra values given here take precedence over values defined on the client or passed to this method.
60
60
  extra_headers: Headers | None = None,
61
61
  extra_query: Query | None = None,
62
62
  extra_body: Body | None = None,
63
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
63
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
64
64
  ) -> DialogflowConnectionCreateResponse:
65
65
  """
66
66
  Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx
@@ -115,7 +115,7 @@ class DialogflowConnectionsResource(SyncAPIResource):
115
115
  extra_headers: Headers | None = None,
116
116
  extra_query: Query | None = None,
117
117
  extra_body: Body | None = None,
118
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
118
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
119
119
  ) -> DialogflowConnectionRetrieveResponse:
120
120
  """
121
121
  Return details of the Dialogflow connection associated with the given
@@ -145,16 +145,16 @@ class DialogflowConnectionsResource(SyncAPIResource):
145
145
  connection_id: str,
146
146
  *,
147
147
  service_account: Dict[str, object],
148
- conversation_profile_id: str | NotGiven = NOT_GIVEN,
149
- dialogflow_api: Literal["cx", "es"] | NotGiven = NOT_GIVEN,
150
- environment: str | NotGiven = NOT_GIVEN,
151
- location: str | NotGiven = NOT_GIVEN,
148
+ conversation_profile_id: str | Omit = omit,
149
+ dialogflow_api: Literal["cx", "es"] | Omit = omit,
150
+ environment: str | Omit = omit,
151
+ location: str | Omit = omit,
152
152
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
153
153
  # The extra values given here take precedence over values defined on the client or passed to this method.
154
154
  extra_headers: Headers | None = None,
155
155
  extra_query: Query | None = None,
156
156
  extra_body: Body | None = None,
157
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
157
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
158
158
  ) -> DialogflowConnectionUpdateResponse:
159
159
  """
160
160
  Updates a stored Dialogflow Connection.
@@ -208,7 +208,7 @@ class DialogflowConnectionsResource(SyncAPIResource):
208
208
  extra_headers: Headers | None = None,
209
209
  extra_query: Query | None = None,
210
210
  extra_body: Body | None = None,
211
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
211
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
212
212
  ) -> None:
213
213
  """
214
214
  Deletes a stored Dialogflow Connection.
@@ -259,16 +259,16 @@ class AsyncDialogflowConnectionsResource(AsyncAPIResource):
259
259
  connection_id: str,
260
260
  *,
261
261
  service_account: Dict[str, object],
262
- conversation_profile_id: str | NotGiven = NOT_GIVEN,
263
- dialogflow_api: Literal["cx", "es"] | NotGiven = NOT_GIVEN,
264
- environment: str | NotGiven = NOT_GIVEN,
265
- location: str | NotGiven = NOT_GIVEN,
262
+ conversation_profile_id: str | Omit = omit,
263
+ dialogflow_api: Literal["cx", "es"] | Omit = omit,
264
+ environment: str | Omit = omit,
265
+ location: str | Omit = omit,
266
266
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
267
267
  # The extra values given here take precedence over values defined on the client or passed to this method.
268
268
  extra_headers: Headers | None = None,
269
269
  extra_query: Query | None = None,
270
270
  extra_body: Body | None = None,
271
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
271
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
272
272
  ) -> DialogflowConnectionCreateResponse:
273
273
  """
274
274
  Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx
@@ -323,7 +323,7 @@ class AsyncDialogflowConnectionsResource(AsyncAPIResource):
323
323
  extra_headers: Headers | None = None,
324
324
  extra_query: Query | None = None,
325
325
  extra_body: Body | None = None,
326
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
326
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
327
327
  ) -> DialogflowConnectionRetrieveResponse:
328
328
  """
329
329
  Return details of the Dialogflow connection associated with the given
@@ -353,16 +353,16 @@ class AsyncDialogflowConnectionsResource(AsyncAPIResource):
353
353
  connection_id: str,
354
354
  *,
355
355
  service_account: Dict[str, object],
356
- conversation_profile_id: str | NotGiven = NOT_GIVEN,
357
- dialogflow_api: Literal["cx", "es"] | NotGiven = NOT_GIVEN,
358
- environment: str | NotGiven = NOT_GIVEN,
359
- location: str | NotGiven = NOT_GIVEN,
356
+ conversation_profile_id: str | Omit = omit,
357
+ dialogflow_api: Literal["cx", "es"] | Omit = omit,
358
+ environment: str | Omit = omit,
359
+ location: str | Omit = omit,
360
360
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
361
361
  # The extra values given here take precedence over values defined on the client or passed to this method.
362
362
  extra_headers: Headers | None = None,
363
363
  extra_query: Query | None = None,
364
364
  extra_body: Body | None = None,
365
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
365
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
366
366
  ) -> DialogflowConnectionUpdateResponse:
367
367
  """
368
368
  Updates a stored Dialogflow Connection.
@@ -416,7 +416,7 @@ class AsyncDialogflowConnectionsResource(AsyncAPIResource):
416
416
  extra_headers: Headers | None = None,
417
417
  extra_query: Query | None = None,
418
418
  extra_body: Body | None = None,
419
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
419
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
420
420
  ) -> None:
421
421
  """
422
422
  Deletes a stored Dialogflow Connection.
@@ -5,7 +5,7 @@ from __future__ import annotations
5
5
  import httpx
6
6
 
7
7
  from ..types import document_link_list_params
8
- from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
8
+ from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
9
9
  from .._utils import maybe_transform, async_maybe_transform
10
10
  from .._compat import cached_property
11
11
  from .._resource import SyncAPIResource, AsyncAPIResource
@@ -44,14 +44,14 @@ class DocumentLinksResource(SyncAPIResource):
44
44
  def list(
45
45
  self,
46
46
  *,
47
- filter: document_link_list_params.Filter | NotGiven = NOT_GIVEN,
48
- page: document_link_list_params.Page | NotGiven = NOT_GIVEN,
47
+ filter: document_link_list_params.Filter | Omit = omit,
48
+ page: document_link_list_params.Page | Omit = omit,
49
49
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
50
50
  # The extra values given here take precedence over values defined on the client or passed to this method.
51
51
  extra_headers: Headers | None = None,
52
52
  extra_query: Query | None = None,
53
53
  extra_body: Body | None = None,
54
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
54
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
55
55
  ) -> DocumentLinkListResponse:
56
56
  """
57
57
  List all documents links ordered by created_at descending.
@@ -114,14 +114,14 @@ class AsyncDocumentLinksResource(AsyncAPIResource):
114
114
  async def list(
115
115
  self,
116
116
  *,
117
- filter: document_link_list_params.Filter | NotGiven = NOT_GIVEN,
118
- page: document_link_list_params.Page | NotGiven = NOT_GIVEN,
117
+ filter: document_link_list_params.Filter | Omit = omit,
118
+ page: document_link_list_params.Page | Omit = omit,
119
119
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
120
120
  # The extra values given here take precedence over values defined on the client or passed to this method.
121
121
  extra_headers: Headers | None = None,
122
122
  extra_query: Query | None = None,
123
123
  extra_body: Body | None = None,
124
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
124
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
125
125
  ) -> DocumentLinkListResponse:
126
126
  """
127
127
  List all documents links ordered by created_at descending.
@@ -8,7 +8,7 @@ from typing_extensions import Literal, overload
8
8
  import httpx
9
9
 
10
10
  from ..types import document_list_params, document_update_params, document_upload_params
11
- from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, Base64FileInput
11
+ from .._types import Body, Omit, Query, Headers, NotGiven, Base64FileInput, omit, not_given
12
12
  from .._utils import extract_files, required_args, maybe_transform, deepcopy_minimal, async_maybe_transform
13
13
  from .._compat import cached_property
14
14
  from .._resource import SyncAPIResource, AsyncAPIResource
@@ -32,6 +32,7 @@ from ..types.document_delete_response import DocumentDeleteResponse
32
32
  from ..types.document_update_response import DocumentUpdateResponse
33
33
  from ..types.document_upload_response import DocumentUploadResponse
34
34
  from ..types.document_retrieve_response import DocumentRetrieveResponse
35
+ from ..types.document_generate_download_link_response import DocumentGenerateDownloadLinkResponse
35
36
 
36
37
  __all__ = ["DocumentsResource", "AsyncDocumentsResource"]
37
38
 
@@ -65,7 +66,7 @@ class DocumentsResource(SyncAPIResource):
65
66
  extra_headers: Headers | None = None,
66
67
  extra_query: Query | None = None,
67
68
  extra_body: Body | None = None,
68
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
69
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
69
70
  ) -> DocumentRetrieveResponse:
70
71
  """
71
72
  Retrieve a document.
@@ -93,14 +94,14 @@ class DocumentsResource(SyncAPIResource):
93
94
  self,
94
95
  id: str,
95
96
  *,
96
- customer_reference: str | NotGiven = NOT_GIVEN,
97
- filename: str | NotGiven = NOT_GIVEN,
97
+ customer_reference: str | Omit = omit,
98
+ filename: str | Omit = omit,
98
99
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
99
100
  # The extra values given here take precedence over values defined on the client or passed to this method.
100
101
  extra_headers: Headers | None = None,
101
102
  extra_query: Query | None = None,
102
103
  extra_body: Body | None = None,
103
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
104
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
104
105
  ) -> DocumentUpdateResponse:
105
106
  """
106
107
  Update a document.
@@ -138,16 +139,16 @@ class DocumentsResource(SyncAPIResource):
138
139
  def list(
139
140
  self,
140
141
  *,
141
- filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
142
- page: document_list_params.Page | NotGiven = NOT_GIVEN,
142
+ filter: document_list_params.Filter | Omit = omit,
143
+ page: document_list_params.Page | Omit = omit,
143
144
  sort: List[Literal["filename", "created_at", "updated_at", "-filename", "-created_at", "-updated_at"]]
144
- | NotGiven = NOT_GIVEN,
145
+ | Omit = omit,
145
146
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
146
147
  # The extra values given here take precedence over values defined on the client or passed to this method.
147
148
  extra_headers: Headers | None = None,
148
149
  extra_query: Query | None = None,
149
150
  extra_body: Body | None = None,
150
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
151
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
151
152
  ) -> DocumentListResponse:
152
153
  """
153
154
  List all documents ordered by created_at descending.
@@ -199,7 +200,7 @@ class DocumentsResource(SyncAPIResource):
199
200
  extra_headers: Headers | None = None,
200
201
  extra_query: Query | None = None,
201
202
  extra_body: Body | None = None,
202
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
203
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
203
204
  ) -> DocumentDeleteResponse:
204
205
  """
205
206
  Delete a document.<br /><br />A document can only be deleted if it's not linked
@@ -234,7 +235,7 @@ class DocumentsResource(SyncAPIResource):
234
235
  extra_headers: Headers | None = None,
235
236
  extra_query: Query | None = None,
236
237
  extra_body: Body | None = None,
237
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
238
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
238
239
  ) -> BinaryAPIResponse:
239
240
  """
240
241
  Download a document.
@@ -259,19 +260,53 @@ class DocumentsResource(SyncAPIResource):
259
260
  cast_to=BinaryAPIResponse,
260
261
  )
261
262
 
263
+ def generate_download_link(
264
+ self,
265
+ id: str,
266
+ *,
267
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
268
+ # The extra values given here take precedence over values defined on the client or passed to this method.
269
+ extra_headers: Headers | None = None,
270
+ extra_query: Query | None = None,
271
+ extra_body: Body | None = None,
272
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
273
+ ) -> DocumentGenerateDownloadLinkResponse:
274
+ """
275
+ Generates a temporary pre-signed URL that can be used to download the document
276
+ directly from the storage backend without authentication.
277
+
278
+ Args:
279
+ extra_headers: Send extra headers
280
+
281
+ extra_query: Add additional query parameters to the request
282
+
283
+ extra_body: Add additional JSON properties to the request
284
+
285
+ timeout: Override the client-level default timeout for this request, in seconds
286
+ """
287
+ if not id:
288
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
289
+ return self._get(
290
+ f"/documents/{id}/download_link",
291
+ options=make_request_options(
292
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
293
+ ),
294
+ cast_to=DocumentGenerateDownloadLinkResponse,
295
+ )
296
+
262
297
  @overload
263
298
  def upload(
264
299
  self,
265
300
  *,
266
301
  url: str,
267
- customer_reference: str | NotGiven = NOT_GIVEN,
268
- filename: str | NotGiven = NOT_GIVEN,
302
+ customer_reference: str | Omit = omit,
303
+ filename: str | Omit = omit,
269
304
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
270
305
  # The extra values given here take precedence over values defined on the client or passed to this method.
271
306
  extra_headers: Headers | None = None,
272
307
  extra_query: Query | None = None,
273
308
  extra_body: Body | None = None,
274
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
309
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
275
310
  ) -> DocumentUploadResponse:
276
311
  """
277
312
  Upload a document.<br /><br />Uploaded files must be linked to a service within
@@ -300,14 +335,14 @@ class DocumentsResource(SyncAPIResource):
300
335
  self,
301
336
  *,
302
337
  file: Union[str, Base64FileInput],
303
- customer_reference: str | NotGiven = NOT_GIVEN,
304
- filename: str | NotGiven = NOT_GIVEN,
338
+ customer_reference: str | Omit = omit,
339
+ filename: str | Omit = omit,
305
340
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
306
341
  # The extra values given here take precedence over values defined on the client or passed to this method.
307
342
  extra_headers: Headers | None = None,
308
343
  extra_query: Query | None = None,
309
344
  extra_body: Body | None = None,
310
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
345
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
311
346
  ) -> DocumentUploadResponse:
312
347
  """
313
348
  Upload a document.<br /><br />Uploaded files must be linked to a service within
@@ -334,16 +369,16 @@ class DocumentsResource(SyncAPIResource):
334
369
  def upload(
335
370
  self,
336
371
  *,
337
- url: str | NotGiven = NOT_GIVEN,
338
- customer_reference: str | NotGiven = NOT_GIVEN,
339
- filename: str | NotGiven = NOT_GIVEN,
340
- file: Union[str, Base64FileInput] | NotGiven = NOT_GIVEN,
372
+ url: str | Omit = omit,
373
+ customer_reference: str | Omit = omit,
374
+ filename: str | Omit = omit,
375
+ file: Union[str, Base64FileInput] | Omit = omit,
341
376
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
342
377
  # The extra values given here take precedence over values defined on the client or passed to this method.
343
378
  extra_headers: Headers | None = None,
344
379
  extra_query: Query | None = None,
345
380
  extra_body: Body | None = None,
346
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
381
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
347
382
  ) -> DocumentUploadResponse:
348
383
  body = deepcopy_minimal(
349
384
  {
@@ -399,7 +434,7 @@ class AsyncDocumentsResource(AsyncAPIResource):
399
434
  extra_headers: Headers | None = None,
400
435
  extra_query: Query | None = None,
401
436
  extra_body: Body | None = None,
402
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
437
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
403
438
  ) -> DocumentRetrieveResponse:
404
439
  """
405
440
  Retrieve a document.
@@ -427,14 +462,14 @@ class AsyncDocumentsResource(AsyncAPIResource):
427
462
  self,
428
463
  id: str,
429
464
  *,
430
- customer_reference: str | NotGiven = NOT_GIVEN,
431
- filename: str | NotGiven = NOT_GIVEN,
465
+ customer_reference: str | Omit = omit,
466
+ filename: str | Omit = omit,
432
467
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
433
468
  # The extra values given here take precedence over values defined on the client or passed to this method.
434
469
  extra_headers: Headers | None = None,
435
470
  extra_query: Query | None = None,
436
471
  extra_body: Body | None = None,
437
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
472
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
438
473
  ) -> DocumentUpdateResponse:
439
474
  """
440
475
  Update a document.
@@ -472,16 +507,16 @@ class AsyncDocumentsResource(AsyncAPIResource):
472
507
  async def list(
473
508
  self,
474
509
  *,
475
- filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
476
- page: document_list_params.Page | NotGiven = NOT_GIVEN,
510
+ filter: document_list_params.Filter | Omit = omit,
511
+ page: document_list_params.Page | Omit = omit,
477
512
  sort: List[Literal["filename", "created_at", "updated_at", "-filename", "-created_at", "-updated_at"]]
478
- | NotGiven = NOT_GIVEN,
513
+ | Omit = omit,
479
514
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
480
515
  # The extra values given here take precedence over values defined on the client or passed to this method.
481
516
  extra_headers: Headers | None = None,
482
517
  extra_query: Query | None = None,
483
518
  extra_body: Body | None = None,
484
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
519
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
485
520
  ) -> DocumentListResponse:
486
521
  """
487
522
  List all documents ordered by created_at descending.
@@ -533,7 +568,7 @@ class AsyncDocumentsResource(AsyncAPIResource):
533
568
  extra_headers: Headers | None = None,
534
569
  extra_query: Query | None = None,
535
570
  extra_body: Body | None = None,
536
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
571
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
537
572
  ) -> DocumentDeleteResponse:
538
573
  """
539
574
  Delete a document.<br /><br />A document can only be deleted if it's not linked
@@ -568,7 +603,7 @@ class AsyncDocumentsResource(AsyncAPIResource):
568
603
  extra_headers: Headers | None = None,
569
604
  extra_query: Query | None = None,
570
605
  extra_body: Body | None = None,
571
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
606
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
572
607
  ) -> AsyncBinaryAPIResponse:
573
608
  """
574
609
  Download a document.
@@ -593,19 +628,53 @@ class AsyncDocumentsResource(AsyncAPIResource):
593
628
  cast_to=AsyncBinaryAPIResponse,
594
629
  )
595
630
 
631
+ async def generate_download_link(
632
+ self,
633
+ id: str,
634
+ *,
635
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
636
+ # The extra values given here take precedence over values defined on the client or passed to this method.
637
+ extra_headers: Headers | None = None,
638
+ extra_query: Query | None = None,
639
+ extra_body: Body | None = None,
640
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
641
+ ) -> DocumentGenerateDownloadLinkResponse:
642
+ """
643
+ Generates a temporary pre-signed URL that can be used to download the document
644
+ directly from the storage backend without authentication.
645
+
646
+ Args:
647
+ extra_headers: Send extra headers
648
+
649
+ extra_query: Add additional query parameters to the request
650
+
651
+ extra_body: Add additional JSON properties to the request
652
+
653
+ timeout: Override the client-level default timeout for this request, in seconds
654
+ """
655
+ if not id:
656
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
657
+ return await self._get(
658
+ f"/documents/{id}/download_link",
659
+ options=make_request_options(
660
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
661
+ ),
662
+ cast_to=DocumentGenerateDownloadLinkResponse,
663
+ )
664
+
596
665
  @overload
597
666
  async def upload(
598
667
  self,
599
668
  *,
600
669
  url: str,
601
- customer_reference: str | NotGiven = NOT_GIVEN,
602
- filename: str | NotGiven = NOT_GIVEN,
670
+ customer_reference: str | Omit = omit,
671
+ filename: str | Omit = omit,
603
672
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
604
673
  # The extra values given here take precedence over values defined on the client or passed to this method.
605
674
  extra_headers: Headers | None = None,
606
675
  extra_query: Query | None = None,
607
676
  extra_body: Body | None = None,
608
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
677
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
609
678
  ) -> DocumentUploadResponse:
610
679
  """
611
680
  Upload a document.<br /><br />Uploaded files must be linked to a service within
@@ -634,14 +703,14 @@ class AsyncDocumentsResource(AsyncAPIResource):
634
703
  self,
635
704
  *,
636
705
  file: Union[str, Base64FileInput],
637
- customer_reference: str | NotGiven = NOT_GIVEN,
638
- filename: str | NotGiven = NOT_GIVEN,
706
+ customer_reference: str | Omit = omit,
707
+ filename: str | Omit = omit,
639
708
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
640
709
  # The extra values given here take precedence over values defined on the client or passed to this method.
641
710
  extra_headers: Headers | None = None,
642
711
  extra_query: Query | None = None,
643
712
  extra_body: Body | None = None,
644
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
713
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
645
714
  ) -> DocumentUploadResponse:
646
715
  """
647
716
  Upload a document.<br /><br />Uploaded files must be linked to a service within
@@ -668,16 +737,16 @@ class AsyncDocumentsResource(AsyncAPIResource):
668
737
  async def upload(
669
738
  self,
670
739
  *,
671
- url: str | NotGiven = NOT_GIVEN,
672
- customer_reference: str | NotGiven = NOT_GIVEN,
673
- filename: str | NotGiven = NOT_GIVEN,
674
- file: Union[str, Base64FileInput] | NotGiven = NOT_GIVEN,
740
+ url: str | Omit = omit,
741
+ customer_reference: str | Omit = omit,
742
+ filename: str | Omit = omit,
743
+ file: Union[str, Base64FileInput] | Omit = omit,
675
744
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
676
745
  # The extra values given here take precedence over values defined on the client or passed to this method.
677
746
  extra_headers: Headers | None = None,
678
747
  extra_query: Query | None = None,
679
748
  extra_body: Body | None = None,
680
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
749
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
681
750
  ) -> DocumentUploadResponse:
682
751
  body = deepcopy_minimal(
683
752
  {
@@ -724,6 +793,9 @@ class DocumentsResourceWithRawResponse:
724
793
  documents.download,
725
794
  BinaryAPIResponse,
726
795
  )
796
+ self.generate_download_link = to_raw_response_wrapper(
797
+ documents.generate_download_link,
798
+ )
727
799
  self.upload = to_raw_response_wrapper(
728
800
  documents.upload,
729
801
  )
@@ -749,6 +821,9 @@ class AsyncDocumentsResourceWithRawResponse:
749
821
  documents.download,
750
822
  AsyncBinaryAPIResponse,
751
823
  )
824
+ self.generate_download_link = async_to_raw_response_wrapper(
825
+ documents.generate_download_link,
826
+ )
752
827
  self.upload = async_to_raw_response_wrapper(
753
828
  documents.upload,
754
829
  )
@@ -774,6 +849,9 @@ class DocumentsResourceWithStreamingResponse:
774
849
  documents.download,
775
850
  StreamedBinaryAPIResponse,
776
851
  )
852
+ self.generate_download_link = to_streamed_response_wrapper(
853
+ documents.generate_download_link,
854
+ )
777
855
  self.upload = to_streamed_response_wrapper(
778
856
  documents.upload,
779
857
  )
@@ -799,6 +877,9 @@ class AsyncDocumentsResourceWithStreamingResponse:
799
877
  documents.download,
800
878
  AsyncStreamedBinaryAPIResponse,
801
879
  )
880
+ self.generate_download_link = async_to_streamed_response_wrapper(
881
+ documents.generate_download_link,
882
+ )
802
883
  self.upload = async_to_streamed_response_wrapper(
803
884
  documents.upload,
804
885
  )