paddle-python-sdk 1.2.2__tar.gz → 1.3.0__tar.gz

{paddle_python_sdk-1.2.2/paddle_python_sdk.egg-info → paddle_python_sdk-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: paddle-python-sdk
-Version: 1.2.2
+Version: 1.3.0
 Summary: Paddle's Python SDK for Paddle Billing
 Home-page: https://developer.paddle.com/api-reference/overview
 Author: Paddle and contributors

paddle_python_sdk-1.3.0/examples/adjustments.py

@@ -0,0 +1,69 @@
+from logging import getLogger
+from os import getenv
+from sys import exit  # You should use classes/functions that returns instead of exits
+
+from paddle_billing import Client, Environment, Options
+
+from paddle_billing.Entities.Shared import (
+    Action,
+    AdjustmentType,
+)
+
+from paddle_billing.Exceptions.ApiError import ApiError
+
+from paddle_billing.Resources.Adjustments.Operations import CreateAdjustment, CreateAdjustmentItem
+
+log = getLogger("my_app")
+
+# Verify your Paddle API key was provided by a PADDLE_SECRET_API_KEY environment variable
+# It is strongly advised that you do not include secrets in your source code
+# Use environment variables, and/or secrets management like Vault to obtain your secrets
+api_key: str = getenv("PADDLE_SECRET_API_KEY", None)
+if not api_key:
+    raise ValueError("You must provide the PADDLE_SECRET_API_KEY in your environment variables")
+
+transaction_id: str = getenv("PADDLE_TRANSACTION_ID", None)
+transaction_item_id: str = getenv("PADDLE_TRANSACTION_ITEM_ID", None)
+full_adjustment_transaction_id: str = getenv("PADDLE_FULL_ADJUSTMENT_TRANSACTION_ID", None)
+
+# Determine the environment, defaulting to sandbox
+environment = Environment(getenv("PADDLE_ENVIRONMENT", "sandbox"))
+
+# Initialize the Paddle client
+paddle = Client(api_key, options=Options(environment), logger=log)
+
+
+# ┌───
+# │ Create Partial Adjustment │
+# └───────────────────────────┘
+try:
+    partial_adjustment = paddle.adjustments.create(
+        CreateAdjustment.partial(
+            Action.Refund,
+            [CreateAdjustmentItem(transaction_item_id, AdjustmentType.Partial, "100")],
+            "error",
+            transaction_id,
+        )
+    )
+except ApiError as error:
+    print(error)
+    exit(1)
+
+print(f"Partial Adjustment '{partial_adjustment.id}'")
+
+# ┌───
+# │ Create Full Adjustment │
+# └────────────────────────┘
+try:
+    full_adjustment = paddle.adjustments.create(
+        CreateAdjustment.full(
+            Action.Refund,
+            "error",
+            full_adjustment_transaction_id,
+        )
+    )
+except ApiError as error:
+    print(error)
+    exit(1)
+
+print(f"Full Adjustment '{full_adjustment.id}'")

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_billing/Client.py

@@ -204,7 +204,7 @@ class Client:
                 "Authorization": f"Bearer {self.__api_key}",
                 "Content-Type": "application/json",
                 "Paddle-Version": str(self.use_api_version),
-                "User-Agent": "PaddleSDK/python 1.2.2",
+                "User-Agent": "PaddleSDK/python 1.3.0",
             }
         )
 

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_billing/Entities/Adjustment.py

@@ -6,6 +6,7 @@ from paddle_billing.Entities.Entity import Entity
 from paddle_billing.Entities.Adjustments import AdjustmentItem, AdjustmentTaxRatesUsed
 from paddle_billing.Entities.Shared import (
     Action,
+    AdjustmentActionType,
     AdjustmentStatus,
     CurrencyCode,
     PayoutTotalsAdjustment,
@@ -30,6 +31,7 @@ class Adjustment(Entity):
     created_at: datetime
     updated_at: datetime | None
     tax_rates_used: list[AdjustmentTaxRatesUsed]
+    type: AdjustmentActionType
 
     @staticmethod
     def from_dict(data: dict) -> Adjustment:
@@ -51,4 +53,5 @@ class Adjustment(Entity):
             ),
             updated_at=datetime.fromisoformat(data["updated_at"]) if data.get("updated_at") else None,
             tax_rates_used=[AdjustmentTaxRatesUsed.from_dict(item) for item in data["tax_rates_used"]],
+            type=AdjustmentStatus(data["type"]),
         )

paddle_python_sdk-1.3.0/paddle_billing/Entities/Shared/AdjustmentActionType.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class AdjustmentActionType(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    Full: "AdjustmentActionType" = "full"
+    Partial: "AdjustmentActionType" = "partial"

{paddle_python_sdk-1.2.2/paddle_billing/Notifications → paddle_python_sdk-1.3.0/paddle_billing}/Entities/Shared/CurrencyCode.py

@@ -31,4 +31,5 @@ class CurrencyCode(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
     TRY: "CurrencyCode" = "TRY"
     TWD: "CurrencyCode" = "TWD"
     UAH: "CurrencyCode" = "UAH"
+    VND: "CurrencyCode" = "VND"
     ZAR: "CurrencyCode" = "ZAR"

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_billing/Entities/Shared/__init__.py

@@ -1,5 +1,6 @@
 from paddle_billing.Entities.Shared.Action import Action
 from paddle_billing.Entities.Shared.AddressPreview import AddressPreview
+from paddle_billing.Entities.Shared.AdjustmentActionType import AdjustmentActionType
 from paddle_billing.Entities.Shared.AdjustmentItemTotals import AdjustmentItemTotals
 from paddle_billing.Entities.Shared.AdjustmentStatus import AdjustmentStatus
 from paddle_billing.Entities.Shared.AdjustmentTotals import AdjustmentTotals

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_billing/Notifications/Entities/Adjustment.py

@@ -6,6 +6,7 @@ from paddle_billing.Notifications.Entities.Adjustments import AdjustmentItem, Ad
 from paddle_billing.Notifications.Entities.Entity import Entity
 from paddle_billing.Notifications.Entities.Shared import (
     Action,
+    AdjustmentActionType,
     AdjustmentStatus,
     CurrencyCode,
     PayoutTotalsAdjustment,
@@ -30,6 +31,7 @@ class Adjustment(Entity):
     created_at: datetime
     updated_at: datetime | None
     tax_rates_used: list[AdjustmentTaxRatesUsed] | None
+    type: AdjustmentActionType | None
 
     @staticmethod
     def from_dict(data: dict) -> Adjustment:
@@ -55,4 +57,5 @@ class Adjustment(Entity):
                 if data.get("tax_rates_used")
                 else None
             ),
+            type=AdjustmentActionType(data["type"]) if data.get("type") else None,
         )

paddle_python_sdk-1.3.0/paddle_billing/Notifications/Entities/Shared/AdjustmentActionType.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class AdjustmentActionType(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    Full: "AdjustmentActionType" = "full"
+    Partial: "AdjustmentActionType" = "partial"

{paddle_python_sdk-1.2.2/paddle_billing → paddle_python_sdk-1.3.0/paddle_billing/Notifications}/Entities/Shared/CurrencyCode.py

@@ -31,4 +31,5 @@ class CurrencyCode(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
     TRY: "CurrencyCode" = "TRY"
     TWD: "CurrencyCode" = "TWD"
     UAH: "CurrencyCode" = "UAH"
+    VND: "CurrencyCode" = "VND"
     ZAR: "CurrencyCode" = "ZAR"

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_billing/Notifications/Entities/Shared/__init__.py

@@ -1,5 +1,6 @@
 from paddle_billing.Notifications.Entities.Shared.Action import Action
 from paddle_billing.Notifications.Entities.Shared.AddressPreview import AddressPreview
+from paddle_billing.Notifications.Entities.Shared.AdjustmentActionType import AdjustmentActionType
 from paddle_billing.Notifications.Entities.Shared.AdjustmentItemTotals import AdjustmentItemTotals
 from paddle_billing.Notifications.Entities.Shared.AdjustmentStatus import AdjustmentStatus
 from paddle_billing.Notifications.Entities.Shared.AdjustmentTotals import AdjustmentTotals

paddle_python_sdk-1.3.0/paddle_billing/Resources/Adjustments/Operations/CreateAdjustment.py

@@ -0,0 +1,58 @@
+from dataclasses import dataclass
+
+from paddle_billing.Undefined import Undefined
+
+from paddle_billing.Operation import Operation
+
+from paddle_billing.Entities.Shared import Action, AdjustmentActionType
+
+from paddle_billing.Resources.Adjustments.Operations import CreateAdjustmentItem
+
+from paddle_billing.Exceptions.SdkExceptions.InvalidArgumentException import InvalidArgumentException
+
+
+@dataclass
+class CreateAdjustment(Operation):
+    action: Action
+    items: list[CreateAdjustmentItem] | None | Undefined
+    reason: str
+    transaction_id: str
+    type: AdjustmentActionType | Undefined = Undefined()
+
+    def __post_init__(self):
+        if self.type != AdjustmentActionType.Full and (
+            self.items is None or isinstance(self.items, Undefined) or len(self.items) == 0
+        ):
+            raise InvalidArgumentException.array_is_empty("items")
+
+        if self.type == AdjustmentActionType.Full and isinstance(self.items, list):
+            raise InvalidArgumentException("items are not allowed when the adjustment type is full")
+
+    @staticmethod
+    def full(
+        action: Action,
+        reason: str,
+        transaction_id: str,
+    ) -> "CreateAdjustment":
+        return CreateAdjustment(
+            action=action,
+            reason=reason,
+            transaction_id=transaction_id,
+            items=Undefined(),
+            type=AdjustmentActionType.Full,
+        )
+
+    @staticmethod
+    def partial(
+        action: Action,
+        items: list[CreateAdjustmentItem],
+        reason: str,
+        transaction_id: str,
+    ) -> "CreateAdjustment":
+        return CreateAdjustment(
+            action=action,
+            reason=reason,
+            transaction_id=transaction_id,
+            items=items,
+            type=AdjustmentActionType.Partial,
+        )

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0/paddle_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: paddle-python-sdk
-Version: 1.2.2
+Version: 1.3.0
 Summary: Paddle's Python SDK for Paddle Billing
 Home-page: https://developer.paddle.com/api-reference/overview
 Author: Paddle and contributors

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/paddle_python_sdk.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 setup.cfg
 setup.py
 examples/__init__.py
+examples/adjustments.py
 examples/catalog_management.py
 examples/event_polling.py
 examples/get_products.py
@@ -116,6 +117,7 @@ paddle_billing/Entities/Reports/TransactionsReportType.py
 paddle_billing/Entities/Reports/__init__.py
 paddle_billing/Entities/Shared/Action.py
 paddle_billing/Entities/Shared/AddressPreview.py
+paddle_billing/Entities/Shared/AdjustmentActionType.py
 paddle_billing/Entities/Shared/AdjustmentItemTotals.py
 paddle_billing/Entities/Shared/AdjustmentStatus.py
 paddle_billing/Entities/Shared/AdjustmentTotals.py
@@ -261,6 +263,7 @@ paddle_billing/Notifications/Entities/Reports/ReportType.py
 paddle_billing/Notifications/Entities/Reports/__init__.py
 paddle_billing/Notifications/Entities/Shared/Action.py
 paddle_billing/Notifications/Entities/Shared/AddressPreview.py
+paddle_billing/Notifications/Entities/Shared/AdjustmentActionType.py
 paddle_billing/Notifications/Entities/Shared/AdjustmentItemTotals.py
 paddle_billing/Notifications/Entities/Shared/AdjustmentStatus.py
 paddle_billing/Notifications/Entities/Shared/AdjustmentTotals.py

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 
 setup(
-    version="1.2.2",
+    version="1.3.0",
     author="Paddle and contributors",
     author_email="team-dx@paddle.com",
     description="Paddle's Python SDK for Paddle Billing",

{paddle_python_sdk-1.2.2 → paddle_python_sdk-1.3.0}/tests/Functional/Resources/Adjustments/test_AdjustmentsClient.py

@@ -5,7 +5,7 @@ from urllib.parse import unquote
 from paddle_billing.Entities.Adjustment import Adjustment, AdjustmentTaxRatesUsed
 from paddle_billing.Entities.Collections import AdjustmentCollection
 from paddle_billing.Entities.AdjustmentCreditNote import AdjustmentCreditNote
-from paddle_billing.Entities.Shared import Action, AdjustmentStatus, AdjustmentType, Disposition
+from paddle_billing.Entities.Shared import Action, AdjustmentActionType, AdjustmentStatus, AdjustmentType, Disposition
 
 from paddle_billing.Resources.Adjustments.Operations import (
     CreateAdjustment,
@@ -15,6 +15,8 @@ from paddle_billing.Resources.Adjustments.Operations import (
 )
 from paddle_billing.Resources.Shared.Operations import Pager
 
+from paddle_billing.Undefined import Undefined
+
 from tests.Utils.ReadsFixture import ReadsFixtures
 
 
@@ -49,10 +51,77 @@ class TestAdjustmentsClient:
                 ReadsFixtures.read_raw_json_fixture("response/full_entity"),
                 "/adjustments",
             ),
+            (
+                CreateAdjustment(
+                    Action.Refund,
+                    [CreateAdjustmentItem("txnitm_01h8bxryv3065dyh6103p3yg28", AdjustmentType.Partial, "100")],
+                    "error",
+                    "txn_01h8bxpvx398a7zbawb77y0kp5",
+                    AdjustmentActionType.Partial,
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/create_type_partial_with_items"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/minimal_entity"),
+                "/adjustments",
+            ),
+            (
+                CreateAdjustment.partial(
+                    Action.Refund,
+                    [CreateAdjustmentItem("txnitm_01h8bxryv3065dyh6103p3yg28", AdjustmentType.Partial, "100")],
+                    "error",
+                    "txn_01h8bxpvx398a7zbawb77y0kp5",
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/create_type_partial_with_items"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/minimal_entity"),
+                "/adjustments",
+            ),
+            (
+                CreateAdjustment.full(
+                    Action.Refund,
+                    "error",
+                    "txn_01h8bxpvx398a7zbawb77y0kp5",
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/create_type_full_with_no_items"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/minimal_entity"),
+                "/adjustments",
+            ),
+            (
+                CreateAdjustment(
+                    Action.Refund,
+                    None,
+                    "error",
+                    "txn_01h8bxpvx398a7zbawb77y0kp5",
+                    AdjustmentActionType.Full,
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/create_type_full_with_null_items"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/minimal_entity"),
+                "/adjustments",
+            ),
+            (
+                CreateAdjustment(
+                    Action.Refund,
+                    Undefined(),
+                    "error",
+                    "txn_01h8bxpvx398a7zbawb77y0kp5",
+                    AdjustmentActionType.Full,
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/create_type_full_with_no_items"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/minimal_entity"),
+                "/adjustments",
+            ),
         ],
         ids=[
             "Create adjustment with basic data",
             "Create adjustment with full data",
+            "Create adjustment with basic data with type",
+            "Create partial adjustment with items",
+            "Create full adjustment with no items",
+            "Create full adjustment with None items",
+            "Create full adjustment with Undefined items",
         ],
     )
     def test_create_adjustment_uses_expected_payload(

paddle_python_sdk-1.2.2/paddle_billing/Resources/Adjustments/Operations/CreateAdjustment.py

@@ -1,15 +0,0 @@
-from dataclasses import dataclass
-
-from paddle_billing.Operation import Operation
-
-from paddle_billing.Entities.Shared import Action
-
-from paddle_billing.Resources.Adjustments.Operations import CreateAdjustmentItem
-
-
-@dataclass
-class CreateAdjustment(Operation):
-    action: Action
-    items: list[CreateAdjustmentItem]
-    reason: str
-    transaction_id: str