Metadata-Version: 2.1
Name: naturalpay
Version: 0.19.1
Summary: 
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Provides-Extra: aiohttp
Requires-Dist: aiohttp (>=3.14.0,<4) ; (python_version >= "3.10") and (extra == "aiohttp")
Requires-Dist: httpx (>=0.21.2)
Requires-Dist: httpx-aiohttp (==0.1.8) ; (python_version >= "3.10") and (extra == "aiohttp")
Requires-Dist: pydantic (>=1.9.2)
Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
Requires-Dist: typing_extensions (>=4.0.0)
Project-URL: Repository, https://github.com/naturalpay/naturalpay-python
Description-Content-Type: text/markdown

# Natural Python Library

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fnaturalpay%2Fnaturalpay-python)
[![pypi](https://img.shields.io/pypi/v/naturalpay)](https://pypi.python.org/pypi/naturalpay)

The Natural Python library provides convenient access to the Natural APIs from Python.

## Table of Contents

- [Choosing Your Integration](#choosing-your-integration)
- [Documentation](#documentation)
- [Installation](#installation)
- [Reference](#reference)
- [Usage](#usage)
- [Async Usage](#async-usage)
- [Using Types](#using-types)
- [Nested Params](#nested-params)
- [Handling Errors](#handling-errors)
- [Environments](#environments)
- [Async Client](#async-client)
- [Exception Handling](#exception-handling)
- [Pagination](#pagination)
- [Advanced](#advanced)
  - [Access Raw Response Data](#access-raw-response-data)
  - [Retries](#retries)
  - [Timeouts](#timeouts)
  - [Custom Client](#custom-client)
- [Versioning](#versioning)
- [Requirements](#requirements)
- [Contributing](#contributing)

## Choosing your integration

This SDK is the right tool when you're **building a Python app, service, or
agent runtime** that moves money on Natural — which covers almost every
production integration.

Using a different surface? If you're working **inside an AI coding assistant**
(Claude, Cursor, Codex) and want it to transact directly, use Natural's hosted
**MCP server** at `mcp.natural.co` ([guide](https://docs.natural.co/guides/platform/mcp)).
For terminal and CI use, see the [CLI](https://docs.natural.co/guides/platform/cli).
Full overview: [Choosing your integration](https://docs.natural.co/guides/overview/start-here).

**Building with an AI coding agent?** Install Natural's skill so the agent uses
this SDK correctly instead of hand-writing REST calls:

```sh
npx skills add naturalpay/skill
```

## Documentation

The REST API documentation can be found on [docs.natural.co](https://docs.natural.co). The full API of this library can be found in [api.md](api.md).

## Installation

```sh
pip install naturalpay
```

## Reference

A full reference for this library is available [here](https://github.com/naturalpay/naturalpay-python/blob/HEAD/./reference.md).

## Usage

Instantiate and use the client with the following:

```python
from naturalpay import Natural
from naturalpay.agents import CreateAgentsRequestLimits

client = Natural(
    token="<token>",
)

client.agents.create(
    idempotency_key="Idempotency-Key",
    name="Carrier Payment Agent v2.1",
    description="Autonomous agent that pays delivery carriers",
    limits=CreateAgentsRequestLimits(
        per_transaction=100000,
    ),
)
```

## Async usage

Simply import `AsyncNatural` instead of `Natural` and use `await` with each API call:

```python
import os
import asyncio
from naturalpay import AsyncNatural

client = AsyncNatural(
    api_key=os.environ.get("NATURAL_API_KEY"),  # This is the default and can be omitted
    # defaults to "production".
    environment="dev",
)


async def main() -> None:
    agent = await client.agents.create(
        name="x",
        idempotency_key="Idempotency-Key",
    )
    print(agent.data)


asyncio.run(main())
```

Functionality between the synchronous and asynchronous clients is otherwise identical.

### With aiohttp

By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.

You can enable this by installing `aiohttp`:

```sh
# install from PyPI
pip install naturalpay[aiohttp]
```

Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:

```python
import os
import asyncio
from naturalpay import DefaultAioHttpClient
from naturalpay import AsyncNatural


async def main() -> None:
    async with AsyncNatural(
        api_key=os.environ.get("NATURAL_API_KEY"),  # This is the default and can be omitted
        http_client=DefaultAioHttpClient(),
    ) as client:
        agent = await client.agents.create(
            name="x",
            idempotency_key="Idempotency-Key",
        )
        print(agent.data)


asyncio.run(main())
```

## Using types

Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:

- Serializing back into JSON, `model.to_json()`
- Converting to a dictionary, `model.to_dict()`

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.

## Nested params

Nested parameters are dictionaries, typed using `TypedDict`, for example:

```python
from naturalpay import Natural

client = Natural()

agent = client.agents.create(
    name="x",
    idempotency_key="Idempotency-Key",
    limits={},
)
print(agent.limits)
```

## Handling errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `naturalpay.APIConnectionError` is raised.

When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of `naturalpay.APIStatusError` is raised, containing `status_code` and `response` properties.

All errors inherit from `naturalpay.APIError`.

```python
import naturalpay
from naturalpay import Natural

client = Natural()

try:
    client.agents.create(
        name="x",
        idempotency_key="Idempotency-Key",
    )
except naturalpay.APIConnectionError as e:
    print("The server could not be reached")
    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
except naturalpay.RateLimitError as e:
    print("A 429 status code was received; we should back off a bit.")
except naturalpay.APIStatusError as e:
    print("Another non-200-range status code was received")
    print(e.status_code)
    print(e.response)
```

Error codes are as follows:

| Status Code | Error Type                 |
| ----------- | -------------------------- |
| 400         | `BadRequestError`          |
| 401         | `AuthenticationError`      |
| 403         | `PermissionDeniedError`    |
| 404         | `NotFoundError`            |
| 422         | `UnprocessableEntityError` |
| 429         | `RateLimitError`           |
| >=500       | `InternalServerError`      |
| N/A         | `APIConnectionError`       |

### Retries

Certain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use the `max_retries` option to configure or disable retry settings:

```python
from naturalpay import Natural

# Configure the default for all requests:
client = Natural(
    # default is 2
    max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).agents.create(
    name="x",
    idempotency_key="Idempotency-Key",
)
```

### Timeouts

By default requests time out after 1 minute. You can configure this with a `timeout` option,
which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:

```python
from naturalpay import Natural

# Configure the default for all requests:
client = Natural(
    # 20 seconds (default is 1 minute)
    timeout=20.0,
)

# More granular control:
client = Natural(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request:
client.with_options(timeout=5.0).agents.create(
    name="x",
    idempotency_key="Idempotency-Key",
)
```

On timeout, an `APITimeoutError` is thrown.

Note that requests that time out are [retried twice by default](#retries).

## Environments

This SDK allows you to configure different environments for API requests.

```python
from naturalpay import Natural
from naturalpay.environment import NaturalEnvironment

client = Natural(
    environment=NaturalEnvironment.PRODUCTION,
)
```

## Async Client

The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).

```python
import asyncio
from naturalpay.agents import CreateAgentsRequestLimits

from naturalpay import AsyncNatural

client = AsyncNatural(
    token="<token>",
)


async def main() -> None:
    await client.agents.create(
        idempotency_key="Idempotency-Key",
        name="Carrier Payment Agent v2.1",
        description="Autonomous agent that pays delivery carriers",
        limits=CreateAgentsRequestLimits(
            per_transaction=100000,
        ),
    )


asyncio.run(main())
```

## Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.

```python
from naturalpay.core.api_error import ApiError

try:
    client.agents.create(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)
```

## Pagination

Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.

```python
from naturalpay import Natural

client = Natural(
    token="<token>",
)

client.agents.list()
```

```python
# You can also iterate through pages and access the typed response per page
pager = client.agents.list(...)
for page in pager.iter_pages():
    print(page.response)  # access the typed response for each page
    for item in page:
        print(item)
```

## Advanced

### Access Raw Response Data

The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.

```python
from naturalpay import Natural

client = Natural(...)
response = client.agents.with_raw_response.create(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object
```

### Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).

Which status codes are retried depends on the `retryStatusCodes` generator configuration:

**`legacy`** (current default): retries on
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)

**`recommended`**: retries on
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)

Use the `max_retries` request option to configure this behavior.

```python
client.agents.create(..., request_options={
    "max_retries": 1
})
```

### Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

```python
from naturalpay import Natural

client = Natural(..., timeout=20.0)

# Override timeout for a specific method
client.agents.create(..., request_options={
    "timeout_in_seconds": 1
})
```

### Custom Client

You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
and transports.

```python
import httpx
from naturalpay import Natural

client = Natural(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)
```

## Versioning

This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an [issue](https://www.github.com/naturalpay/naturalpay-python/issues) with questions, bugs, or suggestions.

### Determining the installed version

If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

You can determine the version that is being used at runtime with:

```py
import naturalpay
print(naturalpay.__version__)
```

## Requirements

Python 3.9 or higher.

## Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

