boilpayment 0.2.0__py3-none-any.whl

boilpayment/__init__.py

@@ -0,0 +1,337 @@
+"""boilpayment -- root export.
+
+Deliberately narrow (see ../README.md "Root export & name collisions" for the full rationale and
+the two real name collisions this avoids). What's here:
+  1. The full surface of boilpayment_core (types, Policy, Clock/IdGen, period/money
+     helpers, idempotency helpers, in-memory reference implementations, logging) -- this is what
+     every other module's function signatures are built from, so it's safe and expected to be
+     fully available at the root.
+  2. A curated set of the most-used entry points from the five core operation modules
+     (lifecycle, credits, refund, usage, webhook), so
+     `from boilpayment import upgrade, consume, evaluate, record, receive` covers the
+     common path without picking a submodule.
+
+NOT re-exported here -- use the dedicated submodule instead:
+  - `.stripe`, `.toss`, `.portone`, `.polar` -- the four provider adapters export several
+    same-named functions/types with DIFFERENT shapes (`normalize_failure`,
+    `normalize_subscription`, `normalize_refund`, `map_event_type`, `to_normalized_event` collide
+    between stripe/polar; `CashReceiptType`, `CashReceiptStatus`, `CashReceipt` collide between
+    toss/portone). Bundling any two of them at the root would silently shadow one implementation
+    with the other.
+  - `.notify`, `.cs`, `.postgres` -- add-on/infra modules, not every project uses them.
+  - `.refund`'s own `proration_ratio` (and `days_between`/`apply_rounding`/
+    `weighted_avg_unit_price`) -- `proration_ratio` is a REAL collision with core's own
+    `proration_ratio` (re-exported via #1 above); refund's copy is available at `.refund` only, so
+    `from boilpayment import ...` always gets core's version unambiguously.
+  - the rest of `.lifecycle` (`downgrade`/`convert_trial`/`retry_on_version_conflict`/the
+    `dunning`, `scheduler`, `period` submodules), `.credits` (`grant_for_period`/
+    `rollover_on_renewal`/`clawback`/`expire_due`/`notify_expiring`), `.usage`
+    (`close_period`/`flush_outbox`), `.webhook` (`process_pending`/`default_handlers`/http
+    helpers/correlation ids) -- deeper wiring, no collisions, just kept off the root to keep it a
+    short list. Pull them from their submodule.
+"""
+
+from __future__ import annotations
+
+from boilpayment_core import (
+    DEFAULT_POLICY,
+    ZERO_DECIMAL_CURRENCIES,
+    AnnualRefundMethod,
+    AppendResult,
+    Balance,
+    BankReset,
+    BaseLogger,
+    CancelCredits,
+    CancelMode,
+    CashReceiptMode,
+    CashReceiptRef,
+    CashReceiptType,
+    Checkout,
+    ClawbackShortfall,
+    Clock,
+    CollectingLogger,
+    CollectingNotifier,
+    ConsoleLogger,
+    ConsumeInput,
+    ConsumeOrder,
+    ConsumeResult,
+    CreateCheckoutInput,
+    CsCase,
+    CsCaseKind,
+    CsCaseStatus,
+    Customer,
+    CustomerStatus,
+    Deps,
+    DisputeOnLost,
+    DisputeOnOpen,
+    DowngradeMode,
+    ExpiringBucket,
+    FeeBearer,
+    FixedClock,
+    GrantDuringGrace,
+    GrantLagBehavior,
+    IdGen,
+    InMemoryLedger,
+    InMemoryRepo,
+    InsufficientBalanceError,
+    Interval,
+    IntervalChangeMode,
+    LedgerEntry,
+    LedgerKind,
+    LedgerReference,
+    LedgerSource,
+    LedgerStore,
+    Logger,
+    LogLevel,
+    MemTable,
+    Money,
+    MonthEndAnchor,
+    MultipleSubscriptions,
+    NegativeBalance,
+    NegativeOffset,
+    NewLedgerEntry,
+    NoopLogger,
+    NoopNotifier,
+    NormalizedEvent,
+    NormalizedEventType,
+    Notification,
+    Notifier,
+    NotifyType,
+    OnFinalFailure,
+    OnRecovery,
+    Operation,
+    OperationStatus,
+    OutboxItem,
+    Overage,
+    OveruseBehavior,
+    PauseMode,
+    Payment,
+    PaymentFailure,
+    PaymentKind,
+    PaymentKitError,
+    PaymentProvider,
+    PaymentStatus,
+    Period,
+    Plan,
+    PlanPrice,
+    Policy,
+    PolicyValidationError,
+    Pool,
+    PoolMode,
+    ProrationDenominator,
+    ProviderCapabilities,
+    ProviderError,
+    ProviderName,
+    ProviderRef,
+    Refund,
+    RefundDecision,
+    RefundMethod,
+    RefundRounding,
+    RefundStatus,
+    RegrantMode,
+    Repo,
+    RevokeShortfall,
+    Rollover,
+    RunIdempotentResult,
+    SequentialIdGen,
+    Subscription,
+    SubscriptionStatus,
+    SystemClock,
+    Table,
+    TrialAbuseGuard,
+    TrialCreditsOnCancel,
+    TrialCreditsOnConvert,
+    UpgradeCreditDelta,
+    UpgradeMode,
+    UsageDuringGrace,
+    UsageEvent,
+    UuidIdGen,
+    WebhookEventRecord,
+    WebhookEventStatus,
+    WebhookSignatureError,
+    add_money,
+    assert_same_currency,
+    civil_day_of,
+    days_in_month,
+    days_in_period,
+    deserialize_cs_case,
+    deserialize_ledger_entry,
+    deserialize_refund,
+    deserialize_subscription,
+    elapsed_ratio,
+    hash_payload,
+    money,
+    mul_money_ratio,
+    next_period,
+    period_containing,
+    proration_ratio,
+    redact,
+    resolve_policy,
+    serialize_cs_case,
+    serialize_ledger_entry,
+    serialize_refund,
+    serialize_subscription,
+    stable_stringify,
+    validate_policy,
+)
+from boilpayment_credits import consume, topup
+from boilpayment_lifecycle import cancel, downgrade, reactivate, upgrade
+from boilpayment_refund import evaluate, execute, on_external_refund
+from boilpayment_usage import check, record
+from boilpayment_webhook import default_handlers, process, receive
+
+__all__ = [
+    "DEFAULT_POLICY",
+    "ZERO_DECIMAL_CURRENCIES",
+    "AnnualRefundMethod",
+    "AppendResult",
+    "Balance",
+    "BankReset",
+    "BaseLogger",
+    "CancelCredits",
+    "CancelMode",
+    "CashReceiptMode",
+    "CashReceiptRef",
+    "CashReceiptType",
+    "Checkout",
+    "ClawbackShortfall",
+    "Clock",
+    "CollectingLogger",
+    "CollectingNotifier",
+    "ConsoleLogger",
+    "ConsumeInput",
+    "ConsumeOrder",
+    "ConsumeResult",
+    "CreateCheckoutInput",
+    "CsCase",
+    "CsCaseKind",
+    "CsCaseStatus",
+    "Customer",
+    "CustomerStatus",
+    "Deps",
+    "DisputeOnLost",
+    "DisputeOnOpen",
+    "DowngradeMode",
+    "ExpiringBucket",
+    "FeeBearer",
+    "FixedClock",
+    "GrantDuringGrace",
+    "GrantLagBehavior",
+    "IdGen",
+    "InMemoryLedger",
+    "InMemoryRepo",
+    "InsufficientBalanceError",
+    "Interval",
+    "IntervalChangeMode",
+    "LedgerEntry",
+    "LedgerKind",
+    "LedgerReference",
+    "LedgerSource",
+    "LedgerStore",
+    "LogLevel",
+    "Logger",
+    "MemTable",
+    "Money",
+    "MonthEndAnchor",
+    "MultipleSubscriptions",
+    "NegativeBalance",
+    "NegativeOffset",
+    "NewLedgerEntry",
+    "NoopLogger",
+    "NoopNotifier",
+    "NormalizedEvent",
+    "NormalizedEventType",
+    "Notification",
+    "Notifier",
+    "NotifyType",
+    "OnFinalFailure",
+    "OnRecovery",
+    "Operation",
+    "OperationStatus",
+    "OutboxItem",
+    "Overage",
+    "OveruseBehavior",
+    "PauseMode",
+    "Payment",
+    "PaymentFailure",
+    "PaymentKind",
+    "PaymentKitError",
+    "PaymentProvider",
+    "PaymentStatus",
+    "Period",
+    "Plan",
+    "PlanPrice",
+    "Policy",
+    "PolicyValidationError",
+    "Pool",
+    "PoolMode",
+    "ProrationDenominator",
+    "ProviderCapabilities",
+    "ProviderError",
+    "ProviderName",
+    "ProviderRef",
+    "Refund",
+    "RefundDecision",
+    "RefundMethod",
+    "RefundRounding",
+    "RefundStatus",
+    "RegrantMode",
+    "Repo",
+    "RevokeShortfall",
+    "Rollover",
+    "RunIdempotentResult",
+    "SequentialIdGen",
+    "Subscription",
+    "SubscriptionStatus",
+    "SystemClock",
+    "Table",
+    "TrialAbuseGuard",
+    "TrialCreditsOnCancel",
+    "TrialCreditsOnConvert",
+    "UpgradeCreditDelta",
+    "UpgradeMode",
+    "UsageDuringGrace",
+    "UsageEvent",
+    "UuidIdGen",
+    "WebhookEventRecord",
+    "WebhookEventStatus",
+    "WebhookSignatureError",
+    "add_money",
+    "assert_same_currency",
+    "cancel",
+    "check",
+    "civil_day_of",
+    "consume",
+    "days_in_month",
+    "days_in_period",
+    "default_handlers",
+    "deserialize_cs_case",
+    "deserialize_ledger_entry",
+    "deserialize_refund",
+    "deserialize_subscription",
+    "downgrade",
+    "elapsed_ratio",
+    "evaluate",
+    "execute",
+    "hash_payload",
+    "money",
+    "mul_money_ratio",
+    "next_period",
+    "on_external_refund",
+    "period_containing",
+    "process",
+    "proration_ratio",
+    "reactivate",
+    "receive",
+    "record",
+    "redact",
+    "resolve_policy",
+    "serialize_cs_case",
+    "serialize_ledger_entry",
+    "serialize_refund",
+    "serialize_subscription",
+    "stable_stringify",
+    "topup",
+    "upgrade",
+    "validate_policy",
+]

boilpayment/core.py

@@ -0,0 +1,310 @@
+"""Thin re-export -- see ../README.md. Full surface of boilpayment_core (types, Policy, Clock/IdGen, period/money
+helpers, idempotency helpers, in-memory reference implementations, logging). This is also
+re-exported in full from the package root (boilpayment).
+"""
+
+from __future__ import annotations
+
+from boilpayment_core import (
+    DEFAULT_POLICY,
+    AppendResult,
+    Balance,
+    BaseLogger,
+    CancelPolicy,
+    CashReceiptPolicy,
+    CashReceiptRef,
+    Checkout,
+    Clock,
+    CollectingLogger,
+    CollectingNotifier,
+    ConsoleLogger,
+    ConsumeInput,
+    ConsumeResult,
+    CreateCheckoutInput,
+    CreditConversion,
+    CreditExpiryDays,
+    CreditsPolicy,
+    CsAutoApprovePolicy,
+    CsCase,
+    CsFraudPolicy,
+    CsPolicy,
+    CsRegrantPolicy,
+    Customer,
+    Deps,
+    DisputePolicy,
+    DowngradePolicy,
+    DunningPolicy,
+    ExpiringBucket,
+    FixedClock,
+    IapSettings,
+    IdGen,
+    InMemoryLedger,
+    InMemoryRepo,
+    InsufficientBalanceError,
+    IntervalChangePolicy,
+    LedgerEntry,
+    LedgerReference,
+    LedgerStore,
+    Logger,
+    MemTable,
+    Money,
+    NewLedgerEntry,
+    NoopLogger,
+    NoopNotifier,
+    NormalizedEvent,
+    Notification,
+    Notifier,
+    Operation,
+    OperationTable,
+    OutboxItem,
+    PausePolicy,
+    Payment,
+    PaymentFailure,
+    PaymentKitError,
+    PaymentProvider,
+    Period,
+    PeriodPolicy,
+    Plan,
+    PlanPrice,
+    Policy,
+    PolicyValidationError,
+    ProrationPolicy,
+    ProviderCapabilities,
+    ProviderError,
+    ProviderRef,
+    Refund,
+    RefundDecision,
+    RefundLookupProvider,
+    RefundPolicy,
+    RefundReasons,
+    Repo,
+    RetentionPolicy,
+    RunIdempotentResult,
+    SequentialIdGen,
+    StoreProof,
+    StorePurchaseProvider,
+    Subscription,
+    SubscriptionPolicy,
+    SystemClock,
+    T,
+    Table,
+    TrialPolicy,
+    UpgradePolicy,
+    UsageEvent,
+    UsagePolicy,
+    UuidIdGen,
+    VerifiedStorePurchase,
+    WebhookEventRecord,
+    WebhookSignatureError,
+    add_money,
+    assert_same_currency,
+    attempt_review,
+    civil_day_of,
+    clock,
+    currency_exponent,
+    days_in_month,
+    days_in_period,
+    deserialize_cs_case,
+    deserialize_ledger_entry,
+    deserialize_refund,
+    deserialize_subscription,
+    elapsed_ratio,
+    expected_attempt_amount,
+    find_local_payment,
+    hash_payload,
+    hold_attempt_for_review,
+    iap_settings_from_dict,
+    idempotent,
+    is_closed_by_person,
+    is_legacy_attempt_row,
+    is_store_purchase_provider,
+    is_under_review,
+    iso_z,
+    key_matches_instant,
+    keys,
+    ledger_instant_key,
+    logger,
+    lookup_mismatch,
+    memory,
+    minor_units_from_decimal,
+    minor_units_from_milliunits,
+    money,
+    mul_money_ratio,
+    next_period,
+    operation_instant_key,
+    payment_refs,
+    period,
+    period_containing,
+    policy,
+    policy_from_dict,
+    policy_to_dict,
+    proration_fraction,
+    proration_ratio,
+    record_payment_ref_aliases,
+    redact,
+    resolve_policy,
+    round_half_away_from_zero,
+    run_idempotent,
+    scale_minor,
+    serialize_cs_case,
+    serialize_ledger_entry,
+    serialize_refund,
+    serialize_subscription,
+    stable_stringify,
+    store,
+    store_account_token,
+    types,
+    validate_policy,
+)
+
+__all__ = [
+    "DEFAULT_POLICY",
+    "AppendResult",
+    "Balance",
+    "BaseLogger",
+    "CancelPolicy",
+    "CashReceiptPolicy",
+    "CashReceiptRef",
+    "Checkout",
+    "Clock",
+    "CollectingLogger",
+    "CollectingNotifier",
+    "ConsoleLogger",
+    "ConsumeInput",
+    "ConsumeResult",
+    "CreateCheckoutInput",
+    "CreditConversion",
+    "CreditExpiryDays",
+    "CreditsPolicy",
+    "CsAutoApprovePolicy",
+    "CsCase",
+    "CsFraudPolicy",
+    "CsPolicy",
+    "CsRegrantPolicy",
+    "Customer",
+    "Deps",
+    "DisputePolicy",
+    "DowngradePolicy",
+    "DunningPolicy",
+    "ExpiringBucket",
+    "FixedClock",
+    "IapSettings",
+    "IdGen",
+    "InMemoryLedger",
+    "InMemoryRepo",
+    "InsufficientBalanceError",
+    "IntervalChangePolicy",
+    "LedgerEntry",
+    "LedgerReference",
+    "LedgerStore",
+    "Logger",
+    "MemTable",
+    "Money",
+    "NewLedgerEntry",
+    "NoopLogger",
+    "NoopNotifier",
+    "NormalizedEvent",
+    "Notification",
+    "Notifier",
+    "Operation",
+    "OperationTable",
+    "OutboxItem",
+    "PausePolicy",
+    "Payment",
+    "PaymentFailure",
+    "PaymentKitError",
+    "PaymentProvider",
+    "Period",
+    "PeriodPolicy",
+    "Plan",
+    "PlanPrice",
+    "Policy",
+    "PolicyValidationError",
+    "ProrationPolicy",
+    "ProviderCapabilities",
+    "ProviderError",
+    "ProviderRef",
+    "Refund",
+    "RefundDecision",
+    "RefundLookupProvider",
+    "RefundPolicy",
+    "RefundReasons",
+    "Repo",
+    "RetentionPolicy",
+    "RunIdempotentResult",
+    "SequentialIdGen",
+    "StoreProof",
+    "StorePurchaseProvider",
+    "Subscription",
+    "SubscriptionPolicy",
+    "SystemClock",
+    "T",
+    "Table",
+    "TrialPolicy",
+    "UpgradePolicy",
+    "UsageEvent",
+    "UsagePolicy",
+    "UuidIdGen",
+    "VerifiedStorePurchase",
+    "WebhookEventRecord",
+    "WebhookSignatureError",
+    "add_money",
+    "assert_same_currency",
+    "attempt_review",
+    "civil_day_of",
+    "clock",
+    "currency_exponent",
+    "days_in_month",
+    "days_in_period",
+    "deserialize_cs_case",
+    "deserialize_ledger_entry",
+    "deserialize_refund",
+    "deserialize_subscription",
+    "elapsed_ratio",
+    "expected_attempt_amount",
+    "find_local_payment",
+    "hash_payload",
+    "hold_attempt_for_review",
+    "iap_settings_from_dict",
+    "idempotent",
+    "is_closed_by_person",
+    "is_legacy_attempt_row",
+    "is_store_purchase_provider",
+    "is_under_review",
+    "iso_z",
+    "key_matches_instant",
+    "keys",
+    "ledger_instant_key",
+    "logger",
+    "lookup_mismatch",
+    "memory",
+    "minor_units_from_decimal",
+    "minor_units_from_milliunits",
+    "money",
+    "mul_money_ratio",
+    "next_period",
+    "operation_instant_key",
+    "payment_refs",
+    "period",
+    "period_containing",
+    "policy",
+    "policy_from_dict",
+    "policy_to_dict",
+    "proration_fraction",
+    "proration_ratio",
+    "record_payment_ref_aliases",
+    "redact",
+    "resolve_policy",
+    "round_half_away_from_zero",
+    "run_idempotent",
+    "scale_minor",
+    "serialize_cs_case",
+    "serialize_ledger_entry",
+    "serialize_refund",
+    "serialize_subscription",
+    "stable_stringify",
+    "store",
+    "store_account_token",
+    "types",
+    "validate_policy",
+]

boilpayment/credits.py

@@ -0,0 +1,70 @@
+"""Thin re-export -- see ../README.md. Full surface of boilpayment_credits (grant, consume, rollover, clawback,
+expire, notify_expiring).
+"""
+from __future__ import annotations
+
+from boilpayment_credits import (
+    ClawbackInput,
+    ClawbackResult,
+    ConsumeCreditsInput,
+    ExpireDueInput,
+    ExpireDueResult,
+    ExpiringNotice,
+    GrantForPeriodInput,
+    GrantPoolInput,
+    GrantResult,
+    ManualAdjustInput,
+    NotifyExpiringInput,
+    NotifyExpiringResult,
+    RolloverInput,
+    RolloverResult,
+    TopupInput,
+    clawback,
+    consume,
+    default_expiry,
+    expire,
+    expire_due,
+    grant,
+    grant_for_period,
+    grant_promo,
+    grant_trial,
+    manual_grant,
+    manual_revoke,
+    notify_expiring,
+    rollover,
+    rollover_on_renewal,
+    topup,
+)
+
+__all__ = [
+    "ClawbackInput",
+    "ClawbackResult",
+    "ConsumeCreditsInput",
+    "ExpireDueInput",
+    "ExpireDueResult",
+    "ExpiringNotice",
+    "GrantForPeriodInput",
+    "GrantPoolInput",
+    "GrantResult",
+    "ManualAdjustInput",
+    "NotifyExpiringInput",
+    "NotifyExpiringResult",
+    "RolloverInput",
+    "RolloverResult",
+    "TopupInput",
+    "clawback",
+    "consume",
+    "default_expiry",
+    "expire",
+    "expire_due",
+    "grant",
+    "grant_for_period",
+    "grant_promo",
+    "grant_trial",
+    "manual_grant",
+    "manual_revoke",
+    "notify_expiring",
+    "rollover",
+    "rollover_on_renewal",
+    "topup",
+]