Webiant Logo Webiant Logo
  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

BrevoDefaults.cs

using Nop.Core;
using Nop.Core.Caching;

namespace Nop.Plugin.Misc.Brevo;

/// 
/// Represents plugin constants
/// 
public static class BrevoDefaults
{
    /// 
    /// Gets a plugin system name
    /// 
    public static string SystemName => "Misc.Brevo";

    /// 
    /// Gets a plugin partner name
    /// 
    public static string PartnerName => "NOPCOMMERCE";

    /// 
    /// Gets a user agent used to request Brevo services
    /// 
    public static string UserAgent => $"nopCommerce-{NopVersion.CURRENT_VERSION}";

    /// 
    /// Gets a URL to edit message template on Brevo account
    /// 
    public static string EditMessageTemplateUrl => "https://my.brevo.com/camp/template/{0}/message-setup?tap_a=30591-fb13f0&tap_s=840216-5153c7";

    /// 
    /// Gets a name of the route to the import contacts callback
    /// 
    public static string ImportContactsRoute => "Plugin.Misc.Brevo.ImportContacts";

    /// 
    /// Gets a name of the route to the unsubscribe contact callback
    /// 
    public static string UnsubscribeContactRoute => "Plugin.Misc.Brevo.Unsubscribe";

    /// 
    /// Gets a name of the synchronization schedule task
    /// 
    public static string SynchronizationTaskName => "Synchronization (Brevo plugin)";

    /// 
    /// Gets a type of the synchronization schedule task
    /// 
    public static string SynchronizationTask => "Nop.Plugin.Misc.Brevo.Services.SynchronizationTask";

    /// 
    /// Gets a default synchronization period in hours
    /// 
    public static int DefaultSynchronizationPeriod => 12;

    /// 
    /// Gets a default synchronization limit of Lists
    /// 
    public static int DefaultSynchronizationListsLimit => 50;

    /// 
    /// Gets a header of the API key authorization: api-key
    /// 
    public static string ApiKeyHeader => "api-key";

    /// 
    /// Gets a header of the API key authorization: partner-key
    /// 
    public static string PartnerKeyHeader => "partner-key";

    /// 
    /// Gets a name of attribute to store an email
    /// 
    public static string EmailServiceAttribute => "EMAIL";

    /// 
    /// Gets a name of attribute to store a first name
    /// 
    public static string FirstNameServiceAttribute => "FIRSTNAME";

    /// 
    /// Gets a name of attribute to store a first name for French
    /// 
    public static string FirstNameFrenchServiceAttribute => "PRENOM";

    /// 
    /// Gets a name of attribute to store a first name for Italian
    /// 
    public static string FirstNameItalianServiceAttribute => "NOME";

    /// 
    /// Gets a name of attribute to store a first name for Spanish
    /// 
    public static string FirstNameSpanishServiceAttribute => "NOMBRE";

    /// 
    /// Gets a name of attribute to store a first name for German
    /// 
    public static string FirstNameGermanServiceAttribute => "VORNAME";

    /// 
    /// Gets a name of attribute to store a first name for Portuguese
    /// 
    public static string FirstNamePortugueseServiceAttribute => "NOME";

    /// 
    /// Gets a name of attribute to store a last name
    /// 
    public static string LastNameServiceAttribute => "LASTNAME";

    /// 
    /// Gets a name of attribute to store a last name for French
    /// 
    public static string LastNameFrenchServiceAttribute => "NOM";

    /// 
    /// Gets a name of attribute to store a last name for Italian
    /// 
    public static string LastNameItalianServiceAttribute => "COGNOME";

    /// 
    /// Gets a name of attribute to store a last name for Spanish
    /// 
    public static string LastNameSpanishServiceAttribute => "APELLIDO";

    /// 
    /// Gets a name of attribute to store a last name for German
    /// 
    public static string LastNameGermanServiceAttribute => "NAME";

    /// 
    /// Gets a name of attribute to store a last name for Portuguese
    /// 
    public static string LastNamePortugueseServiceAttribute => "SOBRENOME";

    /// 
    /// Gets a name of attribute to store a username
    /// 
    public static string UsernameServiceAttribute => "USERNAME";

    /// 
    /// Gets a name of attribute to store a phone
    /// 
    public static string PhoneServiceAttribute => "PHONE";

    /// 
    /// Gets a name of attribute to store a SMS
    /// 
    public static string SMSServiceAttribute => "SMS";

    /// 
    /// Gets a name of attribute to store a country
    /// 
    public static string CountryServiceAttribute => "COUNTRY";

    /// 
    /// Gets a name of attribute to store a gender
    /// 
    public static string GenderServiceAttribute => "GENDER";

    /// 
    /// Gets a name of attribute to store a date of birth
    /// 
    public static string DateOfBirthServiceAttribute => "DATE_OF_BIRTH";

    /// 
    /// Gets a name of attribute to store a company
    /// 
    public static string CompanyServiceAttribute => "COMPANY";

    /// 
    /// Gets a name of attribute to store a address 1
    /// 
    public static string Address1ServiceAttribute => "ADDRESS_1";

    /// 
    /// Gets a name of attribute to store a address 2
    /// 
    public static string Address2ServiceAttribute => "ADDRESS_2";

    /// 
    /// Gets a name of attribute to store a zip code
    /// 
    public static string ZipCodeServiceAttribute => "ZIP_CODE";

    /// 
    /// Gets a name of attribute to store a city
    /// 
    public static string CityServiceAttribute => "CITY";

    /// 
    /// Gets a name of attribute to store a zip code
    /// 
    public static string CountyServiceAttribute => "COUNTY";

    /// 
    /// Gets a name of attribute to store a zip code
    /// 
    public static string StateServiceAttribute => "STATE";

    /// 
    /// Gets a name of attribute to store a zip code
    /// 
    public static string FaxServiceAttribute => "FAX";

    /// 
    /// Gets a name of attribute to store a language
    /// 
    public static string LanguageAttribute => "LANGUAGE";

    /// 
    /// Gets a name of attribute to store a store identifier
    /// 
    public static string StoreIdServiceAttribute => "STORE_ID";

    /// 
    /// Gets a name of attribute to store an identifier
    /// 
    public static string IdServiceAttribute => "ID";

    /// 
    /// Gets a name of attribute to store an order identifier
    /// 
    public static string OrderIdServiceAttribute => "ORDER_ID";

    /// 
    /// Gets a name of attribute to store an order date
    /// 
    public static string OrderDateServiceAttribute => "ORDER_DATE";

    /// 
    /// Gets a name of attribute to store an order total
    /// 
    public static string OrderTotalServiceAttribute => "ORDER_PRICE";

    /// 
    /// Gets a name of attribute to store an order total sum
    /// 
    public static string OrderTotalSumServiceAttribute => "NOPCOMMERCE_CA_USER";

    /// 
    /// Gets a name of attribute to store an order total sum of month
    /// 
    public static string OrderTotalMonthSumServiceAttribute => "NOPCOMMERCE_LAST_30_DAYS_CA";

    /// 
    /// Gets a name of attribute to store an order count
    /// 
    public static string OrderCountServiceAttribute => "NOPCOMMERCE_ORDER_TOTAL";

    /// 
    /// Gets a name of attribute to store all orders total sum
    /// 
    public static string AllOrderTotalSumServiceAttribute => "NOPCOMMERCE_CA_TOTAL";

    /// 
    /// Gets a name of attribute to store all orders total sum of month
    /// 
    public static string AllOrderTotalMonthSumServiceAttribute => "NOPCOMMERCE_CA_LAST_30DAYS";

    /// 
    /// Gets a name of attribute to store all orders count
    /// 
    public static string AllOrderCountServiceAttribute => "NOPCOMMERCE_ORDERS_COUNT";

    /// 
    /// Gets a key of the attribute to store shopping cart identifier
    /// 
    public static string ShoppingCartGuidAttribute => "ShoppingCartGuid";

    /// 
    /// Gets a header of the marketing automation authentication key
    /// 
    public static string MarketingAutomationKeyHeader => "ma-key";

    /// 
    /// Gets the marketing automation services URL
    /// 
    public static string MarketingAutomationUrl => "https://in-automate.sendinblue.com/api/v2/";

    /// 
    /// Gets a key of the attribute to store template identifier
    /// 
    public static string TemplateIdAttribute => "TemplateId";

    /// 
    /// Gets a key of the attribute to store a value indicating whether to use SMS notification
    /// 
    public static string UseSmsAttribute => "UseSmsNotifications";

    /// 
    /// Gets a key of the attribute to store SMS text
    /// 
    public static string SmsTextAttribute => "SMSText";

    /// 
    /// Gets a key of the attribute to store phone type
    /// 
    public static string PhoneTypeAttribute => "PhoneTypeId";

    /// 
    /// Gets a name of custom email header 
    /// 
    public static string EmailCustomHeader => "X-Mailin-Tag";

    /// 
    /// Gets a name of the cart updated event
    /// 
    public static string CartUpdatedEventName => "cart_updated";

    /// 
    /// Gets a name of the cart deleted event
    /// 
    public static string CartDeletedEventName => "cart_deleted";

    /// 
    /// Gets a name of the order completed event
    /// 
    public static string OrderCompletedEventName => "order_completed";

    /// 
    /// Gets a key of cache synchronization
    /// 
    public static CacheKey SyncKeyCache => new("PLUGINS_MISC_BREVO_SYNCINFO");

    /// 
    /// Gets a key of notification message
    /// 
    public static string NotificationMessage => "Unfortunately, there’s been an error, feel free to reach our support team.";

    /// 
    /// Gets a token to place tracking identifier in the tracking script
    /// 
    public static string TrackingScriptId => "{TRACKING_ID}";

    /// 
    /// Gets a token to place customer email in the tracking script
    /// 
    public static string TrackingScriptCustomerEmail => "{CUSTOMER_EMAIL}";

    /// 
    /// Generic attribute name to hide general settings block on the plugin configuration page
    /// 
    public static string HideGeneralBlock => "BrevoPage.HideGeneralBlock";

    /// 
    /// Generic attribute name to hide synchronization block on the plugin configuration page
    /// 
    public static string HideSynchronizationBlock => "BrevoPage.HideSynchronizationBlock";

    /// 
    /// Generic attribute name to hide transactional block on the plugin configuration page
    /// 
    public static string HideTransactionalBlock => "BrevoPage.HideTransactionalBlock";

    /// 
    /// Generic attribute name to hide SMS block on the plugin configuration page
    /// 
    public static string HideSmsBlock => "BrevoPage.HideSmsBlock";

    /// 
    /// Generic attribute name to hide marketing automation block on the plugin configuration page
    /// 
    public static string HideMarketingAutomationBlock => "BrevoPage.HideMarketingAutomationBlock";
}