paddle-python-sdk 0.1.0__py3-none-any.whl

paddle_billing/Notifications/Entities/Shared/Checkout.py

@@ -0,0 +1,12 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+
+@dataclass
+class Checkout:
+    url: str | None
+
+
+    @staticmethod
+    def from_dict(data: dict) -> Checkout:
+        return Checkout(url=data.get('url'))

paddle_billing/Notifications/Entities/Shared/CollectionMode.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class CollectionMode(PaddleStrEnum):
+    Automatic = 'automatic'
+    Manual    = 'manual'

paddle_billing/Notifications/Entities/Shared/CountryCode.py

@@ -0,0 +1,233 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class CountryCode(PaddleStrEnum):
+    AD = 'AD'
+    AE = 'AE'
+    AG = 'AG'
+    AI = 'AI'
+    AL = 'AL'
+    AM = 'AM'
+    AO = 'AO'
+    AR = 'AR'
+    AS = 'AS'
+    AT = 'AT'
+    AU = 'AU'
+    AW = 'AW'
+    AX = 'AX'
+    AZ = 'AZ'
+    BA = 'BA'
+    BB = 'BB'
+    BD = 'BD'
+    BE = 'BE'
+    BF = 'BF'
+    BG = 'BG'
+    BH = 'BH'
+    BI = 'BI'
+    BJ = 'BJ'
+    BL = 'BL'
+    BM = 'BM'
+    BN = 'BN'
+    BO = 'BO'
+    BQ = 'BQ'
+    BR = 'BR'
+    BS = 'BS'
+    BT = 'BT'
+    BV = 'BV'
+    BW = 'BW'
+    BZ = 'BZ'
+    CA = 'CA'
+    CC = 'CC'
+    CG = 'CG'
+    CH = 'CH'
+    CI = 'CI'
+    CK = 'CK'
+    CL = 'CL'
+    CM = 'CM'
+    CN = 'CN'
+    CO = 'CO'
+    CR = 'CR'
+    CV = 'CV'
+    CW = 'CW'
+    CX = 'CX'
+    CY = 'CY'
+    CZ = 'CZ'
+    DE = 'DE'
+    DJ = 'DJ'
+    DK = 'DK'
+    DM = 'DM'
+    DO = 'DO'
+    DZ = 'DZ'
+    EC = 'EC'
+    EE = 'EE'
+    EG = 'EG'
+    EH = 'EH'
+    ER = 'ER'
+    ES = 'ES'
+    ET = 'ET'
+    FI = 'FI'
+    FJ = 'FJ'
+    FK = 'FK'
+    FM = 'FM'
+    FO = 'FO'
+    FR = 'FR'
+    GA = 'GA'
+    GB = 'GB'
+    GD = 'GD'
+    GE = 'GE'
+    GF = 'GF'
+    GG = 'GG'
+    GH = 'GH'
+    GI = 'GI'
+    GL = 'GL'
+    GM = 'GM'
+    GN = 'GN'
+    GP = 'GP'
+    GQ = 'GQ'
+    GR = 'GR'
+    GS = 'GS'
+    GT = 'GT'
+    GU = 'GU'
+    GW = 'GW'
+    GY = 'GY'
+    HK = 'HK'
+    HM = 'HM'
+    HN = 'HN'
+    HR = 'HR'
+    HU = 'HU'
+    ID = 'ID'
+    IE = 'IE'
+    IL = 'IL'
+    IM = 'IM'
+    IN = 'IN'
+    IO = 'IO'
+    IQ = 'IQ'
+    IS = 'IS'
+    IT = 'IT'
+    JE = 'JE'
+    JM = 'JM'
+    JO = 'JO'
+    JP = 'JP'
+    KE = 'KE'
+    KG = 'KG'
+    KH = 'KH'
+    KI = 'KI'
+    KM = 'KM'
+    KN = 'KN'
+    KR = 'KR'
+    KW = 'KW'
+    KY = 'KY'
+    KZ = 'KZ'
+    LA = 'LA'
+    LB = 'LB'
+    LC = 'LC'
+    LI = 'LI'
+    LK = 'LK'
+    LR = 'LR'
+    LS = 'LS'
+    LT = 'LT'
+    LU = 'LU'
+    LV = 'LV'
+    MA = 'MA'
+    MC = 'MC'
+    MD = 'MD'
+    ME = 'ME'
+    MF = 'MF'
+    MG = 'MG'
+    MH = 'MH'
+    MK = 'MK'
+    MN = 'MN'
+    MO = 'MO'
+    MP = 'MP'
+    MQ = 'MQ'
+    MR = 'MR'
+    MS = 'MS'
+    MT = 'MT'
+    MU = 'MU'
+    MV = 'MV'
+    MW = 'MW'
+    MX = 'MX'
+    MY = 'MY'
+    MZ = 'MZ'
+    NA = 'NA'
+    NC = 'NC'
+    NE = 'NE'
+    NF = 'NF'
+    NG = 'NG'
+    NL = 'NL'
+    NO = 'NO'
+    NP = 'NP'
+    NR = 'NR'
+    NU = 'NU'
+    NZ = 'NZ'
+    OM = 'OM'
+    PA = 'PA'
+    PE = 'PE'
+    PF = 'PF'
+    PG = 'PG'
+    PH = 'PH'
+    PK = 'PK'
+    PL = 'PL'
+    PM = 'PM'
+    PN = 'PN'
+    PR = 'PR'
+    PS = 'PS'
+    PT = 'PT'
+    PW = 'PW'
+    PY = 'PY'
+    QA = 'QA'
+    RE = 'RE'
+    RO = 'RO'
+    RS = 'RS'
+    RW = 'RW'
+    SA = 'SA'
+    SB = 'SB'
+    SC = 'SC'
+    SE = 'SE'
+    SG = 'SG'
+    SH = 'SH'
+    SI = 'SI'
+    SJ = 'SJ'
+    SK = 'SK'
+    SL = 'SL'
+    SM = 'SM'
+    SN = 'SN'
+    SR = 'SR'
+    ST = 'ST'
+    SV = 'SV'
+    SX = 'SX'
+    SZ = 'SZ'
+    TC = 'TC'
+    TD = 'TD'
+    TF = 'TF'
+    TG = 'TG'
+    TH = 'TH'
+    TJ = 'TJ'
+    TK = 'TK'
+    TL = 'TL'
+    TM = 'TM'
+    TN = 'TN'
+    TO = 'TO'
+    TR = 'TR'
+    TT = 'TT'
+    TV = 'TV'
+    TW = 'TW'
+    TZ = 'TZ'
+    UA = 'UA'
+    UG = 'UG'
+    UM = 'UM'
+    US = 'US'
+    UY = 'UY'
+    UZ = 'UZ'
+    VA = 'VA'
+    VC = 'VC'
+    VG = 'VG'
+    VI = 'VI'
+    VN = 'VN'
+    VU = 'VU'
+    WF = 'WF'
+    WS = 'WS'
+    XK = 'XK'
+    YT = 'YT'
+    ZA = 'ZA'
+    ZM = 'ZM'

paddle_billing/Notifications/Entities/Shared/CurrencyCode.py

@@ -0,0 +1,34 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class CurrencyCode(PaddleStrEnum):
+    USD = 'USD'
+    EUR = 'EUR'
+    GBP = 'GBP'
+    JPY = 'JPY'
+    AUD = 'AUD'
+    CAD = 'CAD'
+    CHF = 'CHF'
+    HKD = 'HKD'
+    SGD = 'SGD'
+    SEK = 'SEK'
+    ARS = 'ARS'
+    BRL = 'BRL'
+    CNY = 'CNY'
+    COP = 'COP'
+    CZK = 'CZK'
+    DKK = 'DKK'
+    HUF = 'HUF'
+    ILS = 'ILS'
+    INR = 'INR'
+    KRW = 'KRW'
+    MXN = 'MXN'
+    NOK = 'NOK'
+    NZD = 'NZD'
+    PLN = 'PLN'
+    RUB = 'RUB'
+    THB = 'THB'
+    TRY = 'TRY'
+    TWD = 'TWD'
+    UAH = 'UAH'
+    ZAR = 'ZAR'

paddle_billing/Notifications/Entities/Shared/CurrencyCodeAdjustments.py

@@ -0,0 +1,7 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class CurrencyCodeAdjustments(PaddleStrEnum):
+    EUR = 'EUR'
+    GBP = 'GBP'
+    USD = 'USD'

paddle_billing/Notifications/Entities/Shared/CurrencyCodePayouts.py

@@ -0,0 +1,17 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class CurrencyCodePayouts(PaddleStrEnum):
+    AUD = 'AUD'
+    CAD = 'CAD'
+    CHF = 'CHF'
+    CNY = 'CNY'
+    CZK = 'CZK'
+    DKK = 'DKK'
+    EUR = 'EUR'
+    GBP = 'GBP'
+    HUF = 'HUF'
+    PLN = 'PLN'
+    SEK = 'SEK'
+    USD = 'USD'
+    ZAR = 'ZAR'

paddle_billing/Notifications/Entities/Shared/CustomData.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class CustomData:
+    data: dict | list  # JSON serializable Python types
+
+
+    def get_parameters(self):
+        return self.data

paddle_billing/Notifications/Entities/Shared/Data.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+from typing      import Any
+
+
+@dataclass
+class Data:
+    data: dict | list | Any  # TODO Any? Should be JSON serializable Python types though
+
+    # from_dict method isn't needed, unless specific processing of 'data' is required.

paddle_billing/Notifications/Entities/Shared/ErrorCode.py

@@ -0,0 +1,21 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class ErrorCode(PaddleStrEnum):
+    AlreadyCanceled         = 'already_canceled'
+    AlreadyRefunded         = 'already_refunded'
+    AuthenticationFailed    = 'authentication_failed'
+    BlockedCard             = 'blocked_card'
+    Canceled                = 'canceled'
+    Declined                = 'declined'
+    ExpiredCard             = 'expired_card'
+    Fraud                   = 'fraud'
+    InvalidAmount           = 'invalid_amount'
+    InvalidPaymentDetails   = 'invalid_payment_details'
+    IssuerUnavailable       = 'issuer_unavailable'
+    NotEnoughBalance        = 'not_enough_balance'
+    PspError                = 'psp_error'
+    RedactedPaymentMethod   = 'redacted_payment_method'
+    SystemError             = 'system_error'
+    TransactionNotPermitted = 'transaction_not_permitted'
+    Unknown                 = 'unknown'

paddle_billing/Notifications/Entities/Shared/ImportMeta.py

@@ -0,0 +1,16 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class ImportMeta:
+    external_id:   str | None
+    imported_from: str
+
+
+    @classmethod
+    def from_dict(cls, data: dict) -> ImportMeta:
+        return ImportMeta(
+            external_id   = data.get('external_id'),
+            imported_from = data['imported_from'],
+        )

paddle_billing/Notifications/Entities/Shared/Interval.py

@@ -0,0 +1,8 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class Interval(PaddleStrEnum):
+    Day   = 'day'
+    Week  = 'week'
+    Month = 'month'
+    Year  = 'year'

paddle_billing/Notifications/Entities/Shared/MethodDetails.py

@@ -0,0 +1,19 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.Card              import Card
+from paddle_billing.Notifications.Entities.Shared.PaymentMethodType import PaymentMethodType
+
+
+@dataclass
+class MethodDetails:
+    type: PaymentMethodType
+    card: Card | None
+
+
+    @classmethod
+    def from_dict(cls, data: dict) -> MethodDetails:
+        return MethodDetails(
+            PaymentMethodType(data['type']),
+            Card.from_dict(data['card']) if data.get('card') else None,
+        )

paddle_billing/Notifications/Entities/Shared/Money.py

@@ -0,0 +1,28 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.CurrencyCode import CurrencyCode
+
+
+@dataclass
+class Money:
+    """
+    https://developer.paddle.com/api-reference/about/data-types#money
+    When specifying the amount, specify it with the lowest denomination of the currency included. For example,
+    $420.69USD would be called with Money('42069', CurrencyCode('USD'))
+    """
+    amount:        str
+    currency_code: CurrencyCode | None
+
+
+    def __post_init__(self):
+        if any(substring in self.amount for substring in [',', '.']):
+            raise ValueError('Money amount should not contain decimals or commas')
+
+
+    @staticmethod
+    def from_dict(data: dict) -> Money:
+        return Money(
+            amount        = data['amount'],
+            currency_code = CurrencyCode(data['currency_code']) if data.get('currency_code') else None,
+        )

paddle_billing/Notifications/Entities/Shared/Original.py

@@ -0,0 +1,18 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.CurrencyCodeAdjustments import CurrencyCodeAdjustments
+
+
+@dataclass
+class Original:
+    amount:        str
+    currency_code: CurrencyCodeAdjustments
+
+
+    @staticmethod
+    def from_dict(data: dict) -> Original:
+        return Original(
+            amount        = data['amount'],
+            currency_code = CurrencyCodeAdjustments(data['currency_code']),
+        )

paddle_billing/Notifications/Entities/Shared/PaymentAttemptStatus.py

@@ -0,0 +1,13 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class PaymentAttemptStatus(PaddleStrEnum):
+    Authorized              = 'authorized'
+    AuthorizedFlagged       = 'authorized_flagged'
+    Canceled                = 'canceled'
+    Captured                = 'captured'
+    Error                   = 'error'
+    ActionRequired          = 'action_required'
+    PendingNoActionRequired = 'pending_no_action_required'
+    Created                 = 'created'
+    Unknown                 = 'unknown'

paddle_billing/Notifications/Entities/Shared/PaymentMethodType.py

@@ -0,0 +1,15 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class PaymentMethodType(PaddleStrEnum):
+    Alipay       = 'alipay'
+    ApplePay     = 'apple_pay'
+    Bancontact   = 'bancontact'
+    Card         = 'card'
+    GooglePay    = 'google_pay'
+    Ideal        = 'ideal'
+    Offline      = 'offline'
+    Paypal       = 'paypal'
+    Unknown      = 'unknown'
+    WireTransfer = 'wire_transfer'
+    Visa         = 'visa'

paddle_billing/Notifications/Entities/Shared/PayoutTotalsAdjustment.py

@@ -0,0 +1,29 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.ChargebackFee       import ChargebackFee
+from paddle_billing.Notifications.Entities.Shared.CurrencyCodePayouts import CurrencyCodePayouts
+
+
+@dataclass
+class PayoutTotalsAdjustment:
+    subtotal:       str
+    tax:            str
+    total:          str
+    fee:            str
+    chargeback_fee: ChargebackFee | None
+    earnings:       str
+    currency_code:  CurrencyCodePayouts
+
+
+    @staticmethod
+    def from_dict(data: dict) -> PayoutTotalsAdjustment:
+        return PayoutTotalsAdjustment(
+            subtotal       = data['subtotal'],
+            tax            = data['tax'],
+            total          = data['total'],
+            fee            = data['fee'],
+            chargeback_fee = ChargebackFee.from_dict(data['chargeback_fee']) if data.get('chargeback_fee') else None,
+            earnings       = data['earnings'],
+            currency_code  = CurrencyCodePayouts(data['currency_code']),
+        )

paddle_billing/Notifications/Entities/Shared/PriceQuantity.py

@@ -0,0 +1,16 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+
+@dataclass
+class PriceQuantity:
+    minimum: int
+    maximum: int
+
+
+    @staticmethod
+    def from_dict(data: dict) -> PriceQuantity:
+        return PriceQuantity(
+            minimum = data['minimum'],
+            maximum = data['maximum'],
+        )

paddle_billing/Notifications/Entities/Shared/Status.py

@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class Status(PaddleStrEnum):
+    Active   = 'active'
+    Archived = 'archived'

paddle_billing/Notifications/Entities/Shared/TaxCategory.py

@@ -0,0 +1,13 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class TaxCategory(PaddleStrEnum):
+    DigitalGoods                = 'digital-goods'
+    Ebooks                      = 'ebooks'
+    ImplementationServices      = 'implementation-services'
+    ProfessionalServices        = 'professional-services'
+    Saas                        = 'saas'
+    SoftwareProgrammingServices = 'software-programming-services'
+    Standard                    = 'standard'
+    TrainingServices            = 'training-services'
+    WebsiteHosting              = 'website-hosting'

paddle_billing/Notifications/Entities/Shared/TaxMode.py

@@ -0,0 +1,7 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class TaxMode(PaddleStrEnum):
+    AccountSetting = 'account_setting'
+    External       = 'external'
+    Internal       = 'internal'

paddle_billing/Notifications/Entities/Shared/TaxRatesUsed.py

@@ -0,0 +1,18 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.Totals import Totals
+
+
+@dataclass
+class TaxRatesUsed:
+    tax_rate: str
+    totals:   Totals
+
+
+    @staticmethod
+    def from_dict(data: dict) -> TaxRatesUsed:
+        return TaxRatesUsed(
+            tax_rate = data['tax_rate'],
+            totals   = Totals.from_dict(data['totals']),
+        )

paddle_billing/Notifications/Entities/Shared/TimePeriod.py

@@ -0,0 +1,18 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+from paddle_billing.Notifications.Entities.Shared.Interval import Interval
+
+
+@dataclass
+class TimePeriod:
+    interval:  Interval
+    frequency: int
+
+
+    @staticmethod
+    def from_dict(data: dict) -> TimePeriod:
+        return TimePeriod(
+            interval  = Interval(data['interval']),
+            frequency = data['frequency'],
+        )

paddle_billing/Notifications/Entities/Shared/Totals.py

@@ -0,0 +1,20 @@
+from __future__  import annotations
+from dataclasses import dataclass
+
+
+@dataclass
+class Totals:
+    subtotal: str
+    discount: str
+    tax:      str
+    total:    str
+
+
+    @staticmethod
+    def from_dict(data: dict) -> Totals:
+        return Totals(
+            subtotal = data['subtotal'],
+            discount = data['discount'],
+            tax      = data['tax'],
+            total    = data['total'],
+        )

paddle_billing/Notifications/Entities/Shared/TransactionOrigin.py

@@ -0,0 +1,10 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+
+
+class TransactionOrigin(PaddleStrEnum):
+    Api                             = 'api'
+    SubscriptionCharge              = 'subscription_charge'
+    SubscriptionPaymentMethodChange = 'subscription_payment_method_change'
+    SubscriptionRecurring           = 'subscription_recurring'
+    SubscriptionUpdate              = 'subscription_update'
+    Web                             = 'web'

paddle_billing/Notifications/Entities/Shared/TransactionPaymentAttempt.py

@@ -0,0 +1,35 @@
+from __future__  import annotations
+from dataclasses import dataclass
+from datetime    import datetime
+
+from paddle_billing.Notifications.Entities.Shared.ErrorCode            import ErrorCode
+from paddle_billing.Notifications.Entities.Shared.MethodDetails        import MethodDetails
+from paddle_billing.Notifications.Entities.Shared.PaymentAttemptStatus import PaymentAttemptStatus
+
+
+@dataclass
+class TransactionPaymentAttempt:
+    payment_attempt_id:       str
+    payment_method_id:        str
+    stored_payment_method_id: str
+    amount:                   str
+    status:                   PaymentAttemptStatus
+    error_code:               ErrorCode | None
+    method_details:           MethodDetails
+    created_at:               datetime
+    captured_at:              datetime | None
+
+
+    @staticmethod
+    def from_dict(data: dict) -> TransactionPaymentAttempt:
+        return TransactionPaymentAttempt(
+            payment_attempt_id       = data['payment_attempt_id'],
+            payment_method_id        = data['payment_method_id'],
+            stored_payment_method_id = data['stored_payment_method_id'],
+            amount                   = data['amount'],
+            status                   = PaymentAttemptStatus(data['status']),
+            method_details           = MethodDetails.from_dict(data['method_details']),
+            created_at               = datetime.fromisoformat(data['created_at']),
+            error_code               = ErrorCode(data['error_code'])               if data.get('error_code')  else None,
+            captured_at              = datetime.fromisoformat(data['captured_at']) if data.get('captured_at') else None,
+        )