Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mcoil.corals.io/vendor/paypal/rest-api-sdk-php/lib/PayPal/Api/ |
<?php
namespace PayPal\Api;
use PayPal\Common\PayPalResourceModel;
use PayPal\Exception\PayPalConnectionException;
use PayPal\Rest\ApiContext;
use PayPal\Transport\PayPalRestCall;
use PayPal\Validation\ArgumentValidator;
use PayPal\Validation\JsonValidator;
/**
* Class WebhookEvent
*
* Represents a Webhooks event
*
* @package PayPal\Api
*
* @property string id
* @property string create_time
* @property string resource_type
* @property string event_type
* @property string summary
* @property mixed resource
*/
class WebhookEvent extends PayPalResourceModel
{
/**
* Identifier of the Webhooks event resource.
*
* @param string $id
*
* @return $this
*/
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* Identifier of the Webhooks event resource.
*
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Time the resource was created.
*
* @param string $create_time
*
* @return $this
*/
public function setCreateTime($create_time)
{
$this->create_time = $create_time;
return $this;
}
/**
* Time the resource was created.
*
* @return string
*/
public function getCreateTime()
{
return $this->create_time;
}
/**
* Name of the resource contained in resource element.
*
* @param string $resource_type
*
* @return $this
*/
public function setResourceType($resource_type)
{
$this->resource_type = $resource_type;
return $this;
}
/**
* Name of the resource contained in resource element.
*
* @return string
*/
public function getResourceType()
{
return $this->resource_type;
}
/**
* Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
*
* @param string $event_type
*
* @return $this
*/
public function setEventType($event_type)
{
$this->event_type = $event_type;
return $this;
}
/**
* Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
*
* @return string
*/
public function getEventType()
{
return $this->event_type;
}
/**
* A summary description of the event. E.g. A successful payment authorization was created for $$
*
* @param string $summary
*
* @return $this
*/
public function setSummary($summary)
{
$this->summary = $summary;
return $this;
}
/**
* A summary description of the event. E.g. A successful payment authorization was created for $$
*
* @return string
*/
public function getSummary()
{
return $this->summary;
}
/**
* This contains the resource that is identified by resource_type element.
*
* @param \PayPal\Common\PayPalModel $resource
*
* @return $this
*/
public function setResource($resource)
{
$this->resource = $resource;
return $this;
}
/**
* This contains the resource that is identified by resource_type element.
*
* @return \PayPal\Common\PayPalModel
*/
public function getResource()
{
return $this->resource;
}
/**
* Validates Received Event from Webhook, and returns the webhook event object. Because security verifications by verifying certificate chain is not enabled in PHP yet,
* we need to fallback to default behavior of retrieving the ID attribute of the data, and make a separate GET call to PayPal APIs, to retrieve the data.
* This is important to do again, as hacker could have faked the data, and the retrieved data cannot be trusted without either doing client side security validation, or making a separate call
* to PayPal APIs to retrieve the actual data. This limits the hacker to mimick a fake data, as hacker wont be able to predict the Id correctly.
*
* NOTE: PLEASE DO NOT USE THE DATA PROVIDED IN WEBHOOK DIRECTLY, AS HACKER COULD PASS IN FAKE DATA. IT IS VERY IMPORTANT THAT YOU RETRIEVE THE ID AND MAKE A SEPARATE CALL TO PAYPAL API.
*
* @param string $body
* @param ApiContext $apiContext
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return WebhookEvent
* @throws \InvalidArgumentException if input arguments are incorrect, or Id is not found.
* @throws PayPalConnectionException if any exception from PayPal APIs other than not found is sent.
*/
public static function validateAndGetReceivedEvent($body, $apiContext = null, $restCall = null)
{
if ($body == null | empty($body)){
throw new \InvalidArgumentException("Body cannot be null or empty");
}
if (!JsonValidator::validate($body, true)) {
throw new \InvalidArgumentException("Request Body is not a valid JSON.");
}
$object = new WebhookEvent($body);
if ($object->getId() == null) {
throw new \InvalidArgumentException("Id attribute not found in JSON. Possible reason could be invalid JSON Object");
}
try {
return self::get($object->getId(), $apiContext, $restCall);
} catch(PayPalConnectionException $ex) {
if ($ex->getCode() == 404) {
// It means that the given webhook event Id is not found for this merchant.
throw new \InvalidArgumentException("Webhook Event Id provided in the data is incorrect. This could happen if anyone other than PayPal is faking the incoming webhook data.");
}
throw $ex;
}
}
/**
* Retrieves the Webhooks event resource identified by event_id. Can be used to retrieve the payload for an event.
*
* @param string $eventId
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return WebhookEvent
*/
public static function get($eventId, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($eventId, 'eventId');
$payLoad = "";
$json = self::executeCall(
"/v1/notifications/webhooks-events/$eventId",
"GET",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new WebhookEvent();
$ret->fromJson($json);
return $ret;
}
/**
* Resends the Webhooks event resource identified by event_id.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return WebhookEvent
*/
public function resend($apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
$payLoad = "";
$json = self::executeCall(
"/v1/notifications/webhooks-events/{$this->getId()}/resend",
"POST",
$payLoad,
null,
$apiContext,
$restCall
);
$this->fromJson($json);
return $this;
}
/**
* 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.
*
* @param array $params
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return WebhookEventList
*/
public static function all($params, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($params, 'params');
$payLoad = "";
$allowedParams = array(
'page_size' => 1,
'start_time' => 1,
'end_time' => 1,
);
$json = self::executeCall(
"/v1/notifications/webhooks-events" . "?" . http_build_query(array_intersect_key($params, $allowedParams)),
"GET",
$payLoad,
null,
$apiContext,
$restCall
);
$ret = new WebhookEventList();
$ret->fromJson($json);
return $ret;
}
}