hexpay 0.0.1__tar.gz

hexpay-0.0.1/.gitignore

@@ -0,0 +1,22 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Local env
+.env
+.env.local

hexpay-0.0.1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: hexpay
+Version: 0.0.1
+Summary: Official Python SDK for the HexPay Merchant API (TON cryptocurrency payments).
+Project-URL: Homepage, https://hexpay.io
+Project-URL: Documentation, https://docs.hexpay.io
+Project-URL: Repository, https://github.com/hexpay-io/hexpay-python
+Project-URL: Issues, https://github.com/hexpay-io/hexpay-python/issues
+Author: HexPay
+License: Proprietary
+Keywords: api,crypto,cryptocurrency,hexpay,payments,sdk,ton
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.0
+Requires-Dist: python-dateutil>=2.8.0
+Description-Content-Type: text/markdown
+
+# HexPay Python SDK
+
+Official Python client for the [HexPay Merchant API](https://hexpay.io) — TON-blockchain
+cryptocurrency payments.
+
+The client in [`hexpay/`](hexpay/) is **fully auto-generated** from the OpenAPI spec at
+[`oapi/api.yaml`](oapi/api.yaml). Do not edit it by hand — your changes will be
+overwritten on the next regeneration.
+
+## Installation
+
+```bash
+pip install "git+https://github.com/hexpay/hexpay-python.git"
+```
+
+Or pin to a release tag:
+
+```bash
+pip install "git+https://github.com/hexpay/hexpay-python.git@v0.0.1"
+```
+
+## Quickstart
+
+```python
+import os
+import uuid
+
+from hexpay import AuthenticatedClient
+from hexpay.api.payments import create_payment
+from hexpay.models import CreatePaymentRequest
+
+client = AuthenticatedClient(
+    base_url="https://api.hexpay.io",
+    token=os.environ["HEXPAY_TOKEN"],
+)
+
+payment = create_payment.sync(
+    client=client,
+    body=CreatePaymentRequest(amount="100.00", currency="USD"),
+    x_idempotency_key=str(uuid.uuid4()),
+)
+
+print(payment.id, payment.checkout_url)
+```
+
+## Authentication
+
+All endpoints require a JWT obtained from the HexPay merchant dashboard. Pass it as
+the `token` argument to `AuthenticatedClient`. Never hard-code tokens — load them
+from environment variables, a secrets manager, or your config layer.
+
+## Idempotency
+
+Every `POST` request requires a UUID v4 `X-Idempotency-Key`. The SDK exposes it as
+the `x_idempotency_key` argument on every mutating operation.
+
+**Reuse the same key when retrying** a failed request — the server returns the
+cached response from the first attempt instead of creating a duplicate payment.
+**Generate a fresh key for each new logical operation.**
+
+See [`examples/idempotency_retry.py`](examples/idempotency_retry.py) for a complete
+retry loop that gets this right.
+
+## Async
+
+Every endpoint exposes both `sync` and `asyncio` entry points:
+
+```python
+import asyncio
+from hexpay.api.payments import list_payments
+
+async def main():
+    page = await list_payments.asyncio(client=client, limit=20)
+    for p in page.payments:
+        print(p.id, p.status)
+
+asyncio.run(main())
+```
+
+## Examples
+
+Runnable scripts under [`examples/`](examples/) — each is self-contained and reads
+`HEXPAY_TOKEN` (and optionally `HEXPAY_BASE_URL`) from the environment:
+
+| File                                                                              | What it shows                                  |
+|-----------------------------------------------------------------------------------|------------------------------------------------|
+| [`create_payment_customer_choice.py`](examples/create_payment_customer_choice.py) | Customer-Choice mode — checkout picks the method |
+| [`create_payment_preselected.py`](examples/create_payment_preselected.py)         | Preselected USDT/TON — `pending` immediately     |
+| [`retrieve_payment.py`](examples/retrieve_payment.py)                             | Fetch full payment details                     |
+| [`poll_payment_status.py`](examples/poll_payment_status.py)                       | Lightweight status polling loop                |
+| [`list_payments.py`](examples/list_payments.py)                                   | Cursor-based pagination                        |
+| [`cancel_payment.py`](examples/cancel_payment.py)                                 | Cancel an active payment                       |
+| [`list_payment_methods.py`](examples/list_payment_methods.py)                     | Discover store-enabled coin/chain combos       |
+| [`error_handling.py`](examples/error_handling.py)                                 | Pattern for inspecting structured errors       |
+| [`idempotency_retry.py`](examples/idempotency_retry.py)                           | Safe retry loop preserving the idempotency key |
+
+Run them with:
+
+```bash
+make gen install                # generate client + install into .venv/
+export HEXPAY_TOKEN="<your-jwt>"
+.venv/bin/python examples/create_payment_customer_choice.py
+```
+
+Or activate the venv once and use plain `python`:
+
+```bash
+source .venv/bin/activate
+python examples/create_payment_customer_choice.py
+```
+
+## Regeneration
+
+```bash
+make gen      # rebuild hexpay/ from oapi/api.yaml — runs in Docker
+make install  # editable install into a local venv
+make lint     # ruff check
+```
+
+`make gen` builds a small image from [`gen.Dockerfile`](gen.Dockerfile)
+(based on `python:3.12-slim` with
+[`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client)
+preinstalled) and runs it against the spec — no host Python required. The
+generator version is pinned by `OPENAPI_PYTHON_CLIENT_VERSION` in the
+Dockerfile.
+
+CI ([`.github/workflows/generate.yml`](.github/workflows/generate.yml)) runs the
+same `make gen` on every push to a non-`main` branch and commits the regenerated
+client back to the branch.
+
+## Compatibility
+
+- Python ≥ 3.9
+- httpx ≥ 0.23, < 0.29
+- Type hints throughout (`py.typed`)

hexpay-0.0.1/README.md

@@ -0,0 +1,135 @@
+# HexPay Python SDK
+
+Official Python client for the [HexPay Merchant API](https://hexpay.io) — TON-blockchain
+cryptocurrency payments.
+
+The client in [`hexpay/`](hexpay/) is **fully auto-generated** from the OpenAPI spec at
+[`oapi/api.yaml`](oapi/api.yaml). Do not edit it by hand — your changes will be
+overwritten on the next regeneration.
+
+## Installation
+
+```bash
+pip install "git+https://github.com/hexpay/hexpay-python.git"
+```
+
+Or pin to a release tag:
+
+```bash
+pip install "git+https://github.com/hexpay/hexpay-python.git@v0.0.1"
+```
+
+## Quickstart
+
+```python
+import os
+import uuid
+
+from hexpay import AuthenticatedClient
+from hexpay.api.payments import create_payment
+from hexpay.models import CreatePaymentRequest
+
+client = AuthenticatedClient(
+    base_url="https://api.hexpay.io",
+    token=os.environ["HEXPAY_TOKEN"],
+)
+
+payment = create_payment.sync(
+    client=client,
+    body=CreatePaymentRequest(amount="100.00", currency="USD"),
+    x_idempotency_key=str(uuid.uuid4()),
+)
+
+print(payment.id, payment.checkout_url)
+```
+
+## Authentication
+
+All endpoints require a JWT obtained from the HexPay merchant dashboard. Pass it as
+the `token` argument to `AuthenticatedClient`. Never hard-code tokens — load them
+from environment variables, a secrets manager, or your config layer.
+
+## Idempotency
+
+Every `POST` request requires a UUID v4 `X-Idempotency-Key`. The SDK exposes it as
+the `x_idempotency_key` argument on every mutating operation.
+
+**Reuse the same key when retrying** a failed request — the server returns the
+cached response from the first attempt instead of creating a duplicate payment.
+**Generate a fresh key for each new logical operation.**
+
+See [`examples/idempotency_retry.py`](examples/idempotency_retry.py) for a complete
+retry loop that gets this right.
+
+## Async
+
+Every endpoint exposes both `sync` and `asyncio` entry points:
+
+```python
+import asyncio
+from hexpay.api.payments import list_payments
+
+async def main():
+    page = await list_payments.asyncio(client=client, limit=20)
+    for p in page.payments:
+        print(p.id, p.status)
+
+asyncio.run(main())
+```
+
+## Examples
+
+Runnable scripts under [`examples/`](examples/) — each is self-contained and reads
+`HEXPAY_TOKEN` (and optionally `HEXPAY_BASE_URL`) from the environment:
+
+| File                                                                              | What it shows                                  |
+|-----------------------------------------------------------------------------------|------------------------------------------------|
+| [`create_payment_customer_choice.py`](examples/create_payment_customer_choice.py) | Customer-Choice mode — checkout picks the method |
+| [`create_payment_preselected.py`](examples/create_payment_preselected.py)         | Preselected USDT/TON — `pending` immediately     |
+| [`retrieve_payment.py`](examples/retrieve_payment.py)                             | Fetch full payment details                     |
+| [`poll_payment_status.py`](examples/poll_payment_status.py)                       | Lightweight status polling loop                |
+| [`list_payments.py`](examples/list_payments.py)                                   | Cursor-based pagination                        |
+| [`cancel_payment.py`](examples/cancel_payment.py)                                 | Cancel an active payment                       |
+| [`list_payment_methods.py`](examples/list_payment_methods.py)                     | Discover store-enabled coin/chain combos       |
+| [`error_handling.py`](examples/error_handling.py)                                 | Pattern for inspecting structured errors       |
+| [`idempotency_retry.py`](examples/idempotency_retry.py)                           | Safe retry loop preserving the idempotency key |
+
+Run them with:
+
+```bash
+make gen install                # generate client + install into .venv/
+export HEXPAY_TOKEN="<your-jwt>"
+.venv/bin/python examples/create_payment_customer_choice.py
+```
+
+Or activate the venv once and use plain `python`:
+
+```bash
+source .venv/bin/activate
+python examples/create_payment_customer_choice.py
+```
+
+## Regeneration
+
+```bash
+make gen      # rebuild hexpay/ from oapi/api.yaml — runs in Docker
+make install  # editable install into a local venv
+make lint     # ruff check
+```
+
+`make gen` builds a small image from [`gen.Dockerfile`](gen.Dockerfile)
+(based on `python:3.12-slim` with
+[`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client)
+preinstalled) and runs it against the spec — no host Python required. The
+generator version is pinned by `OPENAPI_PYTHON_CLIENT_VERSION` in the
+Dockerfile.
+
+CI ([`.github/workflows/generate.yml`](.github/workflows/generate.yml)) runs the
+same `make gen` on every push to a non-`main` branch and commits the regenerated
+client back to the branch.
+
+## Compatibility
+
+- Python ≥ 3.9
+- httpx ≥ 0.23, < 0.29
+- Type hints throughout (`py.typed`)

hexpay-0.0.1/hexpay/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing HexPay Merchant API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

hexpay-0.0.1/hexpay/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

hexpay-0.0.1/hexpay/api/payment_methods/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

hexpay-0.0.1/hexpay/api/payment_methods/list_payment_methods.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.error_response import ErrorResponse
+from ...models.payment_method_list_response import PaymentMethodListResponse
+from typing import cast
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/payment-methods",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | PaymentMethodListResponse | None:
+    if response.status_code == 200:
+        response_200 = PaymentMethodListResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ErrorResponse | PaymentMethodListResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ErrorResponse | PaymentMethodListResponse]:
+    """List payment methods
+
+     Retrieves all payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts.
+
+    Use `coin.symbol` and `chain.symbol` values from this response as inputs for
+    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ErrorResponse | PaymentMethodListResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ErrorResponse | PaymentMethodListResponse | None:
+    """List payment methods
+
+     Retrieves all payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts.
+
+    Use `coin.symbol` and `chain.symbol` values from this response as inputs for
+    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ErrorResponse | PaymentMethodListResponse
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ErrorResponse | PaymentMethodListResponse]:
+    """List payment methods
+
+     Retrieves all payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts.
+
+    Use `coin.symbol` and `chain.symbol` values from this response as inputs for
+    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ErrorResponse | PaymentMethodListResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ErrorResponse | PaymentMethodListResponse | None:
+    """List payment methods
+
+     Retrieves all payment methods enabled for your store. Each entry represents
+    a unique coin + chain combination that your store accepts.
+
+    Use `coin.symbol` and `chain.symbol` values from this response as inputs for
+    the `coin` and `chain` fields in `payment_options.methods` when creating a payment.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ErrorResponse | PaymentMethodListResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

hexpay-0.0.1/hexpay/api/payments/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""