PHP Class PayPal\Api\WebhookEventType

Contains the information for a Webhooks event-type
Inheritance: extends PayPal\Common\PayPalResourceModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
availableEventTypes ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : WebhookEventTypeList Lists available events to which any webhook can subscribe. For a list of supported events, see Webhook events.
getDescription ( ) : string A human-readable description of the event.
getName ( ) : string The unique event name.
getStatus ( ) : string The status of a webhook event.
setDescription ( string $description ) A human-readable description of the event.
setName ( string $name ) The unique event name.
setStatus ( string $status ) The status of a webhook event.
subscribedEventTypes ( string $webhookId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : WebhookEventTypeList Lists event subscriptions for a webhook, by ID.

Method Details

availableEventTypes() public static method

Lists available events to which any webhook can subscribe. For a list of supported events, see Webhook events.
public static availableEventTypes ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : WebhookEventTypeList
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return WebhookEventTypeList

getDescription() public method

A human-readable description of the event.
public getDescription ( ) : string
return string

getName() public method

The unique event name.
public getName ( ) : string
return string

getStatus() public method

The status of a webhook event.
public getStatus ( ) : string
return string

setDescription() public method

A human-readable description of the event.
public setDescription ( string $description )
$description string

setName() public method

The unique event name.
public setName ( string $name )
$name string

setStatus() public method

The status of a webhook event.
public setStatus ( string $status )
$status string

subscribedEventTypes() public static method

Lists event subscriptions for a webhook, by ID.
public static subscribedEventTypes ( string $webhookId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : WebhookEventTypeList
$webhookId string
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
return WebhookEventTypeList