Package com.mailersend.sms.webhooks

Class SmsWebhooks

java.lang.Object

com.mailersend.sms.webhooks.SmsWebhooks

public class SmsWebhooks
extends Object

SmsWebhooks class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SmsWebhooksBuilder	builder()	Gets the builder that can be used to create or update webhooks
boolean	deleteWebhook(String webhookId)	Deletes a webhook
SmsWebhook	getWebhook(String webhookId)	Gets a single webhook
SmsWebhookList	getWebhooks(String smsNumberId)	Gets a list of webhooks
SmsWebhooks	limit(int limit)	Set the results limit (10 - 100)
SmsWebhooksBuilder	newBuilder()	newBuilder.
SmsWebhooks	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

SmsWebhooks

public SmsWebhooks(MailerSend apiObjectRef)

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

Parameters:

apiObjectRef - a MailerSend object.

Method Detail

page

public SmsWebhooks page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a SmsWebhooks object.

limit

public SmsWebhooks limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a SmsWebhooks object.

getWebhooks

public SmsWebhookList getWebhooks(String smsNumberId)
                           throws MailerSendException

Gets a list of webhooks

Parameters:

smsNumberId - a String object.

Returns:

a SmsWebhookList object.

Throws:

MailerSendException

getWebhook

public SmsWebhook getWebhook(String webhookId)
                      throws MailerSendException

Gets a single webhook

Parameters:

webhookId - a String object.

Returns:

a SmsWebhook object.

Throws:

MailerSendException

deleteWebhook

public boolean deleteWebhook(String webhookId)
                      throws MailerSendException

Deletes a webhook

Parameters:

webhookId - a String object.

Returns:

a boolean.

Throws:

MailerSendException

builder

public SmsWebhooksBuilder builder()

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

Returns:

a SmsWebhooksBuilder object.

newBuilder

public SmsWebhooksBuilder newBuilder()

newBuilder.

Returns:

a SmsWebhooksBuilder object.