com.paypal.api.payments

Class EventType

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.EventType

public class EventType
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
EventType() Default Constructor
EventType(java.lang.String name) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
static EventTypeList	availableEventTypes(APIContext apiContext) Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.
static EventTypeList	availableEventTypes(java.lang.String accessToken) Deprecated. Please use availableEventTypes(APIContext) instead.
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Human readable description of the event-type
java.lang.String	getName() Unique event-type name.
int	hashCode()
EventType	setDescription(java.lang.String description) Human readable description of the event-type
EventType	setName(java.lang.String name) Unique event-type name.
static EventTypeList	subscribedEventTypes(APIContext apiContext, java.lang.String webhookId) Retrieves the list of events-types subscribed by the given Webhook.
static EventTypeList	subscribedEventTypes(java.lang.String accessToken, java.lang.String webhookId) Deprecated. Please use subscribedEventTypes(APIContext, 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

EventType

public EventType()

Default Constructor

EventType

public EventType(java.lang.String name)

Parameterized Constructor

Method Detail

subscribedEventTypes

public static EventTypeList subscribedEventTypes(java.lang.String accessToken,
                                                 java.lang.String webhookId)
                                          throws PayPalRESTException

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

Retrieves the list of events-types subscribed by the given Webhook.

Parameters:

accessToken - Access Token used for the API call.

webhookId - String

Returns:

EventTypeList

Throws:

PayPalRESTException

subscribedEventTypes

public static EventTypeList subscribedEventTypes(APIContext apiContext,
                                                 java.lang.String webhookId)
                                          throws PayPalRESTException

Retrieves the list of events-types subscribed by the given Webhook.

Parameters:

apiContext - APIContext used for the API call.

webhookId - String

Returns:

EventTypeList

Throws:

PayPalRESTException

availableEventTypes

public static EventTypeList availableEventTypes(java.lang.String accessToken)
                                         throws PayPalRESTException

Deprecated. Please use availableEventTypes(APIContext) instead.

Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.

Parameters:

accessToken - Access Token used for the API call.

Returns:

EventTypeList

Throws:

PayPalRESTException

availableEventTypes

public static EventTypeList availableEventTypes(APIContext apiContext)
                                         throws PayPalRESTException

Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.

Parameters:

apiContext - APIContext used for the API call.

Returns:

EventTypeList

Throws:

PayPalRESTException

getName

public java.lang.String getName()

Unique event-type name.

getDescription

public java.lang.String getDescription()

Human readable description of the event-type

setName

public EventType setName(java.lang.String name)

Unique event-type name.

Returns:

this

setDescription

public EventType setDescription(java.lang.String description)

Human readable description of the event-type

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