Metadata-Version: 2.1
Name: kard-financial-sdk
Version: 8.4.0
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.10.0,<4) ; extra == "aiohttp"
Requires-Dist: httpx (>=0.21.2)
Requires-Dist: httpx-aiohttp (==0.1.8) ; extra == "aiohttp"
Requires-Dist: pydantic (>=1.9.2)
Requires-Dist: pydantic-core (>=2.18.2,<2.44.0)
Requires-Dist: typing_extensions (>=4.0.0)
Project-URL: Repository, https://github.com/KardFinancial/kard-python-sdk
Description-Content-Type: text/markdown

# Kard 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%2FKardFinancial%2Fkard-python-sdk)
[![pypi](https://img.shields.io/pypi/v/kard-financial-sdk)](https://pypi.python.org/pypi/kard-financial-sdk)

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

## Table of Contents

- [Installation](#installation)
- [Reference](#reference)
- [Usage](#usage)
- [Environments](#environments)
- [Async Client](#async-client)
- [Exception Handling](#exception-handling)
- [Oauth Token Override](#oauth-token-override)
- [Advanced](#advanced)
  - [Access Raw Response Data](#access-raw-response-data)
  - [Retries](#retries)
  - [Timeouts](#timeouts)
  - [Custom Client](#custom-client)
- [Contributing](#contributing)

## Installation

```sh
pip install kard-financial-sdk
```

## Reference

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

## Usage

Instantiate and use the client with the following:

```python
from kard import KardApi
from kard.users import UserRequestDataUnion_User, UserRequestAttributes

client = KardApi(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)

client.users.create(
    organization_id="organization-123",
    data=[
        UserRequestDataUnion_User(
            id="1234567890",
            attributes=UserRequestAttributes(
                zip_code="11238",
                enrolled_rewards=[
                    "CARDLINKED"
                ],
                email="user@example.com",
                hashed_email="a94a8fe5ccb19ba61c4c0873d391e987982fbbd3e2d8a5b76e45a1d4c4e2e3a1",
                phone_number="+14155552671",
                birth_year="1990",
                historical_transactions_sent=True,
            ),
        )
    ],
)
```

## Environments

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

```python
from kard import KardApi
from kard.environment import KardApiEnvironment

client = KardApi(
    environment=KardApiEnvironment.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 kard.users import UserRequestDataUnion_User, UserRequestAttributes

from kard import AsyncKardApi

client = AsyncKardApi(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)


async def main() -> None:
    await client.users.create(
        organization_id="organization-123",
        data=[
            UserRequestDataUnion_User(
                id="1234567890",
                attributes=UserRequestAttributes(
                    zip_code="11238",
                    enrolled_rewards=[
                        "CARDLINKED"
                    ],
                    email="user@example.com",
                    hashed_email="a94a8fe5ccb19ba61c4c0873d391e987982fbbd3e2d8a5b76e45a1d4c4e2e3a1",
                    phone_number="+14155552671",
                    birth_year="1990",
                    historical_transactions_sent=True,
                ),
            )
        ],
    )


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 kard.core.api_error import ApiError

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

## Oauth Token Override

This SDK supports two authentication methods: OAuth client credentials flow (automatic token management) or direct bearer token authentication. You can choose between these options when initializing the client:

```python
from kard import KardApi

# Option 1: Direct bearer token (bypass OAuth flow)
client = KardApi(
    ...,
    token="my-pre-generated-bearer-token",
)

# Option 2: OAuth client credentials flow (automatic token management)
client = KardApi(
    ...,
    client_id="your-client-id",
    client_secret="your-client-secret",
)
```

## 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 kard import KardApi

client = KardApi(...)
response = client.users.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).

A request is deemed retryable when any of the following HTTP status codes is returned:

- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [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/500) (Internal Server Errors)

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

```python
client.users.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 kard import KardApi

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

# Override timeout for a specific method
client.users.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 kard import KardApi

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

## 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!

