feat:Add traffic_source for Notification Settings (#83)

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-php-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## [unreleased] - 2024-10-01
+
+### Added
+
+- Added `traffic_source` property to `NotificationSetting` entity
+- Support notification settings `traffic_source` filter
+
 # [1.3.1] - 2024-09-30
 
 ### Fixed

phpstan.neon.dist

@@ -7,4 +7,5 @@ parameters:
         - '#Method .+ should return .+ but returns Paddle\\SDK\\Entities\\Entity.#'
         - '#Constant .+ is unused.#'
         - '#Call to an undefined static method Paddle\\SDK\\PaddleEnum::Undefined\(\).#'
-        - '#Method Paddle\\SDK\\PaddleEnum::from\(\) should return static\(Paddle\\SDK\\PaddleEnum\) but returns MyCLabs\\Enum\\Enum<mixed>.#'
+        - '#Method Paddle\\SDK\\PaddleEnum::from\(\) should return static\(Paddle\\SDK\\PaddleEnum\) but returns MyCLabs\\Enum\\Enum<mixed>.#'
+        - '#MyCLabsMethodCallToEnumConstRector#'

src/Entities/Adjustment.php

@@ -53,7 +53,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: array_map(fn (array $item) => AdjustmentItem::from($item), $data['items']),
+            items: array_map(fn (array $item): AdjustmentItem => AdjustmentItem::from($item), $data['items']),
             totals: AdjustmentTotals::from($data['totals']),
             payoutTotals: isset($data['payout_totals']) ? PayoutTotalsAdjustment::from($data['payout_totals']) : null,
             createdAt: DateTime::from($data['created_at']),

src/Entities/NotificationSetting.php

@@ -11,6 +11,7 @@
 
 namespace Paddle\SDK\Entities;
 
+use Paddle\SDK\Entities\NotificationSetting\NotificationSettingTrafficSource;
 use Paddle\SDK\Entities\NotificationSetting\NotificationSettingType;
 
 class NotificationSetting implements Entity
@@ -28,6 +29,7 @@ private function __construct(
         public bool $includeSensitiveFields,
         public array $subscribedEvents,
         public string $endpointSecretKey,
+        public NotificationSettingTrafficSource $trafficSource,
     ) {
     }
 
@@ -43,6 +45,7 @@ public static function from(array $data): self
             includeSensitiveFields: $data['include_sensitive_fields'],
             subscribedEvents: array_map(fn (array $eventType): EventType => EventType::from($eventType), $data['subscribed_events'] ?? []),
             endpointSecretKey: $data['endpoint_secret_key'],
+            trafficSource: NotificationSettingTrafficSource::from($data['traffic_source']),
         );
     }
 }

src/Entities/NotificationSetting/NotificationSettingTrafficSource.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * |------
+ * | ! Generated code !
+ * | Altering this code will result in changes being overwritten |
+ * |-------------------------------------------------------------|.
+ */
+
+namespace Paddle\SDK\Entities\NotificationSetting;
+
+use Paddle\SDK\PaddleEnum;
+
+/**
+ * @method static NotificationSettingTrafficSource All()
+ * @method static NotificationSettingTrafficSource Platform()
+ * @method static NotificationSettingTrafficSource Simulation()
+ */
+final class NotificationSettingTrafficSource extends PaddleEnum
+{
+    private const All = 'all';
+    private const Platform = 'platform';
+    private const Simulation = 'simulation';
+}

src/Entities/Subscription/SubscriptionAdjustmentPreview.php

@@ -22,7 +22,7 @@ public static function from(array $data): self
     {
         return new self(
             transactionId: $data['transaction_id'],
-            items: array_map(fn (array $item) => SubscriptionAdjustmentItem::from($item), $data['items']),
+            items: array_map(fn (array $item): SubscriptionAdjustmentItem => SubscriptionAdjustmentItem::from($item), $data['items']),
             totals: AdjustmentTotals::from($data['totals']),
         );
     }

src/Entities/Subscription/SubscriptionNextTransaction.php

@@ -31,7 +31,7 @@ public static function from(array $data): self
             billingPeriod: SubscriptionTimePeriod::from($data['billing_period']),
             details: TransactionDetailsPreview::from($data['details']),
             adjustments: array_map(
-                fn (array $adjustment) => SubscriptionAdjustmentPreview::from($adjustment),
+                fn (array $adjustment): SubscriptionAdjustmentPreview => SubscriptionAdjustmentPreview::from($adjustment),
                 $data['adjustments'],
             ),
         );

src/Resources/NotificationSettings/Operations/ListNotificationSettings.php

@@ -4,6 +4,7 @@
 
 namespace Paddle\SDK\Resources\NotificationSettings\Operations;
 
+use Paddle\SDK\Entities\NotificationSetting\NotificationSettingTrafficSource;
 use Paddle\SDK\HasParameters;
 use Paddle\SDK\Resources\Shared\Operations\List\Pager;
 
@@ -12,6 +13,7 @@ class ListNotificationSettings implements HasParameters
     public function __construct(
         private readonly Pager|null $pager = null,
         private readonly bool|null $active = null,
+        private readonly NotificationSettingTrafficSource|null $trafficSource = null,
     ) {
     }
 
@@ -21,6 +23,7 @@ public function getParameters(): array
             $this->pager?->getParameters() ?? [],
             array_filter([
                 'active' => isset($this->active) ? ($this->active ? 'true' : 'false') : null,
+                'traffic_source' => $this->trafficSource?->getValue(),
             ]),
         );
     }

src/Resources/PricingPreviews/Operations/PreviewPrice.php

@@ -28,7 +28,7 @@ public function __construct(
         public readonly AddressPreview|Undefined|null $address = new Undefined(),
         public readonly string|Undefined|null $customerIpAddress = new Undefined(),
     ) {
-        if (count($this->items) === 0) {
+        if ($this->items === []) {
             throw InvalidArgumentException::arrayIsEmpty('items');
         }
 

tests/Functional/Resources/NotificationSettings/NotificationSettingsClientTest.php

@@ -8,6 +8,7 @@
 use Http\Mock\Client as MockClient;
 use Paddle\SDK\Client;
 use Paddle\SDK\Entities\Event\EventTypeName;
+use Paddle\SDK\Entities\NotificationSetting\NotificationSettingTrafficSource;
 use Paddle\SDK\Entities\NotificationSetting\NotificationSettingType;
 use Paddle\SDK\Environment;
 use Paddle\SDK\Options;
@@ -205,6 +206,11 @@ public static function listOperationsProvider(): \Generator
             sprintf('%s/notification-settings?active=false', Environment::SANDBOX->baseUrl()),
         ];
 
+        yield 'With traffic_source filter platform' => [
+            new ListNotificationSettings(trafficSource: NotificationSettingTrafficSource::Platform()),
+            sprintf('%s/notification-settings?traffic_source=platform', Environment::SANDBOX->baseUrl()),
+        ];
+
         yield 'With default pagination' => [
             new ListNotificationSettings(
                 new Pager(),

tests/Functional/Resources/NotificationSettings/_fixtures/response/full_entity.json

@@ -99,7 +99,8 @@
                 "available_versions": [1]
             }
         ],
-        "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+        "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+        "traffic_source": "platform"
     },
     "meta": {
         "request_id": "fd55d51a-6242-4645-8572-af2a8b6f41b6"

tests/Functional/Resources/NotificationSettings/_fixtures/response/list_default.json

@@ -100,7 +100,8 @@
                     "available_versions": [1]
                 }
             ],
-            "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+            "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "platform"
         },
         {
             "id": "ntfset_01gkpop8bkm3tm53itgkx6klk7",
@@ -202,7 +203,8 @@
                     "available_versions": [1]
                 }
             ],
-            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "platform"
         }
     ],
     "meta": {

tests/Functional/Resources/NotificationSettings/_fixtures/response/list_paginated_page_one.json

@@ -100,7 +100,8 @@
                     "available_versions": [1]
                 }
             ],
-            "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+            "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "platform"
         }
     ],
     "meta": {

tests/Functional/Resources/NotificationSettings/_fixtures/response/list_paginated_page_two.json

@@ -100,7 +100,8 @@
                     "available_versions": [1]
                 }
             ],
-            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "platform"
         }
     ],
     "meta": {

tests/Functional/Resources/NotificationSettings/_fixtures/response/minimal_entity.json

@@ -45,7 +45,8 @@
                 "available_versions": [1]
             }
         ],
-        "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+        "endpoint_secret_key": "pdl_ntfset_01gkpjp8bkm3tm53kdgkx6sms7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+        "traffic_source": "platform"
     },
     "meta": {
         "request_id": "fd55d51a-6242-4645-8572-af2a8b6f41b6"