brevo-python 4.0.1__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.
Files changed (843) hide show
  1. brevo/__init__.py +2253 -0
  2. brevo/account/__init__.py +79 -0
  3. brevo/account/client.py +317 -0
  4. brevo/account/raw_client.py +341 -0
  5. brevo/account/types/__init__.py +77 -0
  6. brevo/account/types/get_account_activity_response.py +24 -0
  7. brevo/account/types/get_account_activity_response_logs_item.py +45 -0
  8. brevo/account/types/get_account_response.py +85 -0
  9. brevo/account/types/get_account_response_address.py +43 -0
  10. brevo/account/types/get_account_response_date_time_preferences.py +38 -0
  11. brevo/account/types/get_account_response_marketing_automation.py +29 -0
  12. brevo/account/types/get_account_response_plan_item.py +53 -0
  13. brevo/account/types/get_account_response_plan_item_type.py +5 -0
  14. brevo/account/types/get_account_response_plan_verticals_item.py +63 -0
  15. brevo/account/types/get_account_response_plan_verticals_item_plan_category.py +5 -0
  16. brevo/account/types/get_account_response_plan_verticals_item_status.py +5 -0
  17. brevo/account/types/get_account_response_plan_verticals_item_users.py +35 -0
  18. brevo/account/types/get_account_response_relay.py +34 -0
  19. brevo/account/types/get_account_response_relay_data.py +40 -0
  20. brevo/balance/__init__.py +139 -0
  21. brevo/balance/client.py +2589 -0
  22. brevo/balance/raw_client.py +4538 -0
  23. brevo/balance/types/__init__.py +169 -0
  24. brevo/balance/types/create_balance_limit_request_constraint_type.py +5 -0
  25. brevo/balance/types/create_balance_limit_request_duration_unit.py +5 -0
  26. brevo/balance/types/create_balance_limit_request_transaction_type.py +5 -0
  27. brevo/balance/types/create_balance_order_response.py +96 -0
  28. brevo/balance/types/get_balance_definition_list_request_sort.py +5 -0
  29. brevo/balance/types/get_balance_definition_list_request_sort_field.py +5 -0
  30. brevo/balance/types/get_balance_definition_list_request_version.py +5 -0
  31. brevo/balance/types/get_balance_definition_list_response.py +24 -0
  32. brevo/balance/types/get_balance_definition_request_version.py +5 -0
  33. brevo/balance/types/get_balance_limit_request_version.py +5 -0
  34. brevo/balance/types/get_contact_balances_response.py +30 -0
  35. brevo/balance/types/get_contact_balances_response_balances_item.py +33 -0
  36. brevo/balance/types/get_loyalty_balance_programs_pid_transaction_history_request_sort.py +5 -0
  37. brevo/balance/types/get_loyalty_balance_programs_pid_transaction_history_request_sort_field.py +7 -0
  38. brevo/balance/types/get_loyalty_balance_programs_pid_transaction_history_response.py +57 -0
  39. brevo/balance/types/get_loyalty_balance_programs_pid_transaction_history_response_transaction_history_item.py +77 -0
  40. brevo/balance/types/get_subscription_balances_response.py +21 -0
  41. brevo/balance/types/get_subscription_balances_response_balance_item.py +30 -0
  42. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_balance_availability_duration_modifier.py +7 -0
  43. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_balance_availability_duration_unit.py +7 -0
  44. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_balance_option_amount_overtaking_strategy.py +7 -0
  45. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_balance_option_credit_rounding.py +7 -0
  46. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_balance_option_debit_rounding.py +7 -0
  47. brevo/balance/types/post_loyalty_balance_programs_pid_balance_definitions_request_unit.py +26 -0
  48. brevo/balance/types/post_loyalty_balance_programs_pid_subscriptions_cid_balances_response.py +66 -0
  49. brevo/balance/types/update_balance_definition_request_balance_availability_duration_modifier.py +7 -0
  50. brevo/balance/types/update_balance_definition_request_balance_availability_duration_unit.py +7 -0
  51. brevo/balance/types/update_balance_definition_request_balance_option_amount_overtaking_strategy.py +7 -0
  52. brevo/balance/types/update_balance_definition_request_balance_option_credit_rounding.py +7 -0
  53. brevo/balance/types/update_balance_definition_request_balance_option_debit_rounding.py +7 -0
  54. brevo/balance/types/update_balance_definition_request_unit.py +26 -0
  55. brevo/balance/types/update_balance_limit_request_constraint_type.py +5 -0
  56. brevo/balance/types/update_balance_limit_request_duration_unit.py +5 -0
  57. brevo/balance/types/update_balance_limit_request_transaction_type.py +5 -0
  58. brevo/client.py +773 -0
  59. brevo/companies/__init__.py +61 -0
  60. brevo/companies/client.py +994 -0
  61. brevo/companies/raw_client.py +1285 -0
  62. brevo/companies/types/__init__.py +59 -0
  63. brevo/companies/types/get_companies_request_sort.py +5 -0
  64. brevo/companies/types/get_companies_response.py +28 -0
  65. brevo/companies/types/get_crm_attributes_companies_response_item.py +40 -0
  66. brevo/companies/types/post_companies_import_response.py +26 -0
  67. brevo/companies/types/post_companies_response.py +27 -0
  68. brevo/companies/types/post_crm_attributes_request_attribute_type.py +7 -0
  69. brevo/companies/types/post_crm_attributes_request_object_type.py +5 -0
  70. brevo/companies/types/post_crm_attributes_response.py +23 -0
  71. brevo/contacts/__init__.py +289 -0
  72. brevo/contacts/client.py +3298 -0
  73. brevo/contacts/raw_client.py +4614 -0
  74. brevo/contacts/types/__init__.py +309 -0
  75. brevo/contacts/types/add_contact_to_list_request_body.py +11 -0
  76. brevo/contacts/types/add_contact_to_list_request_body_emails.py +23 -0
  77. brevo/contacts/types/add_contact_to_list_request_body_ext_ids.py +29 -0
  78. brevo/contacts/types/add_contact_to_list_request_body_ids.py +23 -0
  79. brevo/contacts/types/create_attribute_request_attribute_category.py +7 -0
  80. brevo/contacts/types/create_attribute_request_enumeration_item.py +28 -0
  81. brevo/contacts/types/create_attribute_request_type.py +7 -0
  82. brevo/contacts/types/create_contact_request_attributes_value.py +5 -0
  83. brevo/contacts/types/create_contact_response.py +23 -0
  84. brevo/contacts/types/create_doi_contact_request_attributes_value.py +5 -0
  85. brevo/contacts/types/create_folder_response.py +23 -0
  86. brevo/contacts/types/create_list_response.py +23 -0
  87. brevo/contacts/types/delete_attribute_request_attribute_category.py +7 -0
  88. brevo/contacts/types/delete_contact_request_identifier.py +5 -0
  89. brevo/contacts/types/delete_contact_request_identifier_type.py +7 -0
  90. brevo/contacts/types/get_attributes_response.py +24 -0
  91. brevo/contacts/types/get_attributes_response_attributes_item.py +57 -0
  92. brevo/contacts/types/get_attributes_response_attributes_item_category.py +7 -0
  93. brevo/contacts/types/get_attributes_response_attributes_item_enumeration_item.py +28 -0
  94. brevo/contacts/types/get_attributes_response_attributes_item_type.py +7 -0
  95. brevo/contacts/types/get_contact_info_request_identifier.py +5 -0
  96. brevo/contacts/types/get_contact_info_request_identifier_type.py +7 -0
  97. brevo/contacts/types/get_contact_info_response.py +80 -0
  98. brevo/contacts/types/get_contact_info_response_attributes.py +22 -0
  99. brevo/contacts/types/get_contact_info_response_statistics.py +86 -0
  100. brevo/contacts/types/get_contact_info_response_statistics_clicked_item.py +33 -0
  101. brevo/contacts/types/get_contact_info_response_statistics_clicked_item_links_item.py +40 -0
  102. brevo/contacts/types/get_contact_info_response_statistics_complaints_item.py +31 -0
  103. brevo/contacts/types/get_contact_info_response_statistics_delivered_item.py +31 -0
  104. brevo/contacts/types/get_contact_info_response_statistics_hard_bounces_item.py +31 -0
  105. brevo/contacts/types/get_contact_info_response_statistics_messages_sent_item.py +31 -0
  106. brevo/contacts/types/get_contact_info_response_statistics_opened_item.py +40 -0
  107. brevo/contacts/types/get_contact_info_response_statistics_soft_bounces_item.py +31 -0
  108. brevo/contacts/types/get_contact_info_response_statistics_transac_attributes_item.py +18 -0
  109. brevo/contacts/types/get_contact_info_response_statistics_unsubscriptions.py +43 -0
  110. brevo/contacts/types/get_contact_info_response_statistics_unsubscriptions_admin_unsubscription_item.py +30 -0
  111. brevo/contacts/types/get_contact_info_response_statistics_unsubscriptions_user_unsubscription_item.py +35 -0
  112. brevo/contacts/types/get_contact_stats_request_identifier.py +5 -0
  113. brevo/contacts/types/get_contact_stats_response.py +59 -0
  114. brevo/contacts/types/get_contact_stats_response_clicked_item.py +28 -0
  115. brevo/contacts/types/get_contact_stats_response_clicked_item_links_item.py +40 -0
  116. brevo/contacts/types/get_contact_stats_response_complaints_item.py +31 -0
  117. brevo/contacts/types/get_contact_stats_response_delivered_item.py +31 -0
  118. brevo/contacts/types/get_contact_stats_response_hard_bounces_item.py +31 -0
  119. brevo/contacts/types/get_contact_stats_response_messages_sent_item.py +31 -0
  120. brevo/contacts/types/get_contact_stats_response_opened_item.py +40 -0
  121. brevo/contacts/types/get_contact_stats_response_soft_bounces_item.py +31 -0
  122. brevo/contacts/types/get_contact_stats_response_transac_attributes_item.py +31 -0
  123. brevo/contacts/types/get_contact_stats_response_unsubscriptions.py +39 -0
  124. brevo/contacts/types/get_contact_stats_response_unsubscriptions_admin_unsubscription_item.py +30 -0
  125. brevo/contacts/types/get_contact_stats_response_unsubscriptions_user_unsubscription_item.py +35 -0
  126. brevo/contacts/types/get_contacts_from_list_request_sort.py +5 -0
  127. brevo/contacts/types/get_contacts_request_sort.py +5 -0
  128. brevo/contacts/types/get_folder_lists_request_sort.py +5 -0
  129. brevo/contacts/types/get_folder_lists_response.py +26 -0
  130. brevo/contacts/types/get_folders_request_sort.py +5 -0
  131. brevo/contacts/types/get_folders_response.py +26 -0
  132. brevo/contacts/types/get_list_response.py +68 -0
  133. brevo/contacts/types/get_list_response_campaign_stats_item.py +26 -0
  134. brevo/contacts/types/get_lists_request_sort.py +5 -0
  135. brevo/contacts/types/get_lists_response.py +29 -0
  136. brevo/contacts/types/get_lists_response_lists_item.py +49 -0
  137. brevo/contacts/types/get_segments_request_sort.py +5 -0
  138. brevo/contacts/types/get_segments_response.py +29 -0
  139. brevo/contacts/types/get_segments_response_segments_item.py +41 -0
  140. brevo/contacts/types/import_contacts_request_json_body_item.py +25 -0
  141. brevo/contacts/types/import_contacts_request_new_list.py +41 -0
  142. brevo/contacts/types/import_contacts_response.py +26 -0
  143. brevo/contacts/types/remove_contact_from_list_request_body.py +15 -0
  144. brevo/contacts/types/remove_contact_from_list_request_body_all.py +29 -0
  145. brevo/contacts/types/remove_contact_from_list_request_body_emails.py +23 -0
  146. brevo/contacts/types/remove_contact_from_list_request_body_ext_ids.py +29 -0
  147. brevo/contacts/types/remove_contact_from_list_request_body_ids.py +23 -0
  148. brevo/contacts/types/request_contact_export_request_custom_contact_filter.py +90 -0
  149. brevo/contacts/types/request_contact_export_request_custom_contact_filter_action_for_contacts.py +7 -0
  150. brevo/contacts/types/request_contact_export_request_custom_contact_filter_action_for_email_campaigns.py +8 -0
  151. brevo/contacts/types/request_contact_export_request_custom_contact_filter_action_for_sms_campaigns.py +7 -0
  152. brevo/contacts/types/request_contact_export_response.py +26 -0
  153. brevo/contacts/types/update_attribute_request_attribute_category.py +7 -0
  154. brevo/contacts/types/update_attribute_request_enumeration_item.py +28 -0
  155. brevo/contacts/types/update_batch_contacts_request_contacts_item.py +80 -0
  156. brevo/contacts/types/update_contact_request_attributes_value.py +5 -0
  157. brevo/contacts/types/update_contact_request_identifier.py +5 -0
  158. brevo/contacts/types/update_contact_request_identifier_type.py +7 -0
  159. brevo/conversations/__init__.py +34 -0
  160. brevo/conversations/client.py +912 -0
  161. brevo/conversations/raw_client.py +1328 -0
  162. brevo/conversations/types/__init__.py +36 -0
  163. brevo/conversations/types/put_conversations_visitor_group_response.py +31 -0
  164. brevo/core/__init__.py +125 -0
  165. brevo/core/api_error.py +23 -0
  166. brevo/core/client_wrapper.py +100 -0
  167. brevo/core/datetime_utils.py +28 -0
  168. brevo/core/file.py +67 -0
  169. brevo/core/force_multipart.py +18 -0
  170. brevo/core/http_client.py +776 -0
  171. brevo/core/http_response.py +59 -0
  172. brevo/core/http_sse/__init__.py +42 -0
  173. brevo/core/http_sse/_api.py +112 -0
  174. brevo/core/http_sse/_decoders.py +61 -0
  175. brevo/core/http_sse/_exceptions.py +7 -0
  176. brevo/core/http_sse/_models.py +17 -0
  177. brevo/core/jsonable_encoder.py +108 -0
  178. brevo/core/logging.py +107 -0
  179. brevo/core/pydantic_utilities.py +577 -0
  180. brevo/core/query_encoder.py +58 -0
  181. brevo/core/remove_none_from_dict.py +11 -0
  182. brevo/core/request_options.py +35 -0
  183. brevo/core/serialization.py +276 -0
  184. brevo/core/unchecked_base_model.py +376 -0
  185. brevo/coupons/__init__.py +49 -0
  186. brevo/coupons/client.py +550 -0
  187. brevo/coupons/raw_client.py +839 -0
  188. brevo/coupons/types/__init__.py +47 -0
  189. brevo/coupons/types/create_coupon_collection_response.py +23 -0
  190. brevo/coupons/types/get_coupon_collections_request_sort.py +5 -0
  191. brevo/coupons/types/get_coupon_collections_request_sort_by.py +7 -0
  192. brevo/coupons/types/update_coupon_collection_response.py +35 -0
  193. brevo/custom_objects/__init__.py +139 -0
  194. brevo/custom_objects/client.py +437 -0
  195. brevo/custom_objects/raw_client.py +711 -0
  196. brevo/custom_objects/types/__init__.py +177 -0
  197. brevo/custom_objects/types/batch_delete_object_records_request_identifiers.py +10 -0
  198. brevo/custom_objects/types/batch_delete_object_records_request_identifiers_ext_ids.py +23 -0
  199. brevo/custom_objects/types/batch_delete_object_records_request_identifiers_ids.py +23 -0
  200. brevo/custom_objects/types/batch_delete_object_records_response.py +27 -0
  201. brevo/custom_objects/types/getrecords_request_association.py +5 -0
  202. brevo/custom_objects/types/getrecords_request_sort.py +5 -0
  203. brevo/custom_objects/types/getrecords_response.py +26 -0
  204. brevo/custom_objects/types/getrecords_response_records_item.py +51 -0
  205. brevo/custom_objects/types/getrecords_response_records_item_associations_item.py +10 -0
  206. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one.py +28 -0
  207. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one_records_item.py +15 -0
  208. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one_records_item_one.py +28 -0
  209. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one_records_item_one_identifiers.py +27 -0
  210. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one_records_item_zero.py +28 -0
  211. brevo/custom_objects/types/getrecords_response_records_item_associations_item_one_records_item_zero_identifiers.py +27 -0
  212. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero.py +28 -0
  213. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero_records_item.py +15 -0
  214. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero_records_item_one.py +28 -0
  215. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero_records_item_one_identifiers.py +27 -0
  216. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero_records_item_zero.py +28 -0
  217. brevo/custom_objects/types/getrecords_response_records_item_associations_item_zero_records_item_zero_identifiers.py +27 -0
  218. brevo/custom_objects/types/getrecords_response_records_item_identifiers.py +32 -0
  219. brevo/custom_objects/types/upsertrecords_request_records_item.py +31 -0
  220. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item.py +12 -0
  221. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_one.py +28 -0
  222. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_one_records_item.py +15 -0
  223. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_one_records_item_one.py +20 -0
  224. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_one_records_item_zero.py +28 -0
  225. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_one_records_item_zero_identifiers.py +32 -0
  226. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_zero.py +28 -0
  227. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_zero_records_item.py +23 -0
  228. brevo/custom_objects/types/upsertrecords_request_records_item_associations_item_zero_records_item_identifiers.py +28 -0
  229. brevo/custom_objects/types/upsertrecords_request_records_item_identifiers.py +32 -0
  230. brevo/custom_objects/types/upsertrecords_response.py +29 -0
  231. brevo/deals/__init__.py +52 -0
  232. brevo/deals/client.py +1013 -0
  233. brevo/deals/raw_client.py +1326 -0
  234. brevo/deals/types/__init__.py +50 -0
  235. brevo/deals/types/get_crm_attributes_deals_response_item.py +40 -0
  236. brevo/deals/types/get_crm_deals_request_sort.py +5 -0
  237. brevo/deals/types/get_crm_deals_response.py +28 -0
  238. brevo/deals/types/post_crm_deals_import_response.py +26 -0
  239. brevo/deals/types/post_crm_deals_response.py +27 -0
  240. brevo/domains/__init__.py +79 -0
  241. brevo/domains/client.py +506 -0
  242. brevo/domains/raw_client.py +698 -0
  243. brevo/domains/types/__init__.py +83 -0
  244. brevo/domains/types/authenticate_domain_response.py +28 -0
  245. brevo/domains/types/create_domain_response.py +44 -0
  246. brevo/domains/types/create_domain_response_dns_records.py +40 -0
  247. brevo/domains/types/create_domain_response_dns_records_brevo_code.py +42 -0
  248. brevo/domains/types/create_domain_response_dns_records_dkim_record.py +42 -0
  249. brevo/domains/types/create_domain_response_dns_records_dmarc_record.py +42 -0
  250. brevo/domains/types/get_domain_configuration_response.py +41 -0
  251. brevo/domains/types/get_domain_configuration_response_dns_records.py +44 -0
  252. brevo/domains/types/get_domain_configuration_response_dns_records_brevo_code.py +42 -0
  253. brevo/domains/types/get_domain_configuration_response_dns_records_dkim_record.py +42 -0
  254. brevo/domains/types/get_domain_configuration_response_dns_records_dmarc_record.py +42 -0
  255. brevo/domains/types/get_domains_response.py +39 -0
  256. brevo/domains/types/get_domains_response_domains_item.py +56 -0
  257. brevo/domains/types/get_domains_response_domains_item_creator.py +41 -0
  258. brevo/ecommerce/__init__.py +112 -0
  259. brevo/ecommerce/client.py +2176 -0
  260. brevo/ecommerce/raw_client.py +2895 -0
  261. brevo/ecommerce/types/__init__.py +124 -0
  262. brevo/ecommerce/types/create_batch_order_response.py +28 -0
  263. brevo/ecommerce/types/create_product_alert_request_contact_identifiers.py +33 -0
  264. brevo/ecommerce/types/create_update_batch_category_request_categories_item.py +48 -0
  265. brevo/ecommerce/types/create_update_batch_category_response.py +31 -0
  266. brevo/ecommerce/types/create_update_batch_products_request_products_item.py +89 -0
  267. brevo/ecommerce/types/create_update_batch_products_request_products_item_meta_info_value.py +5 -0
  268. brevo/ecommerce/types/create_update_batch_products_response.py +31 -0
  269. brevo/ecommerce/types/create_update_category_response.py +23 -0
  270. brevo/ecommerce/types/create_update_product_request_meta_info_value.py +5 -0
  271. brevo/ecommerce/types/create_update_product_response.py +23 -0
  272. brevo/ecommerce/types/get_categories_request_sort.py +5 -0
  273. brevo/ecommerce/types/get_categories_response.py +25 -0
  274. brevo/ecommerce/types/get_ecommerce_attribution_metrics_conversion_source_conversion_source_id_request_conversion_source.py +7 -0
  275. brevo/ecommerce/types/get_ecommerce_attribution_metrics_conversion_source_conversion_source_id_response.py +40 -0
  276. brevo/ecommerce/types/get_ecommerce_attribution_metrics_conversion_source_conversion_source_id_response_conversion_source.py +7 -0
  277. brevo/ecommerce/types/get_ecommerce_attribution_metrics_response.py +30 -0
  278. brevo/ecommerce/types/get_ecommerce_attribution_metrics_response_totals.py +32 -0
  279. brevo/ecommerce/types/get_ecommerce_attribution_products_conversion_source_conversion_source_id_request_conversion_source.py +7 -0
  280. brevo/ecommerce/types/get_ecommerce_attribution_products_conversion_source_conversion_source_id_response.py +28 -0
  281. brevo/ecommerce/types/get_ecommerce_attribution_products_conversion_source_conversion_source_id_response_products_item.py +33 -0
  282. brevo/ecommerce/types/get_ecommerce_config_display_currency_response.py +23 -0
  283. brevo/ecommerce/types/get_orders_request_sort.py +5 -0
  284. brevo/ecommerce/types/get_products_request_sort.py +5 -0
  285. brevo/ecommerce/types/get_products_response.py +26 -0
  286. brevo/ecommerce/types/set_config_display_currency_response.py +23 -0
  287. brevo/email_campaigns/__init__.py +139 -0
  288. brevo/email_campaigns/client.py +1864 -0
  289. brevo/email_campaigns/raw_client.py +2472 -0
  290. brevo/email_campaigns/types/__init__.py +141 -0
  291. brevo/email_campaigns/types/create_email_campaign_request_email_expiration_date.py +33 -0
  292. brevo/email_campaigns/types/create_email_campaign_request_email_expiration_date_unit.py +5 -0
  293. brevo/email_campaigns/types/create_email_campaign_request_recipients.py +52 -0
  294. brevo/email_campaigns/types/create_email_campaign_request_sender.py +37 -0
  295. brevo/email_campaigns/types/create_email_campaign_request_winner_criteria.py +5 -0
  296. brevo/email_campaigns/types/create_email_campaign_response.py +23 -0
  297. brevo/email_campaigns/types/email_export_recipients_request_recipients_type.py +10 -0
  298. brevo/email_campaigns/types/email_export_recipients_response.py +26 -0
  299. brevo/email_campaigns/types/get_ab_test_campaign_result_response.py +64 -0
  300. brevo/email_campaigns/types/get_ab_test_campaign_result_response_clicked_links.py +28 -0
  301. brevo/email_campaigns/types/get_ab_test_campaign_result_response_statistics.py +32 -0
  302. brevo/email_campaigns/types/get_ab_test_campaign_result_response_winning_criteria.py +5 -0
  303. brevo/email_campaigns/types/get_ab_test_campaign_result_response_winning_version.py +7 -0
  304. brevo/email_campaigns/types/get_email_campaign_request_statistics.py +7 -0
  305. brevo/email_campaigns/types/get_email_campaign_response.py +234 -0
  306. brevo/email_campaigns/types/get_email_campaign_response_sender.py +33 -0
  307. brevo/email_campaigns/types/get_email_campaign_response_status.py +7 -0
  308. brevo/email_campaigns/types/get_email_campaign_response_type.py +5 -0
  309. brevo/email_campaigns/types/get_email_campaigns_request_sort.py +5 -0
  310. brevo/email_campaigns/types/get_email_campaigns_request_statistics.py +7 -0
  311. brevo/email_campaigns/types/get_email_campaigns_request_status.py +7 -0
  312. brevo/email_campaigns/types/get_email_campaigns_request_type.py +5 -0
  313. brevo/email_campaigns/types/get_email_campaigns_response.py +25 -0
  314. brevo/email_campaigns/types/get_email_campaigns_response_campaigns_item.py +234 -0
  315. brevo/email_campaigns/types/get_email_campaigns_response_campaigns_item_sender.py +33 -0
  316. brevo/email_campaigns/types/get_email_campaigns_response_campaigns_item_status.py +7 -0
  317. brevo/email_campaigns/types/get_email_campaigns_response_campaigns_item_type.py +5 -0
  318. brevo/email_campaigns/types/get_shared_template_url_response.py +29 -0
  319. brevo/email_campaigns/types/update_email_campaign_request_email_expiration_date.py +33 -0
  320. brevo/email_campaigns/types/update_email_campaign_request_email_expiration_date_unit.py +5 -0
  321. brevo/email_campaigns/types/update_email_campaign_request_recipients.py +53 -0
  322. brevo/email_campaigns/types/update_email_campaign_request_sender.py +37 -0
  323. brevo/email_campaigns/types/update_email_campaign_request_winner_criteria.py +5 -0
  324. brevo/email_campaigns/types/upload_image_to_gallery_response.py +23 -0
  325. brevo/environment.py +7 -0
  326. brevo/errors/__init__.py +80 -0
  327. brevo/errors/bad_request_error.py +10 -0
  328. brevo/errors/conflict_error.py +11 -0
  329. brevo/errors/expectation_failed_error.py +11 -0
  330. brevo/errors/failed_dependency_error.py +10 -0
  331. brevo/errors/forbidden_error.py +10 -0
  332. brevo/errors/internal_server_error.py +10 -0
  333. brevo/errors/method_not_allowed_error.py +11 -0
  334. brevo/errors/not_found_error.py +10 -0
  335. brevo/errors/payment_required_error.py +11 -0
  336. brevo/errors/precondition_failed_error.py +11 -0
  337. brevo/errors/too_early_error.py +11 -0
  338. brevo/errors/too_many_requests_error.py +11 -0
  339. brevo/errors/unauthorized_error.py +10 -0
  340. brevo/errors/unprocessable_entity_error.py +11 -0
  341. brevo/errors/unsupported_media_type_error.py +11 -0
  342. brevo/event/__init__.py +52 -0
  343. brevo/event/client.py +184 -0
  344. brevo/event/raw_client.py +230 -0
  345. brevo/event/types/__init__.py +50 -0
  346. brevo/event/types/create_event_request_contact_properties_value.py +5 -0
  347. brevo/event/types/create_event_request_event_properties_value.py +5 -0
  348. brevo/event/types/create_event_request_identifiers.py +52 -0
  349. brevo/event/types/create_event_request_object.py +33 -0
  350. brevo/event/types/create_event_request_object_identifiers.py +32 -0
  351. brevo/external_feeds/__init__.py +79 -0
  352. brevo/external_feeds/client.py +915 -0
  353. brevo/external_feeds/raw_client.py +1087 -0
  354. brevo/external_feeds/types/__init__.py +77 -0
  355. brevo/external_feeds/types/create_external_feed_request_auth_type.py +5 -0
  356. brevo/external_feeds/types/create_external_feed_request_headers_item.py +28 -0
  357. brevo/external_feeds/types/create_external_feed_response.py +23 -0
  358. brevo/external_feeds/types/get_all_external_feeds_request_auth_type.py +5 -0
  359. brevo/external_feeds/types/get_all_external_feeds_request_sort.py +5 -0
  360. brevo/external_feeds/types/get_all_external_feeds_response.py +29 -0
  361. brevo/external_feeds/types/get_all_external_feeds_response_feeds_item.py +96 -0
  362. brevo/external_feeds/types/get_all_external_feeds_response_feeds_item_auth_type.py +5 -0
  363. brevo/external_feeds/types/get_all_external_feeds_response_feeds_item_headers_item.py +28 -0
  364. brevo/external_feeds/types/get_external_feed_by_uuid_response.py +105 -0
  365. brevo/external_feeds/types/get_external_feed_by_uuid_response_auth_type.py +5 -0
  366. brevo/external_feeds/types/get_external_feed_by_uuid_response_headers_item.py +28 -0
  367. brevo/external_feeds/types/update_external_feed_request_auth_type.py +5 -0
  368. brevo/external_feeds/types/update_external_feed_request_headers_item.py +28 -0
  369. brevo/files/__init__.py +38 -0
  370. brevo/files/client.py +479 -0
  371. brevo/files/raw_client.py +675 -0
  372. brevo/files/types/__init__.py +40 -0
  373. brevo/files/types/get_crm_files_id_response.py +30 -0
  374. brevo/files/types/get_crm_files_request_entity.py +5 -0
  375. brevo/files/types/get_crm_files_request_sort.py +5 -0
  376. brevo/inbound_parsing/__init__.py +58 -0
  377. brevo/inbound_parsing/client.py +323 -0
  378. brevo/inbound_parsing/raw_client.py +420 -0
  379. brevo/inbound_parsing/types/__init__.py +60 -0
  380. brevo/inbound_parsing/types/get_inbound_email_events_by_uuid_response.py +72 -0
  381. brevo/inbound_parsing/types/get_inbound_email_events_by_uuid_response_attachments_item.py +40 -0
  382. brevo/inbound_parsing/types/get_inbound_email_events_by_uuid_response_logs_item.py +30 -0
  383. brevo/inbound_parsing/types/get_inbound_email_events_by_uuid_response_logs_item_type.py +7 -0
  384. brevo/inbound_parsing/types/get_inbound_email_events_request_sort.py +5 -0
  385. brevo/inbound_parsing/types/get_inbound_email_events_response.py +21 -0
  386. brevo/inbound_parsing/types/get_inbound_email_events_response_events_item.py +42 -0
  387. brevo/master_account/__init__.py +202 -0
  388. brevo/master_account/client.py +2757 -0
  389. brevo/master_account/raw_client.py +3351 -0
  390. brevo/master_account/types/__init__.py +244 -0
  391. brevo/master_account/types/get_corporate_group_id_response.py +31 -0
  392. brevo/master_account/types/get_corporate_group_id_response_group.py +35 -0
  393. brevo/master_account/types/get_corporate_group_id_response_sub_accounts_item.py +35 -0
  394. brevo/master_account/types/get_corporate_group_id_response_users_item.py +36 -0
  395. brevo/master_account/types/get_corporate_invited_users_list_response.py +24 -0
  396. brevo/master_account/types/get_corporate_invited_users_list_response_users_item.py +50 -0
  397. brevo/master_account/types/get_corporate_invited_users_list_response_users_item_feature_access.py +69 -0
  398. brevo/master_account/types/get_corporate_invited_users_list_response_users_item_groups.py +32 -0
  399. brevo/master_account/types/get_corporate_ip_response_item.py +22 -0
  400. brevo/master_account/types/get_corporate_master_account_response.py +57 -0
  401. brevo/master_account/types/get_corporate_master_account_response_billing_info.py +48 -0
  402. brevo/master_account/types/get_corporate_master_account_response_billing_info_address.py +50 -0
  403. brevo/master_account/types/get_corporate_master_account_response_billing_info_name.py +35 -0
  404. brevo/master_account/types/get_corporate_master_account_response_plan_info.py +63 -0
  405. brevo/master_account/types/get_corporate_master_account_response_plan_info_features_item.py +62 -0
  406. brevo/master_account/types/get_corporate_master_account_response_plan_info_plan_period.py +5 -0
  407. brevo/master_account/types/get_corporate_sub_account_id_response.py +48 -0
  408. brevo/master_account/types/get_corporate_sub_account_id_response_groups_item.py +28 -0
  409. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info.py +42 -0
  410. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits.py +65 -0
  411. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits_emails.py +32 -0
  412. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits_external_feeds.py +33 -0
  413. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits_sms.py +32 -0
  414. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits_whatsapp.py +32 -0
  415. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_credits_wp_subscribers.py +32 -0
  416. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_features.py +58 -0
  417. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_features_inbox.py +32 -0
  418. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_features_landing_page.py +32 -0
  419. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_features_sales_users.py +33 -0
  420. brevo/master_account/types/get_corporate_sub_account_id_response_plan_info_features_users.py +32 -0
  421. brevo/master_account/types/get_corporate_sub_account_response.py +32 -0
  422. brevo/master_account/types/get_corporate_sub_account_response_sub_accounts_item.py +48 -0
  423. brevo/master_account/types/get_corporate_sub_account_response_sub_accounts_item_groups_item.py +28 -0
  424. brevo/master_account/types/get_corporate_user_permission_response.py +40 -0
  425. brevo/master_account/types/get_corporate_user_permission_response_feature_access.py +62 -0
  426. brevo/master_account/types/get_corporate_user_permission_response_groups_item.py +32 -0
  427. brevo/master_account/types/get_sub_account_groups_response_item.py +30 -0
  428. brevo/master_account/types/invite_admin_user_request_privileges_item.py +38 -0
  429. brevo/master_account/types/invite_admin_user_request_privileges_item_feature.py +18 -0
  430. brevo/master_account/types/invite_admin_user_request_privileges_item_permissions_item.py +7 -0
  431. brevo/master_account/types/invite_admin_user_response.py +20 -0
  432. brevo/master_account/types/post_corporate_group_response.py +20 -0
  433. brevo/master_account/types/post_corporate_sub_account_key_response.py +28 -0
  434. brevo/master_account/types/post_corporate_sub_account_request_language.py +5 -0
  435. brevo/master_account/types/post_corporate_sub_account_response.py +23 -0
  436. brevo/master_account/types/post_corporate_sub_account_sso_token_request_target.py +17 -0
  437. brevo/master_account/types/put_corporate_sub_account_id_plan_request_credits.py +59 -0
  438. brevo/master_account/types/put_corporate_sub_account_id_plan_request_features.py +44 -0
  439. brevo/master_account/types/put_corporate_sub_accounts_plan_request_credits.py +59 -0
  440. brevo/master_account/types/put_corporate_sub_accounts_plan_request_features.py +39 -0
  441. brevo/master_account/types/put_corporate_user_email_permissions_request_privileges_item.py +42 -0
  442. brevo/master_account/types/put_corporate_user_email_permissions_request_privileges_item_feature.py +18 -0
  443. brevo/master_account/types/put_corporate_user_email_permissions_request_privileges_item_permissions_item.py +10 -0
  444. brevo/master_account/types/put_corporate_user_invitation_action_email_request_action.py +5 -0
  445. brevo/master_account/types/put_corporate_user_invitation_action_email_response.py +23 -0
  446. brevo/notes/__init__.py +38 -0
  447. brevo/notes/client.py +548 -0
  448. brevo/notes/raw_client.py +766 -0
  449. brevo/notes/types/__init__.py +40 -0
  450. brevo/notes/types/get_crm_notes_request_entity.py +5 -0
  451. brevo/notes/types/get_crm_notes_request_sort.py +5 -0
  452. brevo/notes/types/post_crm_notes_response.py +27 -0
  453. brevo/payments/__init__.py +38 -0
  454. brevo/payments/client.py +315 -0
  455. brevo/payments/raw_client.py +532 -0
  456. brevo/payments/types/__init__.py +40 -0
  457. brevo/payments/types/create_payment_request_response.py +28 -0
  458. brevo/payments/types/get_payment_request_response.py +47 -0
  459. brevo/payments/types/get_payment_request_response_status.py +5 -0
  460. brevo/process/__init__.py +79 -0
  461. brevo/process/client.py +304 -0
  462. brevo/process/raw_client.py +372 -0
  463. brevo/process/types/__init__.py +77 -0
  464. brevo/process/types/get_process_response.py +62 -0
  465. brevo/process/types/get_process_response_info.py +36 -0
  466. brevo/process/types/get_process_response_info_export.py +32 -0
  467. brevo/process/types/get_process_response_info_import.py +57 -0
  468. brevo/process/types/get_process_response_name.py +16 -0
  469. brevo/process/types/get_process_response_status.py +7 -0
  470. brevo/process/types/get_processes_request_sort.py +5 -0
  471. brevo/process/types/get_processes_response.py +29 -0
  472. brevo/process/types/get_processes_response_processes_item.py +62 -0
  473. brevo/process/types/get_processes_response_processes_item_info.py +36 -0
  474. brevo/process/types/get_processes_response_processes_item_info_export.py +32 -0
  475. brevo/process/types/get_processes_response_processes_item_info_import.py +57 -0
  476. brevo/process/types/get_processes_response_processes_item_name.py +16 -0
  477. brevo/process/types/get_processes_response_processes_item_status.py +7 -0
  478. brevo/program/__init__.py +67 -0
  479. brevo/program/client.py +1128 -0
  480. brevo/program/raw_client.py +2526 -0
  481. brevo/program/types/__init__.py +67 -0
  482. brevo/program/types/get_lp_list_request_sort_field.py +5 -0
  483. brevo/program/types/get_lp_list_response.py +24 -0
  484. brevo/program/types/get_parameter_subscription_info_response.py +44 -0
  485. brevo/program/types/get_parameter_subscription_info_response_balance.py +41 -0
  486. brevo/program/types/get_parameter_subscription_info_response_balance_balances_item.py +30 -0
  487. brevo/program/types/get_parameter_subscription_info_response_members_item.py +36 -0
  488. brevo/program/types/get_parameter_subscription_info_response_reward_item.py +66 -0
  489. brevo/program/types/get_parameter_subscription_info_response_tier_item.py +56 -0
  490. brevo/program/types/subscribe_member_to_a_subscription_response.py +46 -0
  491. brevo/program/types/subscribe_to_loyalty_program_response.py +56 -0
  492. brevo/py.typed +0 -0
  493. brevo/reward/__init__.py +115 -0
  494. brevo/reward/client.py +1285 -0
  495. brevo/reward/raw_client.py +2564 -0
  496. brevo/reward/types/__init__.py +139 -0
  497. brevo/reward/types/create_reward_response.py +64 -0
  498. brevo/reward/types/create_voucher_response.py +76 -0
  499. brevo/reward/types/get_code_count_response.py +23 -0
  500. brevo/reward/types/get_loyalty_offer_programs_pid_offers_request_version.py +5 -0
  501. brevo/reward/types/get_loyalty_offer_programs_pid_offers_response.py +34 -0
  502. brevo/reward/types/get_loyalty_offer_programs_pid_offers_response_items_item.py +67 -0
  503. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_request_version.py +5 -0
  504. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response.py +269 -0
  505. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_expiration_modifier.py +7 -0
  506. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_generator.py +52 -0
  507. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_limits_item.py +68 -0
  508. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_products_item.py +40 -0
  509. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_reward_configs.py +33 -0
  510. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_rule.py +101 -0
  511. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_rule_event.py +28 -0
  512. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_rule_results_item.py +43 -0
  513. brevo/reward/types/get_loyalty_offer_programs_pid_rewards_rid_response_rule_results_item_parameters_item.py +37 -0
  514. brevo/reward/types/get_loyalty_offer_programs_pid_vouchers_request_sort.py +5 -0
  515. brevo/reward/types/get_loyalty_offer_programs_pid_vouchers_request_sort_field.py +5 -0
  516. brevo/reward/types/get_loyalty_offer_programs_pid_vouchers_response.py +49 -0
  517. brevo/reward/types/get_loyalty_offer_programs_pid_vouchers_response_contact_rewards_item.py +70 -0
  518. brevo/reward/types/redeem_voucher_request_order.py +85 -0
  519. brevo/reward/types/redeem_voucher_request_order_billing.py +55 -0
  520. brevo/reward/types/redeem_voucher_request_order_identifiers.py +28 -0
  521. brevo/reward/types/redeem_voucher_request_order_products_item.py +46 -0
  522. brevo/reward/types/validate_reward_response.py +23 -0
  523. brevo/senders/__init__.py +67 -0
  524. brevo/senders/client.py +808 -0
  525. brevo/senders/raw_client.py +1089 -0
  526. brevo/senders/types/__init__.py +65 -0
  527. brevo/senders/types/create_sender_request_ips_item.py +36 -0
  528. brevo/senders/types/create_sender_response.py +42 -0
  529. brevo/senders/types/get_ips_from_sender_response.py +25 -0
  530. brevo/senders/types/get_ips_from_sender_response_ips_item.py +38 -0
  531. brevo/senders/types/get_ips_response.py +25 -0
  532. brevo/senders/types/get_ips_response_ips_item.py +38 -0
  533. brevo/senders/types/get_senders_response.py +24 -0
  534. brevo/senders/types/get_senders_response_senders_item.py +46 -0
  535. brevo/senders/types/get_senders_response_senders_item_ips_item.py +33 -0
  536. brevo/senders/types/update_sender_request_ips_item.py +36 -0
  537. brevo/sms_campaigns/__init__.py +73 -0
  538. brevo/sms_campaigns/client.py +1078 -0
  539. brevo/sms_campaigns/raw_client.py +1501 -0
  540. brevo/sms_campaigns/types/__init__.py +71 -0
  541. brevo/sms_campaigns/types/create_sms_campaign_request_recipients.py +33 -0
  542. brevo/sms_campaigns/types/create_sms_campaign_response.py +23 -0
  543. brevo/sms_campaigns/types/get_sms_campaign_response.py +74 -0
  544. brevo/sms_campaigns/types/get_sms_campaign_response_status.py +7 -0
  545. brevo/sms_campaigns/types/get_sms_campaigns_request_sort.py +5 -0
  546. brevo/sms_campaigns/types/get_sms_campaigns_request_status.py +7 -0
  547. brevo/sms_campaigns/types/get_sms_campaigns_response.py +25 -0
  548. brevo/sms_campaigns/types/get_sms_campaigns_response_campaigns_item.py +74 -0
  549. brevo/sms_campaigns/types/get_sms_campaigns_response_campaigns_item_status.py +7 -0
  550. brevo/sms_campaigns/types/request_sms_recipient_export_request_recipients_type.py +7 -0
  551. brevo/sms_campaigns/types/request_sms_recipient_export_response.py +26 -0
  552. brevo/sms_campaigns/types/update_sms_campaign_request_recipients.py +33 -0
  553. brevo/sms_templates/__init__.py +49 -0
  554. brevo/sms_templates/client.py +133 -0
  555. brevo/sms_templates/raw_client.py +151 -0
  556. brevo/sms_templates/types/__init__.py +47 -0
  557. brevo/sms_templates/types/get_sms_templates_request_sort.py +5 -0
  558. brevo/sms_templates/types/get_sms_templates_response.py +26 -0
  559. brevo/sms_templates/types/get_sms_templates_response_templates_item.py +86 -0
  560. brevo/sms_templates/types/get_sms_templates_response_templates_item_compliance.py +37 -0
  561. brevo/tasks/__init__.py +55 -0
  562. brevo/tasks/client.py +814 -0
  563. brevo/tasks/raw_client.py +992 -0
  564. brevo/tasks/types/__init__.py +53 -0
  565. brevo/tasks/types/get_crm_tasks_request_filter_date.py +5 -0
  566. brevo/tasks/types/get_crm_tasks_request_filter_status.py +5 -0
  567. brevo/tasks/types/get_crm_tasks_request_sort.py +5 -0
  568. brevo/tasks/types/get_crm_tasks_response.py +28 -0
  569. brevo/tasks/types/get_crm_tasktypes_response.py +32 -0
  570. brevo/tasks/types/post_crm_tasks_response.py +27 -0
  571. brevo/tier/__init__.py +79 -0
  572. brevo/tier/client.py +1144 -0
  573. brevo/tier/raw_client.py +2360 -0
  574. brevo/tier/types/__init__.py +79 -0
  575. brevo/tier/types/add_subscription_to_tier_response.py +53 -0
  576. brevo/tier/types/create_tier_for_tier_group_request_access_conditions_item.py +31 -0
  577. brevo/tier/types/create_tier_for_tier_group_request_tier_rewards_item.py +26 -0
  578. brevo/tier/types/create_tier_group_request_downgrade_strategy.py +7 -0
  579. brevo/tier/types/create_tier_group_request_upgrade_strategy.py +7 -0
  580. brevo/tier/types/get_list_of_tier_groups_request_version.py +5 -0
  581. brevo/tier/types/get_list_of_tier_groups_response.py +21 -0
  582. brevo/tier/types/get_loyalty_program_tier_request_version.py +5 -0
  583. brevo/tier/types/get_loyalty_program_tier_response.py +21 -0
  584. brevo/tier/types/get_tier_group_request_version.py +5 -0
  585. brevo/tier/types/update_tier_group_request_downgrade_strategy.py +7 -0
  586. brevo/tier/types/update_tier_group_request_upgrade_strategy.py +7 -0
  587. brevo/tier/types/update_tier_request_access_conditions_item.py +31 -0
  588. brevo/tier/types/update_tier_request_tier_rewards_item.py +26 -0
  589. brevo/transactional_emails/__init__.py +175 -0
  590. brevo/transactional_emails/client.py +2544 -0
  591. brevo/transactional_emails/raw_client.py +3240 -0
  592. brevo/transactional_emails/types/__init__.py +189 -0
  593. brevo/transactional_emails/types/create_smtp_template_request_sender.py +37 -0
  594. brevo/transactional_emails/types/create_smtp_template_response.py +23 -0
  595. brevo/transactional_emails/types/get_aggregated_smtp_report_response.py +85 -0
  596. brevo/transactional_emails/types/get_blocked_domains_response.py +23 -0
  597. brevo/transactional_emails/types/get_email_event_report_request_event.py +23 -0
  598. brevo/transactional_emails/types/get_email_event_report_request_sort.py +5 -0
  599. brevo/transactional_emails/types/get_email_event_report_response.py +21 -0
  600. brevo/transactional_emails/types/get_email_event_report_response_events_item.py +79 -0
  601. brevo/transactional_emails/types/get_email_event_report_response_events_item_event.py +23 -0
  602. brevo/transactional_emails/types/get_scheduled_email_by_id_request_sort.py +5 -0
  603. brevo/transactional_emails/types/get_scheduled_email_by_id_request_status.py +5 -0
  604. brevo/transactional_emails/types/get_scheduled_email_by_id_response.py +10 -0
  605. brevo/transactional_emails/types/get_scheduled_email_by_id_response_batches.py +25 -0
  606. brevo/transactional_emails/types/get_scheduled_email_by_id_response_batches_batches_item.py +39 -0
  607. brevo/transactional_emails/types/get_scheduled_email_by_id_response_batches_batches_item_status.py +7 -0
  608. brevo/transactional_emails/types/get_scheduled_email_by_id_response_created_at.py +37 -0
  609. brevo/transactional_emails/types/get_scheduled_email_by_id_response_created_at_status.py +7 -0
  610. brevo/transactional_emails/types/get_smtp_report_request_sort.py +5 -0
  611. brevo/transactional_emails/types/get_smtp_report_response.py +21 -0
  612. brevo/transactional_emails/types/get_smtp_report_response_reports_item.py +86 -0
  613. brevo/transactional_emails/types/get_smtp_templates_request_sort.py +5 -0
  614. brevo/transactional_emails/types/get_smtp_templates_response.py +26 -0
  615. brevo/transactional_emails/types/get_transac_blocked_contacts_request_sort.py +5 -0
  616. brevo/transactional_emails/types/get_transac_blocked_contacts_response.py +25 -0
  617. brevo/transactional_emails/types/get_transac_blocked_contacts_response_contacts_item.py +44 -0
  618. brevo/transactional_emails/types/get_transac_blocked_contacts_response_contacts_item_reason.py +35 -0
  619. brevo/transactional_emails/types/get_transac_blocked_contacts_response_contacts_item_reason_code.py +15 -0
  620. brevo/transactional_emails/types/get_transac_email_content_response.py +57 -0
  621. brevo/transactional_emails/types/get_transac_email_content_response_events_item.py +28 -0
  622. brevo/transactional_emails/types/get_transac_emails_list_request_sort.py +5 -0
  623. brevo/transactional_emails/types/get_transac_emails_list_response.py +34 -0
  624. brevo/transactional_emails/types/get_transac_emails_list_response_transactional_emails_item.py +61 -0
  625. brevo/transactional_emails/types/post_preview_smtp_email_templates_response.py +49 -0
  626. brevo/transactional_emails/types/send_transac_email_request_attachment_item.py +33 -0
  627. brevo/transactional_emails/types/send_transac_email_request_bcc_item.py +28 -0
  628. brevo/transactional_emails/types/send_transac_email_request_cc_item.py +28 -0
  629. brevo/transactional_emails/types/send_transac_email_request_message_versions_item.py +73 -0
  630. brevo/transactional_emails/types/send_transac_email_request_message_versions_item_bcc_item.py +28 -0
  631. brevo/transactional_emails/types/send_transac_email_request_message_versions_item_cc_item.py +28 -0
  632. brevo/transactional_emails/types/send_transac_email_request_message_versions_item_reply_to.py +32 -0
  633. brevo/transactional_emails/types/send_transac_email_request_message_versions_item_to_item.py +28 -0
  634. brevo/transactional_emails/types/send_transac_email_request_reply_to.py +32 -0
  635. brevo/transactional_emails/types/send_transac_email_request_sender.py +37 -0
  636. brevo/transactional_emails/types/send_transac_email_request_to_item.py +28 -0
  637. brevo/transactional_emails/types/send_transac_email_response.py +29 -0
  638. brevo/transactional_emails/types/update_smtp_template_request_sender.py +37 -0
  639. brevo/transactional_sms/__init__.py +70 -0
  640. brevo/transactional_sms/client.py +726 -0
  641. brevo/transactional_sms/raw_client.py +913 -0
  642. brevo/transactional_sms/types/__init__.py +68 -0
  643. brevo/transactional_sms/types/get_sms_events_request_event.py +20 -0
  644. brevo/transactional_sms/types/get_sms_events_request_sort.py +5 -0
  645. brevo/transactional_sms/types/get_sms_events_response.py +21 -0
  646. brevo/transactional_sms/types/get_sms_events_response_events_item.py +52 -0
  647. brevo/transactional_sms/types/get_sms_events_response_events_item_event.py +20 -0
  648. brevo/transactional_sms/types/get_transac_aggregated_sms_report_response.py +75 -0
  649. brevo/transactional_sms/types/get_transac_sms_report_request_sort.py +5 -0
  650. brevo/transactional_sms/types/get_transac_sms_report_response.py +21 -0
  651. brevo/transactional_sms/types/get_transac_sms_report_response_reports_item.py +76 -0
  652. brevo/transactional_sms/types/send_async_transactional_sms_response.py +22 -0
  653. brevo/transactional_sms/types/send_transac_sms_response.py +38 -0
  654. brevo/transactional_whats_app/__init__.py +64 -0
  655. brevo/transactional_whats_app/client.py +283 -0
  656. brevo/transactional_whats_app/raw_client.py +326 -0
  657. brevo/transactional_whats_app/types/__init__.py +62 -0
  658. brevo/transactional_whats_app/types/get_whatsapp_event_report_request_event.py +7 -0
  659. brevo/transactional_whats_app/types/get_whatsapp_event_report_request_sort.py +5 -0
  660. brevo/transactional_whats_app/types/get_whatsapp_event_report_response.py +21 -0
  661. brevo/transactional_whats_app/types/get_whatsapp_event_report_response_events_item.py +65 -0
  662. brevo/transactional_whats_app/types/get_whatsapp_event_report_response_events_item_event.py +7 -0
  663. brevo/transactional_whats_app/types/send_whatsapp_message_request.py +8 -0
  664. brevo/transactional_whats_app/types/send_whatsapp_message_request_params.py +41 -0
  665. brevo/transactional_whats_app/types/send_whatsapp_message_request_text.py +35 -0
  666. brevo/transactional_whats_app/types/send_whatsapp_message_response.py +26 -0
  667. brevo/types/__init__.py +373 -0
  668. brevo/types/ab_test_version_clicks.py +7 -0
  669. brevo/types/ab_test_version_clicks_item.py +35 -0
  670. brevo/types/ab_test_version_stats.py +35 -0
  671. brevo/types/bad_request_error_body.py +29 -0
  672. brevo/types/bad_request_error_body_code.py +45 -0
  673. brevo/types/balance_definition.py +139 -0
  674. brevo/types/balance_definition_balance_availability_duration_modifier.py +7 -0
  675. brevo/types/balance_limit.py +78 -0
  676. brevo/types/cart.py +38 -0
  677. brevo/types/company.py +45 -0
  678. brevo/types/configuration.py +30 -0
  679. brevo/types/contact_error_model.py +34 -0
  680. brevo/types/contact_error_model_code.py +16 -0
  681. brevo/types/conversations_message.py +187 -0
  682. brevo/types/conversations_message_attachments_item.py +50 -0
  683. brevo/types/conversations_message_bcc_item.py +21 -0
  684. brevo/types/conversations_message_cc_item.py +21 -0
  685. brevo/types/conversations_message_file.py +46 -0
  686. brevo/types/conversations_message_file_image_info.py +39 -0
  687. brevo/types/conversations_message_forwarded_to_source_status.py +29 -0
  688. brevo/types/conversations_message_from.py +25 -0
  689. brevo/types/conversations_message_reply_to.py +25 -0
  690. brevo/types/conversations_message_to_item.py +21 -0
  691. brevo/types/conversations_message_type.py +5 -0
  692. brevo/types/conversion_source_metrics.py +35 -0
  693. brevo/types/conversion_source_metrics_conversion_source.py +7 -0
  694. brevo/types/create_update_folder.py +23 -0
  695. brevo/types/deal.py +45 -0
  696. brevo/types/error_model.py +28 -0
  697. brevo/types/file_data.py +60 -0
  698. brevo/types/forbidden_error_body.py +29 -0
  699. brevo/types/forbidden_error_body_code.py +45 -0
  700. brevo/types/get_campaign_recipients.py +25 -0
  701. brevo/types/get_campaign_stats.py +130 -0
  702. brevo/types/get_category_details.py +54 -0
  703. brevo/types/get_contact_details.py +75 -0
  704. brevo/types/get_contact_details_attributes.py +22 -0
  705. brevo/types/get_contacts.py +25 -0
  706. brevo/types/get_coupon_collection.py +75 -0
  707. brevo/types/get_device_browser_stats.py +44 -0
  708. brevo/types/get_extended_campaign_overview.py +230 -0
  709. brevo/types/get_extended_campaign_overview_sender.py +33 -0
  710. brevo/types/get_extended_campaign_overview_status.py +7 -0
  711. brevo/types/get_extended_campaign_overview_type.py +5 -0
  712. brevo/types/get_extended_campaign_stats.py +63 -0
  713. brevo/types/get_extended_campaign_stats_links_stats.py +22 -0
  714. brevo/types/get_extended_campaign_stats_stats_by_device.py +39 -0
  715. brevo/types/get_folder.py +46 -0
  716. brevo/types/get_list.py +46 -0
  717. brevo/types/get_product_details.py +115 -0
  718. brevo/types/get_sms_campaign_overview.py +69 -0
  719. brevo/types/get_sms_campaign_overview_status.py +7 -0
  720. brevo/types/get_sms_campaign_stats.py +55 -0
  721. brevo/types/get_smtp_template_overview.py +93 -0
  722. brevo/types/get_smtp_template_overview_sender.py +33 -0
  723. brevo/types/get_sso_token.py +23 -0
  724. brevo/types/get_webhook.py +74 -0
  725. brevo/types/get_webhook_channel.py +5 -0
  726. brevo/types/get_webhook_type.py +5 -0
  727. brevo/types/inviteuser.py +31 -0
  728. brevo/types/inviteuser_privileges_item.py +34 -0
  729. brevo/types/inviteuser_privileges_item_feature.py +24 -0
  730. brevo/types/inviteuser_privileges_item_permissions_item.py +39 -0
  731. brevo/types/loyalty_program.py +82 -0
  732. brevo/types/loyalty_program_state.py +5 -0
  733. brevo/types/node_response.py +63 -0
  734. brevo/types/not_found_error_body.py +29 -0
  735. brevo/types/not_found_error_body_code.py +45 -0
  736. brevo/types/note.py +61 -0
  737. brevo/types/note_data.py +44 -0
  738. brevo/types/notification.py +32 -0
  739. brevo/types/order.py +85 -0
  740. brevo/types/order_billing.py +66 -0
  741. brevo/types/order_identifiers.py +42 -0
  742. brevo/types/order_meta_info_value.py +5 -0
  743. brevo/types/order_products_item.py +43 -0
  744. brevo/types/pipeline.py +38 -0
  745. brevo/types/pipeline_stages_item.py +32 -0
  746. brevo/types/pipelines.py +7 -0
  747. brevo/types/post_contact_info.py +21 -0
  748. brevo/types/post_contact_info_contacts.py +37 -0
  749. brevo/types/post_contact_info_contacts_failure.py +5 -0
  750. brevo/types/post_contact_info_contacts_success.py +5 -0
  751. brevo/types/post_send_failed.py +46 -0
  752. brevo/types/redeem.py +92 -0
  753. brevo/types/rule_condition_response.py +52 -0
  754. brevo/types/send_report.py +30 -0
  755. brevo/types/send_report_email.py +32 -0
  756. brevo/types/send_report_language.py +5 -0
  757. brevo/types/send_test_email.py +29 -0
  758. brevo/types/send_transac_sms.py +66 -0
  759. brevo/types/send_transac_sms_tag.py +28 -0
  760. brevo/types/send_transac_sms_tag_field.py +5 -0
  761. brevo/types/send_transac_sms_type.py +5 -0
  762. brevo/types/task.py +55 -0
  763. brevo/types/task_reminder.py +39 -0
  764. brevo/types/task_reminder_types_item.py +5 -0
  765. brevo/types/task_reminder_unit.py +5 -0
  766. brevo/types/tier.py +63 -0
  767. brevo/types/tier_access_conditions_item.py +38 -0
  768. brevo/types/tier_group.py +70 -0
  769. brevo/types/tier_group_downgrade_strategy.py +7 -0
  770. brevo/types/tier_group_upgrade_strategy.py +7 -0
  771. brevo/types/tier_tier_rewards_item.py +33 -0
  772. brevo/types/transaction.py +110 -0
  773. brevo/types/unauthorized_error_body.py +29 -0
  774. brevo/types/unauthorized_error_body_code.py +45 -0
  775. brevo/types/update_campaign_status.py +28 -0
  776. brevo/types/update_campaign_status_status.py +8 -0
  777. brevo/types/value_response.py +67 -0
  778. brevo/types/variables_items.py +22 -0
  779. brevo/types/whatsapp_camp_stats.py +26 -0
  780. brevo/user/__init__.py +67 -0
  781. brevo/user/client.py +806 -0
  782. brevo/user/raw_client.py +977 -0
  783. brevo/user/types/__init__.py +67 -0
  784. brevo/user/types/edit_user_permission_response.py +33 -0
  785. brevo/user/types/get_invited_users_list_response.py +24 -0
  786. brevo/user/types/get_invited_users_list_response_users_item.py +39 -0
  787. brevo/user/types/get_invited_users_list_response_users_item_feature_access.py +37 -0
  788. brevo/user/types/get_user_permission_response.py +38 -0
  789. brevo/user/types/get_user_permission_response_privileges_item.py +21 -0
  790. brevo/user/types/inviteuser_response.py +28 -0
  791. brevo/user/types/put_revoke_user_permission_response.py +28 -0
  792. brevo/user/types/putresendcancelinvitation_request_action.py +5 -0
  793. brevo/user/types/putresendcancelinvitation_response.py +28 -0
  794. brevo/version.py +3 -0
  795. brevo/webhooks/__init__.py +82 -0
  796. brevo/webhooks/client.py +982 -0
  797. brevo/webhooks/raw_client.py +1211 -0
  798. brevo/webhooks/types/__init__.py +80 -0
  799. brevo/webhooks/types/create_webhook_request_auth.py +32 -0
  800. brevo/webhooks/types/create_webhook_request_channel.py +5 -0
  801. brevo/webhooks/types/create_webhook_request_events_item.py +26 -0
  802. brevo/webhooks/types/create_webhook_request_headers_item.py +28 -0
  803. brevo/webhooks/types/create_webhook_request_type.py +5 -0
  804. brevo/webhooks/types/create_webhook_response.py +23 -0
  805. brevo/webhooks/types/export_webhooks_history_request_event.py +26 -0
  806. brevo/webhooks/types/export_webhooks_history_request_type.py +5 -0
  807. brevo/webhooks/types/export_webhooks_history_response.py +26 -0
  808. brevo/webhooks/types/get_webhooks_request_sort.py +5 -0
  809. brevo/webhooks/types/get_webhooks_request_type.py +5 -0
  810. brevo/webhooks/types/get_webhooks_response.py +21 -0
  811. brevo/webhooks/types/update_webhook_request_auth.py +32 -0
  812. brevo/webhooks/types/update_webhook_request_events_item.py +26 -0
  813. brevo/webhooks/types/update_webhook_request_headers_item.py +28 -0
  814. brevo/whats_app_campaigns/__init__.py +106 -0
  815. brevo/whats_app_campaigns/client.py +1064 -0
  816. brevo/whats_app_campaigns/raw_client.py +1311 -0
  817. brevo/whats_app_campaigns/types/__init__.py +110 -0
  818. brevo/whats_app_campaigns/types/create_whats_app_campaign_request_recipients.py +41 -0
  819. brevo/whats_app_campaigns/types/create_whats_app_campaign_response.py +23 -0
  820. brevo/whats_app_campaigns/types/create_whats_app_template_request_category.py +5 -0
  821. brevo/whats_app_campaigns/types/create_whats_app_template_request_source.py +5 -0
  822. brevo/whats_app_campaigns/types/create_whats_app_template_response.py +23 -0
  823. brevo/whats_app_campaigns/types/get_whats_app_campaign_response.py +69 -0
  824. brevo/whats_app_campaigns/types/get_whats_app_campaign_response_campaign_status.py +7 -0
  825. brevo/whats_app_campaigns/types/get_whats_app_campaign_response_template.py +61 -0
  826. brevo/whats_app_campaigns/types/get_whats_app_campaign_response_template_components_item.py +21 -0
  827. brevo/whats_app_campaigns/types/get_whats_app_campaigns_request_sort.py +5 -0
  828. brevo/whats_app_campaigns/types/get_whats_app_campaigns_response.py +25 -0
  829. brevo/whats_app_campaigns/types/get_whats_app_campaigns_response_campaigns_item.py +84 -0
  830. brevo/whats_app_campaigns/types/get_whats_app_campaigns_response_campaigns_item_campaign_status.py +7 -0
  831. brevo/whats_app_campaigns/types/get_whats_app_config_response.py +63 -0
  832. brevo/whats_app_campaigns/types/get_whats_app_config_response_phone_number_name_status.py +7 -0
  833. brevo/whats_app_campaigns/types/get_whats_app_config_response_phone_number_quality.py +5 -0
  834. brevo/whats_app_campaigns/types/get_whats_app_config_response_whatsapp_business_account_status.py +7 -0
  835. brevo/whats_app_campaigns/types/get_whats_app_templates_request_sort.py +5 -0
  836. brevo/whats_app_campaigns/types/get_whats_app_templates_request_source.py +5 -0
  837. brevo/whats_app_campaigns/types/get_whats_app_templates_response.py +26 -0
  838. brevo/whats_app_campaigns/types/get_whats_app_templates_response_templates_item.py +65 -0
  839. brevo/whats_app_campaigns/types/update_whats_app_campaign_request_campaign_status.py +5 -0
  840. brevo/whats_app_campaigns/types/update_whats_app_campaign_request_recipients.py +41 -0
  841. brevo_python-4.0.1.dist-info/METADATA +1072 -0
  842. brevo_python-4.0.1.dist-info/RECORD +843 -0
  843. brevo_python-4.0.1.dist-info/WHEEL +4 -0
@@ -0,0 +1,982 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
6
+ from ..core.request_options import RequestOptions
7
+ from ..types.get_webhook import GetWebhook
8
+ from .raw_client import AsyncRawWebhooksClient, RawWebhooksClient
9
+ from .types.create_webhook_request_auth import CreateWebhookRequestAuth
10
+ from .types.create_webhook_request_channel import CreateWebhookRequestChannel
11
+ from .types.create_webhook_request_events_item import CreateWebhookRequestEventsItem
12
+ from .types.create_webhook_request_headers_item import CreateWebhookRequestHeadersItem
13
+ from .types.create_webhook_request_type import CreateWebhookRequestType
14
+ from .types.create_webhook_response import CreateWebhookResponse
15
+ from .types.export_webhooks_history_request_event import ExportWebhooksHistoryRequestEvent
16
+ from .types.export_webhooks_history_request_type import ExportWebhooksHistoryRequestType
17
+ from .types.export_webhooks_history_response import ExportWebhooksHistoryResponse
18
+ from .types.get_webhooks_request_sort import GetWebhooksRequestSort
19
+ from .types.get_webhooks_request_type import GetWebhooksRequestType
20
+ from .types.get_webhooks_response import GetWebhooksResponse
21
+ from .types.update_webhook_request_auth import UpdateWebhookRequestAuth
22
+ from .types.update_webhook_request_events_item import UpdateWebhookRequestEventsItem
23
+ from .types.update_webhook_request_headers_item import UpdateWebhookRequestHeadersItem
24
+
25
+ # this is used as the default value for optional parameters
26
+ OMIT = typing.cast(typing.Any, ...)
27
+
28
+
29
+ class WebhooksClient:
30
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
31
+ self._raw_client = RawWebhooksClient(client_wrapper=client_wrapper)
32
+
33
+ @property
34
+ def with_raw_response(self) -> RawWebhooksClient:
35
+ """
36
+ Retrieves a raw implementation of this client that returns raw responses.
37
+
38
+ Returns
39
+ -------
40
+ RawWebhooksClient
41
+ """
42
+ return self._raw_client
43
+
44
+ def get_webhooks(
45
+ self,
46
+ *,
47
+ type: typing.Optional[GetWebhooksRequestType] = None,
48
+ sort: typing.Optional[GetWebhooksRequestSort] = None,
49
+ request_options: typing.Optional[RequestOptions] = None,
50
+ ) -> GetWebhooksResponse:
51
+ """
52
+ Retrieves all webhooks from your Brevo account with filtering and sorting options.
53
+
54
+ Use this to:
55
+ - Monitor webhook configurations and event handling
56
+ - List webhooks by type (transactional, marketing, inbound)
57
+ - Review webhook endpoints and authentication
58
+ - Track webhook creation and modification history
59
+ - Audit webhook event subscriptions
60
+
61
+ Key information returned:
62
+ - Complete webhook details and configuration
63
+ - Event types and channel subscriptions
64
+ - Authentication and security settings
65
+ - Webhook URLs and custom headers
66
+ - Creation and modification timestamps
67
+
68
+ Parameters
69
+ ----------
70
+ type : typing.Optional[GetWebhooksRequestType]
71
+ Filter on webhook type
72
+
73
+ sort : typing.Optional[GetWebhooksRequestSort]
74
+ Sort the results in the ascending/descending order of webhook creation
75
+
76
+ request_options : typing.Optional[RequestOptions]
77
+ Request-specific configuration.
78
+
79
+ Returns
80
+ -------
81
+ GetWebhooksResponse
82
+ Webhooks informations
83
+
84
+ Examples
85
+ --------
86
+ from brevo import Brevo
87
+
88
+ client = Brevo(
89
+ api_key="YOUR_API_KEY",
90
+ )
91
+ client.webhooks.get_webhooks()
92
+ """
93
+ _response = self._raw_client.get_webhooks(type=type, sort=sort, request_options=request_options)
94
+ return _response.data
95
+
96
+ def create_webhook(
97
+ self,
98
+ *,
99
+ events: typing.Sequence[CreateWebhookRequestEventsItem],
100
+ url: str,
101
+ auth: typing.Optional[CreateWebhookRequestAuth] = OMIT,
102
+ batched: typing.Optional[bool] = OMIT,
103
+ channel: typing.Optional[CreateWebhookRequestChannel] = OMIT,
104
+ description: typing.Optional[str] = OMIT,
105
+ domain: typing.Optional[str] = OMIT,
106
+ headers: typing.Optional[typing.Sequence[CreateWebhookRequestHeadersItem]] = OMIT,
107
+ type: typing.Optional[CreateWebhookRequestType] = OMIT,
108
+ request_options: typing.Optional[RequestOptions] = None,
109
+ ) -> CreateWebhookResponse:
110
+ """
111
+ Creates a new webhook to receive real-time notifications for specified events.
112
+
113
+ Use this to:
114
+ - Set up event notifications for transactional or marketing emails
115
+ - Configure webhook endpoints for campaign tracking
116
+ - Enable real-time monitoring of email delivery status
117
+ - Subscribe to contact list changes and updates
118
+ - Implement custom event handling and automation
119
+
120
+ Key information returned:
121
+ - Created webhook ID and configuration
122
+ - Success confirmation and setup details
123
+
124
+ Parameters
125
+ ----------
126
+ events : typing.Sequence[CreateWebhookRequestEventsItem]
127
+ - Events triggering the webhook. Possible values for
128
+ **Transactional** type webhook: #### `sent` OR `request`,
129
+ `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
130
+ `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
131
+ `unsubscribed` - Possible values for **Marketing** type webhook:
132
+ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
133
+ `unsubscribed`, `listAddition` & `delivered` - Possible values
134
+ for **Inbound** type webhook: #### `inboundEmailProcessed` -
135
+ Possible values for type **Transactional** and channel **SMS**
136
+ ####
137
+ `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
138
+ `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for
139
+ type **Marketing** channel **SMS** ####
140
+ `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
141
+ `subscribe`,`skip`
142
+
143
+ url : str
144
+ URL of the webhook
145
+
146
+ auth : typing.Optional[CreateWebhookRequestAuth]
147
+ Add authentication on webhook url
148
+
149
+ batched : typing.Optional[bool]
150
+ To send batched webhooks
151
+
152
+ channel : typing.Optional[CreateWebhookRequestChannel]
153
+ channel of webhook
154
+
155
+ description : typing.Optional[str]
156
+ Description of the webhook
157
+
158
+ domain : typing.Optional[str]
159
+ Inbound domain of webhook, required in case of event type
160
+ `inbound`
161
+
162
+ headers : typing.Optional[typing.Sequence[CreateWebhookRequestHeadersItem]]
163
+ Custom headers to be send with webhooks
164
+
165
+ type : typing.Optional[CreateWebhookRequestType]
166
+ Type of the webhook
167
+
168
+ request_options : typing.Optional[RequestOptions]
169
+ Request-specific configuration.
170
+
171
+ Returns
172
+ -------
173
+ CreateWebhookResponse
174
+ successfully created
175
+
176
+ Examples
177
+ --------
178
+ from brevo import Brevo
179
+
180
+ client = Brevo(
181
+ api_key="YOUR_API_KEY",
182
+ )
183
+ client.webhooks.create_webhook(
184
+ events=["sent"],
185
+ url="http://requestb.in/173lyyx1",
186
+ )
187
+ """
188
+ _response = self._raw_client.create_webhook(
189
+ events=events,
190
+ url=url,
191
+ auth=auth,
192
+ batched=batched,
193
+ channel=channel,
194
+ description=description,
195
+ domain=domain,
196
+ headers=headers,
197
+ type=type,
198
+ request_options=request_options,
199
+ )
200
+ return _response.data
201
+
202
+ def export_webhooks_history(
203
+ self,
204
+ *,
205
+ event: ExportWebhooksHistoryRequestEvent,
206
+ notify_url: str,
207
+ type: ExportWebhooksHistoryRequestType,
208
+ days: typing.Optional[int] = OMIT,
209
+ email: typing.Optional[str] = OMIT,
210
+ end_date: typing.Optional[str] = OMIT,
211
+ message_id: typing.Optional[int] = OMIT,
212
+ sort: typing.Optional[str] = OMIT,
213
+ start_date: typing.Optional[str] = OMIT,
214
+ webhook_id: typing.Optional[int] = OMIT,
215
+ request_options: typing.Optional[RequestOptions] = None,
216
+ ) -> ExportWebhooksHistoryResponse:
217
+ """
218
+ <Note title="This feature is available for Professional and Enterprise plans">
219
+ To have it activated please send us a request and we will activate it for your account.
220
+ </Note>
221
+
222
+ Exports webhook event history to CSV format for analysis and reporting.
223
+
224
+ Use this to:
225
+ - Generate comprehensive webhook event reports
226
+ - Analyze webhook delivery patterns and success rates
227
+ - Export event data for external analysis tools
228
+ - Create historical reports for compliance and auditing
229
+ - Track webhook performance and reliability metrics
230
+
231
+ Key information returned:
232
+ - Process ID for tracking export completion
233
+ - CSV file will be delivered to specified webhook URL
234
+
235
+ Parameters
236
+ ----------
237
+ event : ExportWebhooksHistoryRequestEvent
238
+ Filter the history for a specific event type
239
+
240
+ notify_url : str
241
+ Webhook URL to receive CSV file link
242
+
243
+ type : ExportWebhooksHistoryRequestType
244
+ Filter the history based on webhook type
245
+
246
+ days : typing.Optional[int]
247
+ Number of days in the past including today (positive
248
+ integer). _Not compatible with 'startDate' and 'endDate'_
249
+
250
+ email : typing.Optional[str]
251
+ Filter the history for a specific email
252
+
253
+ end_date : typing.Optional[str]
254
+ Mandatory if startDate is used. Ending date of the report
255
+ (YYYY-MM-DD). Must be greater than equal to startDate
256
+
257
+ message_id : typing.Optional[int]
258
+ Filter the history for a specific message id. Applicable
259
+ only for transactional webhooks.
260
+
261
+ sort : typing.Optional[str]
262
+ Sorting order of records (asc or desc)
263
+
264
+ start_date : typing.Optional[str]
265
+ Mandatory if endDate is used. Starting date of the history
266
+ (YYYY-MM-DD). Must be lower than equal to endDate
267
+
268
+ webhook_id : typing.Optional[int]
269
+ Filter the history for a specific webhook id
270
+
271
+ request_options : typing.Optional[RequestOptions]
272
+ Request-specific configuration.
273
+
274
+ Returns
275
+ -------
276
+ ExportWebhooksHistoryResponse
277
+ process id created
278
+
279
+ Examples
280
+ --------
281
+ from brevo import Brevo
282
+
283
+ client = Brevo(
284
+ api_key="YOUR_API_KEY",
285
+ )
286
+ client.webhooks.export_webhooks_history(
287
+ event="invalid_parameter",
288
+ notify_url="https://brevo.com",
289
+ type="transactional",
290
+ )
291
+ """
292
+ _response = self._raw_client.export_webhooks_history(
293
+ event=event,
294
+ notify_url=notify_url,
295
+ type=type,
296
+ days=days,
297
+ email=email,
298
+ end_date=end_date,
299
+ message_id=message_id,
300
+ sort=sort,
301
+ start_date=start_date,
302
+ webhook_id=webhook_id,
303
+ request_options=request_options,
304
+ )
305
+ return _response.data
306
+
307
+ def get_webhook(self, webhook_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GetWebhook:
308
+ """
309
+ Retrieves detailed information about a specific webhook configuration.
310
+
311
+ Use this to:
312
+ - Get complete webhook configuration and settings
313
+ - Check webhook event subscriptions and triggers
314
+ - Review authentication and security settings
315
+ - Verify webhook URL and custom headers
316
+ - Access webhook creation and modification history
317
+
318
+ Key information returned:
319
+ - Complete webhook details and configuration
320
+ - Event types and channel subscriptions
321
+ - Authentication credentials and methods
322
+ - Custom headers and request settings
323
+ - Webhook status and activity information
324
+
325
+ Parameters
326
+ ----------
327
+ webhook_id : int
328
+ Id of the webhook
329
+
330
+ request_options : typing.Optional[RequestOptions]
331
+ Request-specific configuration.
332
+
333
+ Returns
334
+ -------
335
+ GetWebhook
336
+ Webhook informations
337
+
338
+ Examples
339
+ --------
340
+ from brevo import Brevo
341
+
342
+ client = Brevo(
343
+ api_key="YOUR_API_KEY",
344
+ )
345
+ client.webhooks.get_webhook(
346
+ webhook_id=1000000,
347
+ )
348
+ """
349
+ _response = self._raw_client.get_webhook(webhook_id, request_options=request_options)
350
+ return _response.data
351
+
352
+ def update_webhook(
353
+ self,
354
+ webhook_id: int,
355
+ *,
356
+ auth: typing.Optional[UpdateWebhookRequestAuth] = OMIT,
357
+ batched: typing.Optional[bool] = OMIT,
358
+ description: typing.Optional[str] = OMIT,
359
+ domain: typing.Optional[str] = OMIT,
360
+ events: typing.Optional[typing.Sequence[UpdateWebhookRequestEventsItem]] = OMIT,
361
+ headers: typing.Optional[typing.Sequence[UpdateWebhookRequestHeadersItem]] = OMIT,
362
+ url: typing.Optional[str] = OMIT,
363
+ request_options: typing.Optional[RequestOptions] = None,
364
+ ) -> None:
365
+ """
366
+ Updates an existing webhook configuration and event subscriptions.
367
+
368
+ Use this to:
369
+ - Modify webhook event subscriptions and triggers
370
+ - Update webhook URL and endpoint configuration
371
+ - Change authentication settings and credentials
372
+ - Adjust custom headers and request parameters
373
+ - Enable or disable specific webhook events
374
+
375
+ Key information returned:
376
+ - Success confirmation of webhook updates
377
+
378
+ Parameters
379
+ ----------
380
+ webhook_id : int
381
+ Id of the webhook
382
+
383
+ auth : typing.Optional[UpdateWebhookRequestAuth]
384
+ Add authentication on webhook url
385
+
386
+ batched : typing.Optional[bool]
387
+ To send batched webhooks
388
+
389
+ description : typing.Optional[str]
390
+ Description of the webhook
391
+
392
+ domain : typing.Optional[str]
393
+ Inbound domain of webhook, used in case of event type `inbound`
394
+
395
+ events : typing.Optional[typing.Sequence[UpdateWebhookRequestEventsItem]]
396
+ - Events triggering the webhook. Possible values for
397
+ **Transactional** type webhook: #### `sent` OR `request`,
398
+ `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
399
+ `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
400
+ `unsubscribed` - Possible values for **Marketing** type webhook:
401
+ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
402
+ `unsubscribed`, `listAddition` & `delivered` - Possible values
403
+ for **Inbound** type webhook: #### `inboundEmailProcessed`
404
+
405
+ headers : typing.Optional[typing.Sequence[UpdateWebhookRequestHeadersItem]]
406
+ Custom headers to be send with webhooks
407
+
408
+ url : typing.Optional[str]
409
+ URL of the webhook
410
+
411
+ request_options : typing.Optional[RequestOptions]
412
+ Request-specific configuration.
413
+
414
+ Returns
415
+ -------
416
+ None
417
+
418
+ Examples
419
+ --------
420
+ from brevo import Brevo
421
+
422
+ client = Brevo(
423
+ api_key="YOUR_API_KEY",
424
+ )
425
+ client.webhooks.update_webhook(
426
+ webhook_id=1000000,
427
+ )
428
+ """
429
+ _response = self._raw_client.update_webhook(
430
+ webhook_id,
431
+ auth=auth,
432
+ batched=batched,
433
+ description=description,
434
+ domain=domain,
435
+ events=events,
436
+ headers=headers,
437
+ url=url,
438
+ request_options=request_options,
439
+ )
440
+ return _response.data
441
+
442
+ def delete_webhook(self, webhook_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
443
+ """
444
+ Permanently deletes a webhook and stops all event notifications.
445
+
446
+ Use this to:
447
+ - Remove unused or obsolete webhook configurations
448
+ - Clean up webhook endpoints and subscriptions
449
+ - Stop event notifications to specific URLs
450
+ - Maintain organized webhook management
451
+
452
+ Key information returned:
453
+ - Success confirmation of webhook deletion
454
+
455
+ Parameters
456
+ ----------
457
+ webhook_id : int
458
+ Id of the webhook
459
+
460
+ request_options : typing.Optional[RequestOptions]
461
+ Request-specific configuration.
462
+
463
+ Returns
464
+ -------
465
+ None
466
+
467
+ Examples
468
+ --------
469
+ from brevo import Brevo
470
+
471
+ client = Brevo(
472
+ api_key="YOUR_API_KEY",
473
+ )
474
+ client.webhooks.delete_webhook(
475
+ webhook_id=1000000,
476
+ )
477
+ """
478
+ _response = self._raw_client.delete_webhook(webhook_id, request_options=request_options)
479
+ return _response.data
480
+
481
+
482
+ class AsyncWebhooksClient:
483
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
484
+ self._raw_client = AsyncRawWebhooksClient(client_wrapper=client_wrapper)
485
+
486
+ @property
487
+ def with_raw_response(self) -> AsyncRawWebhooksClient:
488
+ """
489
+ Retrieves a raw implementation of this client that returns raw responses.
490
+
491
+ Returns
492
+ -------
493
+ AsyncRawWebhooksClient
494
+ """
495
+ return self._raw_client
496
+
497
+ async def get_webhooks(
498
+ self,
499
+ *,
500
+ type: typing.Optional[GetWebhooksRequestType] = None,
501
+ sort: typing.Optional[GetWebhooksRequestSort] = None,
502
+ request_options: typing.Optional[RequestOptions] = None,
503
+ ) -> GetWebhooksResponse:
504
+ """
505
+ Retrieves all webhooks from your Brevo account with filtering and sorting options.
506
+
507
+ Use this to:
508
+ - Monitor webhook configurations and event handling
509
+ - List webhooks by type (transactional, marketing, inbound)
510
+ - Review webhook endpoints and authentication
511
+ - Track webhook creation and modification history
512
+ - Audit webhook event subscriptions
513
+
514
+ Key information returned:
515
+ - Complete webhook details and configuration
516
+ - Event types and channel subscriptions
517
+ - Authentication and security settings
518
+ - Webhook URLs and custom headers
519
+ - Creation and modification timestamps
520
+
521
+ Parameters
522
+ ----------
523
+ type : typing.Optional[GetWebhooksRequestType]
524
+ Filter on webhook type
525
+
526
+ sort : typing.Optional[GetWebhooksRequestSort]
527
+ Sort the results in the ascending/descending order of webhook creation
528
+
529
+ request_options : typing.Optional[RequestOptions]
530
+ Request-specific configuration.
531
+
532
+ Returns
533
+ -------
534
+ GetWebhooksResponse
535
+ Webhooks informations
536
+
537
+ Examples
538
+ --------
539
+ import asyncio
540
+
541
+ from brevo import AsyncBrevo
542
+
543
+ client = AsyncBrevo(
544
+ api_key="YOUR_API_KEY",
545
+ )
546
+
547
+
548
+ async def main() -> None:
549
+ await client.webhooks.get_webhooks()
550
+
551
+
552
+ asyncio.run(main())
553
+ """
554
+ _response = await self._raw_client.get_webhooks(type=type, sort=sort, request_options=request_options)
555
+ return _response.data
556
+
557
+ async def create_webhook(
558
+ self,
559
+ *,
560
+ events: typing.Sequence[CreateWebhookRequestEventsItem],
561
+ url: str,
562
+ auth: typing.Optional[CreateWebhookRequestAuth] = OMIT,
563
+ batched: typing.Optional[bool] = OMIT,
564
+ channel: typing.Optional[CreateWebhookRequestChannel] = OMIT,
565
+ description: typing.Optional[str] = OMIT,
566
+ domain: typing.Optional[str] = OMIT,
567
+ headers: typing.Optional[typing.Sequence[CreateWebhookRequestHeadersItem]] = OMIT,
568
+ type: typing.Optional[CreateWebhookRequestType] = OMIT,
569
+ request_options: typing.Optional[RequestOptions] = None,
570
+ ) -> CreateWebhookResponse:
571
+ """
572
+ Creates a new webhook to receive real-time notifications for specified events.
573
+
574
+ Use this to:
575
+ - Set up event notifications for transactional or marketing emails
576
+ - Configure webhook endpoints for campaign tracking
577
+ - Enable real-time monitoring of email delivery status
578
+ - Subscribe to contact list changes and updates
579
+ - Implement custom event handling and automation
580
+
581
+ Key information returned:
582
+ - Created webhook ID and configuration
583
+ - Success confirmation and setup details
584
+
585
+ Parameters
586
+ ----------
587
+ events : typing.Sequence[CreateWebhookRequestEventsItem]
588
+ - Events triggering the webhook. Possible values for
589
+ **Transactional** type webhook: #### `sent` OR `request`,
590
+ `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
591
+ `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
592
+ `unsubscribed` - Possible values for **Marketing** type webhook:
593
+ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
594
+ `unsubscribed`, `listAddition` & `delivered` - Possible values
595
+ for **Inbound** type webhook: #### `inboundEmailProcessed` -
596
+ Possible values for type **Transactional** and channel **SMS**
597
+ ####
598
+ `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
599
+ `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for
600
+ type **Marketing** channel **SMS** ####
601
+ `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
602
+ `subscribe`,`skip`
603
+
604
+ url : str
605
+ URL of the webhook
606
+
607
+ auth : typing.Optional[CreateWebhookRequestAuth]
608
+ Add authentication on webhook url
609
+
610
+ batched : typing.Optional[bool]
611
+ To send batched webhooks
612
+
613
+ channel : typing.Optional[CreateWebhookRequestChannel]
614
+ channel of webhook
615
+
616
+ description : typing.Optional[str]
617
+ Description of the webhook
618
+
619
+ domain : typing.Optional[str]
620
+ Inbound domain of webhook, required in case of event type
621
+ `inbound`
622
+
623
+ headers : typing.Optional[typing.Sequence[CreateWebhookRequestHeadersItem]]
624
+ Custom headers to be send with webhooks
625
+
626
+ type : typing.Optional[CreateWebhookRequestType]
627
+ Type of the webhook
628
+
629
+ request_options : typing.Optional[RequestOptions]
630
+ Request-specific configuration.
631
+
632
+ Returns
633
+ -------
634
+ CreateWebhookResponse
635
+ successfully created
636
+
637
+ Examples
638
+ --------
639
+ import asyncio
640
+
641
+ from brevo import AsyncBrevo
642
+
643
+ client = AsyncBrevo(
644
+ api_key="YOUR_API_KEY",
645
+ )
646
+
647
+
648
+ async def main() -> None:
649
+ await client.webhooks.create_webhook(
650
+ events=["sent"],
651
+ url="http://requestb.in/173lyyx1",
652
+ )
653
+
654
+
655
+ asyncio.run(main())
656
+ """
657
+ _response = await self._raw_client.create_webhook(
658
+ events=events,
659
+ url=url,
660
+ auth=auth,
661
+ batched=batched,
662
+ channel=channel,
663
+ description=description,
664
+ domain=domain,
665
+ headers=headers,
666
+ type=type,
667
+ request_options=request_options,
668
+ )
669
+ return _response.data
670
+
671
+ async def export_webhooks_history(
672
+ self,
673
+ *,
674
+ event: ExportWebhooksHistoryRequestEvent,
675
+ notify_url: str,
676
+ type: ExportWebhooksHistoryRequestType,
677
+ days: typing.Optional[int] = OMIT,
678
+ email: typing.Optional[str] = OMIT,
679
+ end_date: typing.Optional[str] = OMIT,
680
+ message_id: typing.Optional[int] = OMIT,
681
+ sort: typing.Optional[str] = OMIT,
682
+ start_date: typing.Optional[str] = OMIT,
683
+ webhook_id: typing.Optional[int] = OMIT,
684
+ request_options: typing.Optional[RequestOptions] = None,
685
+ ) -> ExportWebhooksHistoryResponse:
686
+ """
687
+ <Note title="This feature is available for Professional and Enterprise plans">
688
+ To have it activated please send us a request and we will activate it for your account.
689
+ </Note>
690
+
691
+ Exports webhook event history to CSV format for analysis and reporting.
692
+
693
+ Use this to:
694
+ - Generate comprehensive webhook event reports
695
+ - Analyze webhook delivery patterns and success rates
696
+ - Export event data for external analysis tools
697
+ - Create historical reports for compliance and auditing
698
+ - Track webhook performance and reliability metrics
699
+
700
+ Key information returned:
701
+ - Process ID for tracking export completion
702
+ - CSV file will be delivered to specified webhook URL
703
+
704
+ Parameters
705
+ ----------
706
+ event : ExportWebhooksHistoryRequestEvent
707
+ Filter the history for a specific event type
708
+
709
+ notify_url : str
710
+ Webhook URL to receive CSV file link
711
+
712
+ type : ExportWebhooksHistoryRequestType
713
+ Filter the history based on webhook type
714
+
715
+ days : typing.Optional[int]
716
+ Number of days in the past including today (positive
717
+ integer). _Not compatible with 'startDate' and 'endDate'_
718
+
719
+ email : typing.Optional[str]
720
+ Filter the history for a specific email
721
+
722
+ end_date : typing.Optional[str]
723
+ Mandatory if startDate is used. Ending date of the report
724
+ (YYYY-MM-DD). Must be greater than equal to startDate
725
+
726
+ message_id : typing.Optional[int]
727
+ Filter the history for a specific message id. Applicable
728
+ only for transactional webhooks.
729
+
730
+ sort : typing.Optional[str]
731
+ Sorting order of records (asc or desc)
732
+
733
+ start_date : typing.Optional[str]
734
+ Mandatory if endDate is used. Starting date of the history
735
+ (YYYY-MM-DD). Must be lower than equal to endDate
736
+
737
+ webhook_id : typing.Optional[int]
738
+ Filter the history for a specific webhook id
739
+
740
+ request_options : typing.Optional[RequestOptions]
741
+ Request-specific configuration.
742
+
743
+ Returns
744
+ -------
745
+ ExportWebhooksHistoryResponse
746
+ process id created
747
+
748
+ Examples
749
+ --------
750
+ import asyncio
751
+
752
+ from brevo import AsyncBrevo
753
+
754
+ client = AsyncBrevo(
755
+ api_key="YOUR_API_KEY",
756
+ )
757
+
758
+
759
+ async def main() -> None:
760
+ await client.webhooks.export_webhooks_history(
761
+ event="invalid_parameter",
762
+ notify_url="https://brevo.com",
763
+ type="transactional",
764
+ )
765
+
766
+
767
+ asyncio.run(main())
768
+ """
769
+ _response = await self._raw_client.export_webhooks_history(
770
+ event=event,
771
+ notify_url=notify_url,
772
+ type=type,
773
+ days=days,
774
+ email=email,
775
+ end_date=end_date,
776
+ message_id=message_id,
777
+ sort=sort,
778
+ start_date=start_date,
779
+ webhook_id=webhook_id,
780
+ request_options=request_options,
781
+ )
782
+ return _response.data
783
+
784
+ async def get_webhook(
785
+ self, webhook_id: int, *, request_options: typing.Optional[RequestOptions] = None
786
+ ) -> GetWebhook:
787
+ """
788
+ Retrieves detailed information about a specific webhook configuration.
789
+
790
+ Use this to:
791
+ - Get complete webhook configuration and settings
792
+ - Check webhook event subscriptions and triggers
793
+ - Review authentication and security settings
794
+ - Verify webhook URL and custom headers
795
+ - Access webhook creation and modification history
796
+
797
+ Key information returned:
798
+ - Complete webhook details and configuration
799
+ - Event types and channel subscriptions
800
+ - Authentication credentials and methods
801
+ - Custom headers and request settings
802
+ - Webhook status and activity information
803
+
804
+ Parameters
805
+ ----------
806
+ webhook_id : int
807
+ Id of the webhook
808
+
809
+ request_options : typing.Optional[RequestOptions]
810
+ Request-specific configuration.
811
+
812
+ Returns
813
+ -------
814
+ GetWebhook
815
+ Webhook informations
816
+
817
+ Examples
818
+ --------
819
+ import asyncio
820
+
821
+ from brevo import AsyncBrevo
822
+
823
+ client = AsyncBrevo(
824
+ api_key="YOUR_API_KEY",
825
+ )
826
+
827
+
828
+ async def main() -> None:
829
+ await client.webhooks.get_webhook(
830
+ webhook_id=1000000,
831
+ )
832
+
833
+
834
+ asyncio.run(main())
835
+ """
836
+ _response = await self._raw_client.get_webhook(webhook_id, request_options=request_options)
837
+ return _response.data
838
+
839
+ async def update_webhook(
840
+ self,
841
+ webhook_id: int,
842
+ *,
843
+ auth: typing.Optional[UpdateWebhookRequestAuth] = OMIT,
844
+ batched: typing.Optional[bool] = OMIT,
845
+ description: typing.Optional[str] = OMIT,
846
+ domain: typing.Optional[str] = OMIT,
847
+ events: typing.Optional[typing.Sequence[UpdateWebhookRequestEventsItem]] = OMIT,
848
+ headers: typing.Optional[typing.Sequence[UpdateWebhookRequestHeadersItem]] = OMIT,
849
+ url: typing.Optional[str] = OMIT,
850
+ request_options: typing.Optional[RequestOptions] = None,
851
+ ) -> None:
852
+ """
853
+ Updates an existing webhook configuration and event subscriptions.
854
+
855
+ Use this to:
856
+ - Modify webhook event subscriptions and triggers
857
+ - Update webhook URL and endpoint configuration
858
+ - Change authentication settings and credentials
859
+ - Adjust custom headers and request parameters
860
+ - Enable or disable specific webhook events
861
+
862
+ Key information returned:
863
+ - Success confirmation of webhook updates
864
+
865
+ Parameters
866
+ ----------
867
+ webhook_id : int
868
+ Id of the webhook
869
+
870
+ auth : typing.Optional[UpdateWebhookRequestAuth]
871
+ Add authentication on webhook url
872
+
873
+ batched : typing.Optional[bool]
874
+ To send batched webhooks
875
+
876
+ description : typing.Optional[str]
877
+ Description of the webhook
878
+
879
+ domain : typing.Optional[str]
880
+ Inbound domain of webhook, used in case of event type `inbound`
881
+
882
+ events : typing.Optional[typing.Sequence[UpdateWebhookRequestEventsItem]]
883
+ - Events triggering the webhook. Possible values for
884
+ **Transactional** type webhook: #### `sent` OR `request`,
885
+ `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
886
+ `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
887
+ `unsubscribed` - Possible values for **Marketing** type webhook:
888
+ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
889
+ `unsubscribed`, `listAddition` & `delivered` - Possible values
890
+ for **Inbound** type webhook: #### `inboundEmailProcessed`
891
+
892
+ headers : typing.Optional[typing.Sequence[UpdateWebhookRequestHeadersItem]]
893
+ Custom headers to be send with webhooks
894
+
895
+ url : typing.Optional[str]
896
+ URL of the webhook
897
+
898
+ request_options : typing.Optional[RequestOptions]
899
+ Request-specific configuration.
900
+
901
+ Returns
902
+ -------
903
+ None
904
+
905
+ Examples
906
+ --------
907
+ import asyncio
908
+
909
+ from brevo import AsyncBrevo
910
+
911
+ client = AsyncBrevo(
912
+ api_key="YOUR_API_KEY",
913
+ )
914
+
915
+
916
+ async def main() -> None:
917
+ await client.webhooks.update_webhook(
918
+ webhook_id=1000000,
919
+ )
920
+
921
+
922
+ asyncio.run(main())
923
+ """
924
+ _response = await self._raw_client.update_webhook(
925
+ webhook_id,
926
+ auth=auth,
927
+ batched=batched,
928
+ description=description,
929
+ domain=domain,
930
+ events=events,
931
+ headers=headers,
932
+ url=url,
933
+ request_options=request_options,
934
+ )
935
+ return _response.data
936
+
937
+ async def delete_webhook(self, webhook_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
938
+ """
939
+ Permanently deletes a webhook and stops all event notifications.
940
+
941
+ Use this to:
942
+ - Remove unused or obsolete webhook configurations
943
+ - Clean up webhook endpoints and subscriptions
944
+ - Stop event notifications to specific URLs
945
+ - Maintain organized webhook management
946
+
947
+ Key information returned:
948
+ - Success confirmation of webhook deletion
949
+
950
+ Parameters
951
+ ----------
952
+ webhook_id : int
953
+ Id of the webhook
954
+
955
+ request_options : typing.Optional[RequestOptions]
956
+ Request-specific configuration.
957
+
958
+ Returns
959
+ -------
960
+ None
961
+
962
+ Examples
963
+ --------
964
+ import asyncio
965
+
966
+ from brevo import AsyncBrevo
967
+
968
+ client = AsyncBrevo(
969
+ api_key="YOUR_API_KEY",
970
+ )
971
+
972
+
973
+ async def main() -> None:
974
+ await client.webhooks.delete_webhook(
975
+ webhook_id=1000000,
976
+ )
977
+
978
+
979
+ asyncio.run(main())
980
+ """
981
+ _response = await self._raw_client.delete_webhook(webhook_id, request_options=request_options)
982
+ return _response.data