Class WebhookService

java.lang.Object

com.easypost.service.WebhookService

public class WebhookService
extends Object

Method Summary

Modifier and Type	Method	Description
List<Webhook>	all()	Get a list of all Webhook objects.
List<Webhook>	all(Map<String,Object> params)	Get a list of all Webhook objects.
Webhook	create(Map<String,Object> params)	Create a Webhook object from a map of parameters.
void	delete(String id)	Delete this Webhook.
Webhook	retrieve(String id)	Retrieve a Webhook object from the API.
Webhook	update(String id)	Update this webhook.
Webhook	update(String id, Map<String,Object> params)	Update this webhook.

Methods inherited from class java.lang.Object

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

Method Details

create

public Webhook create(Map<String,Object> params)
               throws EasyPostException

Create a Webhook object from a map of parameters.

Parameters:

params - the map of parameters

Returns:

Webhook object

Throws:

EasyPostException - when the request fails.

retrieve

public Webhook retrieve(String id)
                 throws EasyPostException

Retrieve a Webhook object from the API.

Parameters:

id - the ID of the Webhook to retrieve

Returns:

Webhook object

Throws:

EasyPostException - when the request fails.

all

public List<Webhook> all()
                  throws EasyPostException

Get a list of all Webhook objects.

Returns:

List of Webhook objects.

Throws:

EasyPostException - when the request fails.

all

public List<Webhook> all(Map<String,Object> params)
                  throws EasyPostException

Get a list of all Webhook objects.

Parameters:

params - params for request

Returns:

List of Webhook objects.

Throws:

EasyPostException - when the request fails.

delete

public void delete(String id)
            throws EasyPostException

Delete this Webhook.

Parameters:

id - The ID of webhook.

Throws:

EasyPostException - when the request fails.

update

public Webhook update(String id)
               throws EasyPostException

Update this webhook.

Parameters:

id - The ID of webhook.

Returns:

Webhook object

Throws:

EasyPostException - when the request fails.

update

public Webhook update(String id,
 Map<String,Object> params)
               throws EasyPostException

Update this webhook.

Parameters:

id - The ID of webhook.

params - Map of parameters

Returns:

Webhook object

Throws:

EasyPostException - when the request fails.