Package com.dnsimple.endpoints

Class Webhooks

java.lang.Object

com.dnsimple.endpoints.Webhooks

public class Webhooks
extends java.lang.Object

Provides access to the DNSimple Webhooks API.

See Also:

https://developer.dnsimple.com/v2/webhooks

Constructor Summary

Constructors

Constructor	Description
Webhooks(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
SimpleResponse<Webhook>	createWebhook(java.lang.Number account, java.lang.String url)	Create a webhook in the account.
EmptyResponse	deleteWebhook(java.lang.Number account, java.lang.Number webhookId)	Delete a webhook from the account.
SimpleResponse<Webhook>	getWebhook(java.lang.Number account, java.lang.Number webhookId)	Get a specific webhook associated to an account using the webhook's ID.
ListResponse<Webhook>	listWebhooks(java.lang.Number account)	Lists the webhooks in the account.
ListResponse<Webhook>	listWebhooks(java.lang.Number account, ListOptions options)	Lists the webhooks in the account.

Methods inherited from class java.lang.Object

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

Constructor Detail

Webhooks

public Webhooks(HttpEndpointClient client)

Method Detail

listWebhooks

public ListResponse<Webhook> listWebhooks(java.lang.Number account)

Lists the webhooks in the account.

Parameters:

account - The account ID

Returns:

The list webhooks response

See Also:

https://developer.dnsimple.com/v2/webhooks/#listWebhooks

listWebhooks

public ListResponse<Webhook> listWebhooks(java.lang.Number account,
                                          ListOptions options)

Lists the webhooks in the account.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list webhooks response

See Also:

https://developer.dnsimple.com/v2/webhooks/#listWebhooks

createWebhook

public SimpleResponse<Webhook> createWebhook(java.lang.Number account,
                                             java.lang.String url)

Create a webhook in the account.

Parameters:

account - The account ID

url - The url of the webhook

Returns:

The create webhook response

See Also:

https://developer.dnsimple.com/v2/webhooks/#createWebhook

getWebhook

public SimpleResponse<Webhook> getWebhook(java.lang.Number account,
                                          java.lang.Number webhookId)

Get a specific webhook associated to an account using the webhook's ID.

Parameters:

account - The account ID

webhookId - The webhook ID

Returns:

The get webhook response

See Also:

https://developer.dnsimple.com/v2/webhooks/#getWebhook

deleteWebhook

public EmptyResponse deleteWebhook(java.lang.Number account,
                                   java.lang.Number webhookId)

Delete a webhook from the account.

Parameters:

account - The account ID

webhookId - The webhook ID

Returns:

The delete webhook response

See Also:

https://developer.dnsimple.com/v2/webhooks/#deleteWebhook