/**
* Tests the specified webhook
*
* @param webhookID The ID of the webhook
* @throws CreateSendException Thrown when the API responds with HTTP Status >= 400. I.e the test
* fails
* @see <a href="http://www.campaignmonitor.com/api/lists/#testing_a_webhook" target="_blank">
* Testing a webhook</a>
*/
public void testWebhook(String webhookID) throws CreateSendException {
client.get(
String.class,
new ErrorDeserialiser<WebhookTestFailureDetails>(),
"lists",
listID,
"webhooks",
webhookID,
"test.json");
}
/**
* Gets all webhooks which have been attached to events on the specified list
*
* @return The webhooks which have been attached to events for the specified list
* @throws CreateSendException Thrown when the API responds with HTTP Status >= 400
* @see <a href="http://www.campaignmonitor.com/api/lists/#getting_list_webhooks" target="_blank">
* Getting list webhooks</a>
*/
public Webhook[] webhooks() throws CreateSendException {
return client.get(Webhook[].class, "lists", listID, "webhooks.json");
}
/**
* Gets the segments available in the list with the specified ID
*
* @return The segments available in the specified list
* @throws CreateSendException Raised when the API responds with HTTP Status >= 400
* @see <a href="http://www.campaignmonitor.com/api/lists/#getting_list_segments" target="_blank">
* Getting list segments</a>
*/
public Segment[] segments() throws CreateSendException {
return client.get(Segment[].class, "lists", listID, "segments.json");
}
/**
* Gets the custom fields available for the list with the specified ID
*
* @return The custom fields available for the specified list
* @throws CreateSendException Raised when the API responds with HTTP Status >= 400
* @see <a href="http://www.campaignmonitor.com/api/lists/#getting_list_custom_fields"
* target="_blank"> Getting list custom fields</a>
*/
public CustomField[] customFields() throws CreateSendException {
return client.get(CustomField[].class, "lists", listID, "customfields.json");
}
/**
* Gets subscriber statistics for the list with the specified ID
*
* @return Subscriber statistics for the list with the specified ID
* @throws CreateSendException Raised when the API responds with HTTP status >= 400
* @see <a href="http://www.campaignmonitor.com/api/lists/#getting_list_stats" target="_blank">
* Getting list stats</a>
*/
public Statistics stats() throws CreateSendException {
return client.get(Statistics.class, "lists", listID, "stats.json");
}
/**
* Gets the details of the list with the given ID
*
* @return The details of the list with the given ID
* @throws CreateSendException Raised when the API returns a HTTP Status >= 400
* @see <a href="http://www.campaignmonitor.com/api/lists/#getting_list_details" target="_blank">
* Getting list details</a>
*/
public List details() throws CreateSendException {
return client.get(List.class, "lists", listID + ".json");
}