| Package | Description |
|---|---|
| com.createsend | |
| com.createsend.util | |
| com.createsend.util.exceptions |
| Modifier and Type | Method and Description |
|---|---|
void |
Lists.activateWebhook(String webhookID)
Activates the specified webhook.
|
PagedResult<Subscriber> |
Segments.active()
Gets a paged collection of active subscribers within the specified segment.
|
PagedResult<Subscriber> |
Lists.active()
Gets a paged collection of active subscribers who have subscribed to the list.
|
PagedResult<Subscriber> |
Segments.active(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of active subscribers within the specified segment
since the provided date.
|
PagedResult<Subscriber> |
Lists.active(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of active subscribers who have subscribed to the list
since the provided date.
|
PagedResult<Subscriber> |
Segments.active(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of active subscribers within the specified segment.
|
PagedResult<Subscriber> |
Lists.active(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of active subscribers who have subscribed to the list.
|
String |
Administrators.add(Administrator person)
Adds an administrator to the account.
|
String |
People.add(PersonToAdd person)
Adds a person to the client.
|
String |
Subscribers.add(SubscriberToAdd subscriber)
Adds a single subscriber to the specified list
|
ImportResult |
Subscribers.addMany(SubscribersToAdd subscribers)
Import many subscribers into the specified list
|
void |
Segments.addRule(Rule rule)
Adds a new rule to an existing list segment
|
Administrator[] |
General.administrators() |
PagedResult<Subscriber> |
Lists.bounced()
Gets a paged collection of bounced subscribers who have bounced out of the list.
|
PagedResult<Subscriber> |
Lists.bounced(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of bounced subscribers who have bounced out of the list
since the provided date.
|
PagedResult<Subscriber> |
Lists.bounced(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of bounced subscribers who have bounced out of the list.
|
PagedResult<Subscriber> |
Campaigns.bounces()
Gets a paged list of bounces for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.bounces(Date bouncesFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of bounces for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.bounces(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of bounces for the specified campaign
|
PagedResult<CampaignClick> |
Campaigns.clicks()
Gets a paged list of clicks for the specified campaign
|
PagedResult<CampaignClick> |
Campaigns.clicks(Date clicksFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of clicks for the specified campaign
|
PagedResult<CampaignClick> |
Campaigns.clicks(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of clicks for the specified campaign
|
String |
Clients.create(Client client)
Creates a new client based on the provided data.
|
String |
Campaigns.create(String clientID,
CampaignForCreation campaign)
Creates a new campaign for the specified client based on the provided campaign data.
|
String |
Lists.create(String clientID,
List list)
Creates a new empty subscriber list.
|
String |
Segments.create(String listID,
Segment segment)
Creates a new segment on the specified list.
|
String |
Templates.create(String clientID,
TemplateForCreate template)
Creates a new template for the specified client.
|
String |
Lists.createCustomField(CustomFieldForCreate customField)
Creates a new custom field with the specified data
|
String |
Campaigns.createFromTemplate(String clientID,
CampaignForCreationFromTemplate campaign)
Creates a new campaign for the specified client, based on the template
and campaign data specified.
|
String |
Lists.createWebhook(Webhook webhook)
Creates a new webhook on the specified list.
|
CustomField[] |
Lists.customFields()
Gets the custom fields available for the list with the specified ID
|
void |
Lists.deactivateWebhook(String webhookID)
Deactivates the specified webhook.
|
void |
Templates.delete()
Deletes the template with the current ID
|
void |
Segments.delete()
Deletes the specified segment.
|
void |
Lists.delete()
Deletes the list with the specified ID
|
void |
Clients.delete()
Deletes the current client
|
void |
Campaigns.delete()
Deletes the specified draft campaign
|
void |
Subscribers.delete(String emailAddress)
Moves the given email address into the deleted list
|
void |
People.delete(String emailAddress)
Deletes the person with the specified email address from the client
|
void |
Administrators.delete(String emailAddress)
Deletes the administrator with the specified email address from this account
|
void |
Lists.deleteCustomField(String fieldKey)
Deletes the custom field with the specified key
|
PagedResult<Subscriber> |
Lists.deleted()
Gets a paged collection of subscribers who have been deleted from the list.
|
PagedResult<Subscriber> |
Lists.deleted(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of subscribers who have been deleted from the list
since the provided date.
|
PagedResult<Subscriber> |
Lists.deleted(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of subscribers who have been deleted from the list.
|
void |
Segments.deleteRules()
Deletes all rules from the specifed segment
|
void |
Lists.deleteWebhook(String webhookID)
Deletes the specified webhook
|
Segment |
Segments.details()
Gets the details of the specified segment, including all rules and the current number of
active subscribers.
|
List |
Lists.details()
Gets the details of the list with the given ID
|
AllClientDetails |
Clients.details()
Gets the details of the current client
|
Subscriber |
Subscribers.details(String emailAddress)
Gets the details for the subscriber with the given email address in the specified list
|
Person |
People.details(String emailAddress)
Gets the details for the person with the given email address
|
Administrator |
Administrators.details(String emailAddress)
Gets the details for the administrator with the given email address
|
DraftCampaign[] |
Clients.draftCampaigns()
Gets all draft campaigns created for the current client
|
EmailClient[] |
Campaigns.emailClientUsage()
Gets the email clients that subscribers used to open the campaign
|
static OAuthTokenDetails |
General.exchangeToken(int clientID,
String clientSecret,
String redirectUri,
String code)
Exchange a provided OAuth code for an OAuth access token, 'expires in'
value, and refresh token.
|
TemplateDetails |
Templates.get()
Gets the details of the current template
|
String |
General.getAPIKey(String siteAddress,
String username,
String password)
Gets the API Key to use with the given authentication data
|
BillingDetails |
General.getBillingDetails() |
ClientBasics[] |
General.getClients() |
String[] |
General.getCountries() |
String |
General.getExternalSessionUrl(ExternalSessionOptions sessionOptions)
Get a URL which initiates a new external session for the user with the
given email.
|
String |
General.getPrimaryContact() |
String |
Clients.getPrimaryContact()
looks up the primary contact for this client
|
Date |
General.getSystemDate() |
String[] |
General.getTimezones() |
HistoryItem[] |
Subscribers.history(String emailAddress)
Gets the complete history for a given subscriber in the specified list
|
ListBasics[] |
Clients.lists()
Gets all lists for the current client
|
ListsAndSegments |
Campaigns.listsAndSegments()
Gets the lists and segments that a campaign is to be, or has been sent to.
|
ListForEmail[] |
Clients.listsForEmailAddress(String emailAddress)
Gets the lists across a client, to which a subscriber with a particular
email address belongs.
|
PagedResult<CampaignOpen> |
Campaigns.opens()
Gets a paged list of opens for the specified campaign
|
PagedResult<CampaignOpen> |
Campaigns.opens(Date opensFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of opens for the specified campaign
|
PagedResult<CampaignOpen> |
Campaigns.opens(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of opens for the specified campaign
|
Person[] |
Clients.people()
returns a list of people associated with the client.
|
PagedResult<Subscriber> |
Campaigns.recipients(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of recipients for the specified campaign
|
OAuthTokenDetails |
CreateSendBase.refreshToken()
Refresh the current OAuth token using the current refresh token.
|
ScheduledCampaign[] |
Clients.scheduledCampaigns()
Gets all campaigns scheduled to tbe sent by the current client
|
Segment[] |
Lists.segments()
Gets the segments available in the list with the specified ID
|
Segment[] |
Clients.segments()
Gets all segments defined for the current client
|
void |
Campaigns.send(String confirmationEmail,
Date sendDate)
Sends an existing draft campaign using the provided confirmation email and send date.
|
SentCampaign[] |
Clients.sentCampaigns()
Gets all campaigns sent by the current client
|
void |
Clients.setBasics(Client client)
Sets the basic details for the current client.
|
void |
Clients.setMonthlyBilling(BillingDetails billing)
Sets a client to be billed monthly based on the current number of active subscribers across
all lists.
|
void |
Clients.setPaygBilling(BillingDetails billing)
Sets a client to be billed per campaign sent.
|
void |
General.setPrimaryContact(String emailAddress) |
void |
Clients.setPrimaryContact(String emailAddress)
sets the primary contact for this client to the person with the specified email address
|
PagedResult<Subscriber> |
Campaigns.spamComplaints()
Gets a paged list of spam complaints for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.spamComplaints(Date spamComplaintsFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of spam complaints for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.spamComplaints(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of spam complaints for the specified campaign
|
Statistics |
Lists.stats()
Gets subscriber statistics for the list with the specified ID
|
CampaignSummary |
Campaigns.summary()
Get summary reporting data for the specified campaign
|
void |
Clients.suppress(SuppressionDetails details) |
PagedResult<SuppressedSubscriber> |
Clients.suppressionList(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of subscribers who are suppressed from the current clients lists.
|
Template[] |
Clients.templates()
Gets all templates defined for the current client.
|
void |
Campaigns.test(PreviewData data)
Sends a preview of an existing draft campaign to the recipients specified in the preview data.
|
void |
Lists.testWebhook(String webhookID)
Tests the specified webhook
|
CreditsTransferResult |
Clients.transferCredits(CreditsTransferDetails details)
Transfer credits to or from this client.
|
PagedResult<Subscriber> |
Lists.unconfirmed()
Gets a paged collection of unconfirmed subscribers who have subscribed to the list.
|
PagedResult<Subscriber> |
Lists.unconfirmed(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of unconfirmed subscribers who have subscribed to the list
since the provided date.
|
PagedResult<Subscriber> |
Lists.unconfirmed(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of unconfirmed subscribers who have subscribed to the list.
|
void |
Campaigns.unschedule()
Unschedules a campaign and moves it back to the drafts.
|
void |
Subscribers.unsubscribe(String emailAddress)
Unsubscribes the given email address from the specified list
|
PagedResult<Subscriber> |
Lists.unsubscribed()
Gets a paged collection of unsubscribed subscribers who have unsubscribed from the list.
|
PagedResult<Subscriber> |
Lists.unsubscribed(Date subscribedFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of unsubscribed subscribers who have unsubscribed from the list
since the provided date.
|
PagedResult<Subscriber> |
Lists.unsubscribed(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged collection of unsubscribed subscribers who have unsubscribed from the list.
|
PagedResult<Subscriber> |
Campaigns.unsubscribes()
Gets a paged list of unsubscribes for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.unsubscribes(Date unsubscribesFrom,
Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of unsubscribes for the specified campaign
|
PagedResult<Subscriber> |
Campaigns.unsubscribes(Integer page,
Integer pageSize,
String orderField,
String orderDirection)
Gets a paged list of unsubscribes for the specified campaign
|
void |
Clients.unsuppress(String email) |
void |
Lists.update(ListForUpdate list)
Updates the basic list details for an existing subscriber list
|
void |
Segments.update(Segment segment)
Updates an existing segment with the specified details
|
void |
Administrators.update(String originalEmailAddress,
Administrator newDetails)
Updates the details for an existing administrator
|
void |
People.update(String originalEmailAddress,
Person newDetails)
Updates the details for an existing person
|
void |
Subscribers.update(String originalEmailAddress,
SubscriberToAdd newDetails)
Updates any provided information for an existing subscriber
|
void |
Templates.update(TemplateForCreate template)
Updates a template with the specified details
|
String |
Lists.updateCustomField(String fieldKey,
CustomFieldForUpdate customField)
Updates a new custom field.
|
void |
Lists.updateCustomFieldOptions(String fieldKey,
UpdateFieldOptions options)
Updates the available options for a Multi-Valued custom field.
|
Webhook[] |
Lists.webhooks()
Gets all webhooks which have been attached to events on the specified list
|
| Modifier and Type | Method and Description |
|---|---|
void |
JerseyClientImpl.delete(javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements)
Makes a HTTP DELETE request to the specified path with the specified query string
|
void |
JerseyClient.delete(javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements) |
void |
JerseyClientImpl.delete(String... pathElements)
Makes a HTTP DELETE request to the specified path
|
void |
JerseyClient.delete(String... pathElements) |
<T> T |
JerseyClientImpl.get(Class<T> klass,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClient.get(Class<T> klass,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClientImpl.get(Class<T> klass,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
ResourceFactory resourceFactory,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClientImpl.get(Class<T> klass,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
ResourceFactory resourceFactory,
String... pathElements) |
<T> T |
JerseyClient.get(Class<T> klass,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
ResourceFactory resourceFactory,
String... pathElements) |
<T> T |
JerseyClientImpl.get(Class<T> klass,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements)
Performs a HTTP GET on the route specified by the pathElements deserialising the
result to an instance of klass.
|
<T> T |
JerseyClient.get(Class<T> klass,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements) |
<T> T |
JerseyClientImpl.get(Class<T> klass,
String... pathElements)
Performs a HTTP GET on the route specified by the pathElements deserialising the
result to an instance of klass.
|
<T> T |
JerseyClient.get(Class<T> klass,
String... pathElements) |
<T> PagedResult<T> |
JerseyClientImpl.getPagedResult(Integer page,
Integer pageSize,
String orderField,
String orderDirection,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements)
Performs a HTTP GET on the route specified attempting to deserialise the
result to a paged result of the given type.
|
<T> PagedResult<T> |
JerseyClient.getPagedResult(Integer page,
Integer pageSize,
String orderField,
String orderDirection,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements) |
<T> T |
JerseyClientImpl.post(Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClient.post(Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClientImpl.post(Class<T> klass,
Object entity,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClient.post(Class<T> klass,
Object entity,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClientImpl.post(Class<T> klass,
Object entity,
String... pathElements)
Posts the provided entity to the url specified by the provided path elements.
|
<T> T |
JerseyClient.post(Class<T> klass,
Object entity,
String... pathElements) |
<T> T |
JerseyClientImpl.post(String baseUri,
Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClient.post(String baseUri,
Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClientImpl.post(String baseUri,
Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClient.post(String baseUri,
Class<T> klass,
Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
<T> T |
JerseyClientImpl.post(String baseUri,
Class<T> klass,
Object entity,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClient.post(String baseUri,
Class<T> klass,
Object entity,
javax.ws.rs.core.MediaType mediaType,
String... pathElements) |
<T> T |
JerseyClientImpl.post(String baseUri,
Class<T> klass,
Object entity,
String... pathElements) |
<T> T |
JerseyClient.post(String baseUri,
Class<T> klass,
Object entity,
String... pathElements) |
<T> T |
JerseyClientImpl.put(Class<T> klass,
Object entity,
String... pathElements) |
<T> T |
JerseyClient.put(Class<T> klass,
Object entity,
String... pathElements) |
void |
JerseyClientImpl.put(Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
void |
JerseyClient.put(Object entity,
ErrorDeserialiser<?> errorDeserialiser,
String... pathElements) |
void |
JerseyClientImpl.put(Object entity,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements) |
void |
JerseyClient.put(Object entity,
javax.ws.rs.core.MultivaluedMap<String,String> queryString,
String... pathElements) |
void |
JerseyClientImpl.put(Object entity,
String... pathElements)
Makes a HTTP PUT request to the path specified, using the provided entity as the
request body.
|
void |
JerseyClient.put(Object entity,
String... pathElements) |
| Modifier and Type | Class and Description |
|---|---|
class |
BadRequestException
An exception raised when the Campaign Monitor API responds with a 400 Bad Request
|
class |
CreateSendHttpException
An exception raised on any HTTP based error.
|
class |
ExpiredOAuthTokenException |
class |
NotFoundException
An exception raised when the API responds with a 404 Not Found
|
class |
ServerErrorException
An exception raised when the API responds with a 500 Server Error
|
class |
UnauthorisedException
An exception raised when the API responds with a 401 Unauthorized
|
Copyright © 2013. All Rights Reserved.