Class StubBrevoSynchronisationService

java.lang.Object

ch.tocco.nice2.optional.newsletterbrevo.impl.BrevoSynchronisationServiceImpl

ch.tocco.nice2.optional.newsletterbrevo.impl.StubBrevoSynchronisationService

All Implemented Interfaces:

BrevoSynchronisationService

@ConditionalOnExpression("'${spring.profiles.active}' != 'production' && ${nice2.brevo.disableTestSync:true}")
@Component
public class StubBrevoSynchronisationService
extends BrevoSynchronisationServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface BrevoSynchronisationService

BrevoSynchronisationService.AttributePath, BrevoSynchronisationService.AttributeType, BrevoSynchronisationService.SimpleContact

Constructor Summary

Constructors

Constructor	Description
StubBrevoSynchronisationService(PersistenceService persistenceService, org.slf4j.Logger logger, QueryBuilderResultHelperService queryBuilderResultHelperService)

Method Summary

Modifier and Type	Method	Description
void	createAttribute(String name, BrevoSynchronisationService.AttributeType type, EntityList values)	creates a new attribute
void	deleteAttribute(String name, BrevoSynchronisationService.AttributeType type)	delete an attribute
void	getAllContacts(long batchSize, Consumer<Tuple2<Long, List<BrevoSynchronisationService.SimpleContact>>> contactConsumer)	This method will retrieve all contacts of the current brevo account.
List<String>	getAttributes()
brevoModel.GetExtendedContactDetails	getContactInfo(String email)	Returns the contact details for a given email address
void	importUsers(long listId, Condition synchronisationCondition, List<BrevoSynchronisationService.AttributePath> attributes)	Import users to brevo.
void	removeUsersFromList(long listId, Condition synchronisationCondition)
long	synchroniseFolder(Entity folder)	Synchronises a tocco folder to brevo.
long	synchroniseList(long folderId, Entity newsletterCategory)	Synchronises a newsletter category with brevo.
void	updateAttribute(String name, BrevoSynchronisationService.AttributeType type, EntityList values)	update attribute, only useful for category attributes, others need to be deleted and recreated for changes
void	updateBlocklists(String email, List<String> selectedBlocklists)	update blocklist entries in brevo make sure that the email address exist in Brevo before updating it, see BrevoSynchronisationService.isEmailAddressInUse(String)
void	updateEmailAddresses(Map<String,String> changes)	update email addresses in brevo make sure that the email addresses exist in Brevo before updating them, see BrevoSynchronisationService.isEmailAddressInUse(String)

Methods inherited from class BrevoSynchronisationServiceImpl

isEmailAddressInUse, normalizeAttributeName, setImportLimit, setRemoveFromListLimit

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StubBrevoSynchronisationService

public StubBrevoSynchronisationService(PersistenceService persistenceService,
 org.slf4j.Logger logger,
 QueryBuilderResultHelperService queryBuilderResultHelperService)

Method Details

synchroniseFolder

public long synchroniseFolder(Entity folder)

Description copied from interface: BrevoSynchronisationService

Synchronises a tocco folder to brevo.

Specified by:

synchroniseFolder in interface BrevoSynchronisationService

Overrides:

synchroniseFolder in class BrevoSynchronisationServiceImpl

Parameters:

folder - the brevo folder entity to be synchronised

Returns:

id of the folder in brevo

synchroniseList

public long synchroniseList(long folderId,
 Entity newsletterCategory)

Description copied from interface: BrevoSynchronisationService

Synchronises a newsletter category with brevo. Newsletter categories are mapped to lists in brevo.

Specified by:

synchroniseList in interface BrevoSynchronisationService

Overrides:

synchroniseList in class BrevoSynchronisationServiceImpl

Parameters:

folderId - the folder id to be used to create new newsletter categories

newsletterCategory - the newsletter category to be synchronised

Returns:

id of the list in brevo

importUsers

public void importUsers(long listId,
 Condition synchronisationCondition,
 List<BrevoSynchronisationService.AttributePath> attributes)

Description copied from interface: BrevoSynchronisationService

Import users to brevo. Users are transformed to "contacts" and then imported to brevo using the import endpoint. The import endpoint handles creating / updating users and maps users using the email address.

Specified by:

importUsers in interface BrevoSynchronisationService

Overrides:

importUsers in class BrevoSynchronisationServiceImpl

Parameters:

listId - the list id to which the users should be added.

synchronisationCondition - query builder condition to be used to select the users to be synchronised

removeUsersFromList

public void removeUsersFromList(long listId,
 Condition synchronisationCondition)

Specified by:

removeUsersFromList in interface BrevoSynchronisationService

Overrides:

removeUsersFromList in class BrevoSynchronisationServiceImpl

getAttributes

public List<String> getAttributes()

Specified by:

getAttributes in interface BrevoSynchronisationService

Overrides:

getAttributes in class BrevoSynchronisationServiceImpl

Returns:

names of all attributes configured in brevo

createAttribute

public void createAttribute(String name,
 BrevoSynchronisationService.AttributeType type,
 EntityList values)

Description copied from interface: BrevoSynchronisationService

creates a new attribute

Specified by:

createAttribute in interface BrevoSynchronisationService

Overrides:

createAttribute in class BrevoSynchronisationServiceImpl

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

values - the Brevo_attribute_value entities the attribute can take, only relevant for category attributes

updateAttribute

public void updateAttribute(String name,
 BrevoSynchronisationService.AttributeType type,
 EntityList values)

Description copied from interface: BrevoSynchronisationService

update attribute, only useful for category attributes, others need to be deleted and recreated for changes

Specified by:

updateAttribute in interface BrevoSynchronisationService

Overrides:

updateAttribute in class BrevoSynchronisationServiceImpl

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

values - the Brevo_attribute_value entities the attribute can take, only relevant for category attributes

deleteAttribute

public void deleteAttribute(String name,
 BrevoSynchronisationService.AttributeType type)

Description copied from interface: BrevoSynchronisationService

delete an attribute

Specified by:

deleteAttribute in interface BrevoSynchronisationService

Overrides:

deleteAttribute in class BrevoSynchronisationServiceImpl

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

updateEmailAddresses

public void updateEmailAddresses(Map<String,String> changes)

Description copied from interface: BrevoSynchronisationService

update email addresses in brevo make sure that the email addresses exist in Brevo before updating them, see BrevoSynchronisationService.isEmailAddressInUse(String)

Specified by:

updateEmailAddresses in interface BrevoSynchronisationService

Overrides:

updateEmailAddresses in class BrevoSynchronisationServiceImpl

Parameters:

changes - a map containing the current email addresses as keys, and the new email addresses as values

updateBlocklists

public void updateBlocklists(String email,
 List<String> selectedBlocklists)

Description copied from interface: BrevoSynchronisationService

update blocklist entries in brevo make sure that the email address exist in Brevo before updating it, see BrevoSynchronisationService.isEmailAddressInUse(String)

Specified by:

updateBlocklists in interface BrevoSynchronisationService

Overrides:

updateBlocklists in class BrevoSynchronisationServiceImpl

Parameters:

email - the email for which the blocklist entries should be updated

selectedBlocklists - a list of strings of the selected blocklist unique_ids (possible values: "email", "sms")

getContactInfo

public brevoModel.GetExtendedContactDetails getContactInfo(String email)

Description copied from interface: BrevoSynchronisationService

Returns the contact details for a given email address

Specified by:

getContactInfo in interface BrevoSynchronisationService

Overrides:

getContactInfo in class BrevoSynchronisationServiceImpl

getAllContacts

public void getAllContacts(long batchSize,
 Consumer<Tuple2<Long, List<BrevoSynchronisationService.SimpleContact>>> contactConsumer)

Description copied from interface: BrevoSynchronisationService

This method will retrieve all contacts of the current brevo account. It uses paging and will call the consumer with each "page".

Specified by:

getAllContacts in interface BrevoSynchronisationService

Overrides:

getAllContacts in class BrevoSynchronisationServiceImpl

Parameters:

batchSize - the batch size to use when retrieving all contacts.

contactConsumer - the consumer that processes the batches. It consumes a tuple containing the count (all contacts) and the current page of contacts.