pvium 0.1.0__tar.gz

pvium-0.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: pvium
+Version: 0.1.0
+Summary: Python SDK for the Pvium API
+Author: Pvium
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: eth-abi>=5.1.0
+Requires-Dist: eth-account>=0.13.0
+Requires-Dist: eth-keys>=0.6.0
+Requires-Dist: eth-utils>=5.0.0
+Provides-Extra: async
+Requires-Dist: httpx>=0.27.0; extra == "async"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+
+# Pvium Python SDK
+
+Python SDK equivalent of the Pvium TypeScript SDK.
+
+## Project Structure
+
+```text
+pvium-sdk/
+  src/pvium_sdk/
+    core/
+      client.py
+      types.py
+      sdk.py
+      async_sdk.py
+    services/
+      invoice/
+        endpoints.py
+      oauth/
+        oauth.py
+      invites/
+        invites.py
+      payout/
+        payout.py
+      webhooks/
+        webhooks.py
+      ...compatibility wrapper modules...
+    crypto/
+      signing.py
+      invite_merkle.py
+    __init__.py
+    ...compatibility wrapper modules...
+  tests/
+    ...pytest suite...
+  pyproject.toml
+  README.md
+```
+
+## Install
+
+```bash
+pip install -e .
+```
+
+For development and tests:
+
+```bash
+pip install -e '.[dev]'
+```
+
+## Quick Start
+
+```python
+from pvium_sdk import PviumSdk, PviumSdkConfig
+
+pvium = PviumSdk.init(
+    PviumSdkConfig(
+        environment="sandbox",
+        apiKey="your_api_key",
+        clientId="your_client_id",
+    )
+)
+
+invoices = pvium.endpoints.listInvoices()
+print(invoices)
+```
+
+## Async Usage
+
+`AsyncPviumSdk` preserves the same service surface as `PviumSdk` and runs service calls in a worker thread.
+
+```python
+from pvium_sdk import AsyncPviumSdk, PviumSdkConfig
+
+sdk = AsyncPviumSdk.init(
+  PviumSdkConfig(baseUrl="https://api-sandbox.pvium.com/v1", apiKey="your_api_key")
+)
+
+# await any service method
+invoices = await sdk.endpoints.listInvoices()
+```
+
+## Run Tests
+
+```bash
+pytest
+```
+
+## Services
+
+- `pvium.endpoints`
+  - `createInvoice(body, options=None)`
+  - `listInvoices(options=None)`
+  - `getInvoiceStatus(code, options=None)`
+  - `cancelInvoice(invoice_id, options=None)`
+  - `getInstallmentPayments(installment_id, options=None)`
+
+- `pvium.oauth`
+  - `exchangeCodeForToken(input, options=None)`
+  - `refreshAccessToken(input, options=None)`
+  - `getAccessTokenFromRefreshToken(input, options=None)`
+  - `getUserInfo(options=None)`
+
+- `pvium.invites`
+  - `createBundle(input)`
+  - `signBundle(bundle, signer)`
+  - `createSignedBundle(input, signer)`
+  - `commitBundle(bundle, options=None)`
+  - `createSignedAndCommit(input, signer, options=None)`
+
+- `pvium.payout`
+  - `create(input, options=None)`
+  - `createFinalized(input, signer, options=None, request_options=None)`
+  - `list(query=None, options=None)`
+  - `get(payout_id, options=None)`
+  - `addPayments(payout, input, options=None)`
+  - `addRecipients(payout_id, input, options=None)`
+  - `resolveRecipients(payout_id, input, options=None)`
+  - `removePayments(payout_id, input, options=None)`
+  - `deletePayment(payout_id, payment_id, options=None)`
+  - `updatePayment(payout_id, payment_id, input, options=None)`
+  - `editPayment(payout_id, payment_id, input, options=None)`
+  - `listPayments(payout_id, query=None, options=None)`
+  - `listInvites(payout_id, options=None)`
+  - `revokeInvite(payout_id, invite_id, options=None)`
+  - `revokeInviteRoot(payout_id, invite_root_id, options=None)`
+  - `delete(payout_id, options=None)`
+  - `finalize(payout_input, signer, options=None, request_options=None)`
+
+Single-payout responses are payout intent objects. They keep dictionary
+compatibility with `["meta"]` and `["data"]`, and expose payout fields and proxy
+methods directly:
+
+```python
+payout_intent = pvium.payout.create({
+    "type": "Instant",
+    "chain": "base",
+    "name": "Creator payroll",
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "token": "usdc",
+        }
+    ],
+})
+
+finalized = payout_intent.finalize("your_signer_private_key")
+print(finalized.fundingUrl)
+```
+
+Batch detail responses include up to 250 embedded `payments`. If the payout has
+more, the response meta/data includes truncation fields such as
+`paymentsTruncated`, `paymentsLimit`, and `paymentCount`. Use the paginated
+payment list for larger payouts:
+
+```python
+payments = payout_intent.listPayments({"page": 1, "perPage": 100})
+
+for payment in payments["data"]:
+    print(payment["id"], payment["amount"])
+```
+
+You can manage a payout intent and its payments through the intent object:
+
+```python
+payout_intent.editPayment(payment_id, {"memo": "Updated memo"})
+payout_intent.deletePayment(payment_id)
+payout_intent.revokeInvite(invite_id)
+payout_intent.delete()
+```
+
+For funded escrow payouts, use the intent proxy instead of passing the batch
+back into the service:
+
+```python
+funded_escrow = pvium.payout.get("escrow_batch_id")
+
+funded_escrow.addPayments({
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "memo": "Approved payout",
+        }
+    ],
+    "signer": "your_signer_private_key",
+    "finalizeOptions": {"claimDate": 1777488000},
+})
+```
+
+## Utilities
+
+The package exports signing helpers, webhook verification helpers, invite merkle helpers, and payout hash helpers similar to the TypeScript SDK.

pvium-0.1.0/README.md

@@ -0,0 +1,193 @@
+# Pvium Python SDK
+
+Python SDK equivalent of the Pvium TypeScript SDK.
+
+## Project Structure
+
+```text
+pvium-sdk/
+  src/pvium_sdk/
+    core/
+      client.py
+      types.py
+      sdk.py
+      async_sdk.py
+    services/
+      invoice/
+        endpoints.py
+      oauth/
+        oauth.py
+      invites/
+        invites.py
+      payout/
+        payout.py
+      webhooks/
+        webhooks.py
+      ...compatibility wrapper modules...
+    crypto/
+      signing.py
+      invite_merkle.py
+    __init__.py
+    ...compatibility wrapper modules...
+  tests/
+    ...pytest suite...
+  pyproject.toml
+  README.md
+```
+
+## Install
+
+```bash
+pip install -e .
+```
+
+For development and tests:
+
+```bash
+pip install -e '.[dev]'
+```
+
+## Quick Start
+
+```python
+from pvium_sdk import PviumSdk, PviumSdkConfig
+
+pvium = PviumSdk.init(
+    PviumSdkConfig(
+        environment="sandbox",
+        apiKey="your_api_key",
+        clientId="your_client_id",
+    )
+)
+
+invoices = pvium.endpoints.listInvoices()
+print(invoices)
+```
+
+## Async Usage
+
+`AsyncPviumSdk` preserves the same service surface as `PviumSdk` and runs service calls in a worker thread.
+
+```python
+from pvium_sdk import AsyncPviumSdk, PviumSdkConfig
+
+sdk = AsyncPviumSdk.init(
+  PviumSdkConfig(baseUrl="https://api-sandbox.pvium.com/v1", apiKey="your_api_key")
+)
+
+# await any service method
+invoices = await sdk.endpoints.listInvoices()
+```
+
+## Run Tests
+
+```bash
+pytest
+```
+
+## Services
+
+- `pvium.endpoints`
+  - `createInvoice(body, options=None)`
+  - `listInvoices(options=None)`
+  - `getInvoiceStatus(code, options=None)`
+  - `cancelInvoice(invoice_id, options=None)`
+  - `getInstallmentPayments(installment_id, options=None)`
+
+- `pvium.oauth`
+  - `exchangeCodeForToken(input, options=None)`
+  - `refreshAccessToken(input, options=None)`
+  - `getAccessTokenFromRefreshToken(input, options=None)`
+  - `getUserInfo(options=None)`
+
+- `pvium.invites`
+  - `createBundle(input)`
+  - `signBundle(bundle, signer)`
+  - `createSignedBundle(input, signer)`
+  - `commitBundle(bundle, options=None)`
+  - `createSignedAndCommit(input, signer, options=None)`
+
+- `pvium.payout`
+  - `create(input, options=None)`
+  - `createFinalized(input, signer, options=None, request_options=None)`
+  - `list(query=None, options=None)`
+  - `get(payout_id, options=None)`
+  - `addPayments(payout, input, options=None)`
+  - `addRecipients(payout_id, input, options=None)`
+  - `resolveRecipients(payout_id, input, options=None)`
+  - `removePayments(payout_id, input, options=None)`
+  - `deletePayment(payout_id, payment_id, options=None)`
+  - `updatePayment(payout_id, payment_id, input, options=None)`
+  - `editPayment(payout_id, payment_id, input, options=None)`
+  - `listPayments(payout_id, query=None, options=None)`
+  - `listInvites(payout_id, options=None)`
+  - `revokeInvite(payout_id, invite_id, options=None)`
+  - `revokeInviteRoot(payout_id, invite_root_id, options=None)`
+  - `delete(payout_id, options=None)`
+  - `finalize(payout_input, signer, options=None, request_options=None)`
+
+Single-payout responses are payout intent objects. They keep dictionary
+compatibility with `["meta"]` and `["data"]`, and expose payout fields and proxy
+methods directly:
+
+```python
+payout_intent = pvium.payout.create({
+    "type": "Instant",
+    "chain": "base",
+    "name": "Creator payroll",
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "token": "usdc",
+        }
+    ],
+})
+
+finalized = payout_intent.finalize("your_signer_private_key")
+print(finalized.fundingUrl)
+```
+
+Batch detail responses include up to 250 embedded `payments`. If the payout has
+more, the response meta/data includes truncation fields such as
+`paymentsTruncated`, `paymentsLimit`, and `paymentCount`. Use the paginated
+payment list for larger payouts:
+
+```python
+payments = payout_intent.listPayments({"page": 1, "perPage": 100})
+
+for payment in payments["data"]:
+    print(payment["id"], payment["amount"])
+```
+
+You can manage a payout intent and its payments through the intent object:
+
+```python
+payout_intent.editPayment(payment_id, {"memo": "Updated memo"})
+payout_intent.deletePayment(payment_id)
+payout_intent.revokeInvite(invite_id)
+payout_intent.delete()
+```
+
+For funded escrow payouts, use the intent proxy instead of passing the batch
+back into the service:
+
+```python
+funded_escrow = pvium.payout.get("escrow_batch_id")
+
+funded_escrow.addPayments({
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "memo": "Approved payout",
+        }
+    ],
+    "signer": "your_signer_private_key",
+    "finalizeOptions": {"claimDate": 1777488000},
+})
+```
+
+## Utilities
+
+The package exports signing helpers, webhook verification helpers, invite merkle helpers, and payout hash helpers similar to the TypeScript SDK.

pvium-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pvium"
+version = "0.1.0"
+description = "Python SDK for the Pvium API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "Pvium" }]
+dependencies = [
+  "eth-abi>=5.1.0",
+  "eth-account>=0.13.0",
+  "eth-keys>=0.6.0",
+  "eth-utils>=5.0.0",
+]
+
+[project.optional-dependencies]
+async = [
+  "httpx>=0.27.0",
+]
+dev = [
+  "pytest>=8.3.0",
+  "pytest-asyncio>=0.24.0",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["pvium_sdk*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

pvium-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pvium-0.1.0/src/pvium.egg-info/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: pvium
+Version: 0.1.0
+Summary: Python SDK for the Pvium API
+Author: Pvium
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: eth-abi>=5.1.0
+Requires-Dist: eth-account>=0.13.0
+Requires-Dist: eth-keys>=0.6.0
+Requires-Dist: eth-utils>=5.0.0
+Provides-Extra: async
+Requires-Dist: httpx>=0.27.0; extra == "async"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+
+# Pvium Python SDK
+
+Python SDK equivalent of the Pvium TypeScript SDK.
+
+## Project Structure
+
+```text
+pvium-sdk/
+  src/pvium_sdk/
+    core/
+      client.py
+      types.py
+      sdk.py
+      async_sdk.py
+    services/
+      invoice/
+        endpoints.py
+      oauth/
+        oauth.py
+      invites/
+        invites.py
+      payout/
+        payout.py
+      webhooks/
+        webhooks.py
+      ...compatibility wrapper modules...
+    crypto/
+      signing.py
+      invite_merkle.py
+    __init__.py
+    ...compatibility wrapper modules...
+  tests/
+    ...pytest suite...
+  pyproject.toml
+  README.md
+```
+
+## Install
+
+```bash
+pip install -e .
+```
+
+For development and tests:
+
+```bash
+pip install -e '.[dev]'
+```
+
+## Quick Start
+
+```python
+from pvium_sdk import PviumSdk, PviumSdkConfig
+
+pvium = PviumSdk.init(
+    PviumSdkConfig(
+        environment="sandbox",
+        apiKey="your_api_key",
+        clientId="your_client_id",
+    )
+)
+
+invoices = pvium.endpoints.listInvoices()
+print(invoices)
+```
+
+## Async Usage
+
+`AsyncPviumSdk` preserves the same service surface as `PviumSdk` and runs service calls in a worker thread.
+
+```python
+from pvium_sdk import AsyncPviumSdk, PviumSdkConfig
+
+sdk = AsyncPviumSdk.init(
+  PviumSdkConfig(baseUrl="https://api-sandbox.pvium.com/v1", apiKey="your_api_key")
+)
+
+# await any service method
+invoices = await sdk.endpoints.listInvoices()
+```
+
+## Run Tests
+
+```bash
+pytest
+```
+
+## Services
+
+- `pvium.endpoints`
+  - `createInvoice(body, options=None)`
+  - `listInvoices(options=None)`
+  - `getInvoiceStatus(code, options=None)`
+  - `cancelInvoice(invoice_id, options=None)`
+  - `getInstallmentPayments(installment_id, options=None)`
+
+- `pvium.oauth`
+  - `exchangeCodeForToken(input, options=None)`
+  - `refreshAccessToken(input, options=None)`
+  - `getAccessTokenFromRefreshToken(input, options=None)`
+  - `getUserInfo(options=None)`
+
+- `pvium.invites`
+  - `createBundle(input)`
+  - `signBundle(bundle, signer)`
+  - `createSignedBundle(input, signer)`
+  - `commitBundle(bundle, options=None)`
+  - `createSignedAndCommit(input, signer, options=None)`
+
+- `pvium.payout`
+  - `create(input, options=None)`
+  - `createFinalized(input, signer, options=None, request_options=None)`
+  - `list(query=None, options=None)`
+  - `get(payout_id, options=None)`
+  - `addPayments(payout, input, options=None)`
+  - `addRecipients(payout_id, input, options=None)`
+  - `resolveRecipients(payout_id, input, options=None)`
+  - `removePayments(payout_id, input, options=None)`
+  - `deletePayment(payout_id, payment_id, options=None)`
+  - `updatePayment(payout_id, payment_id, input, options=None)`
+  - `editPayment(payout_id, payment_id, input, options=None)`
+  - `listPayments(payout_id, query=None, options=None)`
+  - `listInvites(payout_id, options=None)`
+  - `revokeInvite(payout_id, invite_id, options=None)`
+  - `revokeInviteRoot(payout_id, invite_root_id, options=None)`
+  - `delete(payout_id, options=None)`
+  - `finalize(payout_input, signer, options=None, request_options=None)`
+
+Single-payout responses are payout intent objects. They keep dictionary
+compatibility with `["meta"]` and `["data"]`, and expose payout fields and proxy
+methods directly:
+
+```python
+payout_intent = pvium.payout.create({
+    "type": "Instant",
+    "chain": "base",
+    "name": "Creator payroll",
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "token": "usdc",
+        }
+    ],
+})
+
+finalized = payout_intent.finalize("your_signer_private_key")
+print(finalized.fundingUrl)
+```
+
+Batch detail responses include up to 250 embedded `payments`. If the payout has
+more, the response meta/data includes truncation fields such as
+`paymentsTruncated`, `paymentsLimit`, and `paymentCount`. Use the paginated
+payment list for larger payouts:
+
+```python
+payments = payout_intent.listPayments({"page": 1, "perPage": 100})
+
+for payment in payments["data"]:
+    print(payment["id"], payment["amount"])
+```
+
+You can manage a payout intent and its payments through the intent object:
+
+```python
+payout_intent.editPayment(payment_id, {"memo": "Updated memo"})
+payout_intent.deletePayment(payment_id)
+payout_intent.revokeInvite(invite_id)
+payout_intent.delete()
+```
+
+For funded escrow payouts, use the intent proxy instead of passing the batch
+back into the service:
+
+```python
+funded_escrow = pvium.payout.get("escrow_batch_id")
+
+funded_escrow.addPayments({
+    "payments": [
+        {
+            "receiver": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+            "amount": 100,
+            "memo": "Approved payout",
+        }
+    ],
+    "signer": "your_signer_private_key",
+    "finalizeOptions": {"claimDate": 1777488000},
+})
+```
+
+## Utilities
+
+The package exports signing helpers, webhook verification helpers, invite merkle helpers, and payout hash helpers similar to the TypeScript SDK.

pvium-0.1.0/src/pvium.egg-info/SOURCES.txt

@@ -0,0 +1,50 @@
+README.md
+pyproject.toml
+src/pvium.egg-info/PKG-INFO
+src/pvium.egg-info/SOURCES.txt
+src/pvium.egg-info/dependency_links.txt
+src/pvium.egg-info/requires.txt
+src/pvium.egg-info/top_level.txt
+src/pvium_sdk/__init__.py
+src/pvium_sdk/async_sdk.py
+src/pvium_sdk/client.py
+src/pvium_sdk/endpoints.py
+src/pvium_sdk/invite_merkle.py
+src/pvium_sdk/invites.py
+src/pvium_sdk/oauth.py
+src/pvium_sdk/payout.py
+src/pvium_sdk/sdk.py
+src/pvium_sdk/signing.py
+src/pvium_sdk/types.py
+src/pvium_sdk/webhooks.py
+src/pvium_sdk/core/__init__.py
+src/pvium_sdk/core/async_sdk.py
+src/pvium_sdk/core/client.py
+src/pvium_sdk/core/sdk.py
+src/pvium_sdk/core/types.py
+src/pvium_sdk/crypto/__init__.py
+src/pvium_sdk/crypto/invite_merkle.py
+src/pvium_sdk/crypto/signing.py
+src/pvium_sdk/services/__init__.py
+src/pvium_sdk/services/endpoints.py
+src/pvium_sdk/services/invites.py
+src/pvium_sdk/services/oauth.py
+src/pvium_sdk/services/payout.py
+src/pvium_sdk/services/webhooks.py
+src/pvium_sdk/services/invites/__init__.py
+src/pvium_sdk/services/invites/invites.py
+src/pvium_sdk/services/invoice/__init__.py
+src/pvium_sdk/services/invoice/endpoints.py
+src/pvium_sdk/services/oauth/__init__.py
+src/pvium_sdk/services/oauth/oauth.py
+src/pvium_sdk/services/payout/__init__.py
+src/pvium_sdk/services/payout/payout.py
+src/pvium_sdk/services/webhooks/__init__.py
+src/pvium_sdk/services/webhooks/webhooks.py
+tests/test_async_sdk.py
+tests/test_endpoints.py
+tests/test_invites.py
+tests/test_oauth.py
+tests/test_payout.py
+tests/test_signing.py
+tests/test_webhooks.py

pvium-0.1.0/src/pvium.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+