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,1128 @@
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.loyalty_program import LoyaltyProgram
8
+ from .raw_client import AsyncRawProgramClient, RawProgramClient
9
+ from .types.get_lp_list_request_sort_field import GetLpListRequestSortField
10
+ from .types.get_lp_list_response import GetLpListResponse
11
+ from .types.get_parameter_subscription_info_response import GetParameterSubscriptionInfoResponse
12
+ from .types.subscribe_member_to_a_subscription_response import SubscribeMemberToASubscriptionResponse
13
+ from .types.subscribe_to_loyalty_program_response import SubscribeToLoyaltyProgramResponse
14
+
15
+ # this is used as the default value for optional parameters
16
+ OMIT = typing.cast(typing.Any, ...)
17
+
18
+
19
+ class ProgramClient:
20
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
21
+ self._raw_client = RawProgramClient(client_wrapper=client_wrapper)
22
+
23
+ @property
24
+ def with_raw_response(self) -> RawProgramClient:
25
+ """
26
+ Retrieves a raw implementation of this client that returns raw responses.
27
+
28
+ Returns
29
+ -------
30
+ RawProgramClient
31
+ """
32
+ return self._raw_client
33
+
34
+ def get_lp_list(
35
+ self,
36
+ *,
37
+ limit: typing.Optional[int] = None,
38
+ offset: typing.Optional[int] = None,
39
+ sort_field: typing.Optional[GetLpListRequestSortField] = None,
40
+ sort: typing.Optional[str] = None,
41
+ request_options: typing.Optional[RequestOptions] = None,
42
+ ) -> GetLpListResponse:
43
+ """
44
+ Returns list of loyalty programs
45
+
46
+ Parameters
47
+ ----------
48
+ limit : typing.Optional[int]
49
+ Number of documents per page
50
+
51
+ offset : typing.Optional[int]
52
+ Index of the first document in the page
53
+
54
+ sort_field : typing.Optional[GetLpListRequestSortField]
55
+ Sort documents by field
56
+
57
+ sort : typing.Optional[str]
58
+ Sort documents by field
59
+
60
+ request_options : typing.Optional[RequestOptions]
61
+ Request-specific configuration.
62
+
63
+ Returns
64
+ -------
65
+ GetLpListResponse
66
+ Loyalty Program page
67
+
68
+ Examples
69
+ --------
70
+ from brevo import Brevo
71
+
72
+ client = Brevo(
73
+ api_key="YOUR_API_KEY",
74
+ )
75
+ client.program.get_lp_list()
76
+ """
77
+ _response = self._raw_client.get_lp_list(
78
+ limit=limit, offset=offset, sort_field=sort_field, sort=sort, request_options=request_options
79
+ )
80
+ return _response.data
81
+
82
+ def create_new_lp(
83
+ self,
84
+ *,
85
+ name: str,
86
+ description: typing.Optional[str] = OMIT,
87
+ document_id: typing.Optional[str] = OMIT,
88
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
89
+ request_options: typing.Optional[RequestOptions] = None,
90
+ ) -> LoyaltyProgram:
91
+ """
92
+ Creates loyalty program
93
+
94
+ Parameters
95
+ ----------
96
+ name : str
97
+ Required name of the loyalty program (max 128 chars).
98
+
99
+ description : typing.Optional[str]
100
+ Optional description of the loyalty program (max 256 chars).
101
+
102
+ document_id : typing.Optional[str]
103
+ Optional unique document ID.
104
+
105
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
106
+ Optional metadata related to the loyalty program.
107
+
108
+ request_options : typing.Optional[RequestOptions]
109
+ Request-specific configuration.
110
+
111
+ Returns
112
+ -------
113
+ LoyaltyProgram
114
+ Successfully created loyalty program.
115
+
116
+ Examples
117
+ --------
118
+ from brevo import Brevo
119
+
120
+ client = Brevo(
121
+ api_key="YOUR_API_KEY",
122
+ )
123
+ client.program.create_new_lp(
124
+ name="name",
125
+ )
126
+ """
127
+ _response = self._raw_client.create_new_lp(
128
+ name=name, description=description, document_id=document_id, meta=meta, request_options=request_options
129
+ )
130
+ return _response.data
131
+
132
+ def get_loyalty_program_info(
133
+ self, pid: str, *, request_options: typing.Optional[RequestOptions] = None
134
+ ) -> LoyaltyProgram:
135
+ """
136
+ Returns loyalty program
137
+
138
+ Parameters
139
+ ----------
140
+ pid : str
141
+ Loyalty Program ID. A unique identifier for the loyalty program.
142
+
143
+ request_options : typing.Optional[RequestOptions]
144
+ Request-specific configuration.
145
+
146
+ Returns
147
+ -------
148
+ LoyaltyProgram
149
+ Successfully retrieved loyalty program.
150
+
151
+ Examples
152
+ --------
153
+ from brevo import Brevo
154
+
155
+ client = Brevo(
156
+ api_key="YOUR_API_KEY",
157
+ )
158
+ client.program.get_loyalty_program_info(
159
+ pid="pid",
160
+ )
161
+ """
162
+ _response = self._raw_client.get_loyalty_program_info(pid, request_options=request_options)
163
+ return _response.data
164
+
165
+ def update_loyalty_program(
166
+ self,
167
+ pid: str,
168
+ *,
169
+ name: str,
170
+ description: typing.Optional[str] = OMIT,
171
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
172
+ request_options: typing.Optional[RequestOptions] = None,
173
+ ) -> LoyaltyProgram:
174
+ """
175
+ Updates loyalty program
176
+
177
+ Parameters
178
+ ----------
179
+ pid : str
180
+ Loyalty Program ID. A unique identifier for the loyalty program.
181
+
182
+ name : str
183
+ Loyalty Program name
184
+
185
+ description : typing.Optional[str]
186
+ Loyalty Program description
187
+
188
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
189
+ Loyalty Program meta data
190
+
191
+ request_options : typing.Optional[RequestOptions]
192
+ Request-specific configuration.
193
+
194
+ Returns
195
+ -------
196
+ LoyaltyProgram
197
+ Successfully updated loyalty program.
198
+
199
+ Examples
200
+ --------
201
+ from brevo import Brevo
202
+
203
+ client = Brevo(
204
+ api_key="YOUR_API_KEY",
205
+ )
206
+ client.program.update_loyalty_program(
207
+ pid="pid",
208
+ name="name",
209
+ )
210
+ """
211
+ _response = self._raw_client.update_loyalty_program(
212
+ pid, name=name, description=description, meta=meta, request_options=request_options
213
+ )
214
+ return _response.data
215
+
216
+ def delete_loyalty_program(self, pid: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
217
+ """
218
+ Deletes Loyalty Program
219
+
220
+ Parameters
221
+ ----------
222
+ pid : str
223
+ Loyalty Program ID. A unique identifier for the loyalty program.
224
+
225
+ request_options : typing.Optional[RequestOptions]
226
+ Request-specific configuration.
227
+
228
+ Returns
229
+ -------
230
+ None
231
+
232
+ Examples
233
+ --------
234
+ from brevo import Brevo
235
+
236
+ client = Brevo(
237
+ api_key="YOUR_API_KEY",
238
+ )
239
+ client.program.delete_loyalty_program(
240
+ pid="pid",
241
+ )
242
+ """
243
+ _response = self._raw_client.delete_loyalty_program(pid, request_options=request_options)
244
+ return _response.data
245
+
246
+ def partially_update_loyalty_program(
247
+ self,
248
+ pid: str,
249
+ *,
250
+ description: typing.Optional[str] = OMIT,
251
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
252
+ name: typing.Optional[str] = OMIT,
253
+ request_options: typing.Optional[RequestOptions] = None,
254
+ ) -> LoyaltyProgram:
255
+ """
256
+ Partially updates loyalty program
257
+
258
+ Parameters
259
+ ----------
260
+ pid : str
261
+ Loyalty Program ID. A unique identifier for the loyalty program.
262
+
263
+ description : typing.Optional[str]
264
+ Loyalty Program description
265
+
266
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
267
+ Loyalty Program meta data
268
+
269
+ name : typing.Optional[str]
270
+ Loyalty Program name
271
+
272
+ request_options : typing.Optional[RequestOptions]
273
+ Request-specific configuration.
274
+
275
+ Returns
276
+ -------
277
+ LoyaltyProgram
278
+ Successfully updated loyalty program.
279
+
280
+ Examples
281
+ --------
282
+ from brevo import Brevo
283
+
284
+ client = Brevo(
285
+ api_key="YOUR_API_KEY",
286
+ )
287
+ client.program.partially_update_loyalty_program(
288
+ pid="pid",
289
+ )
290
+ """
291
+ _response = self._raw_client.partially_update_loyalty_program(
292
+ pid, description=description, meta=meta, name=name, request_options=request_options
293
+ )
294
+ return _response.data
295
+
296
+ def get_parameter_subscription_info(
297
+ self,
298
+ pid: str,
299
+ *,
300
+ contact_id: typing.Optional[str] = None,
301
+ params: typing.Optional[str] = None,
302
+ loyalty_subscription_id: typing.Optional[str] = None,
303
+ request_options: typing.Optional[RequestOptions] = None,
304
+ ) -> GetParameterSubscriptionInfoResponse:
305
+ """
306
+ Get Information of balances, tiers, rewards and subscription members for a subscription
307
+
308
+ Parameters
309
+ ----------
310
+ pid : str
311
+ Loyalty Program ID. A unique identifier for the loyalty program.
312
+
313
+ contact_id : typing.Optional[str]
314
+ The contact ID to filter by.
315
+
316
+ params : typing.Optional[str]
317
+ A list of filter parameters for querying the subscription info.
318
+
319
+ loyalty_subscription_id : typing.Optional[str]
320
+ The loyalty subscription ID to filter by.
321
+
322
+ request_options : typing.Optional[RequestOptions]
323
+ Request-specific configuration.
324
+
325
+ Returns
326
+ -------
327
+ GetParameterSubscriptionInfoResponse
328
+ Successfully retrieved subscription info.
329
+
330
+ Examples
331
+ --------
332
+ from brevo import Brevo
333
+
334
+ client = Brevo(
335
+ api_key="YOUR_API_KEY",
336
+ )
337
+ client.program.get_parameter_subscription_info(
338
+ pid="pid",
339
+ )
340
+ """
341
+ _response = self._raw_client.get_parameter_subscription_info(
342
+ pid,
343
+ contact_id=contact_id,
344
+ params=params,
345
+ loyalty_subscription_id=loyalty_subscription_id,
346
+ request_options=request_options,
347
+ )
348
+ return _response.data
349
+
350
+ def publish_loyalty_program(self, pid: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
351
+ """
352
+ Publishes loyalty program
353
+
354
+ Parameters
355
+ ----------
356
+ pid : str
357
+ Loyalty Program ID. A unique identifier for the loyalty program.
358
+
359
+ request_options : typing.Optional[RequestOptions]
360
+ Request-specific configuration.
361
+
362
+ Returns
363
+ -------
364
+ None
365
+
366
+ Examples
367
+ --------
368
+ from brevo import Brevo
369
+
370
+ client = Brevo(
371
+ api_key="YOUR_API_KEY",
372
+ )
373
+ client.program.publish_loyalty_program(
374
+ pid="pid",
375
+ )
376
+ """
377
+ _response = self._raw_client.publish_loyalty_program(pid, request_options=request_options)
378
+ return _response.data
379
+
380
+ def subscribe_member_to_a_subscription(
381
+ self,
382
+ pid: str,
383
+ *,
384
+ member_contact_ids: typing.Sequence[int],
385
+ contact_id: typing.Optional[int] = OMIT,
386
+ loyalty_subscription_id: typing.Optional[str] = OMIT,
387
+ request_options: typing.Optional[RequestOptions] = None,
388
+ ) -> SubscribeMemberToASubscriptionResponse:
389
+ """
390
+ Add member to a subscription
391
+
392
+ Parameters
393
+ ----------
394
+ pid : str
395
+ Loyalty Program ID. A unique identifier for the loyalty program.
396
+
397
+ member_contact_ids : typing.Sequence[int]
398
+ Required, each item must be greater than or equal to 1
399
+
400
+ contact_id : typing.Optional[int]
401
+ Required if LoyaltySubscriptionId is not provided, must be greater than 0
402
+
403
+ loyalty_subscription_id : typing.Optional[str]
404
+ Required if ContactId is not provided, max length 64
405
+
406
+ request_options : typing.Optional[RequestOptions]
407
+ Request-specific configuration.
408
+
409
+ Returns
410
+ -------
411
+ SubscribeMemberToASubscriptionResponse
412
+ Successfully added subscription member.
413
+
414
+ Examples
415
+ --------
416
+ from brevo import Brevo
417
+
418
+ client = Brevo(
419
+ api_key="YOUR_API_KEY",
420
+ )
421
+ client.program.subscribe_member_to_a_subscription(
422
+ pid="pid",
423
+ member_contact_ids=[1],
424
+ )
425
+ """
426
+ _response = self._raw_client.subscribe_member_to_a_subscription(
427
+ pid,
428
+ member_contact_ids=member_contact_ids,
429
+ contact_id=contact_id,
430
+ loyalty_subscription_id=loyalty_subscription_id,
431
+ request_options=request_options,
432
+ )
433
+ return _response.data
434
+
435
+ def delete_contact_members(
436
+ self, pid: str, *, member_contact_ids: str, request_options: typing.Optional[RequestOptions] = None
437
+ ) -> None:
438
+ """
439
+ Deletes member from a subscription
440
+
441
+ Parameters
442
+ ----------
443
+ pid : str
444
+ Loyalty Program ID. A unique identifier for the loyalty program.
445
+
446
+ member_contact_ids : str
447
+ Comma-separated list of member contact IDs to delete from the subscription.
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.program.delete_contact_members(
464
+ pid="pid",
465
+ member_contact_ids="memberContactIds",
466
+ )
467
+ """
468
+ _response = self._raw_client.delete_contact_members(
469
+ pid, member_contact_ids=member_contact_ids, request_options=request_options
470
+ )
471
+ return _response.data
472
+
473
+ def subscribe_to_loyalty_program(
474
+ self,
475
+ pid: str,
476
+ *,
477
+ contact_id: int,
478
+ creation_date: typing.Optional[str] = OMIT,
479
+ loyalty_subscription_id: typing.Optional[str] = OMIT,
480
+ request_options: typing.Optional[RequestOptions] = None,
481
+ ) -> SubscribeToLoyaltyProgramResponse:
482
+ """
483
+ Subscribes to a loyalty program
484
+
485
+ Parameters
486
+ ----------
487
+ pid : str
488
+ Loyalty Program ID. A unique identifier for the loyalty program.
489
+
490
+ contact_id : int
491
+ Required contact ID; must be greater than 0.
492
+
493
+ creation_date : typing.Optional[str]
494
+ Optional custom date-time format.
495
+
496
+ loyalty_subscription_id : typing.Optional[str]
497
+ Optional subscription ID (max length 64).
498
+
499
+ request_options : typing.Optional[RequestOptions]
500
+ Request-specific configuration.
501
+
502
+ Returns
503
+ -------
504
+ SubscribeToLoyaltyProgramResponse
505
+ Successfully created subscription.
506
+
507
+ Examples
508
+ --------
509
+ from brevo import Brevo
510
+
511
+ client = Brevo(
512
+ api_key="YOUR_API_KEY",
513
+ )
514
+ client.program.subscribe_to_loyalty_program(
515
+ pid="pid",
516
+ contact_id=1,
517
+ )
518
+ """
519
+ _response = self._raw_client.subscribe_to_loyalty_program(
520
+ pid,
521
+ contact_id=contact_id,
522
+ creation_date=creation_date,
523
+ loyalty_subscription_id=loyalty_subscription_id,
524
+ request_options=request_options,
525
+ )
526
+ return _response.data
527
+
528
+
529
+ class AsyncProgramClient:
530
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
531
+ self._raw_client = AsyncRawProgramClient(client_wrapper=client_wrapper)
532
+
533
+ @property
534
+ def with_raw_response(self) -> AsyncRawProgramClient:
535
+ """
536
+ Retrieves a raw implementation of this client that returns raw responses.
537
+
538
+ Returns
539
+ -------
540
+ AsyncRawProgramClient
541
+ """
542
+ return self._raw_client
543
+
544
+ async def get_lp_list(
545
+ self,
546
+ *,
547
+ limit: typing.Optional[int] = None,
548
+ offset: typing.Optional[int] = None,
549
+ sort_field: typing.Optional[GetLpListRequestSortField] = None,
550
+ sort: typing.Optional[str] = None,
551
+ request_options: typing.Optional[RequestOptions] = None,
552
+ ) -> GetLpListResponse:
553
+ """
554
+ Returns list of loyalty programs
555
+
556
+ Parameters
557
+ ----------
558
+ limit : typing.Optional[int]
559
+ Number of documents per page
560
+
561
+ offset : typing.Optional[int]
562
+ Index of the first document in the page
563
+
564
+ sort_field : typing.Optional[GetLpListRequestSortField]
565
+ Sort documents by field
566
+
567
+ sort : typing.Optional[str]
568
+ Sort documents by field
569
+
570
+ request_options : typing.Optional[RequestOptions]
571
+ Request-specific configuration.
572
+
573
+ Returns
574
+ -------
575
+ GetLpListResponse
576
+ Loyalty Program page
577
+
578
+ Examples
579
+ --------
580
+ import asyncio
581
+
582
+ from brevo import AsyncBrevo
583
+
584
+ client = AsyncBrevo(
585
+ api_key="YOUR_API_KEY",
586
+ )
587
+
588
+
589
+ async def main() -> None:
590
+ await client.program.get_lp_list()
591
+
592
+
593
+ asyncio.run(main())
594
+ """
595
+ _response = await self._raw_client.get_lp_list(
596
+ limit=limit, offset=offset, sort_field=sort_field, sort=sort, request_options=request_options
597
+ )
598
+ return _response.data
599
+
600
+ async def create_new_lp(
601
+ self,
602
+ *,
603
+ name: str,
604
+ description: typing.Optional[str] = OMIT,
605
+ document_id: typing.Optional[str] = OMIT,
606
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
607
+ request_options: typing.Optional[RequestOptions] = None,
608
+ ) -> LoyaltyProgram:
609
+ """
610
+ Creates loyalty program
611
+
612
+ Parameters
613
+ ----------
614
+ name : str
615
+ Required name of the loyalty program (max 128 chars).
616
+
617
+ description : typing.Optional[str]
618
+ Optional description of the loyalty program (max 256 chars).
619
+
620
+ document_id : typing.Optional[str]
621
+ Optional unique document ID.
622
+
623
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
624
+ Optional metadata related to the loyalty program.
625
+
626
+ request_options : typing.Optional[RequestOptions]
627
+ Request-specific configuration.
628
+
629
+ Returns
630
+ -------
631
+ LoyaltyProgram
632
+ Successfully created loyalty program.
633
+
634
+ Examples
635
+ --------
636
+ import asyncio
637
+
638
+ from brevo import AsyncBrevo
639
+
640
+ client = AsyncBrevo(
641
+ api_key="YOUR_API_KEY",
642
+ )
643
+
644
+
645
+ async def main() -> None:
646
+ await client.program.create_new_lp(
647
+ name="name",
648
+ )
649
+
650
+
651
+ asyncio.run(main())
652
+ """
653
+ _response = await self._raw_client.create_new_lp(
654
+ name=name, description=description, document_id=document_id, meta=meta, request_options=request_options
655
+ )
656
+ return _response.data
657
+
658
+ async def get_loyalty_program_info(
659
+ self, pid: str, *, request_options: typing.Optional[RequestOptions] = None
660
+ ) -> LoyaltyProgram:
661
+ """
662
+ Returns loyalty program
663
+
664
+ Parameters
665
+ ----------
666
+ pid : str
667
+ Loyalty Program ID. A unique identifier for the loyalty program.
668
+
669
+ request_options : typing.Optional[RequestOptions]
670
+ Request-specific configuration.
671
+
672
+ Returns
673
+ -------
674
+ LoyaltyProgram
675
+ Successfully retrieved loyalty program.
676
+
677
+ Examples
678
+ --------
679
+ import asyncio
680
+
681
+ from brevo import AsyncBrevo
682
+
683
+ client = AsyncBrevo(
684
+ api_key="YOUR_API_KEY",
685
+ )
686
+
687
+
688
+ async def main() -> None:
689
+ await client.program.get_loyalty_program_info(
690
+ pid="pid",
691
+ )
692
+
693
+
694
+ asyncio.run(main())
695
+ """
696
+ _response = await self._raw_client.get_loyalty_program_info(pid, request_options=request_options)
697
+ return _response.data
698
+
699
+ async def update_loyalty_program(
700
+ self,
701
+ pid: str,
702
+ *,
703
+ name: str,
704
+ description: typing.Optional[str] = OMIT,
705
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
706
+ request_options: typing.Optional[RequestOptions] = None,
707
+ ) -> LoyaltyProgram:
708
+ """
709
+ Updates loyalty program
710
+
711
+ Parameters
712
+ ----------
713
+ pid : str
714
+ Loyalty Program ID. A unique identifier for the loyalty program.
715
+
716
+ name : str
717
+ Loyalty Program name
718
+
719
+ description : typing.Optional[str]
720
+ Loyalty Program description
721
+
722
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
723
+ Loyalty Program meta data
724
+
725
+ request_options : typing.Optional[RequestOptions]
726
+ Request-specific configuration.
727
+
728
+ Returns
729
+ -------
730
+ LoyaltyProgram
731
+ Successfully updated loyalty program.
732
+
733
+ Examples
734
+ --------
735
+ import asyncio
736
+
737
+ from brevo import AsyncBrevo
738
+
739
+ client = AsyncBrevo(
740
+ api_key="YOUR_API_KEY",
741
+ )
742
+
743
+
744
+ async def main() -> None:
745
+ await client.program.update_loyalty_program(
746
+ pid="pid",
747
+ name="name",
748
+ )
749
+
750
+
751
+ asyncio.run(main())
752
+ """
753
+ _response = await self._raw_client.update_loyalty_program(
754
+ pid, name=name, description=description, meta=meta, request_options=request_options
755
+ )
756
+ return _response.data
757
+
758
+ async def delete_loyalty_program(
759
+ self, pid: str, *, request_options: typing.Optional[RequestOptions] = None
760
+ ) -> None:
761
+ """
762
+ Deletes Loyalty Program
763
+
764
+ Parameters
765
+ ----------
766
+ pid : str
767
+ Loyalty Program ID. A unique identifier for the loyalty program.
768
+
769
+ request_options : typing.Optional[RequestOptions]
770
+ Request-specific configuration.
771
+
772
+ Returns
773
+ -------
774
+ None
775
+
776
+ Examples
777
+ --------
778
+ import asyncio
779
+
780
+ from brevo import AsyncBrevo
781
+
782
+ client = AsyncBrevo(
783
+ api_key="YOUR_API_KEY",
784
+ )
785
+
786
+
787
+ async def main() -> None:
788
+ await client.program.delete_loyalty_program(
789
+ pid="pid",
790
+ )
791
+
792
+
793
+ asyncio.run(main())
794
+ """
795
+ _response = await self._raw_client.delete_loyalty_program(pid, request_options=request_options)
796
+ return _response.data
797
+
798
+ async def partially_update_loyalty_program(
799
+ self,
800
+ pid: str,
801
+ *,
802
+ description: typing.Optional[str] = OMIT,
803
+ meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
804
+ name: typing.Optional[str] = OMIT,
805
+ request_options: typing.Optional[RequestOptions] = None,
806
+ ) -> LoyaltyProgram:
807
+ """
808
+ Partially updates loyalty program
809
+
810
+ Parameters
811
+ ----------
812
+ pid : str
813
+ Loyalty Program ID. A unique identifier for the loyalty program.
814
+
815
+ description : typing.Optional[str]
816
+ Loyalty Program description
817
+
818
+ meta : typing.Optional[typing.Dict[str, typing.Any]]
819
+ Loyalty Program meta data
820
+
821
+ name : typing.Optional[str]
822
+ Loyalty Program name
823
+
824
+ request_options : typing.Optional[RequestOptions]
825
+ Request-specific configuration.
826
+
827
+ Returns
828
+ -------
829
+ LoyaltyProgram
830
+ Successfully updated loyalty program.
831
+
832
+ Examples
833
+ --------
834
+ import asyncio
835
+
836
+ from brevo import AsyncBrevo
837
+
838
+ client = AsyncBrevo(
839
+ api_key="YOUR_API_KEY",
840
+ )
841
+
842
+
843
+ async def main() -> None:
844
+ await client.program.partially_update_loyalty_program(
845
+ pid="pid",
846
+ )
847
+
848
+
849
+ asyncio.run(main())
850
+ """
851
+ _response = await self._raw_client.partially_update_loyalty_program(
852
+ pid, description=description, meta=meta, name=name, request_options=request_options
853
+ )
854
+ return _response.data
855
+
856
+ async def get_parameter_subscription_info(
857
+ self,
858
+ pid: str,
859
+ *,
860
+ contact_id: typing.Optional[str] = None,
861
+ params: typing.Optional[str] = None,
862
+ loyalty_subscription_id: typing.Optional[str] = None,
863
+ request_options: typing.Optional[RequestOptions] = None,
864
+ ) -> GetParameterSubscriptionInfoResponse:
865
+ """
866
+ Get Information of balances, tiers, rewards and subscription members for a subscription
867
+
868
+ Parameters
869
+ ----------
870
+ pid : str
871
+ Loyalty Program ID. A unique identifier for the loyalty program.
872
+
873
+ contact_id : typing.Optional[str]
874
+ The contact ID to filter by.
875
+
876
+ params : typing.Optional[str]
877
+ A list of filter parameters for querying the subscription info.
878
+
879
+ loyalty_subscription_id : typing.Optional[str]
880
+ The loyalty subscription ID to filter by.
881
+
882
+ request_options : typing.Optional[RequestOptions]
883
+ Request-specific configuration.
884
+
885
+ Returns
886
+ -------
887
+ GetParameterSubscriptionInfoResponse
888
+ Successfully retrieved subscription info.
889
+
890
+ Examples
891
+ --------
892
+ import asyncio
893
+
894
+ from brevo import AsyncBrevo
895
+
896
+ client = AsyncBrevo(
897
+ api_key="YOUR_API_KEY",
898
+ )
899
+
900
+
901
+ async def main() -> None:
902
+ await client.program.get_parameter_subscription_info(
903
+ pid="pid",
904
+ )
905
+
906
+
907
+ asyncio.run(main())
908
+ """
909
+ _response = await self._raw_client.get_parameter_subscription_info(
910
+ pid,
911
+ contact_id=contact_id,
912
+ params=params,
913
+ loyalty_subscription_id=loyalty_subscription_id,
914
+ request_options=request_options,
915
+ )
916
+ return _response.data
917
+
918
+ async def publish_loyalty_program(
919
+ self, pid: str, *, request_options: typing.Optional[RequestOptions] = None
920
+ ) -> None:
921
+ """
922
+ Publishes loyalty program
923
+
924
+ Parameters
925
+ ----------
926
+ pid : str
927
+ Loyalty Program ID. A unique identifier for the loyalty program.
928
+
929
+ request_options : typing.Optional[RequestOptions]
930
+ Request-specific configuration.
931
+
932
+ Returns
933
+ -------
934
+ None
935
+
936
+ Examples
937
+ --------
938
+ import asyncio
939
+
940
+ from brevo import AsyncBrevo
941
+
942
+ client = AsyncBrevo(
943
+ api_key="YOUR_API_KEY",
944
+ )
945
+
946
+
947
+ async def main() -> None:
948
+ await client.program.publish_loyalty_program(
949
+ pid="pid",
950
+ )
951
+
952
+
953
+ asyncio.run(main())
954
+ """
955
+ _response = await self._raw_client.publish_loyalty_program(pid, request_options=request_options)
956
+ return _response.data
957
+
958
+ async def subscribe_member_to_a_subscription(
959
+ self,
960
+ pid: str,
961
+ *,
962
+ member_contact_ids: typing.Sequence[int],
963
+ contact_id: typing.Optional[int] = OMIT,
964
+ loyalty_subscription_id: typing.Optional[str] = OMIT,
965
+ request_options: typing.Optional[RequestOptions] = None,
966
+ ) -> SubscribeMemberToASubscriptionResponse:
967
+ """
968
+ Add member to a subscription
969
+
970
+ Parameters
971
+ ----------
972
+ pid : str
973
+ Loyalty Program ID. A unique identifier for the loyalty program.
974
+
975
+ member_contact_ids : typing.Sequence[int]
976
+ Required, each item must be greater than or equal to 1
977
+
978
+ contact_id : typing.Optional[int]
979
+ Required if LoyaltySubscriptionId is not provided, must be greater than 0
980
+
981
+ loyalty_subscription_id : typing.Optional[str]
982
+ Required if ContactId is not provided, max length 64
983
+
984
+ request_options : typing.Optional[RequestOptions]
985
+ Request-specific configuration.
986
+
987
+ Returns
988
+ -------
989
+ SubscribeMemberToASubscriptionResponse
990
+ Successfully added subscription member.
991
+
992
+ Examples
993
+ --------
994
+ import asyncio
995
+
996
+ from brevo import AsyncBrevo
997
+
998
+ client = AsyncBrevo(
999
+ api_key="YOUR_API_KEY",
1000
+ )
1001
+
1002
+
1003
+ async def main() -> None:
1004
+ await client.program.subscribe_member_to_a_subscription(
1005
+ pid="pid",
1006
+ member_contact_ids=[1],
1007
+ )
1008
+
1009
+
1010
+ asyncio.run(main())
1011
+ """
1012
+ _response = await self._raw_client.subscribe_member_to_a_subscription(
1013
+ pid,
1014
+ member_contact_ids=member_contact_ids,
1015
+ contact_id=contact_id,
1016
+ loyalty_subscription_id=loyalty_subscription_id,
1017
+ request_options=request_options,
1018
+ )
1019
+ return _response.data
1020
+
1021
+ async def delete_contact_members(
1022
+ self, pid: str, *, member_contact_ids: str, request_options: typing.Optional[RequestOptions] = None
1023
+ ) -> None:
1024
+ """
1025
+ Deletes member from a subscription
1026
+
1027
+ Parameters
1028
+ ----------
1029
+ pid : str
1030
+ Loyalty Program ID. A unique identifier for the loyalty program.
1031
+
1032
+ member_contact_ids : str
1033
+ Comma-separated list of member contact IDs to delete from the subscription.
1034
+
1035
+ request_options : typing.Optional[RequestOptions]
1036
+ Request-specific configuration.
1037
+
1038
+ Returns
1039
+ -------
1040
+ None
1041
+
1042
+ Examples
1043
+ --------
1044
+ import asyncio
1045
+
1046
+ from brevo import AsyncBrevo
1047
+
1048
+ client = AsyncBrevo(
1049
+ api_key="YOUR_API_KEY",
1050
+ )
1051
+
1052
+
1053
+ async def main() -> None:
1054
+ await client.program.delete_contact_members(
1055
+ pid="pid",
1056
+ member_contact_ids="memberContactIds",
1057
+ )
1058
+
1059
+
1060
+ asyncio.run(main())
1061
+ """
1062
+ _response = await self._raw_client.delete_contact_members(
1063
+ pid, member_contact_ids=member_contact_ids, request_options=request_options
1064
+ )
1065
+ return _response.data
1066
+
1067
+ async def subscribe_to_loyalty_program(
1068
+ self,
1069
+ pid: str,
1070
+ *,
1071
+ contact_id: int,
1072
+ creation_date: typing.Optional[str] = OMIT,
1073
+ loyalty_subscription_id: typing.Optional[str] = OMIT,
1074
+ request_options: typing.Optional[RequestOptions] = None,
1075
+ ) -> SubscribeToLoyaltyProgramResponse:
1076
+ """
1077
+ Subscribes to a loyalty program
1078
+
1079
+ Parameters
1080
+ ----------
1081
+ pid : str
1082
+ Loyalty Program ID. A unique identifier for the loyalty program.
1083
+
1084
+ contact_id : int
1085
+ Required contact ID; must be greater than 0.
1086
+
1087
+ creation_date : typing.Optional[str]
1088
+ Optional custom date-time format.
1089
+
1090
+ loyalty_subscription_id : typing.Optional[str]
1091
+ Optional subscription ID (max length 64).
1092
+
1093
+ request_options : typing.Optional[RequestOptions]
1094
+ Request-specific configuration.
1095
+
1096
+ Returns
1097
+ -------
1098
+ SubscribeToLoyaltyProgramResponse
1099
+ Successfully created subscription.
1100
+
1101
+ Examples
1102
+ --------
1103
+ import asyncio
1104
+
1105
+ from brevo import AsyncBrevo
1106
+
1107
+ client = AsyncBrevo(
1108
+ api_key="YOUR_API_KEY",
1109
+ )
1110
+
1111
+
1112
+ async def main() -> None:
1113
+ await client.program.subscribe_to_loyalty_program(
1114
+ pid="pid",
1115
+ contact_id=1,
1116
+ )
1117
+
1118
+
1119
+ asyncio.run(main())
1120
+ """
1121
+ _response = await self._raw_client.subscribe_to_loyalty_program(
1122
+ pid,
1123
+ contact_id=contact_id,
1124
+ creation_date=creation_date,
1125
+ loyalty_subscription_id=loyalty_subscription_id,
1126
+ request_options=request_options,
1127
+ )
1128
+ return _response.data