Feature: Add optional notification ID to events

PaddleHQ · Sep 16, 2024 · a624e1d · a624e1d
1 parent af2dfb0
commit a624e1d
Show file tree

Hide file tree

Showing 41 changed files with 264 additions and 77 deletions.
diff --git a/examples/webhook_verification_PSR7.php b/examples/webhook_verification_PSR7.php
@@ -11,6 +11,9 @@
  */
 
 use GuzzleHttp\Psr7\ServerRequest;
+use Paddle\SDK\Entities\Event;
+use Paddle\SDK\Entities\Transaction;
+use Paddle\SDK\Notifications\Events\TransactionUpdated;
 use Paddle\SDK\Notifications\Secret;
 use Paddle\SDK\Notifications\Verifier;
 
@@ -21,6 +24,18 @@
 
 if ($isVerified) {
     echo "Webhook is verified\n";
+
+    $event = Event::fromRequest($request);
+    $id = $event->notificationId;
+    $eventId = $event->eventId;
+    $eventType = $event->eventType;
+    $occurredAt = $event->occurredAt;
+
+    if ($event instanceof TransactionUpdated) {
+        /** @var Transaction $transaction */
+        $transaction = $event->data;
+        $transactionId = $transaction->id;
+    }
 } else {
     echo "Webhook is not verified\n";
 }
diff --git a/src/Entities/Event.php b/src/Entities/Event.php
@@ -6,17 +6,16 @@
 
 use Paddle\SDK\Entities\Event\EventTypeName;
 use Paddle\SDK\Notifications\Entities\Entity as NotificationEntity;
+use Psr\Http\Message\ServerRequestInterface;
 
 abstract class Event implements Entity
 {
-    /**
-     * @internal
-     */
     protected function __construct(
         public string $eventId,
         public EventTypeName $eventType,
         public \DateTimeInterface $occurredAt,
         public NotificationEntity $data,
+        public string|null $notificationId = null,
     ) {
     }
 
@@ -45,13 +44,24 @@ public static function from(array $data): self
             EventTypeName::from($data['event_type']),
             DateTime::from($data['occurred_at']),
             $entity::from($data['data']),
+            $data['notification_id'] ?? null,
         );
     }
 
+    public static function fromRequest(ServerRequestInterface $request): self
+    {
+        return self::from(json_decode(
+            (string) $request->getBody(),
+            true,
+            JSON_THROW_ON_ERROR,
+        ));
+    }
+
     abstract public static function fromEvent(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         NotificationEntity $data,
+        string|null $notificationId = null,
     ): static;
 }
diff --git a/src/Notifications/Events/AddressCreated.php b/src/Notifications/Events/AddressCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Address $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/AddressUpdated.php b/src/Notifications/Events/AddressUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Address $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/AdjustmentCreated.php b/src/Notifications/Events/AdjustmentCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Adjustment $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/AdjustmentUpdated.php b/src/Notifications/Events/AdjustmentUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Adjustment $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/BusinessCreated.php b/src/Notifications/Events/BusinessCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Business $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/BusinessUpdated.php b/src/Notifications/Events/BusinessUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Business $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/CustomerCreated.php b/src/Notifications/Events/CustomerCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Customer $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/CustomerUpdated.php b/src/Notifications/Events/CustomerUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Customer $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/DiscountCreated.php b/src/Notifications/Events/DiscountCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Discount $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/DiscountImported.php b/src/Notifications/Events/DiscountImported.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Discount $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/DiscountUpdated.php b/src/Notifications/Events/DiscountUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Discount $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/PayoutCreated.php b/src/Notifications/Events/PayoutCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Payout $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/PayoutPaid.php b/src/Notifications/Events/PayoutPaid.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Payout $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/PriceCreated.php b/src/Notifications/Events/PriceCreated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Price $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }
diff --git a/src/Notifications/Events/PriceUpdated.php b/src/Notifications/Events/PriceUpdated.php
@@ -16,8 +16,9 @@ private function __construct(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Price $data,
+        string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data);
+        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 
     /**
@@ -28,7 +29,8 @@ public static function fromEvent(
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
         Entity $data,
+        string|null $notificationId = null,
     ): static {
-        return new self($eventId, $eventType, $occurredAt, $data);
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
     }
 }