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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebhooksBuilderbuilder()Gets the builder that can be used to create or update webhooksbooleandeleteWebhook(String webhookId)Deletes a webhookWebhookgetWebhook(String webhookId)Gets a single webhookWebhooksListgetWebhooks(String domainId)Gets a list of webhooksWebhookslimit(int limit)Set the results limit (10 - 100)Webhookspage(int page)Set the page of the request
-
-
-
Constructor Detail
-
Webhooks
public Webhooks(MailerSend apiObjectRef)
Do not initialize directly. This should only be accessed from MailerSend.webhooks- Parameters:
apiObjectRef- aMailerSendobject.
-
-
Method Detail
-
page
public Webhooks page(int page)
Set the page of the request- Parameters:
page- a int.- Returns:
- a
Webhooksobject.
-
limit
public Webhooks limit(int limit)
Set the results limit (10 - 100)- Parameters:
limit- a int.- Returns:
- a
Webhooksobject.
-
builder
public WebhooksBuilder builder()
Gets the builder that can be used to create or update webhooks- Returns:
- a
WebhooksBuilderobject.
-
getWebhooks
public WebhooksList getWebhooks(String domainId) throws MailerSendException
Gets a list of webhooks- Parameters:
domainId- aStringobject.- Returns:
- a
WebhooksListobject. - Throws:
MailerSendException
-
getWebhook
public Webhook getWebhook(String webhookId) throws MailerSendException
Gets a single webhook- Parameters:
webhookId- aStringobject.- Returns:
- a
Webhookobject. - Throws:
MailerSendException
-
deleteWebhook
public boolean deleteWebhook(String webhookId) throws MailerSendException
Deletes a webhook- Parameters:
webhookId- aStringobject.- Returns:
- a boolean.
- Throws:
MailerSendException
-
-