fix!: Refactor Adjustments and related entities

- CreateAdjustment now has a write specific AdjustmentItem - Adjustment entities are shared between Adjustments and Subscriptions - AdjustmentProration - AdjustmentType - AdjustmentTimePeriod BREAKING CHANGE: To create an Adjustment you must now use `\Paddle\SDK\Resources\Adjustments\Operations\Create\AdjustmentItem`
PaddleHQ · Feb 7, 2024 · 4fff2e4 · 4fff2e4
1 parent 7551ef9
commit 4fff2e4
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 123 deletions.
diff --git a/src/Entities/Adjustment.php b/src/Entities/Adjustment.php
@@ -11,7 +11,7 @@
 
 namespace Paddle\SDK\Entities;
 
-use Paddle\SDK\Entities\Adjustment\AdjustmentItemTotals;
+use Paddle\SDK\Entities\Adjustment\AdjustmentItem;
 use Paddle\SDK\Entities\Shared\Action;
 use Paddle\SDK\Entities\Shared\AdjustmentStatus;
 use Paddle\SDK\Entities\Shared\CurrencyCode;
@@ -23,7 +23,7 @@ class Adjustment implements Entity
     /**
      * @internal
      *
-     * @param array<AdjustmentItemTotals> $items
+     * @param array<AdjustmentItem> $items
      */
     protected function __construct(
         public string $id,
@@ -55,7 +55,7 @@ public static function from(array $data): self
             creditAppliedToBalance: $data['credit_applied_to_balance'] ?? null,
             currencyCode: CurrencyCode::from($data['currency_code']),
             status: AdjustmentStatus::from($data['status']),
-            items: $data['items'],
+            items: array_map(fn (array $item) => AdjustmentItem::from($item), $data['items']),
             totals: TotalAdjustments::from($data['totals']),
             payoutTotals: isset($data['payout_totals']) ? PayoutTotalsAdjustment::from($data['payout_totals']) : null,
             createdAt: DateTime::from($data['created_at']),

diff --git a/src/Entities/Adjustment/AdjustmentItem.php b/src/Entities/Adjustment/AdjustmentItem.php
@@ -11,12 +11,31 @@
 
 namespace Paddle\SDK\Entities\Adjustment;
 
+use Paddle\SDK\Entities\Shared\AdjustmentItemTotals;
+use Paddle\SDK\Entities\Shared\AdjustmentProration;
+use Paddle\SDK\Entities\Shared\AdjustmentType;
+
 class AdjustmentItem
 {
     public function __construct(
+        public string $id,
         public string $itemId,
         public AdjustmentType $type,
         public string|null $amount,
+        public AdjustmentProration|null $proration,
+        public AdjustmentItemTotals $totals,
     ) {
     }
+
+    public static function from(array $data): self
+    {
+        return new self(
+            id: $data['id'],
+            itemId: $data['item_id'],
+            type: AdjustmentType::from($data['type']),
+            amount: $data['amount'] ?? null,
+            proration: $data['proration'] ? AdjustmentProration::from($data['proration']) : null,
+            totals: AdjustmentItemTotals::from($data['totals']),
+        );
+    }
 }
diff --git a/src/Entities/Adjustment/AdjustmentItemTotals.php b/src/Entities/Adjustment/AdjustmentItemTotals.php
diff --git a/...tities/Adjustment/AdjustmentProration.php → src/Entities/Shared/AdjustmentProration.php b/...tities/Adjustment/AdjustmentProration.php → src/Entities/Shared/AdjustmentProration.php
@@ -9,7 +9,7 @@
  * |-------------------------------------------------------------|.
  */
 
-namespace Paddle\SDK\Entities\Adjustment;
+namespace Paddle\SDK\Entities\Shared;
 
 class AdjustmentProration
 {

diff --git a/...ities/Adjustment/AdjustmentTimePeriod.php → src/Entities/Shared/AdjustmentTimePeriod.php b/...ities/Adjustment/AdjustmentTimePeriod.php → src/Entities/Shared/AdjustmentTimePeriod.php
@@ -9,7 +9,7 @@
  * |-------------------------------------------------------------|.
  */
 
-namespace Paddle\SDK\Entities\Adjustment;
+namespace Paddle\SDK\Entities\Shared;
 
 use Paddle\SDK\Entities\DateTime;
 

diff --git a/src/Entities/Adjustment/AdjustmentType.php → src/Entities/Shared/AdjustmentType.php b/src/Entities/Adjustment/AdjustmentType.php → src/Entities/Shared/AdjustmentType.php
@@ -9,7 +9,7 @@
  * |-------------------------------------------------------------|.
  */
 
-namespace Paddle\SDK\Entities\Adjustment;
+namespace Paddle\SDK\Entities\Shared;
 
 enum AdjustmentType: string
 {

diff --git a/src/Entities/Subscription/SubscriptionAdjustmentItem.php b/src/Entities/Subscription/SubscriptionAdjustmentItem.php
@@ -11,16 +11,17 @@
 
 namespace Paddle\SDK\Entities\Subscription;
 
-use Paddle\SDK\Entities\Adjustment\AdjustmentType;
 use Paddle\SDK\Entities\Shared\AdjustmentItemTotals;
+use Paddle\SDK\Entities\Shared\AdjustmentProration;
+use Paddle\SDK\Entities\Shared\AdjustmentType;
 
 class SubscriptionAdjustmentItem
 {
     public function __construct(
         public string $itemId,
         public AdjustmentType $type,
         public string|null $amount,
-        public SubscriptionProration $proration,
+        public AdjustmentProration $proration,
         public AdjustmentItemTotals $totals,
     ) {
     }
@@ -31,7 +32,7 @@ public static function from(array $data): self
             itemId: $data['item_id'],
             type: AdjustmentType::from($data['type']),
             amount: $data['amount'] ?? null,
-            proration: SubscriptionProration::from($data['proration']),
+            proration: AdjustmentProration::from($data['proration']),
             totals: AdjustmentItemTotals::from($data['totals']),
         );
     }

diff --git a/src/Entities/Transaction/TransactionAdjustment.php b/src/Entities/Transaction/TransactionAdjustment.php
diff --git a/...Transaction/TransactionAdjustmentItem.php → ...ents/Operations/Create/AdjustmentItem.php b/...Transaction/TransactionAdjustmentItem.php → ...ents/Operations/Create/AdjustmentItem.php
@@ -9,20 +9,16 @@
  * |-------------------------------------------------------------|.
  */
 
-namespace Paddle\SDK\Entities\Transaction;
+namespace Paddle\SDK\Resources\Adjustments\Operations\Create;
 
-use Paddle\SDK\Entities\Shared\AdjustmentItemTotals;
-use Paddle\SDK\Entities\Shared\Type;
+use Paddle\SDK\Entities\Shared\AdjustmentType;
 
-class TransactionAdjustmentItem
+class AdjustmentItem
 {
     public function __construct(
-        public string $id,
         public string $itemId,
-        public Type $type,
+        public AdjustmentType $type,
         public string|null $amount,
-        public TransactionProration $proration,
-        public AdjustmentItemTotals $totals,
     ) {
     }
 }
diff --git a/src/Resources/Adjustments/Operations/CreateAdjustment.php b/src/Resources/Adjustments/Operations/CreateAdjustment.php
@@ -4,8 +4,8 @@
 
 namespace Paddle\SDK\Resources\Adjustments\Operations;
 
-use Paddle\SDK\Entities\Adjustment\AdjustmentItem;
 use Paddle\SDK\Entities\Shared\Action;
+use Paddle\SDK\Resources\Adjustments\Operations\Create\AdjustmentItem;
 
 class CreateAdjustment implements \JsonSerializable
 {

diff --git a/tests/Functional/Resources/Adjustments/AdjustmentsClientTest.php b/tests/Functional/Resources/Adjustments/AdjustmentsClientTest.php
@@ -7,12 +7,12 @@
 use GuzzleHttp\Psr7\Response;
 use Http\Mock\Client as MockClient;
 use Paddle\SDK\Client;
-use Paddle\SDK\Entities\Adjustment\AdjustmentItem;
-use Paddle\SDK\Entities\Adjustment\AdjustmentType;
 use Paddle\SDK\Entities\Shared\Action;
 use Paddle\SDK\Entities\Shared\AdjustmentStatus;
+use Paddle\SDK\Entities\Shared\AdjustmentType;
 use Paddle\SDK\Environment;
 use Paddle\SDK\Options;
+use Paddle\SDK\Resources\Adjustments\Operations\Create\AdjustmentItem;
 use Paddle\SDK\Resources\Adjustments\Operations\CreateAdjustment;
 use Paddle\SDK\Resources\Adjustments\Operations\ListAdjustments;
 use Paddle\SDK\Resources\Shared\Operations\List\Pager;