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