com.paypal.api.payments

Class Event

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Event

public class Event
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Event() Default Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
static Event	get(APIContext apiContext, java.lang.String eventId) Retrieves the Webhooks event resource identified by event_id.
static Event	get(java.lang.String accessToken, java.lang.String eventId) Deprecated. Please use get(APIContext, String) instead.
java.lang.String	getCreateTime() Time the resource was created.
java.lang.String	getEventType() Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
java.lang.String	getId() Identifier of the Webhooks event resource.
java.util.List<Links>	getLinks() Hateoas links.
java.lang.Object	getResource() This contains the resource that is identified by resource_type element.
java.lang.String	getResourceType() Name of the resource contained in resource element.
java.lang.String	getSummary() A summary description of the event.
int	hashCode()
static EventList	list(APIContext apiContext, java.lang.String queryParams) Retrieves the list of Webhooks events resources for the application associated with token.
static EventList	list(java.lang.String accessToken, java.lang.String queryParams) Deprecated. Please use list(APIContext, String) instead.
Event	resend(APIContext apiContext) Resends the Webhooks event resource identified by event_id.
Event	resend(java.lang.String accessToken) Deprecated. Please use resend(APIContext) instead.
Event	setCreateTime(java.lang.String createTime) Time the resource was created.
Event	setEventType(java.lang.String eventType) Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
Event	setId(java.lang.String id) Identifier of the Webhooks event resource.
Event	setLinks(java.util.List<Links> links) Hateoas links.
Event	setResource(java.lang.Object resource) This contains the resource that is identified by resource_type element.
Event	setResourceType(java.lang.String resourceType) Name of the resource contained in resource element.
Event	setSummary(java.lang.String summary) A summary description of the event.
static boolean	validateReceivedEvent(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String requestBody) Validates received event received from PayPal to webhook endpoint set for particular webhook Id with PayPal trust source, to verify Data and Certificate integrity.

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

Event

public Event()

Default Constructor

Method Detail

get

@Deprecated
public static Event get(java.lang.String accessToken,
                                    java.lang.String eventId)
                             throws PayPalRESTException

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

Retrieves the Webhooks event resource identified by event_id. Can be used to retrieve the payload for an event.

Parameters:

accessToken - Access Token used for the API call.

eventId - String

Returns:

Event

Throws:

PayPalRESTException

get

public static Event get(APIContext apiContext,
                        java.lang.String eventId)
                 throws PayPalRESTException

Retrieves the Webhooks event resource identified by event_id. Can be used to retrieve the payload for an event.

Parameters:

apiContext - APIContext used for the API call.

eventId - String

Returns:

Event

Throws:

PayPalRESTException

resend

@Deprecated
public Event resend(java.lang.String accessToken)
                         throws PayPalRESTException

Deprecated. Please use resend(APIContext) instead.

Resends the Webhooks event resource identified by event_id.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Event

Throws:

PayPalRESTException

resend

public Event resend(APIContext apiContext)
             throws PayPalRESTException

Resends the Webhooks event resource identified by event_id.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Event

Throws:

PayPalRESTException

list

@Deprecated
public static EventList list(java.lang.String accessToken,
                                         java.lang.String queryParams)
                                  throws PayPalRESTException

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

Retrieves the list of Webhooks events resources for the application associated with token. The developers can use it to see list of past webhooks events.

Parameters:

accessToken - Access Token used for the API call.

Returns:

EventList

Throws:

PayPalRESTException

list

public static EventList list(APIContext apiContext,
                             java.lang.String queryParams)
                      throws PayPalRESTException

Retrieves the list of Webhooks events resources for the application associated with token. The developers can use it to see list of past webhooks events.

Parameters:

apiContext - APIContext used for the API call.

Returns:

EventList

Throws:

PayPalRESTException

validateReceivedEvent

public static boolean validateReceivedEvent(APIContext apiContext,
                                            java.util.Map<java.lang.String,java.lang.String> headers,
                                            java.lang.String requestBody)
                                     throws PayPalRESTException,
                                            java.security.InvalidKeyException,
                                            java.security.NoSuchAlgorithmException,
                                            java.security.SignatureException

Validates received event received from PayPal to webhook endpoint set for particular webhook Id with PayPal trust source, to verify Data and Certificate integrity. It validates both certificate chain, as well as data integrity.

Parameters:

apiContext - APIContext object

headers - Map of Headers received in the event, from request

requestBody - Request body received in the provided webhook

Returns:

true if valid, false otherwise

Throws:

PayPalRESTException

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

java.security.SignatureException

getId

public java.lang.String getId()

Identifier of the Webhooks event resource.

getCreateTime

public java.lang.String getCreateTime()

Time the resource was created.

getResourceType

public java.lang.String getResourceType()

Name of the resource contained in resource element.

getEventType

public java.lang.String getEventType()

Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.

getSummary

public java.lang.String getSummary()

A summary description of the event. E.g. A successful payment authorization was created for $$

getResource

public java.lang.Object getResource()

This contains the resource that is identified by resource_type element.

getLinks

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

Hateoas links.

setId

public Event setId(java.lang.String id)

Identifier of the Webhooks event resource.

Returns:

this

setCreateTime

public Event setCreateTime(java.lang.String createTime)

Time the resource was created.

Returns:

this

setResourceType

public Event setResourceType(java.lang.String resourceType)

Name of the resource contained in resource element.

Returns:

this

setEventType

public Event setEventType(java.lang.String eventType)

Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.

Returns:

this

setSummary

public Event setSummary(java.lang.String summary)

A summary description of the event. E.g. A successful payment authorization was created for $$

Returns:

this

setResource

public Event setResource(java.lang.Object resource)

This contains the resource that is identified by resource_type element.

Returns:

this

setLinks

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

Hateoas links.

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