fix!: Make implementors of Entity internal (#24)

Implementors of \Paddle\SDK\Entities\Entity should not be used directly. To prevent this the constructors are now protected, and the static factory should be used instead conforming to the shape of the API. Each isntance is also documented as @internal now BREAKING CHANGE: Makes core Entity constructors private.
PaddleHQ · Feb 6, 2024 · 05ecdae · 05ecdae
1 parent 8afc3e2
commit 05ecdae
Show file tree

Hide file tree

Showing 30 changed files with 91 additions and 40 deletions.
diff --git a/src/Entities/Address.php b/src/Entities/Address.php
@@ -18,7 +18,10 @@
 
 class Address implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public string|null $description,
         public string|null $firstLine,

diff --git a/src/Entities/Adjustment.php b/src/Entities/Adjustment.php
@@ -21,9 +21,11 @@
 class Adjustment implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<AdjustmentItemTotals> $items
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public Action $action,
         public string $transactionId,

diff --git a/src/Entities/Business.php b/src/Entities/Business.php
@@ -19,9 +19,11 @@
 class Business implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<Contacts> $contacts
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public string $name,
         public string|null $companyNumber,

diff --git a/src/Entities/CreditBalance.php b/src/Entities/CreditBalance.php
@@ -16,7 +16,10 @@
 
 class CreditBalance implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $customerId,
         public CurrencyCode $currencyCode,
         public AdjustmentCustomerBalance $balance,

diff --git a/src/Entities/Customer.php b/src/Entities/Customer.php
@@ -17,7 +17,10 @@
 
 class Customer implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public string|null $name,
         public string $email,

diff --git a/src/Entities/Discount.php b/src/Entities/Discount.php
@@ -18,7 +18,10 @@
 
 class Discount implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public DiscountStatus $status,
         public string $description,

diff --git a/src/Entities/Event.php b/src/Entities/Event.php
@@ -10,7 +10,10 @@
 
 class Event implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $eventId,
         public EventTypeName $eventType,
         public \DateTimeInterface $occurredAt,

diff --git a/src/Entities/EventType.php b/src/Entities/EventType.php
@@ -15,7 +15,10 @@
 
 class EventType implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public EventTypeName $name,
         public string $description,
         public string $group,

diff --git a/src/Entities/Notification.php b/src/Entities/Notification.php
@@ -10,7 +10,10 @@
 
 class Notification implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public EventTypeName $type,
         public NotificationStatus $status,

diff --git a/src/Entities/Notification/NotificationDiscount.php b/src/Entities/Notification/NotificationDiscount.php
@@ -19,7 +19,10 @@
 
 class NotificationDiscount implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public DiscountStatus $status,
         public string $description,

diff --git a/src/Entities/Notification/NotificationSubscription.php b/src/Entities/Notification/NotificationSubscription.php
@@ -20,9 +20,11 @@
 class NotificationSubscription implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<SubscriptionItem> $items
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public SubscriptionStatus $status,
         public string $customerId,

diff --git a/src/Entities/NotificationLog.php b/src/Entities/NotificationLog.php
@@ -6,7 +6,10 @@
 
 class NotificationLog implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public int $responseCode,
         public string|null $responseContentType,

diff --git a/src/Entities/NotificationSetting.php b/src/Entities/NotificationSetting.php
@@ -16,7 +16,10 @@
 
 class NotificationSetting implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public string $description,
         public NotificationSettingType $type,

diff --git a/src/Entities/Price.php b/src/Entities/Price.php
@@ -24,9 +24,11 @@
 class Price implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<UnitPriceOverride> $unitPriceOverrides
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public string $productId,
         public string|null $name,

diff --git a/src/Entities/PricePreview.php b/src/Entities/PricePreview.php
@@ -19,9 +19,11 @@
 class PricePreview implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<AvailablePaymentMethods> $availablePaymentMethods
      */
-    public function __construct(
+    protected function __construct(
         public string|null $customerId,
         public string|null $addressId,
         public string|null $businessId,

diff --git a/src/Entities/PricingPreview/PricePreviewDetails.php b/src/Entities/PricingPreview/PricePreviewDetails.php
@@ -11,9 +11,7 @@
 
 namespace Paddle\SDK\Entities\PricingPreview;
 
-use Paddle\SDK\Entities\Entity;
-
-class PricePreviewDetails implements Entity
+class PricePreviewDetails
 {
     /**
      * @param array<PricePreviewLineItem> $lineItems

diff --git a/src/Entities/PricingPreview/PricePreviewDiscounts.php b/src/Entities/PricingPreview/PricePreviewDiscounts.php
@@ -12,9 +12,8 @@
 namespace Paddle\SDK\Entities\PricingPreview;
 
 use Paddle\SDK\Entities\Discount;
-use Paddle\SDK\Entities\Entity;
 
-class PricePreviewDiscounts implements Entity
+class PricePreviewDiscounts
 {
     public function __construct(
         public Discount $discount,

diff --git a/src/Entities/PricingPreview/PricePreviewItem.php b/src/Entities/PricingPreview/PricePreviewItem.php
@@ -11,9 +11,7 @@
 
 namespace Paddle\SDK\Entities\PricingPreview;
 
-use Paddle\SDK\Entities\Entity;
-
-class PricePreviewItem implements Entity
+class PricePreviewItem
 {
     public function __construct(
         public string $priceId,

diff --git a/src/Entities/PricingPreview/PricePreviewLineItem.php b/src/Entities/PricingPreview/PricePreviewLineItem.php
@@ -11,13 +11,12 @@
 
 namespace Paddle\SDK\Entities\PricingPreview;
 
-use Paddle\SDK\Entities\Entity;
 use Paddle\SDK\Entities\Price;
 use Paddle\SDK\Entities\Product;
 use Paddle\SDK\Entities\Shared\Totals;
 use Paddle\SDK\Entities\Shared\UnitTotals;
 
-class PricePreviewLineItem implements Entity
+class PricePreviewLineItem
 {
     /**
      * @param PricePreviewDiscounts[] $discounts

diff --git a/src/Entities/PricingPreview/PricePreviewTotalsFormatted.php b/src/Entities/PricingPreview/PricePreviewTotalsFormatted.php
@@ -11,9 +11,7 @@
 
 namespace Paddle\SDK\Entities\PricingPreview;
 
-use Paddle\SDK\Entities\Entity;
-
-class PricePreviewTotalsFormatted implements Entity
+class PricePreviewTotalsFormatted
 {
     public function __construct(
         public string $subtotal,

diff --git a/src/Entities/PricingPreview/PricePreviewUnitTotalsFormatted.php b/src/Entities/PricingPreview/PricePreviewUnitTotalsFormatted.php
@@ -11,9 +11,7 @@
 
 namespace Paddle\SDK\Entities\PricingPreview;
 
-use Paddle\SDK\Entities\Entity;
-
-class PricePreviewUnitTotalsFormatted implements Entity
+class PricePreviewUnitTotalsFormatted
 {
     public function __construct(
         public string $subtotal,

diff --git a/src/Entities/Product.php b/src/Entities/Product.php
@@ -20,7 +20,10 @@
 
 class Product implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $id,
         public string $name,
         public string|null $description,

diff --git a/src/Entities/Report.php b/src/Entities/Report.php
@@ -18,9 +18,11 @@
 class Report implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<ReportFilter> $filters
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public ReportStatus $status,
         public int|null $rows,

diff --git a/src/Entities/ReportCSV.php b/src/Entities/ReportCSV.php
@@ -13,7 +13,10 @@
 
 class ReportCSV implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public readonly string $url,
     ) {
     }

diff --git a/src/Entities/Subscription.php b/src/Entities/Subscription.php
@@ -29,9 +29,11 @@
 class Subscription implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<SubscriptionItem> $items
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public SubscriptionStatus $status,
         public string $customerId,

diff --git a/src/Entities/SubscriptionPreview.php b/src/Entities/SubscriptionPreview.php
@@ -29,9 +29,11 @@
 class SubscriptionPreview implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<SubscriptionItem> $items
      */
-    public function __construct(
+    protected function __construct(
         public SubscriptionStatus $status,
         public string $customerId,
         public string $addressId,

diff --git a/src/Entities/SubscriptionTransaction.php b/src/Entities/SubscriptionTransaction.php
@@ -27,11 +27,13 @@
 class SubscriptionTransaction implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<SubscriptionTransactionItem> $items
      * @param array<TransactionPaymentAttempt>   $payments
      * @param array<SubscriptionAdjustment>      $adjustments
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public StatusTransaction $status,
         public string|null $customerId,

diff --git a/src/Entities/Transaction.php b/src/Entities/Transaction.php
@@ -29,12 +29,14 @@
 class Transaction implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<TransactionItem>           $items
      * @param array<TransactionPaymentAttempt> $payments
      * @param array<TransactionAdjustment>     $adjustments
      * @param array<AvailablePaymentMethods>   $availablePaymentMethods
      */
-    public function __construct(
+    protected function __construct(
         public string $id,
         public StatusTransaction $status,
         public string|null $customerId,

diff --git a/src/Entities/TransactionData.php b/src/Entities/TransactionData.php
@@ -13,7 +13,10 @@
 
 class TransactionData implements Entity
 {
-    public function __construct(
+    /**
+     * @internal
+     */
+    protected function __construct(
         public string $url,
     ) {
     }

diff --git a/src/Entities/TransactionPreview.php b/src/Entities/TransactionPreview.php
@@ -20,10 +20,12 @@
 class TransactionPreview implements Entity
 {
     /**
+     * @internal
+     *
      * @param array<TransactionItemPreviewWithPrice> $items
      * @param array<AvailablePaymentMethods>         $availablePaymentMethods
      */
-    public function __construct(
+    protected function __construct(
         public string|null $customerId,
         public string|null $addressId,
         public string|null $businessId,