paddle-python-sdk 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

examples/catalog_management.py

@@ -1,6 +1,6 @@
 from logging import getLogger
-from os      import getenv
-from sys     import exit  # You should use classes/functions that returns instead of exits
+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
 
@@ -8,50 +8,50 @@ from paddle_billing.Entities.Shared import (
     CountryCode,
     CurrencyCode,
     CustomData,
+    Duration,
     Money,
-    TimePeriod,
     PriceQuantity,
     UnitPriceOverride,
     Interval,
     Status,
-    TaxCategory
+    TaxCategory,
 )
 
-from paddle_billing.Exceptions.ApiError                        import ApiError
-from paddle_billing.Exceptions.SdkExceptions.MalformedResponse import MalformedResponse
+from paddle_billing.Exceptions.ApiError import ApiError
 
-from paddle_billing.Resources.Prices.Operations   import CreatePrice, UpdatePrice, PriceIncludes
+from paddle_billing.Resources.Prices.Operations import CreatePrice, UpdatePrice, PriceIncludes
 from paddle_billing.Resources.Products.Operations import CreateProduct, UpdateProduct, ProductIncludes, ListProducts
 
-log = getLogger('my_app')
+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)
+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")
 
 # Determine the environment, defaulting to sandbox
-environment        = getenv('PADDLE_ENVIRONMENT', 'sandbox')
-paddle_environment = getattr(Environment, environment)  # E.g. Environment.sandbox
+environment = Environment(getenv("PADDLE_ENVIRONMENT", "sandbox"))
 
 # Initialize the Paddle client
-paddle = Client(api_key, options=Options(paddle_environment), logger=log)
+paddle = Client(api_key, options=Options(environment), logger=log)
 
 
 # ┌───
 # │ Create Product │
 # └────────────────┘
 try:
-    product = paddle.products.create(CreateProduct(
-        name         = 'Kitten Service',
-        tax_category = TaxCategory.Standard,
-        description  = 'Simply an awesome product',
-        image_url    = 'https://placekitten.com/200/300',
-        custom_data  = CustomData({'foo': 'bar'}),
-    ))
-except (ApiError, MalformedResponse) as error:
+    product = paddle.products.create(
+        CreateProduct(
+            name="Kitten Service",
+            tax_category=TaxCategory.Standard,
+            description="Simply an awesome product",
+            image_url="https://placekitten.com/200/300",
+            custom_data=CustomData({"foo": "bar"}),
+        )
+    )
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -62,12 +62,15 @@ print(f"Created product '{product.id}': {product.description}")
 # │ Update Product │
 # └────────────────┘
 try:
-    product = paddle.products.update(product.id, UpdateProduct(
-        name        = 'Bear Service',
-        image_url   = 'https://placebear.com/200/300',
-        custom_data = CustomData({'beep': 'boop'}),
-    ))
-except (ApiError, MalformedResponse) as error:
+    product = paddle.products.update(
+        product.id,
+        UpdateProduct(
+            name="Bear Service",
+            image_url="https://placebear.com/200/300",
+            custom_data=CustomData({"beep": "boop"}),
+        ),
+    )
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -78,23 +81,24 @@ print(f"Updated product '{product.id}': {product.description}")
 # │ Create Price │
 # └──────────────┘
 try:
-    price = paddle.prices.create(CreatePrice(
-        description   = 'Bear Hug',
-        product_id    = product.id,
-        unit_price    = Money('1000', CurrencyCode.GBP),
-        trial_period  = TimePeriod(Interval.Week, 1),
-        billing_cycle = TimePeriod(Interval.Year, 1),
-        quantity      = PriceQuantity(1, 1),
-        custom_data   = CustomData({'foo': 'bar'}),
-
-        unit_price_overrides=[
-            UnitPriceOverride(
-                [CountryCode.CA, CountryCode.US],
-                Money('5000', CurrencyCode.USD),
-            ),
-        ],
-    ))
-except (ApiError, MalformedResponse) as error:
+    price = paddle.prices.create(
+        CreatePrice(
+            description="Bear Hug",
+            product_id=product.id,
+            unit_price=Money("1000", CurrencyCode.GBP),
+            trial_period=Duration(Interval.Week, 1),
+            billing_cycle=Duration(Interval.Year, 1),
+            quantity=PriceQuantity(1, 1),
+            custom_data=CustomData({"foo": "bar"}),
+            unit_price_overrides=[
+                UnitPriceOverride(
+                    [CountryCode.CA, CountryCode.US],
+                    Money("5000", CurrencyCode.USD),
+                ),
+            ],
+        )
+    )
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -105,12 +109,15 @@ print(f"Created price '{price.id}': {price.description}")
 # │ Update Price │
 # └──────────────┘
 try:
-    price = paddle.prices.update(price.id, UpdatePrice(
-        description = 'One-off Bear Hug',
-        unit_price  = Money('500', CurrencyCode.GBP),
-        custom_data = CustomData({'beep': 'boop'}),
-    ))
-except (ApiError, MalformedResponse) as error:
+    price = paddle.prices.update(
+        price.id,
+        UpdatePrice(
+            description="One-off Bear Hug",
+            unit_price=Money("500", CurrencyCode.GBP),
+            custom_data=CustomData({"beep": "boop"}),
+        ),
+    )
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -122,12 +129,12 @@ print(f"Updated price '{price.id}': {price.description}")
 # └─────────────────────────┘
 try:
     product = paddle.products.get(product.id, [ProductIncludes.Prices])
-except (ApiError, MalformedResponse) as error:
+except ApiError as error:
     print(error)
     exit(1)
 
 print(f"product.prices={product.prices}")
-print(f"Read product '{product.id}' with prices " + ', '.join([str(price.id) for price in product.prices]))
+print(f"Read product '{product.id}' with prices " + ", ".join([str(price.id) for price in product.prices]))
 
 
 # ┌───
@@ -135,7 +142,7 @@ print(f"Read product '{product.id}' with prices " + ', '.join([str(price.id) for
 # └────────────────────────┘
 try:
     price = paddle.prices.get(price.id, [PriceIncludes.Product])
-except (ApiError, MalformedResponse) as error:
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -146,11 +153,13 @@ print(f"Read price '{price.id}' with product {price.product.id if price.product
 # │ Get Products │
 # └──────────────┘
 try:
-    products = paddle.products.list(ListProducts(
-        includes = [ProductIncludes.Prices],
-        statuses = [Status.Active],
-    ))
-except (ApiError, MalformedResponse) as error:
+    products = paddle.products.list(
+        ListProducts(
+            includes=[ProductIncludes.Prices],
+            statuses=[Status.Active],
+        )
+    )
+except ApiError as error:
     print(error)
     exit(1)
 
@@ -160,7 +169,7 @@ except (ApiError, MalformedResponse) as error:
 # └─────────────────────────────┘
 for product in products:
     print(f"Product: {product.name}")
-    print('-' * len(product.name))
+    print("-" * len(product.name))
     for price in product.prices:
         print(f"Price: {price.name} - {price.description}")
     print()

examples/event_polling.py

@@ -1,39 +1,37 @@
 from logging import getLogger
-from os      import getenv
-from sys     import exit  # You should use classes/functions that returns instead of exits
+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.Exceptions.ApiError                        import ApiError
-from paddle_billing.Exceptions.SdkExceptions.MalformedResponse import MalformedResponse
+from paddle_billing.Exceptions.ApiError import ApiError
 
 from paddle_billing.Resources.Events.Operations import ListEvents
 from paddle_billing.Resources.Shared.Operations import Pager
 
-log = getLogger('my_app')
+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)
+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")
 
 # Determine the environment, defaulting to sandbox
-environment        = getenv('PADDLE_ENVIRONMENT', 'sandbox')
-paddle_environment = getattr(Environment, environment)  # E.g. Environment.sandbox
+environment = Environment(getenv("PADDLE_ENVIRONMENT", "sandbox"))
 
 # Initialize the Paddle client
-paddle = Client(api_key, options=Options(paddle_environment), logger=log)
+paddle = Client(api_key, options=Options(environment), logger=log)
 
 # Placeholder for the last processed event ID
-last_processed_event_id = 'evt_01hfxx8t6ek9h399srcrp36jt3'
+last_processed_event_id = "evt_01hfxx8t6ek9h399srcrp36jt3"
 
 events = None
 try:
     # List events starting after the last processed event ID
     events = paddle.events.list(ListEvents(Pager(after=last_processed_event_id)))
-except (ApiError, MalformedResponse) as error:
+except ApiError as error:
     log.error(error)
     # Your additional logic that can handle Paddle's hints about what went wrong
 except Exception as error:
@@ -49,7 +47,7 @@ if not len(events.items):
 
 for event in events:
     last_processed_event_id = event.event_id  # Update the last processed event ID
-    print(f"event: {event.event_id}\t\t Type: {event.event_type.value:28}\t\t Occurred At: {event.occurred_at.format()}")
+    print(f"event: {event.event_id}\t\t Type: {event.event_type.value:28}\t\t Occurred At: {event.occurred_at}")
     # Your additional logic for using each event
 
 # Now you're up-to-date, you should keep a record of the last processed event...

examples/get_products.py

@@ -1,34 +1,37 @@
 from logging import getLogger
-from os      import getenv
-from sys     import exit  # You should use classes/functions that returns instead of exits
+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.Exceptions.ApiError                        import ApiError
-from paddle_billing.Exceptions.SdkExceptions.MalformedResponse import MalformedResponse
+from paddle_billing.Exceptions.ApiError import ApiError
 
-log = getLogger('my_app')
+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 = getenv('PADDLE_SECRET_API_KEY', None)
+api_key = getenv("PADDLE_SECRET_API_KEY", None)
 if not api_key:
     raise ValueError("You must provide the PADDLE_SECRET_API_KEY in your environment variables")
 
 # Determine the environment, defaulting to sandbox
-environment        = getenv('PADDLE_ENVIRONMENT', 'sandbox')
-paddle_environment = getattr(Environment, environment)  # E.g. Environment.sandbox
+environment = Environment(getenv("PADDLE_ENVIRONMENT", "sandbox"))
 
 # Initialize the Paddle client
-paddle = Client(api_key, options=Options(paddle_environment), logger=log)
+paddle = Client(api_key, options=Options(environment), logger=log)
 
 products = None
 try:
     products = paddle.products.list()
-except (ApiError, MalformedResponse) as error:
+except ApiError as error:
     log.error(error)
-    # Your additional logic that can handle Paddle's hints about what went wrong
+    # Your additional logic that can handle Paddle's hints about what went wrong.
+    print(f"error_type: {error.error_type}")
+    print(f"error_code: {error.error_code}")
+    print(f"detail: {error.detail}")
+    print(f"field_errors: {error.field_errors}")
+    print(f"response.status_code: {error.response.status_code}")
 except Exception as error:
     log.error(f"We received an error listing products: {error}")
 

examples/logger.py

@@ -1,25 +1,24 @@
 import logging
 
-from os             import getenv
+from os import getenv
 from paddle_billing import Client, Environment, Options
 
 
 # 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 = getenv('PADDLE_SECRET_API_KEY', None)
+api_key = getenv("PADDLE_SECRET_API_KEY", None)
 if not api_key:
     raise ValueError("You must provide the PADDLE_SECRET_API_KEY in your environment variables")
 
 # Determine the environment, defaulting to sandbox
-environment        = getenv('PADDLE_ENVIRONMENT', 'sandbox')
-paddle_environment = getattr(Environment, environment)  # E.g. Environment.sandbox
+environment = Environment(getenv("PADDLE_ENVIRONMENT", "sandbox"))
 
 # Initialize the Paddle client
 paddle = Client(
     api_key,
-    options = Options(paddle_environment),
-    logger  = logging.getLogger('my_app'),
+    options=Options(environment),
+    logger=logging.getLogger("my_app"),
 )
 
 # Set up logging to standard output
@@ -28,4 +27,7 @@ stdout_handler.setLevel(logging.INFO)
 paddle.log.addHandler(stdout_handler)
 
 # List products
-paddle.products.list()
+products = paddle.products.list()
+
+for product in products:
+    print(f"Product's id: {product.id}")

examples/webhook_verification.py

@@ -0,0 +1,33 @@
+from paddle_billing.Entities.Notifications import NotificationEvent
+from paddle_billing.Notifications import Secret, Verifier
+from examples.Utils.Requests.Request import Request
+
+# This example requires environment variable TEST_MODE=1 to disable time drift checks, e.g.
+# TEST_MODE=1 python webhook_verification.py
+
+secret = "pdl_ntfset_01hs0t3tw21j988db1pam5xg8m_GrOWLNef+vmtjJYq4mSnHNzvc8uWoJ1I"
+
+request = Request.create_from_fixture(
+    "webhook_payload.json",
+    {
+        "Paddle-Signature": "ts=1710498758;h1=558bf93944dbeb4790c7a8af6cb2ea435c8ca9c8396aafc1a4e37424ac132744",
+    },
+)
+
+integrity_check = Verifier().verify(request, Secret(secret))
+
+if integrity_check is True:
+    print("Webhook is verified")
+
+    notification = NotificationEvent.from_request(request)
+    print(f"Notification ID: {notification.notification_id}")
+    print(f"Event ID: {notification.event_id}")
+    print(f"Event Type: {notification.event_type}")
+    print(f"Occurred At: {notification.occurred_at}")
+
+    customer = notification.data
+    print(f"Customer ID: {customer.id}")
+    print(f"Customer Name: {customer.name}")
+    print(f"Customer Email: {customer.email}")
+else:
+    print("Webhook is not verified")