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