Metadata-Version: 2.4
Name: caraer-client
Version: 2.0.595
Summary: Caraer API Documentation
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Caraer API Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: license-file

# caraer-client

Generated Python client for the [Caraer API](https://v2.api.caraer.com).

This repository is regenerated automatically from the production OpenAPI spec after each Caraer backend production deploy. Hand-written serverless payload helpers in `caraer_client/apps.py` are preserved across regenerations.

## Install

```bash
pip install caraer-client
```

## Docs

- API reference: https://developer.caraer.com
- OpenAPI: https://v2.api.caraer.com/api-docs.yaml

## Auth

Configure the generated API client with a Bearer token (see generated docs after the first codegen publish).

## Serverless app payload types

Import TypedDict helpers for lifecycle / webhook / schedule / inbound / job bodies
(instead of running `caraer apps typegen`):

```python
from caraer_client import LifecyclePayload, WebhookPayload, SchedulePayload
# or: from caraer_client.apps import LifecyclePayload

def handler(request):
    body: LifecyclePayload = request.get("body") or {}
    ...
```

## License

See [LICENSE](LICENSE).
