feat: Saved Payment Methods

CHANGELOG.md

@@ -6,6 +6,16 @@ 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
+
+- Support for saved payment methods, see [related changelog](https://developer.paddle.com/changelog/2024/saved-payment-methods?utm_source=dx&utm_medium=paddle-python-sdk)
+  - `Client.payment_methods.list`
+  - `Client.payment_methods.get`
+  - `Client.payment_methods.delete`
+  - `Client.customers.create_auth_token`
+
 ## 1.0.0 - 2024-11-11
 
 ### Changed

paddle_billing/Client.py

@@ -27,6 +27,7 @@
 from paddle_billing.Resources.Notifications.NotificationsClient import NotificationsClient
 from paddle_billing.Resources.NotificationLogs.NotificationLogsClient import NotificationLogsClient
 from paddle_billing.Resources.NotificationSettings.NotificationSettingsClient import NotificationSettingsClient
+from paddle_billing.Resources.PaymentMethods.PaymentMethodsClient import PaymentMethodsClient
 from paddle_billing.Resources.Prices.PricesClient import PricesClient
 from paddle_billing.Resources.PricingPreviews.PricingPreviewsClient import PricingPreviewsClient
 from paddle_billing.Resources.Products.ProductsClient import ProductsClient
@@ -90,6 +91,7 @@ def __init__(
         self.notifications = NotificationsClient(self)
         self.notification_logs = NotificationLogsClient(self)
         self.notification_settings = NotificationSettingsClient(self)
+        self.payment_methods = PaymentMethodsClient(self)
         self.prices = PricesClient(self)
         self.pricing_previews = PricingPreviewsClient(self)
         self.products = ProductsClient(self)

paddle_billing/Entities/Collections/PaymentMethodCollection.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from paddle_billing.Entities.Collections.Collection import Collection
+from paddle_billing.Entities.Collections.Paginator import Paginator
+from paddle_billing.Entities.PaymentMethod import PaymentMethod
+
+
+class PaymentMethodCollection(Collection[PaymentMethod]):
+    @classmethod
+    def from_list(cls, items_data: list, paginator: Paginator | None = None) -> PaymentMethodCollection:
+        items: list[PaymentMethod] = [PaymentMethod.from_dict(item) for item in items_data]
+
+        return PaymentMethodCollection(items, paginator)

paddle_billing/Entities/Collections/__init__.py

@@ -11,6 +11,7 @@
 from paddle_billing.Entities.Collections.NotificationLogCollection import NotificationLogCollection
 from paddle_billing.Entities.Collections.NotificationSettingCollection import NotificationSettingCollection
 from paddle_billing.Entities.Collections.Paginator import Paginator
+from paddle_billing.Entities.Collections.PaymentMethodCollection import PaymentMethodCollection
 from paddle_billing.Entities.Collections.PriceCollection import PriceCollection
 from paddle_billing.Entities.Collections.ProductCollection import ProductCollection
 from paddle_billing.Entities.Collections.ReportCollection import ReportCollection

paddle_billing/Entities/CustomerAuthToken.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from datetime import datetime
+
+from paddle_billing.Entities.Entity import Entity
+
+
+@dataclass
+class CustomerAuthToken(Entity):
+    customer_auth_token: str
+    expires_at: datetime
+
+    @staticmethod
+    def from_dict(data: dict) -> CustomerAuthToken:
+        return CustomerAuthToken(
+            customer_auth_token=data["customer_auth_token"],
+            expires_at=datetime.fromisoformat(data["expires_at"]),
+        )

paddle_billing/Entities/PaymentMethod.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from datetime import datetime
+
+from paddle_billing.Entities.Entity import Entity
+from paddle_billing.Entities.Shared import (
+    Card,
+    Paypal,
+    SavedPaymentMethodOrigin,
+    SavedPaymentMethodType,
+)
+
+
+@dataclass
+class PaymentMethod(Entity):
+    id: str
+    customer_id: str
+    address_id: str
+    type: SavedPaymentMethodType | None
+    card: Card | None
+    paypal: Paypal | None
+    origin: SavedPaymentMethodOrigin
+    saved_at: datetime
+    updated_at: datetime
+
+    @staticmethod
+    def from_dict(data: dict) -> PaymentMethod:
+        return PaymentMethod(
+            id=data["id"],
+            customer_id=data["customer_id"],
+            address_id=data["address_id"],
+            type=SavedPaymentMethodType(data["type"]),
+            card=Card.from_dict(data["card"]) if data.get("card") else None,
+            paypal=Paypal.from_dict(data["paypal"]) if data.get("paypal") else None,
+            origin=SavedPaymentMethodOrigin(data["origin"]),
+            saved_at=datetime.fromisoformat(data["saved_at"]),
+            updated_at=datetime.fromisoformat(data["updated_at"]),
+        )

paddle_billing/Entities/Shared/Paypal.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+from dataclasses import dataclass
+
+
+@dataclass
+class Paypal:
+    email: str
+    reference: str
+
+    @staticmethod
+    def from_dict(data: dict) -> Paypal:
+        return Paypal(
+            email=data["email"],
+            reference=data["reference"],
+        )

paddle_billing/Entities/Shared/SavedPaymentMethodOrigin.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SavedPaymentMethodOrigin(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    SavedDuringPurchase: "SavedPaymentMethodOrigin" = "saved_during_purchase"
+    Subscription: "SavedPaymentMethodOrigin" = "subscription"

paddle_billing/Entities/Shared/SavedPaymentMethodType.py

@@ -0,0 +1,9 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SavedPaymentMethodType(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    Alipay: "SavedPaymentMethodType" = "alipay"
+    ApplePay: "SavedPaymentMethodType" = "apple_pay"
+    Card: "SavedPaymentMethodType" = "card"
+    GooglePay: "SavedPaymentMethodType" = "google_pay"
+    Paypal: "SavedPaymentMethodType" = "paypal"

paddle_billing/Entities/Shared/__init__.py

@@ -31,8 +31,11 @@
 from paddle_billing.Entities.Shared.PaymentAttemptStatus import PaymentAttemptStatus
 from paddle_billing.Entities.Shared.PaymentMethodType import PaymentMethodType
 from paddle_billing.Entities.Shared.PayoutTotalsAdjustment import PayoutTotalsAdjustment
+from paddle_billing.Entities.Shared.Paypal import Paypal
 from paddle_billing.Entities.Shared.PriceQuantity import PriceQuantity
 from paddle_billing.Entities.Shared.Proration import Proration
+from paddle_billing.Entities.Shared.SavedPaymentMethodOrigin import SavedPaymentMethodOrigin
+from paddle_billing.Entities.Shared.SavedPaymentMethodType import SavedPaymentMethodType
 from paddle_billing.Entities.Shared.Status import Status
 from paddle_billing.Entities.Shared.TransactionStatus import TransactionStatus
 from paddle_billing.Entities.Shared.TaxCategory import TaxCategory

paddle_billing/Notifications/Entities/Entity.py

@@ -44,10 +44,12 @@ def from_dict_for_event_type(data: dict, event_type: str) -> Entity | UndefinedE
     def _resolve_event_class_name(event_type) -> str:
         if event_type == "subscription.created":
             return "SubscriptionCreated"
+        if event_type == "payment_method.deleted":
+            return "PaymentMethodDeleted"
 
         event_entity = event_type.split(".")[0] or ""
 
-        return event_entity.lower().title()
+        return event_entity.lower().title().replace("_", "")
 
     def to_dict(self) -> dict:
         return asdict(self)

paddle_billing/Notifications/Entities/PaymentMethod.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from datetime import datetime
+
+from paddle_billing.Notifications.Entities.Entity import Entity
+from paddle_billing.Notifications.Entities.Shared import (
+    SavedPaymentMethodOrigin,
+    SavedPaymentMethodType,
+)
+
+
+@dataclass
+class PaymentMethod(Entity):
+    id: str
+    customer_id: str
+    address_id: str
+    type: SavedPaymentMethodType | None
+    origin: SavedPaymentMethodOrigin
+    saved_at: datetime
+    updated_at: datetime
+
+    @staticmethod
+    def from_dict(data: dict) -> PaymentMethod:
+        return PaymentMethod(
+            id=data["id"],
+            customer_id=data["customer_id"],
+            address_id=data["address_id"],
+            type=SavedPaymentMethodType(data["type"]),
+            origin=SavedPaymentMethodOrigin(data["origin"]),
+            saved_at=datetime.fromisoformat(data["saved_at"]),
+            updated_at=datetime.fromisoformat(data["updated_at"]),
+        )

paddle_billing/Notifications/Entities/PaymentMethodDeleted.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from datetime import datetime
+
+from paddle_billing.Notifications.Entities.Entity import Entity
+from paddle_billing.Notifications.Entities.Shared import (
+    SavedPaymentMethodDeletionReason,
+    SavedPaymentMethodOrigin,
+    SavedPaymentMethodType,
+)
+
+
+@dataclass
+class PaymentMethodDeleted(Entity):
+    id: str
+    customer_id: str
+    address_id: str
+    type: SavedPaymentMethodType | None
+    origin: SavedPaymentMethodOrigin
+    saved_at: datetime
+    updated_at: datetime
+    deletion_reason: SavedPaymentMethodDeletionReason
+
+    @staticmethod
+    def from_dict(data: dict) -> PaymentMethodDeleted:
+        return PaymentMethodDeleted(
+            id=data["id"],
+            customer_id=data["customer_id"],
+            address_id=data["address_id"],
+            type=SavedPaymentMethodType(data["type"]),
+            origin=SavedPaymentMethodOrigin(data["origin"]),
+            saved_at=datetime.fromisoformat(data["saved_at"]),
+            updated_at=datetime.fromisoformat(data["updated_at"]),
+            deletion_reason=SavedPaymentMethodDeletionReason(data["deletion_reason"]),
+        )

paddle_billing/Notifications/Entities/Shared/Paypal.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+from dataclasses import dataclass
+
+
+@dataclass
+class Paypal:
+    email: str
+    reference: str
+
+    @staticmethod
+    def from_dict(data: dict) -> Paypal:
+        return Paypal(
+            email=data["email"],
+            reference=data["reference"],
+        )

paddle_billing/Notifications/Entities/Shared/SavedPaymentMethodDeletionReason.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SavedPaymentMethodDeletionReason(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    ReplacedByNewerVersion: "SavedPaymentMethodDeletionReason" = "replaced_by_newer_version"
+    Api: "SavedPaymentMethodDeletionReason" = "api"

paddle_billing/Notifications/Entities/Shared/SavedPaymentMethodOrigin.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SavedPaymentMethodOrigin(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    SavedDuringPurchase: "SavedPaymentMethodOrigin" = "saved_during_purchase"
+    Subscription: "SavedPaymentMethodOrigin" = "subscription"

paddle_billing/Notifications/Entities/Shared/SavedPaymentMethodType.py

@@ -0,0 +1,9 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SavedPaymentMethodType(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    Alipay: "SavedPaymentMethodType" = "alipay"
+    ApplePay: "SavedPaymentMethodType" = "apple_pay"
+    Card: "SavedPaymentMethodType" = "card"
+    GooglePay: "SavedPaymentMethodType" = "google_pay"
+    Paypal: "SavedPaymentMethodType" = "paypal"

paddle_billing/Notifications/Entities/Shared/__init__.py

@@ -26,8 +26,14 @@
 from paddle_billing.Notifications.Entities.Shared.PaymentAttemptStatus import PaymentAttemptStatus
 from paddle_billing.Notifications.Entities.Shared.PaymentMethodType import PaymentMethodType
 from paddle_billing.Notifications.Entities.Shared.PayoutTotalsAdjustment import PayoutTotalsAdjustment
+from paddle_billing.Notifications.Entities.Shared.Paypal import Paypal
 from paddle_billing.Notifications.Entities.Shared.PriceQuantity import PriceQuantity
 from paddle_billing.Notifications.Entities.Shared.Proration import Proration
+from paddle_billing.Notifications.Entities.Shared.SavedPaymentMethodDeletionReason import (
+    SavedPaymentMethodDeletionReason,
+)
+from paddle_billing.Notifications.Entities.Shared.SavedPaymentMethodOrigin import SavedPaymentMethodOrigin
+from paddle_billing.Notifications.Entities.Shared.SavedPaymentMethodType import SavedPaymentMethodType
 from paddle_billing.Notifications.Entities.Shared.Status import Status
 from paddle_billing.Notifications.Entities.Shared.TransactionStatus import TransactionStatus
 from paddle_billing.Notifications.Entities.Shared.TaxCategory import TaxCategory

paddle_billing/Notifications/Events/PaymentMethodDeleted.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+
+from paddle_billing.Entities.Event import Event
+from paddle_billing.Entities.Events import EventTypeName
+
+from paddle_billing.Notifications.Entities.Customer import PaymentMethod
+
+
+class PaymentMethodDeleted(Event):
+    def __init__(
+        self,
+        event_id: str,
+        event_type: EventTypeName,
+        occurred_at: datetime,
+        data: PaymentMethod,
+    ):
+        super().__init__(event_id, event_type, occurred_at, data)

paddle_billing/Notifications/Events/PaymentMethodSaved.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+
+from paddle_billing.Entities.Event import Event
+from paddle_billing.Entities.Events import EventTypeName
+
+from paddle_billing.Notifications.Entities.PaymentMethod import PaymentMethod
+
+
+class PaymentMethodSaved(Event):
+    def __init__(
+        self,
+        event_id: str,
+        event_type: EventTypeName,
+        occurred_at: datetime,
+        data: PaymentMethod,
+    ):
+        super().__init__(event_id, event_type, occurred_at, data)

paddle_billing/Resources/Customers/CustomersClient.py

@@ -1,7 +1,12 @@
 from paddle_billing.ResponseParser import ResponseParser
 
-from paddle_billing.Entities.Collections import Paginator, CreditBalanceCollection, CustomerCollection
+from paddle_billing.Entities.Collections import (
+    Paginator,
+    CreditBalanceCollection,
+    CustomerCollection,
+)
 from paddle_billing.Entities.Customer import Customer
+from paddle_billing.Entities.CustomerAuthToken import CustomerAuthToken
 from paddle_billing.Entities.Shared import Status
 
 from paddle_billing.Resources.Customers.Operations import (
@@ -62,3 +67,9 @@ def credit_balances(self, customer_id: str, operation: ListCreditBalances = None
         parser = ResponseParser(self.response)
 
         return CreditBalanceCollection.from_list(parser.get_data())
+
+    def create_auth_token(self, customer_id: str) -> CustomerAuthToken:
+        self.response = self.client.post_raw(f"/customers/{customer_id}/auth-token")
+        parser = ResponseParser(self.response)
+
+        return CustomerAuthToken.from_dict(parser.get_data())

paddle_billing/Resources/PaymentMethods/Operations/ListPaymentMethods.py

@@ -0,0 +1,32 @@
+from paddle_billing.HasParameters import HasParameters
+from paddle_billing.Exceptions.SdkExceptions.InvalidArgumentException import InvalidArgumentException
+from paddle_billing.Resources.Shared.Operations import Pager
+
+
+class ListPaymentMethods(HasParameters):
+    def __init__(
+        self,
+        pager: Pager | None = None,
+        address_ids: list[str] = None,
+        supports_checkout: bool = None,
+    ):
+        self.pager = pager
+        self.address_ids = address_ids
+        self.supports_checkout = supports_checkout
+
+        # Validation
+        if address_ids is not None:
+            invalid_items = [id for id in address_ids if not isinstance(id, str)]
+            if invalid_items:
+                raise InvalidArgumentException.array_contains_invalid_types("ids", str.__name__, invalid_items)
+
+    def get_parameters(self) -> dict:
+        parameters = {}
+        if self.pager:
+            parameters.update(self.pager.get_parameters())
+        if self.address_ids:
+            parameters["address_id"] = ",".join(self.address_ids)
+        if self.supports_checkout is not None:
+            parameters["supports_checkout"] = "true" if self.supports_checkout else "false"
+
+        return parameters

paddle_billing/Resources/PaymentMethods/Operations/__init__.py

@@ -0,0 +1 @@
+from paddle_billing.Resources.PaymentMethods.Operations.ListPaymentMethods import ListPaymentMethods