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,1078 @@
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.send_report_email import SendReportEmail
8
+ from ..types.send_report_language import SendReportLanguage
9
+ from ..types.update_campaign_status_status import UpdateCampaignStatusStatus
10
+ from .raw_client import AsyncRawSmsCampaignsClient, RawSmsCampaignsClient
11
+ from .types.create_sms_campaign_request_recipients import CreateSmsCampaignRequestRecipients
12
+ from .types.create_sms_campaign_response import CreateSmsCampaignResponse
13
+ from .types.get_sms_campaign_response import GetSmsCampaignResponse
14
+ from .types.get_sms_campaigns_request_sort import GetSmsCampaignsRequestSort
15
+ from .types.get_sms_campaigns_request_status import GetSmsCampaignsRequestStatus
16
+ from .types.get_sms_campaigns_response import GetSmsCampaignsResponse
17
+ from .types.request_sms_recipient_export_request_recipients_type import RequestSmsRecipientExportRequestRecipientsType
18
+ from .types.request_sms_recipient_export_response import RequestSmsRecipientExportResponse
19
+ from .types.update_sms_campaign_request_recipients import UpdateSmsCampaignRequestRecipients
20
+
21
+ # this is used as the default value for optional parameters
22
+ OMIT = typing.cast(typing.Any, ...)
23
+
24
+
25
+ class SmsCampaignsClient:
26
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
27
+ self._raw_client = RawSmsCampaignsClient(client_wrapper=client_wrapper)
28
+
29
+ @property
30
+ def with_raw_response(self) -> RawSmsCampaignsClient:
31
+ """
32
+ Retrieves a raw implementation of this client that returns raw responses.
33
+
34
+ Returns
35
+ -------
36
+ RawSmsCampaignsClient
37
+ """
38
+ return self._raw_client
39
+
40
+ def get_sms_campaigns(
41
+ self,
42
+ *,
43
+ status: typing.Optional[GetSmsCampaignsRequestStatus] = None,
44
+ start_date: typing.Optional[str] = None,
45
+ end_date: typing.Optional[str] = None,
46
+ limit: typing.Optional[int] = None,
47
+ offset: typing.Optional[int] = None,
48
+ sort: typing.Optional[GetSmsCampaignsRequestSort] = None,
49
+ request_options: typing.Optional[RequestOptions] = None,
50
+ ) -> GetSmsCampaignsResponse:
51
+ """
52
+ Parameters
53
+ ----------
54
+ status : typing.Optional[GetSmsCampaignsRequestStatus]
55
+ Status of campaign.
56
+
57
+ start_date : typing.Optional[str]
58
+ **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
59
+
60
+ end_date : typing.Optional[str]
61
+ **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
62
+
63
+ limit : typing.Optional[int]
64
+ Number limitation for the result returned
65
+
66
+ offset : typing.Optional[int]
67
+ Beginning point in the list to retrieve from.
68
+
69
+ sort : typing.Optional[GetSmsCampaignsRequestSort]
70
+ Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
71
+
72
+ request_options : typing.Optional[RequestOptions]
73
+ Request-specific configuration.
74
+
75
+ Returns
76
+ -------
77
+ GetSmsCampaignsResponse
78
+ SMS campaigns informations
79
+
80
+ Examples
81
+ --------
82
+ from brevo import Brevo
83
+
84
+ client = Brevo(
85
+ api_key="YOUR_API_KEY",
86
+ )
87
+ client.sms_campaigns.get_sms_campaigns()
88
+ """
89
+ _response = self._raw_client.get_sms_campaigns(
90
+ status=status,
91
+ start_date=start_date,
92
+ end_date=end_date,
93
+ limit=limit,
94
+ offset=offset,
95
+ sort=sort,
96
+ request_options=request_options,
97
+ )
98
+ return _response.data
99
+
100
+ def create_sms_campaign(
101
+ self,
102
+ *,
103
+ content: str,
104
+ name: str,
105
+ sender: str,
106
+ organisation_prefix: typing.Optional[str] = OMIT,
107
+ recipients: typing.Optional[CreateSmsCampaignRequestRecipients] = OMIT,
108
+ scheduled_at: typing.Optional[str] = OMIT,
109
+ unicode_enabled: typing.Optional[bool] = OMIT,
110
+ unsubscribe_instruction: typing.Optional[str] = OMIT,
111
+ request_options: typing.Optional[RequestOptions] = None,
112
+ ) -> CreateSmsCampaignResponse:
113
+ """
114
+ Parameters
115
+ ----------
116
+ content : str
117
+ Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS.
118
+
119
+ name : str
120
+ Name of the campaign
121
+
122
+ sender : str
123
+ Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
124
+
125
+ organisation_prefix : typing.Optional[str]
126
+ A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
127
+
128
+ recipients : typing.Optional[CreateSmsCampaignRequestRecipients]
129
+
130
+ scheduled_at : typing.Optional[str]
131
+ UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
132
+
133
+ unicode_enabled : typing.Optional[bool]
134
+ Format of the message. It indicates whether the content should be treated as unicode or not.
135
+
136
+ unsubscribe_instruction : typing.Optional[str]
137
+ Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
138
+
139
+ request_options : typing.Optional[RequestOptions]
140
+ Request-specific configuration.
141
+
142
+ Returns
143
+ -------
144
+ CreateSmsCampaignResponse
145
+ successfully created
146
+
147
+ Examples
148
+ --------
149
+ from brevo import Brevo
150
+
151
+ client = Brevo(
152
+ api_key="YOUR_API_KEY",
153
+ )
154
+ client.sms_campaigns.create_sms_campaign(
155
+ content="Get a discount by visiting our NY store and saying : Happy Spring!",
156
+ name="Spring Promo Code",
157
+ sender="MyShop",
158
+ )
159
+ """
160
+ _response = self._raw_client.create_sms_campaign(
161
+ content=content,
162
+ name=name,
163
+ sender=sender,
164
+ organisation_prefix=organisation_prefix,
165
+ recipients=recipients,
166
+ scheduled_at=scheduled_at,
167
+ unicode_enabled=unicode_enabled,
168
+ unsubscribe_instruction=unsubscribe_instruction,
169
+ request_options=request_options,
170
+ )
171
+ return _response.data
172
+
173
+ def get_sms_campaign(
174
+ self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
175
+ ) -> GetSmsCampaignResponse:
176
+ """
177
+ Parameters
178
+ ----------
179
+ campaign_id : int
180
+ id of the SMS campaign
181
+
182
+ request_options : typing.Optional[RequestOptions]
183
+ Request-specific configuration.
184
+
185
+ Returns
186
+ -------
187
+ GetSmsCampaignResponse
188
+ SMS campaign informations
189
+
190
+ Examples
191
+ --------
192
+ from brevo import Brevo
193
+
194
+ client = Brevo(
195
+ api_key="YOUR_API_KEY",
196
+ )
197
+ client.sms_campaigns.get_sms_campaign(
198
+ campaign_id=1000000,
199
+ )
200
+ """
201
+ _response = self._raw_client.get_sms_campaign(campaign_id, request_options=request_options)
202
+ return _response.data
203
+
204
+ def update_sms_campaign(
205
+ self,
206
+ campaign_id: int,
207
+ *,
208
+ content: typing.Optional[str] = OMIT,
209
+ name: typing.Optional[str] = OMIT,
210
+ organisation_prefix: typing.Optional[str] = OMIT,
211
+ recipients: typing.Optional[UpdateSmsCampaignRequestRecipients] = OMIT,
212
+ scheduled_at: typing.Optional[str] = OMIT,
213
+ sender: typing.Optional[str] = OMIT,
214
+ unicode_enabled: typing.Optional[bool] = OMIT,
215
+ unsubscribe_instruction: typing.Optional[str] = OMIT,
216
+ request_options: typing.Optional[RequestOptions] = None,
217
+ ) -> None:
218
+ """
219
+ Parameters
220
+ ----------
221
+ campaign_id : int
222
+ id of the SMS campaign
223
+
224
+ content : typing.Optional[str]
225
+ Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS
226
+
227
+ name : typing.Optional[str]
228
+ Name of the campaign
229
+
230
+ organisation_prefix : typing.Optional[str]
231
+ A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
232
+
233
+ recipients : typing.Optional[UpdateSmsCampaignRequestRecipients]
234
+
235
+ scheduled_at : typing.Optional[str]
236
+ UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
237
+
238
+ sender : typing.Optional[str]
239
+ Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
240
+
241
+ unicode_enabled : typing.Optional[bool]
242
+ Format of the message. It indicates whether the content should be treated as unicode or not.
243
+
244
+ unsubscribe_instruction : typing.Optional[str]
245
+ Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
246
+
247
+ request_options : typing.Optional[RequestOptions]
248
+ Request-specific configuration.
249
+
250
+ Returns
251
+ -------
252
+ None
253
+
254
+ Examples
255
+ --------
256
+ from brevo import Brevo
257
+
258
+ client = Brevo(
259
+ api_key="YOUR_API_KEY",
260
+ )
261
+ client.sms_campaigns.update_sms_campaign(
262
+ campaign_id=1000000,
263
+ )
264
+ """
265
+ _response = self._raw_client.update_sms_campaign(
266
+ campaign_id,
267
+ content=content,
268
+ name=name,
269
+ organisation_prefix=organisation_prefix,
270
+ recipients=recipients,
271
+ scheduled_at=scheduled_at,
272
+ sender=sender,
273
+ unicode_enabled=unicode_enabled,
274
+ unsubscribe_instruction=unsubscribe_instruction,
275
+ request_options=request_options,
276
+ )
277
+ return _response.data
278
+
279
+ def delete_sms_campaign(self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
280
+ """
281
+ Parameters
282
+ ----------
283
+ campaign_id : int
284
+ id of the SMS campaign
285
+
286
+ request_options : typing.Optional[RequestOptions]
287
+ Request-specific configuration.
288
+
289
+ Returns
290
+ -------
291
+ None
292
+
293
+ Examples
294
+ --------
295
+ from brevo import Brevo
296
+
297
+ client = Brevo(
298
+ api_key="YOUR_API_KEY",
299
+ )
300
+ client.sms_campaigns.delete_sms_campaign(
301
+ campaign_id=1000000,
302
+ )
303
+ """
304
+ _response = self._raw_client.delete_sms_campaign(campaign_id, request_options=request_options)
305
+ return _response.data
306
+
307
+ def request_sms_recipient_export(
308
+ self,
309
+ campaign_id: int,
310
+ *,
311
+ recipients_type: RequestSmsRecipientExportRequestRecipientsType,
312
+ notify_url: typing.Optional[str] = OMIT,
313
+ request_options: typing.Optional[RequestOptions] = None,
314
+ ) -> RequestSmsRecipientExportResponse:
315
+ """
316
+ It returns the background process ID which on completion calls the notify URL that you have set in the input.
317
+
318
+ Parameters
319
+ ----------
320
+ campaign_id : int
321
+ id of the campaign
322
+
323
+ recipients_type : RequestSmsRecipientExportRequestRecipientsType
324
+ Filter the recipients based on how they interacted with the campaign
325
+
326
+ notify_url : typing.Optional[str]
327
+ URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
328
+
329
+ request_options : typing.Optional[RequestOptions]
330
+ Request-specific configuration.
331
+
332
+ Returns
333
+ -------
334
+ RequestSmsRecipientExportResponse
335
+ process id created
336
+
337
+ Examples
338
+ --------
339
+ from brevo import Brevo
340
+
341
+ client = Brevo(
342
+ api_key="YOUR_API_KEY",
343
+ )
344
+ client.sms_campaigns.request_sms_recipient_export(
345
+ campaign_id=1000000,
346
+ recipients_type="all",
347
+ )
348
+ """
349
+ _response = self._raw_client.request_sms_recipient_export(
350
+ campaign_id, recipients_type=recipients_type, notify_url=notify_url, request_options=request_options
351
+ )
352
+ return _response.data
353
+
354
+ def send_sms_campaign_now(
355
+ self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
356
+ ) -> None:
357
+ """
358
+ Parameters
359
+ ----------
360
+ campaign_id : int
361
+ id of the campaign
362
+
363
+ request_options : typing.Optional[RequestOptions]
364
+ Request-specific configuration.
365
+
366
+ Returns
367
+ -------
368
+ None
369
+
370
+ Examples
371
+ --------
372
+ from brevo import Brevo
373
+
374
+ client = Brevo(
375
+ api_key="YOUR_API_KEY",
376
+ )
377
+ client.sms_campaigns.send_sms_campaign_now(
378
+ campaign_id=1000000,
379
+ )
380
+ """
381
+ _response = self._raw_client.send_sms_campaign_now(campaign_id, request_options=request_options)
382
+ return _response.data
383
+
384
+ def send_sms_report(
385
+ self,
386
+ campaign_id: int,
387
+ *,
388
+ email: SendReportEmail,
389
+ language: typing.Optional[SendReportLanguage] = OMIT,
390
+ request_options: typing.Optional[RequestOptions] = None,
391
+ ) -> None:
392
+ """
393
+ Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
394
+
395
+ Parameters
396
+ ----------
397
+ campaign_id : int
398
+ id of the campaign
399
+
400
+ email : SendReportEmail
401
+ Custom attributes for the report email.
402
+
403
+ language : typing.Optional[SendReportLanguage]
404
+ Language of email content for campaign report sending.
405
+
406
+ request_options : typing.Optional[RequestOptions]
407
+ Request-specific configuration.
408
+
409
+ Returns
410
+ -------
411
+ None
412
+
413
+ Examples
414
+ --------
415
+ from brevo import Brevo, SendReportEmail
416
+
417
+ client = Brevo(
418
+ api_key="YOUR_API_KEY",
419
+ )
420
+ client.sms_campaigns.send_sms_report(
421
+ campaign_id=1000000,
422
+ email=SendReportEmail(
423
+ body="Please find attached the report of our last email campaign.",
424
+ to=["jim.suehan@example.com"],
425
+ ),
426
+ )
427
+ """
428
+ _response = self._raw_client.send_sms_report(
429
+ campaign_id, email=email, language=language, request_options=request_options
430
+ )
431
+ return _response.data
432
+
433
+ def send_test_sms(
434
+ self,
435
+ campaign_id: int,
436
+ *,
437
+ phone_number: typing.Optional[str] = OMIT,
438
+ request_options: typing.Optional[RequestOptions] = None,
439
+ ) -> None:
440
+ """
441
+ Parameters
442
+ ----------
443
+ campaign_id : int
444
+ Id of the SMS campaign
445
+
446
+ phone_number : typing.Optional[str]
447
+ Mobile number of the recipient with the country code. This number **must belong to one of your contacts in Brevo account and must not be blacklisted**
448
+
449
+ request_options : typing.Optional[RequestOptions]
450
+ Request-specific configuration.
451
+
452
+ Returns
453
+ -------
454
+ None
455
+
456
+ Examples
457
+ --------
458
+ from brevo import Brevo
459
+
460
+ client = Brevo(
461
+ api_key="YOUR_API_KEY",
462
+ )
463
+ client.sms_campaigns.send_test_sms(
464
+ campaign_id=1000000,
465
+ )
466
+ """
467
+ _response = self._raw_client.send_test_sms(
468
+ campaign_id, phone_number=phone_number, request_options=request_options
469
+ )
470
+ return _response.data
471
+
472
+ def update_sms_campaign_status(
473
+ self,
474
+ campaign_id: int,
475
+ *,
476
+ status: typing.Optional[UpdateCampaignStatusStatus] = OMIT,
477
+ request_options: typing.Optional[RequestOptions] = None,
478
+ ) -> None:
479
+ """
480
+ Parameters
481
+ ----------
482
+ campaign_id : int
483
+ id of the campaign
484
+
485
+ status : typing.Optional[UpdateCampaignStatusStatus]
486
+ Note:- **replicateTemplate** status will be available **only for template type campaigns.**
487
+
488
+ request_options : typing.Optional[RequestOptions]
489
+ Request-specific configuration.
490
+
491
+ Returns
492
+ -------
493
+ None
494
+
495
+ Examples
496
+ --------
497
+ from brevo import Brevo
498
+
499
+ client = Brevo(
500
+ api_key="YOUR_API_KEY",
501
+ )
502
+ client.sms_campaigns.update_sms_campaign_status(
503
+ campaign_id=1000000,
504
+ )
505
+ """
506
+ _response = self._raw_client.update_sms_campaign_status(
507
+ campaign_id, status=status, request_options=request_options
508
+ )
509
+ return _response.data
510
+
511
+
512
+ class AsyncSmsCampaignsClient:
513
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
514
+ self._raw_client = AsyncRawSmsCampaignsClient(client_wrapper=client_wrapper)
515
+
516
+ @property
517
+ def with_raw_response(self) -> AsyncRawSmsCampaignsClient:
518
+ """
519
+ Retrieves a raw implementation of this client that returns raw responses.
520
+
521
+ Returns
522
+ -------
523
+ AsyncRawSmsCampaignsClient
524
+ """
525
+ return self._raw_client
526
+
527
+ async def get_sms_campaigns(
528
+ self,
529
+ *,
530
+ status: typing.Optional[GetSmsCampaignsRequestStatus] = None,
531
+ start_date: typing.Optional[str] = None,
532
+ end_date: typing.Optional[str] = None,
533
+ limit: typing.Optional[int] = None,
534
+ offset: typing.Optional[int] = None,
535
+ sort: typing.Optional[GetSmsCampaignsRequestSort] = None,
536
+ request_options: typing.Optional[RequestOptions] = None,
537
+ ) -> GetSmsCampaignsResponse:
538
+ """
539
+ Parameters
540
+ ----------
541
+ status : typing.Optional[GetSmsCampaignsRequestStatus]
542
+ Status of campaign.
543
+
544
+ start_date : typing.Optional[str]
545
+ **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
546
+
547
+ end_date : typing.Optional[str]
548
+ **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
549
+
550
+ limit : typing.Optional[int]
551
+ Number limitation for the result returned
552
+
553
+ offset : typing.Optional[int]
554
+ Beginning point in the list to retrieve from.
555
+
556
+ sort : typing.Optional[GetSmsCampaignsRequestSort]
557
+ Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
558
+
559
+ request_options : typing.Optional[RequestOptions]
560
+ Request-specific configuration.
561
+
562
+ Returns
563
+ -------
564
+ GetSmsCampaignsResponse
565
+ SMS campaigns informations
566
+
567
+ Examples
568
+ --------
569
+ import asyncio
570
+
571
+ from brevo import AsyncBrevo
572
+
573
+ client = AsyncBrevo(
574
+ api_key="YOUR_API_KEY",
575
+ )
576
+
577
+
578
+ async def main() -> None:
579
+ await client.sms_campaigns.get_sms_campaigns()
580
+
581
+
582
+ asyncio.run(main())
583
+ """
584
+ _response = await self._raw_client.get_sms_campaigns(
585
+ status=status,
586
+ start_date=start_date,
587
+ end_date=end_date,
588
+ limit=limit,
589
+ offset=offset,
590
+ sort=sort,
591
+ request_options=request_options,
592
+ )
593
+ return _response.data
594
+
595
+ async def create_sms_campaign(
596
+ self,
597
+ *,
598
+ content: str,
599
+ name: str,
600
+ sender: str,
601
+ organisation_prefix: typing.Optional[str] = OMIT,
602
+ recipients: typing.Optional[CreateSmsCampaignRequestRecipients] = OMIT,
603
+ scheduled_at: typing.Optional[str] = OMIT,
604
+ unicode_enabled: typing.Optional[bool] = OMIT,
605
+ unsubscribe_instruction: typing.Optional[str] = OMIT,
606
+ request_options: typing.Optional[RequestOptions] = None,
607
+ ) -> CreateSmsCampaignResponse:
608
+ """
609
+ Parameters
610
+ ----------
611
+ content : str
612
+ Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS.
613
+
614
+ name : str
615
+ Name of the campaign
616
+
617
+ sender : str
618
+ Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
619
+
620
+ organisation_prefix : typing.Optional[str]
621
+ A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
622
+
623
+ recipients : typing.Optional[CreateSmsCampaignRequestRecipients]
624
+
625
+ scheduled_at : typing.Optional[str]
626
+ UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
627
+
628
+ unicode_enabled : typing.Optional[bool]
629
+ Format of the message. It indicates whether the content should be treated as unicode or not.
630
+
631
+ unsubscribe_instruction : typing.Optional[str]
632
+ Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
633
+
634
+ request_options : typing.Optional[RequestOptions]
635
+ Request-specific configuration.
636
+
637
+ Returns
638
+ -------
639
+ CreateSmsCampaignResponse
640
+ successfully created
641
+
642
+ Examples
643
+ --------
644
+ import asyncio
645
+
646
+ from brevo import AsyncBrevo
647
+
648
+ client = AsyncBrevo(
649
+ api_key="YOUR_API_KEY",
650
+ )
651
+
652
+
653
+ async def main() -> None:
654
+ await client.sms_campaigns.create_sms_campaign(
655
+ content="Get a discount by visiting our NY store and saying : Happy Spring!",
656
+ name="Spring Promo Code",
657
+ sender="MyShop",
658
+ )
659
+
660
+
661
+ asyncio.run(main())
662
+ """
663
+ _response = await self._raw_client.create_sms_campaign(
664
+ content=content,
665
+ name=name,
666
+ sender=sender,
667
+ organisation_prefix=organisation_prefix,
668
+ recipients=recipients,
669
+ scheduled_at=scheduled_at,
670
+ unicode_enabled=unicode_enabled,
671
+ unsubscribe_instruction=unsubscribe_instruction,
672
+ request_options=request_options,
673
+ )
674
+ return _response.data
675
+
676
+ async def get_sms_campaign(
677
+ self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
678
+ ) -> GetSmsCampaignResponse:
679
+ """
680
+ Parameters
681
+ ----------
682
+ campaign_id : int
683
+ id of the SMS campaign
684
+
685
+ request_options : typing.Optional[RequestOptions]
686
+ Request-specific configuration.
687
+
688
+ Returns
689
+ -------
690
+ GetSmsCampaignResponse
691
+ SMS campaign informations
692
+
693
+ Examples
694
+ --------
695
+ import asyncio
696
+
697
+ from brevo import AsyncBrevo
698
+
699
+ client = AsyncBrevo(
700
+ api_key="YOUR_API_KEY",
701
+ )
702
+
703
+
704
+ async def main() -> None:
705
+ await client.sms_campaigns.get_sms_campaign(
706
+ campaign_id=1000000,
707
+ )
708
+
709
+
710
+ asyncio.run(main())
711
+ """
712
+ _response = await self._raw_client.get_sms_campaign(campaign_id, request_options=request_options)
713
+ return _response.data
714
+
715
+ async def update_sms_campaign(
716
+ self,
717
+ campaign_id: int,
718
+ *,
719
+ content: typing.Optional[str] = OMIT,
720
+ name: typing.Optional[str] = OMIT,
721
+ organisation_prefix: typing.Optional[str] = OMIT,
722
+ recipients: typing.Optional[UpdateSmsCampaignRequestRecipients] = OMIT,
723
+ scheduled_at: typing.Optional[str] = OMIT,
724
+ sender: typing.Optional[str] = OMIT,
725
+ unicode_enabled: typing.Optional[bool] = OMIT,
726
+ unsubscribe_instruction: typing.Optional[str] = OMIT,
727
+ request_options: typing.Optional[RequestOptions] = None,
728
+ ) -> None:
729
+ """
730
+ Parameters
731
+ ----------
732
+ campaign_id : int
733
+ id of the SMS campaign
734
+
735
+ content : typing.Optional[str]
736
+ Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS
737
+
738
+ name : typing.Optional[str]
739
+ Name of the campaign
740
+
741
+ organisation_prefix : typing.Optional[str]
742
+ A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
743
+
744
+ recipients : typing.Optional[UpdateSmsCampaignRequestRecipients]
745
+
746
+ scheduled_at : typing.Optional[str]
747
+ UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
748
+
749
+ sender : typing.Optional[str]
750
+ Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
751
+
752
+ unicode_enabled : typing.Optional[bool]
753
+ Format of the message. It indicates whether the content should be treated as unicode or not.
754
+
755
+ unsubscribe_instruction : typing.Optional[str]
756
+ Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
757
+
758
+ request_options : typing.Optional[RequestOptions]
759
+ Request-specific configuration.
760
+
761
+ Returns
762
+ -------
763
+ None
764
+
765
+ Examples
766
+ --------
767
+ import asyncio
768
+
769
+ from brevo import AsyncBrevo
770
+
771
+ client = AsyncBrevo(
772
+ api_key="YOUR_API_KEY",
773
+ )
774
+
775
+
776
+ async def main() -> None:
777
+ await client.sms_campaigns.update_sms_campaign(
778
+ campaign_id=1000000,
779
+ )
780
+
781
+
782
+ asyncio.run(main())
783
+ """
784
+ _response = await self._raw_client.update_sms_campaign(
785
+ campaign_id,
786
+ content=content,
787
+ name=name,
788
+ organisation_prefix=organisation_prefix,
789
+ recipients=recipients,
790
+ scheduled_at=scheduled_at,
791
+ sender=sender,
792
+ unicode_enabled=unicode_enabled,
793
+ unsubscribe_instruction=unsubscribe_instruction,
794
+ request_options=request_options,
795
+ )
796
+ return _response.data
797
+
798
+ async def delete_sms_campaign(
799
+ self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
800
+ ) -> None:
801
+ """
802
+ Parameters
803
+ ----------
804
+ campaign_id : int
805
+ id of the SMS campaign
806
+
807
+ request_options : typing.Optional[RequestOptions]
808
+ Request-specific configuration.
809
+
810
+ Returns
811
+ -------
812
+ None
813
+
814
+ Examples
815
+ --------
816
+ import asyncio
817
+
818
+ from brevo import AsyncBrevo
819
+
820
+ client = AsyncBrevo(
821
+ api_key="YOUR_API_KEY",
822
+ )
823
+
824
+
825
+ async def main() -> None:
826
+ await client.sms_campaigns.delete_sms_campaign(
827
+ campaign_id=1000000,
828
+ )
829
+
830
+
831
+ asyncio.run(main())
832
+ """
833
+ _response = await self._raw_client.delete_sms_campaign(campaign_id, request_options=request_options)
834
+ return _response.data
835
+
836
+ async def request_sms_recipient_export(
837
+ self,
838
+ campaign_id: int,
839
+ *,
840
+ recipients_type: RequestSmsRecipientExportRequestRecipientsType,
841
+ notify_url: typing.Optional[str] = OMIT,
842
+ request_options: typing.Optional[RequestOptions] = None,
843
+ ) -> RequestSmsRecipientExportResponse:
844
+ """
845
+ It returns the background process ID which on completion calls the notify URL that you have set in the input.
846
+
847
+ Parameters
848
+ ----------
849
+ campaign_id : int
850
+ id of the campaign
851
+
852
+ recipients_type : RequestSmsRecipientExportRequestRecipientsType
853
+ Filter the recipients based on how they interacted with the campaign
854
+
855
+ notify_url : typing.Optional[str]
856
+ URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
857
+
858
+ request_options : typing.Optional[RequestOptions]
859
+ Request-specific configuration.
860
+
861
+ Returns
862
+ -------
863
+ RequestSmsRecipientExportResponse
864
+ process id created
865
+
866
+ Examples
867
+ --------
868
+ import asyncio
869
+
870
+ from brevo import AsyncBrevo
871
+
872
+ client = AsyncBrevo(
873
+ api_key="YOUR_API_KEY",
874
+ )
875
+
876
+
877
+ async def main() -> None:
878
+ await client.sms_campaigns.request_sms_recipient_export(
879
+ campaign_id=1000000,
880
+ recipients_type="all",
881
+ )
882
+
883
+
884
+ asyncio.run(main())
885
+ """
886
+ _response = await self._raw_client.request_sms_recipient_export(
887
+ campaign_id, recipients_type=recipients_type, notify_url=notify_url, request_options=request_options
888
+ )
889
+ return _response.data
890
+
891
+ async def send_sms_campaign_now(
892
+ self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
893
+ ) -> None:
894
+ """
895
+ Parameters
896
+ ----------
897
+ campaign_id : int
898
+ id of the campaign
899
+
900
+ request_options : typing.Optional[RequestOptions]
901
+ Request-specific configuration.
902
+
903
+ Returns
904
+ -------
905
+ None
906
+
907
+ Examples
908
+ --------
909
+ import asyncio
910
+
911
+ from brevo import AsyncBrevo
912
+
913
+ client = AsyncBrevo(
914
+ api_key="YOUR_API_KEY",
915
+ )
916
+
917
+
918
+ async def main() -> None:
919
+ await client.sms_campaigns.send_sms_campaign_now(
920
+ campaign_id=1000000,
921
+ )
922
+
923
+
924
+ asyncio.run(main())
925
+ """
926
+ _response = await self._raw_client.send_sms_campaign_now(campaign_id, request_options=request_options)
927
+ return _response.data
928
+
929
+ async def send_sms_report(
930
+ self,
931
+ campaign_id: int,
932
+ *,
933
+ email: SendReportEmail,
934
+ language: typing.Optional[SendReportLanguage] = OMIT,
935
+ request_options: typing.Optional[RequestOptions] = None,
936
+ ) -> None:
937
+ """
938
+ Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
939
+
940
+ Parameters
941
+ ----------
942
+ campaign_id : int
943
+ id of the campaign
944
+
945
+ email : SendReportEmail
946
+ Custom attributes for the report email.
947
+
948
+ language : typing.Optional[SendReportLanguage]
949
+ Language of email content for campaign report sending.
950
+
951
+ request_options : typing.Optional[RequestOptions]
952
+ Request-specific configuration.
953
+
954
+ Returns
955
+ -------
956
+ None
957
+
958
+ Examples
959
+ --------
960
+ import asyncio
961
+
962
+ from brevo import AsyncBrevo, SendReportEmail
963
+
964
+ client = AsyncBrevo(
965
+ api_key="YOUR_API_KEY",
966
+ )
967
+
968
+
969
+ async def main() -> None:
970
+ await client.sms_campaigns.send_sms_report(
971
+ campaign_id=1000000,
972
+ email=SendReportEmail(
973
+ body="Please find attached the report of our last email campaign.",
974
+ to=["jim.suehan@example.com"],
975
+ ),
976
+ )
977
+
978
+
979
+ asyncio.run(main())
980
+ """
981
+ _response = await self._raw_client.send_sms_report(
982
+ campaign_id, email=email, language=language, request_options=request_options
983
+ )
984
+ return _response.data
985
+
986
+ async def send_test_sms(
987
+ self,
988
+ campaign_id: int,
989
+ *,
990
+ phone_number: typing.Optional[str] = OMIT,
991
+ request_options: typing.Optional[RequestOptions] = None,
992
+ ) -> None:
993
+ """
994
+ Parameters
995
+ ----------
996
+ campaign_id : int
997
+ Id of the SMS campaign
998
+
999
+ phone_number : typing.Optional[str]
1000
+ Mobile number of the recipient with the country code. This number **must belong to one of your contacts in Brevo account and must not be blacklisted**
1001
+
1002
+ request_options : typing.Optional[RequestOptions]
1003
+ Request-specific configuration.
1004
+
1005
+ Returns
1006
+ -------
1007
+ None
1008
+
1009
+ Examples
1010
+ --------
1011
+ import asyncio
1012
+
1013
+ from brevo import AsyncBrevo
1014
+
1015
+ client = AsyncBrevo(
1016
+ api_key="YOUR_API_KEY",
1017
+ )
1018
+
1019
+
1020
+ async def main() -> None:
1021
+ await client.sms_campaigns.send_test_sms(
1022
+ campaign_id=1000000,
1023
+ )
1024
+
1025
+
1026
+ asyncio.run(main())
1027
+ """
1028
+ _response = await self._raw_client.send_test_sms(
1029
+ campaign_id, phone_number=phone_number, request_options=request_options
1030
+ )
1031
+ return _response.data
1032
+
1033
+ async def update_sms_campaign_status(
1034
+ self,
1035
+ campaign_id: int,
1036
+ *,
1037
+ status: typing.Optional[UpdateCampaignStatusStatus] = OMIT,
1038
+ request_options: typing.Optional[RequestOptions] = None,
1039
+ ) -> None:
1040
+ """
1041
+ Parameters
1042
+ ----------
1043
+ campaign_id : int
1044
+ id of the campaign
1045
+
1046
+ status : typing.Optional[UpdateCampaignStatusStatus]
1047
+ Note:- **replicateTemplate** status will be available **only for template type campaigns.**
1048
+
1049
+ request_options : typing.Optional[RequestOptions]
1050
+ Request-specific configuration.
1051
+
1052
+ Returns
1053
+ -------
1054
+ None
1055
+
1056
+ Examples
1057
+ --------
1058
+ import asyncio
1059
+
1060
+ from brevo import AsyncBrevo
1061
+
1062
+ client = AsyncBrevo(
1063
+ api_key="YOUR_API_KEY",
1064
+ )
1065
+
1066
+
1067
+ async def main() -> None:
1068
+ await client.sms_campaigns.update_sms_campaign_status(
1069
+ campaign_id=1000000,
1070
+ )
1071
+
1072
+
1073
+ asyncio.run(main())
1074
+ """
1075
+ _response = await self._raw_client.update_sms_campaign_status(
1076
+ campaign_id, status=status, request_options=request_options
1077
+ )
1078
+ return _response.data