com.paypal.api.payments

Class Webhook

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Webhook

public class Webhook
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Webhook() Default Constructor
Webhook(java.lang.String url, java.util.List<EventType> eventTypes) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
Webhook	create(APIContext apiContext, Webhook webhook) Subscribes your webhook listener to events.
Webhook	create(java.lang.String accessToken, Webhook webhook) Deprecated. Please use create(APIContext, Webhook) instead.
void	delete(APIContext apiContext, java.lang.String webhookId) Deletes a webhook, by ID.
void	delete(java.lang.String accessToken, java.lang.String webhookId) Deprecated. Please use delete(APIContext, String) instead.
boolean	equals(java.lang.Object o)
Webhook	get(APIContext apiContext, java.lang.String webhookId) Shows details for a webhook, by ID.
Webhook	get(java.lang.String accessToken, java.lang.String webhookId) Deprecated. Please use get(APIContext, String) instead.
java.util.List<EventType>	getEventTypes() A list of up to ten events to which to subscribe your webhook.
java.lang.String	getId() The ID of the webhook.
java.util.List<Links>	getLinks() The HATEOAS links related to this call.
java.lang.String	getUrl() The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.
int	hashCode()
Webhook	setEventTypes(java.util.List<EventType> eventTypes) A list of up to ten events to which to subscribe your webhook.
Webhook	setId(java.lang.String id) The ID of the webhook.
Webhook	setLinks(java.util.List<Links> links) The HATEOAS links related to this call.
Webhook	setUrl(java.lang.String url) The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.
Webhook	update(APIContext apiContext, java.lang.String webhookId, java.lang.String patchRequest) Replaces webhook fields with new values.
Webhook	update(java.lang.String accessToken, java.lang.String webhookId, java.lang.String patchRequest) Deprecated. Please use update(APIContext, String, String) instead.

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Webhook

public Webhook()

Default Constructor

Webhook

public Webhook(java.lang.String url,
               java.util.List<EventType> eventTypes)

Parameterized Constructor

Method Detail

create

@Deprecated
public Webhook create(java.lang.String accessToken,
                                  Webhook webhook)
                           throws PayPalRESTException

Deprecated. Please use create(APIContext, Webhook) instead.

Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use.

Parameters:

accessToken - Access Token used for the API call.

webhook - Webhook request

Returns:

Webhook

Throws:

PayPalRESTException

create

public Webhook create(APIContext apiContext,
                      Webhook webhook)
               throws PayPalRESTException

Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use.

Parameters:

apiContext - APIContext used for the API call.

webhook - Webhook request

Returns:

Webhook

Throws:

PayPalRESTException

get

@Deprecated
public Webhook get(java.lang.String accessToken,
                               java.lang.String webhookId)
                        throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Shows details for a webhook, by ID.

Parameters:

accessToken - Access Token used for the API call.

webhookId - Identifier of the webhook

Returns:

Webhook

Throws:

PayPalRESTException

get

public Webhook get(APIContext apiContext,
                   java.lang.String webhookId)
            throws PayPalRESTException

Shows details for a webhook, by ID.

Parameters:

apiContext - APIContext used for the API call.

webhookId - Identifier of the webhook

Returns:

Webhook

Throws:

PayPalRESTException

update

@Deprecated
public Webhook update(java.lang.String accessToken,
                                  java.lang.String webhookId,
                                  java.lang.String patchRequest)
                           throws PayPalRESTException

Deprecated. Please use update(APIContext, String, String) instead.

Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.

Parameters:

accessToken - Access Token used for the API call.

webhookId - Identifier of the webhook

patchRequest - patchRequest

Returns:

Webhook

Throws:

PayPalRESTException

update

public Webhook update(APIContext apiContext,
                      java.lang.String webhookId,
                      java.lang.String patchRequest)
               throws PayPalRESTException

Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Webhook

Throws:

PayPalRESTException

delete

@Deprecated
public void delete(java.lang.String accessToken,
                               java.lang.String webhookId)
                        throws PayPalRESTException

Deprecated. Please use delete(APIContext, String) instead.

Deletes a webhook, by ID.

Parameters:

accessToken - Access Token used for the API call.

webhookId - Identifier of the webhook

Throws:

PayPalRESTException

delete

public void delete(APIContext apiContext,
                   java.lang.String webhookId)
            throws PayPalRESTException

Deletes a webhook, by ID.

Parameters:

apiContext - APIContext used for the API call.

webhookId - Identifier of the webhook

Throws:

PayPalRESTException

getId

public java.lang.String getId()

The ID of the webhook.

getUrl

public java.lang.String getUrl()

The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.

getEventTypes

public java.util.List<EventType> getEventTypes()

A list of up to ten events to which to subscribe your webhook. To subscribe to all events including new events as they are added, specify the asterisk (`*`) wildcard. To replace the `event_types` array, specify the `*` wildcard. To see all supported events, [list available events](#available-event-type.list).

getLinks

public java.util.List<Links> getLinks()

The HATEOAS links related to this call.

setId

public Webhook setId(java.lang.String id)

The ID of the webhook.

Returns:

this

setUrl

public Webhook setUrl(java.lang.String url)

The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.

Returns:

this

setEventTypes

public Webhook setEventTypes(java.util.List<EventType> eventTypes)

A list of up to ten events to which to subscribe your webhook. To subscribe to all events including new events as they are added, specify the asterisk (`*`) wildcard. To replace the `event_types` array, specify the `*` wildcard. To see all supported events, [list available events](#available-event-type.list).

Returns:

this

setLinks

public Webhook setLinks(java.util.List<Links> links)

The HATEOAS links related to this call.

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel