org.mule.module.hubspot.client

Interface HubSpotClient

All Known Implementing Classes:

HubSpotClientImpl

public interface HubSpotClient

Method Summary

Methods

Modifier and Type	Method and Description
HubSpotListAddContactToListResponse	addExistingContactInAList(String accessToken, String userId, String listId, String contactId)
String	authenticate(String userId, Map<String,Object> headers)
Contact	createContact(String accessToken, String userId, ContactProperties contactProperties)
HubSpotList	createContactList(String accessToken, String userId, HubSpotNewList list, List<HubSpotListFilters> filters)
CustomContactProperty	createCustomProperty(String accessToken, String userId, CustomContactProperty contactProperty)
CustomContactPropertyGroup	createCustomPropertyGroup(String accessToken, String userId, CustomContactPropertyGroup customContactPropertyGroup)
ContactDeleted	deleteContact(String accessToken, String userId, String contactId)
void	deleteCustomProperty(String accessToken, String userId, String contactPropertyName)
void	deleteCustomPropertyGroup(String accessToken, String userId, String groupName)
ContactList	getAllContacts(String accessToken, String userId, String count, String contactOffset)
List<CustomContactProperty>	getAllCustomProperties(String accessToken, String userId)
Contact	getContactByEmail(String accessToken, String userId, String contactEmail)
Contact	getContactById(String accessToken, String userId, String contactId)
Contact	getContactByUserToken(String accessToken, String userId, String contactUserToken)
HubSpotList	getContactListById(String accessToken, String userId, String listId)
ContactQuery	getContactsByQuery(String accessToken, String userId, String query, String count)
ContactList	getContactsInAList(String accessToken, String userId, String listId, String count, String property, String offset)
HubSpotListLists	getContactsLists(String accessToken, String userId, String count, String offset)
ContactStatistics	getContactStatistics(String accessToken, String userId)
CustomContactPropertyGroup	getCustomPropertyGroup(String accessToken, String userId, String groupName)
HubSpotListLists	getDynamicContactLists(String accessToken, String userId, String count, String offset)
EmailSubscription	getEmailSubscriptions(String accessToken, String userId, String hubId)
EmailSubscriptionStatus	getEmailSubscriptionStatus(String accessToken, String userId, String hubId, String email)
ContactList	getRecentContacts(String accessToken, String userId, String count, String timeOffset, String contactOffset)
void	refreshToken(HubSpotCredentialsManager objectStoreCredentials, String userId)
void	updateContact(String accessToken, String userId, String contactId, ContactProperties contactProperties)
CustomContactProperty	updateCustomProperty(String accessToken, String userId, String propertyName, CustomContactProperty contactProperty)
CustomContactPropertyGroup	updateCustomPropertyGroup(String accessToken, String userId, String groupName, CustomContactPropertyGroup customContactPropertyGroup)
EmailSubscriptionStatusResult	updateEmailSubscriptionStatus(String accessToken, String userId, String hubId, String email, List<EmailSubscriptionStatusStatuses> statuses)
EmailSubscriptionStatusResult	updateEmailSubscriptionStatusUnsubscribeFromAll(String accessToken, String userId, String hubId, String email)

Method Detail

authenticate

String authenticate(String userId,
                  Map<String,Object> headers)
                    throws HubSpotConnectorException

Throws:

HubSpotConnectorException

getAllContacts

ContactList getAllContacts(String accessToken,
                         String userId,
                         String count,
                         String contactOffset)
                           throws HubSpotConnectorException,
                                  HubSpotConnectorNoAccessTokenException,
                                  HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getRecentContacts

ContactList getRecentContacts(String accessToken,
                            String userId,
                            String count,
                            String timeOffset,
                            String contactOffset)
                              throws HubSpotConnectorException,
                                     HubSpotConnectorNoAccessTokenException,
                                     HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactById

Contact getContactById(String accessToken,
                     String userId,
                     String contactId)
                       throws HubSpotConnectorException,
                              HubSpotConnectorNoAccessTokenException,
                              HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactByEmail

Contact getContactByEmail(String accessToken,
                        String userId,
                        String contactEmail)
                          throws HubSpotConnectorException,
                                 HubSpotConnectorNoAccessTokenException,
                                 HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactByUserToken

Contact getContactByUserToken(String accessToken,
                            String userId,
                            String contactUserToken)
                              throws HubSpotConnectorException,
                                     HubSpotConnectorNoAccessTokenException,
                                     HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactsByQuery

ContactQuery getContactsByQuery(String accessToken,
                              String userId,
                              String query,
                              String count)
                                throws HubSpotConnectorException,
                                       HubSpotConnectorNoAccessTokenException,
                                       HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

deleteContact

ContactDeleted deleteContact(String accessToken,
                           String userId,
                           String contactId)
                             throws HubSpotConnectorException,
                                    HubSpotConnectorNoAccessTokenException,
                                    HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

updateContact

void updateContact(String accessToken,
                 String userId,
                 String contactId,
                 ContactProperties contactProperties)
                   throws HubSpotConnectorException,
                          HubSpotConnectorNoAccessTokenException,
                          HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

createContact

Contact createContact(String accessToken,
                    String userId,
                    ContactProperties contactProperties)
                      throws HubSpotConnectorException,
                             HubSpotConnectorNoAccessTokenException,
                             HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactStatistics

ContactStatistics getContactStatistics(String accessToken,
                                     String userId)
                                       throws HubSpotConnectorException,
                                              HubSpotConnectorNoAccessTokenException,
                                              HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactsLists

HubSpotListLists getContactsLists(String accessToken,
                                String userId,
                                String count,
                                String offset)
                                  throws HubSpotConnectorException,
                                         HubSpotConnectorNoAccessTokenException,
                                         HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactListById

HubSpotList getContactListById(String accessToken,
                             String userId,
                             String listId)
                               throws HubSpotConnectorException,
                                      HubSpotConnectorNoAccessTokenException,
                                      HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getDynamicContactLists

HubSpotListLists getDynamicContactLists(String accessToken,
                                      String userId,
                                      String count,
                                      String offset)
                                        throws HubSpotConnectorException,
                                               HubSpotConnectorNoAccessTokenException,
                                               HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getContactsInAList

ContactList getContactsInAList(String accessToken,
                             String userId,
                             String listId,
                             String count,
                             String property,
                             String offset)
                               throws HubSpotConnectorException,
                                      HubSpotConnectorNoAccessTokenException,
                                      HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

addExistingContactInAList

HubSpotListAddContactToListResponse addExistingContactInAList(String accessToken,
                                                            String userId,
                                                            String listId,
                                                            String contactId)
                                                              throws HubSpotConnectorException,
                                                                     HubSpotConnectorNoAccessTokenException,
                                                                     HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

createContactList

HubSpotList createContactList(String accessToken,
                            String userId,
                            HubSpotNewList list,
                            List<HubSpotListFilters> filters)
                              throws HubSpotConnectorException,
                                     HubSpotConnectorNoAccessTokenException,
                                     HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getEmailSubscriptions

EmailSubscription getEmailSubscriptions(String accessToken,
                                      String userId,
                                      String hubId)
                                        throws HubSpotConnectorException,
                                               HubSpotConnectorNoAccessTokenException,
                                               HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getEmailSubscriptionStatus

EmailSubscriptionStatus getEmailSubscriptionStatus(String accessToken,
                                                 String userId,
                                                 String hubId,
                                                 String email)
                                                   throws HubSpotConnectorException,
                                                          HubSpotConnectorNoAccessTokenException,
                                                          HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

updateEmailSubscriptionStatus

EmailSubscriptionStatusResult updateEmailSubscriptionStatus(String accessToken,
                                                          String userId,
                                                          String hubId,
                                                          String email,
                                                          List<EmailSubscriptionStatusStatuses> statuses)
                                                            throws HubSpotConnectorException,
                                                                   HubSpotConnectorNoAccessTokenException,
                                                                   HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

updateEmailSubscriptionStatusUnsubscribeFromAll

EmailSubscriptionStatusResult updateEmailSubscriptionStatusUnsubscribeFromAll(String accessToken,
                                                                            String userId,
                                                                            String hubId,
                                                                            String email)
                                                                              throws HubSpotConnectorException,
                                                                                     HubSpotConnectorNoAccessTokenException,
                                                                                     HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getAllCustomProperties

List<CustomContactProperty> getAllCustomProperties(String accessToken,
                                                 String userId)
                                                   throws HubSpotConnectorException,
                                                          HubSpotConnectorNoAccessTokenException,
                                                          HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

createCustomProperty

CustomContactProperty createCustomProperty(String accessToken,
                                         String userId,
                                         CustomContactProperty contactProperty)
                                           throws HubSpotConnectorException,
                                                  HubSpotConnectorNoAccessTokenException,
                                                  HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

updateCustomProperty

CustomContactProperty updateCustomProperty(String accessToken,
                                         String userId,
                                         String propertyName,
                                         CustomContactProperty contactProperty)
                                           throws HubSpotConnectorException,
                                                  HubSpotConnectorNoAccessTokenException,
                                                  HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

deleteCustomProperty

void deleteCustomProperty(String accessToken,
                        String userId,
                        String contactPropertyName)
                          throws HubSpotConnectorException,
                                 HubSpotConnectorNoAccessTokenException,
                                 HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

getCustomPropertyGroup

CustomContactPropertyGroup getCustomPropertyGroup(String accessToken,
                                                String userId,
                                                String groupName)
                                                  throws HubSpotConnectorException,
                                                         HubSpotConnectorNoAccessTokenException,
                                                         HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

createCustomPropertyGroup

CustomContactPropertyGroup createCustomPropertyGroup(String accessToken,
                                                   String userId,
                                                   CustomContactPropertyGroup customContactPropertyGroup)
                                                     throws HubSpotConnectorException,
                                                            HubSpotConnectorNoAccessTokenException,
                                                            HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

updateCustomPropertyGroup

CustomContactPropertyGroup updateCustomPropertyGroup(String accessToken,
                                                   String userId,
                                                   String groupName,
                                                   CustomContactPropertyGroup customContactPropertyGroup)
                                                     throws HubSpotConnectorException,
                                                            HubSpotConnectorNoAccessTokenException,
                                                            HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

deleteCustomPropertyGroup

void deleteCustomPropertyGroup(String accessToken,
                             String userId,
                             String groupName)
                               throws HubSpotConnectorException,
                                      HubSpotConnectorNoAccessTokenException,
                                      HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException

refreshToken

void refreshToken(HubSpotCredentialsManager objectStoreCredentials,
                String userId)
                  throws HubSpotConnectorException,
                         HubSpotConnectorNoAccessTokenException,
                         HubSpotConnectorAccessTokenExpiredException

Throws:

HubSpotConnectorException

HubSpotConnectorNoAccessTokenException

HubSpotConnectorAccessTokenExpiredException