fix: Implement missing events, add readonly entity properties and add…

…itional test coverage
PaddleHQ · Sep 17, 2024 · 7de34b3 · 7de34b3
1 parent 009ef00
commit 7de34b3
Show file tree

Hide file tree

Showing 88 changed files with 4,990 additions and 89 deletions.
diff --git a/examples/webhook_verification_PSR7.php b/examples/webhook_verification_PSR7.php
@@ -12,7 +12,6 @@
 
 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;
@@ -32,9 +31,7 @@
     $occurredAt = $event->occurredAt;
 
     if ($event instanceof TransactionUpdated) {
-        /** @var Transaction $transaction */
-        $transaction = $event->data;
-        $transactionId = $transaction->id;
+        $transactionId = $event->transaction->id;
     }
 } else {
     echo "Webhook is not verified\n";

diff --git a/src/Entities/Event.php b/src/Entities/Event.php
@@ -25,7 +25,7 @@ public static function from(array $data): self
         $entity = $type[0] ?? 'Unknown';
         $identifier = str_replace('_', '', ucwords(implode('_', $type), '_'));
 
-        /** @var class-string<Event> $entity */
+        /** @var class-string<Event> $event */
         $event = sprintf('\Paddle\SDK\Notifications\Events\%s', $identifier);
 
         if (! class_exists($event) || ! is_subclass_of($event, self::class)) {

diff --git a/src/Notifications/Events/AddressCreated.php b/src/Notifications/Events/AddressCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Address $data,
+        public readonly Address $address,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $address, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/AddressImported.php b/src/Notifications/Events/AddressImported.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Paddle\SDK\Notifications\Events;
+
+use Paddle\SDK\Entities\Event;
+use Paddle\SDK\Entities\Event\EventTypeName;
+use Paddle\SDK\Notifications\Entities\Address;
+use Paddle\SDK\Notifications\Entities\Entity;
+
+final class AddressImported extends Event
+{
+    private function __construct(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        public readonly Address $address,
+        string|null $notificationId,
+    ) {
+        parent::__construct($eventId, $eventType, $occurredAt, $address, $notificationId);
+    }
+
+    /**
+     * @param Address $data
+     */
+    public static function fromEvent(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        Entity $data,
+        string|null $notificationId = null,
+    ): static {
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
+    }
+}
diff --git a/src/Notifications/Events/AddressUpdated.php b/src/Notifications/Events/AddressUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Address $data,
+        public readonly Address $address,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $address, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/AdjustmentCreated.php b/src/Notifications/Events/AdjustmentCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Adjustment $data,
+        public readonly Adjustment $adjustment,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $adjustment, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/AdjustmentUpdated.php b/src/Notifications/Events/AdjustmentUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Adjustment $data,
+        public readonly Adjustment $adjustment,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $adjustment, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/BusinessCreated.php b/src/Notifications/Events/BusinessCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Business $data,
+        public readonly Business $business,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $business, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/BusinessImported.php b/src/Notifications/Events/BusinessImported.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Paddle\SDK\Notifications\Events;
+
+use Paddle\SDK\Entities\Event;
+use Paddle\SDK\Entities\Event\EventTypeName;
+use Paddle\SDK\Notifications\Entities\Business;
+use Paddle\SDK\Notifications\Entities\Entity;
+
+final class BusinessImported extends Event
+{
+    private function __construct(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        public readonly Business $business,
+        string|null $notificationId,
+    ) {
+        parent::__construct($eventId, $eventType, $occurredAt, $business, $notificationId);
+    }
+
+    /**
+     * @param Business $data
+     */
+    public static function fromEvent(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        Entity $data,
+        string|null $notificationId = null,
+    ): static {
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
+    }
+}
diff --git a/src/Notifications/Events/BusinessUpdated.php b/src/Notifications/Events/BusinessUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Business $data,
+        public readonly Business $business,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $business, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/CustomerCreated.php b/src/Notifications/Events/CustomerCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Customer $data,
+        public readonly Customer $customer,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $customer, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/CustomerImported.php b/src/Notifications/Events/CustomerImported.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Paddle\SDK\Notifications\Events;
+
+use Paddle\SDK\Entities\Event;
+use Paddle\SDK\Entities\Event\EventTypeName;
+use Paddle\SDK\Notifications\Entities\Customer;
+use Paddle\SDK\Notifications\Entities\Entity;
+
+final class CustomerImported extends Event
+{
+    private function __construct(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        public readonly Customer $customer,
+        string|null $notificationId,
+    ) {
+        parent::__construct($eventId, $eventType, $occurredAt, $customer, $notificationId);
+    }
+
+    /**
+     * @param Customer $data
+     */
+    public static function fromEvent(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        Entity $data,
+        string|null $notificationId = null,
+    ): static {
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
+    }
+}
diff --git a/src/Notifications/Events/CustomerUpdated.php b/src/Notifications/Events/CustomerUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Customer $data,
+        public readonly Customer $customer,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $customer, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/DiscountCreated.php b/src/Notifications/Events/DiscountCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Discount $data,
+        public readonly Discount $discount,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $discount, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/DiscountImported.php b/src/Notifications/Events/DiscountImported.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Discount $data,
+        public readonly Discount $discount,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $discount, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/DiscountUpdated.php b/src/Notifications/Events/DiscountUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Discount $data,
+        public readonly Discount $discount,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $discount, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/PayoutCreated.php b/src/Notifications/Events/PayoutCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Payout $data,
+        public readonly Payout $payout,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $payout, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/PayoutPaid.php b/src/Notifications/Events/PayoutPaid.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Payout $data,
+        public readonly Payout $payout,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $payout, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/PriceCreated.php b/src/Notifications/Events/PriceCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Price $data,
+        public readonly Price $price,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $price, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/PriceImported.php b/src/Notifications/Events/PriceImported.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Paddle\SDK\Notifications\Events;
+
+use Paddle\SDK\Entities\Event;
+use Paddle\SDK\Entities\Event\EventTypeName;
+use Paddle\SDK\Notifications\Entities\Entity;
+use Paddle\SDK\Notifications\Entities\Price;
+
+final class PriceImported extends Event
+{
+    private function __construct(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        public readonly Price $price,
+        string|null $notificationId,
+    ) {
+        parent::__construct($eventId, $eventType, $occurredAt, $price, $notificationId);
+    }
+
+    /**
+     * @param Price $data
+     */
+    public static function fromEvent(
+        string $eventId,
+        EventTypeName $eventType,
+        \DateTimeInterface $occurredAt,
+        Entity $data,
+        string|null $notificationId = null,
+    ): static {
+        return new self($eventId, $eventType, $occurredAt, $data, $notificationId);
+    }
+}
diff --git a/src/Notifications/Events/PriceUpdated.php b/src/Notifications/Events/PriceUpdated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Price $data,
+        public readonly Price $price,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $price, $notificationId);
     }
 
     /**

diff --git a/src/Notifications/Events/ProductCreated.php b/src/Notifications/Events/ProductCreated.php
@@ -15,10 +15,10 @@ private function __construct(
         string $eventId,
         EventTypeName $eventType,
         \DateTimeInterface $occurredAt,
-        Product $data,
+        public readonly Product $product,
         string|null $notificationId,
     ) {
-        parent::__construct($eventId, $eventType, $occurredAt, $data, $notificationId);
+        parent::__construct($eventId, $eventType, $occurredAt, $product, $notificationId);
     }
 
     /**