Summary: Methods | [Expand All]
public interface

HubSpotClient

org.mule.module.hubspot.client.HubSpotClient
Known Indirect Subclasses

Summary

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

Public Methods

public abstract HubSpotListAddContactToListResponse addExistingContactInAList (String accessToken, String userId, String listId, String contactId)

Parameters
accessToken
userId
listId
contactId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract String authenticate (String userId, Map<String, Object> headers)

Parameters
userId
headers
Throws
HubSpotConnectorException

public abstract Contact createContact (String accessToken, String userId, ContactProperties contactProperties)

Parameters
accessToken
userId
contactProperties
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract HubSpotList createContactList (String accessToken, String userId, HubSpotNewList list, List<HubSpotListFilters> filters)

Parameters
accessToken
userId
list
filters
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract CustomContactProperty createCustomProperty (String accessToken, String userId, CustomContactProperty contactProperty)

Parameters
accessToken
userId
contactProperty
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract CustomContactPropertyGroup createCustomPropertyGroup (String accessToken, String userId, CustomContactPropertyGroup customContactPropertyGroup)

Parameters
accessToken
userId
customContactPropertyGroup
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactDeleted deleteContact (String accessToken, String userId, String contactId)

Parameters
accessToken
userId
contactId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract void deleteCustomProperty (String accessToken, String userId, String contactPropertyName)

Parameters
accessToken
userId
contactPropertyName
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract void deleteCustomPropertyGroup (String accessToken, String userId, String groupName)

Parameters
accessToken
userId
groupName
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactList getAllContacts (String accessToken, String userId, String count, String contactOffset)

Parameters
accessToken
userId
count
contactOffset
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract List<CustomContactProperty> getAllCustomProperties (String accessToken, String userId)

Parameters
accessToken
userId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract Contact getContactByEmail (String accessToken, String userId, String contactEmail)

Parameters
accessToken
userId
contactEmail
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract Contact getContactById (String accessToken, String userId, String contactId)

Parameters
accessToken
userId
contactId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract Contact getContactByUserToken (String accessToken, String userId, String contactUserToken)

Parameters
accessToken
userId
contactUserToken
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract HubSpotList getContactListById (String accessToken, String userId, String listId)

Parameters
accessToken
userId
listId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactStatistics getContactStatistics (String accessToken, String userId)

Parameters
accessToken
userId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactQuery getContactsByQuery (String accessToken, String userId, String query, String count)

Parameters
accessToken
userId
query
count
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactList getContactsInAList (String accessToken, String userId, String listId, String count, String property, String offset)

Parameters
accessToken
userId
listId
count
property
offset
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract HubSpotListLists getContactsLists (String accessToken, String userId, String count, String offset)

Parameters
accessToken
userId
count
offset
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract CustomContactPropertyGroup getCustomPropertyGroup (String accessToken, String userId, String groupName)

Parameters
accessToken
userId
groupName
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract HubSpotListLists getDynamicContactLists (String accessToken, String userId, String count, String offset)

Parameters
accessToken
userId
count
offset
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract EmailSubscriptionStatus getEmailSubscriptionStatus (String accessToken, String userId, String hubId, String email)

Parameters
accessToken
userId
hubId
email
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract EmailSubscription getEmailSubscriptions (String accessToken, String userId, String hubId)

Parameters
accessToken
userId
hubId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract ContactList getRecentContacts (String accessToken, String userId, String count, String timeOffset, String contactOffset)

Parameters
accessToken
userId
count
timeOffset
contactOffset
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract void refreshToken (HubSpotCredentialsManager objectStoreCredentials, String userId)

Parameters
objectStoreCredentials
userId
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract void updateContact (String accessToken, String userId, String contactId, ContactProperties contactProperties)

Parameters
accessToken
userId
contactId
contactProperties
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract CustomContactProperty updateCustomProperty (String accessToken, String userId, String propertyName, CustomContactProperty contactProperty)

Parameters
accessToken
userId
propertyName
contactProperty
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract CustomContactPropertyGroup updateCustomPropertyGroup (String accessToken, String userId, String groupName, CustomContactPropertyGroup customContactPropertyGroup)

Parameters
accessToken
userId
groupName
customContactPropertyGroup
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract EmailSubscriptionStatusResult updateEmailSubscriptionStatus (String accessToken, String userId, String hubId, String email, List<EmailSubscriptionStatusStatuses> statuses)

Parameters
accessToken
userId
hubId
email
statuses
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException

public abstract EmailSubscriptionStatusResult updateEmailSubscriptionStatusUnsubscribeFromAll (String accessToken, String userId, String hubId, String email)

Parameters
accessToken
userId
hubId
email
Throws
HubSpotConnectorAccessTokenExpiredException
HubSpotConnectorException
HubSpotConnectorNoAccessTokenException