feat: Add support for notification settings traffic source (#72)

CHANGELOG.md

@@ -6,6 +6,11 @@ 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-python-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## [Unreleased]
+
+### Added
+- Added `traffic_source` property to `paddle_billing.Entities.NotificationSetting` entity
+
 ## 1.1.1 - 2024-11-14
 
 ### Fixed

paddle_billing/Entities/NotificationSetting.py

@@ -3,7 +3,7 @@
 
 from paddle_billing.Entities.Entity import Entity
 from paddle_billing.Entities.EventType import EventType
-from paddle_billing.Entities.NotificationSettings import NotificationSettingType
+from paddle_billing.Entities.NotificationSettings import NotificationSettingType, NotificationSettingTrafficSource
 
 
 @dataclass
@@ -17,6 +17,7 @@ class NotificationSetting(Entity):
     include_sensitive_fields: bool
     subscribed_events: list[EventType]
     endpoint_secret_key: str
+    traffic_source: NotificationSettingTrafficSource
 
     @staticmethod
     def from_dict(data: dict) -> NotificationSetting:
@@ -30,4 +31,5 @@ def from_dict(data: dict) -> NotificationSetting:
             include_sensitive_fields=data["include_sensitive_fields"],
             subscribed_events=[EventType.from_dict(event) for event in data.get("subscribed_events", [])],
             endpoint_secret_key=data["endpoint_secret_key"],
+            traffic_source=NotificationSettingTrafficSource(data["traffic_source"]),
         )

paddle_billing/Entities/NotificationSettings/NotificationSettingTrafficSource.py

@@ -0,0 +1,7 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class NotificationSettingTrafficSource(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    All: "NotificationSettingTrafficSource" = "all"
+    Platform: "NotificationSettingTrafficSource" = "platform"
+    Simulation: "NotificationSettingTrafficSource" = "simulation"

paddle_billing/Entities/NotificationSettings/__init__.py

@@ -1 +1,4 @@
+from paddle_billing.Entities.NotificationSettings.NotificationSettingTrafficSource import (
+    NotificationSettingTrafficSource,
+)
 from paddle_billing.Entities.NotificationSettings.NotificationSettingType import NotificationSettingType

paddle_billing/Resources/NotificationSettings/Operations/CreateNotificationSetting.py

@@ -3,7 +3,7 @@
 from paddle_billing.Operation import Operation
 from paddle_billing.Undefined import Undefined
 from paddle_billing.Entities.Events import EventTypeName
-from paddle_billing.Entities.NotificationSettings import NotificationSettingType
+from paddle_billing.Entities.NotificationSettings import NotificationSettingType, NotificationSettingTrafficSource
 
 
 @dataclass
@@ -14,3 +14,4 @@ class CreateNotificationSetting(Operation):
     type: NotificationSettingType
     include_sensitive_fields: bool
     api_version: int | Undefined = Undefined()
+    traffic_source: NotificationSettingTrafficSource | Undefined = Undefined()

paddle_billing/Resources/NotificationSettings/Operations/ListNotificationSettings.py

@@ -2,21 +2,27 @@
 
 from paddle_billing.Resources.Shared.Operations import Pager
 
+from paddle_billing.Entities.NotificationSettings import NotificationSettingTrafficSource
+
 
 class ListNotificationSettings(HasParameters):
     def __init__(
         self,
         pager: Pager | None = None,
         active: bool | None = None,
+        traffic_source: NotificationSettingTrafficSource | None = None,
     ):
         self.pager = pager
         self.active = active
+        self.traffic_source = traffic_source
 
     def get_parameters(self) -> dict:
         parameters = {}
         if self.pager:
             parameters.update(self.pager.get_parameters())
         if self.active is not None:
             parameters["active"] = "true" if self.active else "false"
+        if self.traffic_source is not None:
+            parameters["traffic_source"] = self.traffic_source.value
 
         return parameters

paddle_billing/Resources/NotificationSettings/Operations/UpdateNotificationSetting.py

@@ -3,6 +3,7 @@
 from paddle_billing.Operation import Operation
 from paddle_billing.Undefined import Undefined
 from paddle_billing.Entities.Events import EventTypeName
+from paddle_billing.Entities.NotificationSettings import NotificationSettingTrafficSource
 
 
 @dataclass
@@ -13,3 +14,4 @@ class UpdateNotificationSetting(Operation):
     api_version: int | Undefined = Undefined()
     include_sensitive_fields: bool | Undefined = Undefined()
     subscribed_events: list[EventTypeName] | Undefined = Undefined()
+    traffic_source: NotificationSettingTrafficSource | Undefined = Undefined()

tests/Functional/Resources/NotificationSettings/_fixtures/request/create_traffic_all.json

@@ -0,0 +1,10 @@
+{
+    "description": "Slack notifications",
+    "type": "url",
+    "destination": "https://hooks.slack.com/example",
+    "include_sensitive_fields": false,
+    "subscribed_events": [
+        "transaction.created"
+    ],
+    "traffic_source": "all"
+}

tests/Functional/Resources/NotificationSettings/_fixtures/request/create_traffic_platform.json

@@ -0,0 +1,10 @@
+{
+    "description": "Slack notifications",
+    "type": "url",
+    "destination": "https://hooks.slack.com/example",
+    "include_sensitive_fields": false,
+    "subscribed_events": [
+        "transaction.created"
+    ],
+    "traffic_source": "platform"
+}

tests/Functional/Resources/NotificationSettings/_fixtures/request/create_traffic_simulation.json

@@ -0,0 +1,10 @@
+{
+    "description": "Slack notifications",
+    "type": "url",
+    "destination": "https://hooks.slack.com/example",
+    "include_sensitive_fields": false,
+    "subscribed_events": [
+        "transaction.created"
+    ],
+    "traffic_source": "simulation"
+}

tests/Functional/Resources/NotificationSettings/_fixtures/request/update_traffic_all.json

@@ -0,0 +1,3 @@
+{
+    "traffic_source": "all"
+}

tests/Functional/Resources/NotificationSettings/_fixtures/request/update_traffic_platform.json

@@ -0,0 +1,3 @@
+{
+    "traffic_source": "platform"
+}

tests/Functional/Resources/NotificationSettings/_fixtures/request/update_traffic_simulation.json

@@ -0,0 +1,3 @@
+{
+    "traffic_source": "simulation"
+}

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": "all"
         },
         {
             "id": "ntfset_01gkpop8bkm3tm53itgkx6klk7",
@@ -202,7 +203,27 @@
                     "available_versions": [1]
                 }
             ],
-            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI"
+            "endpoint_secret_key": "ntfset_01gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "platform"
+        },
+        {
+            "id": "ntfset_02gkpop8bkm3tm53itgkx6klk7",
+            "description": "Discord notifications",
+            "type": "url",
+            "destination": "https://hooks.discord.com/example",
+            "active": true,
+            "api_version": 1,
+            "include_sensitive_fields": false,
+            "subscribed_events": [
+                {
+                    "name": "transaction.billed",
+                    "description": "Occurs when a transaction is billed.",
+                    "group": "Transaction",
+                    "available_versions": [1]
+                }
+            ],
+            "endpoint_secret_key": "ntfset_02gkpop8bkm3tm53itgkx6klk7_6h3qd3uFSi9YCD3OLYAShQI90XTI5vEI",
+            "traffic_source": "simulation"
         }
     ],
     "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"