Package com.mailersend.sdk.webhooks

Class Webhooks

java.lang.Object

com.mailersend.sdk.webhooks.Webhooks

public class Webhooks
extends Object

Webhooks class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
Webhooks(MailerSend apiObjectRef)	Do not initialize directly.

Method Summary

Modifier and Type	Method	Description
WebhooksBuilder	builder()	Gets the builder that can be used to create or update webhooks
boolean	deleteWebhook(String webhookId)	Deletes a webhook
Webhook	getWebhook(String webhookId)	Gets a single webhook
WebhooksList	getWebhooks(String domainId)	Gets a list of webhooks
Webhooks	limit(int limit)	Set the results limit (10 - 100)
Webhooks	page(int page)	Set the page of the request

Methods inherited from class java.lang.Object

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

Constructor Detail

Webhooks

public Webhooks(MailerSend apiObjectRef)

Do not initialize directly. This should only be accessed from MailerSend.webhooks

Parameters:

apiObjectRef - a MailerSend object.

Method Detail

page

public Webhooks page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a Webhooks object.

limit

public Webhooks limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a Webhooks object.

builder

public WebhooksBuilder builder()

Gets the builder that can be used to create or update webhooks

Returns:

a WebhooksBuilder object.

getWebhooks

public WebhooksList getWebhooks(String domainId)
                         throws MailerSendException

Gets a list of webhooks

Parameters:

domainId - a String object.

Returns:

a WebhooksList object.

Throws:

MailerSendException

getWebhook

public Webhook getWebhook(String webhookId)
                   throws MailerSendException

Gets a single webhook

Parameters:

webhookId - a String object.

Returns:

a Webhook object.

Throws:

MailerSendException

deleteWebhook

public boolean deleteWebhook(String webhookId)
                      throws MailerSendException

Deletes a webhook

Parameters:

webhookId - a String object.

Returns:

a boolean.

Throws:

MailerSendException