Metadata-Version: 2.4
Name: wflow-api
Version: 0.1.0
Summary: Python client for the wflow.com public API
Keywords: wflow,api,client,async
Author: wflow.com
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Framework :: Pydantic :: 2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: httpx>=0.27
Requires-Dist: pydantic>=2.12
Requires-Python: >=3.12
Project-URL: Homepage, https://www.wflow.com
Project-URL: Documentation, https://developers.wflow.com
Description-Content-Type: text/markdown

# wflow-api

Async Python client for the [wflow.com](https://www.wflow.com) public API: one function per API operation, typed
with pydantic models. The [`wflow-cli`](https://pypi.org/project/wflow-cli/) command is generated from it.

```python
import asyncio

from wflow_api import ENVIRONMENTS, ClientCredentials, WflowClient
from wflow_api.operations.registers import list_register_partners

api_base, account_base = ENVIRONMENTS["prod"]
client = WflowClient(
    ClientCredentials("your-full-client-id", "your-client-secret", account_base),
    api_base=api_base,
    headers={"X-Integration-Id": "your-integration"},
)

page = asyncio.run(list_register_partners(client, "acme", pageSize=50))
print(page.totalItems, [partner.name for partner in page.items])
```

Every operation validates its arguments before a request leaves and raises `wflow_api.WflowError` (or
`WflowApiError`, with `status`, `method`, `path` and `detail`) on failure. Files are bytes: uploads take `content`,
downloads return `FileContent`.
