forjio-plugipay 0.5.0__tar.gz

forjio_plugipay-0.5.0/.gitignore

@@ -0,0 +1,34 @@
+node_modules/
+dist/
+.next/
+.env
+.env.local
+.env.*.local
+*.log
+.DS_Store
+*.swp
+coverage/
+playwright-report/
+test-results/
+tsconfig.tsbuildinfo
+sdk/node/node_modules/
+sdk/node/dist/
+sdk/node/*.tgz
+sdk/js/node_modules/
+sdk/js/dist/
+sdk/js/*.tgz
+sdk/python/.venv/
+sdk/python/.pytest_cache/
+sdk/python/dist/
+sdk/python/build/
+sdk/python/*.egg-info/
+**/__pycache__/
+
+# Throwaway live-check scripts and their screenshots. Named `_*` on
+# purpose so a stray `git add -A` cannot sweep them into a commit —
+# that has happened twice (ec03d87, 821486a).
+e2e/_*.mjs
+e2e/screenshots/_*.png
+
+# apigen scratch copy (scripts/apigen.sh)
+backend/.apigen/

forjio_plugipay-0.5.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 0.5.0
+- `webhook_endpoints.update(endpoint_id, *, url=None, events=None, description=None, active=None)` (`active=True` re-enables an endpoint Plugipay switched off for failing and clears its failure streak), and the delivery log: `webhook_endpoints.list_deliveries(*, limit=None, cursor=None, endpoint_id=None, status=None, type=None)` (a `PageResult`), `get_delivery(delivery_id)`, `retry_delivery(delivery_id)`. New resource `WebhookDelivery`.
+- The `WebhookEndpoint`, `ApiKey` and `BillingTier` docstrings list the fields the API actually returns (endpoint failure streak and `disabledAt` / `disabledReason`; a key's `name`, `keyPrefix`, `environment`, `scopes`, `lastUsedAt`, `key`; a tier's prices, fee and limits).
+- `client.api`: `webhooks_deliveries`, `webhooks_get_deliveries`, `webhooks_deliveries_retry` (regenerated).
+
+## 0.4.0
+Hand-written methods that could never succeed against the API now send what their routes require. Some signatures changed (a minor bump in 0.x); every changed call failed before.
+- `customers.update` sends an `Idempotency-Key` (every call was `400`) and takes `external_id`, `tax_id`, `default_payment_token_id`, `metadata`.
+- `plans.create(*, name, interval, prices=None, currency=None, amount=None, portal_features=None, description=None, interval_count=None, trial_days=None, …)`: the API's prices + `portalFeatures`. `currency` + `amount` are the shorthand for one flat price; `portal_features` defaults to cancel + update the payment method.
+- `templates.create(*, kind, name, config, is_default=None)` / `templates.update(id, *, name=None, config=None)` send `config` (the API never took `document`). `templates.preview(*, kind, config)` returns `{"html": …}` from the HTML page the route answers with (it raised `invalid_response`); `sample_data` is gone. `templates.duplicate(id, name=…)` renames the copy with a second request.
+- `adapters.update_xendit` / `update_paypal` / `update_midtrans` / `update_manual` send an `Idempotency-Key` (every call was `400`) and take keyword fields (`secret_key=`, `client_id=`, `server_key=`, `bank_accounts=`, …); the 0.3 dict argument still works. `adapters.list()` returns the adapters (it always returned `[]`: the API answers an object keyed by kind).
+- `adapters.start_managed_onboarding(*, email)`, `simulate_managed_onboarding(*, kyb_status="live", capabilities_status="live", payouts_ready=True)` and `onboarding.provision_managed()` (no input; returns `{"subAccountId": …}`) send the bodies their routes take.
+- `api_keys.create(*, name, environment=None, scopes=None)` (person-only: a key still gets `403`). `invoices.create` and `invoices.finalize` send an `Idempotency-Key`.
+- `request()` returns the text of a `text/html` success response.
+- The routes-exist test now also fails a hand-written method that sends no `Idempotency-Key` where the route takes one, or whose body (every declared parameter filled in) the route's schema refuses.
+
+## 0.3.0
+- `uploads.image` sends the image as `multipart/form-data` in the field `file`, which is what `POST /api/v1/uploads/image` takes; it sent JSON before and always got 400. It takes `image(file, *, filename=None, content_type=None)` (`file`: bytes or a binary file object); the 0.2 keywords `base64=`, `filename=`, `mime=` still work. It returns `url`, `fileName`, `fileSize`.
+- `client.api.uploads_image(file=…)` and `client.api.public_checkout_sessions_proof_image(id, file=…)` upload a file; `request()` / `_apigen_request()` take `files=` and `form=` (multipart/form-data, signed over no body as the API checks it).
+- Every request is signed with a fresh `X-Plugipay-Timestamp` when it is sent; the API now refuses a signed time more than 300 s off its clock either way (`401 timestamp_skew`, `401 invalid_timestamp`).
+
+## 0.2.0
+- **Published on PyPI as `forjio-plugipay`** (`pip install forjio-plugipay`); the import is still `import plugipay`. The PyPI name `plugipay` belongs to an account Forjio no longer publishes from (like `forjio-linksnap`).
+- `client.api.<area>_<action>(...)`: every Plugipay feature route, one method each, generated from the API spec (`scripts/apigen.sh`). Signed like every other request, with an idempotency key on writes.
+- `api_key=`: a key minted in the dashboard (`pk_live_…` / `pk_test_…`) is sent as `Authorization: Bearer <key>`; `key_id` + `secret` are now optional when `api_key` is given.
+- `webhook_endpoints.list/create/delete` called `/api/v1/webhook-endpoints`, which the API does not serve (every call 404'd); they now call `/api/v1/webhooks`.
+- The API now takes a key on every customer feature. Person-only (403 person_only with a key): `api_keys.*`, `account.*`, `workspaces.create/update/delete`; `admin_portal.*` is for Plugipay's operators.
+- A test checks every hand-written method's route against the API spec (`backend/openapi.json`).
+
+## 0.1.0
+- Initial release: HMAC-signed REST client with full resource coverage.

forjio_plugipay-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Forjio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

forjio_plugipay-0.5.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.5
+Name: forjio-plugipay
+Version: 0.5.0
+Summary: Official Python SDK for Plugipay — HMAC-signed REST client with full resource coverage (customers, plans, checkout sessions, invoices, subscriptions, refunds, adapters, payouts, ledger, reports, webhooks).
+Project-URL: Homepage, https://plugipay.com
+Project-URL: Documentation, https://plugipay.com/docs
+Project-URL: Source, https://github.com/hachimi-cat/plugipay-python
+Project-URL: Issues, https://github.com/hachimi-cat/plugipay-python/issues
+Author-email: Forjio <hello@plugipay.com>
+License: MIT
+License-File: LICENSE
+Keywords: checkout,forjio,indonesia,midtrans,payments,plugipay,subscriptions,xendit
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# plugipay (Python)
+
+Official Python SDK for [Plugipay](https://plugipay.com). HMAC-signed
+REST client; works with Flask, FastAPI, Django, or anything else that
+speaks Python 3.9+.
+
+## Install
+
+```bash
+pip install forjio-plugipay
+```
+
+## Quickstart
+
+```python
+from plugipay import PlugipayClient
+
+plug = PlugipayClient(key_id="ak_live_...", secret="...")
+
+# Create a customer
+customer = plug.customers.create(email="ada@example.com", name="Ada Lovelace")
+
+# Open a checkout session
+session = plug.checkout_sessions.create(
+    amount=125000,
+    currency="IDR",
+    methods=["qris", "va", "ewallet"],
+    success_url="https://yourapp.com/checkout/success",
+    cancel_url="https://yourapp.com/checkout/cancel",
+    customer_id=customer["id"],
+)
+print(session["hostedUrl"])
+
+# Paginate customers
+page = plug.customers.list(limit=20)
+for c in page.data:
+    print(c["id"], c.get("email"))
+if page.has_more:
+    next_page = plug.customers.list(limit=20, cursor=page.cursor)
+```
+
+The client is a context manager — `with PlugipayClient(...) as plug:`
+will close the underlying httpx pool for you.
+
+## Resource namespaces
+
+Mirrors `@forjio/plugipay-node` 1:1:
+
+| Namespace | Methods |
+|---|---|
+| `customers` | `create`, `get`, `list`, `update` |
+| `plans` | `create`, `get`, `list`, `update`, `archive` |
+| `checkout_sessions` | `create`, `get`, `list`, `cancel`, `confirm` |
+| `invoices` | `create`, `get`, `list`, `finalize`, `pay`, `void`, `send_email` |
+| `subscriptions` | `create`, `get`, `list`, `cancel`, `pause`, `resume` |
+| `portal_sessions` | `create` |
+| `receipts` | `list`, `get` |
+| `payouts` | `create`, `get`, `list`, `cancel`, `mark_in_transit`, `mark_paid`, `mark_failed`, `balance`, `get_bank_account`, `update_bank_account` |
+| `ledger` | `list`, `balances` |
+| `reports` | `pnl`, `cash_flow` |
+| `webhook_endpoints` | `list`, `create`, `delete` |
+| `events` | `list`, `get` |
+| `refunds` | `create`, `get`, `list` |
+| `adapters` | `list`, `update_xendit`, `update_paypal`, `update_midtrans`, `update_manual`, `managed_onboarding_state`, `start_managed_onboarding`, `simulate_managed_onboarding` |
+| `api_keys` | `list`, `create`, `revoke` |
+| `billing` | `list_tiers`, `list_plans`, `refresh_tiers` |
+| `onboarding` | `provision_managed` |
+| `checkout_settings` | `get`, `update` |
+| `templates` | `list`, `get`, `create`, `update`, `make_default`, `duplicate`, `preview`, `delete` |
+| `uploads` | `image` |
+| `workspaces` | `list`, `create`, `update`, `delete` |
+| `account` | `get`, `update`, `list_sessions`, `revoke_session`, `revoke_all_sessions`, `list_linked`, `unlink`, `change_email`, `change_password`, `list_members` |
+| `admin_portal` | `me`, `list_billing_accounts`, `update_billing_account`, `list_partners`, `create_partner`, `update_partner`, `delete_partner` |
+| `admin` | `provision_workspace`, `get_workspace`, `partner_usage` |
+
+## Webhooks
+
+Plugipay signs every webhook with HMAC-SHA256 over `${timestamp}.${rawBody}`.
+Pass the *raw* request body (bytes or str), not the parsed JSON.
+
+```python
+from flask import Flask, request, abort
+from plugipay import verify_webhook, PlugipaySignatureError
+import os
+
+app = Flask(__name__)
+SECRET = os.environ["PLUGIPAY_WEBHOOK_SECRET"]
+
+@app.post("/webhooks/plugipay")
+def plugipay_webhook():
+    raw = request.get_data()
+    sig = request.headers.get("X-Plugipay-Signature", "")
+    try:
+        event = verify_webhook(raw, sig, SECRET)
+    except PlugipaySignatureError:
+        abort(400)
+    if event.type == "plugipay.invoice.paid.v1":
+        invoice = event.object
+        # ...
+    return "", 204
+```
+
+## Platform keys
+
+If you hold a platform-admin key acting across many merchants, scope
+each call with `X-Plugipay-On-Behalf-Of` via `for_merchant()`:
+
+```python
+plat = PlugipayClient(key_id="ak_live_platform_...", secret="...")
+for_acc = plat.for_merchant("acc_abc123")
+for_acc.invoices.list()
+```
+
+## Errors
+
+Every failure raises `PlugipayError` (or a subclass —
+`PlugipayNetworkError`, `PlugipayTimeoutError`, `PlugipaySignatureError`).
+The exception carries `.status`, `.code`, `.message`, and (when present)
+`.request_id`.
+
+```python
+from plugipay import PlugipayClient, PlugipayError
+
+plug = PlugipayClient(key_id="...", secret="...")
+try:
+    plug.customers.get("cus_does_not_exist")
+except PlugipayError as e:
+    print(e.status, e.code, e.message, e.request_id)
+```
+
+## Source
+
+<https://github.com/hachimi-cat/plugipay-python>
+
+## License
+
+MIT

forjio_plugipay-0.5.0/README.md

@@ -0,0 +1,137 @@
+# plugipay (Python)
+
+Official Python SDK for [Plugipay](https://plugipay.com). HMAC-signed
+REST client; works with Flask, FastAPI, Django, or anything else that
+speaks Python 3.9+.
+
+## Install
+
+```bash
+pip install forjio-plugipay
+```
+
+## Quickstart
+
+```python
+from plugipay import PlugipayClient
+
+plug = PlugipayClient(key_id="ak_live_...", secret="...")
+
+# Create a customer
+customer = plug.customers.create(email="ada@example.com", name="Ada Lovelace")
+
+# Open a checkout session
+session = plug.checkout_sessions.create(
+    amount=125000,
+    currency="IDR",
+    methods=["qris", "va", "ewallet"],
+    success_url="https://yourapp.com/checkout/success",
+    cancel_url="https://yourapp.com/checkout/cancel",
+    customer_id=customer["id"],
+)
+print(session["hostedUrl"])
+
+# Paginate customers
+page = plug.customers.list(limit=20)
+for c in page.data:
+    print(c["id"], c.get("email"))
+if page.has_more:
+    next_page = plug.customers.list(limit=20, cursor=page.cursor)
+```
+
+The client is a context manager — `with PlugipayClient(...) as plug:`
+will close the underlying httpx pool for you.
+
+## Resource namespaces
+
+Mirrors `@forjio/plugipay-node` 1:1:
+
+| Namespace | Methods |
+|---|---|
+| `customers` | `create`, `get`, `list`, `update` |
+| `plans` | `create`, `get`, `list`, `update`, `archive` |
+| `checkout_sessions` | `create`, `get`, `list`, `cancel`, `confirm` |
+| `invoices` | `create`, `get`, `list`, `finalize`, `pay`, `void`, `send_email` |
+| `subscriptions` | `create`, `get`, `list`, `cancel`, `pause`, `resume` |
+| `portal_sessions` | `create` |
+| `receipts` | `list`, `get` |
+| `payouts` | `create`, `get`, `list`, `cancel`, `mark_in_transit`, `mark_paid`, `mark_failed`, `balance`, `get_bank_account`, `update_bank_account` |
+| `ledger` | `list`, `balances` |
+| `reports` | `pnl`, `cash_flow` |
+| `webhook_endpoints` | `list`, `create`, `delete` |
+| `events` | `list`, `get` |
+| `refunds` | `create`, `get`, `list` |
+| `adapters` | `list`, `update_xendit`, `update_paypal`, `update_midtrans`, `update_manual`, `managed_onboarding_state`, `start_managed_onboarding`, `simulate_managed_onboarding` |
+| `api_keys` | `list`, `create`, `revoke` |
+| `billing` | `list_tiers`, `list_plans`, `refresh_tiers` |
+| `onboarding` | `provision_managed` |
+| `checkout_settings` | `get`, `update` |
+| `templates` | `list`, `get`, `create`, `update`, `make_default`, `duplicate`, `preview`, `delete` |
+| `uploads` | `image` |
+| `workspaces` | `list`, `create`, `update`, `delete` |
+| `account` | `get`, `update`, `list_sessions`, `revoke_session`, `revoke_all_sessions`, `list_linked`, `unlink`, `change_email`, `change_password`, `list_members` |
+| `admin_portal` | `me`, `list_billing_accounts`, `update_billing_account`, `list_partners`, `create_partner`, `update_partner`, `delete_partner` |
+| `admin` | `provision_workspace`, `get_workspace`, `partner_usage` |
+
+## Webhooks
+
+Plugipay signs every webhook with HMAC-SHA256 over `${timestamp}.${rawBody}`.
+Pass the *raw* request body (bytes or str), not the parsed JSON.
+
+```python
+from flask import Flask, request, abort
+from plugipay import verify_webhook, PlugipaySignatureError
+import os
+
+app = Flask(__name__)
+SECRET = os.environ["PLUGIPAY_WEBHOOK_SECRET"]
+
+@app.post("/webhooks/plugipay")
+def plugipay_webhook():
+    raw = request.get_data()
+    sig = request.headers.get("X-Plugipay-Signature", "")
+    try:
+        event = verify_webhook(raw, sig, SECRET)
+    except PlugipaySignatureError:
+        abort(400)
+    if event.type == "plugipay.invoice.paid.v1":
+        invoice = event.object
+        # ...
+    return "", 204
+```
+
+## Platform keys
+
+If you hold a platform-admin key acting across many merchants, scope
+each call with `X-Plugipay-On-Behalf-Of` via `for_merchant()`:
+
+```python
+plat = PlugipayClient(key_id="ak_live_platform_...", secret="...")
+for_acc = plat.for_merchant("acc_abc123")
+for_acc.invoices.list()
+```
+
+## Errors
+
+Every failure raises `PlugipayError` (or a subclass —
+`PlugipayNetworkError`, `PlugipayTimeoutError`, `PlugipaySignatureError`).
+The exception carries `.status`, `.code`, `.message`, and (when present)
+`.request_id`.
+
+```python
+from plugipay import PlugipayClient, PlugipayError
+
+plug = PlugipayClient(key_id="...", secret="...")
+try:
+    plug.customers.get("cus_does_not_exist")
+except PlugipayError as e:
+    print(e.status, e.code, e.message, e.request_id)
+```
+
+## Source
+
+<https://github.com/hachimi-cat/plugipay-python>
+
+## License
+
+MIT

forjio_plugipay-0.5.0/plugipay/__init__.py

@@ -0,0 +1,110 @@
+"""Official Python SDK for Plugipay.
+
+Mirrors the public surface of ``@forjio/plugipay-node``:
+
+- :class:`PlugipayClient` — HMAC-signed client with every resource
+  namespace (customers, plans, checkout_sessions, invoices,
+  subscriptions, refunds, adapters, api_keys, workspaces, templates,
+  uploads, account, admin, ...).
+- :func:`verify_webhook` — verify ``X-Plugipay-Signature`` and parse the
+  event envelope.
+- :class:`PlugipayError` + subclasses — the only thing the SDK raises.
+"""
+
+from .client import PlugipayClient
+from .errors import (
+    PlugipayError,
+    PlugipayNetworkError,
+    PlugipaySignatureError,
+    PlugipayTimeoutError,
+)
+from .resources import (
+    AccountProfile,
+    AdapterConfig,
+    AdminPortalIdentity,
+    ApiKey,
+    AvailableBalance,
+    BankAccount,
+    BillingTier,
+    BrowserSession,
+    CashFlowReport,
+    CheckoutSession,
+    CheckoutSettings,
+    Customer,
+    EventRecord,
+    Invoice,
+    LedgerBalance,
+    LedgerEntry,
+    LinkedAccount,
+    ManagedOnboardingState,
+    PageResult,
+    PartnerUsageSummary,
+    PartnerWorkspace,
+    Payout,
+    Plan,
+    PnLReport,
+    PortalSession,
+    ReceiptSummary,
+    Refund,
+    Resource,
+    Subscription,
+    Template,
+    UploadedFile,
+    WebhookDelivery,
+    WebhookEndpoint,
+    WebhookEvent,
+    Workspace,
+    WorkspaceMember,
+)
+from .webhooks import verify_webhook
+
+__all__ = [
+    # client
+    "PlugipayClient",
+    # errors
+    "PlugipayError",
+    "PlugipayNetworkError",
+    "PlugipaySignatureError",
+    "PlugipayTimeoutError",
+    # webhooks
+    "verify_webhook",
+    # resources
+    "AccountProfile",
+    "AdapterConfig",
+    "AdminPortalIdentity",
+    "ApiKey",
+    "AvailableBalance",
+    "BankAccount",
+    "BillingTier",
+    "BrowserSession",
+    "CashFlowReport",
+    "CheckoutSession",
+    "CheckoutSettings",
+    "Customer",
+    "EventRecord",
+    "Invoice",
+    "LedgerBalance",
+    "LedgerEntry",
+    "LinkedAccount",
+    "ManagedOnboardingState",
+    "PageResult",
+    "PartnerUsageSummary",
+    "PartnerWorkspace",
+    "Payout",
+    "Plan",
+    "PnLReport",
+    "PortalSession",
+    "ReceiptSummary",
+    "Refund",
+    "Resource",
+    "Subscription",
+    "Template",
+    "UploadedFile",
+    "WebhookDelivery",
+    "WebhookEndpoint",
+    "WebhookEvent",
+    "Workspace",
+    "WorkspaceMember",
+]
+
+__version__ = "0.5.0"